blob: 3a64fa4aaf7e34257a30b0141b40b589fbbd3005 [file] [log] [blame]
xjb04a4022021-11-25 15:01:52 +08001/*
2 * libata-scsi.c - helper library for ATA
3 *
4 * Maintained by: Tejun Heo <tj@kernel.org>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
7 *
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
10 *
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 *
26 *
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/driver-api/libata.rst
29 *
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
33 *
34 */
35
36#include <linux/slab.h>
37#include <linux/kernel.h>
38#include <linux/blkdev.h>
39#include <linux/spinlock.h>
40#include <linux/export.h>
41#include <scsi/scsi.h>
42#include <scsi/scsi_host.h>
43#include <scsi/scsi_cmnd.h>
44#include <scsi/scsi_eh.h>
45#include <scsi/scsi_device.h>
46#include <scsi/scsi_tcq.h>
47#include <scsi/scsi_transport.h>
48#include <linux/libata.h>
49#include <linux/hdreg.h>
50#include <linux/uaccess.h>
51#include <linux/suspend.h>
52#include <asm/unaligned.h>
53#include <linux/ioprio.h>
54
55#include "libata.h"
56#include "libata-transport.h"
57
58#define ATA_SCSI_RBUF_SIZE 4096
59
60static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
61static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
62
63typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
64
65static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
66 const struct scsi_device *scsidev);
67static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
68 const struct scsi_device *scsidev);
69
70#define RW_RECOVERY_MPAGE 0x1
71#define RW_RECOVERY_MPAGE_LEN 12
72#define CACHE_MPAGE 0x8
73#define CACHE_MPAGE_LEN 20
74#define CONTROL_MPAGE 0xa
75#define CONTROL_MPAGE_LEN 12
76#define ALL_MPAGES 0x3f
77#define ALL_SUB_MPAGES 0xff
78
79
80static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
81 RW_RECOVERY_MPAGE,
82 RW_RECOVERY_MPAGE_LEN - 2,
83 (1 << 7), /* AWRE */
84 0, /* read retry count */
85 0, 0, 0, 0,
86 0, /* write retry count */
87 0, 0, 0
88};
89
90static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
91 CACHE_MPAGE,
92 CACHE_MPAGE_LEN - 2,
93 0, /* contains WCE, needs to be 0 for logic */
94 0, 0, 0, 0, 0, 0, 0, 0, 0,
95 0, /* contains DRA, needs to be 0 for logic */
96 0, 0, 0, 0, 0, 0, 0
97};
98
99static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
100 CONTROL_MPAGE,
101 CONTROL_MPAGE_LEN - 2,
102 2, /* DSENSE=0, GLTSD=1 */
103 0, /* [QAM+QERR may be 1, see 05-359r1] */
104 0, 0, 0, 0, 0xff, 0xff,
105 0, 30 /* extended self test time, see 05-359r1 */
106};
107
108static const char *ata_lpm_policy_names[] = {
109 [ATA_LPM_UNKNOWN] = "max_performance",
110 [ATA_LPM_MAX_POWER] = "max_performance",
111 [ATA_LPM_MED_POWER] = "medium_power",
112 [ATA_LPM_MED_POWER_WITH_DIPM] = "med_power_with_dipm",
113 [ATA_LPM_MIN_POWER_WITH_PARTIAL] = "min_power_with_partial",
114 [ATA_LPM_MIN_POWER] = "min_power",
115};
116
117static ssize_t ata_scsi_lpm_store(struct device *device,
118 struct device_attribute *attr,
119 const char *buf, size_t count)
120{
121 struct Scsi_Host *shost = class_to_shost(device);
122 struct ata_port *ap = ata_shost_to_port(shost);
123 struct ata_link *link;
124 struct ata_device *dev;
125 enum ata_lpm_policy policy;
126 unsigned long flags;
127
128 /* UNKNOWN is internal state, iterate from MAX_POWER */
129 for (policy = ATA_LPM_MAX_POWER;
130 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
131 const char *name = ata_lpm_policy_names[policy];
132
133 if (strncmp(name, buf, strlen(name)) == 0)
134 break;
135 }
136 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
137 return -EINVAL;
138
139 spin_lock_irqsave(ap->lock, flags);
140
141 ata_for_each_link(link, ap, EDGE) {
142 ata_for_each_dev(dev, &ap->link, ENABLED) {
143 if (dev->horkage & ATA_HORKAGE_NOLPM) {
144 count = -EOPNOTSUPP;
145 goto out_unlock;
146 }
147 }
148 }
149
150 ap->target_lpm_policy = policy;
151 ata_port_schedule_eh(ap);
152out_unlock:
153 spin_unlock_irqrestore(ap->lock, flags);
154 return count;
155}
156
157static ssize_t ata_scsi_lpm_show(struct device *dev,
158 struct device_attribute *attr, char *buf)
159{
160 struct Scsi_Host *shost = class_to_shost(dev);
161 struct ata_port *ap = ata_shost_to_port(shost);
162
163 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
164 return -EINVAL;
165
166 return snprintf(buf, PAGE_SIZE, "%s\n",
167 ata_lpm_policy_names[ap->target_lpm_policy]);
168}
169DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
170 ata_scsi_lpm_show, ata_scsi_lpm_store);
171EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
172
173static ssize_t ata_scsi_park_show(struct device *device,
174 struct device_attribute *attr, char *buf)
175{
176 struct scsi_device *sdev = to_scsi_device(device);
177 struct ata_port *ap;
178 struct ata_link *link;
179 struct ata_device *dev;
180 unsigned long now;
181 unsigned int uninitialized_var(msecs);
182 int rc = 0;
183
184 ap = ata_shost_to_port(sdev->host);
185
186 spin_lock_irq(ap->lock);
187 dev = ata_scsi_find_dev(ap, sdev);
188 if (!dev) {
189 rc = -ENODEV;
190 goto unlock;
191 }
192 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
193 rc = -EOPNOTSUPP;
194 goto unlock;
195 }
196
197 link = dev->link;
198 now = jiffies;
199 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
200 link->eh_context.unloaded_mask & (1 << dev->devno) &&
201 time_after(dev->unpark_deadline, now))
202 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
203 else
204 msecs = 0;
205
206unlock:
207 spin_unlock_irq(ap->lock);
208
209 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
210}
211
212static ssize_t ata_scsi_park_store(struct device *device,
213 struct device_attribute *attr,
214 const char *buf, size_t len)
215{
216 struct scsi_device *sdev = to_scsi_device(device);
217 struct ata_port *ap;
218 struct ata_device *dev;
219 long int input;
220 unsigned long flags;
221 int rc;
222
223 rc = kstrtol(buf, 10, &input);
224 if (rc)
225 return rc;
226 if (input < -2)
227 return -EINVAL;
228 if (input > ATA_TMOUT_MAX_PARK) {
229 rc = -EOVERFLOW;
230 input = ATA_TMOUT_MAX_PARK;
231 }
232
233 ap = ata_shost_to_port(sdev->host);
234
235 spin_lock_irqsave(ap->lock, flags);
236 dev = ata_scsi_find_dev(ap, sdev);
237 if (unlikely(!dev)) {
238 rc = -ENODEV;
239 goto unlock;
240 }
241 if (dev->class != ATA_DEV_ATA &&
242 dev->class != ATA_DEV_ZAC) {
243 rc = -EOPNOTSUPP;
244 goto unlock;
245 }
246
247 if (input >= 0) {
248 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
249 rc = -EOPNOTSUPP;
250 goto unlock;
251 }
252
253 dev->unpark_deadline = ata_deadline(jiffies, input);
254 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
255 ata_port_schedule_eh(ap);
256 complete(&ap->park_req_pending);
257 } else {
258 switch (input) {
259 case -1:
260 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
261 break;
262 case -2:
263 dev->flags |= ATA_DFLAG_NO_UNLOAD;
264 break;
265 }
266 }
267unlock:
268 spin_unlock_irqrestore(ap->lock, flags);
269
270 return rc ? rc : len;
271}
272DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
273 ata_scsi_park_show, ata_scsi_park_store);
274EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
275
276static ssize_t ata_ncq_prio_enable_show(struct device *device,
277 struct device_attribute *attr,
278 char *buf)
279{
280 struct scsi_device *sdev = to_scsi_device(device);
281 struct ata_port *ap;
282 struct ata_device *dev;
283 bool ncq_prio_enable;
284 int rc = 0;
285
286 ap = ata_shost_to_port(sdev->host);
287
288 spin_lock_irq(ap->lock);
289 dev = ata_scsi_find_dev(ap, sdev);
290 if (!dev) {
291 rc = -ENODEV;
292 goto unlock;
293 }
294
295 ncq_prio_enable = dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLE;
296
297unlock:
298 spin_unlock_irq(ap->lock);
299
300 return rc ? rc : snprintf(buf, 20, "%u\n", ncq_prio_enable);
301}
302
303static ssize_t ata_ncq_prio_enable_store(struct device *device,
304 struct device_attribute *attr,
305 const char *buf, size_t len)
306{
307 struct scsi_device *sdev = to_scsi_device(device);
308 struct ata_port *ap;
309 struct ata_device *dev;
310 long int input;
311 int rc;
312
313 rc = kstrtol(buf, 10, &input);
314 if (rc)
315 return rc;
316 if ((input < 0) || (input > 1))
317 return -EINVAL;
318
319 ap = ata_shost_to_port(sdev->host);
320 dev = ata_scsi_find_dev(ap, sdev);
321 if (unlikely(!dev))
322 return -ENODEV;
323
324 spin_lock_irq(ap->lock);
325 if (input)
326 dev->flags |= ATA_DFLAG_NCQ_PRIO_ENABLE;
327 else
328 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
329
330 dev->link->eh_info.action |= ATA_EH_REVALIDATE;
331 dev->link->eh_info.flags |= ATA_EHI_QUIET;
332 ata_port_schedule_eh(ap);
333 spin_unlock_irq(ap->lock);
334
335 ata_port_wait_eh(ap);
336
337 if (input) {
338 spin_lock_irq(ap->lock);
339 if (!(dev->flags & ATA_DFLAG_NCQ_PRIO)) {
340 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
341 rc = -EIO;
342 }
343 spin_unlock_irq(ap->lock);
344 }
345
346 return rc ? rc : len;
347}
348
349DEVICE_ATTR(ncq_prio_enable, S_IRUGO | S_IWUSR,
350 ata_ncq_prio_enable_show, ata_ncq_prio_enable_store);
351EXPORT_SYMBOL_GPL(dev_attr_ncq_prio_enable);
352
353void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
354 u8 sk, u8 asc, u8 ascq)
355{
356 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
357
358 if (!cmd)
359 return;
360
361 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
362
363 scsi_build_sense_buffer(d_sense, cmd->sense_buffer, sk, asc, ascq);
364}
365
366void ata_scsi_set_sense_information(struct ata_device *dev,
367 struct scsi_cmnd *cmd,
368 const struct ata_taskfile *tf)
369{
370 u64 information;
371
372 if (!cmd)
373 return;
374
375 information = ata_tf_read_block(tf, dev);
376 if (information == U64_MAX)
377 return;
378
379 scsi_set_sense_information(cmd->sense_buffer,
380 SCSI_SENSE_BUFFERSIZE, information);
381}
382
383static void ata_scsi_set_invalid_field(struct ata_device *dev,
384 struct scsi_cmnd *cmd, u16 field, u8 bit)
385{
386 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
387 /* "Invalid field in CDB" */
388 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
389 field, bit, 1);
390}
391
392static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
393 struct scsi_cmnd *cmd, u16 field)
394{
395 /* "Invalid field in parameter list" */
396 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
397 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
398 field, 0xff, 0);
399}
400
401static ssize_t
402ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
403 const char *buf, size_t count)
404{
405 struct Scsi_Host *shost = class_to_shost(dev);
406 struct ata_port *ap = ata_shost_to_port(shost);
407 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
408 return ap->ops->em_store(ap, buf, count);
409 return -EINVAL;
410}
411
412static ssize_t
413ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
414 char *buf)
415{
416 struct Scsi_Host *shost = class_to_shost(dev);
417 struct ata_port *ap = ata_shost_to_port(shost);
418
419 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
420 return ap->ops->em_show(ap, buf);
421 return -EINVAL;
422}
423DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
424 ata_scsi_em_message_show, ata_scsi_em_message_store);
425EXPORT_SYMBOL_GPL(dev_attr_em_message);
426
427static ssize_t
428ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
429 char *buf)
430{
431 struct Scsi_Host *shost = class_to_shost(dev);
432 struct ata_port *ap = ata_shost_to_port(shost);
433
434 return snprintf(buf, 23, "%d\n", ap->em_message_type);
435}
436DEVICE_ATTR(em_message_type, S_IRUGO,
437 ata_scsi_em_message_type_show, NULL);
438EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
439
440static ssize_t
441ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
442 char *buf)
443{
444 struct scsi_device *sdev = to_scsi_device(dev);
445 struct ata_port *ap = ata_shost_to_port(sdev->host);
446 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
447
448 if (atadev && ap->ops->sw_activity_show &&
449 (ap->flags & ATA_FLAG_SW_ACTIVITY))
450 return ap->ops->sw_activity_show(atadev, buf);
451 return -EINVAL;
452}
453
454static ssize_t
455ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
456 const char *buf, size_t count)
457{
458 struct scsi_device *sdev = to_scsi_device(dev);
459 struct ata_port *ap = ata_shost_to_port(sdev->host);
460 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
461 enum sw_activity val;
462 int rc;
463
464 if (atadev && ap->ops->sw_activity_store &&
465 (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
466 val = simple_strtoul(buf, NULL, 0);
467 switch (val) {
468 case OFF: case BLINK_ON: case BLINK_OFF:
469 rc = ap->ops->sw_activity_store(atadev, val);
470 if (!rc)
471 return count;
472 else
473 return rc;
474 }
475 }
476 return -EINVAL;
477}
478DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
479 ata_scsi_activity_store);
480EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
481
482struct device_attribute *ata_common_sdev_attrs[] = {
483 &dev_attr_unload_heads,
484 &dev_attr_ncq_prio_enable,
485 NULL
486};
487EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
488
489/**
490 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
491 * @sdev: SCSI device for which BIOS geometry is to be determined
492 * @bdev: block device associated with @sdev
493 * @capacity: capacity of SCSI device
494 * @geom: location to which geometry will be output
495 *
496 * Generic bios head/sector/cylinder calculator
497 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
498 * mapping. Some situations may arise where the disk is not
499 * bootable if this is not used.
500 *
501 * LOCKING:
502 * Defined by the SCSI layer. We don't really care.
503 *
504 * RETURNS:
505 * Zero.
506 */
507int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
508 sector_t capacity, int geom[])
509{
510 geom[0] = 255;
511 geom[1] = 63;
512 sector_div(capacity, 255*63);
513 geom[2] = capacity;
514
515 return 0;
516}
517
518/**
519 * ata_scsi_unlock_native_capacity - unlock native capacity
520 * @sdev: SCSI device to adjust device capacity for
521 *
522 * This function is called if a partition on @sdev extends beyond
523 * the end of the device. It requests EH to unlock HPA.
524 *
525 * LOCKING:
526 * Defined by the SCSI layer. Might sleep.
527 */
528void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
529{
530 struct ata_port *ap = ata_shost_to_port(sdev->host);
531 struct ata_device *dev;
532 unsigned long flags;
533
534 spin_lock_irqsave(ap->lock, flags);
535
536 dev = ata_scsi_find_dev(ap, sdev);
537 if (dev && dev->n_sectors < dev->n_native_sectors) {
538 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
539 dev->link->eh_info.action |= ATA_EH_RESET;
540 ata_port_schedule_eh(ap);
541 }
542
543 spin_unlock_irqrestore(ap->lock, flags);
544 ata_port_wait_eh(ap);
545}
546
547/**
548 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
549 * @ap: target port
550 * @sdev: SCSI device to get identify data for
551 * @arg: User buffer area for identify data
552 *
553 * LOCKING:
554 * Defined by the SCSI layer. We don't really care.
555 *
556 * RETURNS:
557 * Zero on success, negative errno on error.
558 */
559static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
560 void __user *arg)
561{
562 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
563 u16 __user *dst = arg;
564 char buf[40];
565
566 if (!dev)
567 return -ENOMSG;
568
569 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
570 return -EFAULT;
571
572 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
573 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
574 return -EFAULT;
575
576 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
577 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
578 return -EFAULT;
579
580 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
581 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
582 return -EFAULT;
583
584 return 0;
585}
586
587/**
588 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
589 * @scsidev: Device to which we are issuing command
590 * @arg: User provided data for issuing command
591 *
592 * LOCKING:
593 * Defined by the SCSI layer. We don't really care.
594 *
595 * RETURNS:
596 * Zero on success, negative errno on error.
597 */
598int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
599{
600 int rc = 0;
601 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
602 u8 scsi_cmd[MAX_COMMAND_SIZE];
603 u8 args[4], *argbuf = NULL;
604 int argsize = 0;
605 enum dma_data_direction data_dir;
606 struct scsi_sense_hdr sshdr;
607 int cmd_result;
608
609 if (arg == NULL)
610 return -EINVAL;
611
612 if (copy_from_user(args, arg, sizeof(args)))
613 return -EFAULT;
614
615 memset(sensebuf, 0, sizeof(sensebuf));
616 memset(scsi_cmd, 0, sizeof(scsi_cmd));
617
618 if (args[3]) {
619 argsize = ATA_SECT_SIZE * args[3];
620 argbuf = kmalloc(argsize, GFP_KERNEL);
621 if (argbuf == NULL) {
622 rc = -ENOMEM;
623 goto error;
624 }
625
626 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
627 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
628 block count in sector count field */
629 data_dir = DMA_FROM_DEVICE;
630 } else {
631 scsi_cmd[1] = (3 << 1); /* Non-data */
632 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
633 data_dir = DMA_NONE;
634 }
635
636 scsi_cmd[0] = ATA_16;
637
638 scsi_cmd[4] = args[2];
639 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
640 scsi_cmd[6] = args[3];
641 scsi_cmd[8] = args[1];
642 scsi_cmd[10] = 0x4f;
643 scsi_cmd[12] = 0xc2;
644 } else {
645 scsi_cmd[6] = args[1];
646 }
647 scsi_cmd[14] = args[0];
648
649 /* Good values for timeout and retries? Values below
650 from scsi_ioctl_send_command() for default case... */
651 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
652 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
653
654 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
655 u8 *desc = sensebuf + 8;
656 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
657
658 /* If we set cc then ATA pass-through will cause a
659 * check condition even if no error. Filter that. */
660 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
661 if (sshdr.sense_key == RECOVERED_ERROR &&
662 sshdr.asc == 0 && sshdr.ascq == 0x1d)
663 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
664 }
665
666 /* Send userspace a few ATA registers (same as drivers/ide) */
667 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
668 desc[0] == 0x09) { /* code is "ATA Descriptor" */
669 args[0] = desc[13]; /* status */
670 args[1] = desc[3]; /* error */
671 args[2] = desc[5]; /* sector count (0:7) */
672 if (copy_to_user(arg, args, sizeof(args)))
673 rc = -EFAULT;
674 }
675 }
676
677
678 if (cmd_result) {
679 rc = -EIO;
680 goto error;
681 }
682
683 if ((argbuf)
684 && copy_to_user(arg + sizeof(args), argbuf, argsize))
685 rc = -EFAULT;
686error:
687 kfree(argbuf);
688 return rc;
689}
690
691/**
692 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
693 * @scsidev: Device to which we are issuing command
694 * @arg: User provided data for issuing command
695 *
696 * LOCKING:
697 * Defined by the SCSI layer. We don't really care.
698 *
699 * RETURNS:
700 * Zero on success, negative errno on error.
701 */
702int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
703{
704 int rc = 0;
705 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
706 u8 scsi_cmd[MAX_COMMAND_SIZE];
707 u8 args[7];
708 struct scsi_sense_hdr sshdr;
709 int cmd_result;
710
711 if (arg == NULL)
712 return -EINVAL;
713
714 if (copy_from_user(args, arg, sizeof(args)))
715 return -EFAULT;
716
717 memset(sensebuf, 0, sizeof(sensebuf));
718 memset(scsi_cmd, 0, sizeof(scsi_cmd));
719 scsi_cmd[0] = ATA_16;
720 scsi_cmd[1] = (3 << 1); /* Non-data */
721 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
722 scsi_cmd[4] = args[1];
723 scsi_cmd[6] = args[2];
724 scsi_cmd[8] = args[3];
725 scsi_cmd[10] = args[4];
726 scsi_cmd[12] = args[5];
727 scsi_cmd[13] = args[6] & 0x4f;
728 scsi_cmd[14] = args[0];
729
730 /* Good values for timeout and retries? Values below
731 from scsi_ioctl_send_command() for default case... */
732 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
733 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
734
735 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
736 u8 *desc = sensebuf + 8;
737 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
738
739 /* If we set cc then ATA pass-through will cause a
740 * check condition even if no error. Filter that. */
741 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
742 if (sshdr.sense_key == RECOVERED_ERROR &&
743 sshdr.asc == 0 && sshdr.ascq == 0x1d)
744 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
745 }
746
747 /* Send userspace ATA registers */
748 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
749 desc[0] == 0x09) {/* code is "ATA Descriptor" */
750 args[0] = desc[13]; /* status */
751 args[1] = desc[3]; /* error */
752 args[2] = desc[5]; /* sector count (0:7) */
753 args[3] = desc[7]; /* lbal */
754 args[4] = desc[9]; /* lbam */
755 args[5] = desc[11]; /* lbah */
756 args[6] = desc[12]; /* select */
757 if (copy_to_user(arg, args, sizeof(args)))
758 rc = -EFAULT;
759 }
760 }
761
762 if (cmd_result) {
763 rc = -EIO;
764 goto error;
765 }
766
767 error:
768 return rc;
769}
770
771static int ata_ioc32(struct ata_port *ap)
772{
773 if (ap->flags & ATA_FLAG_PIO_DMA)
774 return 1;
775 if (ap->pflags & ATA_PFLAG_PIO32)
776 return 1;
777 return 0;
778}
779
780int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
781 int cmd, void __user *arg)
782{
783 unsigned long val;
784 int rc = -EINVAL;
785 unsigned long flags;
786
787 switch (cmd) {
788 case HDIO_GET_32BIT:
789 spin_lock_irqsave(ap->lock, flags);
790 val = ata_ioc32(ap);
791 spin_unlock_irqrestore(ap->lock, flags);
792 return put_user(val, (unsigned long __user *)arg);
793
794 case HDIO_SET_32BIT:
795 val = (unsigned long) arg;
796 rc = 0;
797 spin_lock_irqsave(ap->lock, flags);
798 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
799 if (val)
800 ap->pflags |= ATA_PFLAG_PIO32;
801 else
802 ap->pflags &= ~ATA_PFLAG_PIO32;
803 } else {
804 if (val != ata_ioc32(ap))
805 rc = -EINVAL;
806 }
807 spin_unlock_irqrestore(ap->lock, flags);
808 return rc;
809
810 case HDIO_GET_IDENTITY:
811 return ata_get_identity(ap, scsidev, arg);
812
813 case HDIO_DRIVE_CMD:
814 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
815 return -EACCES;
816 return ata_cmd_ioctl(scsidev, arg);
817
818 case HDIO_DRIVE_TASK:
819 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
820 return -EACCES;
821 return ata_task_ioctl(scsidev, arg);
822
823 default:
824 rc = -ENOTTY;
825 break;
826 }
827
828 return rc;
829}
830EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
831
832int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
833{
834 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
835 scsidev, cmd, arg);
836}
837EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
838
839/**
840 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
841 * @dev: ATA device to which the new command is attached
842 * @cmd: SCSI command that originated this ATA command
843 *
844 * Obtain a reference to an unused ata_queued_cmd structure,
845 * which is the basic libata structure representing a single
846 * ATA command sent to the hardware.
847 *
848 * If a command was available, fill in the SCSI-specific
849 * portions of the structure with information on the
850 * current command.
851 *
852 * LOCKING:
853 * spin_lock_irqsave(host lock)
854 *
855 * RETURNS:
856 * Command allocated, or %NULL if none available.
857 */
858static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
859 struct scsi_cmnd *cmd)
860{
861 struct ata_queued_cmd *qc;
862
863 qc = ata_qc_new_init(dev, cmd->request->tag);
864 if (qc) {
865 qc->scsicmd = cmd;
866 qc->scsidone = cmd->scsi_done;
867
868 qc->sg = scsi_sglist(cmd);
869 qc->n_elem = scsi_sg_count(cmd);
870
871 if (cmd->request->rq_flags & RQF_QUIET)
872 qc->flags |= ATA_QCFLAG_QUIET;
873 } else {
874 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
875 cmd->scsi_done(cmd);
876 }
877
878 return qc;
879}
880
881static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
882{
883 struct scsi_cmnd *scmd = qc->scsicmd;
884
885 qc->extrabytes = scmd->request->extra_len;
886 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
887}
888
889/**
890 * ata_dump_status - user friendly display of error info
891 * @id: id of the port in question
892 * @tf: ptr to filled out taskfile
893 *
894 * Decode and dump the ATA error/status registers for the user so
895 * that they have some idea what really happened at the non
896 * make-believe layer.
897 *
898 * LOCKING:
899 * inherited from caller
900 */
901static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
902{
903 u8 stat = tf->command, err = tf->feature;
904
905 pr_warn("ata%u: status=0x%02x { ", id, stat);
906 if (stat & ATA_BUSY) {
907 pr_cont("Busy }\n"); /* Data is not valid in this case */
908 } else {
909 if (stat & ATA_DRDY) pr_cont("DriveReady ");
910 if (stat & ATA_DF) pr_cont("DeviceFault ");
911 if (stat & ATA_DSC) pr_cont("SeekComplete ");
912 if (stat & ATA_DRQ) pr_cont("DataRequest ");
913 if (stat & ATA_CORR) pr_cont("CorrectedError ");
914 if (stat & ATA_SENSE) pr_cont("Sense ");
915 if (stat & ATA_ERR) pr_cont("Error ");
916 pr_cont("}\n");
917
918 if (err) {
919 pr_warn("ata%u: error=0x%02x { ", id, err);
920 if (err & ATA_ABORTED) pr_cont("DriveStatusError ");
921 if (err & ATA_ICRC) {
922 if (err & ATA_ABORTED)
923 pr_cont("BadCRC ");
924 else pr_cont("Sector ");
925 }
926 if (err & ATA_UNC) pr_cont("UncorrectableError ");
927 if (err & ATA_IDNF) pr_cont("SectorIdNotFound ");
928 if (err & ATA_TRK0NF) pr_cont("TrackZeroNotFound ");
929 if (err & ATA_AMNF) pr_cont("AddrMarkNotFound ");
930 pr_cont("}\n");
931 }
932 }
933}
934
935/**
936 * ata_to_sense_error - convert ATA error to SCSI error
937 * @id: ATA device number
938 * @drv_stat: value contained in ATA status register
939 * @drv_err: value contained in ATA error register
940 * @sk: the sense key we'll fill out
941 * @asc: the additional sense code we'll fill out
942 * @ascq: the additional sense code qualifier we'll fill out
943 * @verbose: be verbose
944 *
945 * Converts an ATA error into a SCSI error. Fill out pointers to
946 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
947 * format sense blocks.
948 *
949 * LOCKING:
950 * spin_lock_irqsave(host lock)
951 */
952static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
953 u8 *asc, u8 *ascq, int verbose)
954{
955 int i;
956
957 /* Based on the 3ware driver translation table */
958 static const unsigned char sense_table[][4] = {
959 /* BBD|ECC|ID|MAR */
960 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
961 // Device busy Aborted command
962 /* BBD|ECC|ID */
963 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
964 // Device busy Aborted command
965 /* ECC|MC|MARK */
966 {0x61, HARDWARE_ERROR, 0x00, 0x00},
967 // Device fault Hardware error
968 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
969 {0x84, ABORTED_COMMAND, 0x47, 0x00},
970 // Data CRC error SCSI parity error
971 /* MC|ID|ABRT|TRK0|MARK */
972 {0x37, NOT_READY, 0x04, 0x00},
973 // Unit offline Not ready
974 /* MCR|MARK */
975 {0x09, NOT_READY, 0x04, 0x00},
976 // Unrecovered disk error Not ready
977 /* Bad address mark */
978 {0x01, MEDIUM_ERROR, 0x13, 0x00},
979 // Address mark not found for data field
980 /* TRK0 - Track 0 not found */
981 {0x02, HARDWARE_ERROR, 0x00, 0x00},
982 // Hardware error
983 /* Abort: 0x04 is not translated here, see below */
984 /* Media change request */
985 {0x08, NOT_READY, 0x04, 0x00},
986 // FIXME: faking offline
987 /* SRV/IDNF - ID not found */
988 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
989 // Logical address out of range
990 /* MC - Media Changed */
991 {0x20, UNIT_ATTENTION, 0x28, 0x00},
992 // Not ready to ready change, medium may have changed
993 /* ECC - Uncorrectable ECC error */
994 {0x40, MEDIUM_ERROR, 0x11, 0x04},
995 // Unrecovered read error
996 /* BBD - block marked bad */
997 {0x80, MEDIUM_ERROR, 0x11, 0x04},
998 // Block marked bad Medium error, unrecovered read error
999 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1000 };
1001 static const unsigned char stat_table[][4] = {
1002 /* Must be first because BUSY means no other bits valid */
1003 {0x80, ABORTED_COMMAND, 0x47, 0x00},
1004 // Busy, fake parity for now
1005 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
1006 // Device ready, unaligned write command
1007 {0x20, HARDWARE_ERROR, 0x44, 0x00},
1008 // Device fault, internal target failure
1009 {0x08, ABORTED_COMMAND, 0x47, 0x00},
1010 // Timed out in xfer, fake parity for now
1011 {0x04, RECOVERED_ERROR, 0x11, 0x00},
1012 // Recovered ECC error Medium error, recovered
1013 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1014 };
1015
1016 /*
1017 * Is this an error we can process/parse
1018 */
1019 if (drv_stat & ATA_BUSY) {
1020 drv_err = 0; /* Ignore the err bits, they're invalid */
1021 }
1022
1023 if (drv_err) {
1024 /* Look for drv_err */
1025 for (i = 0; sense_table[i][0] != 0xFF; i++) {
1026 /* Look for best matches first */
1027 if ((sense_table[i][0] & drv_err) ==
1028 sense_table[i][0]) {
1029 *sk = sense_table[i][1];
1030 *asc = sense_table[i][2];
1031 *ascq = sense_table[i][3];
1032 goto translate_done;
1033 }
1034 }
1035 }
1036
1037 /*
1038 * Fall back to interpreting status bits. Note that if the drv_err
1039 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
1040 * is not descriptive enough.
1041 */
1042 for (i = 0; stat_table[i][0] != 0xFF; i++) {
1043 if (stat_table[i][0] & drv_stat) {
1044 *sk = stat_table[i][1];
1045 *asc = stat_table[i][2];
1046 *ascq = stat_table[i][3];
1047 goto translate_done;
1048 }
1049 }
1050
1051 /*
1052 * We need a sensible error return here, which is tricky, and one
1053 * that won't cause people to do things like return a disk wrongly.
1054 */
1055 *sk = ABORTED_COMMAND;
1056 *asc = 0x00;
1057 *ascq = 0x00;
1058
1059 translate_done:
1060 if (verbose)
1061 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
1062 id, drv_stat, drv_err, *sk, *asc, *ascq);
1063 return;
1064}
1065
1066/*
1067 * ata_gen_passthru_sense - Generate check condition sense block.
1068 * @qc: Command that completed.
1069 *
1070 * This function is specific to the ATA descriptor format sense
1071 * block specified for the ATA pass through commands. Regardless
1072 * of whether the command errored or not, return a sense
1073 * block. Copy all controller registers into the sense
1074 * block. If there was no error, we get the request from an ATA
1075 * passthrough command, so we use the following sense data:
1076 * sk = RECOVERED ERROR
1077 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1078 *
1079 *
1080 * LOCKING:
1081 * None.
1082 */
1083static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
1084{
1085 struct scsi_cmnd *cmd = qc->scsicmd;
1086 struct ata_taskfile *tf = &qc->result_tf;
1087 unsigned char *sb = cmd->sense_buffer;
1088 unsigned char *desc = sb + 8;
1089 int verbose = qc->ap->ops->error_handler == NULL;
1090 u8 sense_key, asc, ascq;
1091
1092 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1093
1094 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1095
1096 /*
1097 * Use ata_to_sense_error() to map status register bits
1098 * onto sense key, asc & ascq.
1099 */
1100 if (qc->err_mask ||
1101 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1102 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1103 &sense_key, &asc, &ascq, verbose);
1104 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
1105 } else {
1106 /*
1107 * ATA PASS-THROUGH INFORMATION AVAILABLE
1108 * Always in descriptor format sense.
1109 */
1110 scsi_build_sense_buffer(1, cmd->sense_buffer,
1111 RECOVERED_ERROR, 0, 0x1D);
1112 }
1113
1114 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
1115 u8 len;
1116
1117 /* descriptor format */
1118 len = sb[7];
1119 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
1120 if (!desc) {
1121 if (SCSI_SENSE_BUFFERSIZE < len + 14)
1122 return;
1123 sb[7] = len + 14;
1124 desc = sb + 8 + len;
1125 }
1126 desc[0] = 9;
1127 desc[1] = 12;
1128 /*
1129 * Copy registers into sense buffer.
1130 */
1131 desc[2] = 0x00;
1132 desc[3] = tf->feature; /* == error reg */
1133 desc[5] = tf->nsect;
1134 desc[7] = tf->lbal;
1135 desc[9] = tf->lbam;
1136 desc[11] = tf->lbah;
1137 desc[12] = tf->device;
1138 desc[13] = tf->command; /* == status reg */
1139
1140 /*
1141 * Fill in Extend bit, and the high order bytes
1142 * if applicable.
1143 */
1144 if (tf->flags & ATA_TFLAG_LBA48) {
1145 desc[2] |= 0x01;
1146 desc[4] = tf->hob_nsect;
1147 desc[6] = tf->hob_lbal;
1148 desc[8] = tf->hob_lbam;
1149 desc[10] = tf->hob_lbah;
1150 }
1151 } else {
1152 /* Fixed sense format */
1153 desc[0] = tf->feature;
1154 desc[1] = tf->command; /* status */
1155 desc[2] = tf->device;
1156 desc[3] = tf->nsect;
1157 desc[7] = 0;
1158 if (tf->flags & ATA_TFLAG_LBA48) {
1159 desc[8] |= 0x80;
1160 if (tf->hob_nsect)
1161 desc[8] |= 0x40;
1162 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
1163 desc[8] |= 0x20;
1164 }
1165 desc[9] = tf->lbal;
1166 desc[10] = tf->lbam;
1167 desc[11] = tf->lbah;
1168 }
1169}
1170
1171/**
1172 * ata_gen_ata_sense - generate a SCSI fixed sense block
1173 * @qc: Command that we are erroring out
1174 *
1175 * Generate sense block for a failed ATA command @qc. Descriptor
1176 * format is used to accommodate LBA48 block address.
1177 *
1178 * LOCKING:
1179 * None.
1180 */
1181static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1182{
1183 struct ata_device *dev = qc->dev;
1184 struct scsi_cmnd *cmd = qc->scsicmd;
1185 struct ata_taskfile *tf = &qc->result_tf;
1186 unsigned char *sb = cmd->sense_buffer;
1187 int verbose = qc->ap->ops->error_handler == NULL;
1188 u64 block;
1189 u8 sense_key, asc, ascq;
1190
1191 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1192
1193 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1194
1195 if (ata_dev_disabled(dev)) {
1196 /* Device disabled after error recovery */
1197 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
1198 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
1199 return;
1200 }
1201 /* Use ata_to_sense_error() to map status register bits
1202 * onto sense key, asc & ascq.
1203 */
1204 if (qc->err_mask ||
1205 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1206 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1207 &sense_key, &asc, &ascq, verbose);
1208 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1209 } else {
1210 /* Could not decode error */
1211 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
1212 tf->command, qc->err_mask);
1213 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1214 return;
1215 }
1216
1217 block = ata_tf_read_block(&qc->result_tf, dev);
1218 if (block == U64_MAX)
1219 return;
1220
1221 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
1222}
1223
1224static void ata_scsi_sdev_config(struct scsi_device *sdev)
1225{
1226 sdev->use_10_for_rw = 1;
1227 sdev->use_10_for_ms = 1;
1228 sdev->no_write_same = 1;
1229
1230 /* Schedule policy is determined by ->qc_defer() callback and
1231 * it needs to see every deferred qc. Set dev_blocked to 1 to
1232 * prevent SCSI midlayer from automatically deferring
1233 * requests.
1234 */
1235 sdev->max_device_blocked = 1;
1236}
1237
1238/**
1239 * atapi_drain_needed - Check whether data transfer may overflow
1240 * @rq: request to be checked
1241 *
1242 * ATAPI commands which transfer variable length data to host
1243 * might overflow due to application error or hardware bug. This
1244 * function checks whether overflow should be drained and ignored
1245 * for @request.
1246 *
1247 * LOCKING:
1248 * None.
1249 *
1250 * RETURNS:
1251 * 1 if ; otherwise, 0.
1252 */
1253static int atapi_drain_needed(struct request *rq)
1254{
1255 if (likely(!blk_rq_is_passthrough(rq)))
1256 return 0;
1257
1258 if (!blk_rq_bytes(rq) || op_is_write(req_op(rq)))
1259 return 0;
1260
1261 return atapi_cmd_type(scsi_req(rq)->cmd[0]) == ATAPI_MISC;
1262}
1263
1264static int ata_scsi_dev_config(struct scsi_device *sdev,
1265 struct ata_device *dev)
1266{
1267 struct request_queue *q = sdev->request_queue;
1268
1269 if (!ata_id_has_unload(dev->id))
1270 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1271
1272 /* configure max sectors */
1273 blk_queue_max_hw_sectors(q, dev->max_sectors);
1274
1275 if (dev->class == ATA_DEV_ATAPI) {
1276 void *buf;
1277
1278 sdev->sector_size = ATA_SECT_SIZE;
1279
1280 /* set DMA padding */
1281 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1282
1283 /* configure draining */
1284 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1285 if (!buf) {
1286 ata_dev_err(dev, "drain buffer allocation failed\n");
1287 return -ENOMEM;
1288 }
1289
1290 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1291 } else {
1292 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1293 sdev->manage_start_stop = 1;
1294 }
1295
1296 /*
1297 * ata_pio_sectors() expects buffer for each sector to not cross
1298 * page boundary. Enforce it by requiring buffers to be sector
1299 * aligned, which works iff sector_size is not larger than
1300 * PAGE_SIZE. ATAPI devices also need the alignment as
1301 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1302 */
1303 if (sdev->sector_size > PAGE_SIZE)
1304 ata_dev_warn(dev,
1305 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1306 sdev->sector_size);
1307
1308 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1309
1310 if (dev->flags & ATA_DFLAG_AN)
1311 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1312
1313 if (dev->flags & ATA_DFLAG_NCQ) {
1314 int depth;
1315
1316 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1317 depth = min(ATA_MAX_QUEUE, depth);
1318 scsi_change_queue_depth(sdev, depth);
1319 }
1320
1321 blk_queue_flush_queueable(q, false);
1322
1323 if (dev->flags & ATA_DFLAG_TRUSTED)
1324 sdev->security_supported = 1;
1325
1326 dev->sdev = sdev;
1327 return 0;
1328}
1329
1330/**
1331 * ata_scsi_slave_config - Set SCSI device attributes
1332 * @sdev: SCSI device to examine
1333 *
1334 * This is called before we actually start reading
1335 * and writing to the device, to configure certain
1336 * SCSI mid-layer behaviors.
1337 *
1338 * LOCKING:
1339 * Defined by SCSI layer. We don't really care.
1340 */
1341
1342int ata_scsi_slave_config(struct scsi_device *sdev)
1343{
1344 struct ata_port *ap = ata_shost_to_port(sdev->host);
1345 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1346 int rc = 0;
1347
1348 ata_scsi_sdev_config(sdev);
1349
1350 if (dev)
1351 rc = ata_scsi_dev_config(sdev, dev);
1352
1353 return rc;
1354}
1355
1356/**
1357 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1358 * @sdev: SCSI device to be destroyed
1359 *
1360 * @sdev is about to be destroyed for hot/warm unplugging. If
1361 * this unplugging was initiated by libata as indicated by NULL
1362 * dev->sdev, this function doesn't have to do anything.
1363 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1364 * Clear dev->sdev, schedule the device for ATA detach and invoke
1365 * EH.
1366 *
1367 * LOCKING:
1368 * Defined by SCSI layer. We don't really care.
1369 */
1370void ata_scsi_slave_destroy(struct scsi_device *sdev)
1371{
1372 struct ata_port *ap = ata_shost_to_port(sdev->host);
1373 struct request_queue *q = sdev->request_queue;
1374 unsigned long flags;
1375 struct ata_device *dev;
1376
1377 if (!ap->ops->error_handler)
1378 return;
1379
1380 spin_lock_irqsave(ap->lock, flags);
1381 dev = __ata_scsi_find_dev(ap, sdev);
1382 if (dev && dev->sdev) {
1383 /* SCSI device already in CANCEL state, no need to offline it */
1384 dev->sdev = NULL;
1385 dev->flags |= ATA_DFLAG_DETACH;
1386 ata_port_schedule_eh(ap);
1387 }
1388 spin_unlock_irqrestore(ap->lock, flags);
1389
1390 kfree(q->dma_drain_buffer);
1391 q->dma_drain_buffer = NULL;
1392 q->dma_drain_size = 0;
1393}
1394
1395/**
1396 * __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
1397 * @ap: ATA port to which the device change the queue depth
1398 * @sdev: SCSI device to configure queue depth for
1399 * @queue_depth: new queue depth
1400 *
1401 * libsas and libata have different approaches for associating a sdev to
1402 * its ata_port.
1403 *
1404 */
1405int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1406 int queue_depth)
1407{
1408 struct ata_device *dev;
1409 unsigned long flags;
1410
1411 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1412 return sdev->queue_depth;
1413
1414 dev = ata_scsi_find_dev(ap, sdev);
1415 if (!dev || !ata_dev_enabled(dev))
1416 return sdev->queue_depth;
1417
1418 /* NCQ enabled? */
1419 spin_lock_irqsave(ap->lock, flags);
1420 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1421 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1422 dev->flags |= ATA_DFLAG_NCQ_OFF;
1423 queue_depth = 1;
1424 }
1425 spin_unlock_irqrestore(ap->lock, flags);
1426
1427 /* limit and apply queue depth */
1428 queue_depth = min(queue_depth, sdev->host->can_queue);
1429 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1430 queue_depth = min(queue_depth, ATA_MAX_QUEUE);
1431
1432 if (sdev->queue_depth == queue_depth)
1433 return -EINVAL;
1434
1435 return scsi_change_queue_depth(sdev, queue_depth);
1436}
1437
1438/**
1439 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1440 * @sdev: SCSI device to configure queue depth for
1441 * @queue_depth: new queue depth
1442 *
1443 * This is libata standard hostt->change_queue_depth callback.
1444 * SCSI will call into this callback when user tries to set queue
1445 * depth via sysfs.
1446 *
1447 * LOCKING:
1448 * SCSI layer (we don't care)
1449 *
1450 * RETURNS:
1451 * Newly configured queue depth.
1452 */
1453int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1454{
1455 struct ata_port *ap = ata_shost_to_port(sdev->host);
1456
1457 return __ata_change_queue_depth(ap, sdev, queue_depth);
1458}
1459
1460/**
1461 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1462 * @qc: Storage for translated ATA taskfile
1463 *
1464 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1465 * (to start). Perhaps these commands should be preceded by
1466 * CHECK POWER MODE to see what power mode the device is already in.
1467 * [See SAT revision 5 at www.t10.org]
1468 *
1469 * LOCKING:
1470 * spin_lock_irqsave(host lock)
1471 *
1472 * RETURNS:
1473 * Zero on success, non-zero on error.
1474 */
1475static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1476{
1477 struct scsi_cmnd *scmd = qc->scsicmd;
1478 struct ata_taskfile *tf = &qc->tf;
1479 const u8 *cdb = scmd->cmnd;
1480 u16 fp;
1481 u8 bp = 0xff;
1482
1483 if (scmd->cmd_len < 5) {
1484 fp = 4;
1485 goto invalid_fld;
1486 }
1487
1488 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1489 tf->protocol = ATA_PROT_NODATA;
1490 if (cdb[1] & 0x1) {
1491 ; /* ignore IMMED bit, violates sat-r05 */
1492 }
1493 if (cdb[4] & 0x2) {
1494 fp = 4;
1495 bp = 1;
1496 goto invalid_fld; /* LOEJ bit set not supported */
1497 }
1498 if (((cdb[4] >> 4) & 0xf) != 0) {
1499 fp = 4;
1500 bp = 3;
1501 goto invalid_fld; /* power conditions not supported */
1502 }
1503
1504 if (cdb[4] & 0x1) {
1505 tf->nsect = 1; /* 1 sector, lba=0 */
1506
1507 if (qc->dev->flags & ATA_DFLAG_LBA) {
1508 tf->flags |= ATA_TFLAG_LBA;
1509
1510 tf->lbah = 0x0;
1511 tf->lbam = 0x0;
1512 tf->lbal = 0x0;
1513 tf->device |= ATA_LBA;
1514 } else {
1515 /* CHS */
1516 tf->lbal = 0x1; /* sect */
1517 tf->lbam = 0x0; /* cyl low */
1518 tf->lbah = 0x0; /* cyl high */
1519 }
1520
1521 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1522 } else {
1523 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1524 * or S5) causing some drives to spin up and down again.
1525 */
1526 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1527 system_state == SYSTEM_POWER_OFF)
1528 goto skip;
1529
1530 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1531 system_entering_hibernation())
1532 goto skip;
1533
1534 /* Issue ATA STANDBY IMMEDIATE command */
1535 tf->command = ATA_CMD_STANDBYNOW1;
1536 }
1537
1538 /*
1539 * Standby and Idle condition timers could be implemented but that
1540 * would require libata to implement the Power condition mode page
1541 * and allow the user to change it. Changing mode pages requires
1542 * MODE SELECT to be implemented.
1543 */
1544
1545 return 0;
1546
1547 invalid_fld:
1548 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1549 return 1;
1550 skip:
1551 scmd->result = SAM_STAT_GOOD;
1552 return 1;
1553}
1554
1555
1556/**
1557 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1558 * @qc: Storage for translated ATA taskfile
1559 *
1560 * Sets up an ATA taskfile to issue FLUSH CACHE or
1561 * FLUSH CACHE EXT.
1562 *
1563 * LOCKING:
1564 * spin_lock_irqsave(host lock)
1565 *
1566 * RETURNS:
1567 * Zero on success, non-zero on error.
1568 */
1569static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1570{
1571 struct ata_taskfile *tf = &qc->tf;
1572
1573 tf->flags |= ATA_TFLAG_DEVICE;
1574 tf->protocol = ATA_PROT_NODATA;
1575
1576 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1577 tf->command = ATA_CMD_FLUSH_EXT;
1578 else
1579 tf->command = ATA_CMD_FLUSH;
1580
1581 /* flush is critical for IO integrity, consider it an IO command */
1582 qc->flags |= ATA_QCFLAG_IO;
1583
1584 return 0;
1585}
1586
1587/**
1588 * scsi_6_lba_len - Get LBA and transfer length
1589 * @cdb: SCSI command to translate
1590 *
1591 * Calculate LBA and transfer length for 6-byte commands.
1592 *
1593 * RETURNS:
1594 * @plba: the LBA
1595 * @plen: the transfer length
1596 */
1597static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1598{
1599 u64 lba = 0;
1600 u32 len;
1601
1602 VPRINTK("six-byte command\n");
1603
1604 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1605 lba |= ((u64)cdb[2]) << 8;
1606 lba |= ((u64)cdb[3]);
1607
1608 len = cdb[4];
1609
1610 *plba = lba;
1611 *plen = len;
1612}
1613
1614/**
1615 * scsi_10_lba_len - Get LBA and transfer length
1616 * @cdb: SCSI command to translate
1617 *
1618 * Calculate LBA and transfer length for 10-byte commands.
1619 *
1620 * RETURNS:
1621 * @plba: the LBA
1622 * @plen: the transfer length
1623 */
1624static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1625{
1626 u64 lba = 0;
1627 u32 len = 0;
1628
1629 VPRINTK("ten-byte command\n");
1630
1631 lba |= ((u64)cdb[2]) << 24;
1632 lba |= ((u64)cdb[3]) << 16;
1633 lba |= ((u64)cdb[4]) << 8;
1634 lba |= ((u64)cdb[5]);
1635
1636 len |= ((u32)cdb[7]) << 8;
1637 len |= ((u32)cdb[8]);
1638
1639 *plba = lba;
1640 *plen = len;
1641}
1642
1643/**
1644 * scsi_16_lba_len - Get LBA and transfer length
1645 * @cdb: SCSI command to translate
1646 *
1647 * Calculate LBA and transfer length for 16-byte commands.
1648 *
1649 * RETURNS:
1650 * @plba: the LBA
1651 * @plen: the transfer length
1652 */
1653static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1654{
1655 u64 lba = 0;
1656 u32 len = 0;
1657
1658 VPRINTK("sixteen-byte command\n");
1659
1660 lba |= ((u64)cdb[2]) << 56;
1661 lba |= ((u64)cdb[3]) << 48;
1662 lba |= ((u64)cdb[4]) << 40;
1663 lba |= ((u64)cdb[5]) << 32;
1664 lba |= ((u64)cdb[6]) << 24;
1665 lba |= ((u64)cdb[7]) << 16;
1666 lba |= ((u64)cdb[8]) << 8;
1667 lba |= ((u64)cdb[9]);
1668
1669 len |= ((u32)cdb[10]) << 24;
1670 len |= ((u32)cdb[11]) << 16;
1671 len |= ((u32)cdb[12]) << 8;
1672 len |= ((u32)cdb[13]);
1673
1674 *plba = lba;
1675 *plen = len;
1676}
1677
1678/**
1679 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1680 * @qc: Storage for translated ATA taskfile
1681 *
1682 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1683 *
1684 * LOCKING:
1685 * spin_lock_irqsave(host lock)
1686 *
1687 * RETURNS:
1688 * Zero on success, non-zero on error.
1689 */
1690static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1691{
1692 struct scsi_cmnd *scmd = qc->scsicmd;
1693 struct ata_taskfile *tf = &qc->tf;
1694 struct ata_device *dev = qc->dev;
1695 u64 dev_sectors = qc->dev->n_sectors;
1696 const u8 *cdb = scmd->cmnd;
1697 u64 block;
1698 u32 n_block;
1699 u16 fp;
1700
1701 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1702 tf->protocol = ATA_PROT_NODATA;
1703
1704 if (cdb[0] == VERIFY) {
1705 if (scmd->cmd_len < 10) {
1706 fp = 9;
1707 goto invalid_fld;
1708 }
1709 scsi_10_lba_len(cdb, &block, &n_block);
1710 } else if (cdb[0] == VERIFY_16) {
1711 if (scmd->cmd_len < 16) {
1712 fp = 15;
1713 goto invalid_fld;
1714 }
1715 scsi_16_lba_len(cdb, &block, &n_block);
1716 } else {
1717 fp = 0;
1718 goto invalid_fld;
1719 }
1720
1721 if (!n_block)
1722 goto nothing_to_do;
1723 if (block >= dev_sectors)
1724 goto out_of_range;
1725 if ((block + n_block) > dev_sectors)
1726 goto out_of_range;
1727
1728 if (dev->flags & ATA_DFLAG_LBA) {
1729 tf->flags |= ATA_TFLAG_LBA;
1730
1731 if (lba_28_ok(block, n_block)) {
1732 /* use LBA28 */
1733 tf->command = ATA_CMD_VERIFY;
1734 tf->device |= (block >> 24) & 0xf;
1735 } else if (lba_48_ok(block, n_block)) {
1736 if (!(dev->flags & ATA_DFLAG_LBA48))
1737 goto out_of_range;
1738
1739 /* use LBA48 */
1740 tf->flags |= ATA_TFLAG_LBA48;
1741 tf->command = ATA_CMD_VERIFY_EXT;
1742
1743 tf->hob_nsect = (n_block >> 8) & 0xff;
1744
1745 tf->hob_lbah = (block >> 40) & 0xff;
1746 tf->hob_lbam = (block >> 32) & 0xff;
1747 tf->hob_lbal = (block >> 24) & 0xff;
1748 } else
1749 /* request too large even for LBA48 */
1750 goto out_of_range;
1751
1752 tf->nsect = n_block & 0xff;
1753
1754 tf->lbah = (block >> 16) & 0xff;
1755 tf->lbam = (block >> 8) & 0xff;
1756 tf->lbal = block & 0xff;
1757
1758 tf->device |= ATA_LBA;
1759 } else {
1760 /* CHS */
1761 u32 sect, head, cyl, track;
1762
1763 if (!lba_28_ok(block, n_block))
1764 goto out_of_range;
1765
1766 /* Convert LBA to CHS */
1767 track = (u32)block / dev->sectors;
1768 cyl = track / dev->heads;
1769 head = track % dev->heads;
1770 sect = (u32)block % dev->sectors + 1;
1771
1772 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1773 (u32)block, track, cyl, head, sect);
1774
1775 /* Check whether the converted CHS can fit.
1776 Cylinder: 0-65535
1777 Head: 0-15
1778 Sector: 1-255*/
1779 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1780 goto out_of_range;
1781
1782 tf->command = ATA_CMD_VERIFY;
1783 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1784 tf->lbal = sect;
1785 tf->lbam = cyl;
1786 tf->lbah = cyl >> 8;
1787 tf->device |= head;
1788 }
1789
1790 return 0;
1791
1792invalid_fld:
1793 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1794 return 1;
1795
1796out_of_range:
1797 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1798 /* "Logical Block Address out of range" */
1799 return 1;
1800
1801nothing_to_do:
1802 scmd->result = SAM_STAT_GOOD;
1803 return 1;
1804}
1805
1806static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1807{
1808 struct request *rq = scmd->request;
1809 u32 req_blocks;
1810
1811 if (!blk_rq_is_passthrough(rq))
1812 return true;
1813
1814 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1815 if (n_blocks > req_blocks)
1816 return false;
1817
1818 return true;
1819}
1820
1821/**
1822 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1823 * @qc: Storage for translated ATA taskfile
1824 *
1825 * Converts any of six SCSI read/write commands into the
1826 * ATA counterpart, including starting sector (LBA),
1827 * sector count, and taking into account the device's LBA48
1828 * support.
1829 *
1830 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1831 * %WRITE_16 are currently supported.
1832 *
1833 * LOCKING:
1834 * spin_lock_irqsave(host lock)
1835 *
1836 * RETURNS:
1837 * Zero on success, non-zero on error.
1838 */
1839static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1840{
1841 struct scsi_cmnd *scmd = qc->scsicmd;
1842 const u8 *cdb = scmd->cmnd;
1843 struct request *rq = scmd->request;
1844 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1845 unsigned int tf_flags = 0;
1846 u64 block;
1847 u32 n_block;
1848 int rc;
1849 u16 fp = 0;
1850
1851 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1852 tf_flags |= ATA_TFLAG_WRITE;
1853
1854 /* Calculate the SCSI LBA, transfer length and FUA. */
1855 switch (cdb[0]) {
1856 case READ_10:
1857 case WRITE_10:
1858 if (unlikely(scmd->cmd_len < 10)) {
1859 fp = 9;
1860 goto invalid_fld;
1861 }
1862 scsi_10_lba_len(cdb, &block, &n_block);
1863 if (cdb[1] & (1 << 3))
1864 tf_flags |= ATA_TFLAG_FUA;
1865 if (!ata_check_nblocks(scmd, n_block))
1866 goto invalid_fld;
1867 break;
1868 case READ_6:
1869 case WRITE_6:
1870 if (unlikely(scmd->cmd_len < 6)) {
1871 fp = 5;
1872 goto invalid_fld;
1873 }
1874 scsi_6_lba_len(cdb, &block, &n_block);
1875
1876 /* for 6-byte r/w commands, transfer length 0
1877 * means 256 blocks of data, not 0 block.
1878 */
1879 if (!n_block)
1880 n_block = 256;
1881 if (!ata_check_nblocks(scmd, n_block))
1882 goto invalid_fld;
1883 break;
1884 case READ_16:
1885 case WRITE_16:
1886 if (unlikely(scmd->cmd_len < 16)) {
1887 fp = 15;
1888 goto invalid_fld;
1889 }
1890 scsi_16_lba_len(cdb, &block, &n_block);
1891 if (cdb[1] & (1 << 3))
1892 tf_flags |= ATA_TFLAG_FUA;
1893 if (!ata_check_nblocks(scmd, n_block))
1894 goto invalid_fld;
1895 break;
1896 default:
1897 DPRINTK("no-byte command\n");
1898 fp = 0;
1899 goto invalid_fld;
1900 }
1901
1902 /* Check and compose ATA command */
1903 if (!n_block)
1904 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1905 * length 0 means transfer 0 block of data.
1906 * However, for ATA R/W commands, sector count 0 means
1907 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1908 *
1909 * WARNING: one or two older ATA drives treat 0 as 0...
1910 */
1911 goto nothing_to_do;
1912
1913 qc->flags |= ATA_QCFLAG_IO;
1914 qc->nbytes = n_block * scmd->device->sector_size;
1915
1916 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1917 qc->hw_tag, class);
1918
1919 if (likely(rc == 0))
1920 return 0;
1921
1922 if (rc == -ERANGE)
1923 goto out_of_range;
1924 /* treat all other errors as -EINVAL, fall through */
1925invalid_fld:
1926 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1927 return 1;
1928
1929out_of_range:
1930 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1931 /* "Logical Block Address out of range" */
1932 return 1;
1933
1934nothing_to_do:
1935 scmd->result = SAM_STAT_GOOD;
1936 return 1;
1937}
1938
1939static void ata_qc_done(struct ata_queued_cmd *qc)
1940{
1941 struct scsi_cmnd *cmd = qc->scsicmd;
1942 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1943
1944 ata_qc_free(qc);
1945 done(cmd);
1946}
1947
1948static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1949{
1950 struct ata_port *ap = qc->ap;
1951 struct scsi_cmnd *cmd = qc->scsicmd;
1952 u8 *cdb = cmd->cmnd;
1953 int need_sense = (qc->err_mask != 0);
1954
1955 /* For ATA pass thru (SAT) commands, generate a sense block if
1956 * user mandated it or if there's an error. Note that if we
1957 * generate because the user forced us to [CK_COND =1], a check
1958 * condition is generated and the ATA register values are returned
1959 * whether the command completed successfully or not. If there
1960 * was no error, we use the following sense data:
1961 * sk = RECOVERED ERROR
1962 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1963 */
1964 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1965 ((cdb[2] & 0x20) || need_sense))
1966 ata_gen_passthru_sense(qc);
1967 else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1968 cmd->result = SAM_STAT_CHECK_CONDITION;
1969 else if (need_sense)
1970 ata_gen_ata_sense(qc);
1971 else
1972 cmd->result = SAM_STAT_GOOD;
1973
1974 if (need_sense && !ap->ops->error_handler)
1975 ata_dump_status(ap->print_id, &qc->result_tf);
1976
1977 ata_qc_done(qc);
1978}
1979
1980/**
1981 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1982 * @dev: ATA device to which the command is addressed
1983 * @cmd: SCSI command to execute
1984 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1985 *
1986 * Our ->queuecommand() function has decided that the SCSI
1987 * command issued can be directly translated into an ATA
1988 * command, rather than handled internally.
1989 *
1990 * This function sets up an ata_queued_cmd structure for the
1991 * SCSI command, and sends that ata_queued_cmd to the hardware.
1992 *
1993 * The xlat_func argument (actor) returns 0 if ready to execute
1994 * ATA command, else 1 to finish translation. If 1 is returned
1995 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1996 * to be set reflecting an error condition or clean (early)
1997 * termination.
1998 *
1999 * LOCKING:
2000 * spin_lock_irqsave(host lock)
2001 *
2002 * RETURNS:
2003 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
2004 * needs to be deferred.
2005 */
2006static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
2007 ata_xlat_func_t xlat_func)
2008{
2009 struct ata_port *ap = dev->link->ap;
2010 struct ata_queued_cmd *qc;
2011 int rc;
2012
2013 VPRINTK("ENTER\n");
2014
2015 qc = ata_scsi_qc_new(dev, cmd);
2016 if (!qc)
2017 goto err_mem;
2018
2019 /* data is present; dma-map it */
2020 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
2021 cmd->sc_data_direction == DMA_TO_DEVICE) {
2022 if (unlikely(scsi_bufflen(cmd) < 1)) {
2023 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
2024 goto err_did;
2025 }
2026
2027 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
2028
2029 qc->dma_dir = cmd->sc_data_direction;
2030 }
2031
2032 qc->complete_fn = ata_scsi_qc_complete;
2033
2034 if (xlat_func(qc))
2035 goto early_finish;
2036
2037 if (ap->ops->qc_defer) {
2038 if ((rc = ap->ops->qc_defer(qc)))
2039 goto defer;
2040 }
2041
2042 /* select device, send command to hardware */
2043 ata_qc_issue(qc);
2044
2045 VPRINTK("EXIT\n");
2046 return 0;
2047
2048early_finish:
2049 ata_qc_free(qc);
2050 cmd->scsi_done(cmd);
2051 DPRINTK("EXIT - early finish (good or error)\n");
2052 return 0;
2053
2054err_did:
2055 ata_qc_free(qc);
2056 cmd->result = (DID_ERROR << 16);
2057 cmd->scsi_done(cmd);
2058err_mem:
2059 DPRINTK("EXIT - internal\n");
2060 return 0;
2061
2062defer:
2063 ata_qc_free(qc);
2064 DPRINTK("EXIT - defer\n");
2065 if (rc == ATA_DEFER_LINK)
2066 return SCSI_MLQUEUE_DEVICE_BUSY;
2067 else
2068 return SCSI_MLQUEUE_HOST_BUSY;
2069}
2070
2071struct ata_scsi_args {
2072 struct ata_device *dev;
2073 u16 *id;
2074 struct scsi_cmnd *cmd;
2075};
2076
2077/**
2078 * ata_scsi_rbuf_get - Map response buffer.
2079 * @cmd: SCSI command containing buffer to be mapped.
2080 * @flags: unsigned long variable to store irq enable status
2081 * @copy_in: copy in from user buffer
2082 *
2083 * Prepare buffer for simulated SCSI commands.
2084 *
2085 * LOCKING:
2086 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
2087 *
2088 * RETURNS:
2089 * Pointer to response buffer.
2090 */
2091static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
2092 unsigned long *flags)
2093{
2094 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
2095
2096 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
2097 if (copy_in)
2098 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2099 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2100 return ata_scsi_rbuf;
2101}
2102
2103/**
2104 * ata_scsi_rbuf_put - Unmap response buffer.
2105 * @cmd: SCSI command containing buffer to be unmapped.
2106 * @copy_out: copy out result
2107 * @flags: @flags passed to ata_scsi_rbuf_get()
2108 *
2109 * Returns rbuf buffer. The result is copied to @cmd's buffer if
2110 * @copy_back is true.
2111 *
2112 * LOCKING:
2113 * Unlocks ata_scsi_rbuf_lock.
2114 */
2115static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
2116 unsigned long *flags)
2117{
2118 if (copy_out)
2119 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2120 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2121 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
2122}
2123
2124/**
2125 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
2126 * @args: device IDENTIFY data / SCSI command of interest.
2127 * @actor: Callback hook for desired SCSI command simulator
2128 *
2129 * Takes care of the hard work of simulating a SCSI command...
2130 * Mapping the response buffer, calling the command's handler,
2131 * and handling the handler's return value. This return value
2132 * indicates whether the handler wishes the SCSI command to be
2133 * completed successfully (0), or not (in which case cmd->result
2134 * and sense buffer are assumed to be set).
2135 *
2136 * LOCKING:
2137 * spin_lock_irqsave(host lock)
2138 */
2139static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
2140 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
2141{
2142 u8 *rbuf;
2143 unsigned int rc;
2144 struct scsi_cmnd *cmd = args->cmd;
2145 unsigned long flags;
2146
2147 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
2148 rc = actor(args, rbuf);
2149 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
2150
2151 if (rc == 0)
2152 cmd->result = SAM_STAT_GOOD;
2153}
2154
2155/**
2156 * ata_scsiop_inq_std - Simulate INQUIRY command
2157 * @args: device IDENTIFY data / SCSI command of interest.
2158 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2159 *
2160 * Returns standard device identification data associated
2161 * with non-VPD INQUIRY command output.
2162 *
2163 * LOCKING:
2164 * spin_lock_irqsave(host lock)
2165 */
2166static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
2167{
2168 static const u8 versions[] = {
2169 0x00,
2170 0x60, /* SAM-3 (no version claimed) */
2171
2172 0x03,
2173 0x20, /* SBC-2 (no version claimed) */
2174
2175 0x03,
2176 0x00 /* SPC-3 (no version claimed) */
2177 };
2178 static const u8 versions_zbc[] = {
2179 0x00,
2180 0xA0, /* SAM-5 (no version claimed) */
2181
2182 0x06,
2183 0x00, /* SBC-4 (no version claimed) */
2184
2185 0x05,
2186 0xC0, /* SPC-5 (no version claimed) */
2187
2188 0x60,
2189 0x24, /* ZBC r05 */
2190 };
2191
2192 u8 hdr[] = {
2193 TYPE_DISK,
2194 0,
2195 0x5, /* claim SPC-3 version compatibility */
2196 2,
2197 95 - 4,
2198 0,
2199 0,
2200 2
2201 };
2202
2203 VPRINTK("ENTER\n");
2204
2205 /* set scsi removable (RMB) bit per ata bit, or if the
2206 * AHCI port says it's external (Hotplug-capable, eSATA).
2207 */
2208 if (ata_id_removable(args->id) ||
2209 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
2210 hdr[1] |= (1 << 7);
2211
2212 if (args->dev->class == ATA_DEV_ZAC) {
2213 hdr[0] = TYPE_ZBC;
2214 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
2215 }
2216
2217 memcpy(rbuf, hdr, sizeof(hdr));
2218 memcpy(&rbuf[8], "ATA ", 8);
2219 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
2220
2221 /* From SAT, use last 2 words from fw rev unless they are spaces */
2222 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2223 if (strncmp(&rbuf[32], " ", 4) == 0)
2224 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2225
2226 if (rbuf[32] == 0 || rbuf[32] == ' ')
2227 memcpy(&rbuf[32], "n/a ", 4);
2228
2229 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
2230 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2231 else
2232 memcpy(rbuf + 58, versions, sizeof(versions));
2233
2234 return 0;
2235}
2236
2237/**
2238 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2239 * @args: device IDENTIFY data / SCSI command of interest.
2240 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2241 *
2242 * Returns list of inquiry VPD pages available.
2243 *
2244 * LOCKING:
2245 * spin_lock_irqsave(host lock)
2246 */
2247static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2248{
2249 int num_pages;
2250 static const u8 pages[] = {
2251 0x00, /* page 0x00, this page */
2252 0x80, /* page 0x80, unit serial no page */
2253 0x83, /* page 0x83, device ident page */
2254 0x89, /* page 0x89, ata info page */
2255 0xb0, /* page 0xb0, block limits page */
2256 0xb1, /* page 0xb1, block device characteristics page */
2257 0xb2, /* page 0xb2, thin provisioning page */
2258 0xb6, /* page 0xb6, zoned block device characteristics */
2259 };
2260
2261 num_pages = sizeof(pages);
2262 if (!(args->dev->flags & ATA_DFLAG_ZAC))
2263 num_pages--;
2264 rbuf[3] = num_pages; /* number of supported VPD pages */
2265 memcpy(rbuf + 4, pages, num_pages);
2266 return 0;
2267}
2268
2269/**
2270 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2271 * @args: device IDENTIFY data / SCSI command of interest.
2272 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2273 *
2274 * Returns ATA device serial number.
2275 *
2276 * LOCKING:
2277 * spin_lock_irqsave(host lock)
2278 */
2279static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2280{
2281 static const u8 hdr[] = {
2282 0,
2283 0x80, /* this page code */
2284 0,
2285 ATA_ID_SERNO_LEN, /* page len */
2286 };
2287
2288 memcpy(rbuf, hdr, sizeof(hdr));
2289 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2290 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2291 return 0;
2292}
2293
2294/**
2295 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2296 * @args: device IDENTIFY data / SCSI command of interest.
2297 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2298 *
2299 * Yields two logical unit device identification designators:
2300 * - vendor specific ASCII containing the ATA serial number
2301 * - SAT defined "t10 vendor id based" containing ASCII vendor
2302 * name ("ATA "), model and serial numbers.
2303 *
2304 * LOCKING:
2305 * spin_lock_irqsave(host lock)
2306 */
2307static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2308{
2309 const int sat_model_serial_desc_len = 68;
2310 int num;
2311
2312 rbuf[1] = 0x83; /* this page code */
2313 num = 4;
2314
2315 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2316 rbuf[num + 0] = 2;
2317 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2318 num += 4;
2319 ata_id_string(args->id, (unsigned char *) rbuf + num,
2320 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2321 num += ATA_ID_SERNO_LEN;
2322
2323 /* SAT defined lu model and serial numbers descriptor */
2324 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2325 rbuf[num + 0] = 2;
2326 rbuf[num + 1] = 1;
2327 rbuf[num + 3] = sat_model_serial_desc_len;
2328 num += 4;
2329 memcpy(rbuf + num, "ATA ", 8);
2330 num += 8;
2331 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2332 ATA_ID_PROD_LEN);
2333 num += ATA_ID_PROD_LEN;
2334 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2335 ATA_ID_SERNO_LEN);
2336 num += ATA_ID_SERNO_LEN;
2337
2338 if (ata_id_has_wwn(args->id)) {
2339 /* SAT defined lu world wide name */
2340 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2341 rbuf[num + 0] = 1;
2342 rbuf[num + 1] = 3;
2343 rbuf[num + 3] = ATA_ID_WWN_LEN;
2344 num += 4;
2345 ata_id_string(args->id, (unsigned char *) rbuf + num,
2346 ATA_ID_WWN, ATA_ID_WWN_LEN);
2347 num += ATA_ID_WWN_LEN;
2348 }
2349 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2350 return 0;
2351}
2352
2353/**
2354 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2355 * @args: device IDENTIFY data / SCSI command of interest.
2356 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2357 *
2358 * Yields SAT-specified ATA VPD page.
2359 *
2360 * LOCKING:
2361 * spin_lock_irqsave(host lock)
2362 */
2363static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2364{
2365 struct ata_taskfile tf;
2366
2367 memset(&tf, 0, sizeof(tf));
2368
2369 rbuf[1] = 0x89; /* our page code */
2370 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2371 rbuf[3] = (0x238 & 0xff);
2372
2373 memcpy(&rbuf[8], "linux ", 8);
2374 memcpy(&rbuf[16], "libata ", 16);
2375 memcpy(&rbuf[32], DRV_VERSION, 4);
2376
2377 /* we don't store the ATA device signature, so we fake it */
2378
2379 tf.command = ATA_DRDY; /* really, this is Status reg */
2380 tf.lbal = 0x1;
2381 tf.nsect = 0x1;
2382
2383 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2384 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2385
2386 rbuf[56] = ATA_CMD_ID_ATA;
2387
2388 memcpy(&rbuf[60], &args->id[0], 512);
2389 return 0;
2390}
2391
2392static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2393{
2394 u16 min_io_sectors;
2395
2396 rbuf[1] = 0xb0;
2397 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2398
2399 /*
2400 * Optimal transfer length granularity.
2401 *
2402 * This is always one physical block, but for disks with a smaller
2403 * logical than physical sector size we need to figure out what the
2404 * latter is.
2405 */
2406 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2407 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2408
2409 /*
2410 * Optimal unmap granularity.
2411 *
2412 * The ATA spec doesn't even know about a granularity or alignment
2413 * for the TRIM command. We can leave away most of the unmap related
2414 * VPD page entries, but we have specifify a granularity to signal
2415 * that we support some form of unmap - in thise case via WRITE SAME
2416 * with the unmap bit set.
2417 */
2418 if (ata_id_has_trim(args->id)) {
2419 put_unaligned_be64(65535 * ATA_MAX_TRIM_RNUM, &rbuf[36]);
2420 put_unaligned_be32(1, &rbuf[28]);
2421 }
2422
2423 return 0;
2424}
2425
2426static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2427{
2428 int form_factor = ata_id_form_factor(args->id);
2429 int media_rotation_rate = ata_id_rotation_rate(args->id);
2430 u8 zoned = ata_id_zoned_cap(args->id);
2431
2432 rbuf[1] = 0xb1;
2433 rbuf[3] = 0x3c;
2434 rbuf[4] = media_rotation_rate >> 8;
2435 rbuf[5] = media_rotation_rate;
2436 rbuf[7] = form_factor;
2437 if (zoned)
2438 rbuf[8] = (zoned << 4);
2439
2440 return 0;
2441}
2442
2443static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2444{
2445 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2446 rbuf[1] = 0xb2;
2447 rbuf[3] = 0x4;
2448 rbuf[5] = 1 << 6; /* TPWS */
2449
2450 return 0;
2451}
2452
2453static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2454{
2455 /*
2456 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2457 */
2458 rbuf[1] = 0xb6;
2459 rbuf[3] = 0x3C;
2460
2461 /*
2462 * URSWRZ bit is only meaningful for host-managed ZAC drives
2463 */
2464 if (args->dev->zac_zoned_cap & 1)
2465 rbuf[4] |= 1;
2466 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2467 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2468 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2469
2470 return 0;
2471}
2472
2473/**
2474 * modecpy - Prepare response for MODE SENSE
2475 * @dest: output buffer
2476 * @src: data being copied
2477 * @n: length of mode page
2478 * @changeable: whether changeable parameters are requested
2479 *
2480 * Generate a generic MODE SENSE page for either current or changeable
2481 * parameters.
2482 *
2483 * LOCKING:
2484 * None.
2485 */
2486static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2487{
2488 if (changeable) {
2489 memcpy(dest, src, 2);
2490 memset(dest + 2, 0, n - 2);
2491 } else {
2492 memcpy(dest, src, n);
2493 }
2494}
2495
2496/**
2497 * ata_msense_caching - Simulate MODE SENSE caching info page
2498 * @id: device IDENTIFY data
2499 * @buf: output buffer
2500 * @changeable: whether changeable parameters are requested
2501 *
2502 * Generate a caching info page, which conditionally indicates
2503 * write caching to the SCSI layer, depending on device
2504 * capabilities.
2505 *
2506 * LOCKING:
2507 * None.
2508 */
2509static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2510{
2511 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2512 if (changeable) {
2513 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2514 } else {
2515 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2516 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2517 }
2518 return sizeof(def_cache_mpage);
2519}
2520
2521/**
2522 * ata_msense_control - Simulate MODE SENSE control mode page
2523 * @dev: ATA device of interest
2524 * @buf: output buffer
2525 * @changeable: whether changeable parameters are requested
2526 *
2527 * Generate a generic MODE SENSE control mode page.
2528 *
2529 * LOCKING:
2530 * None.
2531 */
2532static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2533 bool changeable)
2534{
2535 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2536 if (changeable) {
2537 buf[2] |= (1 << 2); /* ata_mselect_control() */
2538 } else {
2539 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2540
2541 buf[2] |= (d_sense << 2); /* descriptor format sense data */
2542 }
2543 return sizeof(def_control_mpage);
2544}
2545
2546/**
2547 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2548 * @buf: output buffer
2549 * @changeable: whether changeable parameters are requested
2550 *
2551 * Generate a generic MODE SENSE r/w error recovery page.
2552 *
2553 * LOCKING:
2554 * None.
2555 */
2556static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2557{
2558 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2559 changeable);
2560 return sizeof(def_rw_recovery_mpage);
2561}
2562
2563/*
2564 * We can turn this into a real blacklist if it's needed, for now just
2565 * blacklist any Maxtor BANC1G10 revision firmware
2566 */
2567static int ata_dev_supports_fua(u16 *id)
2568{
2569 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2570
2571 if (!libata_fua)
2572 return 0;
2573 if (!ata_id_has_fua(id))
2574 return 0;
2575
2576 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2577 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2578
2579 if (strcmp(model, "Maxtor"))
2580 return 1;
2581 if (strcmp(fw, "BANC1G10"))
2582 return 1;
2583
2584 return 0; /* blacklisted */
2585}
2586
2587/**
2588 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2589 * @args: device IDENTIFY data / SCSI command of interest.
2590 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2591 *
2592 * Simulate MODE SENSE commands. Assume this is invoked for direct
2593 * access devices (e.g. disks) only. There should be no block
2594 * descriptor for other device types.
2595 *
2596 * LOCKING:
2597 * spin_lock_irqsave(host lock)
2598 */
2599static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2600{
2601 struct ata_device *dev = args->dev;
2602 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2603 static const u8 sat_blk_desc[] = {
2604 0, 0, 0, 0, /* number of blocks: sat unspecified */
2605 0,
2606 0, 0x2, 0x0 /* block length: 512 bytes */
2607 };
2608 u8 pg, spg;
2609 unsigned int ebd, page_control, six_byte;
2610 u8 dpofua, bp = 0xff;
2611 u16 fp;
2612
2613 VPRINTK("ENTER\n");
2614
2615 six_byte = (scsicmd[0] == MODE_SENSE);
2616 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2617 /*
2618 * LLBA bit in msense(10) ignored (compliant)
2619 */
2620
2621 page_control = scsicmd[2] >> 6;
2622 switch (page_control) {
2623 case 0: /* current */
2624 case 1: /* changeable */
2625 case 2: /* defaults */
2626 break; /* supported */
2627 case 3: /* saved */
2628 goto saving_not_supp;
2629 default:
2630 fp = 2;
2631 bp = 6;
2632 goto invalid_fld;
2633 }
2634
2635 if (six_byte)
2636 p += 4 + (ebd ? 8 : 0);
2637 else
2638 p += 8 + (ebd ? 8 : 0);
2639
2640 pg = scsicmd[2] & 0x3f;
2641 spg = scsicmd[3];
2642 /*
2643 * No mode subpages supported (yet) but asking for _all_
2644 * subpages may be valid
2645 */
2646 if (spg && (spg != ALL_SUB_MPAGES)) {
2647 fp = 3;
2648 goto invalid_fld;
2649 }
2650
2651 switch(pg) {
2652 case RW_RECOVERY_MPAGE:
2653 p += ata_msense_rw_recovery(p, page_control == 1);
2654 break;
2655
2656 case CACHE_MPAGE:
2657 p += ata_msense_caching(args->id, p, page_control == 1);
2658 break;
2659
2660 case CONTROL_MPAGE:
2661 p += ata_msense_control(args->dev, p, page_control == 1);
2662 break;
2663
2664 case ALL_MPAGES:
2665 p += ata_msense_rw_recovery(p, page_control == 1);
2666 p += ata_msense_caching(args->id, p, page_control == 1);
2667 p += ata_msense_control(args->dev, p, page_control == 1);
2668 break;
2669
2670 default: /* invalid page code */
2671 fp = 2;
2672 goto invalid_fld;
2673 }
2674
2675 dpofua = 0;
2676 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2677 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2678 dpofua = 1 << 4;
2679
2680 if (six_byte) {
2681 rbuf[0] = p - rbuf - 1;
2682 rbuf[2] |= dpofua;
2683 if (ebd) {
2684 rbuf[3] = sizeof(sat_blk_desc);
2685 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2686 }
2687 } else {
2688 unsigned int output_len = p - rbuf - 2;
2689
2690 rbuf[0] = output_len >> 8;
2691 rbuf[1] = output_len;
2692 rbuf[3] |= dpofua;
2693 if (ebd) {
2694 rbuf[7] = sizeof(sat_blk_desc);
2695 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2696 }
2697 }
2698 return 0;
2699
2700invalid_fld:
2701 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2702 return 1;
2703
2704saving_not_supp:
2705 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2706 /* "Saving parameters not supported" */
2707 return 1;
2708}
2709
2710/**
2711 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2712 * @args: device IDENTIFY data / SCSI command of interest.
2713 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2714 *
2715 * Simulate READ CAPACITY commands.
2716 *
2717 * LOCKING:
2718 * None.
2719 */
2720static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2721{
2722 struct ata_device *dev = args->dev;
2723 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2724 u32 sector_size; /* physical sector size in bytes */
2725 u8 log2_per_phys;
2726 u16 lowest_aligned;
2727
2728 sector_size = ata_id_logical_sector_size(dev->id);
2729 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2730 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2731
2732 VPRINTK("ENTER\n");
2733
2734 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2735 if (last_lba >= 0xffffffffULL)
2736 last_lba = 0xffffffff;
2737
2738 /* sector count, 32-bit */
2739 rbuf[0] = last_lba >> (8 * 3);
2740 rbuf[1] = last_lba >> (8 * 2);
2741 rbuf[2] = last_lba >> (8 * 1);
2742 rbuf[3] = last_lba;
2743
2744 /* sector size */
2745 rbuf[4] = sector_size >> (8 * 3);
2746 rbuf[5] = sector_size >> (8 * 2);
2747 rbuf[6] = sector_size >> (8 * 1);
2748 rbuf[7] = sector_size;
2749 } else {
2750 /* sector count, 64-bit */
2751 rbuf[0] = last_lba >> (8 * 7);
2752 rbuf[1] = last_lba >> (8 * 6);
2753 rbuf[2] = last_lba >> (8 * 5);
2754 rbuf[3] = last_lba >> (8 * 4);
2755 rbuf[4] = last_lba >> (8 * 3);
2756 rbuf[5] = last_lba >> (8 * 2);
2757 rbuf[6] = last_lba >> (8 * 1);
2758 rbuf[7] = last_lba;
2759
2760 /* sector size */
2761 rbuf[ 8] = sector_size >> (8 * 3);
2762 rbuf[ 9] = sector_size >> (8 * 2);
2763 rbuf[10] = sector_size >> (8 * 1);
2764 rbuf[11] = sector_size;
2765
2766 rbuf[12] = 0;
2767 rbuf[13] = log2_per_phys;
2768 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2769 rbuf[15] = lowest_aligned;
2770
2771 if (ata_id_has_trim(args->id) &&
2772 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2773 rbuf[14] |= 0x80; /* LBPME */
2774
2775 if (ata_id_has_zero_after_trim(args->id) &&
2776 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2777 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2778 rbuf[14] |= 0x40; /* LBPRZ */
2779 }
2780 }
2781 if (ata_id_zoned_cap(args->id) ||
2782 args->dev->class == ATA_DEV_ZAC)
2783 rbuf[12] = (1 << 4); /* RC_BASIS */
2784 }
2785 return 0;
2786}
2787
2788/**
2789 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2790 * @args: device IDENTIFY data / SCSI command of interest.
2791 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2792 *
2793 * Simulate REPORT LUNS command.
2794 *
2795 * LOCKING:
2796 * spin_lock_irqsave(host lock)
2797 */
2798static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2799{
2800 VPRINTK("ENTER\n");
2801 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2802
2803 return 0;
2804}
2805
2806static void atapi_sense_complete(struct ata_queued_cmd *qc)
2807{
2808 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2809 /* FIXME: not quite right; we don't want the
2810 * translation of taskfile registers into
2811 * a sense descriptors, since that's only
2812 * correct for ATA, not ATAPI
2813 */
2814 ata_gen_passthru_sense(qc);
2815 }
2816
2817 ata_qc_done(qc);
2818}
2819
2820/* is it pointless to prefer PIO for "safety reasons"? */
2821static inline int ata_pio_use_silly(struct ata_port *ap)
2822{
2823 return (ap->flags & ATA_FLAG_PIO_DMA);
2824}
2825
2826static void atapi_request_sense(struct ata_queued_cmd *qc)
2827{
2828 struct ata_port *ap = qc->ap;
2829 struct scsi_cmnd *cmd = qc->scsicmd;
2830
2831 DPRINTK("ATAPI request sense\n");
2832
2833 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2834
2835#ifdef CONFIG_ATA_SFF
2836 if (ap->ops->sff_tf_read)
2837 ap->ops->sff_tf_read(ap, &qc->tf);
2838#endif
2839
2840 /* fill these in, for the case where they are -not- overwritten */
2841 cmd->sense_buffer[0] = 0x70;
2842 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2843
2844 ata_qc_reinit(qc);
2845
2846 /* setup sg table and init transfer direction */
2847 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2848 ata_sg_init(qc, &qc->sgent, 1);
2849 qc->dma_dir = DMA_FROM_DEVICE;
2850
2851 memset(&qc->cdb, 0, qc->dev->cdb_len);
2852 qc->cdb[0] = REQUEST_SENSE;
2853 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2854
2855 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2856 qc->tf.command = ATA_CMD_PACKET;
2857
2858 if (ata_pio_use_silly(ap)) {
2859 qc->tf.protocol = ATAPI_PROT_DMA;
2860 qc->tf.feature |= ATAPI_PKT_DMA;
2861 } else {
2862 qc->tf.protocol = ATAPI_PROT_PIO;
2863 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2864 qc->tf.lbah = 0;
2865 }
2866 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2867
2868 qc->complete_fn = atapi_sense_complete;
2869
2870 ata_qc_issue(qc);
2871
2872 DPRINTK("EXIT\n");
2873}
2874
2875/*
2876 * ATAPI devices typically report zero for their SCSI version, and sometimes
2877 * deviate from the spec WRT response data format. If SCSI version is
2878 * reported as zero like normal, then we make the following fixups:
2879 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2880 * modern device.
2881 * 2) Ensure response data format / ATAPI information are always correct.
2882 */
2883static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2884{
2885 u8 buf[4];
2886
2887 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2888 if (buf[2] == 0) {
2889 buf[2] = 0x5;
2890 buf[3] = 0x32;
2891 }
2892 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2893}
2894
2895static void atapi_qc_complete(struct ata_queued_cmd *qc)
2896{
2897 struct scsi_cmnd *cmd = qc->scsicmd;
2898 unsigned int err_mask = qc->err_mask;
2899
2900 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2901
2902 /* handle completion from new EH */
2903 if (unlikely(qc->ap->ops->error_handler &&
2904 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2905
2906 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2907 /* FIXME: not quite right; we don't want the
2908 * translation of taskfile registers into a
2909 * sense descriptors, since that's only
2910 * correct for ATA, not ATAPI
2911 */
2912 ata_gen_passthru_sense(qc);
2913 }
2914
2915 /* SCSI EH automatically locks door if sdev->locked is
2916 * set. Sometimes door lock request continues to
2917 * fail, for example, when no media is present. This
2918 * creates a loop - SCSI EH issues door lock which
2919 * fails and gets invoked again to acquire sense data
2920 * for the failed command.
2921 *
2922 * If door lock fails, always clear sdev->locked to
2923 * avoid this infinite loop.
2924 *
2925 * This may happen before SCSI scan is complete. Make
2926 * sure qc->dev->sdev isn't NULL before dereferencing.
2927 */
2928 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2929 qc->dev->sdev->locked = 0;
2930
2931 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2932 ata_qc_done(qc);
2933 return;
2934 }
2935
2936 /* successful completion or old EH failure path */
2937 if (unlikely(err_mask & AC_ERR_DEV)) {
2938 cmd->result = SAM_STAT_CHECK_CONDITION;
2939 atapi_request_sense(qc);
2940 return;
2941 } else if (unlikely(err_mask)) {
2942 /* FIXME: not quite right; we don't want the
2943 * translation of taskfile registers into
2944 * a sense descriptors, since that's only
2945 * correct for ATA, not ATAPI
2946 */
2947 ata_gen_passthru_sense(qc);
2948 } else {
2949 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2950 atapi_fixup_inquiry(cmd);
2951 cmd->result = SAM_STAT_GOOD;
2952 }
2953
2954 ata_qc_done(qc);
2955}
2956/**
2957 * atapi_xlat - Initialize PACKET taskfile
2958 * @qc: command structure to be initialized
2959 *
2960 * LOCKING:
2961 * spin_lock_irqsave(host lock)
2962 *
2963 * RETURNS:
2964 * Zero on success, non-zero on failure.
2965 */
2966static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2967{
2968 struct scsi_cmnd *scmd = qc->scsicmd;
2969 struct ata_device *dev = qc->dev;
2970 int nodata = (scmd->sc_data_direction == DMA_NONE);
2971 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2972 unsigned int nbytes;
2973
2974 memset(qc->cdb, 0, dev->cdb_len);
2975 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2976
2977 qc->complete_fn = atapi_qc_complete;
2978
2979 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2980 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2981 qc->tf.flags |= ATA_TFLAG_WRITE;
2982 DPRINTK("direction: write\n");
2983 }
2984
2985 qc->tf.command = ATA_CMD_PACKET;
2986 ata_qc_set_pc_nbytes(qc);
2987
2988 /* check whether ATAPI DMA is safe */
2989 if (!nodata && !using_pio && atapi_check_dma(qc))
2990 using_pio = 1;
2991
2992 /* Some controller variants snoop this value for Packet
2993 * transfers to do state machine and FIFO management. Thus we
2994 * want to set it properly, and for DMA where it is
2995 * effectively meaningless.
2996 */
2997 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2998
2999 /* Most ATAPI devices which honor transfer chunk size don't
3000 * behave according to the spec when odd chunk size which
3001 * matches the transfer length is specified. If the number of
3002 * bytes to transfer is 2n+1. According to the spec, what
3003 * should happen is to indicate that 2n+1 is going to be
3004 * transferred and transfer 2n+2 bytes where the last byte is
3005 * padding.
3006 *
3007 * In practice, this doesn't happen. ATAPI devices first
3008 * indicate and transfer 2n bytes and then indicate and
3009 * transfer 2 bytes where the last byte is padding.
3010 *
3011 * This inconsistency confuses several controllers which
3012 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
3013 * These controllers use actual number of transferred bytes to
3014 * update DMA poitner and transfer of 4n+2 bytes make those
3015 * controller push DMA pointer by 4n+4 bytes because SATA data
3016 * FISes are aligned to 4 bytes. This causes data corruption
3017 * and buffer overrun.
3018 *
3019 * Always setting nbytes to even number solves this problem
3020 * because then ATAPI devices don't have to split data at 2n
3021 * boundaries.
3022 */
3023 if (nbytes & 0x1)
3024 nbytes++;
3025
3026 qc->tf.lbam = (nbytes & 0xFF);
3027 qc->tf.lbah = (nbytes >> 8);
3028
3029 if (nodata)
3030 qc->tf.protocol = ATAPI_PROT_NODATA;
3031 else if (using_pio)
3032 qc->tf.protocol = ATAPI_PROT_PIO;
3033 else {
3034 /* DMA data xfer */
3035 qc->tf.protocol = ATAPI_PROT_DMA;
3036 qc->tf.feature |= ATAPI_PKT_DMA;
3037
3038 if ((dev->flags & ATA_DFLAG_DMADIR) &&
3039 (scmd->sc_data_direction != DMA_TO_DEVICE))
3040 /* some SATA bridges need us to indicate data xfer direction */
3041 qc->tf.feature |= ATAPI_DMADIR;
3042 }
3043
3044
3045 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
3046 as ATAPI tape drives don't get this right otherwise */
3047 return 0;
3048}
3049
3050static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
3051{
3052 if (!sata_pmp_attached(ap)) {
3053 if (likely(devno >= 0 &&
3054 devno < ata_link_max_devices(&ap->link)))
3055 return &ap->link.device[devno];
3056 } else {
3057 if (likely(devno >= 0 &&
3058 devno < ap->nr_pmp_links))
3059 return &ap->pmp_link[devno].device[0];
3060 }
3061
3062 return NULL;
3063}
3064
3065static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
3066 const struct scsi_device *scsidev)
3067{
3068 int devno;
3069
3070 /* skip commands not addressed to targets we simulate */
3071 if (!sata_pmp_attached(ap)) {
3072 if (unlikely(scsidev->channel || scsidev->lun))
3073 return NULL;
3074 devno = scsidev->id;
3075 } else {
3076 if (unlikely(scsidev->id || scsidev->lun))
3077 return NULL;
3078 devno = scsidev->channel;
3079 }
3080
3081 return ata_find_dev(ap, devno);
3082}
3083
3084/**
3085 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
3086 * @ap: ATA port to which the device is attached
3087 * @scsidev: SCSI device from which we derive the ATA device
3088 *
3089 * Given various information provided in struct scsi_cmnd,
3090 * map that onto an ATA bus, and using that mapping
3091 * determine which ata_device is associated with the
3092 * SCSI command to be sent.
3093 *
3094 * LOCKING:
3095 * spin_lock_irqsave(host lock)
3096 *
3097 * RETURNS:
3098 * Associated ATA device, or %NULL if not found.
3099 */
3100static struct ata_device *
3101ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
3102{
3103 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
3104
3105 if (unlikely(!dev || !ata_dev_enabled(dev)))
3106 return NULL;
3107
3108 return dev;
3109}
3110
3111/*
3112 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
3113 * @byte1: Byte 1 from pass-thru CDB.
3114 *
3115 * RETURNS:
3116 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
3117 */
3118static u8
3119ata_scsi_map_proto(u8 byte1)
3120{
3121 switch((byte1 & 0x1e) >> 1) {
3122 case 3: /* Non-data */
3123 return ATA_PROT_NODATA;
3124
3125 case 6: /* DMA */
3126 case 10: /* UDMA Data-in */
3127 case 11: /* UDMA Data-Out */
3128 return ATA_PROT_DMA;
3129
3130 case 4: /* PIO Data-in */
3131 case 5: /* PIO Data-out */
3132 return ATA_PROT_PIO;
3133
3134 case 12: /* FPDMA */
3135 return ATA_PROT_NCQ;
3136
3137 case 0: /* Hard Reset */
3138 case 1: /* SRST */
3139 case 8: /* Device Diagnostic */
3140 case 9: /* Device Reset */
3141 case 7: /* DMA Queued */
3142 case 15: /* Return Response Info */
3143 default: /* Reserved */
3144 break;
3145 }
3146
3147 return ATA_PROT_UNKNOWN;
3148}
3149
3150/**
3151 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
3152 * @qc: command structure to be initialized
3153 *
3154 * Handles either 12, 16, or 32-byte versions of the CDB.
3155 *
3156 * RETURNS:
3157 * Zero on success, non-zero on failure.
3158 */
3159static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
3160{
3161 struct ata_taskfile *tf = &(qc->tf);
3162 struct scsi_cmnd *scmd = qc->scsicmd;
3163 struct ata_device *dev = qc->dev;
3164 const u8 *cdb = scmd->cmnd;
3165 u16 fp;
3166 u16 cdb_offset = 0;
3167
3168 /* 7Fh variable length cmd means a ata pass-thru(32) */
3169 if (cdb[0] == VARIABLE_LENGTH_CMD)
3170 cdb_offset = 9;
3171
3172 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
3173 if (tf->protocol == ATA_PROT_UNKNOWN) {
3174 fp = 1;
3175 goto invalid_fld;
3176 }
3177
3178 if (ata_is_ncq(tf->protocol) && (cdb[2 + cdb_offset] & 0x3) == 0)
3179 tf->protocol = ATA_PROT_NCQ_NODATA;
3180
3181 /* enable LBA */
3182 tf->flags |= ATA_TFLAG_LBA;
3183
3184 /*
3185 * 12 and 16 byte CDBs use different offsets to
3186 * provide the various register values.
3187 */
3188 if (cdb[0] == ATA_16) {
3189 /*
3190 * 16-byte CDB - may contain extended commands.
3191 *
3192 * If that is the case, copy the upper byte register values.
3193 */
3194 if (cdb[1] & 0x01) {
3195 tf->hob_feature = cdb[3];
3196 tf->hob_nsect = cdb[5];
3197 tf->hob_lbal = cdb[7];
3198 tf->hob_lbam = cdb[9];
3199 tf->hob_lbah = cdb[11];
3200 tf->flags |= ATA_TFLAG_LBA48;
3201 } else
3202 tf->flags &= ~ATA_TFLAG_LBA48;
3203
3204 /*
3205 * Always copy low byte, device and command registers.
3206 */
3207 tf->feature = cdb[4];
3208 tf->nsect = cdb[6];
3209 tf->lbal = cdb[8];
3210 tf->lbam = cdb[10];
3211 tf->lbah = cdb[12];
3212 tf->device = cdb[13];
3213 tf->command = cdb[14];
3214 } else if (cdb[0] == ATA_12) {
3215 /*
3216 * 12-byte CDB - incapable of extended commands.
3217 */
3218 tf->flags &= ~ATA_TFLAG_LBA48;
3219
3220 tf->feature = cdb[3];
3221 tf->nsect = cdb[4];
3222 tf->lbal = cdb[5];
3223 tf->lbam = cdb[6];
3224 tf->lbah = cdb[7];
3225 tf->device = cdb[8];
3226 tf->command = cdb[9];
3227 } else {
3228 /*
3229 * 32-byte CDB - may contain extended command fields.
3230 *
3231 * If that is the case, copy the upper byte register values.
3232 */
3233 if (cdb[10] & 0x01) {
3234 tf->hob_feature = cdb[20];
3235 tf->hob_nsect = cdb[22];
3236 tf->hob_lbal = cdb[16];
3237 tf->hob_lbam = cdb[15];
3238 tf->hob_lbah = cdb[14];
3239 tf->flags |= ATA_TFLAG_LBA48;
3240 } else
3241 tf->flags &= ~ATA_TFLAG_LBA48;
3242
3243 tf->feature = cdb[21];
3244 tf->nsect = cdb[23];
3245 tf->lbal = cdb[19];
3246 tf->lbam = cdb[18];
3247 tf->lbah = cdb[17];
3248 tf->device = cdb[24];
3249 tf->command = cdb[25];
3250 tf->auxiliary = get_unaligned_be32(&cdb[28]);
3251 }
3252
3253 /* For NCQ commands copy the tag value */
3254 if (ata_is_ncq(tf->protocol))
3255 tf->nsect = qc->hw_tag << 3;
3256
3257 /* enforce correct master/slave bit */
3258 tf->device = dev->devno ?
3259 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3260
3261 switch (tf->command) {
3262 /* READ/WRITE LONG use a non-standard sect_size */
3263 case ATA_CMD_READ_LONG:
3264 case ATA_CMD_READ_LONG_ONCE:
3265 case ATA_CMD_WRITE_LONG:
3266 case ATA_CMD_WRITE_LONG_ONCE:
3267 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3268 fp = 1;
3269 goto invalid_fld;
3270 }
3271 qc->sect_size = scsi_bufflen(scmd);
3272 break;
3273
3274 /* commands using reported Logical Block size (e.g. 512 or 4K) */
3275 case ATA_CMD_CFA_WRITE_NE:
3276 case ATA_CMD_CFA_TRANS_SECT:
3277 case ATA_CMD_CFA_WRITE_MULT_NE:
3278 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3279 case ATA_CMD_READ:
3280 case ATA_CMD_READ_EXT:
3281 case ATA_CMD_READ_QUEUED:
3282 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3283 case ATA_CMD_FPDMA_READ:
3284 case ATA_CMD_READ_MULTI:
3285 case ATA_CMD_READ_MULTI_EXT:
3286 case ATA_CMD_PIO_READ:
3287 case ATA_CMD_PIO_READ_EXT:
3288 case ATA_CMD_READ_STREAM_DMA_EXT:
3289 case ATA_CMD_READ_STREAM_EXT:
3290 case ATA_CMD_VERIFY:
3291 case ATA_CMD_VERIFY_EXT:
3292 case ATA_CMD_WRITE:
3293 case ATA_CMD_WRITE_EXT:
3294 case ATA_CMD_WRITE_FUA_EXT:
3295 case ATA_CMD_WRITE_QUEUED:
3296 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3297 case ATA_CMD_FPDMA_WRITE:
3298 case ATA_CMD_WRITE_MULTI:
3299 case ATA_CMD_WRITE_MULTI_EXT:
3300 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3301 case ATA_CMD_PIO_WRITE:
3302 case ATA_CMD_PIO_WRITE_EXT:
3303 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3304 case ATA_CMD_WRITE_STREAM_EXT:
3305 qc->sect_size = scmd->device->sector_size;
3306 break;
3307
3308 /* Everything else uses 512 byte "sectors" */
3309 default:
3310 qc->sect_size = ATA_SECT_SIZE;
3311 }
3312
3313 /*
3314 * Set flags so that all registers will be written, pass on
3315 * write indication (used for PIO/DMA setup), result TF is
3316 * copied back and we don't whine too much about its failure.
3317 */
3318 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3319 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3320 tf->flags |= ATA_TFLAG_WRITE;
3321
3322 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3323
3324 /*
3325 * Set transfer length.
3326 *
3327 * TODO: find out if we need to do more here to
3328 * cover scatter/gather case.
3329 */
3330 ata_qc_set_pc_nbytes(qc);
3331
3332 /* We may not issue DMA commands if no DMA mode is set */
3333 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3334 fp = 1;
3335 goto invalid_fld;
3336 }
3337
3338 /* We may not issue NCQ commands to devices not supporting NCQ */
3339 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3340 fp = 1;
3341 goto invalid_fld;
3342 }
3343
3344 /* sanity check for pio multi commands */
3345 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3346 fp = 1;
3347 goto invalid_fld;
3348 }
3349
3350 if (is_multi_taskfile(tf)) {
3351 unsigned int multi_count = 1 << (cdb[1] >> 5);
3352
3353 /* compare the passed through multi_count
3354 * with the cached multi_count of libata
3355 */
3356 if (multi_count != dev->multi_count)
3357 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3358 multi_count);
3359 }
3360
3361 /*
3362 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3363 * SET_FEATURES - XFER MODE must be preceded/succeeded
3364 * by an update to hardware-specific registers for each
3365 * controller (i.e. the reason for ->set_piomode(),
3366 * ->set_dmamode(), and ->post_set_mode() hooks).
3367 */
3368 if (tf->command == ATA_CMD_SET_FEATURES &&
3369 tf->feature == SETFEATURES_XFER) {
3370 fp = (cdb[0] == ATA_16) ? 4 : 3;
3371 goto invalid_fld;
3372 }
3373
3374 /*
3375 * Filter TPM commands by default. These provide an
3376 * essentially uncontrolled encrypted "back door" between
3377 * applications and the disk. Set libata.allow_tpm=1 if you
3378 * have a real reason for wanting to use them. This ensures
3379 * that installed software cannot easily mess stuff up without
3380 * user intent. DVR type users will probably ship with this enabled
3381 * for movie content management.
3382 *
3383 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3384 * for this and should do in future but that it is not sufficient as
3385 * DCS is an optional feature set. Thus we also do the software filter
3386 * so that we comply with the TC consortium stated goal that the user
3387 * can turn off TC features of their system.
3388 */
3389 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3390 fp = (cdb[0] == ATA_16) ? 14 : 9;
3391 goto invalid_fld;
3392 }
3393
3394 return 0;
3395
3396 invalid_fld:
3397 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3398 return 1;
3399}
3400
3401/**
3402 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3403 * @cmd: SCSI command being translated
3404 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3405 * @sector: Starting sector
3406 * @count: Total Range of request in logical sectors
3407 *
3408 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3409 * descriptor.
3410 *
3411 * Upto 64 entries of the format:
3412 * 63:48 Range Length
3413 * 47:0 LBA
3414 *
3415 * Range Length of 0 is ignored.
3416 * LBA's should be sorted order and not overlap.
3417 *
3418 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3419 *
3420 * Return: Number of bytes copied into sglist.
3421 */
3422static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3423 u64 sector, u32 count)
3424{
3425 struct scsi_device *sdp = cmd->device;
3426 size_t len = sdp->sector_size;
3427 size_t r;
3428 __le64 *buf;
3429 u32 i = 0;
3430 unsigned long flags;
3431
3432 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3433
3434 if (len > ATA_SCSI_RBUF_SIZE)
3435 len = ATA_SCSI_RBUF_SIZE;
3436
3437 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3438 buf = ((void *)ata_scsi_rbuf);
3439 memset(buf, 0, len);
3440 while (i < trmax) {
3441 u64 entry = sector |
3442 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3443 buf[i++] = __cpu_to_le64(entry);
3444 if (count <= 0xffff)
3445 break;
3446 count -= 0xffff;
3447 sector += 0xffff;
3448 }
3449 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3450 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3451
3452 return r;
3453}
3454
3455/**
3456 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3457 * @qc: Command to be translated
3458 *
3459 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3460 * an SCT Write Same command.
3461 * Based on WRITE SAME has the UNMAP flag:
3462 *
3463 * - When set translate to DSM TRIM
3464 * - When clear translate to SCT Write Same
3465 */
3466static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3467{
3468 struct ata_taskfile *tf = &qc->tf;
3469 struct scsi_cmnd *scmd = qc->scsicmd;
3470 struct scsi_device *sdp = scmd->device;
3471 size_t len = sdp->sector_size;
3472 struct ata_device *dev = qc->dev;
3473 const u8 *cdb = scmd->cmnd;
3474 u64 block;
3475 u32 n_block;
3476 const u32 trmax = len >> 3;
3477 u32 size;
3478 u16 fp;
3479 u8 bp = 0xff;
3480 u8 unmap = cdb[1] & 0x8;
3481
3482 /* we may not issue DMA commands if no DMA mode is set */
3483 if (unlikely(!dev->dma_mode))
3484 goto invalid_opcode;
3485
3486 /*
3487 * We only allow sending this command through the block layer,
3488 * as it modifies the DATA OUT buffer, which would corrupt user
3489 * memory for SG_IO commands.
3490 */
3491 if (unlikely(blk_rq_is_passthrough(scmd->request)))
3492 goto invalid_opcode;
3493
3494 if (unlikely(scmd->cmd_len < 16)) {
3495 fp = 15;
3496 goto invalid_fld;
3497 }
3498 scsi_16_lba_len(cdb, &block, &n_block);
3499
3500 if (!unmap ||
3501 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3502 !ata_id_has_trim(dev->id)) {
3503 fp = 1;
3504 bp = 3;
3505 goto invalid_fld;
3506 }
3507 /* If the request is too large the cmd is invalid */
3508 if (n_block > 0xffff * trmax) {
3509 fp = 2;
3510 goto invalid_fld;
3511 }
3512
3513 /*
3514 * WRITE SAME always has a sector sized buffer as payload, this
3515 * should never be a multiple entry S/G list.
3516 */
3517 if (!scsi_sg_count(scmd))
3518 goto invalid_param_len;
3519
3520 /*
3521 * size must match sector size in bytes
3522 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3523 * is defined as number of 512 byte blocks to be transferred.
3524 */
3525
3526 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3527 if (size != len)
3528 goto invalid_param_len;
3529
3530 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3531 /* Newer devices support queued TRIM commands */
3532 tf->protocol = ATA_PROT_NCQ;
3533 tf->command = ATA_CMD_FPDMA_SEND;
3534 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3535 tf->nsect = qc->hw_tag << 3;
3536 tf->hob_feature = (size / 512) >> 8;
3537 tf->feature = size / 512;
3538
3539 tf->auxiliary = 1;
3540 } else {
3541 tf->protocol = ATA_PROT_DMA;
3542 tf->hob_feature = 0;
3543 tf->feature = ATA_DSM_TRIM;
3544 tf->hob_nsect = (size / 512) >> 8;
3545 tf->nsect = size / 512;
3546 tf->command = ATA_CMD_DSM;
3547 }
3548
3549 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3550 ATA_TFLAG_WRITE;
3551
3552 ata_qc_set_pc_nbytes(qc);
3553
3554 return 0;
3555
3556invalid_fld:
3557 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3558 return 1;
3559invalid_param_len:
3560 /* "Parameter list length error" */
3561 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3562 return 1;
3563invalid_opcode:
3564 /* "Invalid command operation code" */
3565 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3566 return 1;
3567}
3568
3569/**
3570 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3571 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3572 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3573 *
3574 * Yields a subset to satisfy scsi_report_opcode()
3575 *
3576 * LOCKING:
3577 * spin_lock_irqsave(host lock)
3578 */
3579static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3580{
3581 struct ata_device *dev = args->dev;
3582 u8 *cdb = args->cmd->cmnd;
3583 u8 supported = 0;
3584 unsigned int err = 0;
3585
3586 if (cdb[2] != 1) {
3587 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3588 err = 2;
3589 goto out;
3590 }
3591 switch (cdb[3]) {
3592 case INQUIRY:
3593 case MODE_SENSE:
3594 case MODE_SENSE_10:
3595 case READ_CAPACITY:
3596 case SERVICE_ACTION_IN_16:
3597 case REPORT_LUNS:
3598 case REQUEST_SENSE:
3599 case SYNCHRONIZE_CACHE:
3600 case REZERO_UNIT:
3601 case SEEK_6:
3602 case SEEK_10:
3603 case TEST_UNIT_READY:
3604 case SEND_DIAGNOSTIC:
3605 case MAINTENANCE_IN:
3606 case READ_6:
3607 case READ_10:
3608 case READ_16:
3609 case WRITE_6:
3610 case WRITE_10:
3611 case WRITE_16:
3612 case ATA_12:
3613 case ATA_16:
3614 case VERIFY:
3615 case VERIFY_16:
3616 case MODE_SELECT:
3617 case MODE_SELECT_10:
3618 case START_STOP:
3619 supported = 3;
3620 break;
3621 case ZBC_IN:
3622 case ZBC_OUT:
3623 if (ata_id_zoned_cap(dev->id) ||
3624 dev->class == ATA_DEV_ZAC)
3625 supported = 3;
3626 break;
3627 case SECURITY_PROTOCOL_IN:
3628 case SECURITY_PROTOCOL_OUT:
3629 if (dev->flags & ATA_DFLAG_TRUSTED)
3630 supported = 3;
3631 break;
3632 default:
3633 break;
3634 }
3635out:
3636 rbuf[1] = supported; /* supported */
3637 return err;
3638}
3639
3640/**
3641 * ata_scsi_report_zones_complete - convert ATA output
3642 * @qc: command structure returning the data
3643 *
3644 * Convert T-13 little-endian field representation into
3645 * T-10 big-endian field representation.
3646 * What a mess.
3647 */
3648static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3649{
3650 struct scsi_cmnd *scmd = qc->scsicmd;
3651 struct sg_mapping_iter miter;
3652 unsigned long flags;
3653 unsigned int bytes = 0;
3654
3655 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3656 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3657
3658 local_irq_save(flags);
3659 while (sg_miter_next(&miter)) {
3660 unsigned int offset = 0;
3661
3662 if (bytes == 0) {
3663 char *hdr;
3664 u32 list_length;
3665 u64 max_lba, opt_lba;
3666 u16 same;
3667
3668 /* Swizzle header */
3669 hdr = miter.addr;
3670 list_length = get_unaligned_le32(&hdr[0]);
3671 same = get_unaligned_le16(&hdr[4]);
3672 max_lba = get_unaligned_le64(&hdr[8]);
3673 opt_lba = get_unaligned_le64(&hdr[16]);
3674 put_unaligned_be32(list_length, &hdr[0]);
3675 hdr[4] = same & 0xf;
3676 put_unaligned_be64(max_lba, &hdr[8]);
3677 put_unaligned_be64(opt_lba, &hdr[16]);
3678 offset += 64;
3679 bytes += 64;
3680 }
3681 while (offset < miter.length) {
3682 char *rec;
3683 u8 cond, type, non_seq, reset;
3684 u64 size, start, wp;
3685
3686 /* Swizzle zone descriptor */
3687 rec = miter.addr + offset;
3688 type = rec[0] & 0xf;
3689 cond = (rec[1] >> 4) & 0xf;
3690 non_seq = (rec[1] & 2);
3691 reset = (rec[1] & 1);
3692 size = get_unaligned_le64(&rec[8]);
3693 start = get_unaligned_le64(&rec[16]);
3694 wp = get_unaligned_le64(&rec[24]);
3695 rec[0] = type;
3696 rec[1] = (cond << 4) | non_seq | reset;
3697 put_unaligned_be64(size, &rec[8]);
3698 put_unaligned_be64(start, &rec[16]);
3699 put_unaligned_be64(wp, &rec[24]);
3700 WARN_ON(offset + 64 > miter.length);
3701 offset += 64;
3702 bytes += 64;
3703 }
3704 }
3705 sg_miter_stop(&miter);
3706 local_irq_restore(flags);
3707
3708 ata_scsi_qc_complete(qc);
3709}
3710
3711static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3712{
3713 struct ata_taskfile *tf = &qc->tf;
3714 struct scsi_cmnd *scmd = qc->scsicmd;
3715 const u8 *cdb = scmd->cmnd;
3716 u16 sect, fp = (u16)-1;
3717 u8 sa, options, bp = 0xff;
3718 u64 block;
3719 u32 n_block;
3720
3721 if (unlikely(scmd->cmd_len < 16)) {
3722 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3723 scmd->cmd_len);
3724 fp = 15;
3725 goto invalid_fld;
3726 }
3727 scsi_16_lba_len(cdb, &block, &n_block);
3728 if (n_block != scsi_bufflen(scmd)) {
3729 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3730 n_block, scsi_bufflen(scmd));
3731 goto invalid_param_len;
3732 }
3733 sa = cdb[1] & 0x1f;
3734 if (sa != ZI_REPORT_ZONES) {
3735 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3736 fp = 1;
3737 goto invalid_fld;
3738 }
3739 /*
3740 * ZAC allows only for transfers in 512 byte blocks,
3741 * and uses a 16 bit value for the transfer count.
3742 */
3743 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3744 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3745 goto invalid_param_len;
3746 }
3747 sect = n_block / 512;
3748 options = cdb[14] & 0xbf;
3749
3750 if (ata_ncq_enabled(qc->dev) &&
3751 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3752 tf->protocol = ATA_PROT_NCQ;
3753 tf->command = ATA_CMD_FPDMA_RECV;
3754 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3755 tf->nsect = qc->hw_tag << 3;
3756 tf->feature = sect & 0xff;
3757 tf->hob_feature = (sect >> 8) & 0xff;
3758 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3759 } else {
3760 tf->command = ATA_CMD_ZAC_MGMT_IN;
3761 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3762 tf->protocol = ATA_PROT_DMA;
3763 tf->hob_feature = options;
3764 tf->hob_nsect = (sect >> 8) & 0xff;
3765 tf->nsect = sect & 0xff;
3766 }
3767 tf->device = ATA_LBA;
3768 tf->lbah = (block >> 16) & 0xff;
3769 tf->lbam = (block >> 8) & 0xff;
3770 tf->lbal = block & 0xff;
3771 tf->hob_lbah = (block >> 40) & 0xff;
3772 tf->hob_lbam = (block >> 32) & 0xff;
3773 tf->hob_lbal = (block >> 24) & 0xff;
3774
3775 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3776 qc->flags |= ATA_QCFLAG_RESULT_TF;
3777
3778 ata_qc_set_pc_nbytes(qc);
3779
3780 qc->complete_fn = ata_scsi_report_zones_complete;
3781
3782 return 0;
3783
3784invalid_fld:
3785 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3786 return 1;
3787
3788invalid_param_len:
3789 /* "Parameter list length error" */
3790 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3791 return 1;
3792}
3793
3794static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3795{
3796 struct ata_taskfile *tf = &qc->tf;
3797 struct scsi_cmnd *scmd = qc->scsicmd;
3798 struct ata_device *dev = qc->dev;
3799 const u8 *cdb = scmd->cmnd;
3800 u8 all, sa;
3801 u64 block;
3802 u32 n_block;
3803 u16 fp = (u16)-1;
3804
3805 if (unlikely(scmd->cmd_len < 16)) {
3806 fp = 15;
3807 goto invalid_fld;
3808 }
3809
3810 sa = cdb[1] & 0x1f;
3811 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3812 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3813 fp = 1;
3814 goto invalid_fld;
3815 }
3816
3817 scsi_16_lba_len(cdb, &block, &n_block);
3818 if (n_block) {
3819 /*
3820 * ZAC MANAGEMENT OUT doesn't define any length
3821 */
3822 goto invalid_param_len;
3823 }
3824
3825 all = cdb[14] & 0x1;
3826 if (all) {
3827 /*
3828 * Ignore the block address (zone ID) as defined by ZBC.
3829 */
3830 block = 0;
3831 } else if (block >= dev->n_sectors) {
3832 /*
3833 * Block must be a valid zone ID (a zone start LBA).
3834 */
3835 fp = 2;
3836 goto invalid_fld;
3837 }
3838
3839 if (ata_ncq_enabled(qc->dev) &&
3840 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3841 tf->protocol = ATA_PROT_NCQ_NODATA;
3842 tf->command = ATA_CMD_NCQ_NON_DATA;
3843 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3844 tf->nsect = qc->hw_tag << 3;
3845 tf->auxiliary = sa | ((u16)all << 8);
3846 } else {
3847 tf->protocol = ATA_PROT_NODATA;
3848 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3849 tf->feature = sa;
3850 tf->hob_feature = all;
3851 }
3852 tf->lbah = (block >> 16) & 0xff;
3853 tf->lbam = (block >> 8) & 0xff;
3854 tf->lbal = block & 0xff;
3855 tf->hob_lbah = (block >> 40) & 0xff;
3856 tf->hob_lbam = (block >> 32) & 0xff;
3857 tf->hob_lbal = (block >> 24) & 0xff;
3858 tf->device = ATA_LBA;
3859 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3860
3861 return 0;
3862
3863 invalid_fld:
3864 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3865 return 1;
3866invalid_param_len:
3867 /* "Parameter list length error" */
3868 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3869 return 1;
3870}
3871
3872/**
3873 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3874 * @qc: Storage for translated ATA taskfile
3875 * @buf: input buffer
3876 * @len: number of valid bytes in the input buffer
3877 * @fp: out parameter for the failed field on error
3878 *
3879 * Prepare a taskfile to modify caching information for the device.
3880 *
3881 * LOCKING:
3882 * None.
3883 */
3884static int ata_mselect_caching(struct ata_queued_cmd *qc,
3885 const u8 *buf, int len, u16 *fp)
3886{
3887 struct ata_taskfile *tf = &qc->tf;
3888 struct ata_device *dev = qc->dev;
3889 u8 mpage[CACHE_MPAGE_LEN];
3890 u8 wce;
3891 int i;
3892
3893 /*
3894 * The first two bytes of def_cache_mpage are a header, so offsets
3895 * in mpage are off by 2 compared to buf. Same for len.
3896 */
3897
3898 if (len != CACHE_MPAGE_LEN - 2) {
3899 if (len < CACHE_MPAGE_LEN - 2)
3900 *fp = len;
3901 else
3902 *fp = CACHE_MPAGE_LEN - 2;
3903 return -EINVAL;
3904 }
3905
3906 wce = buf[0] & (1 << 2);
3907
3908 /*
3909 * Check that read-only bits are not modified.
3910 */
3911 ata_msense_caching(dev->id, mpage, false);
3912 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3913 if (i == 0)
3914 continue;
3915 if (mpage[i + 2] != buf[i]) {
3916 *fp = i;
3917 return -EINVAL;
3918 }
3919 }
3920
3921 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3922 tf->protocol = ATA_PROT_NODATA;
3923 tf->nsect = 0;
3924 tf->command = ATA_CMD_SET_FEATURES;
3925 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3926 return 0;
3927}
3928
3929/**
3930 * ata_mselect_control - Simulate MODE SELECT for control page
3931 * @qc: Storage for translated ATA taskfile
3932 * @buf: input buffer
3933 * @len: number of valid bytes in the input buffer
3934 * @fp: out parameter for the failed field on error
3935 *
3936 * Prepare a taskfile to modify caching information for the device.
3937 *
3938 * LOCKING:
3939 * None.
3940 */
3941static int ata_mselect_control(struct ata_queued_cmd *qc,
3942 const u8 *buf, int len, u16 *fp)
3943{
3944 struct ata_device *dev = qc->dev;
3945 u8 mpage[CONTROL_MPAGE_LEN];
3946 u8 d_sense;
3947 int i;
3948
3949 /*
3950 * The first two bytes of def_control_mpage are a header, so offsets
3951 * in mpage are off by 2 compared to buf. Same for len.
3952 */
3953
3954 if (len != CONTROL_MPAGE_LEN - 2) {
3955 if (len < CONTROL_MPAGE_LEN - 2)
3956 *fp = len;
3957 else
3958 *fp = CONTROL_MPAGE_LEN - 2;
3959 return -EINVAL;
3960 }
3961
3962 d_sense = buf[0] & (1 << 2);
3963
3964 /*
3965 * Check that read-only bits are not modified.
3966 */
3967 ata_msense_control(dev, mpage, false);
3968 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3969 if (i == 0)
3970 continue;
3971 if (mpage[2 + i] != buf[i]) {
3972 *fp = i;
3973 return -EINVAL;
3974 }
3975 }
3976 if (d_sense & (1 << 2))
3977 dev->flags |= ATA_DFLAG_D_SENSE;
3978 else
3979 dev->flags &= ~ATA_DFLAG_D_SENSE;
3980 return 0;
3981}
3982
3983/**
3984 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3985 * @qc: Storage for translated ATA taskfile
3986 *
3987 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3988 * Assume this is invoked for direct access devices (e.g. disks) only.
3989 * There should be no block descriptor for other device types.
3990 *
3991 * LOCKING:
3992 * spin_lock_irqsave(host lock)
3993 */
3994static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3995{
3996 struct scsi_cmnd *scmd = qc->scsicmd;
3997 const u8 *cdb = scmd->cmnd;
3998 const u8 *p;
3999 u8 pg, spg;
4000 unsigned six_byte, pg_len, hdr_len, bd_len;
4001 int len;
4002 u16 fp = (u16)-1;
4003 u8 bp = 0xff;
4004
4005 VPRINTK("ENTER\n");
4006
4007 six_byte = (cdb[0] == MODE_SELECT);
4008 if (six_byte) {
4009 if (scmd->cmd_len < 5) {
4010 fp = 4;
4011 goto invalid_fld;
4012 }
4013
4014 len = cdb[4];
4015 hdr_len = 4;
4016 } else {
4017 if (scmd->cmd_len < 9) {
4018 fp = 8;
4019 goto invalid_fld;
4020 }
4021
4022 len = (cdb[7] << 8) + cdb[8];
4023 hdr_len = 8;
4024 }
4025
4026 /* We only support PF=1, SP=0. */
4027 if ((cdb[1] & 0x11) != 0x10) {
4028 fp = 1;
4029 bp = (cdb[1] & 0x01) ? 1 : 5;
4030 goto invalid_fld;
4031 }
4032
4033 /* Test early for possible overrun. */
4034 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
4035 goto invalid_param_len;
4036
4037 p = page_address(sg_page(scsi_sglist(scmd)));
4038
4039 /* Move past header and block descriptors. */
4040 if (len < hdr_len)
4041 goto invalid_param_len;
4042
4043 if (six_byte)
4044 bd_len = p[3];
4045 else
4046 bd_len = (p[6] << 8) + p[7];
4047
4048 len -= hdr_len;
4049 p += hdr_len;
4050 if (len < bd_len)
4051 goto invalid_param_len;
4052 if (bd_len != 0 && bd_len != 8) {
4053 fp = (six_byte) ? 3 : 6;
4054 fp += bd_len + hdr_len;
4055 goto invalid_param;
4056 }
4057
4058 len -= bd_len;
4059 p += bd_len;
4060 if (len == 0)
4061 goto skip;
4062
4063 /* Parse both possible formats for the mode page headers. */
4064 pg = p[0] & 0x3f;
4065 if (p[0] & 0x40) {
4066 if (len < 4)
4067 goto invalid_param_len;
4068
4069 spg = p[1];
4070 pg_len = (p[2] << 8) | p[3];
4071 p += 4;
4072 len -= 4;
4073 } else {
4074 if (len < 2)
4075 goto invalid_param_len;
4076
4077 spg = 0;
4078 pg_len = p[1];
4079 p += 2;
4080 len -= 2;
4081 }
4082
4083 /*
4084 * No mode subpages supported (yet) but asking for _all_
4085 * subpages may be valid
4086 */
4087 if (spg && (spg != ALL_SUB_MPAGES)) {
4088 fp = (p[0] & 0x40) ? 1 : 0;
4089 fp += hdr_len + bd_len;
4090 goto invalid_param;
4091 }
4092 if (pg_len > len)
4093 goto invalid_param_len;
4094
4095 switch (pg) {
4096 case CACHE_MPAGE:
4097 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4098 fp += hdr_len + bd_len;
4099 goto invalid_param;
4100 }
4101 break;
4102 case CONTROL_MPAGE:
4103 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
4104 fp += hdr_len + bd_len;
4105 goto invalid_param;
4106 } else {
4107 goto skip; /* No ATA command to send */
4108 }
4109 break;
4110 default: /* invalid page code */
4111 fp = bd_len + hdr_len;
4112 goto invalid_param;
4113 }
4114
4115 /*
4116 * Only one page has changeable data, so we only support setting one
4117 * page at a time.
4118 */
4119 if (len > pg_len)
4120 goto invalid_param;
4121
4122 return 0;
4123
4124 invalid_fld:
4125 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4126 return 1;
4127
4128 invalid_param:
4129 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4130 return 1;
4131
4132 invalid_param_len:
4133 /* "Parameter list length error" */
4134 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4135 return 1;
4136
4137 skip:
4138 scmd->result = SAM_STAT_GOOD;
4139 return 1;
4140}
4141
4142static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
4143{
4144 if (len == 0)
4145 return ATA_CMD_TRUSTED_NONDATA;
4146 else if (send)
4147 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
4148 else
4149 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
4150}
4151
4152static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
4153{
4154 struct scsi_cmnd *scmd = qc->scsicmd;
4155 const u8 *cdb = scmd->cmnd;
4156 struct ata_taskfile *tf = &qc->tf;
4157 u8 secp = cdb[1];
4158 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
4159 u16 spsp = get_unaligned_be16(&cdb[2]);
4160 u32 len = get_unaligned_be32(&cdb[6]);
4161 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
4162
4163 /*
4164 * We don't support the ATA "security" protocol.
4165 */
4166 if (secp == 0xef) {
4167 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
4168 return 1;
4169 }
4170
4171 if (cdb[4] & 7) { /* INC_512 */
4172 if (len > 0xffff) {
4173 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4174 return 1;
4175 }
4176 } else {
4177 if (len > 0x01fffe00) {
4178 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4179 return 1;
4180 }
4181
4182 /* convert to the sector-based ATA addressing */
4183 len = (len + 511) / 512;
4184 }
4185
4186 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
4187 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
4188 if (send)
4189 tf->flags |= ATA_TFLAG_WRITE;
4190 tf->command = ata_scsi_trusted_op(len, send, dma);
4191 tf->feature = secp;
4192 tf->lbam = spsp & 0xff;
4193 tf->lbah = spsp >> 8;
4194
4195 if (len) {
4196 tf->nsect = len & 0xff;
4197 tf->lbal = len >> 8;
4198 } else {
4199 if (!send)
4200 tf->lbah = (1 << 7);
4201 }
4202
4203 ata_qc_set_pc_nbytes(qc);
4204 return 0;
4205}
4206
4207/**
4208 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
4209 * @qc: Command to be translated
4210 *
4211 * Translate a SCSI variable length CDB to specified commands.
4212 * It checks a service action value in CDB to call corresponding handler.
4213 *
4214 * RETURNS:
4215 * Zero on success, non-zero on failure
4216 *
4217 */
4218static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
4219{
4220 struct scsi_cmnd *scmd = qc->scsicmd;
4221 const u8 *cdb = scmd->cmnd;
4222 const u16 sa = get_unaligned_be16(&cdb[8]);
4223
4224 /*
4225 * if service action represents a ata pass-thru(32) command,
4226 * then pass it to ata_scsi_pass_thru handler.
4227 */
4228 if (sa == ATA_32)
4229 return ata_scsi_pass_thru(qc);
4230
4231 /* unsupported service action */
4232 return 1;
4233}
4234
4235/**
4236 * ata_get_xlat_func - check if SCSI to ATA translation is possible
4237 * @dev: ATA device
4238 * @cmd: SCSI command opcode to consider
4239 *
4240 * Look up the SCSI command given, and determine whether the
4241 * SCSI command is to be translated or simulated.
4242 *
4243 * RETURNS:
4244 * Pointer to translation function if possible, %NULL if not.
4245 */
4246
4247static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4248{
4249 switch (cmd) {
4250 case READ_6:
4251 case READ_10:
4252 case READ_16:
4253
4254 case WRITE_6:
4255 case WRITE_10:
4256 case WRITE_16:
4257 return ata_scsi_rw_xlat;
4258
4259 case WRITE_SAME_16:
4260 return ata_scsi_write_same_xlat;
4261
4262 case SYNCHRONIZE_CACHE:
4263 if (ata_try_flush_cache(dev))
4264 return ata_scsi_flush_xlat;
4265 break;
4266
4267 case VERIFY:
4268 case VERIFY_16:
4269 return ata_scsi_verify_xlat;
4270
4271 case ATA_12:
4272 case ATA_16:
4273 return ata_scsi_pass_thru;
4274
4275 case VARIABLE_LENGTH_CMD:
4276 return ata_scsi_var_len_cdb_xlat;
4277
4278 case MODE_SELECT:
4279 case MODE_SELECT_10:
4280 return ata_scsi_mode_select_xlat;
4281 break;
4282
4283 case ZBC_IN:
4284 return ata_scsi_zbc_in_xlat;
4285
4286 case ZBC_OUT:
4287 return ata_scsi_zbc_out_xlat;
4288
4289 case SECURITY_PROTOCOL_IN:
4290 case SECURITY_PROTOCOL_OUT:
4291 if (!(dev->flags & ATA_DFLAG_TRUSTED))
4292 break;
4293 return ata_scsi_security_inout_xlat;
4294
4295 case START_STOP:
4296 return ata_scsi_start_stop_xlat;
4297 }
4298
4299 return NULL;
4300}
4301
4302/**
4303 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
4304 * @ap: ATA port to which the command was being sent
4305 * @cmd: SCSI command to dump
4306 *
4307 * Prints the contents of a SCSI command via printk().
4308 */
4309
4310static inline void ata_scsi_dump_cdb(struct ata_port *ap,
4311 struct scsi_cmnd *cmd)
4312{
4313#ifdef ATA_VERBOSE_DEBUG
4314 struct scsi_device *scsidev = cmd->device;
4315
4316 VPRINTK("CDB (%u:%d,%d,%lld) %9ph\n",
4317 ap->print_id,
4318 scsidev->channel, scsidev->id, scsidev->lun,
4319 cmd->cmnd);
4320#endif
4321}
4322
4323static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
4324 struct ata_device *dev)
4325{
4326 u8 scsi_op = scmd->cmnd[0];
4327 ata_xlat_func_t xlat_func;
4328 int rc = 0;
4329
4330 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4331 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4332 goto bad_cdb_len;
4333
4334 xlat_func = ata_get_xlat_func(dev, scsi_op);
4335 } else {
4336 if (unlikely(!scmd->cmd_len))
4337 goto bad_cdb_len;
4338
4339 xlat_func = NULL;
4340 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4341 /* relay SCSI command to ATAPI device */
4342 int len = COMMAND_SIZE(scsi_op);
4343 if (unlikely(len > scmd->cmd_len ||
4344 len > dev->cdb_len ||
4345 scmd->cmd_len > ATAPI_CDB_LEN))
4346 goto bad_cdb_len;
4347
4348 xlat_func = atapi_xlat;
4349 } else {
4350 /* ATA_16 passthru, treat as an ATA command */
4351 if (unlikely(scmd->cmd_len > 16))
4352 goto bad_cdb_len;
4353
4354 xlat_func = ata_get_xlat_func(dev, scsi_op);
4355 }
4356 }
4357
4358 if (xlat_func)
4359 rc = ata_scsi_translate(dev, scmd, xlat_func);
4360 else
4361 ata_scsi_simulate(dev, scmd);
4362
4363 return rc;
4364
4365 bad_cdb_len:
4366 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4367 scmd->cmd_len, scsi_op, dev->cdb_len);
4368 scmd->result = DID_ERROR << 16;
4369 scmd->scsi_done(scmd);
4370 return 0;
4371}
4372
4373/**
4374 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4375 * @shost: SCSI host of command to be sent
4376 * @cmd: SCSI command to be sent
4377 *
4378 * In some cases, this function translates SCSI commands into
4379 * ATA taskfiles, and queues the taskfiles to be sent to
4380 * hardware. In other cases, this function simulates a
4381 * SCSI device by evaluating and responding to certain
4382 * SCSI commands. This creates the overall effect of
4383 * ATA and ATAPI devices appearing as SCSI devices.
4384 *
4385 * LOCKING:
4386 * ATA host lock
4387 *
4388 * RETURNS:
4389 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4390 * 0 otherwise.
4391 */
4392int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4393{
4394 struct ata_port *ap;
4395 struct ata_device *dev;
4396 struct scsi_device *scsidev = cmd->device;
4397 int rc = 0;
4398 unsigned long irq_flags;
4399
4400 ap = ata_shost_to_port(shost);
4401
4402 spin_lock_irqsave(ap->lock, irq_flags);
4403
4404 ata_scsi_dump_cdb(ap, cmd);
4405
4406 dev = ata_scsi_find_dev(ap, scsidev);
4407 if (likely(dev))
4408 rc = __ata_scsi_queuecmd(cmd, dev);
4409 else {
4410 cmd->result = (DID_BAD_TARGET << 16);
4411 cmd->scsi_done(cmd);
4412 }
4413
4414 spin_unlock_irqrestore(ap->lock, irq_flags);
4415
4416 return rc;
4417}
4418
4419/**
4420 * ata_scsi_simulate - simulate SCSI command on ATA device
4421 * @dev: the target device
4422 * @cmd: SCSI command being sent to device.
4423 *
4424 * Interprets and directly executes a select list of SCSI commands
4425 * that can be handled internally.
4426 *
4427 * LOCKING:
4428 * spin_lock_irqsave(host lock)
4429 */
4430
4431void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4432{
4433 struct ata_scsi_args args;
4434 const u8 *scsicmd = cmd->cmnd;
4435 u8 tmp8;
4436
4437 args.dev = dev;
4438 args.id = dev->id;
4439 args.cmd = cmd;
4440
4441 switch(scsicmd[0]) {
4442 case INQUIRY:
4443 if (scsicmd[1] & 2) /* is CmdDt set? */
4444 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4445 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4446 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4447 else switch (scsicmd[2]) {
4448 case 0x00:
4449 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4450 break;
4451 case 0x80:
4452 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4453 break;
4454 case 0x83:
4455 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4456 break;
4457 case 0x89:
4458 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4459 break;
4460 case 0xb0:
4461 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4462 break;
4463 case 0xb1:
4464 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4465 break;
4466 case 0xb2:
4467 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4468 break;
4469 case 0xb6:
4470 if (dev->flags & ATA_DFLAG_ZAC) {
4471 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4472 break;
4473 }
4474 /* Fallthrough */
4475 default:
4476 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4477 break;
4478 }
4479 break;
4480
4481 case MODE_SENSE:
4482 case MODE_SENSE_10:
4483 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4484 break;
4485
4486 case READ_CAPACITY:
4487 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4488 break;
4489
4490 case SERVICE_ACTION_IN_16:
4491 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4492 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4493 else
4494 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4495 break;
4496
4497 case REPORT_LUNS:
4498 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4499 break;
4500
4501 case REQUEST_SENSE:
4502 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4503 cmd->result = (DRIVER_SENSE << 24);
4504 break;
4505
4506 /* if we reach this, then writeback caching is disabled,
4507 * turning this into a no-op.
4508 */
4509 case SYNCHRONIZE_CACHE:
4510 /* fall through */
4511
4512 /* no-op's, complete with success */
4513 case REZERO_UNIT:
4514 case SEEK_6:
4515 case SEEK_10:
4516 case TEST_UNIT_READY:
4517 break;
4518
4519 case SEND_DIAGNOSTIC:
4520 tmp8 = scsicmd[1] & ~(1 << 3);
4521 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4522 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4523 break;
4524
4525 case MAINTENANCE_IN:
4526 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4527 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4528 else
4529 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4530 break;
4531
4532 /* all other commands */
4533 default:
4534 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4535 /* "Invalid command operation code" */
4536 break;
4537 }
4538
4539 cmd->scsi_done(cmd);
4540}
4541
4542int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4543{
4544 int i, rc;
4545
4546 for (i = 0; i < host->n_ports; i++) {
4547 struct ata_port *ap = host->ports[i];
4548 struct Scsi_Host *shost;
4549
4550 rc = -ENOMEM;
4551 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4552 if (!shost)
4553 goto err_alloc;
4554
4555 shost->eh_noresume = 1;
4556 *(struct ata_port **)&shost->hostdata[0] = ap;
4557 ap->scsi_host = shost;
4558
4559 shost->transportt = ata_scsi_transport_template;
4560 shost->unique_id = ap->print_id;
4561 shost->max_id = 16;
4562 shost->max_lun = 1;
4563 shost->max_channel = 1;
4564 shost->max_cmd_len = 32;
4565
4566 /* Schedule policy is determined by ->qc_defer()
4567 * callback and it needs to see every deferred qc.
4568 * Set host_blocked to 1 to prevent SCSI midlayer from
4569 * automatically deferring requests.
4570 */
4571 shost->max_host_blocked = 1;
4572
4573 rc = scsi_add_host_with_dma(ap->scsi_host,
4574 &ap->tdev, ap->host->dev);
4575 if (rc)
4576 goto err_add;
4577 }
4578
4579 return 0;
4580
4581 err_add:
4582 scsi_host_put(host->ports[i]->scsi_host);
4583 err_alloc:
4584 while (--i >= 0) {
4585 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4586
4587 scsi_remove_host(shost);
4588 scsi_host_put(shost);
4589 }
4590 return rc;
4591}
4592
4593void ata_scsi_scan_host(struct ata_port *ap, int sync)
4594{
4595 int tries = 5;
4596 struct ata_device *last_failed_dev = NULL;
4597 struct ata_link *link;
4598 struct ata_device *dev;
4599
4600 repeat:
4601 ata_for_each_link(link, ap, EDGE) {
4602 ata_for_each_dev(dev, link, ENABLED) {
4603 struct scsi_device *sdev;
4604 int channel = 0, id = 0;
4605
4606 if (dev->sdev)
4607 continue;
4608
4609 if (ata_is_host_link(link))
4610 id = dev->devno;
4611 else
4612 channel = link->pmp;
4613
4614 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4615 NULL);
4616 if (!IS_ERR(sdev)) {
4617 dev->sdev = sdev;
4618 scsi_device_put(sdev);
4619 } else {
4620 dev->sdev = NULL;
4621 }
4622 }
4623 }
4624
4625 /* If we scanned while EH was in progress or allocation
4626 * failure occurred, scan would have failed silently. Check
4627 * whether all devices are attached.
4628 */
4629 ata_for_each_link(link, ap, EDGE) {
4630 ata_for_each_dev(dev, link, ENABLED) {
4631 if (!dev->sdev)
4632 goto exit_loop;
4633 }
4634 }
4635 exit_loop:
4636 if (!link)
4637 return;
4638
4639 /* we're missing some SCSI devices */
4640 if (sync) {
4641 /* If caller requested synchrnous scan && we've made
4642 * any progress, sleep briefly and repeat.
4643 */
4644 if (dev != last_failed_dev) {
4645 msleep(100);
4646 last_failed_dev = dev;
4647 goto repeat;
4648 }
4649
4650 /* We might be failing to detect boot device, give it
4651 * a few more chances.
4652 */
4653 if (--tries) {
4654 msleep(100);
4655 goto repeat;
4656 }
4657
4658 ata_port_err(ap,
4659 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4660 }
4661
4662 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4663 round_jiffies_relative(HZ));
4664}
4665
4666/**
4667 * ata_scsi_offline_dev - offline attached SCSI device
4668 * @dev: ATA device to offline attached SCSI device for
4669 *
4670 * This function is called from ata_eh_hotplug() and responsible
4671 * for taking the SCSI device attached to @dev offline. This
4672 * function is called with host lock which protects dev->sdev
4673 * against clearing.
4674 *
4675 * LOCKING:
4676 * spin_lock_irqsave(host lock)
4677 *
4678 * RETURNS:
4679 * 1 if attached SCSI device exists, 0 otherwise.
4680 */
4681int ata_scsi_offline_dev(struct ata_device *dev)
4682{
4683 if (dev->sdev) {
4684 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4685 return 1;
4686 }
4687 return 0;
4688}
4689
4690/**
4691 * ata_scsi_remove_dev - remove attached SCSI device
4692 * @dev: ATA device to remove attached SCSI device for
4693 *
4694 * This function is called from ata_eh_scsi_hotplug() and
4695 * responsible for removing the SCSI device attached to @dev.
4696 *
4697 * LOCKING:
4698 * Kernel thread context (may sleep).
4699 */
4700static void ata_scsi_remove_dev(struct ata_device *dev)
4701{
4702 struct ata_port *ap = dev->link->ap;
4703 struct scsi_device *sdev;
4704 unsigned long flags;
4705
4706 /* Alas, we need to grab scan_mutex to ensure SCSI device
4707 * state doesn't change underneath us and thus
4708 * scsi_device_get() always succeeds. The mutex locking can
4709 * be removed if there is __scsi_device_get() interface which
4710 * increments reference counts regardless of device state.
4711 */
4712 mutex_lock(&ap->scsi_host->scan_mutex);
4713 spin_lock_irqsave(ap->lock, flags);
4714
4715 /* clearing dev->sdev is protected by host lock */
4716 sdev = dev->sdev;
4717 dev->sdev = NULL;
4718
4719 if (sdev) {
4720 /* If user initiated unplug races with us, sdev can go
4721 * away underneath us after the host lock and
4722 * scan_mutex are released. Hold onto it.
4723 */
4724 if (scsi_device_get(sdev) == 0) {
4725 /* The following ensures the attached sdev is
4726 * offline on return from ata_scsi_offline_dev()
4727 * regardless it wins or loses the race
4728 * against this function.
4729 */
4730 scsi_device_set_state(sdev, SDEV_OFFLINE);
4731 } else {
4732 WARN_ON(1);
4733 sdev = NULL;
4734 }
4735 }
4736
4737 spin_unlock_irqrestore(ap->lock, flags);
4738 mutex_unlock(&ap->scsi_host->scan_mutex);
4739
4740 if (sdev) {
4741 ata_dev_info(dev, "detaching (SCSI %s)\n",
4742 dev_name(&sdev->sdev_gendev));
4743
4744 scsi_remove_device(sdev);
4745 scsi_device_put(sdev);
4746 }
4747}
4748
4749static void ata_scsi_handle_link_detach(struct ata_link *link)
4750{
4751 struct ata_port *ap = link->ap;
4752 struct ata_device *dev;
4753
4754 ata_for_each_dev(dev, link, ALL) {
4755 unsigned long flags;
4756
4757 if (!(dev->flags & ATA_DFLAG_DETACHED))
4758 continue;
4759
4760 spin_lock_irqsave(ap->lock, flags);
4761 dev->flags &= ~ATA_DFLAG_DETACHED;
4762 spin_unlock_irqrestore(ap->lock, flags);
4763
4764 if (zpodd_dev_enabled(dev))
4765 zpodd_exit(dev);
4766
4767 ata_scsi_remove_dev(dev);
4768 }
4769}
4770
4771/**
4772 * ata_scsi_media_change_notify - send media change event
4773 * @dev: Pointer to the disk device with media change event
4774 *
4775 * Tell the block layer to send a media change notification
4776 * event.
4777 *
4778 * LOCKING:
4779 * spin_lock_irqsave(host lock)
4780 */
4781void ata_scsi_media_change_notify(struct ata_device *dev)
4782{
4783 if (dev->sdev)
4784 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4785 GFP_ATOMIC);
4786}
4787
4788/**
4789 * ata_scsi_hotplug - SCSI part of hotplug
4790 * @work: Pointer to ATA port to perform SCSI hotplug on
4791 *
4792 * Perform SCSI part of hotplug. It's executed from a separate
4793 * workqueue after EH completes. This is necessary because SCSI
4794 * hot plugging requires working EH and hot unplugging is
4795 * synchronized with hot plugging with a mutex.
4796 *
4797 * LOCKING:
4798 * Kernel thread context (may sleep).
4799 */
4800void ata_scsi_hotplug(struct work_struct *work)
4801{
4802 struct ata_port *ap =
4803 container_of(work, struct ata_port, hotplug_task.work);
4804 int i;
4805
4806 if (ap->pflags & ATA_PFLAG_UNLOADING) {
4807 DPRINTK("ENTER/EXIT - unloading\n");
4808 return;
4809 }
4810
4811 /*
4812 * XXX - UGLY HACK
4813 *
4814 * The block layer suspend/resume path is fundamentally broken due
4815 * to freezable kthreads and workqueue and may deadlock if a block
4816 * device gets removed while resume is in progress. I don't know
4817 * what the solution is short of removing freezable kthreads and
4818 * workqueues altogether.
4819 *
4820 * The following is an ugly hack to avoid kicking off device
4821 * removal while freezer is active. This is a joke but does avoid
4822 * this particular deadlock scenario.
4823 *
4824 * https://bugzilla.kernel.org/show_bug.cgi?id=62801
4825 * http://marc.info/?l=linux-kernel&m=138695698516487
4826 */
4827#ifdef CONFIG_FREEZER
4828 while (pm_freezing)
4829 msleep(10);
4830#endif
4831
4832 DPRINTK("ENTER\n");
4833 mutex_lock(&ap->scsi_scan_mutex);
4834
4835 /* Unplug detached devices. We cannot use link iterator here
4836 * because PMP links have to be scanned even if PMP is
4837 * currently not attached. Iterate manually.
4838 */
4839 ata_scsi_handle_link_detach(&ap->link);
4840 if (ap->pmp_link)
4841 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4842 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4843
4844 /* scan for new ones */
4845 ata_scsi_scan_host(ap, 0);
4846
4847 mutex_unlock(&ap->scsi_scan_mutex);
4848 DPRINTK("EXIT\n");
4849}
4850
4851/**
4852 * ata_scsi_user_scan - indication for user-initiated bus scan
4853 * @shost: SCSI host to scan
4854 * @channel: Channel to scan
4855 * @id: ID to scan
4856 * @lun: LUN to scan
4857 *
4858 * This function is called when user explicitly requests bus
4859 * scan. Set probe pending flag and invoke EH.
4860 *
4861 * LOCKING:
4862 * SCSI layer (we don't care)
4863 *
4864 * RETURNS:
4865 * Zero.
4866 */
4867int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4868 unsigned int id, u64 lun)
4869{
4870 struct ata_port *ap = ata_shost_to_port(shost);
4871 unsigned long flags;
4872 int devno, rc = 0;
4873
4874 if (!ap->ops->error_handler)
4875 return -EOPNOTSUPP;
4876
4877 if (lun != SCAN_WILD_CARD && lun)
4878 return -EINVAL;
4879
4880 if (!sata_pmp_attached(ap)) {
4881 if (channel != SCAN_WILD_CARD && channel)
4882 return -EINVAL;
4883 devno = id;
4884 } else {
4885 if (id != SCAN_WILD_CARD && id)
4886 return -EINVAL;
4887 devno = channel;
4888 }
4889
4890 spin_lock_irqsave(ap->lock, flags);
4891
4892 if (devno == SCAN_WILD_CARD) {
4893 struct ata_link *link;
4894
4895 ata_for_each_link(link, ap, EDGE) {
4896 struct ata_eh_info *ehi = &link->eh_info;
4897 ehi->probe_mask |= ATA_ALL_DEVICES;
4898 ehi->action |= ATA_EH_RESET;
4899 }
4900 } else {
4901 struct ata_device *dev = ata_find_dev(ap, devno);
4902
4903 if (dev) {
4904 struct ata_eh_info *ehi = &dev->link->eh_info;
4905 ehi->probe_mask |= 1 << dev->devno;
4906 ehi->action |= ATA_EH_RESET;
4907 } else
4908 rc = -EINVAL;
4909 }
4910
4911 if (rc == 0) {
4912 ata_port_schedule_eh(ap);
4913 spin_unlock_irqrestore(ap->lock, flags);
4914 ata_port_wait_eh(ap);
4915 } else
4916 spin_unlock_irqrestore(ap->lock, flags);
4917
4918 return rc;
4919}
4920
4921/**
4922 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4923 * @work: Pointer to ATA port to perform scsi_rescan_device()
4924 *
4925 * After ATA pass thru (SAT) commands are executed successfully,
4926 * libata need to propagate the changes to SCSI layer.
4927 *
4928 * LOCKING:
4929 * Kernel thread context (may sleep).
4930 */
4931void ata_scsi_dev_rescan(struct work_struct *work)
4932{
4933 struct ata_port *ap =
4934 container_of(work, struct ata_port, scsi_rescan_task);
4935 struct ata_link *link;
4936 struct ata_device *dev;
4937 unsigned long flags;
4938
4939 mutex_lock(&ap->scsi_scan_mutex);
4940 spin_lock_irqsave(ap->lock, flags);
4941
4942 ata_for_each_link(link, ap, EDGE) {
4943 ata_for_each_dev(dev, link, ENABLED) {
4944 struct scsi_device *sdev = dev->sdev;
4945
4946 if (!sdev)
4947 continue;
4948 if (scsi_device_get(sdev))
4949 continue;
4950
4951 spin_unlock_irqrestore(ap->lock, flags);
4952 scsi_rescan_device(&(sdev->sdev_gendev));
4953 scsi_device_put(sdev);
4954 spin_lock_irqsave(ap->lock, flags);
4955 }
4956 }
4957
4958 spin_unlock_irqrestore(ap->lock, flags);
4959 mutex_unlock(&ap->scsi_scan_mutex);
4960}
4961
4962/**
4963 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4964 * @host: ATA host container for all SAS ports
4965 * @port_info: Information from low-level host driver
4966 * @shost: SCSI host that the scsi device is attached to
4967 *
4968 * LOCKING:
4969 * PCI/etc. bus probe sem.
4970 *
4971 * RETURNS:
4972 * ata_port pointer on success / NULL on failure.
4973 */
4974
4975struct ata_port *ata_sas_port_alloc(struct ata_host *host,
4976 struct ata_port_info *port_info,
4977 struct Scsi_Host *shost)
4978{
4979 struct ata_port *ap;
4980
4981 ap = ata_port_alloc(host);
4982 if (!ap)
4983 return NULL;
4984
4985 ap->port_no = 0;
4986 ap->lock = &host->lock;
4987 ap->pio_mask = port_info->pio_mask;
4988 ap->mwdma_mask = port_info->mwdma_mask;
4989 ap->udma_mask = port_info->udma_mask;
4990 ap->flags |= port_info->flags;
4991 ap->ops = port_info->port_ops;
4992 ap->cbl = ATA_CBL_SATA;
4993
4994 return ap;
4995}
4996EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4997
4998/**
4999 * ata_sas_port_start - Set port up for dma.
5000 * @ap: Port to initialize
5001 *
5002 * Called just after data structures for each port are
5003 * initialized.
5004 *
5005 * May be used as the port_start() entry in ata_port_operations.
5006 *
5007 * LOCKING:
5008 * Inherited from caller.
5009 */
5010int ata_sas_port_start(struct ata_port *ap)
5011{
5012 /*
5013 * the port is marked as frozen at allocation time, but if we don't
5014 * have new eh, we won't thaw it
5015 */
5016 if (!ap->ops->error_handler)
5017 ap->pflags &= ~ATA_PFLAG_FROZEN;
5018 return 0;
5019}
5020EXPORT_SYMBOL_GPL(ata_sas_port_start);
5021
5022/**
5023 * ata_port_stop - Undo ata_sas_port_start()
5024 * @ap: Port to shut down
5025 *
5026 * May be used as the port_stop() entry in ata_port_operations.
5027 *
5028 * LOCKING:
5029 * Inherited from caller.
5030 */
5031
5032void ata_sas_port_stop(struct ata_port *ap)
5033{
5034}
5035EXPORT_SYMBOL_GPL(ata_sas_port_stop);
5036
5037/**
5038 * ata_sas_async_probe - simply schedule probing and return
5039 * @ap: Port to probe
5040 *
5041 * For batch scheduling of probe for sas attached ata devices, assumes
5042 * the port has already been through ata_sas_port_init()
5043 */
5044void ata_sas_async_probe(struct ata_port *ap)
5045{
5046 __ata_port_probe(ap);
5047}
5048EXPORT_SYMBOL_GPL(ata_sas_async_probe);
5049
5050int ata_sas_sync_probe(struct ata_port *ap)
5051{
5052 return ata_port_probe(ap);
5053}
5054EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
5055
5056
5057/**
5058 * ata_sas_port_init - Initialize a SATA device
5059 * @ap: SATA port to initialize
5060 *
5061 * LOCKING:
5062 * PCI/etc. bus probe sem.
5063 *
5064 * RETURNS:
5065 * Zero on success, non-zero on error.
5066 */
5067
5068int ata_sas_port_init(struct ata_port *ap)
5069{
5070 int rc = ap->ops->port_start(ap);
5071
5072 if (rc)
5073 return rc;
5074 ap->print_id = atomic_inc_return(&ata_print_id);
5075 return 0;
5076}
5077EXPORT_SYMBOL_GPL(ata_sas_port_init);
5078
5079int ata_sas_tport_add(struct device *parent, struct ata_port *ap)
5080{
5081 return ata_tport_add(parent, ap);
5082}
5083EXPORT_SYMBOL_GPL(ata_sas_tport_add);
5084
5085void ata_sas_tport_delete(struct ata_port *ap)
5086{
5087 ata_tport_delete(ap);
5088}
5089EXPORT_SYMBOL_GPL(ata_sas_tport_delete);
5090
5091/**
5092 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
5093 * @ap: SATA port to destroy
5094 *
5095 */
5096
5097void ata_sas_port_destroy(struct ata_port *ap)
5098{
5099 if (ap->ops->port_stop)
5100 ap->ops->port_stop(ap);
5101 kfree(ap);
5102}
5103EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
5104
5105/**
5106 * ata_sas_slave_configure - Default slave_config routine for libata devices
5107 * @sdev: SCSI device to configure
5108 * @ap: ATA port to which SCSI device is attached
5109 *
5110 * RETURNS:
5111 * Zero.
5112 */
5113
5114int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
5115{
5116 ata_scsi_sdev_config(sdev);
5117 ata_scsi_dev_config(sdev, ap->link.device);
5118 return 0;
5119}
5120EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
5121
5122/**
5123 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
5124 * @cmd: SCSI command to be sent
5125 * @ap: ATA port to which the command is being sent
5126 *
5127 * RETURNS:
5128 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
5129 * 0 otherwise.
5130 */
5131
5132int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
5133{
5134 int rc = 0;
5135
5136 ata_scsi_dump_cdb(ap, cmd);
5137
5138 if (likely(ata_dev_enabled(ap->link.device)))
5139 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
5140 else {
5141 cmd->result = (DID_BAD_TARGET << 16);
5142 cmd->scsi_done(cmd);
5143 }
5144 return rc;
5145}
5146EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
5147
5148int ata_sas_allocate_tag(struct ata_port *ap)
5149{
5150 unsigned int max_queue = ap->host->n_tags;
5151 unsigned int i, tag;
5152
5153 for (i = 0, tag = ap->sas_last_tag + 1; i < max_queue; i++, tag++) {
5154 tag = tag < max_queue ? tag : 0;
5155
5156 /* the last tag is reserved for internal command. */
5157 if (ata_tag_internal(tag))
5158 continue;
5159
5160 if (!test_and_set_bit(tag, &ap->sas_tag_allocated)) {
5161 ap->sas_last_tag = tag;
5162 return tag;
5163 }
5164 }
5165 return -1;
5166}
5167
5168void ata_sas_free_tag(unsigned int tag, struct ata_port *ap)
5169{
5170 clear_bit(tag, &ap->sas_tag_allocated);
5171}