blob: ec628cea386e99d4f737ccdd83000ae6fe0e368b [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>
Tejun Heo30afc842006-03-18 18:40:14 +090044#include <scsi/scsi_transport.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/libata.h>
Jeff Garzikb0955182005-05-12 15:45:22 -040046#include <linux/hdreg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <asm/uaccess.h>
48
49#include "libata.h"
50
Jeff Garzikb0955182005-05-12 15:45:22 -040051#define SECTOR_SIZE 512
52
Jeff Garzik057ace52005-10-22 14:27:05 -040053typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -040055ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
Tejun Heo30afc842006-03-18 18:40:14 +090056enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040058#define RW_RECOVERY_MPAGE 0x1
59#define RW_RECOVERY_MPAGE_LEN 12
60#define CACHE_MPAGE 0x8
61#define CACHE_MPAGE_LEN 20
62#define CONTROL_MPAGE 0xa
63#define CONTROL_MPAGE_LEN 12
64#define ALL_MPAGES 0x3f
65#define ALL_SUB_MPAGES 0xff
66
67
68static const u8 def_rw_recovery_mpage[] = {
69 RW_RECOVERY_MPAGE,
70 RW_RECOVERY_MPAGE_LEN - 2,
71 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
72 (1 << 6), /* ARRE (auto read reallocation) */
73 0, /* read retry count */
74 0, 0, 0, 0,
75 0, /* write retry count */
76 0, 0, 0
77};
78
79static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
80 CACHE_MPAGE,
81 CACHE_MPAGE_LEN - 2,
82 0, /* contains WCE, needs to be 0 for logic */
83 0, 0, 0, 0, 0, 0, 0, 0, 0,
84 0, /* contains DRA, needs to be 0 for logic */
85 0, 0, 0, 0, 0, 0, 0
86};
87
88static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
89 CONTROL_MPAGE,
90 CONTROL_MPAGE_LEN - 2,
91 2, /* DSENSE=0, GLTSD=1 */
92 0, /* [QAM+QERR may be 1, see 05-359r1] */
93 0, 0, 0, 0, 0xff, 0xff,
94 0, 30 /* extended self test time, see 05-359r1 */
95};
96
Tejun Heo30afc842006-03-18 18:40:14 +090097/*
98 * libata transport template. libata doesn't do real transport stuff.
99 * It just needs the eh_timed_out hook.
100 */
101struct scsi_transport_template ata_scsi_transport_template = {
102 .eh_timed_out = ata_scsi_timed_out,
103};
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Douglas Gilbertae006512005-10-09 09:09:35 -0400106static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
107 void (*done)(struct scsi_cmnd *))
108{
109 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
110 /* "Invalid field in cbd" */
111 done(cmd);
112}
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/**
115 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
116 * @sdev: SCSI device for which BIOS geometry is to be determined
117 * @bdev: block device associated with @sdev
118 * @capacity: capacity of SCSI device
119 * @geom: location to which geometry will be output
120 *
121 * Generic bios head/sector/cylinder calculator
122 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
123 * mapping. Some situations may arise where the disk is not
124 * bootable if this is not used.
125 *
126 * LOCKING:
127 * Defined by the SCSI layer. We don't really care.
128 *
129 * RETURNS:
130 * Zero.
131 */
132int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
133 sector_t capacity, int geom[])
134{
135 geom[0] = 255;
136 geom[1] = 63;
137 sector_div(capacity, 255*63);
138 geom[2] = capacity;
139
140 return 0;
141}
142
Jeff Garzikb0955182005-05-12 15:45:22 -0400143/**
144 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800145 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400146 * @arg: User provided data for issuing command
147 *
148 * LOCKING:
149 * Defined by the SCSI layer. We don't really care.
150 *
151 * RETURNS:
152 * Zero on success, negative errno on error.
153 */
154
155int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
156{
157 int rc = 0;
158 u8 scsi_cmd[MAX_COMMAND_SIZE];
159 u8 args[4], *argbuf = NULL;
160 int argsize = 0;
Mike Christie85837eb2005-11-11 16:38:53 -0600161 struct scsi_sense_hdr sshdr;
162 enum dma_data_direction data_dir;
Jeff Garzikb0955182005-05-12 15:45:22 -0400163
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500164 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400165 return -EINVAL;
166
167 if (copy_from_user(args, arg, sizeof(args)))
168 return -EFAULT;
169
Jeff Garzikb0955182005-05-12 15:45:22 -0400170 memset(scsi_cmd, 0, sizeof(scsi_cmd));
171
172 if (args[3]) {
173 argsize = SECTOR_SIZE * args[3];
174 argbuf = kmalloc(argsize, GFP_KERNEL);
Jeff Raubitschek54dac832005-10-04 10:21:19 -0400175 if (argbuf == NULL) {
176 rc = -ENOMEM;
177 goto error;
178 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400179
180 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
181 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
182 block count in sector count field */
Mike Christie85837eb2005-11-11 16:38:53 -0600183 data_dir = DMA_FROM_DEVICE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400184 } else {
185 scsi_cmd[1] = (3 << 1); /* Non-data */
186 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
Mike Christie85837eb2005-11-11 16:38:53 -0600187 data_dir = DMA_NONE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400188 }
189
190 scsi_cmd[0] = ATA_16;
191
192 scsi_cmd[4] = args[2];
193 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
194 scsi_cmd[6] = args[3];
195 scsi_cmd[8] = args[1];
196 scsi_cmd[10] = 0x4f;
197 scsi_cmd[12] = 0xc2;
198 } else {
199 scsi_cmd[6] = args[1];
200 }
201 scsi_cmd[14] = args[0];
202
203 /* Good values for timeout and retries? Values below
204 from scsi_ioctl_send_command() for default case... */
Mike Christie85837eb2005-11-11 16:38:53 -0600205 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
206 &sshdr, (10*HZ), 5)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400207 rc = -EIO;
208 goto error;
209 }
210
211 /* Need code to retrieve data from check condition? */
212
213 if ((argbuf)
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500214 && copy_to_user(arg + sizeof(args), argbuf, argsize))
Jeff Garzikb0955182005-05-12 15:45:22 -0400215 rc = -EFAULT;
216error:
Jeff Garzikb0955182005-05-12 15:45:22 -0400217 if (argbuf)
218 kfree(argbuf);
219
220 return rc;
221}
222
223/**
224 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800225 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400226 * @arg: User provided data for issuing command
227 *
228 * LOCKING:
229 * Defined by the SCSI layer. We don't really care.
230 *
231 * RETURNS:
232 * Zero on success, negative errno on error.
233 */
234int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
235{
236 int rc = 0;
237 u8 scsi_cmd[MAX_COMMAND_SIZE];
238 u8 args[7];
Mike Christie85837eb2005-11-11 16:38:53 -0600239 struct scsi_sense_hdr sshdr;
Jeff Garzikb0955182005-05-12 15:45:22 -0400240
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500241 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400242 return -EINVAL;
243
244 if (copy_from_user(args, arg, sizeof(args)))
245 return -EFAULT;
246
247 memset(scsi_cmd, 0, sizeof(scsi_cmd));
248 scsi_cmd[0] = ATA_16;
249 scsi_cmd[1] = (3 << 1); /* Non-data */
250 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
251 scsi_cmd[4] = args[1];
252 scsi_cmd[6] = args[2];
253 scsi_cmd[8] = args[3];
254 scsi_cmd[10] = args[4];
255 scsi_cmd[12] = args[5];
256 scsi_cmd[14] = args[0];
257
Jeff Garzikb0955182005-05-12 15:45:22 -0400258 /* Good values for timeout and retries? Values below
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500259 from scsi_ioctl_send_command() for default case... */
Mike Christie85837eb2005-11-11 16:38:53 -0600260 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
261 (10*HZ), 5))
Jeff Garzikb0955182005-05-12 15:45:22 -0400262 rc = -EIO;
Jeff Garzikb0955182005-05-12 15:45:22 -0400263
264 /* Need code to retrieve data from check condition? */
Jeff Garzikb0955182005-05-12 15:45:22 -0400265 return rc;
266}
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
269{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 int val = -EINVAL, rc = -EINVAL;
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 switch (cmd) {
273 case ATA_IOC_GET_IO32:
274 val = 0;
275 if (copy_to_user(arg, &val, 1))
276 return -EFAULT;
277 return 0;
278
279 case ATA_IOC_SET_IO32:
280 val = (unsigned long) arg;
281 if (val != 0)
282 return -EINVAL;
283 return 0;
284
Jeff Garzikb0955182005-05-12 15:45:22 -0400285 case HDIO_DRIVE_CMD:
286 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
287 return -EACCES;
288 return ata_cmd_ioctl(scsidev, arg);
289
290 case HDIO_DRIVE_TASK:
291 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
292 return -EACCES;
293 return ata_task_ioctl(scsidev, arg);
294
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 default:
296 rc = -ENOTTY;
297 break;
298 }
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 return rc;
301}
302
303/**
304 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
305 * @ap: ATA port to which the new command is attached
306 * @dev: ATA device to which the new command is attached
307 * @cmd: SCSI command that originated this ATA command
308 * @done: SCSI command completion function
309 *
310 * Obtain a reference to an unused ata_queued_cmd structure,
311 * which is the basic libata structure representing a single
312 * ATA command sent to the hardware.
313 *
314 * If a command was available, fill in the SCSI-specific
315 * portions of the structure with information on the
316 * current command.
317 *
318 * LOCKING:
319 * spin_lock_irqsave(host_set lock)
320 *
321 * RETURNS:
322 * Command allocated, or %NULL if none available.
323 */
324struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
325 struct ata_device *dev,
326 struct scsi_cmnd *cmd,
327 void (*done)(struct scsi_cmnd *))
328{
329 struct ata_queued_cmd *qc;
330
331 qc = ata_qc_new_init(ap, dev);
332 if (qc) {
333 qc->scsicmd = cmd;
334 qc->scsidone = done;
335
336 if (cmd->use_sg) {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400337 qc->__sg = (struct scatterlist *) cmd->request_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 qc->n_elem = cmd->use_sg;
339 } else {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400340 qc->__sg = &qc->sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 qc->n_elem = 1;
342 }
343 } else {
344 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
345 done(cmd);
346 }
347
348 return qc;
349}
350
351/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400352 * ata_dump_status - user friendly display of error info
353 * @id: id of the port in question
354 * @tf: ptr to filled out taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400356 * Decode and dump the ATA error/status registers for the user so
357 * that they have some idea what really happened at the non
358 * make-believe layer.
359 *
360 * LOCKING:
361 * inherited from caller
362 */
363void ata_dump_status(unsigned id, struct ata_taskfile *tf)
364{
365 u8 stat = tf->command, err = tf->feature;
366
367 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
368 if (stat & ATA_BUSY) {
369 printk("Busy }\n"); /* Data is not valid in this case */
370 } else {
371 if (stat & 0x40) printk("DriveReady ");
372 if (stat & 0x20) printk("DeviceFault ");
373 if (stat & 0x10) printk("SeekComplete ");
374 if (stat & 0x08) printk("DataRequest ");
375 if (stat & 0x04) printk("CorrectedError ");
376 if (stat & 0x02) printk("Index ");
377 if (stat & 0x01) printk("Error ");
378 printk("}\n");
379
380 if (err) {
381 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
382 if (err & 0x04) printk("DriveStatusError ");
383 if (err & 0x80) {
384 if (err & 0x04) printk("BadCRC ");
385 else printk("Sector ");
386 }
387 if (err & 0x40) printk("UncorrectableError ");
388 if (err & 0x10) printk("SectorIdNotFound ");
389 if (err & 0x02) printk("TrackZeroNotFound ");
390 if (err & 0x01) printk("AddrMarkNotFound ");
391 printk("}\n");
392 }
393 }
394}
395
Jens Axboe9b847542006-01-06 09:28:07 +0100396int ata_scsi_device_resume(struct scsi_device *sdev)
397{
398 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
399 struct ata_device *dev = &ap->device[sdev->id];
400
401 return ata_device_resume(ap, dev);
402}
403
Nigel Cunningham082776e2006-03-23 23:22:16 +1000404int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
Jens Axboe9b847542006-01-06 09:28:07 +0100405{
406 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
407 struct ata_device *dev = &ap->device[sdev->id];
408
Nigel Cunningham082776e2006-03-23 23:22:16 +1000409 return ata_device_suspend(ap, dev, state);
Jens Axboe9b847542006-01-06 09:28:07 +0100410}
411
Jeff Garzikb0955182005-05-12 15:45:22 -0400412/**
413 * ata_to_sense_error - convert ATA error to SCSI error
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800414 * @id: ATA device number
Jeff Garzikb0955182005-05-12 15:45:22 -0400415 * @drv_stat: value contained in ATA status register
416 * @drv_err: value contained in ATA error register
417 * @sk: the sense key we'll fill out
418 * @asc: the additional sense code we'll fill out
419 * @ascq: the additional sense code qualifier we'll fill out
420 *
421 * Converts an ATA error into a SCSI error. Fill out pointers to
422 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
423 * format sense blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 *
425 * LOCKING:
426 * spin_lock_irqsave(host_set lock)
427 */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500428void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
Jeff Garzikb0955182005-05-12 15:45:22 -0400429 u8 *ascq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430{
Jeff Garzikb0955182005-05-12 15:45:22 -0400431 int i;
Jeff Garzikffe75ef2005-10-09 10:40:44 -0400432
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 /* Based on the 3ware driver translation table */
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100434 static const unsigned char sense_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 /* BBD|ECC|ID|MAR */
436 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
437 /* BBD|ECC|ID */
438 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
439 /* ECC|MC|MARK */
440 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
441 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
442 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
443 /* MC|ID|ABRT|TRK0|MARK */
444 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
445 /* MCR|MARK */
446 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
447 /* Bad address mark */
448 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
449 /* TRK0 */
450 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
451 /* Abort & !ICRC */
452 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
453 /* Media change request */
454 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
455 /* SRV */
456 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
457 /* Media change */
458 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
459 /* ECC */
460 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
461 /* BBD - block marked bad */
462 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
463 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
464 };
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100465 static const unsigned char stat_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 /* Must be first because BUSY means no other bits valid */
467 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
468 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
469 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
470 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
471 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
472 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 /*
475 * Is this an error we can process/parse
476 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400477 if (drv_stat & ATA_BUSY) {
478 drv_err = 0; /* Ignore the err bits, they're invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Jeff Garzikb0955182005-05-12 15:45:22 -0400481 if (drv_err) {
482 /* Look for drv_err */
483 for (i = 0; sense_table[i][0] != 0xFF; i++) {
484 /* Look for best matches first */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500485 if ((sense_table[i][0] & drv_err) ==
Jeff Garzikb0955182005-05-12 15:45:22 -0400486 sense_table[i][0]) {
487 *sk = sense_table[i][1];
488 *asc = sense_table[i][2];
489 *ascq = sense_table[i][3];
490 goto translate_done;
491 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400493 /* No immediate match */
494 printk(KERN_WARNING "ata%u: no sense translation for "
495 "error 0x%02x\n", id, drv_err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 }
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 /* Fall back to interpreting status bits */
Jeff Garzikb0955182005-05-12 15:45:22 -0400499 for (i = 0; stat_table[i][0] != 0xFF; i++) {
500 if (stat_table[i][0] & drv_stat) {
501 *sk = stat_table[i][1];
502 *asc = stat_table[i][2];
503 *ascq = stat_table[i][3];
504 goto translate_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400507 /* No error? Undecoded? */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500508 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
Jeff Garzikb0955182005-05-12 15:45:22 -0400509 id, drv_stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Alan Cox2d202022006-03-21 15:53:46 +0000511 /* We need a sensible error return here, which is tricky, and one
512 that won't cause people to do things like return a disk wrongly */
513 *sk = ABORTED_COMMAND;
514 *asc = 0x00;
515 *ascq = 0x00;
Jeff Garzikb0955182005-05-12 15:45:22 -0400516
517 translate_done:
518 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
519 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
520 *sk, *asc, *ascq);
521 return;
522}
523
524/*
525 * ata_gen_ata_desc_sense - Generate check condition sense block.
526 * @qc: Command that completed.
527 *
528 * This function is specific to the ATA descriptor format sense
529 * block specified for the ATA pass through commands. Regardless
530 * of whether the command errored or not, return a sense
531 * block. Copy all controller registers into the sense
532 * block. Clear sense key, ASC & ASCQ if there is no error.
533 *
534 * LOCKING:
535 * spin_lock_irqsave(host_set lock)
536 */
537void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
538{
539 struct scsi_cmnd *cmd = qc->scsicmd;
540 struct ata_taskfile *tf = &qc->tf;
541 unsigned char *sb = cmd->sense_buffer;
542 unsigned char *desc = sb + 8;
543
544 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
545
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400546 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400547
548 /*
549 * Read the controller registers.
550 */
Tejun Heoa46314742006-02-11 19:11:13 +0900551 WARN_ON(qc->ap->ops->tf_read == NULL);
Jeff Garzikb0955182005-05-12 15:45:22 -0400552 qc->ap->ops->tf_read(qc->ap, tf);
553
554 /*
555 * Use ata_to_sense_error() to map status register bits
556 * onto sense key, asc & ascq.
557 */
Tejun Heo058e55e2006-04-02 18:51:53 +0900558 if (qc->err_mask ||
559 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400560 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
561 &sb[1], &sb[2], &sb[3]);
562 sb[1] &= 0x0f;
563 }
564
565 /*
566 * Sense data is current and format is descriptor.
567 */
568 sb[0] = 0x72;
569
570 desc[0] = 0x09;
571
572 /*
573 * Set length of additional sense data.
574 * Since we only populate descriptor 0, the total
575 * length is the same (fixed) length as descriptor 0.
576 */
577 desc[1] = sb[7] = 14;
578
579 /*
580 * Copy registers into sense buffer.
581 */
582 desc[2] = 0x00;
583 desc[3] = tf->feature; /* == error reg */
584 desc[5] = tf->nsect;
585 desc[7] = tf->lbal;
586 desc[9] = tf->lbam;
587 desc[11] = tf->lbah;
588 desc[12] = tf->device;
589 desc[13] = tf->command; /* == status reg */
590
591 /*
592 * Fill in Extend bit, and the high order bytes
593 * if applicable.
594 */
595 if (tf->flags & ATA_TFLAG_LBA48) {
596 desc[2] |= 0x01;
597 desc[4] = tf->hob_nsect;
598 desc[6] = tf->hob_lbal;
599 desc[8] = tf->hob_lbam;
600 desc[10] = tf->hob_lbah;
601 }
602}
603
604/**
605 * ata_gen_fixed_sense - generate a SCSI fixed sense block
606 * @qc: Command that we are erroring out
607 *
608 * Leverage ata_to_sense_error() to give us the codes. Fit our
609 * LBA in here if there's room.
610 *
611 * LOCKING:
612 * inherited from caller
613 */
614void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
615{
616 struct scsi_cmnd *cmd = qc->scsicmd;
617 struct ata_taskfile *tf = &qc->tf;
618 unsigned char *sb = cmd->sense_buffer;
619
620 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
621
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400622 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400623
624 /*
625 * Read the controller registers.
626 */
Tejun Heoa46314742006-02-11 19:11:13 +0900627 WARN_ON(qc->ap->ops->tf_read == NULL);
Jeff Garzikb0955182005-05-12 15:45:22 -0400628 qc->ap->ops->tf_read(qc->ap, tf);
629
630 /*
631 * Use ata_to_sense_error() to map status register bits
632 * onto sense key, asc & ascq.
633 */
Tejun Heo058e55e2006-04-02 18:51:53 +0900634 if (qc->err_mask ||
635 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400636 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
637 &sb[2], &sb[12], &sb[13]);
638 sb[2] &= 0x0f;
639 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
641 sb[0] = 0x70;
Jeff Garzikb0955182005-05-12 15:45:22 -0400642 sb[7] = 0x0a;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400643
Jeff Garzika7dac442005-10-30 04:44:42 -0500644 if (tf->flags & ATA_TFLAG_LBA48) {
645 /* TODO: find solution for LBA48 descriptors */
646 }
647
648 else if (tf->flags & ATA_TFLAG_LBA) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400649 /* A small (28b) LBA will fit in the 32b info field */
650 sb[0] |= 0x80; /* set valid bit */
651 sb[3] = tf->device & 0x0f;
652 sb[4] = tf->lbah;
653 sb[5] = tf->lbam;
654 sb[6] = tf->lbal;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 }
Jeff Garzika7dac442005-10-30 04:44:42 -0500656
657 else {
658 /* TODO: C/H/S */
659 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660}
661
Brian Kinga6cce2a2006-03-17 17:04:15 -0600662static void ata_scsi_sdev_config(struct scsi_device *sdev)
663{
664 sdev->use_10_for_rw = 1;
665 sdev->use_10_for_ms = 1;
666}
667
668static void ata_scsi_dev_config(struct scsi_device *sdev,
669 struct ata_device *dev)
670{
671 unsigned int max_sectors;
672
673 /* TODO: 2048 is an arbitrary number, not the
674 * hardware maximum. This should be increased to
675 * 65534 when Jens Axboe's patch for dynamically
676 * determining max_sectors is merged.
677 */
678 max_sectors = ATA_MAX_SECTORS;
679 if (dev->flags & ATA_DFLAG_LBA48)
680 max_sectors = 2048;
681 if (dev->max_sectors)
682 max_sectors = dev->max_sectors;
683
684 blk_queue_max_sectors(sdev->request_queue, max_sectors);
685
686 /*
687 * SATA DMA transfers must be multiples of 4 byte, so
688 * we need to pad ATAPI transfers using an extra sg.
689 * Decrement max hw segments accordingly.
690 */
691 if (dev->class == ATA_DEV_ATAPI) {
692 request_queue_t *q = sdev->request_queue;
693 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
694 }
695}
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/**
698 * ata_scsi_slave_config - Set SCSI device attributes
699 * @sdev: SCSI device to examine
700 *
701 * This is called before we actually start reading
702 * and writing to the device, to configure certain
703 * SCSI mid-layer behaviors.
704 *
705 * LOCKING:
706 * Defined by SCSI layer. We don't really care.
707 */
708
709int ata_scsi_slave_config(struct scsi_device *sdev)
710{
Brian Kinga6cce2a2006-03-17 17:04:15 -0600711 ata_scsi_sdev_config(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
714
715 if (sdev->id < ATA_MAX_DEVICES) {
716 struct ata_port *ap;
717 struct ata_device *dev;
718
719 ap = (struct ata_port *) &sdev->host->hostdata[0];
720 dev = &ap->device[sdev->id];
721
Brian Kinga6cce2a2006-03-17 17:04:15 -0600722 ata_scsi_dev_config(sdev, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
724
725 return 0; /* scsi layer doesn't check return value, sigh */
726}
727
728/**
Tejun Heof29841e2006-02-10 15:10:48 +0900729 * ata_scsi_timed_out - SCSI layer time out callback
730 * @cmd: timed out SCSI command
731 *
732 * Handles SCSI layer timeout. We race with normal completion of
733 * the qc for @cmd. If the qc is already gone, we lose and let
734 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
735 * timed out and EH should be invoked. Prevent ata_qc_complete()
736 * from finishing it by setting EH_SCHEDULED and return
737 * EH_NOT_HANDLED.
738 *
739 * LOCKING:
740 * Called from timer context
741 *
742 * RETURNS:
743 * EH_HANDLED or EH_NOT_HANDLED
744 */
745enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
746{
747 struct Scsi_Host *host = cmd->device->host;
748 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
749 unsigned long flags;
750 struct ata_queued_cmd *qc;
751 enum scsi_eh_timer_return ret = EH_HANDLED;
752
753 DPRINTK("ENTER\n");
754
755 spin_lock_irqsave(&ap->host_set->lock, flags);
756 qc = ata_qc_from_tag(ap, ap->active_tag);
757 if (qc) {
Tejun Heoa46314742006-02-11 19:11:13 +0900758 WARN_ON(qc->scsicmd != cmd);
Tejun Heof29841e2006-02-10 15:10:48 +0900759 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
760 qc->err_mask |= AC_ERR_TIMEOUT;
761 ret = EH_NOT_HANDLED;
762 }
763 spin_unlock_irqrestore(&ap->host_set->lock, flags);
764
765 DPRINTK("EXIT, ret=%d\n", ret);
766 return ret;
767}
768
769/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 * ata_scsi_error - SCSI layer error handler callback
771 * @host: SCSI host on which error occurred
772 *
773 * Handles SCSI-layer-thrown error events.
774 *
775 * LOCKING:
776 * Inherited from SCSI layer (none, can sleep)
777 *
778 * RETURNS:
779 * Zero.
780 */
781
782int ata_scsi_error(struct Scsi_Host *host)
783{
Tejun Heoc43c5552006-04-02 18:51:52 +0900784 struct ata_port *ap = (struct ata_port *)&host->hostdata[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
786 DPRINTK("ENTER\n");
787
Tejun Heoc43c5552006-04-02 18:51:52 +0900788 /* synchronize with IRQ handler and port task */
789 spin_unlock_wait(&ap->host_set->lock);
Tejun Heo86e45b62006-03-05 15:29:09 +0900790 ata_port_flush_task(ap);
791
Tejun Heoc43c5552006-04-02 18:51:52 +0900792 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 ap->ops->eng_timeout(ap);
795
Tejun Heoa46314742006-02-11 19:11:13 +0900796 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900797
798 scsi_eh_flush_done_q(&ap->eh_done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
800 DPRINTK("EXIT\n");
801 return 0;
802}
803
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900804static void ata_eh_scsidone(struct scsi_cmnd *scmd)
805{
806 /* nada */
807}
808
809static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
810{
811 struct ata_port *ap = qc->ap;
812 struct scsi_cmnd *scmd = qc->scsicmd;
813 unsigned long flags;
814
815 spin_lock_irqsave(&ap->host_set->lock, flags);
816 qc->scsidone = ata_eh_scsidone;
Tejun Heo341963b2006-02-10 15:10:48 +0900817 __ata_qc_complete(qc);
Tejun Heoa46314742006-02-11 19:11:13 +0900818 WARN_ON(ata_tag_valid(qc->tag));
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900819 spin_unlock_irqrestore(&ap->host_set->lock, flags);
820
821 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
822}
823
824/**
825 * ata_eh_qc_complete - Complete an active ATA command from EH
826 * @qc: Command to complete
827 *
828 * Indicate to the mid and upper layers that an ATA command has
829 * completed. To be used from EH.
830 */
831void ata_eh_qc_complete(struct ata_queued_cmd *qc)
832{
833 struct scsi_cmnd *scmd = qc->scsicmd;
834 scmd->retries = scmd->allowed;
835 __ata_eh_qc_complete(qc);
836}
837
838/**
839 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
840 * @qc: Command to retry
841 *
842 * Indicate to the mid and upper layers that an ATA command
843 * should be retried. To be used from EH.
844 *
845 * SCSI midlayer limits the number of retries to scmd->allowed.
846 * This function might need to adjust scmd->retries for commands
847 * which get retried due to unrelated NCQ failures.
848 */
849void ata_eh_qc_retry(struct ata_queued_cmd *qc)
850{
851 __ata_eh_qc_complete(qc);
852}
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400855 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
856 * @qc: Storage for translated ATA taskfile
857 * @scsicmd: SCSI command to translate
858 *
859 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
860 * (to start). Perhaps these commands should be preceded by
861 * CHECK POWER MODE to see what power mode the device is already in.
862 * [See SAT revision 5 at www.t10.org]
863 *
864 * LOCKING:
865 * spin_lock_irqsave(host_set lock)
866 *
867 * RETURNS:
868 * Zero on success, non-zero on error.
869 */
870
871static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
Jeff Garzik057ace52005-10-22 14:27:05 -0400872 const u8 *scsicmd)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400873{
874 struct ata_taskfile *tf = &qc->tf;
875
876 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
877 tf->protocol = ATA_PROT_NODATA;
878 if (scsicmd[1] & 0x1) {
879 ; /* ignore IMMED bit, violates sat-r05 */
880 }
881 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400882 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400883 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400884 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400885 if (scsicmd[4] & 0x1) {
886 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400887
888 if (qc->dev->flags & ATA_DFLAG_LBA) {
889 qc->tf.flags |= ATA_TFLAG_LBA;
890
891 tf->lbah = 0x0;
892 tf->lbam = 0x0;
893 tf->lbal = 0x0;
894 tf->device |= ATA_LBA;
895 } else {
896 /* CHS */
897 tf->lbal = 0x1; /* sect */
898 tf->lbam = 0x0; /* cyl low */
899 tf->lbah = 0x0; /* cyl high */
900 }
901
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400902 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
903 } else {
904 tf->nsect = 0; /* time period value (0 implies now) */
905 tf->command = ATA_CMD_STANDBY;
906 /* Consider: ATA STANDBY IMMEDIATE command */
907 }
908 /*
909 * Standby and Idle condition timers could be implemented but that
910 * would require libata to implement the Power condition mode page
911 * and allow the user to change it. Changing mode pages requires
912 * MODE SELECT to be implemented.
913 */
914
915 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400916
917invalid_fld:
918 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
919 /* "Invalid field in cbd" */
920 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400921}
922
923
924/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
926 * @qc: Storage for translated ATA taskfile
927 * @scsicmd: SCSI command to translate (ignored)
928 *
929 * Sets up an ATA taskfile to issue FLUSH CACHE or
930 * FLUSH CACHE EXT.
931 *
932 * LOCKING:
933 * spin_lock_irqsave(host_set lock)
934 *
935 * RETURNS:
936 * Zero on success, non-zero on error.
937 */
938
Jeff Garzik057ace52005-10-22 14:27:05 -0400939static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
941 struct ata_taskfile *tf = &qc->tf;
942
943 tf->flags |= ATA_TFLAG_DEVICE;
944 tf->protocol = ATA_PROT_NODATA;
945
Albert Lee07506692005-10-12 15:04:18 +0800946 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 (ata_id_has_flush_ext(qc->dev->id)))
948 tf->command = ATA_CMD_FLUSH_EXT;
949 else
950 tf->command = ATA_CMD_FLUSH;
951
952 return 0;
953}
954
955/**
Albert Lee3aef5232005-10-04 08:47:43 -0400956 * scsi_6_lba_len - Get LBA and transfer length
957 * @scsicmd: SCSI command to translate
958 *
959 * Calculate LBA and transfer length for 6-byte commands.
960 *
961 * RETURNS:
962 * @plba: the LBA
963 * @plen: the transfer length
964 */
965
Jeff Garzik057ace52005-10-22 14:27:05 -0400966static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400967{
968 u64 lba = 0;
969 u32 len = 0;
970
971 VPRINTK("six-byte command\n");
972
973 lba |= ((u64)scsicmd[2]) << 8;
974 lba |= ((u64)scsicmd[3]);
975
976 len |= ((u32)scsicmd[4]);
977
978 *plba = lba;
979 *plen = len;
980}
981
982/**
983 * scsi_10_lba_len - Get LBA and transfer length
984 * @scsicmd: SCSI command to translate
985 *
986 * Calculate LBA and transfer length for 10-byte commands.
987 *
988 * RETURNS:
989 * @plba: the LBA
990 * @plen: the transfer length
991 */
992
Jeff Garzik057ace52005-10-22 14:27:05 -0400993static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400994{
995 u64 lba = 0;
996 u32 len = 0;
997
998 VPRINTK("ten-byte command\n");
999
1000 lba |= ((u64)scsicmd[2]) << 24;
1001 lba |= ((u64)scsicmd[3]) << 16;
1002 lba |= ((u64)scsicmd[4]) << 8;
1003 lba |= ((u64)scsicmd[5]);
1004
1005 len |= ((u32)scsicmd[7]) << 8;
1006 len |= ((u32)scsicmd[8]);
1007
1008 *plba = lba;
1009 *plen = len;
1010}
1011
1012/**
1013 * scsi_16_lba_len - Get LBA and transfer length
1014 * @scsicmd: SCSI command to translate
1015 *
1016 * Calculate LBA and transfer length for 16-byte commands.
1017 *
1018 * RETURNS:
1019 * @plba: the LBA
1020 * @plen: the transfer length
1021 */
1022
Jeff Garzik057ace52005-10-22 14:27:05 -04001023static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001024{
1025 u64 lba = 0;
1026 u32 len = 0;
1027
1028 VPRINTK("sixteen-byte command\n");
1029
1030 lba |= ((u64)scsicmd[2]) << 56;
1031 lba |= ((u64)scsicmd[3]) << 48;
1032 lba |= ((u64)scsicmd[4]) << 40;
1033 lba |= ((u64)scsicmd[5]) << 32;
1034 lba |= ((u64)scsicmd[6]) << 24;
1035 lba |= ((u64)scsicmd[7]) << 16;
1036 lba |= ((u64)scsicmd[8]) << 8;
1037 lba |= ((u64)scsicmd[9]);
1038
1039 len |= ((u32)scsicmd[10]) << 24;
1040 len |= ((u32)scsicmd[11]) << 16;
1041 len |= ((u32)scsicmd[12]) << 8;
1042 len |= ((u32)scsicmd[13]);
1043
1044 *plba = lba;
1045 *plen = len;
1046}
1047
1048/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1050 * @qc: Storage for translated ATA taskfile
1051 * @scsicmd: SCSI command to translate
1052 *
1053 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1054 *
1055 * LOCKING:
1056 * spin_lock_irqsave(host_set lock)
1057 *
1058 * RETURNS:
1059 * Zero on success, non-zero on error.
1060 */
1061
Jeff Garzik057ace52005-10-22 14:27:05 -04001062static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063{
1064 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001065 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -04001067 u64 block;
1068 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069
1070 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1071 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Albert Lee3aef5232005-10-04 08:47:43 -04001073 if (scsicmd[0] == VERIFY)
1074 scsi_10_lba_len(scsicmd, &block, &n_block);
1075 else if (scsicmd[0] == VERIFY_16)
1076 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 else
Douglas Gilbertae006512005-10-09 09:09:35 -04001078 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
Albert Lee8bf62ece2005-05-12 15:29:42 -04001080 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -04001081 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001082 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001083 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001084 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001085 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Albert Lee07506692005-10-12 15:04:18 +08001087 if (dev->flags & ATA_DFLAG_LBA) {
1088 tf->flags |= ATA_TFLAG_LBA;
1089
Albert Leec6a33e22005-10-12 15:12:26 +08001090 if (lba_28_ok(block, n_block)) {
1091 /* use LBA28 */
1092 tf->command = ATA_CMD_VERIFY;
1093 tf->device |= (block >> 24) & 0xf;
1094 } else if (lba_48_ok(block, n_block)) {
1095 if (!(dev->flags & ATA_DFLAG_LBA48))
1096 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001097
1098 /* use LBA48 */
1099 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001100 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Albert Lee8bf62ece2005-05-12 15:29:42 -04001102 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Albert Lee8bf62ece2005-05-12 15:29:42 -04001104 tf->hob_lbah = (block >> 40) & 0xff;
1105 tf->hob_lbam = (block >> 32) & 0xff;
1106 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001107 } else
1108 /* request too large even for LBA48 */
1109 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001110
1111 tf->nsect = n_block & 0xff;
1112
1113 tf->lbah = (block >> 16) & 0xff;
1114 tf->lbam = (block >> 8) & 0xff;
1115 tf->lbal = block & 0xff;
1116
1117 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001119 /* CHS */
1120 u32 sect, head, cyl, track;
1121
Albert Leec6a33e22005-10-12 15:12:26 +08001122 if (!lba_28_ok(block, n_block))
1123 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001124
Albert Lee8bf62ece2005-05-12 15:29:42 -04001125 /* Convert LBA to CHS */
1126 track = (u32)block / dev->sectors;
1127 cyl = track / dev->heads;
1128 head = track % dev->heads;
1129 sect = (u32)block % dev->sectors + 1;
1130
Albert Leec187c4b2005-10-04 08:46:51 -04001131 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1132 (u32)block, track, cyl, head, sect);
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001133
1134 /* Check whether the converted CHS can fit.
1135 Cylinder: 0-65535
Albert Lee8bf62ece2005-05-12 15:29:42 -04001136 Head: 0-15
1137 Sector: 1-255*/
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001138 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001139 goto out_of_range;
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001140
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001142 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1143 tf->lbal = sect;
1144 tf->lbam = cyl;
1145 tf->lbah = cyl >> 8;
1146 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 }
1148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001150
1151invalid_fld:
1152 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1153 /* "Invalid field in cbd" */
1154 return 1;
1155
1156out_of_range:
1157 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1158 /* "Logical Block Address out of range" */
1159 return 1;
1160
1161nothing_to_do:
1162 qc->scsicmd->result = SAM_STAT_GOOD;
1163 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164}
1165
1166/**
1167 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1168 * @qc: Storage for translated ATA taskfile
1169 * @scsicmd: SCSI command to translate
1170 *
1171 * Converts any of six SCSI read/write commands into the
1172 * ATA counterpart, including starting sector (LBA),
1173 * sector count, and taking into account the device's LBA48
1174 * support.
1175 *
1176 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1177 * %WRITE_16 are currently supported.
1178 *
1179 * LOCKING:
1180 * spin_lock_irqsave(host_set lock)
1181 *
1182 * RETURNS:
1183 * Zero on success, non-zero on error.
1184 */
1185
Jeff Garzik057ace52005-10-22 14:27:05 -04001186static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
1188 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001189 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -04001190 u64 block;
1191 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Tejun Heo27197362006-04-02 18:51:53 +09001193 qc->flags |= ATA_QCFLAG_IO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Albert Lee8cbd6df2005-10-12 15:06:27 +08001196 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1197 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001200 /* Calculate the SCSI LBA, transfer length and FUA. */
Albert Lee3aef5232005-10-04 08:47:43 -04001201 switch (scsicmd[0]) {
1202 case READ_10:
1203 case WRITE_10:
1204 scsi_10_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001205 if (unlikely(scsicmd[1] & (1 << 3)))
1206 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001207 break;
1208 case READ_6:
1209 case WRITE_6:
1210 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001211
1212 /* for 6-byte r/w commands, transfer length 0
1213 * means 256 blocks of data, not 0 block.
1214 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001215 if (!n_block)
1216 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -04001217 break;
1218 case READ_16:
1219 case WRITE_16:
1220 scsi_16_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001221 if (unlikely(scsicmd[1] & (1 << 3)))
1222 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001223 break;
1224 default:
Albert Lee8bf62ece2005-05-12 15:29:42 -04001225 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001226 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 }
1228
Albert Lee8bf62ece2005-05-12 15:29:42 -04001229 /* Check and compose ATA command */
1230 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001231 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1232 * length 0 means transfer 0 block of data.
1233 * However, for ATA R/W commands, sector count 0 means
1234 * 256 or 65536 sectors, not 0 sectors as in SCSI.
Alan Coxf51750d2005-11-07 17:06:33 +00001235 *
1236 * WARNING: one or two older ATA drives treat 0 as 0...
Albert Leec187c4b2005-10-04 08:46:51 -04001237 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001238 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001239
Albert Lee07506692005-10-12 15:04:18 +08001240 if (dev->flags & ATA_DFLAG_LBA) {
1241 tf->flags |= ATA_TFLAG_LBA;
1242
Albert Leec6a33e22005-10-12 15:12:26 +08001243 if (lba_28_ok(block, n_block)) {
1244 /* use LBA28 */
1245 tf->device |= (block >> 24) & 0xf;
1246 } else if (lba_48_ok(block, n_block)) {
1247 if (!(dev->flags & ATA_DFLAG_LBA48))
Douglas Gilbertae006512005-10-09 09:09:35 -04001248 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001249
Albert Lee07506692005-10-12 15:04:18 +08001250 /* use LBA48 */
1251 tf->flags |= ATA_TFLAG_LBA48;
1252
Albert Lee8bf62ece2005-05-12 15:29:42 -04001253 tf->hob_nsect = (n_block >> 8) & 0xff;
1254
1255 tf->hob_lbah = (block >> 40) & 0xff;
1256 tf->hob_lbam = (block >> 32) & 0xff;
1257 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001258 } else
1259 /* request too large even for LBA48 */
1260 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001261
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001262 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1263 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001264
Albert Lee8bf62ece2005-05-12 15:29:42 -04001265 qc->nsect = n_block;
1266 tf->nsect = n_block & 0xff;
1267
1268 tf->lbah = (block >> 16) & 0xff;
1269 tf->lbam = (block >> 8) & 0xff;
1270 tf->lbal = block & 0xff;
1271
1272 tf->device |= ATA_LBA;
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001273 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001274 /* CHS */
1275 u32 sect, head, cyl, track;
1276
1277 /* The request -may- be too large for CHS addressing. */
Albert Leec6a33e22005-10-12 15:12:26 +08001278 if (!lba_28_ok(block, n_block))
Douglas Gilbertae006512005-10-09 09:09:35 -04001279 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001280
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001281 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1282 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001283
Albert Lee8bf62ece2005-05-12 15:29:42 -04001284 /* Convert LBA to CHS */
1285 track = (u32)block / dev->sectors;
1286 cyl = track / dev->heads;
1287 head = track % dev->heads;
1288 sect = (u32)block % dev->sectors + 1;
1289
Albert Leec187c4b2005-10-04 08:46:51 -04001290 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ece2005-05-12 15:29:42 -04001291 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -04001292
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001293 /* Check whether the converted CHS can fit.
1294 Cylinder: 0-65535
Albert Lee8bf62ece2005-05-12 15:29:42 -04001295 Head: 0-15
1296 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -04001297 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001298 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001299
Albert Lee8bf62ece2005-05-12 15:29:42 -04001300 qc->nsect = n_block;
1301 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1302 tf->lbal = sect;
1303 tf->lbam = cyl;
1304 tf->lbah = cyl >> 8;
1305 tf->device |= head;
1306 }
1307
1308 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001309
1310invalid_fld:
1311 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1312 /* "Invalid field in cbd" */
1313 return 1;
1314
1315out_of_range:
1316 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1317 /* "Logical Block Address out of range" */
1318 return 1;
1319
1320nothing_to_do:
1321 qc->scsicmd->result = SAM_STAT_GOOD;
1322 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323}
1324
Tejun Heo77853bf2006-01-23 13:09:36 +09001325static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326{
1327 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001328 u8 *cdb = cmd->cmnd;
Albert Leea22e2eb2005-12-05 15:38:02 +08001329 int need_sense = (qc->err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Jeff Garzikb0955182005-05-12 15:45:22 -04001331 /* For ATA pass thru (SAT) commands, generate a sense block if
1332 * user mandated it or if there's an error. Note that if we
1333 * generate because the user forced us to, a check condition
1334 * is generated and the ATA register values are returned
1335 * whether the command completed successfully or not. If there
1336 * was no error, SK, ASC and ASCQ will all be zero.
1337 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001338 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1339 ((cdb[2] & 0x20) || need_sense)) {
Jeff Garzikb0955182005-05-12 15:45:22 -04001340 ata_gen_ata_desc_sense(qc);
1341 } else {
1342 if (!need_sense) {
1343 cmd->result = SAM_STAT_GOOD;
1344 } else {
1345 /* TODO: decide which descriptor format to use
1346 * for 48b LBA devices and call that here
1347 * instead of the fixed desc, which is only
1348 * good for smaller LBA (and maybe CHS?)
1349 * devices.
1350 */
1351 ata_gen_fixed_sense(qc);
1352 }
1353 }
1354
1355 if (need_sense) {
1356 /* The ata_gen_..._sense routines fill in tf */
1357 ata_dump_status(qc->ap->id, &qc->tf);
1358 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359
1360 qc->scsidone(cmd);
1361
Tejun Heo77853bf2006-01-23 13:09:36 +09001362 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363}
1364
1365/**
1366 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1367 * @ap: ATA port to which the command is addressed
1368 * @dev: ATA device to which the command is addressed
1369 * @cmd: SCSI command to execute
1370 * @done: SCSI command completion function
1371 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1372 *
1373 * Our ->queuecommand() function has decided that the SCSI
1374 * command issued can be directly translated into an ATA
1375 * command, rather than handled internally.
1376 *
1377 * This function sets up an ata_queued_cmd structure for the
1378 * SCSI command, and sends that ata_queued_cmd to the hardware.
1379 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001380 * The xlat_func argument (actor) returns 0 if ready to execute
1381 * ATA command, else 1 to finish translation. If 1 is returned
1382 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1383 * to be set reflecting an error condition or clean (early)
1384 * termination.
1385 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 * LOCKING:
1387 * spin_lock_irqsave(host_set lock)
1388 */
1389
1390static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1391 struct scsi_cmnd *cmd,
1392 void (*done)(struct scsi_cmnd *),
1393 ata_xlat_func_t xlat_func)
1394{
1395 struct ata_queued_cmd *qc;
1396 u8 *scsicmd = cmd->cmnd;
1397
1398 VPRINTK("ENTER\n");
1399
1400 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1401 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001402 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
1404 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -05001405 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1406 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 if (unlikely(cmd->request_bufflen < 1)) {
1408 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1409 ap->id, dev->devno);
Douglas Gilbertae006512005-10-09 09:09:35 -04001410 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 }
1412
1413 if (cmd->use_sg)
1414 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1415 else
1416 ata_sg_init_one(qc, cmd->request_buffer,
1417 cmd->request_bufflen);
1418
1419 qc->dma_dir = cmd->sc_data_direction;
1420 }
1421
1422 qc->complete_fn = ata_scsi_qc_complete;
1423
1424 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -04001425 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
1427 /* select device, send command to hardware */
Tejun Heo8e0e6942006-03-31 20:41:11 +09001428 ata_qc_issue(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
1430 VPRINTK("EXIT\n");
1431 return;
1432
Douglas Gilbertae006512005-10-09 09:09:35 -04001433early_finish:
1434 ata_qc_free(qc);
1435 done(cmd);
1436 DPRINTK("EXIT - early finish (good or error)\n");
1437 return;
1438
1439err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001441err_mem:
1442 cmd->result = (DID_ERROR << 16);
1443 done(cmd);
1444 DPRINTK("EXIT - internal\n");
1445 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446}
1447
1448/**
1449 * ata_scsi_rbuf_get - Map response buffer.
1450 * @cmd: SCSI command containing buffer to be mapped.
1451 * @buf_out: Pointer to mapped area.
1452 *
1453 * Maps buffer contained within SCSI command @cmd.
1454 *
1455 * LOCKING:
1456 * spin_lock_irqsave(host_set lock)
1457 *
1458 * RETURNS:
1459 * Length of response buffer.
1460 */
1461
1462static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1463{
1464 u8 *buf;
1465 unsigned int buflen;
1466
1467 if (cmd->use_sg) {
1468 struct scatterlist *sg;
1469
1470 sg = (struct scatterlist *) cmd->request_buffer;
1471 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1472 buflen = sg->length;
1473 } else {
1474 buf = cmd->request_buffer;
1475 buflen = cmd->request_bufflen;
1476 }
1477
1478 *buf_out = buf;
1479 return buflen;
1480}
1481
1482/**
1483 * ata_scsi_rbuf_put - Unmap response buffer.
1484 * @cmd: SCSI command containing buffer to be unmapped.
1485 * @buf: buffer to unmap
1486 *
1487 * Unmaps response buffer contained within @cmd.
1488 *
1489 * LOCKING:
1490 * spin_lock_irqsave(host_set lock)
1491 */
1492
1493static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1494{
1495 if (cmd->use_sg) {
1496 struct scatterlist *sg;
1497
1498 sg = (struct scatterlist *) cmd->request_buffer;
1499 kunmap_atomic(buf - sg->offset, KM_USER0);
1500 }
1501}
1502
1503/**
1504 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1505 * @args: device IDENTIFY data / SCSI command of interest.
1506 * @actor: Callback hook for desired SCSI command simulator
1507 *
1508 * Takes care of the hard work of simulating a SCSI command...
1509 * Mapping the response buffer, calling the command's handler,
1510 * and handling the handler's return value. This return value
1511 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001512 * completed successfully (0), or not (in which case cmd->result
1513 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 *
1515 * LOCKING:
1516 * spin_lock_irqsave(host_set lock)
1517 */
1518
1519void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1520 unsigned int (*actor) (struct ata_scsi_args *args,
1521 u8 *rbuf, unsigned int buflen))
1522{
1523 u8 *rbuf;
1524 unsigned int buflen, rc;
1525 struct scsi_cmnd *cmd = args->cmd;
1526
1527 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1528 memset(rbuf, 0, buflen);
1529 rc = actor(args, rbuf, buflen);
1530 ata_scsi_rbuf_put(cmd, rbuf);
1531
Douglas Gilbertae006512005-10-09 09:09:35 -04001532 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001534 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535}
1536
1537/**
1538 * ata_scsiop_inq_std - Simulate INQUIRY command
1539 * @args: device IDENTIFY data / SCSI command of interest.
1540 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1541 * @buflen: Response buffer length.
1542 *
1543 * Returns standard device identification data associated
Jeff Garzikb142eb62006-03-21 20:37:47 -05001544 * with non-VPD INQUIRY command output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 *
1546 * LOCKING:
1547 * spin_lock_irqsave(host_set lock)
1548 */
1549
1550unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1551 unsigned int buflen)
1552{
1553 u8 hdr[] = {
1554 TYPE_DISK,
1555 0,
1556 0x5, /* claim SPC-3 version compatibility */
1557 2,
1558 95 - 4
1559 };
1560
1561 /* set scsi removeable (RMB) bit per ata bit */
1562 if (ata_id_removeable(args->id))
1563 hdr[1] |= (1 << 7);
1564
1565 VPRINTK("ENTER\n");
1566
1567 memcpy(rbuf, hdr, sizeof(hdr));
1568
1569 if (buflen > 35) {
1570 memcpy(&rbuf[8], "ATA ", 8);
Tejun Heo6a62a042006-02-13 10:02:46 +09001571 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1572 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 if (rbuf[32] == 0 || rbuf[32] == ' ')
1574 memcpy(&rbuf[32], "n/a ", 4);
1575 }
1576
1577 if (buflen > 63) {
1578 const u8 versions[] = {
1579 0x60, /* SAM-3 (no version claimed) */
1580
1581 0x03,
1582 0x20, /* SBC-2 (no version claimed) */
1583
1584 0x02,
1585 0x60 /* SPC-3 (no version claimed) */
1586 };
1587
1588 memcpy(rbuf + 59, versions, sizeof(versions));
1589 }
1590
1591 return 0;
1592}
1593
1594/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001595 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 * @args: device IDENTIFY data / SCSI command of interest.
1597 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1598 * @buflen: Response buffer length.
1599 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001600 * Returns list of inquiry VPD pages available.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 *
1602 * LOCKING:
1603 * spin_lock_irqsave(host_set lock)
1604 */
1605
1606unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1607 unsigned int buflen)
1608{
1609 const u8 pages[] = {
1610 0x00, /* page 0x00, this page */
1611 0x80, /* page 0x80, unit serial no page */
1612 0x83 /* page 0x83, device ident page */
1613 };
Jeff Garzikb142eb62006-03-21 20:37:47 -05001614 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
1616 if (buflen > 6)
1617 memcpy(rbuf + 4, pages, sizeof(pages));
1618
1619 return 0;
1620}
1621
1622/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001623 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 * @args: device IDENTIFY data / SCSI command of interest.
1625 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1626 * @buflen: Response buffer length.
1627 *
1628 * Returns ATA device serial number.
1629 *
1630 * LOCKING:
1631 * spin_lock_irqsave(host_set lock)
1632 */
1633
1634unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1635 unsigned int buflen)
1636{
1637 const u8 hdr[] = {
1638 0,
1639 0x80, /* this page code */
1640 0,
1641 ATA_SERNO_LEN, /* page len */
1642 };
1643 memcpy(rbuf, hdr, sizeof(hdr));
1644
1645 if (buflen > (ATA_SERNO_LEN + 4 - 1))
Tejun Heo6a62a042006-02-13 10:02:46 +09001646 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1647 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
1649 return 0;
1650}
1651
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001653 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 * @args: device IDENTIFY data / SCSI command of interest.
1655 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1656 * @buflen: Response buffer length.
1657 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001658 * Yields two logical unit device identification designators:
1659 * - vendor specific ASCII containing the ATA serial number
1660 * - SAT defined "t10 vendor id based" containing ASCII vendor
1661 * name ("ATA "), model and serial numbers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 *
1663 * LOCKING:
1664 * spin_lock_irqsave(host_set lock)
1665 */
1666
1667unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1668 unsigned int buflen)
1669{
Jeff Garzikb142eb62006-03-21 20:37:47 -05001670 int num;
1671 const int sat_model_serial_desc_len = 68;
1672 const int ata_model_byte_len = 40;
1673
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 rbuf[1] = 0x83; /* this page code */
Jeff Garzikb142eb62006-03-21 20:37:47 -05001675 num = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Jeff Garzikb142eb62006-03-21 20:37:47 -05001677 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1678 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001679 rbuf[num + 0] = 2;
Jeff Garzikb142eb62006-03-21 20:37:47 -05001680 rbuf[num + 3] = ATA_SERNO_LEN;
1681 num += 4;
1682 ata_id_string(args->id, (unsigned char *) rbuf + num,
1683 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1684 num += ATA_SERNO_LEN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 }
Jeff Garzikb142eb62006-03-21 20:37:47 -05001686 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1687 /* SAT defined lu model and serial numbers descriptor */
1688 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001689 rbuf[num + 0] = 2;
1690 rbuf[num + 1] = 1;
Jeff Garzikb142eb62006-03-21 20:37:47 -05001691 rbuf[num + 3] = sat_model_serial_desc_len;
1692 num += 4;
1693 memcpy(rbuf + num, "ATA ", 8);
1694 num += 8;
1695 ata_id_string(args->id, (unsigned char *) rbuf + num,
1696 ATA_ID_PROD_OFS, ata_model_byte_len);
1697 num += ata_model_byte_len;
1698 ata_id_string(args->id, (unsigned char *) rbuf + num,
1699 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1700 num += ATA_SERNO_LEN;
1701 }
1702 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 return 0;
1704}
1705
1706/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001707 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 * @args: device IDENTIFY data / SCSI command of interest.
1709 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1710 * @buflen: Response buffer length.
1711 *
1712 * No operation. Simply returns success to caller, to indicate
1713 * that the caller should successfully complete this SCSI command.
1714 *
1715 * LOCKING:
1716 * spin_lock_irqsave(host_set lock)
1717 */
1718
1719unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1720 unsigned int buflen)
1721{
1722 VPRINTK("ENTER\n");
1723 return 0;
1724}
1725
1726/**
1727 * ata_msense_push - Push data onto MODE SENSE data output buffer
1728 * @ptr_io: (input/output) Location to store more output data
1729 * @last: End of output data buffer
1730 * @buf: Pointer to BLOB being added to output buffer
1731 * @buflen: Length of BLOB
1732 *
1733 * Store MODE SENSE data on an output buffer.
1734 *
1735 * LOCKING:
1736 * None.
1737 */
1738
1739static void ata_msense_push(u8 **ptr_io, const u8 *last,
1740 const u8 *buf, unsigned int buflen)
1741{
1742 u8 *ptr = *ptr_io;
1743
1744 if ((ptr + buflen - 1) > last)
1745 return;
1746
1747 memcpy(ptr, buf, buflen);
1748
1749 ptr += buflen;
1750
1751 *ptr_io = ptr;
1752}
1753
1754/**
1755 * ata_msense_caching - Simulate MODE SENSE caching info page
1756 * @id: device IDENTIFY data
1757 * @ptr_io: (input/output) Location to store more output data
1758 * @last: End of output data buffer
1759 *
1760 * Generate a caching info page, which conditionally indicates
1761 * write caching to the SCSI layer, depending on device
1762 * capabilities.
1763 *
1764 * LOCKING:
1765 * None.
1766 */
1767
1768static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1769 const u8 *last)
1770{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001771 u8 page[CACHE_MPAGE_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001773 memcpy(page, def_cache_mpage, sizeof(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 if (ata_id_wcache_enabled(id))
1775 page[2] |= (1 << 2); /* write cache enable */
1776 if (!ata_id_rahead_enabled(id))
1777 page[12] |= (1 << 5); /* disable read ahead */
1778
1779 ata_msense_push(ptr_io, last, page, sizeof(page));
1780 return sizeof(page);
1781}
1782
1783/**
1784 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1785 * @dev: Device associated with this MODE SENSE command
1786 * @ptr_io: (input/output) Location to store more output data
1787 * @last: End of output data buffer
1788 *
1789 * Generate a generic MODE SENSE control mode page.
1790 *
1791 * LOCKING:
1792 * None.
1793 */
1794
1795static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1796{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001797 ata_msense_push(ptr_io, last, def_control_mpage,
1798 sizeof(def_control_mpage));
1799 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800}
1801
1802/**
1803 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1804 * @dev: Device associated with this MODE SENSE command
1805 * @ptr_io: (input/output) Location to store more output data
1806 * @last: End of output data buffer
1807 *
1808 * Generate a generic MODE SENSE r/w error recovery page.
1809 *
1810 * LOCKING:
1811 * None.
1812 */
1813
1814static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1815{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001817 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1818 sizeof(def_rw_recovery_mpage));
1819 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820}
1821
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001822/*
1823 * We can turn this into a real blacklist if it's needed, for now just
1824 * blacklist any Maxtor BANC1G10 revision firmware
1825 */
1826static int ata_dev_supports_fua(u16 *id)
1827{
1828 unsigned char model[41], fw[9];
1829
Jeff Garzikc3c013a2006-02-27 22:31:19 -05001830 if (!libata_fua)
1831 return 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001832 if (!ata_id_has_fua(id))
1833 return 0;
1834
Tejun Heo6a62a042006-02-13 10:02:46 +09001835 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1836 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001837
Tejun Heo2e026712006-02-12 22:47:04 +09001838 if (strcmp(model, "Maxtor"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001839 return 1;
Tejun Heo2e026712006-02-12 22:47:04 +09001840 if (strcmp(fw, "BANC1G10"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001841 return 1;
1842
1843 return 0; /* blacklisted */
1844}
1845
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846/**
1847 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1848 * @args: device IDENTIFY data / SCSI command of interest.
1849 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1850 * @buflen: Response buffer length.
1851 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001852 * Simulate MODE SENSE commands. Assume this is invoked for direct
1853 * access devices (e.g. disks) only. There should be no block
1854 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 *
1856 * LOCKING:
1857 * spin_lock_irqsave(host_set lock)
1858 */
1859
1860unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1861 unsigned int buflen)
1862{
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001863 struct ata_device *dev = args->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 u8 *scsicmd = args->cmd->cmnd, *p, *last;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001865 const u8 sat_blk_desc[] = {
1866 0, 0, 0, 0, /* number of blocks: sat unspecified */
1867 0,
1868 0, 0x2, 0x0 /* block length: 512 bytes */
1869 };
1870 u8 pg, spg;
1871 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001872 u8 dpofua;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873
1874 VPRINTK("ENTER\n");
1875
1876 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001877 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1878 /*
1879 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001881
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04001883 switch (page_control) {
1884 case 0: /* current */
1885 break; /* supported */
1886 case 3: /* saved */
1887 goto saving_not_supp;
1888 case 1: /* changeable */
1889 case 2: /* defaults */
1890 default:
1891 goto invalid_fld;
1892 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001894 if (six_byte) {
1895 output_len = 4 + (ebd ? 8 : 0);
1896 alloc_len = scsicmd[4];
1897 } else {
1898 output_len = 8 + (ebd ? 8 : 0);
1899 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1900 }
1901 minlen = (alloc_len < buflen) ? alloc_len : buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902
1903 p = rbuf + output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001904 last = rbuf + minlen - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001906 pg = scsicmd[2] & 0x3f;
1907 spg = scsicmd[3];
1908 /*
1909 * No mode subpages supported (yet) but asking for _all_
1910 * subpages may be valid
1911 */
1912 if (spg && (spg != ALL_SUB_MPAGES))
1913 goto invalid_fld;
1914
1915 switch(pg) {
1916 case RW_RECOVERY_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 output_len += ata_msense_rw_recovery(&p, last);
1918 break;
1919
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001920 case CACHE_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 output_len += ata_msense_caching(args->id, &p, last);
1922 break;
1923
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001924 case CONTROL_MPAGE: {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 output_len += ata_msense_ctl_mode(&p, last);
1926 break;
1927 }
1928
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001929 case ALL_MPAGES:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 output_len += ata_msense_rw_recovery(&p, last);
1931 output_len += ata_msense_caching(args->id, &p, last);
1932 output_len += ata_msense_ctl_mode(&p, last);
1933 break;
1934
1935 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04001936 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 }
1938
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001939 if (minlen < 1)
1940 return 0;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001941
1942 dpofua = 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001943 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001944 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1945 dpofua = 1 << 4;
1946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 if (six_byte) {
1948 output_len--;
1949 rbuf[0] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001950 if (minlen > 2)
1951 rbuf[2] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001952 if (ebd) {
1953 if (minlen > 3)
1954 rbuf[3] = sizeof(sat_blk_desc);
1955 if (minlen > 11)
1956 memcpy(rbuf + 4, sat_blk_desc,
1957 sizeof(sat_blk_desc));
1958 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 } else {
1960 output_len -= 2;
1961 rbuf[0] = output_len >> 8;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001962 if (minlen > 1)
1963 rbuf[1] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001964 if (minlen > 3)
1965 rbuf[3] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001966 if (ebd) {
1967 if (minlen > 7)
1968 rbuf[7] = sizeof(sat_blk_desc);
1969 if (minlen > 15)
1970 memcpy(rbuf + 8, sat_blk_desc,
1971 sizeof(sat_blk_desc));
1972 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001975
1976invalid_fld:
1977 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1978 /* "Invalid field in cbd" */
1979 return 1;
1980
1981saving_not_supp:
1982 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1983 /* "Saving parameters not supported" */
1984 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985}
1986
1987/**
1988 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1989 * @args: device IDENTIFY data / SCSI command of interest.
1990 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1991 * @buflen: Response buffer length.
1992 *
1993 * Simulate READ CAPACITY commands.
1994 *
1995 * LOCKING:
1996 * spin_lock_irqsave(host_set lock)
1997 */
1998
1999unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2000 unsigned int buflen)
2001{
2002 u64 n_sectors;
2003 u32 tmp;
2004
2005 VPRINTK("ENTER\n");
2006
Albert Lee8bf62ece2005-05-12 15:29:42 -04002007 if (ata_id_has_lba(args->id)) {
2008 if (ata_id_has_lba48(args->id))
2009 n_sectors = ata_id_u64(args->id, 100);
2010 else
2011 n_sectors = ata_id_u32(args->id, 60);
2012 } else {
2013 /* CHS default translation */
2014 n_sectors = args->id[1] * args->id[3] * args->id[6];
2015
2016 if (ata_id_current_chs_valid(args->id))
2017 /* CHS current translation */
2018 n_sectors = ata_id_u32(args->id, 57);
2019 }
2020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 n_sectors--; /* ATA TotalUserSectors - 1 */
2022
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07002024 if( n_sectors >= 0xffffffffULL )
2025 tmp = 0xffffffff ; /* Return max count on overflow */
2026 else
2027 tmp = n_sectors ;
2028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 /* sector count, 32-bit */
2030 rbuf[0] = tmp >> (8 * 3);
2031 rbuf[1] = tmp >> (8 * 2);
2032 rbuf[2] = tmp >> (8 * 1);
2033 rbuf[3] = tmp;
2034
2035 /* sector size */
2036 tmp = ATA_SECT_SIZE;
2037 rbuf[6] = tmp >> 8;
2038 rbuf[7] = tmp;
2039
2040 } else {
2041 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07002042 tmp = n_sectors >> (8 * 4);
2043 rbuf[2] = tmp >> (8 * 3);
2044 rbuf[3] = tmp >> (8 * 2);
2045 rbuf[4] = tmp >> (8 * 1);
2046 rbuf[5] = tmp;
2047 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 rbuf[6] = tmp >> (8 * 3);
2049 rbuf[7] = tmp >> (8 * 2);
2050 rbuf[8] = tmp >> (8 * 1);
2051 rbuf[9] = tmp;
2052
2053 /* sector size */
2054 tmp = ATA_SECT_SIZE;
2055 rbuf[12] = tmp >> 8;
2056 rbuf[13] = tmp;
2057 }
2058
2059 return 0;
2060}
2061
2062/**
2063 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2064 * @args: device IDENTIFY data / SCSI command of interest.
2065 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2066 * @buflen: Response buffer length.
2067 *
2068 * Simulate REPORT LUNS command.
2069 *
2070 * LOCKING:
2071 * spin_lock_irqsave(host_set lock)
2072 */
2073
2074unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2075 unsigned int buflen)
2076{
2077 VPRINTK("ENTER\n");
2078 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2079
2080 return 0;
2081}
2082
2083/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04002084 * ata_scsi_set_sense - Set SCSI sense data and status
2085 * @cmd: SCSI request to be handled
2086 * @sk: SCSI-defined sense key
2087 * @asc: SCSI-defined additional sense code
2088 * @ascq: SCSI-defined additional sense code qualifier
2089 *
2090 * Helper function that builds a valid fixed format, current
2091 * response code and the given sense key (sk), additional sense
2092 * code (asc) and additional sense code qualifier (ascq) with
2093 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2094 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2095 *
2096 * LOCKING:
2097 * Not required
2098 */
2099
2100void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2101{
2102 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2103
2104 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2105 cmd->sense_buffer[2] = sk;
2106 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2107 cmd->sense_buffer[12] = asc;
2108 cmd->sense_buffer[13] = ascq;
2109}
2110
2111/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 * ata_scsi_badcmd - End a SCSI request with an error
2113 * @cmd: SCSI request to be handled
2114 * @done: SCSI command completion function
2115 * @asc: SCSI-defined additional sense code
2116 * @ascq: SCSI-defined additional sense code qualifier
2117 *
2118 * Helper function that completes a SCSI command with
2119 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2120 * and the specified additional sense codes.
2121 *
2122 * LOCKING:
2123 * spin_lock_irqsave(host_set lock)
2124 */
2125
2126void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2127{
2128 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04002129 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
2131 done(cmd);
2132}
2133
Tejun Heo77853bf2006-01-23 13:09:36 +09002134static void atapi_sense_complete(struct ata_queued_cmd *qc)
Jeff Garzika939c962005-10-05 17:09:16 -04002135{
Albert Leea22e2eb2005-12-05 15:38:02 +08002136 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002137 /* FIXME: not quite right; we don't want the
2138 * translation of taskfile registers into
2139 * a sense descriptors, since that's only
2140 * correct for ATA, not ATAPI
2141 */
2142 ata_gen_ata_desc_sense(qc);
2143
2144 qc->scsidone(qc->scsicmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002145 ata_qc_free(qc);
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002146}
2147
2148/* is it pointless to prefer PIO for "safety reasons"? */
2149static inline int ata_pio_use_silly(struct ata_port *ap)
2150{
2151 return (ap->flags & ATA_FLAG_PIO_DMA);
2152}
2153
2154static void atapi_request_sense(struct ata_queued_cmd *qc)
2155{
2156 struct ata_port *ap = qc->ap;
2157 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika939c962005-10-05 17:09:16 -04002158
2159 DPRINTK("ATAPI request sense\n");
2160
Jeff Garzika939c962005-10-05 17:09:16 -04002161 /* FIXME: is this needed? */
2162 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2163
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002164 ap->ops->tf_read(ap, &qc->tf);
2165
2166 /* fill these in, for the case where they are -not- overwritten */
2167 cmd->sense_buffer[0] = 0x70;
2168 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2169
2170 ata_qc_reinit(qc);
2171
Jeff Garzika939c962005-10-05 17:09:16 -04002172 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2173 qc->dma_dir = DMA_FROM_DEVICE;
2174
Tejun Heo6e7846e2006-02-12 23:32:58 +09002175 memset(&qc->cdb, 0, qc->dev->cdb_len);
Jeff Garzika939c962005-10-05 17:09:16 -04002176 qc->cdb[0] = REQUEST_SENSE;
2177 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2178
2179 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2180 qc->tf.command = ATA_CMD_PACKET;
2181
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002182 if (ata_pio_use_silly(ap)) {
2183 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2184 qc->tf.feature |= ATAPI_PKT_DMA;
2185 } else {
2186 qc->tf.protocol = ATA_PROT_ATAPI;
2187 qc->tf.lbam = (8 * 1024) & 0xff;
2188 qc->tf.lbah = (8 * 1024) >> 8;
2189 }
Jeff Garzika939c962005-10-05 17:09:16 -04002190 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2191
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002192 qc->complete_fn = atapi_sense_complete;
Jeff Garzika939c962005-10-05 17:09:16 -04002193
Tejun Heo8e0e6942006-03-31 20:41:11 +09002194 ata_qc_issue(qc);
Jeff Garzika939c962005-10-05 17:09:16 -04002195
2196 DPRINTK("EXIT\n");
2197}
2198
Tejun Heo77853bf2006-01-23 13:09:36 +09002199static void atapi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200{
2201 struct scsi_cmnd *cmd = qc->scsicmd;
Albert Leea22e2eb2005-12-05 15:38:02 +08002202 unsigned int err_mask = qc->err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203
Jeff Garzika7dac442005-10-30 04:44:42 -05002204 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002205
Jeff Garzika7dac442005-10-30 04:44:42 -05002206 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 cmd->result = SAM_STAT_CHECK_CONDITION;
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002208 atapi_request_sense(qc);
Tejun Heo77853bf2006-01-23 13:09:36 +09002209 return;
Jeff Garzike12669e2005-10-05 18:39:23 -04002210 }
2211
Jeff Garzika7dac442005-10-30 04:44:42 -05002212 else if (unlikely(err_mask))
2213 /* FIXME: not quite right; we don't want the
2214 * translation of taskfile registers into
2215 * a sense descriptors, since that's only
2216 * correct for ATA, not ATAPI
2217 */
2218 ata_gen_ata_desc_sense(qc);
2219
Jeff Garzike12669e2005-10-05 18:39:23 -04002220 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 u8 *scsicmd = cmd->cmnd;
2222
Tony Battersbyfd71da42005-12-21 16:35:44 -05002223 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 u8 *buf = NULL;
2225 unsigned int buflen;
2226
2227 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002228
2229 /* ATAPI devices typically report zero for their SCSI version,
2230 * and sometimes deviate from the spec WRT response data
2231 * format. If SCSI version is reported as zero like normal,
2232 * then we make the following fixups: 1) Fake MMC-5 version,
2233 * to indicate to the Linux scsi midlayer this is a modern
2234 * device. 2) Ensure response data format / ATAPI information
2235 * are always correct.
2236 */
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002237 if (buf[2] == 0) {
2238 buf[2] = 0x5;
2239 buf[3] = 0x32;
2240 }
2241
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 ata_scsi_rbuf_put(cmd, buf);
2243 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 cmd->result = SAM_STAT_GOOD;
2246 }
2247
2248 qc->scsidone(cmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002249 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250}
2251/**
2252 * atapi_xlat - Initialize PACKET taskfile
2253 * @qc: command structure to be initialized
2254 * @scsicmd: SCSI CDB associated with this PACKET command
2255 *
2256 * LOCKING:
2257 * spin_lock_irqsave(host_set lock)
2258 *
2259 * RETURNS:
2260 * Zero on success, non-zero on failure.
2261 */
2262
Jeff Garzik057ace52005-10-22 14:27:05 -04002263static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
2265 struct scsi_cmnd *cmd = qc->scsicmd;
2266 struct ata_device *dev = qc->dev;
2267 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db052005-04-17 15:26:13 -05002268 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269
2270 if (!using_pio)
2271 /* Check whether ATAPI DMA is safe */
2272 if (ata_check_atapi_dma(qc))
2273 using_pio = 1;
2274
Tejun Heo6e7846e2006-02-12 23:32:58 +09002275 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276
2277 qc->complete_fn = atapi_qc_complete;
2278
2279 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db052005-04-17 15:26:13 -05002280 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 qc->tf.flags |= ATA_TFLAG_WRITE;
2282 DPRINTK("direction: write\n");
2283 }
2284
2285 qc->tf.command = ATA_CMD_PACKET;
2286
2287 /* no data, or PIO data xfer */
2288 if (using_pio || nodata) {
2289 if (nodata)
2290 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2291 else
2292 qc->tf.protocol = ATA_PROT_ATAPI;
2293 qc->tf.lbam = (8 * 1024) & 0xff;
2294 qc->tf.lbah = (8 * 1024) >> 8;
2295 }
2296
2297 /* DMA data xfer */
2298 else {
2299 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2300 qc->tf.feature |= ATAPI_PKT_DMA;
2301
2302#ifdef ATAPI_ENABLE_DMADIR
2303 /* some SATA bridges need us to indicate data xfer direction */
be7db052005-04-17 15:26:13 -05002304 if (cmd->sc_data_direction != DMA_TO_DEVICE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 qc->tf.feature |= ATAPI_DMADIR;
2306#endif
2307 }
2308
2309 qc->nbytes = cmd->bufflen;
2310
2311 return 0;
2312}
2313
2314/**
2315 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2316 * @ap: ATA port to which the device is attached
2317 * @scsidev: SCSI device from which we derive the ATA device
2318 *
2319 * Given various information provided in struct scsi_cmnd,
2320 * map that onto an ATA bus, and using that mapping
2321 * determine which ata_device is associated with the
2322 * SCSI command to be sent.
2323 *
2324 * LOCKING:
2325 * spin_lock_irqsave(host_set lock)
2326 *
2327 * RETURNS:
2328 * Associated ATA device, or %NULL if not found.
2329 */
2330
2331static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002332ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333{
2334 struct ata_device *dev;
2335
2336 /* skip commands not addressed to targets we simulate */
2337 if (likely(scsidev->id < ATA_MAX_DEVICES))
2338 dev = &ap->device[scsidev->id];
2339 else
2340 return NULL;
2341
2342 if (unlikely((scsidev->channel != 0) ||
2343 (scsidev->lun != 0)))
2344 return NULL;
2345
Tejun Heoe1211e32006-04-01 01:38:18 +09002346 if (unlikely(!ata_dev_enabled(dev)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 return NULL;
2348
Jeff Garzik50630192005-12-13 02:29:45 -05002349 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2350 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2351 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2352 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
Jeff Garzik1623c812005-08-30 03:37:42 -04002353 return NULL;
Jeff Garzik50630192005-12-13 02:29:45 -05002354 }
Jeff Garzik1623c812005-08-30 03:37:42 -04002355 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356
2357 return dev;
2358}
2359
Jeff Garzikb0955182005-05-12 15:45:22 -04002360/*
2361 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2362 * @byte1: Byte 1 from pass-thru CDB.
2363 *
2364 * RETURNS:
2365 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2366 */
2367static u8
2368ata_scsi_map_proto(u8 byte1)
2369{
2370 switch((byte1 & 0x1e) >> 1) {
2371 case 3: /* Non-data */
2372 return ATA_PROT_NODATA;
2373
2374 case 6: /* DMA */
2375 return ATA_PROT_DMA;
2376
2377 case 4: /* PIO Data-in */
2378 case 5: /* PIO Data-out */
Jeff Garzikb0955182005-05-12 15:45:22 -04002379 return ATA_PROT_PIO;
2380
2381 case 10: /* Device Reset */
2382 case 0: /* Hard Reset */
2383 case 1: /* SRST */
2384 case 2: /* Bus Idle */
2385 case 7: /* Packet */
2386 case 8: /* DMA Queued */
2387 case 9: /* Device Diagnostic */
2388 case 11: /* UDMA Data-in */
2389 case 12: /* UDMA Data-Out */
2390 case 13: /* FPDMA */
2391 default: /* Reserved */
2392 break;
2393 }
2394
2395 return ATA_PROT_UNKNOWN;
2396}
2397
2398/**
2399 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2400 * @qc: command structure to be initialized
Randy Dunlap8e8b77d2005-11-01 21:29:27 -08002401 * @scsicmd: SCSI command to convert
Jeff Garzikb0955182005-05-12 15:45:22 -04002402 *
2403 * Handles either 12 or 16-byte versions of the CDB.
2404 *
2405 * RETURNS:
2406 * Zero on success, non-zero on failure.
2407 */
2408static unsigned int
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002409ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
Jeff Garzikb0955182005-05-12 15:45:22 -04002410{
2411 struct ata_taskfile *tf = &(qc->tf);
2412 struct scsi_cmnd *cmd = qc->scsicmd;
2413
2414 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
Tejun Heo9a405252005-12-02 11:49:11 +09002415 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002416
Albert Leef59b0cf2006-03-16 17:59:22 +08002417 if (scsicmd[1] & 0xe0)
2418 /* PIO multi not supported yet */
2419 goto invalid_fld;
2420
Jeff Garzikb0955182005-05-12 15:45:22 -04002421 /*
2422 * 12 and 16 byte CDBs use different offsets to
2423 * provide the various register values.
2424 */
2425 if (scsicmd[0] == ATA_16) {
2426 /*
2427 * 16-byte CDB - may contain extended commands.
2428 *
2429 * If that is the case, copy the upper byte register values.
2430 */
2431 if (scsicmd[1] & 0x01) {
2432 tf->hob_feature = scsicmd[3];
2433 tf->hob_nsect = scsicmd[5];
2434 tf->hob_lbal = scsicmd[7];
2435 tf->hob_lbam = scsicmd[9];
2436 tf->hob_lbah = scsicmd[11];
2437 tf->flags |= ATA_TFLAG_LBA48;
2438 } else
2439 tf->flags &= ~ATA_TFLAG_LBA48;
2440
2441 /*
2442 * Always copy low byte, device and command registers.
2443 */
2444 tf->feature = scsicmd[4];
2445 tf->nsect = scsicmd[6];
2446 tf->lbal = scsicmd[8];
2447 tf->lbam = scsicmd[10];
2448 tf->lbah = scsicmd[12];
2449 tf->device = scsicmd[13];
2450 tf->command = scsicmd[14];
2451 } else {
2452 /*
2453 * 12-byte CDB - incapable of extended commands.
2454 */
2455 tf->flags &= ~ATA_TFLAG_LBA48;
2456
2457 tf->feature = scsicmd[3];
2458 tf->nsect = scsicmd[4];
2459 tf->lbal = scsicmd[5];
2460 tf->lbam = scsicmd[6];
2461 tf->lbah = scsicmd[7];
2462 tf->device = scsicmd[8];
2463 tf->command = scsicmd[9];
2464 }
Mark Lorddcc2d1e2005-11-13 16:22:06 -05002465 /*
2466 * If slave is possible, enforce correct master/slave bit
2467 */
2468 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2469 tf->device = qc->dev->devno ?
2470 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002471
2472 /*
2473 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2474 * SET_FEATURES - XFER MODE must be preceded/succeeded
2475 * by an update to hardware-specific registers for each
2476 * controller (i.e. the reason for ->set_piomode(),
2477 * ->set_dmamode(), and ->post_set_mode() hooks).
2478 */
2479 if ((tf->command == ATA_CMD_SET_FEATURES)
2480 && (tf->feature == SETFEATURES_XFER))
Tejun Heo9a405252005-12-02 11:49:11 +09002481 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002482
2483 /*
2484 * Set flags so that all registers will be written,
2485 * and pass on write indication (used for PIO/DMA
2486 * setup.)
2487 */
2488 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2489
Jeff Garzik0274aa22005-06-22 13:50:56 -04002490 if (cmd->sc_data_direction == DMA_TO_DEVICE)
Jeff Garzikb0955182005-05-12 15:45:22 -04002491 tf->flags |= ATA_TFLAG_WRITE;
2492
2493 /*
2494 * Set transfer length.
2495 *
2496 * TODO: find out if we need to do more here to
2497 * cover scatter/gather case.
2498 */
2499 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2500
2501 return 0;
Tejun Heo9a405252005-12-02 11:49:11 +09002502
2503 invalid_fld:
2504 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2505 /* "Invalid field in cdb" */
2506 return 1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002507}
2508
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509/**
2510 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2511 * @dev: ATA device
2512 * @cmd: SCSI command opcode to consider
2513 *
2514 * Look up the SCSI command given, and determine whether the
2515 * SCSI command is to be translated or simulated.
2516 *
2517 * RETURNS:
2518 * Pointer to translation function if possible, %NULL if not.
2519 */
2520
2521static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2522{
2523 switch (cmd) {
2524 case READ_6:
2525 case READ_10:
2526 case READ_16:
2527
2528 case WRITE_6:
2529 case WRITE_10:
2530 case WRITE_16:
2531 return ata_scsi_rw_xlat;
2532
2533 case SYNCHRONIZE_CACHE:
2534 if (ata_try_flush_cache(dev))
2535 return ata_scsi_flush_xlat;
2536 break;
2537
2538 case VERIFY:
2539 case VERIFY_16:
2540 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04002541
2542 case ATA_12:
2543 case ATA_16:
2544 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04002545
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04002546 case START_STOP:
2547 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548 }
2549
2550 return NULL;
2551}
2552
2553/**
2554 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2555 * @ap: ATA port to which the command was being sent
2556 * @cmd: SCSI command to dump
2557 *
2558 * Prints the contents of a SCSI command via printk().
2559 */
2560
2561static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2562 struct scsi_cmnd *cmd)
2563{
2564#ifdef ATA_DEBUG
2565 struct scsi_device *scsidev = cmd->device;
2566 u8 *scsicmd = cmd->cmnd;
2567
2568 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2569 ap->id,
2570 scsidev->channel, scsidev->id, scsidev->lun,
2571 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2572 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2573 scsicmd[8]);
2574#endif
2575}
2576
Brian Kingeb3f0f92006-03-23 17:30:02 -06002577static inline void __ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
2578 struct ata_port *ap, struct ata_device *dev)
2579{
2580 if (dev->class == ATA_DEV_ATA) {
2581 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2582 cmd->cmnd[0]);
2583
2584 if (xlat_func)
2585 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2586 else
2587 ata_scsi_simulate(ap, dev, cmd, done);
2588 } else
2589 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2590}
2591
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592/**
2593 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2594 * @cmd: SCSI command to be sent
2595 * @done: Completion function, called when command is complete
2596 *
2597 * In some cases, this function translates SCSI commands into
2598 * ATA taskfiles, and queues the taskfiles to be sent to
2599 * hardware. In other cases, this function simulates a
2600 * SCSI device by evaluating and responding to certain
2601 * SCSI commands. This creates the overall effect of
2602 * ATA and ATAPI devices appearing as SCSI devices.
2603 *
2604 * LOCKING:
2605 * Releases scsi-layer-held lock, and obtains host_set lock.
2606 *
2607 * RETURNS:
2608 * Zero.
2609 */
2610
2611int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2612{
2613 struct ata_port *ap;
2614 struct ata_device *dev;
2615 struct scsi_device *scsidev = cmd->device;
Jeff Garzik005a5a02005-10-30 23:31:48 -05002616 struct Scsi_Host *shost = scsidev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617
Jeff Garzik005a5a02005-10-30 23:31:48 -05002618 ap = (struct ata_port *) &shost->hostdata[0];
2619
2620 spin_unlock(shost->host_lock);
2621 spin_lock(&ap->host_set->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622
2623 ata_scsi_dump_cdb(ap, cmd);
2624
2625 dev = ata_scsi_find_dev(ap, scsidev);
Brian Kingeb3f0f92006-03-23 17:30:02 -06002626 if (likely(dev))
2627 __ata_scsi_queuecmd(cmd, done, ap, dev);
2628 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 cmd->result = (DID_BAD_TARGET << 16);
2630 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631 }
2632
Jeff Garzik005a5a02005-10-30 23:31:48 -05002633 spin_unlock(&ap->host_set->lock);
2634 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 return 0;
2636}
2637
2638/**
2639 * ata_scsi_simulate - simulate SCSI command on ATA device
Randy Dunlapc893a3a2006-01-28 13:15:32 -05002640 * @ap: port the device is connected to
2641 * @dev: the target device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642 * @cmd: SCSI command being sent to device.
2643 * @done: SCSI command completion function.
2644 *
2645 * Interprets and directly executes a select list of SCSI commands
2646 * that can be handled internally.
2647 *
2648 * LOCKING:
2649 * spin_lock_irqsave(host_set lock)
2650 */
2651
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002652void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 struct scsi_cmnd *cmd,
2654 void (*done)(struct scsi_cmnd *))
2655{
2656 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04002657 const u8 *scsicmd = cmd->cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002659 args.ap = ap;
2660 args.dev = dev;
2661 args.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 args.cmd = cmd;
2663 args.done = done;
2664
2665 switch(scsicmd[0]) {
2666 /* no-op's, complete with success */
2667 case SYNCHRONIZE_CACHE:
2668 case REZERO_UNIT:
2669 case SEEK_6:
2670 case SEEK_10:
2671 case TEST_UNIT_READY:
2672 case FORMAT_UNIT: /* FIXME: correct? */
2673 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2674 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2675 break;
2676
2677 case INQUIRY:
2678 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04002679 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2681 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2682 else if (scsicmd[2] == 0x00)
2683 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2684 else if (scsicmd[2] == 0x80)
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2686 else if (scsicmd[2] == 0x83)
2687 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2688 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002689 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 break;
2691
2692 case MODE_SENSE:
2693 case MODE_SENSE_10:
2694 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2695 break;
2696
2697 case MODE_SELECT: /* unconditionally return */
2698 case MODE_SELECT_10: /* bad-field-in-cdb */
Douglas Gilbertae006512005-10-09 09:09:35 -04002699 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700 break;
2701
2702 case READ_CAPACITY:
2703 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2704 break;
2705
2706 case SERVICE_ACTION_IN:
2707 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2708 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2709 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002710 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711 break;
2712
2713 case REPORT_LUNS:
2714 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2715 break;
2716
Jeff Garzikb0955182005-05-12 15:45:22 -04002717 /* mandatory commands we haven't implemented yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718 case REQUEST_SENSE:
2719
2720 /* all other commands */
2721 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04002722 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2723 /* "Invalid command operation code" */
2724 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 break;
2726 }
2727}
2728
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002729void ata_scsi_scan_host(struct ata_port *ap)
2730{
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002731 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002732 unsigned int i;
2733
Tejun Heo198e0fe2006-04-02 18:51:52 +09002734 if (ap->flags & ATA_FLAG_DISABLED)
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002735 return;
2736
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002737 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2738 dev = &ap->device[i];
2739
Tejun Heoe1211e32006-04-01 01:38:18 +09002740 if (ata_dev_enabled(dev))
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002741 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2742 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002743}
2744