blob: 2c644cbb6e9c4bb966a9bbeb217597490e03a703 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 */
35
36#include <linux/kernel.h>
37#include <linux/blkdev.h>
38#include <linux/spinlock.h>
39#include <scsi/scsi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <scsi/scsi_host.h>
Mike Christie85837eb2005-11-11 16:38:53 -060041#include <scsi/scsi_eh.h>
Jeff Garzik005a5a02005-10-30 23:31:48 -050042#include <scsi/scsi_device.h>
Jeff Garzik193515d2005-11-07 00:59:37 -050043#include <scsi/scsi_request.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/libata.h>
Jeff Garzikb0955182005-05-12 15:45:22 -040045#include <linux/hdreg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <asm/uaccess.h>
47
48#include "libata.h"
49
Jeff Garzikb0955182005-05-12 15:45:22 -040050#define SECTOR_SIZE 512
51
Jeff Garzik057ace52005-10-22 14:27:05 -040052typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -040054ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040056#define RW_RECOVERY_MPAGE 0x1
57#define RW_RECOVERY_MPAGE_LEN 12
58#define CACHE_MPAGE 0x8
59#define CACHE_MPAGE_LEN 20
60#define CONTROL_MPAGE 0xa
61#define CONTROL_MPAGE_LEN 12
62#define ALL_MPAGES 0x3f
63#define ALL_SUB_MPAGES 0xff
64
65
66static const u8 def_rw_recovery_mpage[] = {
67 RW_RECOVERY_MPAGE,
68 RW_RECOVERY_MPAGE_LEN - 2,
69 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
70 (1 << 6), /* ARRE (auto read reallocation) */
71 0, /* read retry count */
72 0, 0, 0, 0,
73 0, /* write retry count */
74 0, 0, 0
75};
76
77static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
78 CACHE_MPAGE,
79 CACHE_MPAGE_LEN - 2,
80 0, /* contains WCE, needs to be 0 for logic */
81 0, 0, 0, 0, 0, 0, 0, 0, 0,
82 0, /* contains DRA, needs to be 0 for logic */
83 0, 0, 0, 0, 0, 0, 0
84};
85
86static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
87 CONTROL_MPAGE,
88 CONTROL_MPAGE_LEN - 2,
89 2, /* DSENSE=0, GLTSD=1 */
90 0, /* [QAM+QERR may be 1, see 05-359r1] */
91 0, 0, 0, 0, 0xff, 0xff,
92 0, 30 /* extended self test time, see 05-359r1 */
93};
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Douglas Gilbertae006512005-10-09 09:09:35 -040096static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
97 void (*done)(struct scsi_cmnd *))
98{
99 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
100 /* "Invalid field in cbd" */
101 done(cmd);
102}
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104/**
105 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
106 * @sdev: SCSI device for which BIOS geometry is to be determined
107 * @bdev: block device associated with @sdev
108 * @capacity: capacity of SCSI device
109 * @geom: location to which geometry will be output
110 *
111 * Generic bios head/sector/cylinder calculator
112 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
113 * mapping. Some situations may arise where the disk is not
114 * bootable if this is not used.
115 *
116 * LOCKING:
117 * Defined by the SCSI layer. We don't really care.
118 *
119 * RETURNS:
120 * Zero.
121 */
122int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
123 sector_t capacity, int geom[])
124{
125 geom[0] = 255;
126 geom[1] = 63;
127 sector_div(capacity, 255*63);
128 geom[2] = capacity;
129
130 return 0;
131}
132
Jeff Garzikb0955182005-05-12 15:45:22 -0400133/**
134 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800135 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400136 * @arg: User provided data for issuing command
137 *
138 * LOCKING:
139 * Defined by the SCSI layer. We don't really care.
140 *
141 * RETURNS:
142 * Zero on success, negative errno on error.
143 */
144
145int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
146{
147 int rc = 0;
148 u8 scsi_cmd[MAX_COMMAND_SIZE];
149 u8 args[4], *argbuf = NULL;
150 int argsize = 0;
Mike Christie85837eb2005-11-11 16:38:53 -0600151 struct scsi_sense_hdr sshdr;
152 enum dma_data_direction data_dir;
Jeff Garzikb0955182005-05-12 15:45:22 -0400153
154 if (NULL == (void *)arg)
155 return -EINVAL;
156
157 if (copy_from_user(args, arg, sizeof(args)))
158 return -EFAULT;
159
Jeff Garzikb0955182005-05-12 15:45:22 -0400160 memset(scsi_cmd, 0, sizeof(scsi_cmd));
161
162 if (args[3]) {
163 argsize = SECTOR_SIZE * args[3];
164 argbuf = kmalloc(argsize, GFP_KERNEL);
Jeff Raubitschek54dac832005-10-04 10:21:19 -0400165 if (argbuf == NULL) {
166 rc = -ENOMEM;
167 goto error;
168 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400169
170 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
171 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
172 block count in sector count field */
Mike Christie85837eb2005-11-11 16:38:53 -0600173 data_dir = DMA_FROM_DEVICE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400174 } else {
175 scsi_cmd[1] = (3 << 1); /* Non-data */
176 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
Mike Christie85837eb2005-11-11 16:38:53 -0600177 data_dir = DMA_NONE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400178 }
179
180 scsi_cmd[0] = ATA_16;
181
182 scsi_cmd[4] = args[2];
183 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
184 scsi_cmd[6] = args[3];
185 scsi_cmd[8] = args[1];
186 scsi_cmd[10] = 0x4f;
187 scsi_cmd[12] = 0xc2;
188 } else {
189 scsi_cmd[6] = args[1];
190 }
191 scsi_cmd[14] = args[0];
192
193 /* Good values for timeout and retries? Values below
194 from scsi_ioctl_send_command() for default case... */
Mike Christie85837eb2005-11-11 16:38:53 -0600195 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
196 &sshdr, (10*HZ), 5)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400197 rc = -EIO;
198 goto error;
199 }
200
201 /* Need code to retrieve data from check condition? */
202
203 if ((argbuf)
204 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
205 rc = -EFAULT;
206error:
Jeff Garzikb0955182005-05-12 15:45:22 -0400207 if (argbuf)
208 kfree(argbuf);
209
210 return rc;
211}
212
213/**
214 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800215 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400216 * @arg: User provided data for issuing command
217 *
218 * LOCKING:
219 * Defined by the SCSI layer. We don't really care.
220 *
221 * RETURNS:
222 * Zero on success, negative errno on error.
223 */
224int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
225{
226 int rc = 0;
227 u8 scsi_cmd[MAX_COMMAND_SIZE];
228 u8 args[7];
Mike Christie85837eb2005-11-11 16:38:53 -0600229 struct scsi_sense_hdr sshdr;
Jeff Garzikb0955182005-05-12 15:45:22 -0400230
231 if (NULL == (void *)arg)
232 return -EINVAL;
233
234 if (copy_from_user(args, arg, sizeof(args)))
235 return -EFAULT;
236
237 memset(scsi_cmd, 0, sizeof(scsi_cmd));
238 scsi_cmd[0] = ATA_16;
239 scsi_cmd[1] = (3 << 1); /* Non-data */
240 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
241 scsi_cmd[4] = args[1];
242 scsi_cmd[6] = args[2];
243 scsi_cmd[8] = args[3];
244 scsi_cmd[10] = args[4];
245 scsi_cmd[12] = args[5];
246 scsi_cmd[14] = args[0];
247
Jeff Garzikb0955182005-05-12 15:45:22 -0400248 /* Good values for timeout and retries? Values below
Mike Christie85837eb2005-11-11 16:38:53 -0600249 from scsi_ioctl_send_command() for default case... */
250 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
251 (10*HZ), 5))
Jeff Garzikb0955182005-05-12 15:45:22 -0400252 rc = -EIO;
Jeff Garzikb0955182005-05-12 15:45:22 -0400253
254 /* Need code to retrieve data from check condition? */
Jeff Garzikb0955182005-05-12 15:45:22 -0400255 return rc;
256}
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
259{
260 struct ata_port *ap;
261 struct ata_device *dev;
262 int val = -EINVAL, rc = -EINVAL;
263
264 ap = (struct ata_port *) &scsidev->host->hostdata[0];
265 if (!ap)
266 goto out;
267
268 dev = ata_scsi_find_dev(ap, scsidev);
269 if (!dev) {
270 rc = -ENODEV;
271 goto out;
272 }
273
274 switch (cmd) {
275 case ATA_IOC_GET_IO32:
276 val = 0;
277 if (copy_to_user(arg, &val, 1))
278 return -EFAULT;
279 return 0;
280
281 case ATA_IOC_SET_IO32:
282 val = (unsigned long) arg;
283 if (val != 0)
284 return -EINVAL;
285 return 0;
286
Jeff Garzikb0955182005-05-12 15:45:22 -0400287 case HDIO_DRIVE_CMD:
288 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
289 return -EACCES;
290 return ata_cmd_ioctl(scsidev, arg);
291
292 case HDIO_DRIVE_TASK:
293 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
294 return -EACCES;
295 return ata_task_ioctl(scsidev, arg);
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 default:
298 rc = -ENOTTY;
299 break;
300 }
301
302out:
303 return rc;
304}
305
306/**
307 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
308 * @ap: ATA port to which the new command is attached
309 * @dev: ATA device to which the new command is attached
310 * @cmd: SCSI command that originated this ATA command
311 * @done: SCSI command completion function
312 *
313 * Obtain a reference to an unused ata_queued_cmd structure,
314 * which is the basic libata structure representing a single
315 * ATA command sent to the hardware.
316 *
317 * If a command was available, fill in the SCSI-specific
318 * portions of the structure with information on the
319 * current command.
320 *
321 * LOCKING:
322 * spin_lock_irqsave(host_set lock)
323 *
324 * RETURNS:
325 * Command allocated, or %NULL if none available.
326 */
327struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
328 struct ata_device *dev,
329 struct scsi_cmnd *cmd,
330 void (*done)(struct scsi_cmnd *))
331{
332 struct ata_queued_cmd *qc;
333
334 qc = ata_qc_new_init(ap, dev);
335 if (qc) {
336 qc->scsicmd = cmd;
337 qc->scsidone = done;
338
339 if (cmd->use_sg) {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400340 qc->__sg = (struct scatterlist *) cmd->request_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 qc->n_elem = cmd->use_sg;
342 } else {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400343 qc->__sg = &qc->sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 qc->n_elem = 1;
345 }
346 } else {
347 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
348 done(cmd);
349 }
350
351 return qc;
352}
353
354/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400355 * ata_dump_status - user friendly display of error info
356 * @id: id of the port in question
357 * @tf: ptr to filled out taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400359 * Decode and dump the ATA error/status registers for the user so
360 * that they have some idea what really happened at the non
361 * make-believe layer.
362 *
363 * LOCKING:
364 * inherited from caller
365 */
366void ata_dump_status(unsigned id, struct ata_taskfile *tf)
367{
368 u8 stat = tf->command, err = tf->feature;
369
370 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
371 if (stat & ATA_BUSY) {
372 printk("Busy }\n"); /* Data is not valid in this case */
373 } else {
374 if (stat & 0x40) printk("DriveReady ");
375 if (stat & 0x20) printk("DeviceFault ");
376 if (stat & 0x10) printk("SeekComplete ");
377 if (stat & 0x08) printk("DataRequest ");
378 if (stat & 0x04) printk("CorrectedError ");
379 if (stat & 0x02) printk("Index ");
380 if (stat & 0x01) printk("Error ");
381 printk("}\n");
382
383 if (err) {
384 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
385 if (err & 0x04) printk("DriveStatusError ");
386 if (err & 0x80) {
387 if (err & 0x04) printk("BadCRC ");
388 else printk("Sector ");
389 }
390 if (err & 0x40) printk("UncorrectableError ");
391 if (err & 0x10) printk("SectorIdNotFound ");
392 if (err & 0x02) printk("TrackZeroNotFound ");
393 if (err & 0x01) printk("AddrMarkNotFound ");
394 printk("}\n");
395 }
396 }
397}
398
399/**
400 * ata_to_sense_error - convert ATA error to SCSI error
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800401 * @id: ATA device number
Jeff Garzikb0955182005-05-12 15:45:22 -0400402 * @drv_stat: value contained in ATA status register
403 * @drv_err: value contained in ATA error register
404 * @sk: the sense key we'll fill out
405 * @asc: the additional sense code we'll fill out
406 * @ascq: the additional sense code qualifier we'll fill out
407 *
408 * Converts an ATA error into a SCSI error. Fill out pointers to
409 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
410 * format sense blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 *
412 * LOCKING:
413 * spin_lock_irqsave(host_set lock)
414 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400415void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
416 u8 *ascq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Jeff Garzikb0955182005-05-12 15:45:22 -0400418 int i;
Jeff Garzikffe75ef2005-10-09 10:40:44 -0400419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 /* Based on the 3ware driver translation table */
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100421 static const unsigned char sense_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 /* BBD|ECC|ID|MAR */
423 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
424 /* BBD|ECC|ID */
425 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
426 /* ECC|MC|MARK */
427 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
428 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
429 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
430 /* MC|ID|ABRT|TRK0|MARK */
431 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
432 /* MCR|MARK */
433 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
434 /* Bad address mark */
435 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
436 /* TRK0 */
437 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
438 /* Abort & !ICRC */
439 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
440 /* Media change request */
441 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
442 /* SRV */
443 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
444 /* Media change */
445 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
446 /* ECC */
447 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
448 /* BBD - block marked bad */
449 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
450 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
451 };
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100452 static const unsigned char stat_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 /* Must be first because BUSY means no other bits valid */
454 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
455 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
456 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
457 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
458 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
459 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 /*
462 * Is this an error we can process/parse
463 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400464 if (drv_stat & ATA_BUSY) {
465 drv_err = 0; /* Ignore the err bits, they're invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Jeff Garzikb0955182005-05-12 15:45:22 -0400468 if (drv_err) {
469 /* Look for drv_err */
470 for (i = 0; sense_table[i][0] != 0xFF; i++) {
471 /* Look for best matches first */
472 if ((sense_table[i][0] & drv_err) ==
473 sense_table[i][0]) {
474 *sk = sense_table[i][1];
475 *asc = sense_table[i][2];
476 *ascq = sense_table[i][3];
477 goto translate_done;
478 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400480 /* No immediate match */
481 printk(KERN_WARNING "ata%u: no sense translation for "
482 "error 0x%02x\n", id, drv_err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
484
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 /* Fall back to interpreting status bits */
Jeff Garzikb0955182005-05-12 15:45:22 -0400486 for (i = 0; stat_table[i][0] != 0xFF; i++) {
487 if (stat_table[i][0] & drv_stat) {
488 *sk = stat_table[i][1];
489 *asc = stat_table[i][2];
490 *ascq = stat_table[i][3];
491 goto translate_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400494 /* No error? Undecoded? */
495 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
496 id, drv_stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Jeff Garzikb0955182005-05-12 15:45:22 -0400498 /* For our last chance pick, use medium read error because
499 * it's much more common than an ATA drive telling you a write
500 * has failed.
501 */
502 *sk = MEDIUM_ERROR;
503 *asc = 0x11; /* "unrecovered read error" */
504 *ascq = 0x04; /* "auto-reallocation failed" */
505
506 translate_done:
507 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
508 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
509 *sk, *asc, *ascq);
510 return;
511}
512
513/*
514 * ata_gen_ata_desc_sense - Generate check condition sense block.
515 * @qc: Command that completed.
516 *
517 * This function is specific to the ATA descriptor format sense
518 * block specified for the ATA pass through commands. Regardless
519 * of whether the command errored or not, return a sense
520 * block. Copy all controller registers into the sense
521 * block. Clear sense key, ASC & ASCQ if there is no error.
522 *
523 * LOCKING:
524 * spin_lock_irqsave(host_set lock)
525 */
526void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
527{
528 struct scsi_cmnd *cmd = qc->scsicmd;
529 struct ata_taskfile *tf = &qc->tf;
530 unsigned char *sb = cmd->sense_buffer;
531 unsigned char *desc = sb + 8;
532
533 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
534
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400535 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400536
537 /*
538 * Read the controller registers.
539 */
540 assert(NULL != qc->ap->ops->tf_read);
541 qc->ap->ops->tf_read(qc->ap, tf);
542
543 /*
544 * Use ata_to_sense_error() to map status register bits
545 * onto sense key, asc & ascq.
546 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500547 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400548 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
549 &sb[1], &sb[2], &sb[3]);
550 sb[1] &= 0x0f;
551 }
552
553 /*
554 * Sense data is current and format is descriptor.
555 */
556 sb[0] = 0x72;
557
558 desc[0] = 0x09;
559
560 /*
561 * Set length of additional sense data.
562 * Since we only populate descriptor 0, the total
563 * length is the same (fixed) length as descriptor 0.
564 */
565 desc[1] = sb[7] = 14;
566
567 /*
568 * Copy registers into sense buffer.
569 */
570 desc[2] = 0x00;
571 desc[3] = tf->feature; /* == error reg */
572 desc[5] = tf->nsect;
573 desc[7] = tf->lbal;
574 desc[9] = tf->lbam;
575 desc[11] = tf->lbah;
576 desc[12] = tf->device;
577 desc[13] = tf->command; /* == status reg */
578
579 /*
580 * Fill in Extend bit, and the high order bytes
581 * if applicable.
582 */
583 if (tf->flags & ATA_TFLAG_LBA48) {
584 desc[2] |= 0x01;
585 desc[4] = tf->hob_nsect;
586 desc[6] = tf->hob_lbal;
587 desc[8] = tf->hob_lbam;
588 desc[10] = tf->hob_lbah;
589 }
590}
591
592/**
593 * ata_gen_fixed_sense - generate a SCSI fixed sense block
594 * @qc: Command that we are erroring out
595 *
596 * Leverage ata_to_sense_error() to give us the codes. Fit our
597 * LBA in here if there's room.
598 *
599 * LOCKING:
600 * inherited from caller
601 */
602void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
603{
604 struct scsi_cmnd *cmd = qc->scsicmd;
605 struct ata_taskfile *tf = &qc->tf;
606 unsigned char *sb = cmd->sense_buffer;
607
608 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
609
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400610 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400611
612 /*
613 * Read the controller registers.
614 */
615 assert(NULL != qc->ap->ops->tf_read);
616 qc->ap->ops->tf_read(qc->ap, tf);
617
618 /*
619 * Use ata_to_sense_error() to map status register bits
620 * onto sense key, asc & ascq.
621 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500622 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400623 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
624 &sb[2], &sb[12], &sb[13]);
625 sb[2] &= 0x0f;
626 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
628 sb[0] = 0x70;
Jeff Garzikb0955182005-05-12 15:45:22 -0400629 sb[7] = 0x0a;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400630
Jeff Garzika7dac442005-10-30 04:44:42 -0500631 if (tf->flags & ATA_TFLAG_LBA48) {
632 /* TODO: find solution for LBA48 descriptors */
633 }
634
635 else if (tf->flags & ATA_TFLAG_LBA) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400636 /* A small (28b) LBA will fit in the 32b info field */
637 sb[0] |= 0x80; /* set valid bit */
638 sb[3] = tf->device & 0x0f;
639 sb[4] = tf->lbah;
640 sb[5] = tf->lbam;
641 sb[6] = tf->lbal;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 }
Jeff Garzika7dac442005-10-30 04:44:42 -0500643
644 else {
645 /* TODO: C/H/S */
646 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
649/**
650 * ata_scsi_slave_config - Set SCSI device attributes
651 * @sdev: SCSI device to examine
652 *
653 * This is called before we actually start reading
654 * and writing to the device, to configure certain
655 * SCSI mid-layer behaviors.
656 *
657 * LOCKING:
658 * Defined by SCSI layer. We don't really care.
659 */
660
661int ata_scsi_slave_config(struct scsi_device *sdev)
662{
663 sdev->use_10_for_rw = 1;
664 sdev->use_10_for_ms = 1;
665
666 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
667
668 if (sdev->id < ATA_MAX_DEVICES) {
669 struct ata_port *ap;
670 struct ata_device *dev;
671
672 ap = (struct ata_port *) &sdev->host->hostdata[0];
673 dev = &ap->device[sdev->id];
674
675 /* TODO: 1024 is an arbitrary number, not the
676 * hardware maximum. This should be increased to
677 * 65534 when Jens Axboe's patch for dynamically
678 * determining max_sectors is merged.
679 */
680 if ((dev->flags & ATA_DFLAG_LBA48) &&
681 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
John W. Linvillef85bdb92005-05-12 15:49:54 -0400682 /*
683 * do not overwrite sdev->host->max_sectors, since
684 * other drives on this host may not support LBA48
685 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 blk_queue_max_sectors(sdev->request_queue, 2048);
687 }
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400688
689 /*
690 * SATA DMA transfers must be multiples of 4 byte, so
691 * we need to pad ATAPI transfers using an extra sg.
692 * Decrement max hw segments accordingly.
693 */
694 if (dev->class == ATA_DEV_ATAPI) {
695 request_queue_t *q = sdev->request_queue;
696 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
697 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 }
699
700 return 0; /* scsi layer doesn't check return value, sigh */
701}
702
703/**
704 * ata_scsi_error - SCSI layer error handler callback
705 * @host: SCSI host on which error occurred
706 *
707 * Handles SCSI-layer-thrown error events.
708 *
709 * LOCKING:
710 * Inherited from SCSI layer (none, can sleep)
711 *
712 * RETURNS:
713 * Zero.
714 */
715
716int ata_scsi_error(struct Scsi_Host *host)
717{
718 struct ata_port *ap;
719
720 DPRINTK("ENTER\n");
721
722 ap = (struct ata_port *) &host->hostdata[0];
723 ap->ops->eng_timeout(ap);
724
725 /* TODO: this is per-command; when queueing is supported
726 * this code will either change or move to a more
727 * appropriate place
728 */
729 host->host_failed--;
Tejun Heo425174382005-08-10 13:38:27 -0400730 INIT_LIST_HEAD(&host->eh_cmd_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
732 DPRINTK("EXIT\n");
733 return 0;
734}
735
736/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400737 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
738 * @qc: Storage for translated ATA taskfile
739 * @scsicmd: SCSI command to translate
740 *
741 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
742 * (to start). Perhaps these commands should be preceded by
743 * CHECK POWER MODE to see what power mode the device is already in.
744 * [See SAT revision 5 at www.t10.org]
745 *
746 * LOCKING:
747 * spin_lock_irqsave(host_set lock)
748 *
749 * RETURNS:
750 * Zero on success, non-zero on error.
751 */
752
753static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
Jeff Garzik057ace52005-10-22 14:27:05 -0400754 const u8 *scsicmd)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400755{
756 struct ata_taskfile *tf = &qc->tf;
757
758 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
759 tf->protocol = ATA_PROT_NODATA;
760 if (scsicmd[1] & 0x1) {
761 ; /* ignore IMMED bit, violates sat-r05 */
762 }
763 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400764 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400765 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400766 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400767 if (scsicmd[4] & 0x1) {
768 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400769
770 if (qc->dev->flags & ATA_DFLAG_LBA) {
771 qc->tf.flags |= ATA_TFLAG_LBA;
772
773 tf->lbah = 0x0;
774 tf->lbam = 0x0;
775 tf->lbal = 0x0;
776 tf->device |= ATA_LBA;
777 } else {
778 /* CHS */
779 tf->lbal = 0x1; /* sect */
780 tf->lbam = 0x0; /* cyl low */
781 tf->lbah = 0x0; /* cyl high */
782 }
783
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400784 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
785 } else {
786 tf->nsect = 0; /* time period value (0 implies now) */
787 tf->command = ATA_CMD_STANDBY;
788 /* Consider: ATA STANDBY IMMEDIATE command */
789 }
790 /*
791 * Standby and Idle condition timers could be implemented but that
792 * would require libata to implement the Power condition mode page
793 * and allow the user to change it. Changing mode pages requires
794 * MODE SELECT to be implemented.
795 */
796
797 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400798
799invalid_fld:
800 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
801 /* "Invalid field in cbd" */
802 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400803}
804
805
806/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
808 * @qc: Storage for translated ATA taskfile
809 * @scsicmd: SCSI command to translate (ignored)
810 *
811 * Sets up an ATA taskfile to issue FLUSH CACHE or
812 * FLUSH CACHE EXT.
813 *
814 * LOCKING:
815 * spin_lock_irqsave(host_set lock)
816 *
817 * RETURNS:
818 * Zero on success, non-zero on error.
819 */
820
Jeff Garzik057ace52005-10-22 14:27:05 -0400821static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
823 struct ata_taskfile *tf = &qc->tf;
824
825 tf->flags |= ATA_TFLAG_DEVICE;
826 tf->protocol = ATA_PROT_NODATA;
827
Albert Lee07506692005-10-12 15:04:18 +0800828 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 (ata_id_has_flush_ext(qc->dev->id)))
830 tf->command = ATA_CMD_FLUSH_EXT;
831 else
832 tf->command = ATA_CMD_FLUSH;
833
834 return 0;
835}
836
837/**
Albert Lee3aef5232005-10-04 08:47:43 -0400838 * scsi_6_lba_len - Get LBA and transfer length
839 * @scsicmd: SCSI command to translate
840 *
841 * Calculate LBA and transfer length for 6-byte commands.
842 *
843 * RETURNS:
844 * @plba: the LBA
845 * @plen: the transfer length
846 */
847
Jeff Garzik057ace52005-10-22 14:27:05 -0400848static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400849{
850 u64 lba = 0;
851 u32 len = 0;
852
853 VPRINTK("six-byte command\n");
854
855 lba |= ((u64)scsicmd[2]) << 8;
856 lba |= ((u64)scsicmd[3]);
857
858 len |= ((u32)scsicmd[4]);
859
860 *plba = lba;
861 *plen = len;
862}
863
864/**
865 * scsi_10_lba_len - Get LBA and transfer length
866 * @scsicmd: SCSI command to translate
867 *
868 * Calculate LBA and transfer length for 10-byte commands.
869 *
870 * RETURNS:
871 * @plba: the LBA
872 * @plen: the transfer length
873 */
874
Jeff Garzik057ace52005-10-22 14:27:05 -0400875static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400876{
877 u64 lba = 0;
878 u32 len = 0;
879
880 VPRINTK("ten-byte command\n");
881
882 lba |= ((u64)scsicmd[2]) << 24;
883 lba |= ((u64)scsicmd[3]) << 16;
884 lba |= ((u64)scsicmd[4]) << 8;
885 lba |= ((u64)scsicmd[5]);
886
887 len |= ((u32)scsicmd[7]) << 8;
888 len |= ((u32)scsicmd[8]);
889
890 *plba = lba;
891 *plen = len;
892}
893
894/**
895 * scsi_16_lba_len - Get LBA and transfer length
896 * @scsicmd: SCSI command to translate
897 *
898 * Calculate LBA and transfer length for 16-byte commands.
899 *
900 * RETURNS:
901 * @plba: the LBA
902 * @plen: the transfer length
903 */
904
Jeff Garzik057ace52005-10-22 14:27:05 -0400905static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400906{
907 u64 lba = 0;
908 u32 len = 0;
909
910 VPRINTK("sixteen-byte command\n");
911
912 lba |= ((u64)scsicmd[2]) << 56;
913 lba |= ((u64)scsicmd[3]) << 48;
914 lba |= ((u64)scsicmd[4]) << 40;
915 lba |= ((u64)scsicmd[5]) << 32;
916 lba |= ((u64)scsicmd[6]) << 24;
917 lba |= ((u64)scsicmd[7]) << 16;
918 lba |= ((u64)scsicmd[8]) << 8;
919 lba |= ((u64)scsicmd[9]);
920
921 len |= ((u32)scsicmd[10]) << 24;
922 len |= ((u32)scsicmd[11]) << 16;
923 len |= ((u32)scsicmd[12]) << 8;
924 len |= ((u32)scsicmd[13]);
925
926 *plba = lba;
927 *plen = len;
928}
929
930/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
932 * @qc: Storage for translated ATA taskfile
933 * @scsicmd: SCSI command to translate
934 *
935 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
936 *
937 * LOCKING:
938 * spin_lock_irqsave(host_set lock)
939 *
940 * RETURNS:
941 * Zero on success, non-zero on error.
942 */
943
Jeff Garzik057ace52005-10-22 14:27:05 -0400944static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945{
946 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400947 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -0400949 u64 block;
950 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
952 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
953 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Albert Lee3aef5232005-10-04 08:47:43 -0400955 if (scsicmd[0] == VERIFY)
956 scsi_10_lba_len(scsicmd, &block, &n_block);
957 else if (scsicmd[0] == VERIFY_16)
958 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 else
Douglas Gilbertae006512005-10-09 09:09:35 -0400960 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961
Albert Lee8bf62ec2005-05-12 15:29:42 -0400962 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -0400963 goto nothing_to_do;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400964 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400965 goto out_of_range;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400966 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400967 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968
Albert Lee07506692005-10-12 15:04:18 +0800969 if (dev->flags & ATA_DFLAG_LBA) {
970 tf->flags |= ATA_TFLAG_LBA;
971
972 if (dev->flags & ATA_DFLAG_LBA48) {
973 if (n_block > (64 * 1024))
974 goto invalid_fld;
975
976 /* use LBA48 */
977 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400978 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
Albert Lee8bf62ec2005-05-12 15:29:42 -0400980 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
Albert Lee8bf62ec2005-05-12 15:29:42 -0400982 tf->hob_lbah = (block >> 40) & 0xff;
983 tf->hob_lbam = (block >> 32) & 0xff;
984 tf->hob_lbal = (block >> 24) & 0xff;
985 } else {
Albert Lee07506692005-10-12 15:04:18 +0800986 if (n_block > 256)
987 goto invalid_fld;
988
989 /* use LBA28 */
Albert Lee8bf62ec2005-05-12 15:29:42 -0400990 tf->command = ATA_CMD_VERIFY;
991
992 tf->device |= (block >> 24) & 0xf;
993 }
994
995 tf->nsect = n_block & 0xff;
996
997 tf->lbah = (block >> 16) & 0xff;
998 tf->lbam = (block >> 8) & 0xff;
999 tf->lbal = block & 0xff;
1000
1001 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 } else {
Albert Lee8bf62ec2005-05-12 15:29:42 -04001003 /* CHS */
1004 u32 sect, head, cyl, track;
1005
Albert Lee07506692005-10-12 15:04:18 +08001006 if (n_block > 256)
1007 goto invalid_fld;
1008
Albert Lee8bf62ec2005-05-12 15:29:42 -04001009 /* Convert LBA to CHS */
1010 track = (u32)block / dev->sectors;
1011 cyl = track / dev->heads;
1012 head = track % dev->heads;
1013 sect = (u32)block % dev->sectors + 1;
1014
Albert Leec187c4b2005-10-04 08:46:51 -04001015 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1016 (u32)block, track, cyl, head, sect);
Albert Lee8bf62ec2005-05-12 15:29:42 -04001017
1018 /* Check whether the converted CHS can fit.
1019 Cylinder: 0-65535
1020 Head: 0-15
1021 Sector: 1-255*/
1022 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001023 goto out_of_range;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001026 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1027 tf->lbal = sect;
1028 tf->lbam = cyl;
1029 tf->lbah = cyl >> 8;
1030 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 }
1032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001034
1035invalid_fld:
1036 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1037 /* "Invalid field in cbd" */
1038 return 1;
1039
1040out_of_range:
1041 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1042 /* "Logical Block Address out of range" */
1043 return 1;
1044
1045nothing_to_do:
1046 qc->scsicmd->result = SAM_STAT_GOOD;
1047 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048}
1049
1050/**
1051 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1052 * @qc: Storage for translated ATA taskfile
1053 * @scsicmd: SCSI command to translate
1054 *
1055 * Converts any of six SCSI read/write commands into the
1056 * ATA counterpart, including starting sector (LBA),
1057 * sector count, and taking into account the device's LBA48
1058 * support.
1059 *
1060 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1061 * %WRITE_16 are currently supported.
1062 *
1063 * LOCKING:
1064 * spin_lock_irqsave(host_set lock)
1065 *
1066 * RETURNS:
1067 * Zero on success, non-zero on error.
1068 */
1069
Jeff Garzik057ace52005-10-22 14:27:05 -04001070static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071{
1072 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001073 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -04001074 u64 block;
1075 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078
Albert Lee8cbd6df2005-10-12 15:06:27 +08001079 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1080 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001083 /* Calculate the SCSI LBA, transfer length and FUA. */
Albert Lee3aef5232005-10-04 08:47:43 -04001084 switch (scsicmd[0]) {
1085 case READ_10:
1086 case WRITE_10:
1087 scsi_10_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001088 if (unlikely(scsicmd[1] & (1 << 3)))
1089 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001090 break;
1091 case READ_6:
1092 case WRITE_6:
1093 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001094
1095 /* for 6-byte r/w commands, transfer length 0
1096 * means 256 blocks of data, not 0 block.
1097 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001098 if (!n_block)
1099 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -04001100 break;
1101 case READ_16:
1102 case WRITE_16:
1103 scsi_16_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001104 if (unlikely(scsicmd[1] & (1 << 3)))
1105 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001106 break;
1107 default:
Albert Lee8bf62ec2005-05-12 15:29:42 -04001108 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001109 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 }
1111
Albert Lee8bf62ec2005-05-12 15:29:42 -04001112 /* Check and compose ATA command */
1113 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001114 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1115 * length 0 means transfer 0 block of data.
1116 * However, for ATA R/W commands, sector count 0 means
1117 * 256 or 65536 sectors, not 0 sectors as in SCSI.
Alan Coxf51750d2005-11-07 17:06:33 +00001118 *
1119 * WARNING: one or two older ATA drives treat 0 as 0...
Albert Leec187c4b2005-10-04 08:46:51 -04001120 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001121 goto nothing_to_do;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001122
Albert Lee07506692005-10-12 15:04:18 +08001123 if (dev->flags & ATA_DFLAG_LBA) {
1124 tf->flags |= ATA_TFLAG_LBA;
1125
1126 if (dev->flags & ATA_DFLAG_LBA48) {
Albert Lee8bf62ec2005-05-12 15:29:42 -04001127 /* The request -may- be too large for LBA48. */
1128 if ((block >> 48) || (n_block > 65536))
Douglas Gilbertae006512005-10-09 09:09:35 -04001129 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
Albert Lee07506692005-10-12 15:04:18 +08001131 /* use LBA48 */
1132 tf->flags |= ATA_TFLAG_LBA48;
1133
Albert Lee8bf62ec2005-05-12 15:29:42 -04001134 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
Albert Lee8bf62ec2005-05-12 15:29:42 -04001136 tf->hob_lbah = (block >> 40) & 0xff;
1137 tf->hob_lbam = (block >> 32) & 0xff;
1138 tf->hob_lbal = (block >> 24) & 0xff;
1139 } else {
Albert Lee07506692005-10-12 15:04:18 +08001140 /* use LBA28 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
Albert Lee8bf62ec2005-05-12 15:29:42 -04001142 /* The request -may- be too large for LBA28. */
1143 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -04001144 goto out_of_range;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001145
1146 tf->device |= (block >> 24) & 0xf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 }
1148
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001149 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1150 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001151
Albert Lee8bf62ec2005-05-12 15:29:42 -04001152 qc->nsect = n_block;
1153 tf->nsect = n_block & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154
Albert Lee8bf62ec2005-05-12 15:29:42 -04001155 tf->lbah = (block >> 16) & 0xff;
1156 tf->lbam = (block >> 8) & 0xff;
1157 tf->lbal = block & 0xff;
1158
1159 tf->device |= ATA_LBA;
1160 } else {
1161 /* CHS */
1162 u32 sect, head, cyl, track;
1163
1164 /* The request -may- be too large for CHS addressing. */
1165 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -04001166 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001167
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001168 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1169 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001170
Albert Lee8bf62ec2005-05-12 15:29:42 -04001171 /* Convert LBA to CHS */
1172 track = (u32)block / dev->sectors;
1173 cyl = track / dev->heads;
1174 head = track % dev->heads;
1175 sect = (u32)block % dev->sectors + 1;
1176
Albert Leec187c4b2005-10-04 08:46:51 -04001177 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ec2005-05-12 15:29:42 -04001178 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -04001179
Albert Lee8bf62ec2005-05-12 15:29:42 -04001180 /* Check whether the converted CHS can fit.
1181 Cylinder: 0-65535
1182 Head: 0-15
1183 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -04001184 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001185 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001186
Albert Lee8bf62ec2005-05-12 15:29:42 -04001187 qc->nsect = n_block;
1188 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1189 tf->lbal = sect;
1190 tf->lbam = cyl;
1191 tf->lbah = cyl >> 8;
1192 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 }
1194
Albert Lee8bf62ec2005-05-12 15:29:42 -04001195 return 0;
Jeff Garzik13593262005-08-27 04:20:12 -04001196
Douglas Gilbertae006512005-10-09 09:09:35 -04001197invalid_fld:
1198 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1199 /* "Invalid field in cbd" */
1200 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Douglas Gilbertae006512005-10-09 09:09:35 -04001202out_of_range:
1203 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1204 /* "Logical Block Address out of range" */
1205 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Douglas Gilbertae006512005-10-09 09:09:35 -04001207nothing_to_do:
1208 qc->scsicmd->result = SAM_STAT_GOOD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 return 1;
1210}
1211
Albert Leea22e2eb2005-12-05 15:38:02 +08001212static int ata_scsi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213{
1214 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001215 u8 *cdb = cmd->cmnd;
Albert Leea22e2eb2005-12-05 15:38:02 +08001216 int need_sense = (qc->err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
Jeff Garzikb0955182005-05-12 15:45:22 -04001218 /* For ATA pass thru (SAT) commands, generate a sense block if
1219 * user mandated it or if there's an error. Note that if we
1220 * generate because the user forced us to, a check condition
1221 * is generated and the ATA register values are returned
1222 * whether the command completed successfully or not. If there
1223 * was no error, SK, ASC and ASCQ will all be zero.
1224 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001225 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1226 ((cdb[2] & 0x20) || need_sense)) {
Jeff Garzikb0955182005-05-12 15:45:22 -04001227 ata_gen_ata_desc_sense(qc);
1228 } else {
1229 if (!need_sense) {
1230 cmd->result = SAM_STAT_GOOD;
1231 } else {
1232 /* TODO: decide which descriptor format to use
1233 * for 48b LBA devices and call that here
1234 * instead of the fixed desc, which is only
1235 * good for smaller LBA (and maybe CHS?)
1236 * devices.
1237 */
1238 ata_gen_fixed_sense(qc);
1239 }
1240 }
1241
1242 if (need_sense) {
1243 /* The ata_gen_..._sense routines fill in tf */
1244 ata_dump_status(qc->ap->id, &qc->tf);
1245 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246
1247 qc->scsidone(cmd);
1248
1249 return 0;
1250}
1251
1252/**
1253 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1254 * @ap: ATA port to which the command is addressed
1255 * @dev: ATA device to which the command is addressed
1256 * @cmd: SCSI command to execute
1257 * @done: SCSI command completion function
1258 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1259 *
1260 * Our ->queuecommand() function has decided that the SCSI
1261 * command issued can be directly translated into an ATA
1262 * command, rather than handled internally.
1263 *
1264 * This function sets up an ata_queued_cmd structure for the
1265 * SCSI command, and sends that ata_queued_cmd to the hardware.
1266 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001267 * The xlat_func argument (actor) returns 0 if ready to execute
1268 * ATA command, else 1 to finish translation. If 1 is returned
1269 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1270 * to be set reflecting an error condition or clean (early)
1271 * termination.
1272 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 * LOCKING:
1274 * spin_lock_irqsave(host_set lock)
1275 */
1276
1277static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1278 struct scsi_cmnd *cmd,
1279 void (*done)(struct scsi_cmnd *),
1280 ata_xlat_func_t xlat_func)
1281{
1282 struct ata_queued_cmd *qc;
1283 u8 *scsicmd = cmd->cmnd;
1284
1285 VPRINTK("ENTER\n");
1286
1287 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1288 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001289 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
1291 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -05001292 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1293 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 if (unlikely(cmd->request_bufflen < 1)) {
1295 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1296 ap->id, dev->devno);
Douglas Gilbertae006512005-10-09 09:09:35 -04001297 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 }
1299
1300 if (cmd->use_sg)
1301 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1302 else
1303 ata_sg_init_one(qc, cmd->request_buffer,
1304 cmd->request_bufflen);
1305
1306 qc->dma_dir = cmd->sc_data_direction;
1307 }
1308
1309 qc->complete_fn = ata_scsi_qc_complete;
1310
1311 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -04001312 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
1314 /* select device, send command to hardware */
1315 if (ata_qc_issue(qc))
Douglas Gilbertae006512005-10-09 09:09:35 -04001316 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
1318 VPRINTK("EXIT\n");
1319 return;
1320
Douglas Gilbertae006512005-10-09 09:09:35 -04001321early_finish:
1322 ata_qc_free(qc);
1323 done(cmd);
1324 DPRINTK("EXIT - early finish (good or error)\n");
1325 return;
1326
1327err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001329err_mem:
1330 cmd->result = (DID_ERROR << 16);
1331 done(cmd);
1332 DPRINTK("EXIT - internal\n");
1333 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334}
1335
1336/**
1337 * ata_scsi_rbuf_get - Map response buffer.
1338 * @cmd: SCSI command containing buffer to be mapped.
1339 * @buf_out: Pointer to mapped area.
1340 *
1341 * Maps buffer contained within SCSI command @cmd.
1342 *
1343 * LOCKING:
1344 * spin_lock_irqsave(host_set lock)
1345 *
1346 * RETURNS:
1347 * Length of response buffer.
1348 */
1349
1350static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1351{
1352 u8 *buf;
1353 unsigned int buflen;
1354
1355 if (cmd->use_sg) {
1356 struct scatterlist *sg;
1357
1358 sg = (struct scatterlist *) cmd->request_buffer;
1359 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1360 buflen = sg->length;
1361 } else {
1362 buf = cmd->request_buffer;
1363 buflen = cmd->request_bufflen;
1364 }
1365
1366 *buf_out = buf;
1367 return buflen;
1368}
1369
1370/**
1371 * ata_scsi_rbuf_put - Unmap response buffer.
1372 * @cmd: SCSI command containing buffer to be unmapped.
1373 * @buf: buffer to unmap
1374 *
1375 * Unmaps response buffer contained within @cmd.
1376 *
1377 * LOCKING:
1378 * spin_lock_irqsave(host_set lock)
1379 */
1380
1381static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1382{
1383 if (cmd->use_sg) {
1384 struct scatterlist *sg;
1385
1386 sg = (struct scatterlist *) cmd->request_buffer;
1387 kunmap_atomic(buf - sg->offset, KM_USER0);
1388 }
1389}
1390
1391/**
1392 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1393 * @args: device IDENTIFY data / SCSI command of interest.
1394 * @actor: Callback hook for desired SCSI command simulator
1395 *
1396 * Takes care of the hard work of simulating a SCSI command...
1397 * Mapping the response buffer, calling the command's handler,
1398 * and handling the handler's return value. This return value
1399 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001400 * completed successfully (0), or not (in which case cmd->result
1401 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 *
1403 * LOCKING:
1404 * spin_lock_irqsave(host_set lock)
1405 */
1406
1407void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1408 unsigned int (*actor) (struct ata_scsi_args *args,
1409 u8 *rbuf, unsigned int buflen))
1410{
1411 u8 *rbuf;
1412 unsigned int buflen, rc;
1413 struct scsi_cmnd *cmd = args->cmd;
1414
1415 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1416 memset(rbuf, 0, buflen);
1417 rc = actor(args, rbuf, buflen);
1418 ata_scsi_rbuf_put(cmd, rbuf);
1419
Douglas Gilbertae006512005-10-09 09:09:35 -04001420 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001422 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423}
1424
1425/**
1426 * ata_scsiop_inq_std - Simulate INQUIRY command
1427 * @args: device IDENTIFY data / SCSI command of interest.
1428 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1429 * @buflen: Response buffer length.
1430 *
1431 * Returns standard device identification data associated
1432 * with non-EVPD INQUIRY command output.
1433 *
1434 * LOCKING:
1435 * spin_lock_irqsave(host_set lock)
1436 */
1437
1438unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1439 unsigned int buflen)
1440{
1441 u8 hdr[] = {
1442 TYPE_DISK,
1443 0,
1444 0x5, /* claim SPC-3 version compatibility */
1445 2,
1446 95 - 4
1447 };
1448
1449 /* set scsi removeable (RMB) bit per ata bit */
1450 if (ata_id_removeable(args->id))
1451 hdr[1] |= (1 << 7);
1452
1453 VPRINTK("ENTER\n");
1454
1455 memcpy(rbuf, hdr, sizeof(hdr));
1456
1457 if (buflen > 35) {
1458 memcpy(&rbuf[8], "ATA ", 8);
1459 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1460 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1461 if (rbuf[32] == 0 || rbuf[32] == ' ')
1462 memcpy(&rbuf[32], "n/a ", 4);
1463 }
1464
1465 if (buflen > 63) {
1466 const u8 versions[] = {
1467 0x60, /* SAM-3 (no version claimed) */
1468
1469 0x03,
1470 0x20, /* SBC-2 (no version claimed) */
1471
1472 0x02,
1473 0x60 /* SPC-3 (no version claimed) */
1474 };
1475
1476 memcpy(rbuf + 59, versions, sizeof(versions));
1477 }
1478
1479 return 0;
1480}
1481
1482/**
1483 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1484 * @args: device IDENTIFY data / SCSI command of interest.
1485 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1486 * @buflen: Response buffer length.
1487 *
1488 * Returns list of inquiry EVPD pages available.
1489 *
1490 * LOCKING:
1491 * spin_lock_irqsave(host_set lock)
1492 */
1493
1494unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1495 unsigned int buflen)
1496{
1497 const u8 pages[] = {
1498 0x00, /* page 0x00, this page */
1499 0x80, /* page 0x80, unit serial no page */
1500 0x83 /* page 0x83, device ident page */
1501 };
1502 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1503
1504 if (buflen > 6)
1505 memcpy(rbuf + 4, pages, sizeof(pages));
1506
1507 return 0;
1508}
1509
1510/**
1511 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1512 * @args: device IDENTIFY data / SCSI command of interest.
1513 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1514 * @buflen: Response buffer length.
1515 *
1516 * Returns ATA device serial number.
1517 *
1518 * LOCKING:
1519 * spin_lock_irqsave(host_set lock)
1520 */
1521
1522unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1523 unsigned int buflen)
1524{
1525 const u8 hdr[] = {
1526 0,
1527 0x80, /* this page code */
1528 0,
1529 ATA_SERNO_LEN, /* page len */
1530 };
1531 memcpy(rbuf, hdr, sizeof(hdr));
1532
1533 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1534 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1535 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1536
1537 return 0;
1538}
1539
Arjan van de Ven98ac62d2005-11-28 10:06:23 +01001540static const char * const inq_83_str = "Linux ATA-SCSI simulator";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
1542/**
1543 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1544 * @args: device IDENTIFY data / SCSI command of interest.
1545 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1546 * @buflen: Response buffer length.
1547 *
1548 * Returns device identification. Currently hardcoded to
1549 * return "Linux ATA-SCSI simulator".
1550 *
1551 * LOCKING:
1552 * spin_lock_irqsave(host_set lock)
1553 */
1554
1555unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1556 unsigned int buflen)
1557{
1558 rbuf[1] = 0x83; /* this page code */
1559 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1560
1561 /* our one and only identification descriptor (vendor-specific) */
1562 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1563 rbuf[4 + 0] = 2; /* code set: ASCII */
1564 rbuf[4 + 3] = strlen(inq_83_str);
1565 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1566 }
1567
1568 return 0;
1569}
1570
1571/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001572 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 * @args: device IDENTIFY data / SCSI command of interest.
1574 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1575 * @buflen: Response buffer length.
1576 *
1577 * No operation. Simply returns success to caller, to indicate
1578 * that the caller should successfully complete this SCSI command.
1579 *
1580 * LOCKING:
1581 * spin_lock_irqsave(host_set lock)
1582 */
1583
1584unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1585 unsigned int buflen)
1586{
1587 VPRINTK("ENTER\n");
1588 return 0;
1589}
1590
1591/**
1592 * ata_msense_push - Push data onto MODE SENSE data output buffer
1593 * @ptr_io: (input/output) Location to store more output data
1594 * @last: End of output data buffer
1595 * @buf: Pointer to BLOB being added to output buffer
1596 * @buflen: Length of BLOB
1597 *
1598 * Store MODE SENSE data on an output buffer.
1599 *
1600 * LOCKING:
1601 * None.
1602 */
1603
1604static void ata_msense_push(u8 **ptr_io, const u8 *last,
1605 const u8 *buf, unsigned int buflen)
1606{
1607 u8 *ptr = *ptr_io;
1608
1609 if ((ptr + buflen - 1) > last)
1610 return;
1611
1612 memcpy(ptr, buf, buflen);
1613
1614 ptr += buflen;
1615
1616 *ptr_io = ptr;
1617}
1618
1619/**
1620 * ata_msense_caching - Simulate MODE SENSE caching info page
1621 * @id: device IDENTIFY data
1622 * @ptr_io: (input/output) Location to store more output data
1623 * @last: End of output data buffer
1624 *
1625 * Generate a caching info page, which conditionally indicates
1626 * write caching to the SCSI layer, depending on device
1627 * capabilities.
1628 *
1629 * LOCKING:
1630 * None.
1631 */
1632
1633static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1634 const u8 *last)
1635{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001636 u8 page[CACHE_MPAGE_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001638 memcpy(page, def_cache_mpage, sizeof(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 if (ata_id_wcache_enabled(id))
1640 page[2] |= (1 << 2); /* write cache enable */
1641 if (!ata_id_rahead_enabled(id))
1642 page[12] |= (1 << 5); /* disable read ahead */
1643
1644 ata_msense_push(ptr_io, last, page, sizeof(page));
1645 return sizeof(page);
1646}
1647
1648/**
1649 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1650 * @dev: Device associated with this MODE SENSE command
1651 * @ptr_io: (input/output) Location to store more output data
1652 * @last: End of output data buffer
1653 *
1654 * Generate a generic MODE SENSE control mode page.
1655 *
1656 * LOCKING:
1657 * None.
1658 */
1659
1660static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1661{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001662 ata_msense_push(ptr_io, last, def_control_mpage,
1663 sizeof(def_control_mpage));
1664 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665}
1666
1667/**
1668 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1669 * @dev: Device associated with this MODE SENSE command
1670 * @ptr_io: (input/output) Location to store more output data
1671 * @last: End of output data buffer
1672 *
1673 * Generate a generic MODE SENSE r/w error recovery page.
1674 *
1675 * LOCKING:
1676 * None.
1677 */
1678
1679static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1680{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001682 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1683 sizeof(def_rw_recovery_mpage));
1684 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685}
1686
1687/**
1688 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1689 * @args: device IDENTIFY data / SCSI command of interest.
1690 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1691 * @buflen: Response buffer length.
1692 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001693 * Simulate MODE SENSE commands. Assume this is invoked for direct
1694 * access devices (e.g. disks) only. There should be no block
1695 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 *
1697 * LOCKING:
1698 * spin_lock_irqsave(host_set lock)
1699 */
1700
1701unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1702 unsigned int buflen)
1703{
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001704 struct ata_device *dev = args->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 u8 *scsicmd = args->cmd->cmnd, *p, *last;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001706 const u8 sat_blk_desc[] = {
1707 0, 0, 0, 0, /* number of blocks: sat unspecified */
1708 0,
1709 0, 0x2, 0x0 /* block length: 512 bytes */
1710 };
1711 u8 pg, spg;
1712 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001713 u8 dpofua;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
1715 VPRINTK("ENTER\n");
1716
1717 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001718 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1719 /*
1720 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001722
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04001724 switch (page_control) {
1725 case 0: /* current */
1726 break; /* supported */
1727 case 3: /* saved */
1728 goto saving_not_supp;
1729 case 1: /* changeable */
1730 case 2: /* defaults */
1731 default:
1732 goto invalid_fld;
1733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001735 if (six_byte) {
1736 output_len = 4 + (ebd ? 8 : 0);
1737 alloc_len = scsicmd[4];
1738 } else {
1739 output_len = 8 + (ebd ? 8 : 0);
1740 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1741 }
1742 minlen = (alloc_len < buflen) ? alloc_len : buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743
1744 p = rbuf + output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001745 last = rbuf + minlen - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001747 pg = scsicmd[2] & 0x3f;
1748 spg = scsicmd[3];
1749 /*
1750 * No mode subpages supported (yet) but asking for _all_
1751 * subpages may be valid
1752 */
1753 if (spg && (spg != ALL_SUB_MPAGES))
1754 goto invalid_fld;
1755
1756 switch(pg) {
1757 case RW_RECOVERY_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 output_len += ata_msense_rw_recovery(&p, last);
1759 break;
1760
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001761 case CACHE_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 output_len += ata_msense_caching(args->id, &p, last);
1763 break;
1764
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001765 case CONTROL_MPAGE: {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 output_len += ata_msense_ctl_mode(&p, last);
1767 break;
1768 }
1769
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001770 case ALL_MPAGES:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 output_len += ata_msense_rw_recovery(&p, last);
1772 output_len += ata_msense_caching(args->id, &p, last);
1773 output_len += ata_msense_ctl_mode(&p, last);
1774 break;
1775
1776 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04001777 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 }
1779
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001780 if (minlen < 1)
1781 return 0;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001782
1783 dpofua = 0;
1784 if (ata_id_has_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1785 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1786 dpofua = 1 << 4;
1787
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 if (six_byte) {
1789 output_len--;
1790 rbuf[0] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001791 if (minlen > 2)
1792 rbuf[2] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001793 if (ebd) {
1794 if (minlen > 3)
1795 rbuf[3] = sizeof(sat_blk_desc);
1796 if (minlen > 11)
1797 memcpy(rbuf + 4, sat_blk_desc,
1798 sizeof(sat_blk_desc));
1799 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 } else {
1801 output_len -= 2;
1802 rbuf[0] = output_len >> 8;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001803 if (minlen > 1)
1804 rbuf[1] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001805 if (minlen > 3)
1806 rbuf[3] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001807 if (ebd) {
1808 if (minlen > 7)
1809 rbuf[7] = sizeof(sat_blk_desc);
1810 if (minlen > 15)
1811 memcpy(rbuf + 8, sat_blk_desc,
1812 sizeof(sat_blk_desc));
1813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001816
1817invalid_fld:
1818 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1819 /* "Invalid field in cbd" */
1820 return 1;
1821
1822saving_not_supp:
1823 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1824 /* "Saving parameters not supported" */
1825 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826}
1827
1828/**
1829 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1830 * @args: device IDENTIFY data / SCSI command of interest.
1831 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1832 * @buflen: Response buffer length.
1833 *
1834 * Simulate READ CAPACITY commands.
1835 *
1836 * LOCKING:
1837 * spin_lock_irqsave(host_set lock)
1838 */
1839
1840unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1841 unsigned int buflen)
1842{
1843 u64 n_sectors;
1844 u32 tmp;
1845
1846 VPRINTK("ENTER\n");
1847
Albert Lee8bf62ec2005-05-12 15:29:42 -04001848 if (ata_id_has_lba(args->id)) {
1849 if (ata_id_has_lba48(args->id))
1850 n_sectors = ata_id_u64(args->id, 100);
1851 else
1852 n_sectors = ata_id_u32(args->id, 60);
1853 } else {
1854 /* CHS default translation */
1855 n_sectors = args->id[1] * args->id[3] * args->id[6];
1856
1857 if (ata_id_current_chs_valid(args->id))
1858 /* CHS current translation */
1859 n_sectors = ata_id_u32(args->id, 57);
1860 }
1861
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 n_sectors--; /* ATA TotalUserSectors - 1 */
1863
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07001865 if( n_sectors >= 0xffffffffULL )
1866 tmp = 0xffffffff ; /* Return max count on overflow */
1867 else
1868 tmp = n_sectors ;
1869
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 /* sector count, 32-bit */
1871 rbuf[0] = tmp >> (8 * 3);
1872 rbuf[1] = tmp >> (8 * 2);
1873 rbuf[2] = tmp >> (8 * 1);
1874 rbuf[3] = tmp;
1875
1876 /* sector size */
1877 tmp = ATA_SECT_SIZE;
1878 rbuf[6] = tmp >> 8;
1879 rbuf[7] = tmp;
1880
1881 } else {
1882 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07001883 tmp = n_sectors >> (8 * 4);
1884 rbuf[2] = tmp >> (8 * 3);
1885 rbuf[3] = tmp >> (8 * 2);
1886 rbuf[4] = tmp >> (8 * 1);
1887 rbuf[5] = tmp;
1888 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 rbuf[6] = tmp >> (8 * 3);
1890 rbuf[7] = tmp >> (8 * 2);
1891 rbuf[8] = tmp >> (8 * 1);
1892 rbuf[9] = tmp;
1893
1894 /* sector size */
1895 tmp = ATA_SECT_SIZE;
1896 rbuf[12] = tmp >> 8;
1897 rbuf[13] = tmp;
1898 }
1899
1900 return 0;
1901}
1902
1903/**
1904 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1905 * @args: device IDENTIFY data / SCSI command of interest.
1906 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1907 * @buflen: Response buffer length.
1908 *
1909 * Simulate REPORT LUNS command.
1910 *
1911 * LOCKING:
1912 * spin_lock_irqsave(host_set lock)
1913 */
1914
1915unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1916 unsigned int buflen)
1917{
1918 VPRINTK("ENTER\n");
1919 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1920
1921 return 0;
1922}
1923
1924/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04001925 * ata_scsi_set_sense - Set SCSI sense data and status
1926 * @cmd: SCSI request to be handled
1927 * @sk: SCSI-defined sense key
1928 * @asc: SCSI-defined additional sense code
1929 * @ascq: SCSI-defined additional sense code qualifier
1930 *
1931 * Helper function that builds a valid fixed format, current
1932 * response code and the given sense key (sk), additional sense
1933 * code (asc) and additional sense code qualifier (ascq) with
1934 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1935 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1936 *
1937 * LOCKING:
1938 * Not required
1939 */
1940
1941void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1942{
1943 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1944
1945 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1946 cmd->sense_buffer[2] = sk;
1947 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1948 cmd->sense_buffer[12] = asc;
1949 cmd->sense_buffer[13] = ascq;
1950}
1951
1952/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 * ata_scsi_badcmd - End a SCSI request with an error
1954 * @cmd: SCSI request to be handled
1955 * @done: SCSI command completion function
1956 * @asc: SCSI-defined additional sense code
1957 * @ascq: SCSI-defined additional sense code qualifier
1958 *
1959 * Helper function that completes a SCSI command with
1960 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1961 * and the specified additional sense codes.
1962 *
1963 * LOCKING:
1964 * spin_lock_irqsave(host_set lock)
1965 */
1966
1967void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1968{
1969 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001970 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971
1972 done(cmd);
1973}
1974
Albert Leea22e2eb2005-12-05 15:38:02 +08001975static int atapi_sense_complete(struct ata_queued_cmd *qc)
Jeff Garzika939c962005-10-05 17:09:16 -04001976{
Albert Leea22e2eb2005-12-05 15:38:02 +08001977 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
Jeff Garzikc6e6e662005-11-14 14:50:05 -05001978 /* FIXME: not quite right; we don't want the
1979 * translation of taskfile registers into
1980 * a sense descriptors, since that's only
1981 * correct for ATA, not ATAPI
1982 */
1983 ata_gen_ata_desc_sense(qc);
1984
1985 qc->scsidone(qc->scsicmd);
1986 return 0;
1987}
1988
1989/* is it pointless to prefer PIO for "safety reasons"? */
1990static inline int ata_pio_use_silly(struct ata_port *ap)
1991{
1992 return (ap->flags & ATA_FLAG_PIO_DMA);
1993}
1994
1995static void atapi_request_sense(struct ata_queued_cmd *qc)
1996{
1997 struct ata_port *ap = qc->ap;
1998 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika939c962005-10-05 17:09:16 -04001999
2000 DPRINTK("ATAPI request sense\n");
2001
Jeff Garzika939c962005-10-05 17:09:16 -04002002 /* FIXME: is this needed? */
2003 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2004
Jeff Garzikc6e6e662005-11-14 14:50:05 -05002005 ap->ops->tf_read(ap, &qc->tf);
2006
2007 /* fill these in, for the case where they are -not- overwritten */
2008 cmd->sense_buffer[0] = 0x70;
2009 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2010
2011 ata_qc_reinit(qc);
2012
Jeff Garzika939c962005-10-05 17:09:16 -04002013 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2014 qc->dma_dir = DMA_FROM_DEVICE;
2015
2016 memset(&qc->cdb, 0, ap->cdb_len);
2017 qc->cdb[0] = REQUEST_SENSE;
2018 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2019
2020 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2021 qc->tf.command = ATA_CMD_PACKET;
2022
Jeff Garzikc6e6e662005-11-14 14:50:05 -05002023 if (ata_pio_use_silly(ap)) {
2024 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2025 qc->tf.feature |= ATAPI_PKT_DMA;
2026 } else {
2027 qc->tf.protocol = ATA_PROT_ATAPI;
2028 qc->tf.lbam = (8 * 1024) & 0xff;
2029 qc->tf.lbah = (8 * 1024) >> 8;
2030 }
Jeff Garzika939c962005-10-05 17:09:16 -04002031 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2032
Jeff Garzikc6e6e662005-11-14 14:50:05 -05002033 qc->complete_fn = atapi_sense_complete;
Jeff Garzika939c962005-10-05 17:09:16 -04002034
Albert Leea22e2eb2005-12-05 15:38:02 +08002035 if (ata_qc_issue(qc)) {
2036 qc->err_mask |= AC_ERR_OTHER;
2037 ata_qc_complete(qc);
2038 }
Jeff Garzika939c962005-10-05 17:09:16 -04002039
2040 DPRINTK("EXIT\n");
2041}
2042
Albert Leea22e2eb2005-12-05 15:38:02 +08002043static int atapi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044{
2045 struct scsi_cmnd *cmd = qc->scsicmd;
Albert Leea22e2eb2005-12-05 15:38:02 +08002046 unsigned int err_mask = qc->err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047
Jeff Garzika7dac442005-10-30 04:44:42 -05002048 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002049
Jeff Garzika7dac442005-10-30 04:44:42 -05002050 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 cmd->result = SAM_STAT_CHECK_CONDITION;
Jeff Garzikc6e6e662005-11-14 14:50:05 -05002052 atapi_request_sense(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 return 1;
Jeff Garzike12669e2005-10-05 18:39:23 -04002054 }
2055
Jeff Garzika7dac442005-10-30 04:44:42 -05002056 else if (unlikely(err_mask))
2057 /* FIXME: not quite right; we don't want the
2058 * translation of taskfile registers into
2059 * a sense descriptors, since that's only
2060 * correct for ATA, not ATAPI
2061 */
2062 ata_gen_ata_desc_sense(qc);
2063
Jeff Garzike12669e2005-10-05 18:39:23 -04002064 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 u8 *scsicmd = cmd->cmnd;
2066
Tony Battersbyfd71da42005-12-21 16:35:44 -05002067 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 u8 *buf = NULL;
2069 unsigned int buflen;
2070
2071 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002072
2073 /* ATAPI devices typically report zero for their SCSI version,
2074 * and sometimes deviate from the spec WRT response data
2075 * format. If SCSI version is reported as zero like normal,
2076 * then we make the following fixups: 1) Fake MMC-5 version,
2077 * to indicate to the Linux scsi midlayer this is a modern
2078 * device. 2) Ensure response data format / ATAPI information
2079 * are always correct.
2080 */
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002081 if (buf[2] == 0) {
2082 buf[2] = 0x5;
2083 buf[3] = 0x32;
2084 }
2085
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 ata_scsi_rbuf_put(cmd, buf);
2087 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002088
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 cmd->result = SAM_STAT_GOOD;
2090 }
2091
2092 qc->scsidone(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 return 0;
2094}
2095/**
2096 * atapi_xlat - Initialize PACKET taskfile
2097 * @qc: command structure to be initialized
2098 * @scsicmd: SCSI CDB associated with this PACKET command
2099 *
2100 * LOCKING:
2101 * spin_lock_irqsave(host_set lock)
2102 *
2103 * RETURNS:
2104 * Zero on success, non-zero on failure.
2105 */
2106
Jeff Garzik057ace52005-10-22 14:27:05 -04002107static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108{
2109 struct scsi_cmnd *cmd = qc->scsicmd;
2110 struct ata_device *dev = qc->dev;
2111 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db052005-04-17 15:26:13 -05002112 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
2114 if (!using_pio)
2115 /* Check whether ATAPI DMA is safe */
2116 if (ata_check_atapi_dma(qc))
2117 using_pio = 1;
2118
2119 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2120
2121 qc->complete_fn = atapi_qc_complete;
2122
2123 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db052005-04-17 15:26:13 -05002124 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 qc->tf.flags |= ATA_TFLAG_WRITE;
2126 DPRINTK("direction: write\n");
2127 }
2128
2129 qc->tf.command = ATA_CMD_PACKET;
2130
2131 /* no data, or PIO data xfer */
2132 if (using_pio || nodata) {
2133 if (nodata)
2134 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2135 else
2136 qc->tf.protocol = ATA_PROT_ATAPI;
2137 qc->tf.lbam = (8 * 1024) & 0xff;
2138 qc->tf.lbah = (8 * 1024) >> 8;
2139 }
2140
2141 /* DMA data xfer */
2142 else {
2143 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2144 qc->tf.feature |= ATAPI_PKT_DMA;
2145
2146#ifdef ATAPI_ENABLE_DMADIR
2147 /* some SATA bridges need us to indicate data xfer direction */
be7db052005-04-17 15:26:13 -05002148 if (cmd->sc_data_direction != DMA_TO_DEVICE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 qc->tf.feature |= ATAPI_DMADIR;
2150#endif
2151 }
2152
2153 qc->nbytes = cmd->bufflen;
2154
2155 return 0;
2156}
2157
2158/**
2159 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2160 * @ap: ATA port to which the device is attached
2161 * @scsidev: SCSI device from which we derive the ATA device
2162 *
2163 * Given various information provided in struct scsi_cmnd,
2164 * map that onto an ATA bus, and using that mapping
2165 * determine which ata_device is associated with the
2166 * SCSI command to be sent.
2167 *
2168 * LOCKING:
2169 * spin_lock_irqsave(host_set lock)
2170 *
2171 * RETURNS:
2172 * Associated ATA device, or %NULL if not found.
2173 */
2174
2175static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002176ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177{
2178 struct ata_device *dev;
2179
2180 /* skip commands not addressed to targets we simulate */
2181 if (likely(scsidev->id < ATA_MAX_DEVICES))
2182 dev = &ap->device[scsidev->id];
2183 else
2184 return NULL;
2185
2186 if (unlikely((scsidev->channel != 0) ||
2187 (scsidev->lun != 0)))
2188 return NULL;
2189
2190 if (unlikely(!ata_dev_present(dev)))
2191 return NULL;
2192
Jeff Garzik50630192005-12-13 02:29:45 -05002193 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2194 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2195 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2196 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
Jeff Garzik1623c812005-08-30 03:37:42 -04002197 return NULL;
Jeff Garzik50630192005-12-13 02:29:45 -05002198 }
Jeff Garzik1623c812005-08-30 03:37:42 -04002199 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
2201 return dev;
2202}
2203
Jeff Garzikb0955182005-05-12 15:45:22 -04002204/*
2205 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2206 * @byte1: Byte 1 from pass-thru CDB.
2207 *
2208 * RETURNS:
2209 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2210 */
2211static u8
2212ata_scsi_map_proto(u8 byte1)
2213{
2214 switch((byte1 & 0x1e) >> 1) {
2215 case 3: /* Non-data */
2216 return ATA_PROT_NODATA;
2217
2218 case 6: /* DMA */
2219 return ATA_PROT_DMA;
2220
2221 case 4: /* PIO Data-in */
2222 case 5: /* PIO Data-out */
2223 if (byte1 & 0xe0) {
2224 return ATA_PROT_PIO_MULT;
2225 }
2226 return ATA_PROT_PIO;
2227
2228 case 10: /* Device Reset */
2229 case 0: /* Hard Reset */
2230 case 1: /* SRST */
2231 case 2: /* Bus Idle */
2232 case 7: /* Packet */
2233 case 8: /* DMA Queued */
2234 case 9: /* Device Diagnostic */
2235 case 11: /* UDMA Data-in */
2236 case 12: /* UDMA Data-Out */
2237 case 13: /* FPDMA */
2238 default: /* Reserved */
2239 break;
2240 }
2241
2242 return ATA_PROT_UNKNOWN;
2243}
2244
2245/**
2246 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2247 * @qc: command structure to be initialized
Randy Dunlap8e8b77d2005-11-01 21:29:27 -08002248 * @scsicmd: SCSI command to convert
Jeff Garzikb0955182005-05-12 15:45:22 -04002249 *
2250 * Handles either 12 or 16-byte versions of the CDB.
2251 *
2252 * RETURNS:
2253 * Zero on success, non-zero on failure.
2254 */
2255static unsigned int
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002256ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
Jeff Garzikb0955182005-05-12 15:45:22 -04002257{
2258 struct ata_taskfile *tf = &(qc->tf);
2259 struct scsi_cmnd *cmd = qc->scsicmd;
2260
2261 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
Tejun Heo9a405252005-12-02 11:49:11 +09002262 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002263
2264 /*
2265 * 12 and 16 byte CDBs use different offsets to
2266 * provide the various register values.
2267 */
2268 if (scsicmd[0] == ATA_16) {
2269 /*
2270 * 16-byte CDB - may contain extended commands.
2271 *
2272 * If that is the case, copy the upper byte register values.
2273 */
2274 if (scsicmd[1] & 0x01) {
2275 tf->hob_feature = scsicmd[3];
2276 tf->hob_nsect = scsicmd[5];
2277 tf->hob_lbal = scsicmd[7];
2278 tf->hob_lbam = scsicmd[9];
2279 tf->hob_lbah = scsicmd[11];
2280 tf->flags |= ATA_TFLAG_LBA48;
2281 } else
2282 tf->flags &= ~ATA_TFLAG_LBA48;
2283
2284 /*
2285 * Always copy low byte, device and command registers.
2286 */
2287 tf->feature = scsicmd[4];
2288 tf->nsect = scsicmd[6];
2289 tf->lbal = scsicmd[8];
2290 tf->lbam = scsicmd[10];
2291 tf->lbah = scsicmd[12];
2292 tf->device = scsicmd[13];
2293 tf->command = scsicmd[14];
2294 } else {
2295 /*
2296 * 12-byte CDB - incapable of extended commands.
2297 */
2298 tf->flags &= ~ATA_TFLAG_LBA48;
2299
2300 tf->feature = scsicmd[3];
2301 tf->nsect = scsicmd[4];
2302 tf->lbal = scsicmd[5];
2303 tf->lbam = scsicmd[6];
2304 tf->lbah = scsicmd[7];
2305 tf->device = scsicmd[8];
2306 tf->command = scsicmd[9];
2307 }
Mark Lorddcc2d1e2005-11-13 16:22:06 -05002308 /*
2309 * If slave is possible, enforce correct master/slave bit
2310 */
2311 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2312 tf->device = qc->dev->devno ?
2313 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002314
2315 /*
2316 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2317 * SET_FEATURES - XFER MODE must be preceded/succeeded
2318 * by an update to hardware-specific registers for each
2319 * controller (i.e. the reason for ->set_piomode(),
2320 * ->set_dmamode(), and ->post_set_mode() hooks).
2321 */
2322 if ((tf->command == ATA_CMD_SET_FEATURES)
2323 && (tf->feature == SETFEATURES_XFER))
Tejun Heo9a405252005-12-02 11:49:11 +09002324 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002325
2326 /*
2327 * Set flags so that all registers will be written,
2328 * and pass on write indication (used for PIO/DMA
2329 * setup.)
2330 */
2331 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2332
Jeff Garzik0274aa22005-06-22 13:50:56 -04002333 if (cmd->sc_data_direction == DMA_TO_DEVICE)
Jeff Garzikb0955182005-05-12 15:45:22 -04002334 tf->flags |= ATA_TFLAG_WRITE;
2335
2336 /*
2337 * Set transfer length.
2338 *
2339 * TODO: find out if we need to do more here to
2340 * cover scatter/gather case.
2341 */
2342 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2343
2344 return 0;
Tejun Heo9a405252005-12-02 11:49:11 +09002345
2346 invalid_fld:
2347 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2348 /* "Invalid field in cdb" */
2349 return 1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002350}
2351
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352/**
2353 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2354 * @dev: ATA device
2355 * @cmd: SCSI command opcode to consider
2356 *
2357 * Look up the SCSI command given, and determine whether the
2358 * SCSI command is to be translated or simulated.
2359 *
2360 * RETURNS:
2361 * Pointer to translation function if possible, %NULL if not.
2362 */
2363
2364static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2365{
2366 switch (cmd) {
2367 case READ_6:
2368 case READ_10:
2369 case READ_16:
2370
2371 case WRITE_6:
2372 case WRITE_10:
2373 case WRITE_16:
2374 return ata_scsi_rw_xlat;
2375
2376 case SYNCHRONIZE_CACHE:
2377 if (ata_try_flush_cache(dev))
2378 return ata_scsi_flush_xlat;
2379 break;
2380
2381 case VERIFY:
2382 case VERIFY_16:
2383 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04002384
2385 case ATA_12:
2386 case ATA_16:
2387 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04002388
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04002389 case START_STOP:
2390 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 }
2392
2393 return NULL;
2394}
2395
2396/**
2397 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2398 * @ap: ATA port to which the command was being sent
2399 * @cmd: SCSI command to dump
2400 *
2401 * Prints the contents of a SCSI command via printk().
2402 */
2403
2404static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2405 struct scsi_cmnd *cmd)
2406{
2407#ifdef ATA_DEBUG
2408 struct scsi_device *scsidev = cmd->device;
2409 u8 *scsicmd = cmd->cmnd;
2410
2411 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2412 ap->id,
2413 scsidev->channel, scsidev->id, scsidev->lun,
2414 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2415 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2416 scsicmd[8]);
2417#endif
2418}
2419
2420/**
2421 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2422 * @cmd: SCSI command to be sent
2423 * @done: Completion function, called when command is complete
2424 *
2425 * In some cases, this function translates SCSI commands into
2426 * ATA taskfiles, and queues the taskfiles to be sent to
2427 * hardware. In other cases, this function simulates a
2428 * SCSI device by evaluating and responding to certain
2429 * SCSI commands. This creates the overall effect of
2430 * ATA and ATAPI devices appearing as SCSI devices.
2431 *
2432 * LOCKING:
2433 * Releases scsi-layer-held lock, and obtains host_set lock.
2434 *
2435 * RETURNS:
2436 * Zero.
2437 */
2438
2439int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2440{
2441 struct ata_port *ap;
2442 struct ata_device *dev;
2443 struct scsi_device *scsidev = cmd->device;
Jeff Garzik005a5a02005-10-30 23:31:48 -05002444 struct Scsi_Host *shost = scsidev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
Jeff Garzik005a5a02005-10-30 23:31:48 -05002446 ap = (struct ata_port *) &shost->hostdata[0];
2447
2448 spin_unlock(shost->host_lock);
2449 spin_lock(&ap->host_set->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450
2451 ata_scsi_dump_cdb(ap, cmd);
2452
2453 dev = ata_scsi_find_dev(ap, scsidev);
2454 if (unlikely(!dev)) {
2455 cmd->result = (DID_BAD_TARGET << 16);
2456 done(cmd);
2457 goto out_unlock;
2458 }
2459
2460 if (dev->class == ATA_DEV_ATA) {
2461 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2462 cmd->cmnd[0]);
2463
2464 if (xlat_func)
2465 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2466 else
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002467 ata_scsi_simulate(ap, dev, cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 } else
2469 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2470
2471out_unlock:
Jeff Garzik005a5a02005-10-30 23:31:48 -05002472 spin_unlock(&ap->host_set->lock);
2473 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 return 0;
2475}
2476
2477/**
2478 * ata_scsi_simulate - simulate SCSI command on ATA device
2479 * @id: current IDENTIFY data for target device.
2480 * @cmd: SCSI command being sent to device.
2481 * @done: SCSI command completion function.
2482 *
2483 * Interprets and directly executes a select list of SCSI commands
2484 * that can be handled internally.
2485 *
2486 * LOCKING:
2487 * spin_lock_irqsave(host_set lock)
2488 */
2489
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002490void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 struct scsi_cmnd *cmd,
2492 void (*done)(struct scsi_cmnd *))
2493{
2494 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04002495 const u8 *scsicmd = cmd->cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002497 args.ap = ap;
2498 args.dev = dev;
2499 args.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 args.cmd = cmd;
2501 args.done = done;
2502
2503 switch(scsicmd[0]) {
2504 /* no-op's, complete with success */
2505 case SYNCHRONIZE_CACHE:
2506 case REZERO_UNIT:
2507 case SEEK_6:
2508 case SEEK_10:
2509 case TEST_UNIT_READY:
2510 case FORMAT_UNIT: /* FIXME: correct? */
2511 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2512 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2513 break;
2514
2515 case INQUIRY:
2516 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04002517 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2519 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2520 else if (scsicmd[2] == 0x00)
2521 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2522 else if (scsicmd[2] == 0x80)
2523 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2524 else if (scsicmd[2] == 0x83)
2525 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2526 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002527 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 break;
2529
2530 case MODE_SENSE:
2531 case MODE_SENSE_10:
2532 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2533 break;
2534
2535 case MODE_SELECT: /* unconditionally return */
2536 case MODE_SELECT_10: /* bad-field-in-cdb */
Douglas Gilbertae006512005-10-09 09:09:35 -04002537 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 break;
2539
2540 case READ_CAPACITY:
2541 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2542 break;
2543
2544 case SERVICE_ACTION_IN:
2545 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2546 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2547 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002548 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 break;
2550
2551 case REPORT_LUNS:
2552 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2553 break;
2554
Jeff Garzikb0955182005-05-12 15:45:22 -04002555 /* mandatory commands we haven't implemented yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 case REQUEST_SENSE:
2557
2558 /* all other commands */
2559 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04002560 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2561 /* "Invalid command operation code" */
2562 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 break;
2564 }
2565}
2566
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002567void ata_scsi_scan_host(struct ata_port *ap)
2568{
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002569 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002570 unsigned int i;
2571
2572 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2573 return;
2574
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002575 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2576 dev = &ap->device[i];
2577
2578 if (ata_dev_present(dev))
2579 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2580 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002581}
2582