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