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