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