projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
[SCSI] modify change_queue_depth to take in reason why it is being called
[deliverable/linux.git] / drivers / ata / libata-scsi.c
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 if (dev->class == ATA_DEV_ATAPI) {
1103 struct request_queue *q = sdev->request_queue;
1104 void *buf;
1105
1106 /* set the min alignment and padding */
1107 blk_queue_update_dma_alignment(sdev->request_queue,
1108 ATA_DMA_PAD_SZ - 1);
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 /* ATA devices must be sector aligned */
1123 blk_queue_update_dma_alignment(sdev->request_queue,
1124 ATA_SECT_SIZE - 1);
1125 sdev->manage_start_stop = 1;
1126 }
1127
1128 if (dev->flags & ATA_DFLAG_AN)
1129 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1130
1131 if (dev->flags & ATA_DFLAG_NCQ) {
1132 int depth;
1133
1134 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1135 depth = min(ATA_MAX_QUEUE - 1, depth);
1136 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
1137 }
1138
1139 return 0;
1140 }
1141
1142 /**
1143 * ata_scsi_slave_config - Set SCSI device attributes
1144 * @sdev: SCSI device to examine
1145 *
1146 * This is called before we actually start reading
1147 * and writing to the device, to configure certain
1148 * SCSI mid-layer behaviors.
1149 *
1150 * LOCKING:
1151 * Defined by SCSI layer. We don't really care.
1152 */
1153
1154 int ata_scsi_slave_config(struct scsi_device *sdev)
1155 {
1156 struct ata_port *ap = ata_shost_to_port(sdev->host);
1157 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1158 int rc = 0;
1159
1160 ata_scsi_sdev_config(sdev);
1161
1162 if (dev)
1163 rc = ata_scsi_dev_config(sdev, dev);
1164
1165 return rc;
1166 }
1167
1168 /**
1169 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1170 * @sdev: SCSI device to be destroyed
1171 *
1172 * @sdev is about to be destroyed for hot/warm unplugging. If
1173 * this unplugging was initiated by libata as indicated by NULL
1174 * dev->sdev, this function doesn't have to do anything.
1175 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1176 * Clear dev->sdev, schedule the device for ATA detach and invoke
1177 * EH.
1178 *
1179 * LOCKING:
1180 * Defined by SCSI layer. We don't really care.
1181 */
1182 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1183 {
1184 struct ata_port *ap = ata_shost_to_port(sdev->host);
1185 struct request_queue *q = sdev->request_queue;
1186 unsigned long flags;
1187 struct ata_device *dev;
1188
1189 if (!ap->ops->error_handler)
1190 return;
1191
1192 spin_lock_irqsave(ap->lock, flags);
1193 dev = __ata_scsi_find_dev(ap, sdev);
1194 if (dev && dev->sdev) {
1195 /* SCSI device already in CANCEL state, no need to offline it */
1196 dev->sdev = NULL;
1197 dev->flags |= ATA_DFLAG_DETACH;
1198 ata_port_schedule_eh(ap);
1199 }
1200 spin_unlock_irqrestore(ap->lock, flags);
1201
1202 kfree(q->dma_drain_buffer);
1203 q->dma_drain_buffer = NULL;
1204 q->dma_drain_size = 0;
1205 }
1206
1207 /**
1208 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1209 * @sdev: SCSI device to configure queue depth for
1210 * @queue_depth: new queue depth
1211 * @reason: calling context
1212 *
1213 * This is libata standard hostt->change_queue_depth callback.
1214 * SCSI will call into this callback when user tries to set queue
1215 * depth via sysfs.
1216 *
1217 * LOCKING:
1218 * SCSI layer (we don't care)
1219 *
1220 * RETURNS:
1221 * Newly configured queue depth.
1222 */
1223 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth,
1224 int reason)
1225 {
1226 struct ata_port *ap = ata_shost_to_port(sdev->host);
1227 struct ata_device *dev;
1228 unsigned long flags;
1229
1230 if (reason != SCSI_QDEPTH_DEFAULT)
1231 return -EOPNOTSUPP;
1232
1233 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1234 return sdev->queue_depth;
1235
1236 dev = ata_scsi_find_dev(ap, sdev);
1237 if (!dev || !ata_dev_enabled(dev))
1238 return sdev->queue_depth;
1239
1240 /* NCQ enabled? */
1241 spin_lock_irqsave(ap->lock, flags);
1242 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1243 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1244 dev->flags |= ATA_DFLAG_NCQ_OFF;
1245 queue_depth = 1;
1246 }
1247 spin_unlock_irqrestore(ap->lock, flags);
1248
1249 /* limit and apply queue depth */
1250 queue_depth = min(queue_depth, sdev->host->can_queue);
1251 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1252 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1253
1254 if (sdev->queue_depth == queue_depth)
1255 return -EINVAL;
1256
1257 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1258 return queue_depth;
1259 }
1260
1261 /**
1262 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1263 * @qc: Storage for translated ATA taskfile
1264 *
1265 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1266 * (to start). Perhaps these commands should be preceded by
1267 * CHECK POWER MODE to see what power mode the device is already in.
1268 * [See SAT revision 5 at www.t10.org]
1269 *
1270 * LOCKING:
1271 * spin_lock_irqsave(host lock)
1272 *
1273 * RETURNS:
1274 * Zero on success, non-zero on error.
1275 */
1276 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1277 {
1278 struct scsi_cmnd *scmd = qc->scsicmd;
1279 struct ata_taskfile *tf = &qc->tf;
1280 const u8 *cdb = scmd->cmnd;
1281
1282 if (scmd->cmd_len < 5)
1283 goto invalid_fld;
1284
1285 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1286 tf->protocol = ATA_PROT_NODATA;
1287 if (cdb[1] & 0x1) {
1288 ; /* ignore IMMED bit, violates sat-r05 */
1289 }
1290 if (cdb[4] & 0x2)
1291 goto invalid_fld; /* LOEJ bit set not supported */
1292 if (((cdb[4] >> 4) & 0xf) != 0)
1293 goto invalid_fld; /* power conditions not supported */
1294
1295 if (cdb[4] & 0x1) {
1296 tf->nsect = 1; /* 1 sector, lba=0 */
1297
1298 if (qc->dev->flags & ATA_DFLAG_LBA) {
1299 tf->flags |= ATA_TFLAG_LBA;
1300
1301 tf->lbah = 0x0;
1302 tf->lbam = 0x0;
1303 tf->lbal = 0x0;
1304 tf->device |= ATA_LBA;
1305 } else {
1306 /* CHS */
1307 tf->lbal = 0x1; /* sect */
1308 tf->lbam = 0x0; /* cyl low */
1309 tf->lbah = 0x0; /* cyl high */
1310 }
1311
1312 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1313 } else {
1314 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1315 * or S5) causing some drives to spin up and down again.
1316 */
1317 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1318 system_state == SYSTEM_POWER_OFF)
1319 goto skip;
1320
1321 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1322 system_entering_hibernation())
1323 goto skip;
1324
1325 /* Issue ATA STANDBY IMMEDIATE command */
1326 tf->command = ATA_CMD_STANDBYNOW1;
1327 }
1328
1329 /*
1330 * Standby and Idle condition timers could be implemented but that
1331 * would require libata to implement the Power condition mode page
1332 * and allow the user to change it. Changing mode pages requires
1333 * MODE SELECT to be implemented.
1334 */
1335
1336 return 0;
1337
1338 invalid_fld:
1339 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1340 /* "Invalid field in cbd" */
1341 return 1;
1342 skip:
1343 scmd->result = SAM_STAT_GOOD;
1344 return 1;
1345 }
1346
1347
1348 /**
1349 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1350 * @qc: Storage for translated ATA taskfile
1351 *
1352 * Sets up an ATA taskfile to issue FLUSH CACHE or
1353 * FLUSH CACHE EXT.
1354 *
1355 * LOCKING:
1356 * spin_lock_irqsave(host lock)
1357 *
1358 * RETURNS:
1359 * Zero on success, non-zero on error.
1360 */
1361 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1362 {
1363 struct ata_taskfile *tf = &qc->tf;
1364
1365 tf->flags |= ATA_TFLAG_DEVICE;
1366 tf->protocol = ATA_PROT_NODATA;
1367
1368 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1369 tf->command = ATA_CMD_FLUSH_EXT;
1370 else
1371 tf->command = ATA_CMD_FLUSH;
1372
1373 /* flush is critical for IO integrity, consider it an IO command */
1374 qc->flags |= ATA_QCFLAG_IO;
1375
1376 return 0;
1377 }
1378
1379 /**
1380 * scsi_6_lba_len - Get LBA and transfer length
1381 * @cdb: SCSI command to translate
1382 *
1383 * Calculate LBA and transfer length for 6-byte commands.
1384 *
1385 * RETURNS:
1386 * @plba: the LBA
1387 * @plen: the transfer length
1388 */
1389 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1390 {
1391 u64 lba = 0;
1392 u32 len;
1393
1394 VPRINTK("six-byte command\n");
1395
1396 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1397 lba |= ((u64)cdb[2]) << 8;
1398 lba |= ((u64)cdb[3]);
1399
1400 len = cdb[4];
1401
1402 *plba = lba;
1403 *plen = len;
1404 }
1405
1406 /**
1407 * scsi_10_lba_len - Get LBA and transfer length
1408 * @cdb: SCSI command to translate
1409 *
1410 * Calculate LBA and transfer length for 10-byte commands.
1411 *
1412 * RETURNS:
1413 * @plba: the LBA
1414 * @plen: the transfer length
1415 */
1416 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1417 {
1418 u64 lba = 0;
1419 u32 len = 0;
1420
1421 VPRINTK("ten-byte command\n");
1422
1423 lba |= ((u64)cdb[2]) << 24;
1424 lba |= ((u64)cdb[3]) << 16;
1425 lba |= ((u64)cdb[4]) << 8;
1426 lba |= ((u64)cdb[5]);
1427
1428 len |= ((u32)cdb[7]) << 8;
1429 len |= ((u32)cdb[8]);
1430
1431 *plba = lba;
1432 *plen = len;
1433 }
1434
1435 /**
1436 * scsi_16_lba_len - Get LBA and transfer length
1437 * @cdb: SCSI command to translate
1438 *
1439 * Calculate LBA and transfer length for 16-byte commands.
1440 *
1441 * RETURNS:
1442 * @plba: the LBA
1443 * @plen: the transfer length
1444 */
1445 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1446 {
1447 u64 lba = 0;
1448 u32 len = 0;
1449
1450 VPRINTK("sixteen-byte command\n");
1451
1452 lba |= ((u64)cdb[2]) << 56;
1453 lba |= ((u64)cdb[3]) << 48;
1454 lba |= ((u64)cdb[4]) << 40;
1455 lba |= ((u64)cdb[5]) << 32;
1456 lba |= ((u64)cdb[6]) << 24;
1457 lba |= ((u64)cdb[7]) << 16;
1458 lba |= ((u64)cdb[8]) << 8;
1459 lba |= ((u64)cdb[9]);
1460
1461 len |= ((u32)cdb[10]) << 24;
1462 len |= ((u32)cdb[11]) << 16;
1463 len |= ((u32)cdb[12]) << 8;
1464 len |= ((u32)cdb[13]);
1465
1466 *plba = lba;
1467 *plen = len;
1468 }
1469
1470 /**
1471 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1472 * @qc: Storage for translated ATA taskfile
1473 *
1474 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1475 *
1476 * LOCKING:
1477 * spin_lock_irqsave(host lock)
1478 *
1479 * RETURNS:
1480 * Zero on success, non-zero on error.
1481 */
1482 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1483 {
1484 struct scsi_cmnd *scmd = qc->scsicmd;
1485 struct ata_taskfile *tf = &qc->tf;
1486 struct ata_device *dev = qc->dev;
1487 u64 dev_sectors = qc->dev->n_sectors;
1488 const u8 *cdb = scmd->cmnd;
1489 u64 block;
1490 u32 n_block;
1491
1492 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1493 tf->protocol = ATA_PROT_NODATA;
1494
1495 if (cdb[0] == VERIFY) {
1496 if (scmd->cmd_len < 10)
1497 goto invalid_fld;
1498 scsi_10_lba_len(cdb, &block, &n_block);
1499 } else if (cdb[0] == VERIFY_16) {
1500 if (scmd->cmd_len < 16)
1501 goto invalid_fld;
1502 scsi_16_lba_len(cdb, &block, &n_block);
1503 } else
1504 goto invalid_fld;
1505
1506 if (!n_block)
1507 goto nothing_to_do;
1508 if (block >= dev_sectors)
1509 goto out_of_range;
1510 if ((block + n_block) > dev_sectors)
1511 goto out_of_range;
1512
1513 if (dev->flags & ATA_DFLAG_LBA) {
1514 tf->flags |= ATA_TFLAG_LBA;
1515
1516 if (lba_28_ok(block, n_block)) {
1517 /* use LBA28 */
1518 tf->command = ATA_CMD_VERIFY;
1519 tf->device |= (block >> 24) & 0xf;
1520 } else if (lba_48_ok(block, n_block)) {
1521 if (!(dev->flags & ATA_DFLAG_LBA48))
1522 goto out_of_range;
1523
1524 /* use LBA48 */
1525 tf->flags |= ATA_TFLAG_LBA48;
1526 tf->command = ATA_CMD_VERIFY_EXT;
1527
1528 tf->hob_nsect = (n_block >> 8) & 0xff;
1529
1530 tf->hob_lbah = (block >> 40) & 0xff;
1531 tf->hob_lbam = (block >> 32) & 0xff;
1532 tf->hob_lbal = (block >> 24) & 0xff;
1533 } else
1534 /* request too large even for LBA48 */
1535 goto out_of_range;
1536
1537 tf->nsect = n_block & 0xff;
1538
1539 tf->lbah = (block >> 16) & 0xff;
1540 tf->lbam = (block >> 8) & 0xff;
1541 tf->lbal = block & 0xff;
1542
1543 tf->device |= ATA_LBA;
1544 } else {
1545 /* CHS */
1546 u32 sect, head, cyl, track;
1547
1548 if (!lba_28_ok(block, n_block))
1549 goto out_of_range;
1550
1551 /* Convert LBA to CHS */
1552 track = (u32)block / dev->sectors;
1553 cyl = track / dev->heads;
1554 head = track % dev->heads;
1555 sect = (u32)block % dev->sectors + 1;
1556
1557 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1558 (u32)block, track, cyl, head, sect);
1559
1560 /* Check whether the converted CHS can fit.
1561 Cylinder: 0-65535
1562 Head: 0-15
1563 Sector: 1-255*/
1564 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1565 goto out_of_range;
1566
1567 tf->command = ATA_CMD_VERIFY;
1568 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1569 tf->lbal = sect;
1570 tf->lbam = cyl;
1571 tf->lbah = cyl >> 8;
1572 tf->device |= head;
1573 }
1574
1575 return 0;
1576
1577 invalid_fld:
1578 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1579 /* "Invalid field in cbd" */
1580 return 1;
1581
1582 out_of_range:
1583 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1584 /* "Logical Block Address out of range" */
1585 return 1;
1586
1587 nothing_to_do:
1588 scmd->result = SAM_STAT_GOOD;
1589 return 1;
1590 }
1591
1592 /**
1593 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1594 * @qc: Storage for translated ATA taskfile
1595 *
1596 * Converts any of six SCSI read/write commands into the
1597 * ATA counterpart, including starting sector (LBA),
1598 * sector count, and taking into account the device's LBA48
1599 * support.
1600 *
1601 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1602 * %WRITE_16 are currently supported.
1603 *
1604 * LOCKING:
1605 * spin_lock_irqsave(host lock)
1606 *
1607 * RETURNS:
1608 * Zero on success, non-zero on error.
1609 */
1610 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1611 {
1612 struct scsi_cmnd *scmd = qc->scsicmd;
1613 const u8 *cdb = scmd->cmnd;
1614 unsigned int tf_flags = 0;
1615 u64 block;
1616 u32 n_block;
1617 int rc;
1618
1619 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1620 tf_flags |= ATA_TFLAG_WRITE;
1621
1622 /* Calculate the SCSI LBA, transfer length and FUA. */
1623 switch (cdb[0]) {
1624 case READ_10:
1625 case WRITE_10:
1626 if (unlikely(scmd->cmd_len < 10))
1627 goto invalid_fld;
1628 scsi_10_lba_len(cdb, &block, &n_block);
1629 if (unlikely(cdb[1] & (1 << 3)))
1630 tf_flags |= ATA_TFLAG_FUA;
1631 break;
1632 case READ_6:
1633 case WRITE_6:
1634 if (unlikely(scmd->cmd_len < 6))
1635 goto invalid_fld;
1636 scsi_6_lba_len(cdb, &block, &n_block);
1637
1638 /* for 6-byte r/w commands, transfer length 0
1639 * means 256 blocks of data, not 0 block.
1640 */
1641 if (!n_block)
1642 n_block = 256;
1643 break;
1644 case READ_16:
1645 case WRITE_16:
1646 if (unlikely(scmd->cmd_len < 16))
1647 goto invalid_fld;
1648 scsi_16_lba_len(cdb, &block, &n_block);
1649 if (unlikely(cdb[1] & (1 << 3)))
1650 tf_flags |= ATA_TFLAG_FUA;
1651 break;
1652 default:
1653 DPRINTK("no-byte command\n");
1654 goto invalid_fld;
1655 }
1656
1657 /* Check and compose ATA command */
1658 if (!n_block)
1659 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1660 * length 0 means transfer 0 block of data.
1661 * However, for ATA R/W commands, sector count 0 means
1662 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1663 *
1664 * WARNING: one or two older ATA drives treat 0 as 0...
1665 */
1666 goto nothing_to_do;
1667
1668 qc->flags |= ATA_QCFLAG_IO;
1669 qc->nbytes = n_block * ATA_SECT_SIZE;
1670
1671 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1672 qc->tag);
1673 if (likely(rc == 0))
1674 return 0;
1675
1676 if (rc == -ERANGE)
1677 goto out_of_range;
1678 /* treat all other errors as -EINVAL, fall through */
1679 invalid_fld:
1680 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1681 /* "Invalid field in cbd" */
1682 return 1;
1683
1684 out_of_range:
1685 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1686 /* "Logical Block Address out of range" */
1687 return 1;
1688
1689 nothing_to_do:
1690 scmd->result = SAM_STAT_GOOD;
1691 return 1;
1692 }
1693
1694 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1695 {
1696 struct ata_port *ap = qc->ap;
1697 struct scsi_cmnd *cmd = qc->scsicmd;
1698 u8 *cdb = cmd->cmnd;
1699 int need_sense = (qc->err_mask != 0);
1700
1701 /* For ATA pass thru (SAT) commands, generate a sense block if
1702 * user mandated it or if there's an error. Note that if we
1703 * generate because the user forced us to, a check condition
1704 * is generated and the ATA register values are returned
1705 * whether the command completed successfully or not. If there
1706 * was no error, SK, ASC and ASCQ will all be zero.
1707 */
1708 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1709 ((cdb[2] & 0x20) || need_sense)) {
1710 ata_gen_passthru_sense(qc);
1711 } else {
1712 if (!need_sense) {
1713 cmd->result = SAM_STAT_GOOD;
1714 } else {
1715 /* TODO: decide which descriptor format to use
1716 * for 48b LBA devices and call that here
1717 * instead of the fixed desc, which is only
1718 * good for smaller LBA (and maybe CHS?)
1719 * devices.
1720 */
1721 ata_gen_ata_sense(qc);
1722 }
1723 }
1724
1725 if (need_sense && !ap->ops->error_handler)
1726 ata_dump_status(ap->print_id, &qc->result_tf);
1727
1728 qc->scsidone(cmd);
1729
1730 ata_qc_free(qc);
1731 }
1732
1733 /**
1734 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1735 * @dev: ATA device to which the command is addressed
1736 * @cmd: SCSI command to execute
1737 * @done: SCSI command completion function
1738 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1739 *
1740 * Our ->queuecommand() function has decided that the SCSI
1741 * command issued can be directly translated into an ATA
1742 * command, rather than handled internally.
1743 *
1744 * This function sets up an ata_queued_cmd structure for the
1745 * SCSI command, and sends that ata_queued_cmd to the hardware.
1746 *
1747 * The xlat_func argument (actor) returns 0 if ready to execute
1748 * ATA command, else 1 to finish translation. If 1 is returned
1749 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1750 * to be set reflecting an error condition or clean (early)
1751 * termination.
1752 *
1753 * LOCKING:
1754 * spin_lock_irqsave(host lock)
1755 *
1756 * RETURNS:
1757 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1758 * needs to be deferred.
1759 */
1760 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1761 void (*done)(struct scsi_cmnd *),
1762 ata_xlat_func_t xlat_func)
1763 {
1764 struct ata_port *ap = dev->link->ap;
1765 struct ata_queued_cmd *qc;
1766 int rc;
1767
1768 VPRINTK("ENTER\n");
1769
1770 qc = ata_scsi_qc_new(dev, cmd, done);
1771 if (!qc)
1772 goto err_mem;
1773
1774 /* data is present; dma-map it */
1775 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1776 cmd->sc_data_direction == DMA_TO_DEVICE) {
1777 if (unlikely(scsi_bufflen(cmd) < 1)) {
1778 ata_dev_printk(dev, KERN_WARNING,
1779 "WARNING: zero len r/w req\n");
1780 goto err_did;
1781 }
1782
1783 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1784
1785 qc->dma_dir = cmd->sc_data_direction;
1786 }
1787
1788 qc->complete_fn = ata_scsi_qc_complete;
1789
1790 if (xlat_func(qc))
1791 goto early_finish;
1792
1793 if (ap->ops->qc_defer) {
1794 if ((rc = ap->ops->qc_defer(qc)))
1795 goto defer;
1796 }
1797
1798 /* select device, send command to hardware */
1799 ata_qc_issue(qc);
1800
1801 VPRINTK("EXIT\n");
1802 return 0;
1803
1804 early_finish:
1805 ata_qc_free(qc);
1806 qc->scsidone(cmd);
1807 DPRINTK("EXIT - early finish (good or error)\n");
1808 return 0;
1809
1810 err_did:
1811 ata_qc_free(qc);
1812 cmd->result = (DID_ERROR << 16);
1813 qc->scsidone(cmd);
1814 err_mem:
1815 DPRINTK("EXIT - internal\n");
1816 return 0;
1817
1818 defer:
1819 ata_qc_free(qc);
1820 DPRINTK("EXIT - defer\n");
1821 if (rc == ATA_DEFER_LINK)
1822 return SCSI_MLQUEUE_DEVICE_BUSY;
1823 else
1824 return SCSI_MLQUEUE_HOST_BUSY;
1825 }
1826
1827 /**
1828 * ata_scsi_rbuf_get - Map response buffer.
1829 * @cmd: SCSI command containing buffer to be mapped.
1830 * @flags: unsigned long variable to store irq enable status
1831 * @copy_in: copy in from user buffer
1832 *
1833 * Prepare buffer for simulated SCSI commands.
1834 *
1835 * LOCKING:
1836 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1837 *
1838 * RETURNS:
1839 * Pointer to response buffer.
1840 */
1841 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1842 unsigned long *flags)
1843 {
1844 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1845
1846 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1847 if (copy_in)
1848 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1849 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1850 return ata_scsi_rbuf;
1851 }
1852
1853 /**
1854 * ata_scsi_rbuf_put - Unmap response buffer.
1855 * @cmd: SCSI command containing buffer to be unmapped.
1856 * @copy_out: copy out result
1857 * @flags: @flags passed to ata_scsi_rbuf_get()
1858 *
1859 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1860 * @copy_back is true.
1861 *
1862 * LOCKING:
1863 * Unlocks ata_scsi_rbuf_lock.
1864 */
1865 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1866 unsigned long *flags)
1867 {
1868 if (copy_out)
1869 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1870 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1871 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1872 }
1873
1874 /**
1875 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1876 * @args: device IDENTIFY data / SCSI command of interest.
1877 * @actor: Callback hook for desired SCSI command simulator
1878 *
1879 * Takes care of the hard work of simulating a SCSI command...
1880 * Mapping the response buffer, calling the command's handler,
1881 * and handling the handler's return value. This return value
1882 * indicates whether the handler wishes the SCSI command to be
1883 * completed successfully (0), or not (in which case cmd->result
1884 * and sense buffer are assumed to be set).
1885 *
1886 * LOCKING:
1887 * spin_lock_irqsave(host lock)
1888 */
1889 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1890 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1891 {
1892 u8 *rbuf;
1893 unsigned int rc;
1894 struct scsi_cmnd *cmd = args->cmd;
1895 unsigned long flags;
1896
1897 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1898 rc = actor(args, rbuf);
1899 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1900
1901 if (rc == 0)
1902 cmd->result = SAM_STAT_GOOD;
1903 args->done(cmd);
1904 }
1905
1906 /**
1907 * ata_scsiop_inq_std - Simulate INQUIRY command
1908 * @args: device IDENTIFY data / SCSI command of interest.
1909 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1910 *
1911 * Returns standard device identification data associated
1912 * with non-VPD INQUIRY command output.
1913 *
1914 * LOCKING:
1915 * spin_lock_irqsave(host lock)
1916 */
1917 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1918 {
1919 const u8 versions[] = {
1920 0x60, /* SAM-3 (no version claimed) */
1921
1922 0x03,
1923 0x20, /* SBC-2 (no version claimed) */
1924
1925 0x02,
1926 0x60 /* SPC-3 (no version claimed) */
1927 };
1928 u8 hdr[] = {
1929 TYPE_DISK,
1930 0,
1931 0x5, /* claim SPC-3 version compatibility */
1932 2,
1933 95 - 4
1934 };
1935
1936 VPRINTK("ENTER\n");
1937
1938 /* set scsi removeable (RMB) bit per ata bit */
1939 if (ata_id_removeable(args->id))
1940 hdr[1] |= (1 << 7);
1941
1942 memcpy(rbuf, hdr, sizeof(hdr));
1943 memcpy(&rbuf[8], "ATA ", 8);
1944 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1945 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1946
1947 if (rbuf[32] == 0 || rbuf[32] == ' ')
1948 memcpy(&rbuf[32], "n/a ", 4);
1949
1950 memcpy(rbuf + 59, versions, sizeof(versions));
1951
1952 return 0;
1953 }
1954
1955 /**
1956 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1957 * @args: device IDENTIFY data / SCSI command of interest.
1958 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1959 *
1960 * Returns list of inquiry VPD pages available.
1961 *
1962 * LOCKING:
1963 * spin_lock_irqsave(host lock)
1964 */
1965 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1966 {
1967 const u8 pages[] = {
1968 0x00, /* page 0x00, this page */
1969 0x80, /* page 0x80, unit serial no page */
1970 0x83, /* page 0x83, device ident page */
1971 0x89, /* page 0x89, ata info page */
1972 0xb1, /* page 0xb1, block device characteristics page */
1973 };
1974
1975 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1976 memcpy(rbuf + 4, pages, sizeof(pages));
1977 return 0;
1978 }
1979
1980 /**
1981 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1982 * @args: device IDENTIFY data / SCSI command of interest.
1983 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1984 *
1985 * Returns ATA device serial number.
1986 *
1987 * LOCKING:
1988 * spin_lock_irqsave(host lock)
1989 */
1990 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1991 {
1992 const u8 hdr[] = {
1993 0,
1994 0x80, /* this page code */
1995 0,
1996 ATA_ID_SERNO_LEN, /* page len */
1997 };
1998
1999 memcpy(rbuf, hdr, sizeof(hdr));
2000 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2001 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2002 return 0;
2003 }
2004
2005 /**
2006 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2007 * @args: device IDENTIFY data / SCSI command of interest.
2008 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2009 *
2010 * Yields two logical unit device identification designators:
2011 * - vendor specific ASCII containing the ATA serial number
2012 * - SAT defined "t10 vendor id based" containing ASCII vendor
2013 * name ("ATA "), model and serial numbers.
2014 *
2015 * LOCKING:
2016 * spin_lock_irqsave(host lock)
2017 */
2018 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2019 {
2020 const int sat_model_serial_desc_len = 68;
2021 int num;
2022
2023 rbuf[1] = 0x83; /* this page code */
2024 num = 4;
2025
2026 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2027 rbuf[num + 0] = 2;
2028 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2029 num += 4;
2030 ata_id_string(args->id, (unsigned char *) rbuf + num,
2031 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2032 num += ATA_ID_SERNO_LEN;
2033
2034 /* SAT defined lu model and serial numbers descriptor */
2035 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2036 rbuf[num + 0] = 2;
2037 rbuf[num + 1] = 1;
2038 rbuf[num + 3] = sat_model_serial_desc_len;
2039 num += 4;
2040 memcpy(rbuf + num, "ATA ", 8);
2041 num += 8;
2042 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2043 ATA_ID_PROD_LEN);
2044 num += ATA_ID_PROD_LEN;
2045 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2046 ATA_ID_SERNO_LEN);
2047 num += ATA_ID_SERNO_LEN;
2048
2049 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2050 return 0;
2051 }
2052
2053 /**
2054 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2055 * @args: device IDENTIFY data / SCSI command of interest.
2056 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2057 *
2058 * Yields SAT-specified ATA VPD page.
2059 *
2060 * LOCKING:
2061 * spin_lock_irqsave(host lock)
2062 */
2063 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2064 {
2065 struct ata_taskfile tf;
2066
2067 memset(&tf, 0, sizeof(tf));
2068
2069 rbuf[1] = 0x89; /* our page code */
2070 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2071 rbuf[3] = (0x238 & 0xff);
2072
2073 memcpy(&rbuf[8], "linux ", 8);
2074 memcpy(&rbuf[16], "libata ", 16);
2075 memcpy(&rbuf[32], DRV_VERSION, 4);
2076 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2077
2078 /* we don't store the ATA device signature, so we fake it */
2079
2080 tf.command = ATA_DRDY; /* really, this is Status reg */
2081 tf.lbal = 0x1;
2082 tf.nsect = 0x1;
2083
2084 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2085 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2086
2087 rbuf[56] = ATA_CMD_ID_ATA;
2088
2089 memcpy(&rbuf[60], &args->id[0], 512);
2090 return 0;
2091 }
2092
2093 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2094 {
2095 int form_factor = ata_id_form_factor(args->id);
2096 int media_rotation_rate = ata_id_rotation_rate(args->id);
2097
2098 rbuf[1] = 0xb1;
2099 rbuf[3] = 0x3c;
2100 rbuf[4] = media_rotation_rate >> 8;
2101 rbuf[5] = media_rotation_rate;
2102 rbuf[7] = form_factor;
2103
2104 return 0;
2105 }
2106
2107 /**
2108 * ata_scsiop_noop - Command handler that simply returns success.
2109 * @args: device IDENTIFY data / SCSI command of interest.
2110 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2111 *
2112 * No operation. Simply returns success to caller, to indicate
2113 * that the caller should successfully complete this SCSI command.
2114 *
2115 * LOCKING:
2116 * spin_lock_irqsave(host lock)
2117 */
2118 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2119 {
2120 VPRINTK("ENTER\n");
2121 return 0;
2122 }
2123
2124 /**
2125 * ata_msense_caching - Simulate MODE SENSE caching info page
2126 * @id: device IDENTIFY data
2127 * @buf: output buffer
2128 *
2129 * Generate a caching info page, which conditionally indicates
2130 * write caching to the SCSI layer, depending on device
2131 * capabilities.
2132 *
2133 * LOCKING:
2134 * None.
2135 */
2136 static unsigned int ata_msense_caching(u16 *id, u8 *buf)
2137 {
2138 memcpy(buf, def_cache_mpage, sizeof(def_cache_mpage));
2139 if (ata_id_wcache_enabled(id))
2140 buf[2] |= (1 << 2); /* write cache enable */
2141 if (!ata_id_rahead_enabled(id))
2142 buf[12] |= (1 << 5); /* disable read ahead */
2143 return sizeof(def_cache_mpage);
2144 }
2145
2146 /**
2147 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2148 * @buf: output buffer
2149 *
2150 * Generate a generic MODE SENSE control mode page.
2151 *
2152 * LOCKING:
2153 * None.
2154 */
2155 static unsigned int ata_msense_ctl_mode(u8 *buf)
2156 {
2157 memcpy(buf, def_control_mpage, sizeof(def_control_mpage));
2158 return sizeof(def_control_mpage);
2159 }
2160
2161 /**
2162 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2163 * @buf: output buffer
2164 *
2165 * Generate a generic MODE SENSE r/w error recovery page.
2166 *
2167 * LOCKING:
2168 * None.
2169 */
2170 static unsigned int ata_msense_rw_recovery(u8 *buf)
2171 {
2172 memcpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage));
2173 return sizeof(def_rw_recovery_mpage);
2174 }
2175
2176 /*
2177 * We can turn this into a real blacklist if it's needed, for now just
2178 * blacklist any Maxtor BANC1G10 revision firmware
2179 */
2180 static int ata_dev_supports_fua(u16 *id)
2181 {
2182 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2183
2184 if (!libata_fua)
2185 return 0;
2186 if (!ata_id_has_fua(id))
2187 return 0;
2188
2189 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2190 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2191
2192 if (strcmp(model, "Maxtor"))
2193 return 1;
2194 if (strcmp(fw, "BANC1G10"))
2195 return 1;
2196
2197 return 0; /* blacklisted */
2198 }
2199
2200 /**
2201 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2202 * @args: device IDENTIFY data / SCSI command of interest.
2203 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2204 *
2205 * Simulate MODE SENSE commands. Assume this is invoked for direct
2206 * access devices (e.g. disks) only. There should be no block
2207 * descriptor for other device types.
2208 *
2209 * LOCKING:
2210 * spin_lock_irqsave(host lock)
2211 */
2212 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2213 {
2214 struct ata_device *dev = args->dev;
2215 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2216 const u8 sat_blk_desc[] = {
2217 0, 0, 0, 0, /* number of blocks: sat unspecified */
2218 0,
2219 0, 0x2, 0x0 /* block length: 512 bytes */
2220 };
2221 u8 pg, spg;
2222 unsigned int ebd, page_control, six_byte;
2223 u8 dpofua;
2224
2225 VPRINTK("ENTER\n");
2226
2227 six_byte = (scsicmd[0] == MODE_SENSE);
2228 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2229 /*
2230 * LLBA bit in msense(10) ignored (compliant)
2231 */
2232
2233 page_control = scsicmd[2] >> 6;
2234 switch (page_control) {
2235 case 0: /* current */
2236 break; /* supported */
2237 case 3: /* saved */
2238 goto saving_not_supp;
2239 case 1: /* changeable */
2240 case 2: /* defaults */
2241 default:
2242 goto invalid_fld;
2243 }
2244
2245 if (six_byte)
2246 p += 4 + (ebd ? 8 : 0);
2247 else
2248 p += 8 + (ebd ? 8 : 0);
2249
2250 pg = scsicmd[2] & 0x3f;
2251 spg = scsicmd[3];
2252 /*
2253 * No mode subpages supported (yet) but asking for _all_
2254 * subpages may be valid
2255 */
2256 if (spg && (spg != ALL_SUB_MPAGES))
2257 goto invalid_fld;
2258
2259 switch(pg) {
2260 case RW_RECOVERY_MPAGE:
2261 p += ata_msense_rw_recovery(p);
2262 break;
2263
2264 case CACHE_MPAGE:
2265 p += ata_msense_caching(args->id, p);
2266 break;
2267
2268 case CONTROL_MPAGE:
2269 p += ata_msense_ctl_mode(p);
2270 break;
2271
2272 case ALL_MPAGES:
2273 p += ata_msense_rw_recovery(p);
2274 p += ata_msense_caching(args->id, p);
2275 p += ata_msense_ctl_mode(p);
2276 break;
2277
2278 default: /* invalid page code */
2279 goto invalid_fld;
2280 }
2281
2282 dpofua = 0;
2283 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2284 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2285 dpofua = 1 << 4;
2286
2287 if (six_byte) {
2288 rbuf[0] = p - rbuf - 1;
2289 rbuf[2] |= dpofua;
2290 if (ebd) {
2291 rbuf[3] = sizeof(sat_blk_desc);
2292 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2293 }
2294 } else {
2295 unsigned int output_len = p - rbuf - 2;
2296
2297 rbuf[0] = output_len >> 8;
2298 rbuf[1] = output_len;
2299 rbuf[3] |= dpofua;
2300 if (ebd) {
2301 rbuf[7] = sizeof(sat_blk_desc);
2302 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2303 }
2304 }
2305 return 0;
2306
2307 invalid_fld:
2308 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2309 /* "Invalid field in cbd" */
2310 return 1;
2311
2312 saving_not_supp:
2313 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2314 /* "Saving parameters not supported" */
2315 return 1;
2316 }
2317
2318 /**
2319 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2320 * @args: device IDENTIFY data / SCSI command of interest.
2321 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2322 *
2323 * Simulate READ CAPACITY commands.
2324 *
2325 * LOCKING:
2326 * None.
2327 */
2328 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2329 {
2330 struct ata_device *dev = args->dev;
2331 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2332 u8 log_per_phys = 0;
2333 u16 lowest_aligned = 0;
2334 u16 word_106 = dev->id[106];
2335 u16 word_209 = dev->id[209];
2336
2337 if ((word_106 & 0xc000) == 0x4000) {
2338 /* Number and offset of logical sectors per physical sector */
2339 if (word_106 & (1 << 13))
2340 log_per_phys = word_106 & 0xf;
2341 if ((word_209 & 0xc000) == 0x4000) {
2342 u16 first = dev->id[209] & 0x3fff;
2343 if (first > 0)
2344 lowest_aligned = (1 << log_per_phys) - first;
2345 }
2346 }
2347
2348 VPRINTK("ENTER\n");
2349
2350 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2351 if (last_lba >= 0xffffffffULL)
2352 last_lba = 0xffffffff;
2353
2354 /* sector count, 32-bit */
2355 rbuf[0] = last_lba >> (8 * 3);
2356 rbuf[1] = last_lba >> (8 * 2);
2357 rbuf[2] = last_lba >> (8 * 1);
2358 rbuf[3] = last_lba;
2359
2360 /* sector size */
2361 rbuf[6] = ATA_SECT_SIZE >> 8;
2362 rbuf[7] = ATA_SECT_SIZE & 0xff;
2363 } else {
2364 /* sector count, 64-bit */
2365 rbuf[0] = last_lba >> (8 * 7);
2366 rbuf[1] = last_lba >> (8 * 6);
2367 rbuf[2] = last_lba >> (8 * 5);
2368 rbuf[3] = last_lba >> (8 * 4);
2369 rbuf[4] = last_lba >> (8 * 3);
2370 rbuf[5] = last_lba >> (8 * 2);
2371 rbuf[6] = last_lba >> (8 * 1);
2372 rbuf[7] = last_lba;
2373
2374 /* sector size */
2375 rbuf[10] = ATA_SECT_SIZE >> 8;
2376 rbuf[11] = ATA_SECT_SIZE & 0xff;
2377
2378 rbuf[12] = 0;
2379 rbuf[13] = log_per_phys;
2380 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2381 rbuf[15] = lowest_aligned;
2382 }
2383
2384 return 0;
2385 }
2386
2387 /**
2388 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2389 * @args: device IDENTIFY data / SCSI command of interest.
2390 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2391 *
2392 * Simulate REPORT LUNS command.
2393 *
2394 * LOCKING:
2395 * spin_lock_irqsave(host lock)
2396 */
2397 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2398 {
2399 VPRINTK("ENTER\n");
2400 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2401
2402 return 0;
2403 }
2404
2405 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2406 {
2407 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2408 /* FIXME: not quite right; we don't want the
2409 * translation of taskfile registers into
2410 * a sense descriptors, since that's only
2411 * correct for ATA, not ATAPI
2412 */
2413 ata_gen_passthru_sense(qc);
2414 }
2415
2416 qc->scsidone(qc->scsicmd);
2417 ata_qc_free(qc);
2418 }
2419
2420 /* is it pointless to prefer PIO for "safety reasons"? */
2421 static inline int ata_pio_use_silly(struct ata_port *ap)
2422 {
2423 return (ap->flags & ATA_FLAG_PIO_DMA);
2424 }
2425
2426 static void atapi_request_sense(struct ata_queued_cmd *qc)
2427 {
2428 struct ata_port *ap = qc->ap;
2429 struct scsi_cmnd *cmd = qc->scsicmd;
2430
2431 DPRINTK("ATAPI request sense\n");
2432
2433 /* FIXME: is this needed? */
2434 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2435
2436 #ifdef CONFIG_ATA_SFF
2437 if (ap->ops->sff_tf_read)
2438 ap->ops->sff_tf_read(ap, &qc->tf);
2439 #endif
2440
2441 /* fill these in, for the case where they are -not- overwritten */
2442 cmd->sense_buffer[0] = 0x70;
2443 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2444
2445 ata_qc_reinit(qc);
2446
2447 /* setup sg table and init transfer direction */
2448 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2449 ata_sg_init(qc, &qc->sgent, 1);
2450 qc->dma_dir = DMA_FROM_DEVICE;
2451
2452 memset(&qc->cdb, 0, qc->dev->cdb_len);
2453 qc->cdb[0] = REQUEST_SENSE;
2454 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2455
2456 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2457 qc->tf.command = ATA_CMD_PACKET;
2458
2459 if (ata_pio_use_silly(ap)) {
2460 qc->tf.protocol = ATAPI_PROT_DMA;
2461 qc->tf.feature |= ATAPI_PKT_DMA;
2462 } else {
2463 qc->tf.protocol = ATAPI_PROT_PIO;
2464 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2465 qc->tf.lbah = 0;
2466 }
2467 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2468
2469 qc->complete_fn = atapi_sense_complete;
2470
2471 ata_qc_issue(qc);
2472
2473 DPRINTK("EXIT\n");
2474 }
2475
2476 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2477 {
2478 struct scsi_cmnd *cmd = qc->scsicmd;
2479 unsigned int err_mask = qc->err_mask;
2480
2481 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2482
2483 /* handle completion from new EH */
2484 if (unlikely(qc->ap->ops->error_handler &&
2485 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2486
2487 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2488 /* FIXME: not quite right; we don't want the
2489 * translation of taskfile registers into a
2490 * sense descriptors, since that's only
2491 * correct for ATA, not ATAPI
2492 */
2493 ata_gen_passthru_sense(qc);
2494 }
2495
2496 /* SCSI EH automatically locks door if sdev->locked is
2497 * set. Sometimes door lock request continues to
2498 * fail, for example, when no media is present. This
2499 * creates a loop - SCSI EH issues door lock which
2500 * fails and gets invoked again to acquire sense data
2501 * for the failed command.
2502 *
2503 * If door lock fails, always clear sdev->locked to
2504 * avoid this infinite loop.
2505 */
2506 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2507 qc->dev->sdev->locked = 0;
2508
2509 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2510 qc->scsidone(cmd);
2511 ata_qc_free(qc);
2512 return;
2513 }
2514
2515 /* successful completion or old EH failure path */
2516 if (unlikely(err_mask & AC_ERR_DEV)) {
2517 cmd->result = SAM_STAT_CHECK_CONDITION;
2518 atapi_request_sense(qc);
2519 return;
2520 } else if (unlikely(err_mask)) {
2521 /* FIXME: not quite right; we don't want the
2522 * translation of taskfile registers into
2523 * a sense descriptors, since that's only
2524 * correct for ATA, not ATAPI
2525 */
2526 ata_gen_passthru_sense(qc);
2527 } else {
2528 u8 *scsicmd = cmd->cmnd;
2529
2530 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2531 unsigned long flags;
2532 u8 *buf;
2533
2534 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2535
2536 /* ATAPI devices typically report zero for their SCSI version,
2537 * and sometimes deviate from the spec WRT response data
2538 * format. If SCSI version is reported as zero like normal,
2539 * then we make the following fixups: 1) Fake MMC-5 version,
2540 * to indicate to the Linux scsi midlayer this is a modern
2541 * device. 2) Ensure response data format / ATAPI information
2542 * are always correct.
2543 */
2544 if (buf[2] == 0) {
2545 buf[2] = 0x5;
2546 buf[3] = 0x32;
2547 }
2548
2549 ata_scsi_rbuf_put(cmd, true, &flags);
2550 }
2551
2552 cmd->result = SAM_STAT_GOOD;
2553 }
2554
2555 qc->scsidone(cmd);
2556 ata_qc_free(qc);
2557 }
2558 /**
2559 * atapi_xlat - Initialize PACKET taskfile
2560 * @qc: command structure to be initialized
2561 *
2562 * LOCKING:
2563 * spin_lock_irqsave(host lock)
2564 *
2565 * RETURNS:
2566 * Zero on success, non-zero on failure.
2567 */
2568 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2569 {
2570 struct scsi_cmnd *scmd = qc->scsicmd;
2571 struct ata_device *dev = qc->dev;
2572 int nodata = (scmd->sc_data_direction == DMA_NONE);
2573 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2574 unsigned int nbytes;
2575
2576 memset(qc->cdb, 0, dev->cdb_len);
2577 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2578
2579 qc->complete_fn = atapi_qc_complete;
2580
2581 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2582 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2583 qc->tf.flags |= ATA_TFLAG_WRITE;
2584 DPRINTK("direction: write\n");
2585 }
2586
2587 qc->tf.command = ATA_CMD_PACKET;
2588 ata_qc_set_pc_nbytes(qc);
2589
2590 /* check whether ATAPI DMA is safe */
2591 if (!nodata && !using_pio && atapi_check_dma(qc))
2592 using_pio = 1;
2593
2594 /* Some controller variants snoop this value for Packet
2595 * transfers to do state machine and FIFO management. Thus we
2596 * want to set it properly, and for DMA where it is
2597 * effectively meaningless.
2598 */
2599 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2600
2601 /* Most ATAPI devices which honor transfer chunk size don't
2602 * behave according to the spec when odd chunk size which
2603 * matches the transfer length is specified. If the number of
2604 * bytes to transfer is 2n+1. According to the spec, what
2605 * should happen is to indicate that 2n+1 is going to be
2606 * transferred and transfer 2n+2 bytes where the last byte is
2607 * padding.
2608 *
2609 * In practice, this doesn't happen. ATAPI devices first
2610 * indicate and transfer 2n bytes and then indicate and
2611 * transfer 2 bytes where the last byte is padding.
2612 *
2613 * This inconsistency confuses several controllers which
2614 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2615 * These controllers use actual number of transferred bytes to
2616 * update DMA poitner and transfer of 4n+2 bytes make those
2617 * controller push DMA pointer by 4n+4 bytes because SATA data
2618 * FISes are aligned to 4 bytes. This causes data corruption
2619 * and buffer overrun.
2620 *
2621 * Always setting nbytes to even number solves this problem
2622 * because then ATAPI devices don't have to split data at 2n
2623 * boundaries.
2624 */
2625 if (nbytes & 0x1)
2626 nbytes++;
2627
2628 qc->tf.lbam = (nbytes & 0xFF);
2629 qc->tf.lbah = (nbytes >> 8);
2630
2631 if (nodata)
2632 qc->tf.protocol = ATAPI_PROT_NODATA;
2633 else if (using_pio)
2634 qc->tf.protocol = ATAPI_PROT_PIO;
2635 else {
2636 /* DMA data xfer */
2637 qc->tf.protocol = ATAPI_PROT_DMA;
2638 qc->tf.feature |= ATAPI_PKT_DMA;
2639
2640 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2641 (scmd->sc_data_direction != DMA_TO_DEVICE))
2642 /* some SATA bridges need us to indicate data xfer direction */
2643 qc->tf.feature |= ATAPI_DMADIR;
2644 }
2645
2646
2647 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2648 as ATAPI tape drives don't get this right otherwise */
2649 return 0;
2650 }
2651
2652 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2653 {
2654 if (!sata_pmp_attached(ap)) {
2655 if (likely(devno < ata_link_max_devices(&ap->link)))
2656 return &ap->link.device[devno];
2657 } else {
2658 if (likely(devno < ap->nr_pmp_links))
2659 return &ap->pmp_link[devno].device[0];
2660 }
2661
2662 return NULL;
2663 }
2664
2665 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2666 const struct scsi_device *scsidev)
2667 {
2668 int devno;
2669
2670 /* skip commands not addressed to targets we simulate */
2671 if (!sata_pmp_attached(ap)) {
2672 if (unlikely(scsidev->channel || scsidev->lun))
2673 return NULL;
2674 devno = scsidev->id;
2675 } else {
2676 if (unlikely(scsidev->id || scsidev->lun))
2677 return NULL;
2678 devno = scsidev->channel;
2679 }
2680
2681 return ata_find_dev(ap, devno);
2682 }
2683
2684 /**
2685 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2686 * @ap: ATA port to which the device is attached
2687 * @scsidev: SCSI device from which we derive the ATA device
2688 *
2689 * Given various information provided in struct scsi_cmnd,
2690 * map that onto an ATA bus, and using that mapping
2691 * determine which ata_device is associated with the
2692 * SCSI command to be sent.
2693 *
2694 * LOCKING:
2695 * spin_lock_irqsave(host lock)
2696 *
2697 * RETURNS:
2698 * Associated ATA device, or %NULL if not found.
2699 */
2700 static struct ata_device *
2701 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2702 {
2703 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2704
2705 if (unlikely(!dev || !ata_dev_enabled(dev)))
2706 return NULL;
2707
2708 return dev;
2709 }
2710
2711 /*
2712 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2713 * @byte1: Byte 1 from pass-thru CDB.
2714 *
2715 * RETURNS:
2716 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2717 */
2718 static u8
2719 ata_scsi_map_proto(u8 byte1)
2720 {
2721 switch((byte1 & 0x1e) >> 1) {
2722 case 3: /* Non-data */
2723 return ATA_PROT_NODATA;
2724
2725 case 6: /* DMA */
2726 case 10: /* UDMA Data-in */
2727 case 11: /* UDMA Data-Out */
2728 return ATA_PROT_DMA;
2729
2730 case 4: /* PIO Data-in */
2731 case 5: /* PIO Data-out */
2732 return ATA_PROT_PIO;
2733
2734 case 0: /* Hard Reset */
2735 case 1: /* SRST */
2736 case 8: /* Device Diagnostic */
2737 case 9: /* Device Reset */
2738 case 7: /* DMA Queued */
2739 case 12: /* FPDMA */
2740 case 15: /* Return Response Info */
2741 default: /* Reserved */
2742 break;
2743 }
2744
2745 return ATA_PROT_UNKNOWN;
2746 }
2747
2748 /**
2749 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2750 * @qc: command structure to be initialized
2751 *
2752 * Handles either 12 or 16-byte versions of the CDB.
2753 *
2754 * RETURNS:
2755 * Zero on success, non-zero on failure.
2756 */
2757 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2758 {
2759 struct ata_taskfile *tf = &(qc->tf);
2760 struct scsi_cmnd *scmd = qc->scsicmd;
2761 struct ata_device *dev = qc->dev;
2762 const u8 *cdb = scmd->cmnd;
2763
2764 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2765 goto invalid_fld;
2766
2767 /*
2768 * 12 and 16 byte CDBs use different offsets to
2769 * provide the various register values.
2770 */
2771 if (cdb[0] == ATA_16) {
2772 /*
2773 * 16-byte CDB - may contain extended commands.
2774 *
2775 * If that is the case, copy the upper byte register values.
2776 */
2777 if (cdb[1] & 0x01) {
2778 tf->hob_feature = cdb[3];
2779 tf->hob_nsect = cdb[5];
2780 tf->hob_lbal = cdb[7];
2781 tf->hob_lbam = cdb[9];
2782 tf->hob_lbah = cdb[11];
2783 tf->flags |= ATA_TFLAG_LBA48;
2784 } else
2785 tf->flags &= ~ATA_TFLAG_LBA48;
2786
2787 /*
2788 * Always copy low byte, device and command registers.
2789 */
2790 tf->feature = cdb[4];
2791 tf->nsect = cdb[6];
2792 tf->lbal = cdb[8];
2793 tf->lbam = cdb[10];
2794 tf->lbah = cdb[12];
2795 tf->device = cdb[13];
2796 tf->command = cdb[14];
2797 } else {
2798 /*
2799 * 12-byte CDB - incapable of extended commands.
2800 */
2801 tf->flags &= ~ATA_TFLAG_LBA48;
2802
2803 tf->feature = cdb[3];
2804 tf->nsect = cdb[4];
2805 tf->lbal = cdb[5];
2806 tf->lbam = cdb[6];
2807 tf->lbah = cdb[7];
2808 tf->device = cdb[8];
2809 tf->command = cdb[9];
2810 }
2811
2812 /* enforce correct master/slave bit */
2813 tf->device = dev->devno ?
2814 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2815
2816 /* READ/WRITE LONG use a non-standard sect_size */
2817 qc->sect_size = ATA_SECT_SIZE;
2818 switch (tf->command) {
2819 case ATA_CMD_READ_LONG:
2820 case ATA_CMD_READ_LONG_ONCE:
2821 case ATA_CMD_WRITE_LONG:
2822 case ATA_CMD_WRITE_LONG_ONCE:
2823 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2824 goto invalid_fld;
2825 qc->sect_size = scsi_bufflen(scmd);
2826 }
2827
2828 /*
2829 * Set flags so that all registers will be written, pass on
2830 * write indication (used for PIO/DMA setup), result TF is
2831 * copied back and we don't whine too much about its failure.
2832 */
2833 tf->flags = ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2834 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2835 tf->flags |= ATA_TFLAG_WRITE;
2836
2837 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2838
2839 /*
2840 * Set transfer length.
2841 *
2842 * TODO: find out if we need to do more here to
2843 * cover scatter/gather case.
2844 */
2845 ata_qc_set_pc_nbytes(qc);
2846
2847 /* We may not issue DMA commands if no DMA mode is set */
2848 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2849 goto invalid_fld;
2850
2851 /* sanity check for pio multi commands */
2852 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2853 goto invalid_fld;
2854
2855 if (is_multi_taskfile(tf)) {
2856 unsigned int multi_count = 1 << (cdb[1] >> 5);
2857
2858 /* compare the passed through multi_count
2859 * with the cached multi_count of libata
2860 */
2861 if (multi_count != dev->multi_count)
2862 ata_dev_printk(dev, KERN_WARNING,
2863 "invalid multi_count %u ignored\n",
2864 multi_count);
2865 }
2866
2867 /*
2868 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2869 * SET_FEATURES - XFER MODE must be preceded/succeeded
2870 * by an update to hardware-specific registers for each
2871 * controller (i.e. the reason for ->set_piomode(),
2872 * ->set_dmamode(), and ->post_set_mode() hooks).
2873 */
2874 if (tf->command == ATA_CMD_SET_FEATURES &&
2875 tf->feature == SETFEATURES_XFER)
2876 goto invalid_fld;
2877
2878 /*
2879 * Filter TPM commands by default. These provide an
2880 * essentially uncontrolled encrypted "back door" between
2881 * applications and the disk. Set libata.allow_tpm=1 if you
2882 * have a real reason for wanting to use them. This ensures
2883 * that installed software cannot easily mess stuff up without
2884 * user intent. DVR type users will probably ship with this enabled
2885 * for movie content management.
2886 *
2887 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2888 * for this and should do in future but that it is not sufficient as
2889 * DCS is an optional feature set. Thus we also do the software filter
2890 * so that we comply with the TC consortium stated goal that the user
2891 * can turn off TC features of their system.
2892 */
2893 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2894 goto invalid_fld;
2895
2896 return 0;
2897
2898 invalid_fld:
2899 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2900 /* "Invalid field in cdb" */
2901 return 1;
2902 }
2903
2904 /**
2905 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2906 * @dev: ATA device
2907 * @cmd: SCSI command opcode to consider
2908 *
2909 * Look up the SCSI command given, and determine whether the
2910 * SCSI command is to be translated or simulated.
2911 *
2912 * RETURNS:
2913 * Pointer to translation function if possible, %NULL if not.
2914 */
2915
2916 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2917 {
2918 switch (cmd) {
2919 case READ_6:
2920 case READ_10:
2921 case READ_16:
2922
2923 case WRITE_6:
2924 case WRITE_10:
2925 case WRITE_16:
2926 return ata_scsi_rw_xlat;
2927
2928 case SYNCHRONIZE_CACHE:
2929 if (ata_try_flush_cache(dev))
2930 return ata_scsi_flush_xlat;
2931 break;
2932
2933 case VERIFY:
2934 case VERIFY_16:
2935 return ata_scsi_verify_xlat;
2936
2937 case ATA_12:
2938 case ATA_16:
2939 return ata_scsi_pass_thru;
2940
2941 case START_STOP:
2942 return ata_scsi_start_stop_xlat;
2943 }
2944
2945 return NULL;
2946 }
2947
2948 /**
2949 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2950 * @ap: ATA port to which the command was being sent
2951 * @cmd: SCSI command to dump
2952 *
2953 * Prints the contents of a SCSI command via printk().
2954 */
2955
2956 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2957 struct scsi_cmnd *cmd)
2958 {
2959 #ifdef ATA_DEBUG
2960 struct scsi_device *scsidev = cmd->device;
2961 u8 *scsicmd = cmd->cmnd;
2962
2963 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2964 ap->print_id,
2965 scsidev->channel, scsidev->id, scsidev->lun,
2966 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2967 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2968 scsicmd[8]);
2969 #endif
2970 }
2971
2972 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2973 void (*done)(struct scsi_cmnd *),
2974 struct ata_device *dev)
2975 {
2976 u8 scsi_op = scmd->cmnd[0];
2977 ata_xlat_func_t xlat_func;
2978 int rc = 0;
2979
2980 if (dev->class == ATA_DEV_ATA) {
2981 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
2982 goto bad_cdb_len;
2983
2984 xlat_func = ata_get_xlat_func(dev, scsi_op);
2985 } else {
2986 if (unlikely(!scmd->cmd_len))
2987 goto bad_cdb_len;
2988
2989 xlat_func = NULL;
2990 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
2991 /* relay SCSI command to ATAPI device */
2992 int len = COMMAND_SIZE(scsi_op);
2993 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
2994 goto bad_cdb_len;
2995
2996 xlat_func = atapi_xlat;
2997 } else {
2998 /* ATA_16 passthru, treat as an ATA command */
2999 if (unlikely(scmd->cmd_len > 16))
3000 goto bad_cdb_len;
3001
3002 xlat_func = ata_get_xlat_func(dev, scsi_op);
3003 }
3004 }
3005
3006 if (xlat_func)
3007 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
3008 else
3009 ata_scsi_simulate(dev, scmd, done);
3010
3011 return rc;
3012
3013 bad_cdb_len:
3014 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3015 scmd->cmd_len, scsi_op, dev->cdb_len);
3016 scmd->result = DID_ERROR << 16;
3017 done(scmd);
3018 return 0;
3019 }
3020
3021 /**
3022 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3023 * @cmd: SCSI command to be sent
3024 * @done: Completion function, called when command is complete
3025 *
3026 * In some cases, this function translates SCSI commands into
3027 * ATA taskfiles, and queues the taskfiles to be sent to
3028 * hardware. In other cases, this function simulates a
3029 * SCSI device by evaluating and responding to certain
3030 * SCSI commands. This creates the overall effect of
3031 * ATA and ATAPI devices appearing as SCSI devices.
3032 *
3033 * LOCKING:
3034 * Releases scsi-layer-held lock, and obtains host lock.
3035 *
3036 * RETURNS:
3037 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3038 * 0 otherwise.
3039 */
3040 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3041 {
3042 struct ata_port *ap;
3043 struct ata_device *dev;
3044 struct scsi_device *scsidev = cmd->device;
3045 struct Scsi_Host *shost = scsidev->host;
3046 int rc = 0;
3047
3048 ap = ata_shost_to_port(shost);
3049
3050 spin_unlock(shost->host_lock);
3051 spin_lock(ap->lock);
3052
3053 ata_scsi_dump_cdb(ap, cmd);
3054
3055 dev = ata_scsi_find_dev(ap, scsidev);
3056 if (likely(dev))
3057 rc = __ata_scsi_queuecmd(cmd, done, dev);
3058 else {
3059 cmd->result = (DID_BAD_TARGET << 16);
3060 done(cmd);
3061 }
3062
3063 spin_unlock(ap->lock);
3064 spin_lock(shost->host_lock);
3065 return rc;
3066 }
3067
3068 /**
3069 * ata_scsi_simulate - simulate SCSI command on ATA device
3070 * @dev: the target device
3071 * @cmd: SCSI command being sent to device.
3072 * @done: SCSI command completion function.
3073 *
3074 * Interprets and directly executes a select list of SCSI commands
3075 * that can be handled internally.
3076 *
3077 * LOCKING:
3078 * spin_lock_irqsave(host lock)
3079 */
3080
3081 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3082 void (*done)(struct scsi_cmnd *))
3083 {
3084 struct ata_scsi_args args;
3085 const u8 *scsicmd = cmd->cmnd;
3086 u8 tmp8;
3087
3088 args.dev = dev;
3089 args.id = dev->id;
3090 args.cmd = cmd;
3091 args.done = done;
3092
3093 switch(scsicmd[0]) {
3094 /* TODO: worth improving? */
3095 case FORMAT_UNIT:
3096 ata_scsi_invalid_field(cmd, done);
3097 break;
3098
3099 case INQUIRY:
3100 if (scsicmd[1] & 2) /* is CmdDt set? */
3101 ata_scsi_invalid_field(cmd, done);
3102 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3103 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3104 else switch (scsicmd[2]) {
3105 case 0x00:
3106 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3107 break;
3108 case 0x80:
3109 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3110 break;
3111 case 0x83:
3112 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3113 break;
3114 case 0x89:
3115 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3116 break;
3117 case 0xb1:
3118 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
3119 break;
3120 default:
3121 ata_scsi_invalid_field(cmd, done);
3122 break;
3123 }
3124 break;
3125
3126 case MODE_SENSE:
3127 case MODE_SENSE_10:
3128 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3129 break;
3130
3131 case MODE_SELECT: /* unconditionally return */
3132 case MODE_SELECT_10: /* bad-field-in-cdb */
3133 ata_scsi_invalid_field(cmd, done);
3134 break;
3135
3136 case READ_CAPACITY:
3137 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3138 break;
3139
3140 case SERVICE_ACTION_IN:
3141 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3142 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3143 else
3144 ata_scsi_invalid_field(cmd, done);
3145 break;
3146
3147 case REPORT_LUNS:
3148 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3149 break;
3150
3151 case REQUEST_SENSE:
3152 ata_scsi_set_sense(cmd, 0, 0, 0);
3153 cmd->result = (DRIVER_SENSE << 24);
3154 done(cmd);
3155 break;
3156
3157 /* if we reach this, then writeback caching is disabled,
3158 * turning this into a no-op.
3159 */
3160 case SYNCHRONIZE_CACHE:
3161 /* fall through */
3162
3163 /* no-op's, complete with success */
3164 case REZERO_UNIT:
3165 case SEEK_6:
3166 case SEEK_10:
3167 case TEST_UNIT_READY:
3168 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3169 break;
3170
3171 case SEND_DIAGNOSTIC:
3172 tmp8 = scsicmd[1] & ~(1 << 3);
3173 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3174 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3175 else
3176 ata_scsi_invalid_field(cmd, done);
3177 break;
3178
3179 /* all other commands */
3180 default:
3181 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3182 /* "Invalid command operation code" */
3183 done(cmd);
3184 break;
3185 }
3186 }
3187
3188 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3189 {
3190 int i, rc;
3191
3192 for (i = 0; i < host->n_ports; i++) {
3193 struct ata_port *ap = host->ports[i];
3194 struct Scsi_Host *shost;
3195
3196 rc = -ENOMEM;
3197 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3198 if (!shost)
3199 goto err_alloc;
3200
3201 *(struct ata_port **)&shost->hostdata[0] = ap;
3202 ap->scsi_host = shost;
3203
3204 shost->transportt = &ata_scsi_transport_template;
3205 shost->unique_id = ap->print_id;
3206 shost->max_id = 16;
3207 shost->max_lun = 1;
3208 shost->max_channel = 1;
3209 shost->max_cmd_len = 16;
3210
3211 /* Schedule policy is determined by ->qc_defer()
3212 * callback and it needs to see every deferred qc.
3213 * Set host_blocked to 1 to prevent SCSI midlayer from
3214 * automatically deferring requests.
3215 */
3216 shost->max_host_blocked = 1;
3217
3218 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3219 if (rc)
3220 goto err_add;
3221 }
3222
3223 return 0;
3224
3225 err_add:
3226 scsi_host_put(host->ports[i]->scsi_host);
3227 err_alloc:
3228 while (--i >= 0) {
3229 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3230
3231 scsi_remove_host(shost);
3232 scsi_host_put(shost);
3233 }
3234 return rc;
3235 }
3236
3237 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3238 {
3239 int tries = 5;
3240 struct ata_device *last_failed_dev = NULL;
3241 struct ata_link *link;
3242 struct ata_device *dev;
3243
3244 if (ap->flags & ATA_FLAG_DISABLED)
3245 return;
3246
3247 repeat:
3248 ata_for_each_link(link, ap, EDGE) {
3249 ata_for_each_dev(dev, link, ENABLED) {
3250 struct scsi_device *sdev;
3251 int channel = 0, id = 0;
3252
3253 if (dev->sdev)
3254 continue;
3255
3256 if (ata_is_host_link(link))
3257 id = dev->devno;
3258 else
3259 channel = link->pmp;
3260
3261 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3262 NULL);
3263 if (!IS_ERR(sdev)) {
3264 dev->sdev = sdev;
3265 scsi_device_put(sdev);
3266 }
3267 }
3268 }
3269
3270 /* If we scanned while EH was in progress or allocation
3271 * failure occurred, scan would have failed silently. Check
3272 * whether all devices are attached.
3273 */
3274 ata_for_each_link(link, ap, EDGE) {
3275 ata_for_each_dev(dev, link, ENABLED) {
3276 if (!dev->sdev)
3277 goto exit_loop;
3278 }
3279 }
3280 exit_loop:
3281 if (!link)
3282 return;
3283
3284 /* we're missing some SCSI devices */
3285 if (sync) {
3286 /* If caller requested synchrnous scan && we've made
3287 * any progress, sleep briefly and repeat.
3288 */
3289 if (dev != last_failed_dev) {
3290 msleep(100);
3291 last_failed_dev = dev;
3292 goto repeat;
3293 }
3294
3295 /* We might be failing to detect boot device, give it
3296 * a few more chances.
3297 */
3298 if (--tries) {
3299 msleep(100);
3300 goto repeat;
3301 }
3302
3303 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3304 "failed without making any progress,\n"
3305 " switching to async\n");
3306 }
3307
3308 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3309 round_jiffies_relative(HZ));
3310 }
3311
3312 /**
3313 * ata_scsi_offline_dev - offline attached SCSI device
3314 * @dev: ATA device to offline attached SCSI device for
3315 *
3316 * This function is called from ata_eh_hotplug() and responsible
3317 * for taking the SCSI device attached to @dev offline. This
3318 * function is called with host lock which protects dev->sdev
3319 * against clearing.
3320 *
3321 * LOCKING:
3322 * spin_lock_irqsave(host lock)
3323 *
3324 * RETURNS:
3325 * 1 if attached SCSI device exists, 0 otherwise.
3326 */
3327 int ata_scsi_offline_dev(struct ata_device *dev)
3328 {
3329 if (dev->sdev) {
3330 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3331 return 1;
3332 }
3333 return 0;
3334 }
3335
3336 /**
3337 * ata_scsi_remove_dev - remove attached SCSI device
3338 * @dev: ATA device to remove attached SCSI device for
3339 *
3340 * This function is called from ata_eh_scsi_hotplug() and
3341 * responsible for removing the SCSI device attached to @dev.
3342 *
3343 * LOCKING:
3344 * Kernel thread context (may sleep).
3345 */
3346 static void ata_scsi_remove_dev(struct ata_device *dev)
3347 {
3348 struct ata_port *ap = dev->link->ap;
3349 struct scsi_device *sdev;
3350 unsigned long flags;
3351
3352 /* Alas, we need to grab scan_mutex to ensure SCSI device
3353 * state doesn't change underneath us and thus
3354 * scsi_device_get() always succeeds. The mutex locking can
3355 * be removed if there is __scsi_device_get() interface which
3356 * increments reference counts regardless of device state.
3357 */
3358 mutex_lock(&ap->scsi_host->scan_mutex);
3359 spin_lock_irqsave(ap->lock, flags);
3360
3361 /* clearing dev->sdev is protected by host lock */
3362 sdev = dev->sdev;
3363 dev->sdev = NULL;
3364
3365 if (sdev) {
3366 /* If user initiated unplug races with us, sdev can go
3367 * away underneath us after the host lock and
3368 * scan_mutex are released. Hold onto it.
3369 */
3370 if (scsi_device_get(sdev) == 0) {
3371 /* The following ensures the attached sdev is
3372 * offline on return from ata_scsi_offline_dev()
3373 * regardless it wins or loses the race
3374 * against this function.
3375 */
3376 scsi_device_set_state(sdev, SDEV_OFFLINE);
3377 } else {
3378 WARN_ON(1);
3379 sdev = NULL;
3380 }
3381 }
3382
3383 spin_unlock_irqrestore(ap->lock, flags);
3384 mutex_unlock(&ap->scsi_host->scan_mutex);
3385
3386 if (sdev) {
3387 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3388 dev_name(&sdev->sdev_gendev));
3389
3390 scsi_remove_device(sdev);
3391 scsi_device_put(sdev);
3392 }
3393 }
3394
3395 static void ata_scsi_handle_link_detach(struct ata_link *link)
3396 {
3397 struct ata_port *ap = link->ap;
3398 struct ata_device *dev;
3399
3400 ata_for_each_dev(dev, link, ALL) {
3401 unsigned long flags;
3402
3403 if (!(dev->flags & ATA_DFLAG_DETACHED))
3404 continue;
3405
3406 spin_lock_irqsave(ap->lock, flags);
3407 dev->flags &= ~ATA_DFLAG_DETACHED;
3408 spin_unlock_irqrestore(ap->lock, flags);
3409
3410 ata_scsi_remove_dev(dev);
3411 }
3412 }
3413
3414 /**
3415 * ata_scsi_media_change_notify - send media change event
3416 * @dev: Pointer to the disk device with media change event
3417 *
3418 * Tell the block layer to send a media change notification
3419 * event.
3420 *
3421 * LOCKING:
3422 * spin_lock_irqsave(host lock)
3423 */
3424 void ata_scsi_media_change_notify(struct ata_device *dev)
3425 {
3426 if (dev->sdev)
3427 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3428 GFP_ATOMIC);
3429 }
3430
3431 /**
3432 * ata_scsi_hotplug - SCSI part of hotplug
3433 * @work: Pointer to ATA port to perform SCSI hotplug on
3434 *
3435 * Perform SCSI part of hotplug. It's executed from a separate
3436 * workqueue after EH completes. This is necessary because SCSI
3437 * hot plugging requires working EH and hot unplugging is
3438 * synchronized with hot plugging with a mutex.
3439 *
3440 * LOCKING:
3441 * Kernel thread context (may sleep).
3442 */
3443 void ata_scsi_hotplug(struct work_struct *work)
3444 {
3445 struct ata_port *ap =
3446 container_of(work, struct ata_port, hotplug_task.work);
3447 int i;
3448
3449 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3450 DPRINTK("ENTER/EXIT - unloading\n");
3451 return;
3452 }
3453
3454 DPRINTK("ENTER\n");
3455
3456 /* Unplug detached devices. We cannot use link iterator here
3457 * because PMP links have to be scanned even if PMP is
3458 * currently not attached. Iterate manually.
3459 */
3460 ata_scsi_handle_link_detach(&ap->link);
3461 if (ap->pmp_link)
3462 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3463 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3464
3465 /* scan for new ones */
3466 ata_scsi_scan_host(ap, 0);
3467
3468 DPRINTK("EXIT\n");
3469 }
3470
3471 /**
3472 * ata_scsi_user_scan - indication for user-initiated bus scan
3473 * @shost: SCSI host to scan
3474 * @channel: Channel to scan
3475 * @id: ID to scan
3476 * @lun: LUN to scan
3477 *
3478 * This function is called when user explicitly requests bus
3479 * scan. Set probe pending flag and invoke EH.
3480 *
3481 * LOCKING:
3482 * SCSI layer (we don't care)
3483 *
3484 * RETURNS:
3485 * Zero.
3486 */
3487 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3488 unsigned int id, unsigned int lun)
3489 {
3490 struct ata_port *ap = ata_shost_to_port(shost);
3491 unsigned long flags;
3492 int devno, rc = 0;
3493
3494 if (!ap->ops->error_handler)
3495 return -EOPNOTSUPP;
3496
3497 if (lun != SCAN_WILD_CARD && lun)
3498 return -EINVAL;
3499
3500 if (!sata_pmp_attached(ap)) {
3501 if (channel != SCAN_WILD_CARD && channel)
3502 return -EINVAL;
3503 devno = id;
3504 } else {
3505 if (id != SCAN_WILD_CARD && id)
3506 return -EINVAL;
3507 devno = channel;
3508 }
3509
3510 spin_lock_irqsave(ap->lock, flags);
3511
3512 if (devno == SCAN_WILD_CARD) {
3513 struct ata_link *link;
3514
3515 ata_for_each_link(link, ap, EDGE) {
3516 struct ata_eh_info *ehi = &link->eh_info;
3517 ehi->probe_mask |= ATA_ALL_DEVICES;
3518 ehi->action |= ATA_EH_RESET;
3519 }
3520 } else {
3521 struct ata_device *dev = ata_find_dev(ap, devno);
3522
3523 if (dev) {
3524 struct ata_eh_info *ehi = &dev->link->eh_info;
3525 ehi->probe_mask |= 1 << dev->devno;
3526 ehi->action |= ATA_EH_RESET;
3527 } else
3528 rc = -EINVAL;
3529 }
3530
3531 if (rc == 0) {
3532 ata_port_schedule_eh(ap);
3533 spin_unlock_irqrestore(ap->lock, flags);
3534 ata_port_wait_eh(ap);
3535 } else
3536 spin_unlock_irqrestore(ap->lock, flags);
3537
3538 return rc;
3539 }
3540
3541 /**
3542 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3543 * @work: Pointer to ATA port to perform scsi_rescan_device()
3544 *
3545 * After ATA pass thru (SAT) commands are executed successfully,
3546 * libata need to propagate the changes to SCSI layer. This
3547 * function must be executed from ata_aux_wq such that sdev
3548 * attach/detach don't race with rescan.
3549 *
3550 * LOCKING:
3551 * Kernel thread context (may sleep).
3552 */
3553 void ata_scsi_dev_rescan(struct work_struct *work)
3554 {
3555 struct ata_port *ap =
3556 container_of(work, struct ata_port, scsi_rescan_task);
3557 struct ata_link *link;
3558 struct ata_device *dev;
3559 unsigned long flags;
3560
3561 spin_lock_irqsave(ap->lock, flags);
3562
3563 ata_for_each_link(link, ap, EDGE) {
3564 ata_for_each_dev(dev, link, ENABLED) {
3565 struct scsi_device *sdev = dev->sdev;
3566
3567 if (!sdev)
3568 continue;
3569 if (scsi_device_get(sdev))
3570 continue;
3571
3572 spin_unlock_irqrestore(ap->lock, flags);
3573 scsi_rescan_device(&(sdev->sdev_gendev));
3574 scsi_device_put(sdev);
3575 spin_lock_irqsave(ap->lock, flags);
3576 }
3577 }
3578
3579 spin_unlock_irqrestore(ap->lock, flags);
3580 }
3581
3582 /**
3583 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3584 * @host: ATA host container for all SAS ports
3585 * @port_info: Information from low-level host driver
3586 * @shost: SCSI host that the scsi device is attached to
3587 *
3588 * LOCKING:
3589 * PCI/etc. bus probe sem.
3590 *
3591 * RETURNS:
3592 * ata_port pointer on success / NULL on failure.
3593 */
3594
3595 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3596 struct ata_port_info *port_info,
3597 struct Scsi_Host *shost)
3598 {
3599 struct ata_port *ap;
3600
3601 ap = ata_port_alloc(host);
3602 if (!ap)
3603 return NULL;
3604
3605 ap->port_no = 0;
3606 ap->lock = shost->host_lock;
3607 ap->pio_mask = port_info->pio_mask;
3608 ap->mwdma_mask = port_info->mwdma_mask;
3609 ap->udma_mask = port_info->udma_mask;
3610 ap->flags |= port_info->flags;
3611 ap->ops = port_info->port_ops;
3612 ap->cbl = ATA_CBL_SATA;
3613
3614 return ap;
3615 }
3616 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3617
3618 /**
3619 * ata_sas_port_start - Set port up for dma.
3620 * @ap: Port to initialize
3621 *
3622 * Called just after data structures for each port are
3623 * initialized.
3624 *
3625 * May be used as the port_start() entry in ata_port_operations.
3626 *
3627 * LOCKING:
3628 * Inherited from caller.
3629 */
3630 int ata_sas_port_start(struct ata_port *ap)
3631 {
3632 return 0;
3633 }
3634 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3635
3636 /**
3637 * ata_port_stop - Undo ata_sas_port_start()
3638 * @ap: Port to shut down
3639 *
3640 * May be used as the port_stop() entry in ata_port_operations.
3641 *
3642 * LOCKING:
3643 * Inherited from caller.
3644 */
3645
3646 void ata_sas_port_stop(struct ata_port *ap)
3647 {
3648 }
3649 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3650
3651 /**
3652 * ata_sas_port_init - Initialize a SATA device
3653 * @ap: SATA port to initialize
3654 *
3655 * LOCKING:
3656 * PCI/etc. bus probe sem.
3657 *
3658 * RETURNS:
3659 * Zero on success, non-zero on error.
3660 */
3661
3662 int ata_sas_port_init(struct ata_port *ap)
3663 {
3664 int rc = ap->ops->port_start(ap);
3665
3666 if (!rc) {
3667 ap->print_id = ata_print_id++;
3668 rc = ata_bus_probe(ap);
3669 }
3670
3671 return rc;
3672 }
3673 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3674
3675 /**
3676 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3677 * @ap: SATA port to destroy
3678 *
3679 */
3680
3681 void ata_sas_port_destroy(struct ata_port *ap)
3682 {
3683 if (ap->ops->port_stop)
3684 ap->ops->port_stop(ap);
3685 kfree(ap);
3686 }
3687 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3688
3689 /**
3690 * ata_sas_slave_configure - Default slave_config routine for libata devices
3691 * @sdev: SCSI device to configure
3692 * @ap: ATA port to which SCSI device is attached
3693 *
3694 * RETURNS:
3695 * Zero.
3696 */
3697
3698 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3699 {
3700 ata_scsi_sdev_config(sdev);
3701 ata_scsi_dev_config(sdev, ap->link.device);
3702 return 0;
3703 }
3704 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3705
3706 /**
3707 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3708 * @cmd: SCSI command to be sent
3709 * @done: Completion function, called when command is complete
3710 * @ap: ATA port to which the command is being sent
3711 *
3712 * RETURNS:
3713 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3714 * 0 otherwise.
3715 */
3716
3717 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3718 struct ata_port *ap)
3719 {
3720 int rc = 0;
3721
3722 ata_scsi_dump_cdb(ap, cmd);
3723
3724 if (likely(ata_dev_enabled(ap->link.device)))
3725 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3726 else {
3727 cmd->result = (DID_BAD_TARGET << 16);
3728 done(cmd);
3729 }
3730 return rc;
3731 }
3732 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
Linux kernel - Deliverables
This page took 0.111098 seconds and 5 git commands to generate.