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