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