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