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