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