Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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/kernel.h>
37#include <linux/blkdev.h>
38#include <linux/spinlock.h>
39#include <scsi/scsi.h>
40#include <scsi/scsi_host.h>
41#include <scsi/scsi_cmnd.h>
42#include <scsi/scsi_eh.h>
43#include <scsi/scsi_device.h>
44#include <scsi/scsi_tcq.h>
45#include <scsi/scsi_transport.h>
46#include <linux/libata.h>
47#include <linux/hdreg.h>
48#include <linux/uaccess.h>
49
50#include "libata.h"
51
52#define SECTOR_SIZE 512
53#define ATA_SCSI_RBUF_SIZE 4096
54
55static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
56static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
57
58typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
59
60static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
61 const struct scsi_device *scsidev);
62static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
63 const struct scsi_device *scsidev);
64static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
65 unsigned int id, unsigned int lun);
66
67
68#define RW_RECOVERY_MPAGE 0x1
69#define RW_RECOVERY_MPAGE_LEN 12
70#define CACHE_MPAGE 0x8
71#define CACHE_MPAGE_LEN 20
72#define CONTROL_MPAGE 0xa
73#define CONTROL_MPAGE_LEN 12
74#define ALL_MPAGES 0x3f
75#define ALL_SUB_MPAGES 0xff
76
77
78static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
79 RW_RECOVERY_MPAGE,
80 RW_RECOVERY_MPAGE_LEN - 2,
81 (1 << 7), /* AWRE */
82 0, /* read retry count */
83 0, 0, 0, 0,
84 0, /* write retry count */
85 0, 0, 0
86};
87
88static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
89 CACHE_MPAGE,
90 CACHE_MPAGE_LEN - 2,
91 0, /* contains WCE, needs to be 0 for logic */
92 0, 0, 0, 0, 0, 0, 0, 0, 0,
93 0, /* contains DRA, needs to be 0 for logic */
94 0, 0, 0, 0, 0, 0, 0
95};
96
97static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
98 CONTROL_MPAGE,
99 CONTROL_MPAGE_LEN - 2,
100 2, /* DSENSE=0, GLTSD=1 */
101 0, /* [QAM+QERR may be 1, see 05-359r1] */
102 0, 0, 0, 0, 0xff, 0xff,
103 0, 30 /* extended self test time, see 05-359r1 */
104};
105
106/*
107 * libata transport template. libata doesn't do real transport stuff.
108 * It just needs the eh_timed_out hook.
109 */
110static struct scsi_transport_template ata_scsi_transport_template = {
111 .eh_strategy_handler = ata_scsi_error,
112 .eh_timed_out = ata_scsi_timed_out,
113 .user_scan = ata_scsi_user_scan,
114};
115
116
117static const struct {
118 enum link_pm value;
119 const char *name;
120} link_pm_policy[] = {
121 { NOT_AVAILABLE, "max_performance" },
122 { MIN_POWER, "min_power" },
123 { MAX_PERFORMANCE, "max_performance" },
124 { MEDIUM_POWER, "medium_power" },
125};
126
127static const char *ata_scsi_lpm_get(enum link_pm policy)
128{
129 int i;
130
131 for (i = 0; i < ARRAY_SIZE(link_pm_policy); i++)
132 if (link_pm_policy[i].value == policy)
133 return link_pm_policy[i].name;
134
135 return NULL;
136}
137
138static ssize_t ata_scsi_lpm_put(struct device *dev,
139 struct device_attribute *attr,
140 const char *buf, size_t count)
141{
142 struct Scsi_Host *shost = class_to_shost(dev);
143 struct ata_port *ap = ata_shost_to_port(shost);
144 enum link_pm policy = 0;
145 int i;
146
147 /*
148 * we are skipping array location 0 on purpose - this
149 * is because a value of NOT_AVAILABLE is displayed
150 * to the user as max_performance, but when the user
151 * writes "max_performance", they actually want the
152 * value to match MAX_PERFORMANCE.
153 */
154 for (i = 1; i < ARRAY_SIZE(link_pm_policy); i++) {
155 const int len = strlen(link_pm_policy[i].name);
156 if (strncmp(link_pm_policy[i].name, buf, len) == 0 &&
157 buf[len] == '\n') {
158 policy = link_pm_policy[i].value;
159 break;
160 }
161 }
162 if (!policy)
163 return -EINVAL;
164
165 ata_lpm_schedule(ap, policy);
166 return count;
167}
168
169static ssize_t
170ata_scsi_lpm_show(struct device *dev, struct device_attribute *attr, char *buf)
171{
172 struct Scsi_Host *shost = class_to_shost(dev);
173 struct ata_port *ap = ata_shost_to_port(shost);
174 const char *policy =
175 ata_scsi_lpm_get(ap->pm_policy);
176
177 if (!policy)
178 return -EINVAL;
179
180 return snprintf(buf, 23, "%s\n", policy);
181}
182DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
183 ata_scsi_lpm_show, ata_scsi_lpm_put);
184EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
185
186static ssize_t ata_scsi_park_show(struct device *device,
187 struct device_attribute *attr, char *buf)
188{
189 struct scsi_device *sdev = to_scsi_device(device);
190 struct ata_port *ap;
191 struct ata_link *link;
192 struct ata_device *dev;
193 unsigned long flags;
194 unsigned int uninitialized_var(msecs);
195 int rc = 0;
196
197 ap = ata_shost_to_port(sdev->host);
198
199 spin_lock_irqsave(ap->lock, flags);
200 dev = ata_scsi_find_dev(ap, sdev);
201 if (!dev) {
202 rc = -ENODEV;
203 goto unlock;
204 }
205 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
206 rc = -EOPNOTSUPP;
207 goto unlock;
208 }
209
210 link = dev->link;
211 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
212 link->eh_context.unloaded_mask & (1 << dev->devno) &&
213 time_after(dev->unpark_deadline, jiffies))
214 msecs = jiffies_to_msecs(dev->unpark_deadline - jiffies);
215 else
216 msecs = 0;
217
218unlock:
219 spin_unlock_irq(ap->lock);
220
221 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
222}
223
224static ssize_t ata_scsi_park_store(struct device *device,
225 struct device_attribute *attr,
226 const char *buf, size_t len)
227{
228 struct scsi_device *sdev = to_scsi_device(device);
229 struct ata_port *ap;
230 struct ata_device *dev;
231 long int input;
232 unsigned long flags;
233 int rc;
234
235 rc = strict_strtol(buf, 10, &input);
236 if (rc || input < -2)
237 return -EINVAL;
238 if (input > ATA_TMOUT_MAX_PARK) {
239 rc = -EOVERFLOW;
240 input = ATA_TMOUT_MAX_PARK;
241 }
242
243 ap = ata_shost_to_port(sdev->host);
244
245 spin_lock_irqsave(ap->lock, flags);
246 dev = ata_scsi_find_dev(ap, sdev);
247 if (unlikely(!dev)) {
248 rc = -ENODEV;
249 goto unlock;
250 }
251 if (dev->class != ATA_DEV_ATA) {
252 rc = -EOPNOTSUPP;
253 goto unlock;
254 }
255
256 if (input >= 0) {
257 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
258 rc = -EOPNOTSUPP;
259 goto unlock;
260 }
261
262 dev->unpark_deadline = ata_deadline(jiffies, input);
263 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
264 ata_port_schedule_eh(ap);
265 complete(&ap->park_req_pending);
266 } else {
267 switch (input) {
268 case -1:
269 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
270 break;
271 case -2:
272 dev->flags |= ATA_DFLAG_NO_UNLOAD;
273 break;
274 }
275 }
276unlock:
277 spin_unlock_irqrestore(ap->lock, flags);
278
279 return rc ? rc : len;
280}
281DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
282 ata_scsi_park_show, ata_scsi_park_store);
283EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
284
285static void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
286{
287 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
288
289 scsi_build_sense_buffer(0, cmd->sense_buffer, sk, asc, ascq);
290}
291
292static ssize_t
293ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
294 const char *buf, size_t count)
295{
296 struct Scsi_Host *shost = class_to_shost(dev);
297 struct ata_port *ap = ata_shost_to_port(shost);
298 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
299 return ap->ops->em_store(ap, buf, count);
300 return -EINVAL;
301}
302
303static ssize_t
304ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
305 char *buf)
306{
307 struct Scsi_Host *shost = class_to_shost(dev);
308 struct ata_port *ap = ata_shost_to_port(shost);
309
310 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
311 return ap->ops->em_show(ap, buf);
312 return -EINVAL;
313}
314DEVICE_ATTR(em_message, S_IRUGO | S_IWUGO,
315 ata_scsi_em_message_show, ata_scsi_em_message_store);
316EXPORT_SYMBOL_GPL(dev_attr_em_message);
317
318static ssize_t
319ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
320 char *buf)
321{
322 struct Scsi_Host *shost = class_to_shost(dev);
323 struct ata_port *ap = ata_shost_to_port(shost);
324
325 return snprintf(buf, 23, "%d\n", ap->em_message_type);
326}
327DEVICE_ATTR(em_message_type, S_IRUGO,
328 ata_scsi_em_message_type_show, NULL);
329EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
330
331static ssize_t
332ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
333 char *buf)
334{
335 struct scsi_device *sdev = to_scsi_device(dev);
336 struct ata_port *ap = ata_shost_to_port(sdev->host);
337 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
338
339 if (ap->ops->sw_activity_show && (ap->flags & ATA_FLAG_SW_ACTIVITY))
340 return ap->ops->sw_activity_show(atadev, buf);
341 return -EINVAL;
342}
343
344static ssize_t
345ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
346 const char *buf, size_t count)
347{
348 struct scsi_device *sdev = to_scsi_device(dev);
349 struct ata_port *ap = ata_shost_to_port(sdev->host);
350 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
351 enum sw_activity val;
352 int rc;
353
354 if (ap->ops->sw_activity_store && (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
355 val = simple_strtoul(buf, NULL, 0);
356 switch (val) {
357 case OFF: case BLINK_ON: case BLINK_OFF:
358 rc = ap->ops->sw_activity_store(atadev, val);
359 if (!rc)
360 return count;
361 else
362 return rc;
363 }
364 }
365 return -EINVAL;
366}
367DEVICE_ATTR(sw_activity, S_IWUGO | S_IRUGO, ata_scsi_activity_show,
368 ata_scsi_activity_store);
369EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
370
371struct device_attribute *ata_common_sdev_attrs[] = {
372 &dev_attr_unload_heads,
373 NULL
374};
375EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
376
377static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
378 void (*done)(struct scsi_cmnd *))
379{
380 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
381 /* "Invalid field in cbd" */
382 done(cmd);
383}
384
385/**
386 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
387 * @sdev: SCSI device for which BIOS geometry is to be determined
388 * @bdev: block device associated with @sdev
389 * @capacity: capacity of SCSI device
390 * @geom: location to which geometry will be output
391 *
392 * Generic bios head/sector/cylinder calculator
393 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
394 * mapping. Some situations may arise where the disk is not
395 * bootable if this is not used.
396 *
397 * LOCKING:
398 * Defined by the SCSI layer. We don't really care.
399 *
400 * RETURNS:
401 * Zero.
402 */
403int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
404 sector_t capacity, int geom[])
405{
406 geom[0] = 255;
407 geom[1] = 63;
408 sector_div(capacity, 255*63);
409 geom[2] = capacity;
410
411 return 0;
412}
413
414/**
415 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
416 * @sdev: SCSI device to get identify data for
417 * @arg: User buffer area for identify data
418 *
419 * LOCKING:
420 * Defined by the SCSI layer. We don't really care.
421 *
422 * RETURNS:
423 * Zero on success, negative errno on error.
424 */
425static int ata_get_identity(struct scsi_device *sdev, void __user *arg)
426{
427 struct ata_port *ap = ata_shost_to_port(sdev->host);
428 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
429 u16 __user *dst = arg;
430 char buf[40];
431
432 if (!dev)
433 return -ENOMSG;
434
435 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
436 return -EFAULT;
437
438 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
439 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
440 return -EFAULT;
441
442 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
443 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
444 return -EFAULT;
445
446 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
447 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
448 return -EFAULT;
449
450 return 0;
451}
452
453/**
454 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
455 * @scsidev: Device to which we are issuing command
456 * @arg: User provided data for issuing command
457 *
458 * LOCKING:
459 * Defined by the SCSI layer. We don't really care.
460 *
461 * RETURNS:
462 * Zero on success, negative errno on error.
463 */
464int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
465{
466 int rc = 0;
467 u8 scsi_cmd[MAX_COMMAND_SIZE];
468 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
469 int argsize = 0;
470 enum dma_data_direction data_dir;
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 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
480 if (!sensebuf)
481 return -ENOMEM;
482
483 memset(scsi_cmd, 0, sizeof(scsi_cmd));
484
485 if (args[3]) {
486 argsize = SECTOR_SIZE * args[3];
487 argbuf = kmalloc(argsize, GFP_KERNEL);
488 if (argbuf == NULL) {
489 rc = -ENOMEM;
490 goto error;
491 }
492
493 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
494 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
495 block count in sector count field */
496 data_dir = DMA_FROM_DEVICE;
497 } else {
498 scsi_cmd[1] = (3 << 1); /* Non-data */
499 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
500 data_dir = DMA_NONE;
501 }
502
503 scsi_cmd[0] = ATA_16;
504
505 scsi_cmd[4] = args[2];
506 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
507 scsi_cmd[6] = args[3];
508 scsi_cmd[8] = args[1];
509 scsi_cmd[10] = 0x4f;
510 scsi_cmd[12] = 0xc2;
511 } else {
512 scsi_cmd[6] = args[1];
513 }
514 scsi_cmd[14] = args[0];
515
516 /* Good values for timeout and retries? Values below
517 from scsi_ioctl_send_command() for default case... */
518 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
519 sensebuf, (10*HZ), 5, 0);
520
521 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
522 u8 *desc = sensebuf + 8;
523 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
524
525 /* If we set cc then ATA pass-through will cause a
526 * check condition even if no error. Filter that. */
527 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
528 struct scsi_sense_hdr sshdr;
529 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
530 &sshdr);
531 if (sshdr.sense_key == 0 &&
532 sshdr.asc == 0 && sshdr.ascq == 0)
533 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
534 }
535
536 /* Send userspace a few ATA registers (same as drivers/ide) */
537 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
538 desc[0] == 0x09) { /* code is "ATA Descriptor" */
539 args[0] = desc[13]; /* status */
540 args[1] = desc[3]; /* error */
541 args[2] = desc[5]; /* sector count (0:7) */
542 if (copy_to_user(arg, args, sizeof(args)))
543 rc = -EFAULT;
544 }
545 }
546
547
548 if (cmd_result) {
549 rc = -EIO;
550 goto error;
551 }
552
553 if ((argbuf)
554 && copy_to_user(arg + sizeof(args), argbuf, argsize))
555 rc = -EFAULT;
556error:
557 kfree(sensebuf);
558 kfree(argbuf);
559 return rc;
560}
561
562/**
563 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
564 * @scsidev: Device to which we are issuing command
565 * @arg: User provided data for issuing command
566 *
567 * LOCKING:
568 * Defined by the SCSI layer. We don't really care.
569 *
570 * RETURNS:
571 * Zero on success, negative errno on error.
572 */
573int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
574{
575 int rc = 0;
576 u8 scsi_cmd[MAX_COMMAND_SIZE];
577 u8 args[7], *sensebuf = NULL;
578 int cmd_result;
579
580 if (arg == NULL)
581 return -EINVAL;
582
583 if (copy_from_user(args, arg, sizeof(args)))
584 return -EFAULT;
585
586 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
587 if (!sensebuf)
588 return -ENOMEM;
589
590 memset(scsi_cmd, 0, sizeof(scsi_cmd));
591 scsi_cmd[0] = ATA_16;
592 scsi_cmd[1] = (3 << 1); /* Non-data */
593 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
594 scsi_cmd[4] = args[1];
595 scsi_cmd[6] = args[2];
596 scsi_cmd[8] = args[3];
597 scsi_cmd[10] = args[4];
598 scsi_cmd[12] = args[5];
599 scsi_cmd[13] = args[6] & 0x4f;
600 scsi_cmd[14] = args[0];
601
602 /* Good values for timeout and retries? Values below
603 from scsi_ioctl_send_command() for default case... */
604 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
605 sensebuf, (10*HZ), 5, 0);
606
607 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
608 u8 *desc = sensebuf + 8;
609 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
610
611 /* If we set cc then ATA pass-through will cause a
612 * check condition even if no error. Filter that. */
613 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
614 struct scsi_sense_hdr sshdr;
615 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
616 &sshdr);
617 if (sshdr.sense_key == 0 &&
618 sshdr.asc == 0 && sshdr.ascq == 0)
619 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
620 }
621
622 /* Send userspace ATA registers */
623 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
624 desc[0] == 0x09) {/* code is "ATA Descriptor" */
625 args[0] = desc[13]; /* status */
626 args[1] = desc[3]; /* error */
627 args[2] = desc[5]; /* sector count (0:7) */
628 args[3] = desc[7]; /* lbal */
629 args[4] = desc[9]; /* lbam */
630 args[5] = desc[11]; /* lbah */
631 args[6] = desc[12]; /* select */
632 if (copy_to_user(arg, args, sizeof(args)))
633 rc = -EFAULT;
634 }
635 }
636
637 if (cmd_result) {
638 rc = -EIO;
639 goto error;
640 }
641
642 error:
643 kfree(sensebuf);
644 return rc;
645}
646
647int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
648{
649 int val = -EINVAL, rc = -EINVAL;
650
651 switch (cmd) {
652 case ATA_IOC_GET_IO32:
653 val = 0;
654 if (copy_to_user(arg, &val, 1))
655 return -EFAULT;
656 return 0;
657
658 case ATA_IOC_SET_IO32:
659 val = (unsigned long) arg;
660 if (val != 0)
661 return -EINVAL;
662 return 0;
663
664 case HDIO_GET_IDENTITY:
665 return ata_get_identity(scsidev, arg);
666
667 case HDIO_DRIVE_CMD:
668 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
669 return -EACCES;
670 return ata_cmd_ioctl(scsidev, arg);
671
672 case HDIO_DRIVE_TASK:
673 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
674 return -EACCES;
675 return ata_task_ioctl(scsidev, arg);
676
677 default:
678 rc = -ENOTTY;
679 break;
680 }
681
682 return rc;
683}
684
685/**
686 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
687 * @dev: ATA device to which the new command is attached
688 * @cmd: SCSI command that originated this ATA command
689 * @done: SCSI command completion function
690 *
691 * Obtain a reference to an unused ata_queued_cmd structure,
692 * which is the basic libata structure representing a single
693 * ATA command sent to the hardware.
694 *
695 * If a command was available, fill in the SCSI-specific
696 * portions of the structure with information on the
697 * current command.
698 *
699 * LOCKING:
700 * spin_lock_irqsave(host lock)
701 *
702 * RETURNS:
703 * Command allocated, or %NULL if none available.
704 */
705static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
706 struct scsi_cmnd *cmd,
707 void (*done)(struct scsi_cmnd *))
708{
709 struct ata_queued_cmd *qc;
710
711 qc = ata_qc_new_init(dev, cmd->request->tag);
712 if (qc) {
713 qc->scsicmd = cmd;
714 qc->scsidone = done;
715
716 qc->sg = scsi_sglist(cmd);
717 qc->n_elem = scsi_sg_count(cmd);
718 } else {
719 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
720 done(cmd);
721 }
722
723 return qc;
724}
725
726static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
727{
728 struct scsi_cmnd *scmd = qc->scsicmd;
729
730 qc->extrabytes = scmd->request->extra_len;
731 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
732}
733
734/**
735 * ata_dump_status - user friendly display of error info
736 * @id: id of the port in question
737 * @tf: ptr to filled out taskfile
738 *
739 * Decode and dump the ATA error/status registers for the user so
740 * that they have some idea what really happened at the non
741 * make-believe layer.
742 *
743 * LOCKING:
744 * inherited from caller
745 */
746static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
747{
748 u8 stat = tf->command, err = tf->feature;
749
750 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
751 if (stat & ATA_BUSY) {
752 printk("Busy }\n"); /* Data is not valid in this case */
753 } else {
754 if (stat & 0x40) printk("DriveReady ");
755 if (stat & 0x20) printk("DeviceFault ");
756 if (stat & 0x10) printk("SeekComplete ");
757 if (stat & 0x08) printk("DataRequest ");
758 if (stat & 0x04) printk("CorrectedError ");
759 if (stat & 0x02) printk("Index ");
760 if (stat & 0x01) printk("Error ");
761 printk("}\n");
762
763 if (err) {
764 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
765 if (err & 0x04) printk("DriveStatusError ");
766 if (err & 0x80) {
767 if (err & 0x04) printk("BadCRC ");
768 else printk("Sector ");
769 }
770 if (err & 0x40) printk("UncorrectableError ");
771 if (err & 0x10) printk("SectorIdNotFound ");
772 if (err & 0x02) printk("TrackZeroNotFound ");
773 if (err & 0x01) printk("AddrMarkNotFound ");
774 printk("}\n");
775 }
776 }
777}
778
779/**
780 * ata_to_sense_error - convert ATA error to SCSI error
781 * @id: ATA device number
782 * @drv_stat: value contained in ATA status register
783 * @drv_err: value contained in ATA error register
784 * @sk: the sense key we'll fill out
785 * @asc: the additional sense code we'll fill out
786 * @ascq: the additional sense code qualifier we'll fill out
787 * @verbose: be verbose
788 *
789 * Converts an ATA error into a SCSI error. Fill out pointers to
790 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
791 * format sense blocks.
792 *
793 * LOCKING:
794 * spin_lock_irqsave(host lock)
795 */
796static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
797 u8 *asc, u8 *ascq, int verbose)
798{
799 int i;
800
801 /* Based on the 3ware driver translation table */
802 static const unsigned char sense_table[][4] = {
803 /* BBD|ECC|ID|MAR */
804 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
805 /* BBD|ECC|ID */
806 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
807 /* ECC|MC|MARK */
808 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
809 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
810 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
811 /* MC|ID|ABRT|TRK0|MARK */
812 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
813 /* MCR|MARK */
814 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
815 /* Bad address mark */
816 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
817 /* TRK0 */
818 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
819 /* Abort & !ICRC */
820 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
821 /* Media change request */
822 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
823 /* SRV */
824 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
825 /* Media change */
826 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
827 /* ECC */
828 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
829 /* BBD - block marked bad */
830 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
831 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
832 };
833 static const unsigned char stat_table[][4] = {
834 /* Must be first because BUSY means no other bits valid */
835 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
836 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
837 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
838 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
839 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
840 };
841
842 /*
843 * Is this an error we can process/parse
844 */
845 if (drv_stat & ATA_BUSY) {
846 drv_err = 0; /* Ignore the err bits, they're invalid */
847 }
848
849 if (drv_err) {
850 /* Look for drv_err */
851 for (i = 0; sense_table[i][0] != 0xFF; i++) {
852 /* Look for best matches first */
853 if ((sense_table[i][0] & drv_err) ==
854 sense_table[i][0]) {
855 *sk = sense_table[i][1];
856 *asc = sense_table[i][2];
857 *ascq = sense_table[i][3];
858 goto translate_done;
859 }
860 }
861 /* No immediate match */
862 if (verbose)
863 printk(KERN_WARNING "ata%u: no sense translation for "
864 "error 0x%02x\n", id, drv_err);
865 }
866
867 /* Fall back to interpreting status bits */
868 for (i = 0; stat_table[i][0] != 0xFF; i++) {
869 if (stat_table[i][0] & drv_stat) {
870 *sk = stat_table[i][1];
871 *asc = stat_table[i][2];
872 *ascq = stat_table[i][3];
873 goto translate_done;
874 }
875 }
876 /* No error? Undecoded? */
877 if (verbose)
878 printk(KERN_WARNING "ata%u: no sense translation for "
879 "status: 0x%02x\n", id, drv_stat);
880
881 /* We need a sensible error return here, which is tricky, and one
882 that won't cause people to do things like return a disk wrongly */
883 *sk = ABORTED_COMMAND;
884 *asc = 0x00;
885 *ascq = 0x00;
886
887 translate_done:
888 if (verbose)
889 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
890 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
891 id, drv_stat, drv_err, *sk, *asc, *ascq);
892 return;
893}
894
895/*
896 * ata_gen_passthru_sense - Generate check condition sense block.
897 * @qc: Command that completed.
898 *
899 * This function is specific to the ATA descriptor format sense
900 * block specified for the ATA pass through commands. Regardless
901 * of whether the command errored or not, return a sense
902 * block. Copy all controller registers into the sense
903 * block. Clear sense key, ASC & ASCQ if there is no error.
904 *
905 * LOCKING:
906 * None.
907 */
908static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
909{
910 struct scsi_cmnd *cmd = qc->scsicmd;
911 struct ata_taskfile *tf = &qc->result_tf;
912 unsigned char *sb = cmd->sense_buffer;
913 unsigned char *desc = sb + 8;
914 int verbose = qc->ap->ops->error_handler == NULL;
915
916 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
917
918 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
919
920 /*
921 * Use ata_to_sense_error() to map status register bits
922 * onto sense key, asc & ascq.
923 */
924 if (qc->err_mask ||
925 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
926 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
927 &sb[1], &sb[2], &sb[3], verbose);
928 sb[1] &= 0x0f;
929 }
930
931 /*
932 * Sense data is current and format is descriptor.
933 */
934 sb[0] = 0x72;
935
936 desc[0] = 0x09;
937
938 /* set length of additional sense data */
939 sb[7] = 14;
940 desc[1] = 12;
941
942 /*
943 * Copy registers into sense buffer.
944 */
945 desc[2] = 0x00;
946 desc[3] = tf->feature; /* == error reg */
947 desc[5] = tf->nsect;
948 desc[7] = tf->lbal;
949 desc[9] = tf->lbam;
950 desc[11] = tf->lbah;
951 desc[12] = tf->device;
952 desc[13] = tf->command; /* == status reg */
953
954 /*
955 * Fill in Extend bit, and the high order bytes
956 * if applicable.
957 */
958 if (tf->flags & ATA_TFLAG_LBA48) {
959 desc[2] |= 0x01;
960 desc[4] = tf->hob_nsect;
961 desc[6] = tf->hob_lbal;
962 desc[8] = tf->hob_lbam;
963 desc[10] = tf->hob_lbah;
964 }
965}
966
967/**
968 * ata_gen_ata_sense - generate a SCSI fixed sense block
969 * @qc: Command that we are erroring out
970 *
971 * Generate sense block for a failed ATA command @qc. Descriptor
972 * format is used to accomodate LBA48 block address.
973 *
974 * LOCKING:
975 * None.
976 */
977static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
978{
979 struct ata_device *dev = qc->dev;
980 struct scsi_cmnd *cmd = qc->scsicmd;
981 struct ata_taskfile *tf = &qc->result_tf;
982 unsigned char *sb = cmd->sense_buffer;
983 unsigned char *desc = sb + 8;
984 int verbose = qc->ap->ops->error_handler == NULL;
985 u64 block;
986
987 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
988
989 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
990
991 /* sense data is current and format is descriptor */
992 sb[0] = 0x72;
993
994 /* Use ata_to_sense_error() to map status register bits
995 * onto sense key, asc & ascq.
996 */
997 if (qc->err_mask ||
998 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
999 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1000 &sb[1], &sb[2], &sb[3], verbose);
1001 sb[1] &= 0x0f;
1002 }
1003
1004 block = ata_tf_read_block(&qc->result_tf, dev);
1005
1006 /* information sense data descriptor */
1007 sb[7] = 12;
1008 desc[0] = 0x00;
1009 desc[1] = 10;
1010
1011 desc[2] |= 0x80; /* valid */
1012 desc[6] = block >> 40;
1013 desc[7] = block >> 32;
1014 desc[8] = block >> 24;
1015 desc[9] = block >> 16;
1016 desc[10] = block >> 8;
1017 desc[11] = block;
1018}
1019
1020static void ata_scsi_sdev_config(struct scsi_device *sdev)
1021{
1022 sdev->use_10_for_rw = 1;
1023 sdev->use_10_for_ms = 1;
1024
1025 /* Schedule policy is determined by ->qc_defer() callback and
1026 * it needs to see every deferred qc. Set dev_blocked to 1 to
1027 * prevent SCSI midlayer from automatically deferring
1028 * requests.
1029 */
1030 sdev->max_device_blocked = 1;
1031}
1032
1033/**
1034 * atapi_drain_needed - Check whether data transfer may overflow
1035 * @rq: request to be checked
1036 *
1037 * ATAPI commands which transfer variable length data to host
1038 * might overflow due to application error or hardare bug. This
1039 * function checks whether overflow should be drained and ignored
1040 * for @request.
1041 *
1042 * LOCKING:
1043 * None.
1044 *
1045 * RETURNS:
1046 * 1 if ; otherwise, 0.
1047 */
1048static int atapi_drain_needed(struct request *rq)
1049{
1050 if (likely(!blk_pc_request(rq)))
1051 return 0;
1052
1053 if (!rq->data_len || (rq->cmd_flags & REQ_RW))
1054 return 0;
1055
1056 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1057}
1058
1059static int ata_scsi_dev_config(struct scsi_device *sdev,
1060 struct ata_device *dev)
1061{
1062 if (!ata_id_has_unload(dev->id))
1063 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1064
1065 /* configure max sectors */
1066 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
1067
1068 if (dev->class == ATA_DEV_ATAPI) {
1069 struct request_queue *q = sdev->request_queue;
1070 void *buf;
1071
1072 /* set the min alignment and padding */
1073 blk_queue_update_dma_alignment(sdev->request_queue,
1074 ATA_DMA_PAD_SZ - 1);
1075 blk_queue_update_dma_pad(sdev->request_queue,
1076 ATA_DMA_PAD_SZ - 1);
1077
1078 /* configure draining */
1079 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1080 if (!buf) {
1081 ata_dev_printk(dev, KERN_ERR,
1082 "drain buffer allocation failed\n");
1083 return -ENOMEM;
1084 }
1085
1086 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1087 } else {
1088 if (ata_id_is_ssd(dev->id))
1089 queue_flag_set_unlocked(QUEUE_FLAG_NONROT,
1090 sdev->request_queue);
1091
1092 /* ATA devices must be sector aligned */
1093 blk_queue_update_dma_alignment(sdev->request_queue,
1094 ATA_SECT_SIZE - 1);
1095 sdev->manage_start_stop = 1;
1096 }
1097
1098 if (dev->flags & ATA_DFLAG_AN)
1099 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1100
1101 if (dev->flags & ATA_DFLAG_NCQ) {
1102 int depth;
1103
1104 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1105 depth = min(ATA_MAX_QUEUE - 1, depth);
1106 scsi_set_tag_type(sdev, MSG_SIMPLE_TAG);
1107 scsi_activate_tcq(sdev, depth);
1108 }
1109
1110 return 0;
1111}
1112
1113/**
1114 * ata_scsi_slave_config - Set SCSI device attributes
1115 * @sdev: SCSI device to examine
1116 *
1117 * This is called before we actually start reading
1118 * and writing to the device, to configure certain
1119 * SCSI mid-layer behaviors.
1120 *
1121 * LOCKING:
1122 * Defined by SCSI layer. We don't really care.
1123 */
1124
1125int ata_scsi_slave_config(struct scsi_device *sdev)
1126{
1127 struct ata_port *ap = ata_shost_to_port(sdev->host);
1128 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1129 int rc = 0;
1130
1131 ata_scsi_sdev_config(sdev);
1132
1133 if (dev)
1134 rc = ata_scsi_dev_config(sdev, dev);
1135
1136 return rc;
1137}
1138
1139/**
1140 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1141 * @sdev: SCSI device to be destroyed
1142 *
1143 * @sdev is about to be destroyed for hot/warm unplugging. If
1144 * this unplugging was initiated by libata as indicated by NULL
1145 * dev->sdev, this function doesn't have to do anything.
1146 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1147 * Clear dev->sdev, schedule the device for ATA detach and invoke
1148 * EH.
1149 *
1150 * LOCKING:
1151 * Defined by SCSI layer. We don't really care.
1152 */
1153void ata_scsi_slave_destroy(struct scsi_device *sdev)
1154{
1155 struct ata_port *ap = ata_shost_to_port(sdev->host);
1156 struct request_queue *q = sdev->request_queue;
1157 unsigned long flags;
1158 struct ata_device *dev;
1159
1160 if (!ap->ops->error_handler)
1161 return;
1162
1163 spin_lock_irqsave(ap->lock, flags);
1164 dev = __ata_scsi_find_dev(ap, sdev);
1165 if (dev && dev->sdev) {
1166 /* SCSI device already in CANCEL state, no need to offline it */
1167 dev->sdev = NULL;
1168 dev->flags |= ATA_DFLAG_DETACH;
1169 ata_port_schedule_eh(ap);
1170 }
1171 spin_unlock_irqrestore(ap->lock, flags);
1172
1173 kfree(q->dma_drain_buffer);
1174 q->dma_drain_buffer = NULL;
1175 q->dma_drain_size = 0;
1176}
1177
1178/**
1179 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1180 * @sdev: SCSI device to configure queue depth for
1181 * @queue_depth: new queue depth
1182 *
1183 * This is libata standard hostt->change_queue_depth callback.
1184 * SCSI will call into this callback when user tries to set queue
1185 * depth via sysfs.
1186 *
1187 * LOCKING:
1188 * SCSI layer (we don't care)
1189 *
1190 * RETURNS:
1191 * Newly configured queue depth.
1192 */
1193int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1194{
1195 struct ata_port *ap = ata_shost_to_port(sdev->host);
1196 struct ata_device *dev;
1197 unsigned long flags;
1198
1199 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1200 return sdev->queue_depth;
1201
1202 dev = ata_scsi_find_dev(ap, sdev);
1203 if (!dev || !ata_dev_enabled(dev))
1204 return sdev->queue_depth;
1205
1206 /* NCQ enabled? */
1207 spin_lock_irqsave(ap->lock, flags);
1208 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1209 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1210 dev->flags |= ATA_DFLAG_NCQ_OFF;
1211 queue_depth = 1;
1212 }
1213 spin_unlock_irqrestore(ap->lock, flags);
1214
1215 /* limit and apply queue depth */
1216 queue_depth = min(queue_depth, sdev->host->can_queue);
1217 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1218 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1219
1220 if (sdev->queue_depth == queue_depth)
1221 return -EINVAL;
1222
1223 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1224 return queue_depth;
1225}
1226
1227/* XXX: for spindown warning */
1228static void ata_delayed_done_timerfn(unsigned long arg)
1229{
1230 struct scsi_cmnd *scmd = (void *)arg;
1231
1232 scmd->scsi_done(scmd);
1233}
1234
1235/* XXX: for spindown warning */
1236static void ata_delayed_done(struct scsi_cmnd *scmd)
1237{
1238 static struct timer_list timer;
1239
1240 setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
1241 mod_timer(&timer, jiffies + 5 * HZ);
1242}
1243
1244/**
1245 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1246 * @qc: Storage for translated ATA taskfile
1247 *
1248 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1249 * (to start). Perhaps these commands should be preceded by
1250 * CHECK POWER MODE to see what power mode the device is already in.
1251 * [See SAT revision 5 at www.t10.org]
1252 *
1253 * LOCKING:
1254 * spin_lock_irqsave(host lock)
1255 *
1256 * RETURNS:
1257 * Zero on success, non-zero on error.
1258 */
1259static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1260{
1261 struct scsi_cmnd *scmd = qc->scsicmd;
1262 struct ata_taskfile *tf = &qc->tf;
1263 const u8 *cdb = scmd->cmnd;
1264
1265 if (scmd->cmd_len < 5)
1266 goto invalid_fld;
1267
1268 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1269 tf->protocol = ATA_PROT_NODATA;
1270 if (cdb[1] & 0x1) {
1271 ; /* ignore IMMED bit, violates sat-r05 */
1272 }
1273 if (cdb[4] & 0x2)
1274 goto invalid_fld; /* LOEJ bit set not supported */
1275 if (((cdb[4] >> 4) & 0xf) != 0)
1276 goto invalid_fld; /* power conditions not supported */
1277
1278 if (cdb[4] & 0x1) {
1279 tf->nsect = 1; /* 1 sector, lba=0 */
1280
1281 if (qc->dev->flags & ATA_DFLAG_LBA) {
1282 tf->flags |= ATA_TFLAG_LBA;
1283
1284 tf->lbah = 0x0;
1285 tf->lbam = 0x0;
1286 tf->lbal = 0x0;
1287 tf->device |= ATA_LBA;
1288 } else {
1289 /* CHS */
1290 tf->lbal = 0x1; /* sect */
1291 tf->lbam = 0x0; /* cyl low */
1292 tf->lbah = 0x0; /* cyl high */
1293 }
1294
1295 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1296 } else {
1297 /* XXX: This is for backward compatibility, will be
1298 * removed. Read Documentation/feature-removal-schedule.txt
1299 * for more info.
1300 */
1301 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
1302 (system_state == SYSTEM_HALT ||
1303 system_state == SYSTEM_POWER_OFF)) {
1304 static unsigned long warned;
1305
1306 if (!test_and_set_bit(0, &warned)) {
1307 ata_dev_printk(qc->dev, KERN_WARNING,
1308 "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
1309 "UPDATE SHUTDOWN UTILITY\n");
1310 ata_dev_printk(qc->dev, KERN_WARNING,
1311 "For more info, visit "
1312 "http://linux-ata.org/shutdown.html\n");
1313
1314 /* ->scsi_done is not used, use it for
1315 * delayed completion.
1316 */
1317 scmd->scsi_done = qc->scsidone;
1318 qc->scsidone = ata_delayed_done;
1319 }
1320 scmd->result = SAM_STAT_GOOD;
1321 return 1;
1322 }
1323
1324 /* Issue ATA STANDBY IMMEDIATE command */
1325 tf->command = ATA_CMD_STANDBYNOW1;
1326 }
1327
1328 /*
1329 * Standby and Idle condition timers could be implemented but that
1330 * would require libata to implement the Power condition mode page
1331 * and allow the user to change it. Changing mode pages requires
1332 * MODE SELECT to be implemented.
1333 */
1334
1335 return 0;
1336
1337invalid_fld:
1338 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1339 /* "Invalid field in cbd" */
1340 return 1;
1341}
1342
1343
1344/**
1345 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1346 * @qc: Storage for translated ATA taskfile
1347 *
1348 * Sets up an ATA taskfile to issue FLUSH CACHE or
1349 * FLUSH CACHE EXT.
1350 *
1351 * LOCKING:
1352 * spin_lock_irqsave(host lock)
1353 *
1354 * RETURNS:
1355 * Zero on success, non-zero on error.
1356 */
1357static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1358{
1359 struct ata_taskfile *tf = &qc->tf;
1360
1361 tf->flags |= ATA_TFLAG_DEVICE;
1362 tf->protocol = ATA_PROT_NODATA;
1363
1364 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1365 tf->command = ATA_CMD_FLUSH_EXT;
1366 else
1367 tf->command = ATA_CMD_FLUSH;
1368
1369 /* flush is critical for IO integrity, consider it an IO command */
1370 qc->flags |= ATA_QCFLAG_IO;
1371
1372 return 0;
1373}
1374
1375/**
1376 * scsi_6_lba_len - Get LBA and transfer length
1377 * @cdb: SCSI command to translate
1378 *
1379 * Calculate LBA and transfer length for 6-byte commands.
1380 *
1381 * RETURNS:
1382 * @plba: the LBA
1383 * @plen: the transfer length
1384 */
1385static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1386{
1387 u64 lba = 0;
1388 u32 len;
1389
1390 VPRINTK("six-byte command\n");
1391
1392 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1393 lba |= ((u64)cdb[2]) << 8;
1394 lba |= ((u64)cdb[3]);
1395
1396 len = cdb[4];
1397
1398 *plba = lba;
1399 *plen = len;
1400}
1401
1402/**
1403 * scsi_10_lba_len - Get LBA and transfer length
1404 * @cdb: SCSI command to translate
1405 *
1406 * Calculate LBA and transfer length for 10-byte commands.
1407 *
1408 * RETURNS:
1409 * @plba: the LBA
1410 * @plen: the transfer length
1411 */
1412static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1413{
1414 u64 lba = 0;
1415 u32 len = 0;
1416
1417 VPRINTK("ten-byte command\n");
1418
1419 lba |= ((u64)cdb[2]) << 24;
1420 lba |= ((u64)cdb[3]) << 16;
1421 lba |= ((u64)cdb[4]) << 8;
1422 lba |= ((u64)cdb[5]);
1423
1424 len |= ((u32)cdb[7]) << 8;
1425 len |= ((u32)cdb[8]);
1426
1427 *plba = lba;
1428 *plen = len;
1429}
1430
1431/**
1432 * scsi_16_lba_len - Get LBA and transfer length
1433 * @cdb: SCSI command to translate
1434 *
1435 * Calculate LBA and transfer length for 16-byte commands.
1436 *
1437 * RETURNS:
1438 * @plba: the LBA
1439 * @plen: the transfer length
1440 */
1441static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1442{
1443 u64 lba = 0;
1444 u32 len = 0;
1445
1446 VPRINTK("sixteen-byte command\n");
1447
1448 lba |= ((u64)cdb[2]) << 56;
1449 lba |= ((u64)cdb[3]) << 48;
1450 lba |= ((u64)cdb[4]) << 40;
1451 lba |= ((u64)cdb[5]) << 32;
1452 lba |= ((u64)cdb[6]) << 24;
1453 lba |= ((u64)cdb[7]) << 16;
1454 lba |= ((u64)cdb[8]) << 8;
1455 lba |= ((u64)cdb[9]);
1456
1457 len |= ((u32)cdb[10]) << 24;
1458 len |= ((u32)cdb[11]) << 16;
1459 len |= ((u32)cdb[12]) << 8;
1460 len |= ((u32)cdb[13]);
1461
1462 *plba = lba;
1463 *plen = len;
1464}
1465
1466/**
1467 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1468 * @qc: Storage for translated ATA taskfile
1469 *
1470 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1471 *
1472 * LOCKING:
1473 * spin_lock_irqsave(host lock)
1474 *
1475 * RETURNS:
1476 * Zero on success, non-zero on error.
1477 */
1478static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1479{
1480 struct scsi_cmnd *scmd = qc->scsicmd;
1481 struct ata_taskfile *tf = &qc->tf;
1482 struct ata_device *dev = qc->dev;
1483 u64 dev_sectors = qc->dev->n_sectors;
1484 const u8 *cdb = scmd->cmnd;
1485 u64 block;
1486 u32 n_block;
1487
1488 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1489 tf->protocol = ATA_PROT_NODATA;
1490
1491 if (cdb[0] == VERIFY) {
1492 if (scmd->cmd_len < 10)
1493 goto invalid_fld;
1494 scsi_10_lba_len(cdb, &block, &n_block);
1495 } else if (cdb[0] == VERIFY_16) {
1496 if (scmd->cmd_len < 16)
1497 goto invalid_fld;
1498 scsi_16_lba_len(cdb, &block, &n_block);
1499 } else
1500 goto invalid_fld;
1501
1502 if (!n_block)
1503 goto nothing_to_do;
1504 if (block >= dev_sectors)
1505 goto out_of_range;
1506 if ((block + n_block) > dev_sectors)
1507 goto out_of_range;
1508
1509 if (dev->flags & ATA_DFLAG_LBA) {
1510 tf->flags |= ATA_TFLAG_LBA;
1511
1512 if (lba_28_ok(block, n_block)) {
1513 /* use LBA28 */
1514 tf->command = ATA_CMD_VERIFY;
1515 tf->device |= (block >> 24) & 0xf;
1516 } else if (lba_48_ok(block, n_block)) {
1517 if (!(dev->flags & ATA_DFLAG_LBA48))
1518 goto out_of_range;
1519
1520 /* use LBA48 */
1521 tf->flags |= ATA_TFLAG_LBA48;
1522 tf->command = ATA_CMD_VERIFY_EXT;
1523
1524 tf->hob_nsect = (n_block >> 8) & 0xff;
1525
1526 tf->hob_lbah = (block >> 40) & 0xff;
1527 tf->hob_lbam = (block >> 32) & 0xff;
1528 tf->hob_lbal = (block >> 24) & 0xff;
1529 } else
1530 /* request too large even for LBA48 */
1531 goto out_of_range;
1532
1533 tf->nsect = n_block & 0xff;
1534
1535 tf->lbah = (block >> 16) & 0xff;
1536 tf->lbam = (block >> 8) & 0xff;
1537 tf->lbal = block & 0xff;
1538
1539 tf->device |= ATA_LBA;
1540 } else {
1541 /* CHS */
1542 u32 sect, head, cyl, track;
1543
1544 if (!lba_28_ok(block, n_block))
1545 goto out_of_range;
1546
1547 /* Convert LBA to CHS */
1548 track = (u32)block / dev->sectors;
1549 cyl = track / dev->heads;
1550 head = track % dev->heads;
1551 sect = (u32)block % dev->sectors + 1;
1552
1553 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1554 (u32)block, track, cyl, head, sect);
1555
1556 /* Check whether the converted CHS can fit.
1557 Cylinder: 0-65535
1558 Head: 0-15
1559 Sector: 1-255*/
1560 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1561 goto out_of_range;
1562
1563 tf->command = ATA_CMD_VERIFY;
1564 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1565 tf->lbal = sect;
1566 tf->lbam = cyl;
1567 tf->lbah = cyl >> 8;
1568 tf->device |= head;
1569 }
1570
1571 return 0;
1572
1573invalid_fld:
1574 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1575 /* "Invalid field in cbd" */
1576 return 1;
1577
1578out_of_range:
1579 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1580 /* "Logical Block Address out of range" */
1581 return 1;
1582
1583nothing_to_do:
1584 scmd->result = SAM_STAT_GOOD;
1585 return 1;
1586}
1587
1588/**
1589 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1590 * @qc: Storage for translated ATA taskfile
1591 *
1592 * Converts any of six SCSI read/write commands into the
1593 * ATA counterpart, including starting sector (LBA),
1594 * sector count, and taking into account the device's LBA48
1595 * support.
1596 *
1597 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1598 * %WRITE_16 are currently supported.
1599 *
1600 * LOCKING:
1601 * spin_lock_irqsave(host lock)
1602 *
1603 * RETURNS:
1604 * Zero on success, non-zero on error.
1605 */
1606static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1607{
1608 struct scsi_cmnd *scmd = qc->scsicmd;
1609 const u8 *cdb = scmd->cmnd;
1610 unsigned int tf_flags = 0;
1611 u64 block;
1612 u32 n_block;
1613 int rc;
1614
1615 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1616 tf_flags |= ATA_TFLAG_WRITE;
1617
1618 /* Calculate the SCSI LBA, transfer length and FUA. */
1619 switch (cdb[0]) {
1620 case READ_10:
1621 case WRITE_10:
1622 if (unlikely(scmd->cmd_len < 10))
1623 goto invalid_fld;
1624 scsi_10_lba_len(cdb, &block, &n_block);
1625 if (unlikely(cdb[1] & (1 << 3)))
1626 tf_flags |= ATA_TFLAG_FUA;
1627 break;
1628 case READ_6:
1629 case WRITE_6:
1630 if (unlikely(scmd->cmd_len < 6))
1631 goto invalid_fld;
1632 scsi_6_lba_len(cdb, &block, &n_block);
1633
1634 /* for 6-byte r/w commands, transfer length 0
1635 * means 256 blocks of data, not 0 block.
1636 */
1637 if (!n_block)
1638 n_block = 256;
1639 break;
1640 case READ_16:
1641 case WRITE_16:
1642 if (unlikely(scmd->cmd_len < 16))
1643 goto invalid_fld;
1644 scsi_16_lba_len(cdb, &block, &n_block);
1645 if (unlikely(cdb[1] & (1 << 3)))
1646 tf_flags |= ATA_TFLAG_FUA;
1647 break;
1648 default:
1649 DPRINTK("no-byte command\n");
1650 goto invalid_fld;
1651 }
1652
1653 /* Check and compose ATA command */
1654 if (!n_block)
1655 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1656 * length 0 means transfer 0 block of data.
1657 * However, for ATA R/W commands, sector count 0 means
1658 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1659 *
1660 * WARNING: one or two older ATA drives treat 0 as 0...
1661 */
1662 goto nothing_to_do;
1663
1664 qc->flags |= ATA_QCFLAG_IO;
1665 qc->nbytes = n_block * ATA_SECT_SIZE;
1666
1667 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1668 qc->tag);
1669 if (likely(rc == 0))
1670 return 0;
1671
1672 if (rc == -ERANGE)
1673 goto out_of_range;
1674 /* treat all other errors as -EINVAL, fall through */
1675invalid_fld:
1676 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1677 /* "Invalid field in cbd" */
1678 return 1;
1679
1680out_of_range:
1681 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1682 /* "Logical Block Address out of range" */
1683 return 1;
1684
1685nothing_to_do:
1686 scmd->result = SAM_STAT_GOOD;
1687 return 1;
1688}
1689
1690static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1691{
1692 struct ata_port *ap = qc->ap;
1693 struct scsi_cmnd *cmd = qc->scsicmd;
1694 u8 *cdb = cmd->cmnd;
1695 int need_sense = (qc->err_mask != 0);
1696
1697 /* For ATA pass thru (SAT) commands, generate a sense block if
1698 * user mandated it or if there's an error. Note that if we
1699 * generate because the user forced us to, a check condition
1700 * is generated and the ATA register values are returned
1701 * whether the command completed successfully or not. If there
1702 * was no error, SK, ASC and ASCQ will all be zero.
1703 */
1704 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1705 ((cdb[2] & 0x20) || need_sense)) {
1706 ata_gen_passthru_sense(qc);
1707 } else {
1708 if (!need_sense) {
1709 cmd->result = SAM_STAT_GOOD;
1710 } else {
1711 /* TODO: decide which descriptor format to use
1712 * for 48b LBA devices and call that here
1713 * instead of the fixed desc, which is only
1714 * good for smaller LBA (and maybe CHS?)
1715 * devices.
1716 */
1717 ata_gen_ata_sense(qc);
1718 }
1719 }
1720
1721 /* XXX: track spindown state for spindown skipping and warning */
1722 if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1723 qc->tf.command == ATA_CMD_STANDBYNOW1))
1724 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1725 else if (likely(system_state != SYSTEM_HALT &&
1726 system_state != SYSTEM_POWER_OFF))
1727 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1728
1729 if (need_sense && !ap->ops->error_handler)
1730 ata_dump_status(ap->print_id, &qc->result_tf);
1731
1732 qc->scsidone(cmd);
1733
1734 ata_qc_free(qc);
1735}
1736
1737/**
1738 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1739 * @dev: ATA device to which the command is addressed
1740 * @cmd: SCSI command to execute
1741 * @done: SCSI command completion function
1742 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1743 *
1744 * Our ->queuecommand() function has decided that the SCSI
1745 * command issued can be directly translated into an ATA
1746 * command, rather than handled internally.
1747 *
1748 * This function sets up an ata_queued_cmd structure for the
1749 * SCSI command, and sends that ata_queued_cmd to the hardware.
1750 *
1751 * The xlat_func argument (actor) returns 0 if ready to execute
1752 * ATA command, else 1 to finish translation. If 1 is returned
1753 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1754 * to be set reflecting an error condition or clean (early)
1755 * termination.
1756 *
1757 * LOCKING:
1758 * spin_lock_irqsave(host lock)
1759 *
1760 * RETURNS:
1761 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1762 * needs to be deferred.
1763 */
1764static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1765 void (*done)(struct scsi_cmnd *),
1766 ata_xlat_func_t xlat_func)
1767{
1768 struct ata_port *ap = dev->link->ap;
1769 struct ata_queued_cmd *qc;
1770 int rc;
1771
1772 VPRINTK("ENTER\n");
1773
1774 qc = ata_scsi_qc_new(dev, cmd, done);
1775 if (!qc)
1776 goto err_mem;
1777
1778 /* data is present; dma-map it */
1779 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1780 cmd->sc_data_direction == DMA_TO_DEVICE) {
1781 if (unlikely(scsi_bufflen(cmd) < 1)) {
1782 ata_dev_printk(dev, KERN_WARNING,
1783 "WARNING: zero len r/w req\n");
1784 goto err_did;
1785 }
1786
1787 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1788
1789 qc->dma_dir = cmd->sc_data_direction;
1790 }
1791
1792 qc->complete_fn = ata_scsi_qc_complete;
1793
1794 if (xlat_func(qc))
1795 goto early_finish;
1796
1797 if (ap->ops->qc_defer) {
1798 if ((rc = ap->ops->qc_defer(qc)))
1799 goto defer;
1800 }
1801
1802 /* select device, send command to hardware */
1803 ata_qc_issue(qc);
1804
1805 VPRINTK("EXIT\n");
1806 return 0;
1807
1808early_finish:
1809 ata_qc_free(qc);
1810 qc->scsidone(cmd);
1811 DPRINTK("EXIT - early finish (good or error)\n");
1812 return 0;
1813
1814err_did:
1815 ata_qc_free(qc);
1816 cmd->result = (DID_ERROR << 16);
1817 qc->scsidone(cmd);
1818err_mem:
1819 DPRINTK("EXIT - internal\n");
1820 return 0;
1821
1822defer:
1823 ata_qc_free(qc);
1824 DPRINTK("EXIT - defer\n");
1825 if (rc == ATA_DEFER_LINK)
1826 return SCSI_MLQUEUE_DEVICE_BUSY;
1827 else
1828 return SCSI_MLQUEUE_HOST_BUSY;
1829}
1830
1831/**
1832 * ata_scsi_rbuf_get - Map response buffer.
1833 * @cmd: SCSI command containing buffer to be mapped.
1834 * @flags: unsigned long variable to store irq enable status
1835 * @copy_in: copy in from user buffer
1836 *
1837 * Prepare buffer for simulated SCSI commands.
1838 *
1839 * LOCKING:
1840 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1841 *
1842 * RETURNS:
1843 * Pointer to response buffer.
1844 */
1845static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1846 unsigned long *flags)
1847{
1848 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1849
1850 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1851 if (copy_in)
1852 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1853 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1854 return ata_scsi_rbuf;
1855}
1856
1857/**
1858 * ata_scsi_rbuf_put - Unmap response buffer.
1859 * @cmd: SCSI command containing buffer to be unmapped.
1860 * @copy_out: copy out result
1861 * @flags: @flags passed to ata_scsi_rbuf_get()
1862 *
1863 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1864 * @copy_back is true.
1865 *
1866 * LOCKING:
1867 * Unlocks ata_scsi_rbuf_lock.
1868 */
1869static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1870 unsigned long *flags)
1871{
1872 if (copy_out)
1873 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1874 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1875 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1876}
1877
1878/**
1879 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1880 * @args: device IDENTIFY data / SCSI command of interest.
1881 * @actor: Callback hook for desired SCSI command simulator
1882 *
1883 * Takes care of the hard work of simulating a SCSI command...
1884 * Mapping the response buffer, calling the command's handler,
1885 * and handling the handler's return value. This return value
1886 * indicates whether the handler wishes the SCSI command to be
1887 * completed successfully (0), or not (in which case cmd->result
1888 * and sense buffer are assumed to be set).
1889 *
1890 * LOCKING:
1891 * spin_lock_irqsave(host lock)
1892 */
1893static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1894 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1895{
1896 u8 *rbuf;
1897 unsigned int rc;
1898 struct scsi_cmnd *cmd = args->cmd;
1899 unsigned long flags;
1900
1901 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1902 rc = actor(args, rbuf);
1903 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1904
1905 if (rc == 0)
1906 cmd->result = SAM_STAT_GOOD;
1907 args->done(cmd);
1908}
1909
1910/**
1911 * ata_scsiop_inq_std - Simulate INQUIRY command
1912 * @args: device IDENTIFY data / SCSI command of interest.
1913 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1914 *
1915 * Returns standard device identification data associated
1916 * with non-VPD INQUIRY command output.
1917 *
1918 * LOCKING:
1919 * spin_lock_irqsave(host lock)
1920 */
1921static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1922{
1923 const u8 versions[] = {
1924 0x60, /* SAM-3 (no version claimed) */
1925
1926 0x03,
1927 0x20, /* SBC-2 (no version claimed) */
1928
1929 0x02,
1930 0x60 /* SPC-3 (no version claimed) */
1931 };
1932 u8 hdr[] = {
1933 TYPE_DISK,
1934 0,
1935 0x5, /* claim SPC-3 version compatibility */
1936 2,
1937 95 - 4
1938 };
1939
1940 VPRINTK("ENTER\n");
1941
1942 /* set scsi removeable (RMB) bit per ata bit */
1943 if (ata_id_removeable(args->id))
1944 hdr[1] |= (1 << 7);
1945
1946 memcpy(rbuf, hdr, sizeof(hdr));
1947
1948 /* if ncq, set tags supported */
1949 if (ata_id_has_ncq(args->id))
1950 rbuf[7] |= (1 << 1);
1951
1952 memcpy(&rbuf[8], "ATA ", 8);
1953 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1954 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1955
1956 if (rbuf[32] == 0 || rbuf[32] == ' ')
1957 memcpy(&rbuf[32], "n/a ", 4);
1958
1959 memcpy(rbuf + 59, versions, sizeof(versions));
1960
1961 return 0;
1962}
1963
1964/**
1965 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1966 * @args: device IDENTIFY data / SCSI command of interest.
1967 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1968 *
1969 * Returns list of inquiry VPD pages available.
1970 *
1971 * LOCKING:
1972 * spin_lock_irqsave(host lock)
1973 */
1974static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1975{
1976 const u8 pages[] = {
1977 0x00, /* page 0x00, this page */
1978 0x80, /* page 0x80, unit serial no page */
1979 0x83, /* page 0x83, device ident page */
1980 0x89, /* page 0x89, ata info page */
1981 0xb1, /* page 0xb1, block device characteristics page */
1982 };
1983
1984 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1985 memcpy(rbuf + 4, pages, sizeof(pages));
1986 return 0;
1987}
1988
1989/**
1990 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1991 * @args: device IDENTIFY data / SCSI command of interest.
1992 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1993 *
1994 * Returns ATA device serial number.
1995 *
1996 * LOCKING:
1997 * spin_lock_irqsave(host lock)
1998 */
1999static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2000{
2001 const u8 hdr[] = {
2002 0,
2003 0x80, /* this page code */
2004 0,
2005 ATA_ID_SERNO_LEN, /* page len */
2006 };
2007
2008 memcpy(rbuf, hdr, sizeof(hdr));
2009 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2010 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2011 return 0;
2012}
2013
2014/**
2015 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2016 * @args: device IDENTIFY data / SCSI command of interest.
2017 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2018 *
2019 * Yields two logical unit device identification designators:
2020 * - vendor specific ASCII containing the ATA serial number
2021 * - SAT defined "t10 vendor id based" containing ASCII vendor
2022 * name ("ATA "), model and serial numbers.
2023 *
2024 * LOCKING:
2025 * spin_lock_irqsave(host lock)
2026 */
2027static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2028{
2029 const int sat_model_serial_desc_len = 68;
2030 int num;
2031
2032 rbuf[1] = 0x83; /* this page code */
2033 num = 4;
2034
2035 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2036 rbuf[num + 0] = 2;
2037 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2038 num += 4;
2039 ata_id_string(args->id, (unsigned char *) rbuf + num,
2040 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2041 num += ATA_ID_SERNO_LEN;
2042
2043 /* SAT defined lu model and serial numbers descriptor */
2044 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2045 rbuf[num + 0] = 2;
2046 rbuf[num + 1] = 1;
2047 rbuf[num + 3] = sat_model_serial_desc_len;
2048 num += 4;
2049 memcpy(rbuf + num, "ATA ", 8);
2050 num += 8;
2051 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2052 ATA_ID_PROD_LEN);
2053 num += ATA_ID_PROD_LEN;
2054 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2055 ATA_ID_SERNO_LEN);
2056 num += ATA_ID_SERNO_LEN;
2057
2058 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2059 return 0;
2060}
2061
2062/**
2063 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2064 * @args: device IDENTIFY data / SCSI command of interest.
2065 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2066 *
2067 * Yields SAT-specified ATA VPD page.
2068 *
2069 * LOCKING:
2070 * spin_lock_irqsave(host lock)
2071 */
2072static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2073{
2074 struct ata_taskfile tf;
2075
2076 memset(&tf, 0, sizeof(tf));
2077
2078 rbuf[1] = 0x89; /* our page code */
2079 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2080 rbuf[3] = (0x238 & 0xff);
2081
2082 memcpy(&rbuf[8], "linux ", 8);
2083 memcpy(&rbuf[16], "libata ", 16);
2084 memcpy(&rbuf[32], DRV_VERSION, 4);
2085 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2086
2087 /* we don't store the ATA device signature, so we fake it */
2088
2089 tf.command = ATA_DRDY; /* really, this is Status reg */
2090 tf.lbal = 0x1;
2091 tf.nsect = 0x1;
2092
2093 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2094 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2095
2096 rbuf[56] = ATA_CMD_ID_ATA;
2097
2098 memcpy(&rbuf[60], &args->id[0], 512);
2099 return 0;
2100}
2101
2102static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2103{
2104 rbuf[1] = 0xb1;
2105 rbuf[3] = 0x3c;
2106 if (ata_id_major_version(args->id) > 7) {
2107 rbuf[4] = args->id[217] >> 8;
2108 rbuf[5] = args->id[217];
2109 rbuf[7] = args->id[168] & 0xf;
2110 }
2111
2112 return 0;
2113}
2114
2115/**
2116 * ata_scsiop_noop - Command handler that simply returns success.
2117 * @args: device IDENTIFY data / SCSI command of interest.
2118 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2119 *
2120 * No operation. Simply returns success to caller, to indicate
2121 * that the caller should successfully complete this SCSI command.
2122 *
2123 * LOCKING:
2124 * spin_lock_irqsave(host lock)
2125 */
2126static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2127{
2128 VPRINTK("ENTER\n");
2129 return 0;
2130}
2131
2132/**
2133 * ata_msense_caching - Simulate MODE SENSE caching info page
2134 * @id: device IDENTIFY data
2135 * @buf: output buffer
2136 *
2137 * Generate a caching info page, which conditionally indicates
2138 * write caching to the SCSI layer, depending on device
2139 * capabilities.
2140 *
2141 * LOCKING:
2142 * None.
2143 */
2144static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2145{
2146 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2147 if (ata_id_wcache_enabled(id))
2148 buf[2] |= (1 << 2); /* write cache enable */
2149 if (!ata_id_rahead_enabled(id))
2150 buf[12] |= (1 << 5); /* disable read ahead */
2151 return sizeof(def_cache_mpage);
2152}
2153
2154/**
2155 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2156 * @buf: output buffer
2157 *
2158 * Generate a generic MODE SENSE control mode page.
2159 *
2160 * LOCKING:
2161 * None.
2162 */
2163static unsigned int ata_msense_ctl_mode(u8 *buf)
2164{
2165 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2166 return sizeof(def_control_mpage);
2167}
2168
2169/**
2170 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2171 * @buf: output buffer
2172 *
2173 * Generate a generic MODE SENSE r/w error recovery page.
2174 *
2175 * LOCKING:
2176 * None.
2177 */
2178static unsigned int ata_msense_rw_recovery(u8 *buf)
2179{
2180 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2181 return sizeof(def_rw_recovery_mpage);
2182}
2183
2184/*
2185 * We can turn this into a real blacklist if it's needed, for now just
2186 * blacklist any Maxtor BANC1G10 revision firmware
2187 */
2188static int ata_dev_supports_fua(u16 *id)
2189{
2190 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2191
2192 if (!libata_fua)
2193 return 0;
2194 if (!ata_id_has_fua(id))
2195 return 0;
2196
2197 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2198 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2199
2200 if (strcmp(model, "Maxtor"))
2201 return 1;
2202 if (strcmp(fw, "BANC1G10"))
2203 return 1;
2204
2205 return 0; /* blacklisted */
2206}
2207
2208/**
2209 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2210 * @args: device IDENTIFY data / SCSI command of interest.
2211 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2212 *
2213 * Simulate MODE SENSE commands. Assume this is invoked for direct
2214 * access devices (e.g. disks) only. There should be no block
2215 * descriptor for other device types.
2216 *
2217 * LOCKING:
2218 * spin_lock_irqsave(host lock)
2219 */
2220static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2221{
2222 struct ata_device *dev = args->dev;
2223 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2224 const u8 sat_blk_desc[] = {
2225 0, 0, 0, 0, /* number of blocks: sat unspecified */
2226 0,
2227 0, 0x2, 0x0 /* block length: 512 bytes */
2228 };
2229 u8 pg, spg;
2230 unsigned int ebd, page_control, six_byte;
2231 u8 dpofua;
2232
2233 VPRINTK("ENTER\n");
2234
2235 six_byte = (scsicmd[0] == MODE_SENSE);
2236 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2237 /*
2238 * LLBA bit in msense(10) ignored (compliant)
2239 */
2240
2241 page_control = scsicmd[2] >> 6;
2242 switch (page_control) {
2243 case 0: /* current */
2244 break; /* supported */
2245 case 3: /* saved */
2246 goto saving_not_supp;
2247 case 1: /* changeable */
2248 case 2: /* defaults */
2249 default:
2250 goto invalid_fld;
2251 }
2252
2253 if (six_byte)
2254 p += 4 + (ebd ? 8 : 0);
2255 else
2256 p += 8 + (ebd ? 8 : 0);
2257
2258 pg = scsicmd[2] & 0x3f;
2259 spg = scsicmd[3];
2260 /*
2261 * No mode subpages supported (yet) but asking for _all_
2262 * subpages may be valid
2263 */
2264 if (spg && (spg != ALL_SUB_MPAGES))
2265 goto invalid_fld;
2266
2267 switch(pg) {
2268 case RW_RECOVERY_MPAGE:
2269 p += ata_msense_rw_recovery(p);
2270 break;
2271
2272 case CACHE_MPAGE:
2273 p += ata_msense_caching(args->id, p);
2274 break;
2275
2276 case CONTROL_MPAGE:
2277 p += ata_msense_ctl_mode(p);
2278 break;
2279
2280 case ALL_MPAGES:
2281 p += ata_msense_rw_recovery(p);
2282 p += ata_msense_caching(args->id, p);
2283 p += ata_msense_ctl_mode(p);
2284 break;
2285
2286 default: /* invalid page code */
2287 goto invalid_fld;
2288 }
2289
2290 dpofua = 0;
2291 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2292 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2293 dpofua = 1 << 4;
2294
2295 if (six_byte) {
2296 rbuf[0] = p - rbuf - 1;
2297 rbuf[2] |= dpofua;
2298 if (ebd) {
2299 rbuf[3] = sizeof(sat_blk_desc);
2300 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2301 }
2302 } else {
2303 unsigned int output_len = p - rbuf - 2;
2304
2305 rbuf[0] = output_len >> 8;
2306 rbuf[1] = output_len;
2307 rbuf[3] |= dpofua;
2308 if (ebd) {
2309 rbuf[7] = sizeof(sat_blk_desc);
2310 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2311 }
2312 }
2313 return 0;
2314
2315invalid_fld:
2316 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2317 /* "Invalid field in cbd" */
2318 return 1;
2319
2320saving_not_supp:
2321 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2322 /* "Saving parameters not supported" */
2323 return 1;
2324}
2325
2326/**
2327 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2328 * @args: device IDENTIFY data / SCSI command of interest.
2329 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2330 *
2331 * Simulate READ CAPACITY commands.
2332 *
2333 * LOCKING:
2334 * None.
2335 */
2336static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2337{
2338 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2339
2340 VPRINTK("ENTER\n");
2341
2342 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2343 if (last_lba >= 0xffffffffULL)
2344 last_lba = 0xffffffff;
2345
2346 /* sector count, 32-bit */
2347 rbuf[0] = last_lba >> (8 * 3);
2348 rbuf[1] = last_lba >> (8 * 2);
2349 rbuf[2] = last_lba >> (8 * 1);
2350 rbuf[3] = last_lba;
2351
2352 /* sector size */
2353 rbuf[6] = ATA_SECT_SIZE >> 8;
2354 rbuf[7] = ATA_SECT_SIZE & 0xff;
2355 } else {
2356 /* sector count, 64-bit */
2357 rbuf[0] = last_lba >> (8 * 7);
2358 rbuf[1] = last_lba >> (8 * 6);
2359 rbuf[2] = last_lba >> (8 * 5);
2360 rbuf[3] = last_lba >> (8 * 4);
2361 rbuf[4] = last_lba >> (8 * 3);
2362 rbuf[5] = last_lba >> (8 * 2);
2363 rbuf[6] = last_lba >> (8 * 1);
2364 rbuf[7] = last_lba;
2365
2366 /* sector size */
2367 rbuf[10] = ATA_SECT_SIZE >> 8;
2368 rbuf[11] = ATA_SECT_SIZE & 0xff;
2369 }
2370
2371 return 0;
2372}
2373
2374/**
2375 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2376 * @args: device IDENTIFY data / SCSI command of interest.
2377 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2378 *
2379 * Simulate REPORT LUNS command.
2380 *
2381 * LOCKING:
2382 * spin_lock_irqsave(host lock)
2383 */
2384static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2385{
2386 VPRINTK("ENTER\n");
2387 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2388
2389 return 0;
2390}
2391
2392static void atapi_sense_complete(struct ata_queued_cmd *qc)
2393{
2394 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2395 /* FIXME: not quite right; we don't want the
2396 * translation of taskfile registers into
2397 * a sense descriptors, since that's only
2398 * correct for ATA, not ATAPI
2399 */
2400 ata_gen_passthru_sense(qc);
2401 }
2402
2403 qc->scsidone(qc->scsicmd);
2404 ata_qc_free(qc);
2405}
2406
2407/* is it pointless to prefer PIO for "safety reasons"? */
2408static inline int ata_pio_use_silly(struct ata_port *ap)
2409{
2410 return (ap->flags & ATA_FLAG_PIO_DMA);
2411}
2412
2413static void atapi_request_sense(struct ata_queued_cmd *qc)
2414{
2415 struct ata_port *ap = qc->ap;
2416 struct scsi_cmnd *cmd = qc->scsicmd;
2417
2418 DPRINTK("ATAPI request sense\n");
2419
2420 /* FIXME: is this needed? */
2421 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2422
2423#ifdef CONFIG_ATA_SFF
2424 if (ap->ops->sff_tf_read)
2425 ap->ops->sff_tf_read(ap, &qc->tf);
2426#endif
2427
2428 /* fill these in, for the case where they are -not- overwritten */
2429 cmd->sense_buffer[0] = 0x70;
2430 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2431
2432 ata_qc_reinit(qc);
2433
2434 /* setup sg table and init transfer direction */
2435 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2436 ata_sg_init(qc, &qc->sgent, 1);
2437 qc->dma_dir = DMA_FROM_DEVICE;
2438
2439 memset(&qc->cdb, 0, qc->dev->cdb_len);
2440 qc->cdb[0] = REQUEST_SENSE;
2441 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2442
2443 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2444 qc->tf.command = ATA_CMD_PACKET;
2445
2446 if (ata_pio_use_silly(ap)) {
2447 qc->tf.protocol = ATAPI_PROT_DMA;
2448 qc->tf.feature |= ATAPI_PKT_DMA;
2449 } else {
2450 qc->tf.protocol = ATAPI_PROT_PIO;
2451 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2452 qc->tf.lbah = 0;
2453 }
2454 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2455
2456 qc->complete_fn = atapi_sense_complete;
2457
2458 ata_qc_issue(qc);
2459
2460 DPRINTK("EXIT\n");
2461}
2462
2463static void atapi_qc_complete(struct ata_queued_cmd *qc)
2464{
2465 struct scsi_cmnd *cmd = qc->scsicmd;
2466 unsigned int err_mask = qc->err_mask;
2467
2468 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2469
2470 /* handle completion from new EH */
2471 if (unlikely(qc->ap->ops->error_handler &&
2472 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2473
2474 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2475 /* FIXME: not quite right; we don't want the
2476 * translation of taskfile registers into a
2477 * sense descriptors, since that's only
2478 * correct for ATA, not ATAPI
2479 */
2480 ata_gen_passthru_sense(qc);
2481 }
2482
2483 /* SCSI EH automatically locks door if sdev->locked is
2484 * set. Sometimes door lock request continues to
2485 * fail, for example, when no media is present. This
2486 * creates a loop - SCSI EH issues door lock which
2487 * fails and gets invoked again to acquire sense data
2488 * for the failed command.
2489 *
2490 * If door lock fails, always clear sdev->locked to
2491 * avoid this infinite loop.
2492 */
2493 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2494 qc->dev->sdev->locked = 0;
2495
2496 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2497 qc->scsidone(cmd);
2498 ata_qc_free(qc);
2499 return;
2500 }
2501
2502 /* successful completion or old EH failure path */
2503 if (unlikely(err_mask & AC_ERR_DEV)) {
2504 cmd->result = SAM_STAT_CHECK_CONDITION;
2505 atapi_request_sense(qc);
2506 return;
2507 } else if (unlikely(err_mask)) {
2508 /* FIXME: not quite right; we don't want the
2509 * translation of taskfile registers into
2510 * a sense descriptors, since that's only
2511 * correct for ATA, not ATAPI
2512 */
2513 ata_gen_passthru_sense(qc);
2514 } else {
2515 u8 *scsicmd = cmd->cmnd;
2516
2517 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2518 unsigned long flags;
2519 u8 *buf;
2520
2521 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2522
2523 /* ATAPI devices typically report zero for their SCSI version,
2524 * and sometimes deviate from the spec WRT response data
2525 * format. If SCSI version is reported as zero like normal,
2526 * then we make the following fixups: 1) Fake MMC-5 version,
2527 * to indicate to the Linux scsi midlayer this is a modern
2528 * device. 2) Ensure response data format / ATAPI information
2529 * are always correct.
2530 */
2531 if (buf[2] == 0) {
2532 buf[2] = 0x5;
2533 buf[3] = 0x32;
2534 }
2535
2536 ata_scsi_rbuf_put(cmd, true, &flags);
2537 }
2538
2539 cmd->result = SAM_STAT_GOOD;
2540 }
2541
2542 qc->scsidone(cmd);
2543 ata_qc_free(qc);
2544}
2545/**
2546 * atapi_xlat - Initialize PACKET taskfile
2547 * @qc: command structure to be initialized
2548 *
2549 * LOCKING:
2550 * spin_lock_irqsave(host lock)
2551 *
2552 * RETURNS:
2553 * Zero on success, non-zero on failure.
2554 */
2555static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2556{
2557 struct scsi_cmnd *scmd = qc->scsicmd;
2558 struct ata_device *dev = qc->dev;
2559 int nodata = (scmd->sc_data_direction == DMA_NONE);
2560 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2561 unsigned int nbytes;
2562
2563 memset(qc->cdb, 0, dev->cdb_len);
2564 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2565
2566 qc->complete_fn = atapi_qc_complete;
2567
2568 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2569 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2570 qc->tf.flags |= ATA_TFLAG_WRITE;
2571 DPRINTK("direction: write\n");
2572 }
2573
2574 qc->tf.command = ATA_CMD_PACKET;
2575 ata_qc_set_pc_nbytes(qc);
2576
2577 /* check whether ATAPI DMA is safe */
2578 if (!nodata && !using_pio && atapi_check_dma(qc))
2579 using_pio = 1;
2580
2581 /* Some controller variants snoop this value for Packet
2582 * transfers to do state machine and FIFO management. Thus we
2583 * want to set it properly, and for DMA where it is
2584 * effectively meaningless.
2585 */
2586 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2587
2588 /* Most ATAPI devices which honor transfer chunk size don't
2589 * behave according to the spec when odd chunk size which
2590 * matches the transfer length is specified. If the number of
2591 * bytes to transfer is 2n+1. According to the spec, what
2592 * should happen is to indicate that 2n+1 is going to be
2593 * transferred and transfer 2n+2 bytes where the last byte is
2594 * padding.
2595 *
2596 * In practice, this doesn't happen. ATAPI devices first
2597 * indicate and transfer 2n bytes and then indicate and
2598 * transfer 2 bytes where the last byte is padding.
2599 *
2600 * This inconsistency confuses several controllers which
2601 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2602 * These controllers use actual number of transferred bytes to
2603 * update DMA poitner and transfer of 4n+2 bytes make those
2604 * controller push DMA pointer by 4n+4 bytes because SATA data
2605 * FISes are aligned to 4 bytes. This causes data corruption
2606 * and buffer overrun.
2607 *
2608 * Always setting nbytes to even number solves this problem
2609 * because then ATAPI devices don't have to split data at 2n
2610 * boundaries.
2611 */
2612 if (nbytes & 0x1)
2613 nbytes++;
2614
2615 qc->tf.lbam = (nbytes & 0xFF);
2616 qc->tf.lbah = (nbytes >> 8);
2617
2618 if (nodata)
2619 qc->tf.protocol = ATAPI_PROT_NODATA;
2620 else if (using_pio)
2621 qc->tf.protocol = ATAPI_PROT_PIO;
2622 else {
2623 /* DMA data xfer */
2624 qc->tf.protocol = ATAPI_PROT_DMA;
2625 qc->tf.feature |= ATAPI_PKT_DMA;
2626
2627 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2628 (scmd->sc_data_direction != DMA_TO_DEVICE))
2629 /* some SATA bridges need us to indicate data xfer direction */
2630 qc->tf.feature |= ATAPI_DMADIR;
2631 }
2632
2633
2634 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2635 as ATAPI tape drives don't get this right otherwise */
2636 return 0;
2637}
2638
2639static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2640{
2641 if (!sata_pmp_attached(ap)) {
2642 if (likely(devno < ata_link_max_devices(&ap->link)))
2643 return &ap->link.device[devno];
2644 } else {
2645 if (likely(devno < ap->nr_pmp_links))
2646 return &ap->pmp_link[devno].device[0];
2647 }
2648
2649 return NULL;
2650}
2651
2652static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2653 const struct scsi_device *scsidev)
2654{
2655 int devno;
2656
2657 /* skip commands not addressed to targets we simulate */
2658 if (!sata_pmp_attached(ap)) {
2659 if (unlikely(scsidev->channel || scsidev->lun))
2660 return NULL;
2661 devno = scsidev->id;
2662 } else {
2663 if (unlikely(scsidev->id || scsidev->lun))
2664 return NULL;
2665 devno = scsidev->channel;
2666 }
2667
2668 return ata_find_dev(ap, devno);
2669}
2670
2671/**
2672 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2673 * @ap: ATA port to which the device is attached
2674 * @scsidev: SCSI device from which we derive the ATA device
2675 *
2676 * Given various information provided in struct scsi_cmnd,
2677 * map that onto an ATA bus, and using that mapping
2678 * determine which ata_device is associated with the
2679 * SCSI command to be sent.
2680 *
2681 * LOCKING:
2682 * spin_lock_irqsave(host lock)
2683 *
2684 * RETURNS:
2685 * Associated ATA device, or %NULL if not found.
2686 */
2687static struct ata_device *
2688ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2689{
2690 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2691
2692 if (unlikely(!dev || !ata_dev_enabled(dev)))
2693 return NULL;
2694
2695 return dev;
2696}
2697
2698/*
2699 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2700 * @byte1: Byte 1 from pass-thru CDB.
2701 *
2702 * RETURNS:
2703 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2704 */
2705static u8
2706ata_scsi_map_proto(u8 byte1)
2707{
2708 switch((byte1 & 0x1e) >> 1) {
2709 case 3: /* Non-data */
2710 return ATA_PROT_NODATA;
2711
2712 case 6: /* DMA */
2713 case 10: /* UDMA Data-in */
2714 case 11: /* UDMA Data-Out */
2715 return ATA_PROT_DMA;
2716
2717 case 4: /* PIO Data-in */
2718 case 5: /* PIO Data-out */
2719 return ATA_PROT_PIO;
2720
2721 case 0: /* Hard Reset */
2722 case 1: /* SRST */
2723 case 8: /* Device Diagnostic */
2724 case 9: /* Device Reset */
2725 case 7: /* DMA Queued */
2726 case 12: /* FPDMA */
2727 case 15: /* Return Response Info */
2728 default: /* Reserved */
2729 break;
2730 }
2731
2732 return ATA_PROT_UNKNOWN;
2733}
2734
2735/**
2736 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2737 * @qc: command structure to be initialized
2738 *
2739 * Handles either 12 or 16-byte versions of the CDB.
2740 *
2741 * RETURNS:
2742 * Zero on success, non-zero on failure.
2743 */
2744static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2745{
2746 struct ata_taskfile *tf = &(qc->tf);
2747 struct scsi_cmnd *scmd = qc->scsicmd;
2748 struct ata_device *dev = qc->dev;
2749 const u8 *cdb = scmd->cmnd;
2750
2751 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2752 goto invalid_fld;
2753
2754 /*
2755 * Filter TPM commands by default. These provide an
2756 * essentially uncontrolled encrypted "back door" between
2757 * applications and the disk. Set libata.allow_tpm=1 if you
2758 * have a real reason for wanting to use them. This ensures
2759 * that installed software cannot easily mess stuff up without
2760 * user intent. DVR type users will probably ship with this enabled
2761 * for movie content management.
2762 *
2763 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2764 * for this and should do in future but that it is not sufficient as
2765 * DCS is an optional feature set. Thus we also do the software filter
2766 * so that we comply with the TC consortium stated goal that the user
2767 * can turn off TC features of their system.
2768 */
2769 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2770 goto invalid_fld;
2771
2772 /* We may not issue DMA commands if no DMA mode is set */
2773 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2774 goto invalid_fld;
2775
2776 /*
2777 * 12 and 16 byte CDBs use different offsets to
2778 * provide the various register values.
2779 */
2780 if (cdb[0] == ATA_16) {
2781 /*
2782 * 16-byte CDB - may contain extended commands.
2783 *
2784 * If that is the case, copy the upper byte register values.
2785 */
2786 if (cdb[1] & 0x01) {
2787 tf->hob_feature = cdb[3];
2788 tf->hob_nsect = cdb[5];
2789 tf->hob_lbal = cdb[7];
2790 tf->hob_lbam = cdb[9];
2791 tf->hob_lbah = cdb[11];
2792 tf->flags |= ATA_TFLAG_LBA48;
2793 } else
2794 tf->flags &= ~ATA_TFLAG_LBA48;
2795
2796 /*
2797 * Always copy low byte, device and command registers.
2798 */
2799 tf->feature = cdb[4];
2800 tf->nsect = cdb[6];
2801 tf->lbal = cdb[8];
2802 tf->lbam = cdb[10];
2803 tf->lbah = cdb[12];
2804 tf->device = cdb[13];
2805 tf->command = cdb[14];
2806 } else {
2807 /*
2808 * 12-byte CDB - incapable of extended commands.
2809 */
2810 tf->flags &= ~ATA_TFLAG_LBA48;
2811
2812 tf->feature = cdb[3];
2813 tf->nsect = cdb[4];
2814 tf->lbal = cdb[5];
2815 tf->lbam = cdb[6];
2816 tf->lbah = cdb[7];
2817 tf->device = cdb[8];
2818 tf->command = cdb[9];
2819 }
2820
2821 /* enforce correct master/slave bit */
2822 tf->device = dev->devno ?
2823 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2824
2825 /* sanity check for pio multi commands */
2826 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2827 goto invalid_fld;
2828
2829 if (is_multi_taskfile(tf)) {
2830 unsigned int multi_count = 1 << (cdb[1] >> 5);
2831
2832 /* compare the passed through multi_count
2833 * with the cached multi_count of libata
2834 */
2835 if (multi_count != dev->multi_count)
2836 ata_dev_printk(dev, KERN_WARNING,
2837 "invalid multi_count %u ignored\n",
2838 multi_count);
2839 }
2840
2841 /* READ/WRITE LONG use a non-standard sect_size */
2842 qc->sect_size = ATA_SECT_SIZE;
2843 switch (tf->command) {
2844 case ATA_CMD_READ_LONG:
2845 case ATA_CMD_READ_LONG_ONCE:
2846 case ATA_CMD_WRITE_LONG:
2847 case ATA_CMD_WRITE_LONG_ONCE:
2848 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2849 goto invalid_fld;
2850 qc->sect_size = scsi_bufflen(scmd);
2851 }
2852
2853 /*
2854 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2855 * SET_FEATURES - XFER MODE must be preceded/succeeded
2856 * by an update to hardware-specific registers for each
2857 * controller (i.e. the reason for ->set_piomode(),
2858 * ->set_dmamode(), and ->post_set_mode() hooks).
2859 */
2860 if ((tf->command == ATA_CMD_SET_FEATURES)
2861 && (tf->feature == SETFEATURES_XFER))
2862 goto invalid_fld;
2863
2864 /*
2865 * Set flags so that all registers will be written,
2866 * and pass on write indication (used for PIO/DMA
2867 * setup.)
2868 */
2869 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2870
2871 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2872 tf->flags |= ATA_TFLAG_WRITE;
2873
2874 /*
2875 * Set transfer length.
2876 *
2877 * TODO: find out if we need to do more here to
2878 * cover scatter/gather case.
2879 */
2880 ata_qc_set_pc_nbytes(qc);
2881
2882 /* request result TF and be quiet about device error */
2883 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2884
2885 return 0;
2886
2887 invalid_fld:
2888 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2889 /* "Invalid field in cdb" */
2890 return 1;
2891}
2892
2893/**
2894 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2895 * @dev: ATA device
2896 * @cmd: SCSI command opcode to consider
2897 *
2898 * Look up the SCSI command given, and determine whether the
2899 * SCSI command is to be translated or simulated.
2900 *
2901 * RETURNS:
2902 * Pointer to translation function if possible, %NULL if not.
2903 */
2904
2905static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2906{
2907 switch (cmd) {
2908 case READ_6:
2909 case READ_10:
2910 case READ_16:
2911
2912 case WRITE_6:
2913 case WRITE_10:
2914 case WRITE_16:
2915 return ata_scsi_rw_xlat;
2916
2917 case SYNCHRONIZE_CACHE:
2918 if (ata_try_flush_cache(dev))
2919 return ata_scsi_flush_xlat;
2920 break;
2921
2922 case VERIFY:
2923 case VERIFY_16:
2924 return ata_scsi_verify_xlat;
2925
2926 case ATA_12:
2927 case ATA_16:
2928 return ata_scsi_pass_thru;
2929
2930 case START_STOP:
2931 return ata_scsi_start_stop_xlat;
2932 }
2933
2934 return NULL;
2935}
2936
2937/**
2938 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2939 * @ap: ATA port to which the command was being sent
2940 * @cmd: SCSI command to dump
2941 *
2942 * Prints the contents of a SCSI command via printk().
2943 */
2944
2945static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2946 struct scsi_cmnd *cmd)
2947{
2948#ifdef ATA_DEBUG
2949 struct scsi_device *scsidev = cmd->device;
2950 u8 *scsicmd = cmd->cmnd;
2951
2952 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2953 ap->print_id,
2954 scsidev->channel, scsidev->id, scsidev->lun,
2955 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2956 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2957 scsicmd[8]);
2958#endif
2959}
2960
2961static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2962 void (*done)(struct scsi_cmnd *),
2963 struct ata_device *dev)
2964{
2965 u8 scsi_op = scmd->cmnd[0];
2966 ata_xlat_func_t xlat_func;
2967 int rc = 0;
2968
2969 if (dev->class == ATA_DEV_ATA) {
2970 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
2971 goto bad_cdb_len;
2972
2973 xlat_func = ata_get_xlat_func(dev, scsi_op);
2974 } else {
2975 if (unlikely(!scmd->cmd_len))
2976 goto bad_cdb_len;
2977
2978 xlat_func = NULL;
2979 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
2980 /* relay SCSI command to ATAPI device */
2981 int len = COMMAND_SIZE(scsi_op);
2982 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
2983 goto bad_cdb_len;
2984
2985 xlat_func = atapi_xlat;
2986 } else {
2987 /* ATA_16 passthru, treat as an ATA command */
2988 if (unlikely(scmd->cmd_len > 16))
2989 goto bad_cdb_len;
2990
2991 xlat_func = ata_get_xlat_func(dev, scsi_op);
2992 }
2993 }
2994
2995 if (xlat_func)
2996 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2997 else
2998 ata_scsi_simulate(dev, scmd, done);
2999
3000 return rc;
3001
3002 bad_cdb_len:
3003 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3004 scmd->cmd_len, scsi_op, dev->cdb_len);
3005 scmd->result = DID_ERROR << 16;
3006 done(scmd);
3007 return 0;
3008}
3009
3010/**
3011 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3012 * @cmd: SCSI command to be sent
3013 * @done: Completion function, called when command is complete
3014 *
3015 * In some cases, this function translates SCSI commands into
3016 * ATA taskfiles, and queues the taskfiles to be sent to
3017 * hardware. In other cases, this function simulates a
3018 * SCSI device by evaluating and responding to certain
3019 * SCSI commands. This creates the overall effect of
3020 * ATA and ATAPI devices appearing as SCSI devices.
3021 *
3022 * LOCKING:
3023 * Releases scsi-layer-held lock, and obtains host lock.
3024 *
3025 * RETURNS:
3026 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3027 * 0 otherwise.
3028 */
3029int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3030{
3031 struct ata_port *ap;
3032 struct ata_device *dev;
3033 struct scsi_device *scsidev = cmd->device;
3034 struct Scsi_Host *shost = scsidev->host;
3035 int rc = 0;
3036
3037 ap = ata_shost_to_port(shost);
3038
3039 spin_unlock(shost->host_lock);
3040 spin_lock(ap->lock);
3041
3042 ata_scsi_dump_cdb(ap, cmd);
3043
3044 dev = ata_scsi_find_dev(ap, scsidev);
3045 if (likely(dev))
3046 rc = __ata_scsi_queuecmd(cmd, done, dev);
3047 else {
3048 cmd->result = (DID_BAD_TARGET << 16);
3049 done(cmd);
3050 }
3051
3052 spin_unlock(ap->lock);
3053 spin_lock(shost->host_lock);
3054 return rc;
3055}
3056
3057/**
3058 * ata_scsi_simulate - simulate SCSI command on ATA device
3059 * @dev: the target device
3060 * @cmd: SCSI command being sent to device.
3061 * @done: SCSI command completion function.
3062 *
3063 * Interprets and directly executes a select list of SCSI commands
3064 * that can be handled internally.
3065 *
3066 * LOCKING:
3067 * spin_lock_irqsave(host lock)
3068 */
3069
3070void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3071 void (*done)(struct scsi_cmnd *))
3072{
3073 struct ata_scsi_args args;
3074 const u8 *scsicmd = cmd->cmnd;
3075 u8 tmp8;
3076
3077 args.dev = dev;
3078 args.id = dev->id;
3079 args.cmd = cmd;
3080 args.done = done;
3081
3082 switch(scsicmd[0]) {
3083 /* TODO: worth improving? */
3084 case FORMAT_UNIT:
3085 ata_scsi_invalid_field(cmd, done);
3086 break;
3087
3088 case INQUIRY:
3089 if (scsicmd[1] & 2) /* is CmdDt set? */
3090 ata_scsi_invalid_field(cmd, done);
3091 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3092 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3093 else switch (scsicmd[2]) {
3094 case 0x00:
3095 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3096 break;
3097 case 0x80:
3098 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3099 break;
3100 case 0x83:
3101 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3102 break;
3103 case 0x89:
3104 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3105 break;
3106 case 0xb1:
3107 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3108 break;
3109 default:
3110 ata_scsi_invalid_field(cmd, done);
3111 break;
3112 }
3113 break;
3114
3115 case MODE_SENSE:
3116 case MODE_SENSE_10:
3117 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3118 break;
3119
3120 case MODE_SELECT: /* unconditionally return */
3121 case MODE_SELECT_10: /* bad-field-in-cdb */
3122 ata_scsi_invalid_field(cmd, done);
3123 break;
3124
3125 case READ_CAPACITY:
3126 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3127 break;
3128
3129 case SERVICE_ACTION_IN:
3130 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3131 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3132 else
3133 ata_scsi_invalid_field(cmd, done);
3134 break;
3135
3136 case REPORT_LUNS:
3137 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3138 break;
3139
3140 case REQUEST_SENSE:
3141 ata_scsi_set_sense(cmd, 0, 0, 0);
3142 cmd->result = (DRIVER_SENSE << 24);
3143 done(cmd);
3144 break;
3145
3146 /* if we reach this, then writeback caching is disabled,
3147 * turning this into a no-op.
3148 */
3149 case SYNCHRONIZE_CACHE:
3150 /* fall through */
3151
3152 /* no-op's, complete with success */
3153 case REZERO_UNIT:
3154 case SEEK_6:
3155 case SEEK_10:
3156 case TEST_UNIT_READY:
3157 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3158 break;
3159
3160 case SEND_DIAGNOSTIC:
3161 tmp8 = scsicmd[1] & ~(1 << 3);
3162 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3163 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3164 else
3165 ata_scsi_invalid_field(cmd, done);
3166 break;
3167
3168 /* all other commands */
3169 default:
3170 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3171 /* "Invalid command operation code" */
3172 done(cmd);
3173 break;
3174 }
3175}
3176
3177int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3178{
3179 int i, rc;
3180
3181 for (i = 0; i < host->n_ports; i++) {
3182 struct ata_port *ap = host->ports[i];
3183 struct Scsi_Host *shost;
3184
3185 rc = -ENOMEM;
3186 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3187 if (!shost)
3188 goto err_alloc;
3189
3190 *(struct ata_port **)&shost->hostdata[0] = ap;
3191 ap->scsi_host = shost;
3192
3193 shost->transportt = &ata_scsi_transport_template;
3194 shost->unique_id = ap->print_id;
3195 shost->max_id = 16;
3196 shost->max_lun = 1;
3197 shost->max_channel = 1;
3198 shost->max_cmd_len = 16;
3199
3200 /* Schedule policy is determined by ->qc_defer()
3201 * callback and it needs to see every deferred qc.
3202 * Set host_blocked to 1 to prevent SCSI midlayer from
3203 * automatically deferring requests.
3204 */
3205 shost->max_host_blocked = 1;
3206
3207 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3208 if (rc)
3209 goto err_add;
3210 }
3211
3212 return 0;
3213
3214 err_add:
3215 scsi_host_put(host->ports[i]->scsi_host);
3216 err_alloc:
3217 while (--i >= 0) {
3218 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3219
3220 scsi_remove_host(shost);
3221 scsi_host_put(shost);
3222 }
3223 return rc;
3224}
3225
3226void ata_scsi_scan_host(struct ata_port *ap, int sync)
3227{
3228 int tries = 5;
3229 struct ata_device *last_failed_dev = NULL;
3230 struct ata_link *link;
3231 struct ata_device *dev;
3232
3233 if (ap->flags & ATA_FLAG_DISABLED)
3234 return;
3235
3236 repeat:
3237 ata_port_for_each_link(link, ap) {
3238 ata_link_for_each_dev(dev, link) {
3239 struct scsi_device *sdev;
3240 int channel = 0, id = 0;
3241
3242 if (!ata_dev_enabled(dev) || dev->sdev)
3243 continue;
3244
3245 if (ata_is_host_link(link))
3246 id = dev->devno;
3247 else
3248 channel = link->pmp;
3249
3250 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3251 NULL);
3252 if (!IS_ERR(sdev)) {
3253 dev->sdev = sdev;
3254 scsi_device_put(sdev);
3255 }
3256 }
3257 }
3258
3259 /* If we scanned while EH was in progress or allocation
3260 * failure occurred, scan would have failed silently. Check
3261 * whether all devices are attached.
3262 */
3263 ata_port_for_each_link(link, ap) {
3264 ata_link_for_each_dev(dev, link) {
3265 if (ata_dev_enabled(dev) && !dev->sdev)
3266 goto exit_loop;
3267 }
3268 }
3269 exit_loop:
3270 if (!link)
3271 return;
3272
3273 /* we're missing some SCSI devices */
3274 if (sync) {
3275 /* If caller requested synchrnous scan && we've made
3276 * any progress, sleep briefly and repeat.
3277 */
3278 if (dev != last_failed_dev) {
3279 msleep(100);
3280 last_failed_dev = dev;
3281 goto repeat;
3282 }
3283
3284 /* We might be failing to detect boot device, give it
3285 * a few more chances.
3286 */
3287 if (--tries) {
3288 msleep(100);
3289 goto repeat;
3290 }
3291
3292 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3293 "failed without making any progress,\n"
3294 " switching to async\n");
3295 }
3296
3297 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3298 round_jiffies_relative(HZ));
3299}
3300
3301/**
3302 * ata_scsi_offline_dev - offline attached SCSI device
3303 * @dev: ATA device to offline attached SCSI device for
3304 *
3305 * This function is called from ata_eh_hotplug() and responsible
3306 * for taking the SCSI device attached to @dev offline. This
3307 * function is called with host lock which protects dev->sdev
3308 * against clearing.
3309 *
3310 * LOCKING:
3311 * spin_lock_irqsave(host lock)
3312 *
3313 * RETURNS:
3314 * 1 if attached SCSI device exists, 0 otherwise.
3315 */
3316int ata_scsi_offline_dev(struct ata_device *dev)
3317{
3318 if (dev->sdev) {
3319 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3320 return 1;
3321 }
3322 return 0;
3323}
3324
3325/**
3326 * ata_scsi_remove_dev - remove attached SCSI device
3327 * @dev: ATA device to remove attached SCSI device for
3328 *
3329 * This function is called from ata_eh_scsi_hotplug() and
3330 * responsible for removing the SCSI device attached to @dev.
3331 *
3332 * LOCKING:
3333 * Kernel thread context (may sleep).
3334 */
3335static void ata_scsi_remove_dev(struct ata_device *dev)
3336{
3337 struct ata_port *ap = dev->link->ap;
3338 struct scsi_device *sdev;
3339 unsigned long flags;
3340
3341 /* Alas, we need to grab scan_mutex to ensure SCSI device
3342 * state doesn't change underneath us and thus
3343 * scsi_device_get() always succeeds. The mutex locking can
3344 * be removed if there is __scsi_device_get() interface which
3345 * increments reference counts regardless of device state.
3346 */
3347 mutex_lock(&ap->scsi_host->scan_mutex);
3348 spin_lock_irqsave(ap->lock, flags);
3349
3350 /* clearing dev->sdev is protected by host lock */
3351 sdev = dev->sdev;
3352 dev->sdev = NULL;
3353
3354 if (sdev) {
3355 /* If user initiated unplug races with us, sdev can go
3356 * away underneath us after the host lock and
3357 * scan_mutex are released. Hold onto it.
3358 */
3359 if (scsi_device_get(sdev) == 0) {
3360 /* The following ensures the attached sdev is
3361 * offline on return from ata_scsi_offline_dev()
3362 * regardless it wins or loses the race
3363 * against this function.
3364 */
3365 scsi_device_set_state(sdev, SDEV_OFFLINE);
3366 } else {
3367 WARN_ON(1);
3368 sdev = NULL;
3369 }
3370 }
3371
3372 spin_unlock_irqrestore(ap->lock, flags);
3373 mutex_unlock(&ap->scsi_host->scan_mutex);
3374
3375 if (sdev) {
3376 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3377 sdev->sdev_gendev.bus_id);
3378
3379 scsi_remove_device(sdev);
3380 scsi_device_put(sdev);
3381 }
3382}
3383
3384static void ata_scsi_handle_link_detach(struct ata_link *link)
3385{
3386 struct ata_port *ap = link->ap;
3387 struct ata_device *dev;
3388
3389 ata_link_for_each_dev(dev, link) {
3390 unsigned long flags;
3391
3392 if (!(dev->flags & ATA_DFLAG_DETACHED))
3393 continue;
3394
3395 spin_lock_irqsave(ap->lock, flags);
3396 dev->flags &= ~ATA_DFLAG_DETACHED;
3397 spin_unlock_irqrestore(ap->lock, flags);
3398
3399 ata_scsi_remove_dev(dev);
3400 }
3401}
3402
3403/**
3404 * ata_scsi_media_change_notify - send media change event
3405 * @dev: Pointer to the disk device with media change event
3406 *
3407 * Tell the block layer to send a media change notification
3408 * event.
3409 *
3410 * LOCKING:
3411 * spin_lock_irqsave(host lock)
3412 */
3413void ata_scsi_media_change_notify(struct ata_device *dev)
3414{
3415 if (dev->sdev)
3416 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3417 GFP_ATOMIC);
3418}
3419
3420/**
3421 * ata_scsi_hotplug - SCSI part of hotplug
3422 * @work: Pointer to ATA port to perform SCSI hotplug on
3423 *
3424 * Perform SCSI part of hotplug. It's executed from a separate
3425 * workqueue after EH completes. This is necessary because SCSI
3426 * hot plugging requires working EH and hot unplugging is
3427 * synchronized with hot plugging with a mutex.
3428 *
3429 * LOCKING:
3430 * Kernel thread context (may sleep).
3431 */
3432void ata_scsi_hotplug(struct work_struct *work)
3433{
3434 struct ata_port *ap =
3435 container_of(work, struct ata_port, hotplug_task.work);
3436 int i;
3437
3438 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3439 DPRINTK("ENTER/EXIT - unloading\n");
3440 return;
3441 }
3442
3443 DPRINTK("ENTER\n");
3444
3445 /* Unplug detached devices. We cannot use link iterator here
3446 * because PMP links have to be scanned even if PMP is
3447 * currently not attached. Iterate manually.
3448 */
3449 ata_scsi_handle_link_detach(&ap->link);
3450 if (ap->pmp_link)
3451 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3452 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3453
3454 /* scan for new ones */
3455 ata_scsi_scan_host(ap, 0);
3456
3457 DPRINTK("EXIT\n");
3458}
3459
3460/**
3461 * ata_scsi_user_scan - indication for user-initiated bus scan
3462 * @shost: SCSI host to scan
3463 * @channel: Channel to scan
3464 * @id: ID to scan
3465 * @lun: LUN to scan
3466 *
3467 * This function is called when user explicitly requests bus
3468 * scan. Set probe pending flag and invoke EH.
3469 *
3470 * LOCKING:
3471 * SCSI layer (we don't care)
3472 *
3473 * RETURNS:
3474 * Zero.
3475 */
3476static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3477 unsigned int id, unsigned int lun)
3478{
3479 struct ata_port *ap = ata_shost_to_port(shost);
3480 unsigned long flags;
3481 int devno, rc = 0;
3482
3483 if (!ap->ops->error_handler)
3484 return -EOPNOTSUPP;
3485
3486 if (lun != SCAN_WILD_CARD && lun)
3487 return -EINVAL;
3488
3489 if (!sata_pmp_attached(ap)) {
3490 if (channel != SCAN_WILD_CARD && channel)
3491 return -EINVAL;
3492 devno = id;
3493 } else {
3494 if (id != SCAN_WILD_CARD && id)
3495 return -EINVAL;
3496 devno = channel;
3497 }
3498
3499 spin_lock_irqsave(ap->lock, flags);
3500
3501 if (devno == SCAN_WILD_CARD) {
3502 struct ata_link *link;
3503
3504 ata_port_for_each_link(link, ap) {
3505 struct ata_eh_info *ehi = &link->eh_info;
3506 ehi->probe_mask |= ATA_ALL_DEVICES;
3507 ehi->action |= ATA_EH_RESET;
3508 }
3509 } else {
3510 struct ata_device *dev = ata_find_dev(ap, devno);
3511
3512 if (dev) {
3513 struct ata_eh_info *ehi = &dev->link->eh_info;
3514 ehi->probe_mask |= 1 << dev->devno;
3515 ehi->action |= ATA_EH_RESET;
3516 } else
3517 rc = -EINVAL;
3518 }
3519
3520 if (rc == 0) {
3521 ata_port_schedule_eh(ap);
3522 spin_unlock_irqrestore(ap->lock, flags);
3523 ata_port_wait_eh(ap);
3524 } else
3525 spin_unlock_irqrestore(ap->lock, flags);
3526
3527 return rc;
3528}
3529
3530/**
3531 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3532 * @work: Pointer to ATA port to perform scsi_rescan_device()
3533 *
3534 * After ATA pass thru (SAT) commands are executed successfully,
3535 * libata need to propagate the changes to SCSI layer. This
3536 * function must be executed from ata_aux_wq such that sdev
3537 * attach/detach don't race with rescan.
3538 *
3539 * LOCKING:
3540 * Kernel thread context (may sleep).
3541 */
3542void ata_scsi_dev_rescan(struct work_struct *work)
3543{
3544 struct ata_port *ap =
3545 container_of(work, struct ata_port, scsi_rescan_task);
3546 struct ata_link *link;
3547 struct ata_device *dev;
3548 unsigned long flags;
3549
3550 spin_lock_irqsave(ap->lock, flags);
3551
3552 ata_port_for_each_link(link, ap) {
3553 ata_link_for_each_dev(dev, link) {
3554 struct scsi_device *sdev = dev->sdev;
3555
3556 if (!ata_dev_enabled(dev) || !sdev)
3557 continue;
3558 if (scsi_device_get(sdev))
3559 continue;
3560
3561 spin_unlock_irqrestore(ap->lock, flags);
3562 scsi_rescan_device(&(sdev->sdev_gendev));
3563 scsi_device_put(sdev);
3564 spin_lock_irqsave(ap->lock, flags);
3565 }
3566 }
3567
3568 spin_unlock_irqrestore(ap->lock, flags);
3569}
3570
3571/**
3572 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3573 * @host: ATA host container for all SAS ports
3574 * @port_info: Information from low-level host driver
3575 * @shost: SCSI host that the scsi device is attached to
3576 *
3577 * LOCKING:
3578 * PCI/etc. bus probe sem.
3579 *
3580 * RETURNS:
3581 * ata_port pointer on success / NULL on failure.
3582 */
3583
3584struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3585 struct ata_port_info *port_info,
3586 struct Scsi_Host *shost)
3587{
3588 struct ata_port *ap;
3589
3590 ap = ata_port_alloc(host);
3591 if (!ap)
3592 return NULL;
3593
3594 ap->port_no = 0;
3595 ap->lock = shost->host_lock;
3596 ap->pio_mask = port_info->pio_mask;
3597 ap->mwdma_mask = port_info->mwdma_mask;
3598 ap->udma_mask = port_info->udma_mask;
3599 ap->flags |= port_info->flags;
3600 ap->ops = port_info->port_ops;
3601 ap->cbl = ATA_CBL_SATA;
3602
3603 return ap;
3604}
3605EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3606
3607/**
3608 * ata_sas_port_start - Set port up for dma.
3609 * @ap: Port to initialize
3610 *
3611 * Called just after data structures for each port are
3612 * initialized.
3613 *
3614 * May be used as the port_start() entry in ata_port_operations.
3615 *
3616 * LOCKING:
3617 * Inherited from caller.
3618 */
3619int ata_sas_port_start(struct ata_port *ap)
3620{
3621 return 0;
3622}
3623EXPORT_SYMBOL_GPL(ata_sas_port_start);
3624
3625/**
3626 * ata_port_stop - Undo ata_sas_port_start()
3627 * @ap: Port to shut down
3628 *
3629 * May be used as the port_stop() entry in ata_port_operations.
3630 *
3631 * LOCKING:
3632 * Inherited from caller.
3633 */
3634
3635void ata_sas_port_stop(struct ata_port *ap)
3636{
3637}
3638EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3639
3640/**
3641 * ata_sas_port_init - Initialize a SATA device
3642 * @ap: SATA port to initialize
3643 *
3644 * LOCKING:
3645 * PCI/etc. bus probe sem.
3646 *
3647 * RETURNS:
3648 * Zero on success, non-zero on error.
3649 */
3650
3651int ata_sas_port_init(struct ata_port *ap)
3652{
3653 int rc = ap->ops->port_start(ap);
3654
3655 if (!rc) {
3656 ap->print_id = ata_print_id++;
3657 rc = ata_bus_probe(ap);
3658 }
3659
3660 return rc;
3661}
3662EXPORT_SYMBOL_GPL(ata_sas_port_init);
3663
3664/**
3665 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3666 * @ap: SATA port to destroy
3667 *
3668 */
3669
3670void ata_sas_port_destroy(struct ata_port *ap)
3671{
3672 if (ap->ops->port_stop)
3673 ap->ops->port_stop(ap);
3674 kfree(ap);
3675}
3676EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3677
3678/**
3679 * ata_sas_slave_configure - Default slave_config routine for libata devices
3680 * @sdev: SCSI device to configure
3681 * @ap: ATA port to which SCSI device is attached
3682 *
3683 * RETURNS:
3684 * Zero.
3685 */
3686
3687int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3688{
3689 ata_scsi_sdev_config(sdev);
3690 ata_scsi_dev_config(sdev, ap->link.device);
3691 return 0;
3692}
3693EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3694
3695/**
3696 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3697 * @cmd: SCSI command to be sent
3698 * @done: Completion function, called when command is complete
3699 * @ap: ATA port to which the command is being sent
3700 *
3701 * RETURNS:
3702 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3703 * 0 otherwise.
3704 */
3705
3706int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3707 struct ata_port *ap)
3708{
3709 int rc = 0;
3710
3711 ata_scsi_dump_cdb(ap, cmd);
3712
3713 if (likely(ata_dev_enabled(ap->link.device)))
3714 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3715 else {
3716 cmd->result = (DID_BAD_TARGET << 16);
3717 done(cmd);
3718 }
3719 return rc;
3720}
3721EXPORT_SYMBOL_GPL(ata_sas_queuecmd);