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