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