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