blob: 7ced41ecde860c0c4c58ce0c5cb7d9afc0d05051 [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>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020041#include <scsi/scsi_cmnd.h>
Mike Christie85837eb2005-11-11 16:38:53 -060042#include <scsi/scsi_eh.h>
Jeff Garzik005a5a02005-10-30 23:31:48 -050043#include <scsi/scsi_device.h>
Tejun Heoa6e6ce82006-05-15 21:03:48 +090044#include <scsi/scsi_tcq.h>
Tejun Heo30afc842006-03-18 18:40:14 +090045#include <scsi/scsi_transport.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/libata.h>
Jeff Garzikb0955182005-05-12 15:45:22 -040047#include <linux/hdreg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <asm/uaccess.h>
49
50#include "libata.h"
51
Jeff Garzikb0955182005-05-12 15:45:22 -040052#define SECTOR_SIZE 512
53
Jeff Garzik057ace52005-10-22 14:27:05 -040054typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
Tejun Heoab5b3a52006-05-31 18:27:34 +090055
56static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
57 const struct scsi_device *scsidev);
58static struct ata_device * ata_scsi_find_dev(struct ata_port *ap,
59 const struct scsi_device *scsidev);
Tejun Heo83c47bc2006-05-31 18:28:07 +090060static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
61 unsigned int id, unsigned int lun);
Tejun Heoab5b3a52006-05-31 18:27:34 +090062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040064#define RW_RECOVERY_MPAGE 0x1
65#define RW_RECOVERY_MPAGE_LEN 12
66#define CACHE_MPAGE 0x8
67#define CACHE_MPAGE_LEN 20
68#define CONTROL_MPAGE 0xa
69#define CONTROL_MPAGE_LEN 12
70#define ALL_MPAGES 0x3f
71#define ALL_SUB_MPAGES 0xff
72
73
74static const u8 def_rw_recovery_mpage[] = {
75 RW_RECOVERY_MPAGE,
76 RW_RECOVERY_MPAGE_LEN - 2,
77 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
78 (1 << 6), /* ARRE (auto read reallocation) */
79 0, /* read retry count */
80 0, 0, 0, 0,
81 0, /* write retry count */
82 0, 0, 0
83};
84
85static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
86 CACHE_MPAGE,
87 CACHE_MPAGE_LEN - 2,
88 0, /* contains WCE, needs to be 0 for logic */
89 0, 0, 0, 0, 0, 0, 0, 0, 0,
90 0, /* contains DRA, needs to be 0 for logic */
91 0, 0, 0, 0, 0, 0, 0
92};
93
94static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
95 CONTROL_MPAGE,
96 CONTROL_MPAGE_LEN - 2,
97 2, /* DSENSE=0, GLTSD=1 */
98 0, /* [QAM+QERR may be 1, see 05-359r1] */
99 0, 0, 0, 0, 0xff, 0xff,
100 0, 30 /* extended self test time, see 05-359r1 */
101};
102
Tejun Heo30afc842006-03-18 18:40:14 +0900103/*
104 * libata transport template. libata doesn't do real transport stuff.
105 * It just needs the eh_timed_out hook.
106 */
107struct scsi_transport_template ata_scsi_transport_template = {
Christoph Hellwig9227c332006-04-01 19:21:04 +0200108 .eh_strategy_handler = ata_scsi_error,
Tejun Heo30afc842006-03-18 18:40:14 +0900109 .eh_timed_out = ata_scsi_timed_out,
Tejun Heoccf68c32006-05-31 18:28:09 +0900110 .user_scan = ata_scsi_user_scan,
Tejun Heo30afc842006-03-18 18:40:14 +0900111};
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Douglas Gilbertae006512005-10-09 09:09:35 -0400114static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
115 void (*done)(struct scsi_cmnd *))
116{
117 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
118 /* "Invalid field in cbd" */
119 done(cmd);
120}
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122/**
123 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
124 * @sdev: SCSI device for which BIOS geometry is to be determined
125 * @bdev: block device associated with @sdev
126 * @capacity: capacity of SCSI device
127 * @geom: location to which geometry will be output
128 *
129 * Generic bios head/sector/cylinder calculator
130 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
131 * mapping. Some situations may arise where the disk is not
132 * bootable if this is not used.
133 *
134 * LOCKING:
135 * Defined by the SCSI layer. We don't really care.
136 *
137 * RETURNS:
138 * Zero.
139 */
140int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
141 sector_t capacity, int geom[])
142{
143 geom[0] = 255;
144 geom[1] = 63;
145 sector_div(capacity, 255*63);
146 geom[2] = capacity;
147
148 return 0;
149}
150
Jeff Garzikb0955182005-05-12 15:45:22 -0400151/**
152 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800153 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400154 * @arg: User provided data for issuing command
155 *
156 * LOCKING:
157 * Defined by the SCSI layer. We don't really care.
158 *
159 * RETURNS:
160 * Zero on success, negative errno on error.
161 */
162
163int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
164{
165 int rc = 0;
166 u8 scsi_cmd[MAX_COMMAND_SIZE];
167 u8 args[4], *argbuf = NULL;
168 int argsize = 0;
Mike Christie85837eb2005-11-11 16:38:53 -0600169 struct scsi_sense_hdr sshdr;
170 enum dma_data_direction data_dir;
Jeff Garzikb0955182005-05-12 15:45:22 -0400171
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500172 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400173 return -EINVAL;
174
175 if (copy_from_user(args, arg, sizeof(args)))
176 return -EFAULT;
177
Jeff Garzikb0955182005-05-12 15:45:22 -0400178 memset(scsi_cmd, 0, sizeof(scsi_cmd));
179
180 if (args[3]) {
181 argsize = SECTOR_SIZE * args[3];
182 argbuf = kmalloc(argsize, GFP_KERNEL);
Jeff Raubitschek54dac832005-10-04 10:21:19 -0400183 if (argbuf == NULL) {
184 rc = -ENOMEM;
185 goto error;
186 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400187
188 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
189 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
190 block count in sector count field */
Mike Christie85837eb2005-11-11 16:38:53 -0600191 data_dir = DMA_FROM_DEVICE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400192 } else {
193 scsi_cmd[1] = (3 << 1); /* Non-data */
194 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
Mike Christie85837eb2005-11-11 16:38:53 -0600195 data_dir = DMA_NONE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400196 }
197
198 scsi_cmd[0] = ATA_16;
199
200 scsi_cmd[4] = args[2];
201 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
202 scsi_cmd[6] = args[3];
203 scsi_cmd[8] = args[1];
204 scsi_cmd[10] = 0x4f;
205 scsi_cmd[12] = 0xc2;
206 } else {
207 scsi_cmd[6] = args[1];
208 }
209 scsi_cmd[14] = args[0];
210
211 /* Good values for timeout and retries? Values below
212 from scsi_ioctl_send_command() for default case... */
Mike Christie85837eb2005-11-11 16:38:53 -0600213 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
214 &sshdr, (10*HZ), 5)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400215 rc = -EIO;
216 goto error;
217 }
218
219 /* Need code to retrieve data from check condition? */
220
221 if ((argbuf)
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500222 && copy_to_user(arg + sizeof(args), argbuf, argsize))
Jeff Garzikb0955182005-05-12 15:45:22 -0400223 rc = -EFAULT;
224error:
Jesper Juhl8f760782006-06-27 02:55:06 -0700225 kfree(argbuf);
Jeff Garzikb0955182005-05-12 15:45:22 -0400226 return rc;
227}
228
229/**
230 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800231 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400232 * @arg: User provided data for issuing command
233 *
234 * LOCKING:
235 * Defined by the SCSI layer. We don't really care.
236 *
237 * RETURNS:
238 * Zero on success, negative errno on error.
239 */
240int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
241{
242 int rc = 0;
243 u8 scsi_cmd[MAX_COMMAND_SIZE];
244 u8 args[7];
Mike Christie85837eb2005-11-11 16:38:53 -0600245 struct scsi_sense_hdr sshdr;
Jeff Garzikb0955182005-05-12 15:45:22 -0400246
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500247 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400248 return -EINVAL;
249
250 if (copy_from_user(args, arg, sizeof(args)))
251 return -EFAULT;
252
253 memset(scsi_cmd, 0, sizeof(scsi_cmd));
254 scsi_cmd[0] = ATA_16;
255 scsi_cmd[1] = (3 << 1); /* Non-data */
256 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
257 scsi_cmd[4] = args[1];
258 scsi_cmd[6] = args[2];
259 scsi_cmd[8] = args[3];
260 scsi_cmd[10] = args[4];
261 scsi_cmd[12] = args[5];
262 scsi_cmd[14] = args[0];
263
Jeff Garzikb0955182005-05-12 15:45:22 -0400264 /* Good values for timeout and retries? Values below
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500265 from scsi_ioctl_send_command() for default case... */
Mike Christie85837eb2005-11-11 16:38:53 -0600266 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
267 (10*HZ), 5))
Jeff Garzikb0955182005-05-12 15:45:22 -0400268 rc = -EIO;
Jeff Garzikb0955182005-05-12 15:45:22 -0400269
270 /* Need code to retrieve data from check condition? */
Jeff Garzikb0955182005-05-12 15:45:22 -0400271 return rc;
272}
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
275{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 int val = -EINVAL, rc = -EINVAL;
277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 switch (cmd) {
279 case ATA_IOC_GET_IO32:
280 val = 0;
281 if (copy_to_user(arg, &val, 1))
282 return -EFAULT;
283 return 0;
284
285 case ATA_IOC_SET_IO32:
286 val = (unsigned long) arg;
287 if (val != 0)
288 return -EINVAL;
289 return 0;
290
Jeff Garzikb0955182005-05-12 15:45:22 -0400291 case HDIO_DRIVE_CMD:
292 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
293 return -EACCES;
294 return ata_cmd_ioctl(scsidev, arg);
295
296 case HDIO_DRIVE_TASK:
297 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
298 return -EACCES;
299 return ata_task_ioctl(scsidev, arg);
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 default:
302 rc = -ENOTTY;
303 break;
304 }
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 return rc;
307}
308
309/**
310 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 * @dev: ATA device to which the new command is attached
312 * @cmd: SCSI command that originated this ATA command
313 * @done: SCSI command completion function
314 *
315 * Obtain a reference to an unused ata_queued_cmd structure,
316 * which is the basic libata structure representing a single
317 * ATA command sent to the hardware.
318 *
319 * If a command was available, fill in the SCSI-specific
320 * portions of the structure with information on the
321 * current command.
322 *
323 * LOCKING:
324 * spin_lock_irqsave(host_set lock)
325 *
326 * RETURNS:
327 * Command allocated, or %NULL if none available.
328 */
Tejun Heo3373efd2006-05-15 20:57:53 +0900329struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 struct scsi_cmnd *cmd,
331 void (*done)(struct scsi_cmnd *))
332{
333 struct ata_queued_cmd *qc;
334
Tejun Heo3373efd2006-05-15 20:57:53 +0900335 qc = ata_qc_new_init(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 if (qc) {
337 qc->scsicmd = cmd;
338 qc->scsidone = done;
339
340 if (cmd->use_sg) {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400341 qc->__sg = (struct scatterlist *) cmd->request_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 qc->n_elem = cmd->use_sg;
343 } else {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400344 qc->__sg = &qc->sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 qc->n_elem = 1;
346 }
347 } else {
348 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
349 done(cmd);
350 }
351
352 return qc;
353}
354
355/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400356 * ata_dump_status - user friendly display of error info
357 * @id: id of the port in question
358 * @tf: ptr to filled out taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400360 * Decode and dump the ATA error/status registers for the user so
361 * that they have some idea what really happened at the non
362 * make-believe layer.
363 *
364 * LOCKING:
365 * inherited from caller
366 */
367void ata_dump_status(unsigned id, struct ata_taskfile *tf)
368{
369 u8 stat = tf->command, err = tf->feature;
370
371 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
372 if (stat & ATA_BUSY) {
373 printk("Busy }\n"); /* Data is not valid in this case */
374 } else {
375 if (stat & 0x40) printk("DriveReady ");
376 if (stat & 0x20) printk("DeviceFault ");
377 if (stat & 0x10) printk("SeekComplete ");
378 if (stat & 0x08) printk("DataRequest ");
379 if (stat & 0x04) printk("CorrectedError ");
380 if (stat & 0x02) printk("Index ");
381 if (stat & 0x01) printk("Error ");
382 printk("}\n");
383
384 if (err) {
385 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
386 if (err & 0x04) printk("DriveStatusError ");
387 if (err & 0x80) {
388 if (err & 0x04) printk("BadCRC ");
389 else printk("Sector ");
390 }
391 if (err & 0x40) printk("UncorrectableError ");
392 if (err & 0x10) printk("SectorIdNotFound ");
393 if (err & 0x02) printk("TrackZeroNotFound ");
394 if (err & 0x01) printk("AddrMarkNotFound ");
395 printk("}\n");
396 }
397 }
398}
399
Tejun Heod6f26d12006-07-03 16:07:26 +0900400/**
401 * ata_scsi_device_suspend - suspend ATA device associated with sdev
402 * @sdev: the SCSI device to suspend
403 * @state: target power management state
404 *
405 * Request suspend EH action on the ATA device associated with
406 * @sdev and wait for the operation to complete.
407 *
408 * LOCKING:
409 * Kernel thread context (may sleep).
410 *
411 * RETURNS:
412 * 0 on success, -errno otherwise.
413 */
Nigel Cunningham082776e2006-03-23 23:22:16 +1000414int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
Jens Axboe9b847542006-01-06 09:28:07 +0100415{
Jeff Garzik35bb94b2006-04-11 13:12:34 -0400416 struct ata_port *ap = ata_shost_to_port(sdev->host);
Tejun Heod6f26d12006-07-03 16:07:26 +0900417 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
418 unsigned long flags;
419 unsigned int action;
420 int rc = 0;
Jens Axboe9b847542006-01-06 09:28:07 +0100421
Tejun Heod6f26d12006-07-03 16:07:26 +0900422 if (!dev)
423 goto out;
424
425 spin_lock_irqsave(ap->lock, flags);
426
427 /* wait for the previous resume to complete */
428 while (dev->flags & ATA_DFLAG_SUSPENDED) {
429 spin_unlock_irqrestore(ap->lock, flags);
430 ata_port_wait_eh(ap);
431 spin_lock_irqsave(ap->lock, flags);
432 }
433
434 /* if @sdev is already detached, nothing to do */
435 if (sdev->sdev_state == SDEV_OFFLINE ||
436 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
437 goto out_unlock;
438
439 /* request suspend */
440 action = ATA_EH_SUSPEND;
441 if (state.event != PM_EVENT_SUSPEND)
442 action |= ATA_EH_PM_FREEZE;
443 ap->eh_info.dev_action[dev->devno] |= action;
444 ap->eh_info.flags |= ATA_EHI_QUIET;
445 ata_port_schedule_eh(ap);
446
447 spin_unlock_irqrestore(ap->lock, flags);
448
449 /* wait for EH to do the job */
450 ata_port_wait_eh(ap);
451
452 spin_lock_irqsave(ap->lock, flags);
453
454 /* If @sdev is still attached but the associated ATA device
455 * isn't suspended, the operation failed.
456 */
457 if (sdev->sdev_state != SDEV_OFFLINE &&
458 sdev->sdev_state != SDEV_CANCEL && sdev->sdev_state != SDEV_DEL &&
459 !(dev->flags & ATA_DFLAG_SUSPENDED))
460 rc = -EIO;
461
462 out_unlock:
463 spin_unlock_irqrestore(ap->lock, flags);
464 out:
465 if (rc == 0)
466 sdev->sdev_gendev.power.power_state = state;
467 return rc;
468}
469
470/**
471 * ata_scsi_device_resume - resume ATA device associated with sdev
472 * @sdev: the SCSI device to resume
473 *
474 * Request resume EH action on the ATA device associated with
475 * @sdev and return immediately. This enables parallel
476 * wakeup/spinup of devices.
477 *
478 * LOCKING:
479 * Kernel thread context (may sleep).
480 *
481 * RETURNS:
482 * 0.
483 */
484int ata_scsi_device_resume(struct scsi_device *sdev)
485{
486 struct ata_port *ap = ata_shost_to_port(sdev->host);
487 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
488 struct ata_eh_info *ehi = &ap->eh_info;
489 unsigned long flags;
490 unsigned int action;
491
492 if (!dev)
493 goto out;
494
495 spin_lock_irqsave(ap->lock, flags);
496
497 /* if @sdev is already detached, nothing to do */
498 if (sdev->sdev_state == SDEV_OFFLINE ||
499 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
500 goto out_unlock;
501
502 /* request resume */
503 action = ATA_EH_RESUME;
504 if (sdev->sdev_gendev.power.power_state.event == PM_EVENT_SUSPEND)
505 __ata_ehi_hotplugged(ehi);
506 else
507 action |= ATA_EH_PM_FREEZE | ATA_EH_SOFTRESET;
508 ehi->dev_action[dev->devno] |= action;
509
510 /* We don't want autopsy and verbose EH messages. Disable
511 * those if we're the only device on this link.
512 */
513 if (ata_port_max_devices(ap) == 1)
514 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
515
516 ata_port_schedule_eh(ap);
517
518 out_unlock:
519 spin_unlock_irqrestore(ap->lock, flags);
520 out:
521 sdev->sdev_gendev.power.power_state = PMSG_ON;
522 return 0;
Jens Axboe9b847542006-01-06 09:28:07 +0100523}
524
Jeff Garzikb0955182005-05-12 15:45:22 -0400525/**
526 * ata_to_sense_error - convert ATA error to SCSI error
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800527 * @id: ATA device number
Jeff Garzikb0955182005-05-12 15:45:22 -0400528 * @drv_stat: value contained in ATA status register
529 * @drv_err: value contained in ATA error register
530 * @sk: the sense key we'll fill out
531 * @asc: the additional sense code we'll fill out
532 * @ascq: the additional sense code qualifier we'll fill out
Tejun Heo246619d2006-05-15 20:58:16 +0900533 * @verbose: be verbose
Jeff Garzikb0955182005-05-12 15:45:22 -0400534 *
535 * Converts an ATA error into a SCSI error. Fill out pointers to
536 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
537 * format sense blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 *
539 * LOCKING:
540 * spin_lock_irqsave(host_set lock)
541 */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500542void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
Tejun Heo246619d2006-05-15 20:58:16 +0900543 u8 *ascq, int verbose)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544{
Jeff Garzikb0955182005-05-12 15:45:22 -0400545 int i;
Jeff Garzikffe75ef2005-10-09 10:40:44 -0400546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 /* Based on the 3ware driver translation table */
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100548 static const unsigned char sense_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 /* BBD|ECC|ID|MAR */
550 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
551 /* BBD|ECC|ID */
552 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
553 /* ECC|MC|MARK */
554 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
555 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
556 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
557 /* MC|ID|ABRT|TRK0|MARK */
558 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
559 /* MCR|MARK */
560 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
561 /* Bad address mark */
562 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
563 /* TRK0 */
564 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
565 /* Abort & !ICRC */
566 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
567 /* Media change request */
568 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
569 /* SRV */
570 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
571 /* Media change */
572 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
573 /* ECC */
574 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
575 /* BBD - block marked bad */
576 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
577 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
578 };
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100579 static const unsigned char stat_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 /* Must be first because BUSY means no other bits valid */
581 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
582 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
583 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
584 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
585 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
586 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 /*
589 * Is this an error we can process/parse
590 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400591 if (drv_stat & ATA_BUSY) {
592 drv_err = 0; /* Ignore the err bits, they're invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Jeff Garzikb0955182005-05-12 15:45:22 -0400595 if (drv_err) {
596 /* Look for drv_err */
597 for (i = 0; sense_table[i][0] != 0xFF; i++) {
598 /* Look for best matches first */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -0500599 if ((sense_table[i][0] & drv_err) ==
Jeff Garzikb0955182005-05-12 15:45:22 -0400600 sense_table[i][0]) {
601 *sk = sense_table[i][1];
602 *asc = sense_table[i][2];
603 *ascq = sense_table[i][3];
604 goto translate_done;
605 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400607 /* No immediate match */
Tejun Heo246619d2006-05-15 20:58:16 +0900608 if (verbose)
609 printk(KERN_WARNING "ata%u: no sense translation for "
610 "error 0x%02x\n", id, drv_err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 }
612
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 /* Fall back to interpreting status bits */
Jeff Garzikb0955182005-05-12 15:45:22 -0400614 for (i = 0; stat_table[i][0] != 0xFF; i++) {
615 if (stat_table[i][0] & drv_stat) {
616 *sk = stat_table[i][1];
617 *asc = stat_table[i][2];
618 *ascq = stat_table[i][3];
619 goto translate_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400622 /* No error? Undecoded? */
Tejun Heo246619d2006-05-15 20:58:16 +0900623 if (verbose)
624 printk(KERN_WARNING "ata%u: no sense translation for "
625 "status: 0x%02x\n", id, drv_stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Alan Cox2d202022006-03-21 15:53:46 +0000627 /* We need a sensible error return here, which is tricky, and one
628 that won't cause people to do things like return a disk wrongly */
629 *sk = ABORTED_COMMAND;
630 *asc = 0x00;
631 *ascq = 0x00;
Jeff Garzikb0955182005-05-12 15:45:22 -0400632
633 translate_done:
Tejun Heo246619d2006-05-15 20:58:16 +0900634 if (verbose)
635 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
636 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
637 id, drv_stat, drv_err, *sk, *asc, *ascq);
Jeff Garzikb0955182005-05-12 15:45:22 -0400638 return;
639}
640
641/*
642 * ata_gen_ata_desc_sense - Generate check condition sense block.
643 * @qc: Command that completed.
644 *
645 * This function is specific to the ATA descriptor format sense
646 * block specified for the ATA pass through commands. Regardless
647 * of whether the command errored or not, return a sense
648 * block. Copy all controller registers into the sense
649 * block. Clear sense key, ASC & ASCQ if there is no error.
650 *
651 * LOCKING:
652 * spin_lock_irqsave(host_set lock)
653 */
654void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
655{
656 struct scsi_cmnd *cmd = qc->scsicmd;
Tejun Heoe61e0672006-05-15 20:57:40 +0900657 struct ata_taskfile *tf = &qc->result_tf;
Jeff Garzikb0955182005-05-12 15:45:22 -0400658 unsigned char *sb = cmd->sense_buffer;
659 unsigned char *desc = sb + 8;
Tejun Heo246619d2006-05-15 20:58:16 +0900660 int verbose = qc->ap->ops->error_handler == NULL;
Jeff Garzikb0955182005-05-12 15:45:22 -0400661
662 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
663
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400664 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400665
666 /*
Jeff Garzikb0955182005-05-12 15:45:22 -0400667 * Use ata_to_sense_error() to map status register bits
668 * onto sense key, asc & ascq.
669 */
Tejun Heo058e55e2006-04-02 18:51:53 +0900670 if (qc->err_mask ||
671 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400672 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
Tejun Heo246619d2006-05-15 20:58:16 +0900673 &sb[1], &sb[2], &sb[3], verbose);
Jeff Garzikb0955182005-05-12 15:45:22 -0400674 sb[1] &= 0x0f;
675 }
676
677 /*
678 * Sense data is current and format is descriptor.
679 */
680 sb[0] = 0x72;
681
682 desc[0] = 0x09;
683
684 /*
685 * Set length of additional sense data.
686 * Since we only populate descriptor 0, the total
687 * length is the same (fixed) length as descriptor 0.
688 */
689 desc[1] = sb[7] = 14;
690
691 /*
692 * Copy registers into sense buffer.
693 */
694 desc[2] = 0x00;
695 desc[3] = tf->feature; /* == error reg */
696 desc[5] = tf->nsect;
697 desc[7] = tf->lbal;
698 desc[9] = tf->lbam;
699 desc[11] = tf->lbah;
700 desc[12] = tf->device;
701 desc[13] = tf->command; /* == status reg */
702
703 /*
704 * Fill in Extend bit, and the high order bytes
705 * if applicable.
706 */
707 if (tf->flags & ATA_TFLAG_LBA48) {
708 desc[2] |= 0x01;
709 desc[4] = tf->hob_nsect;
710 desc[6] = tf->hob_lbal;
711 desc[8] = tf->hob_lbam;
712 desc[10] = tf->hob_lbah;
713 }
714}
715
716/**
717 * ata_gen_fixed_sense - generate a SCSI fixed sense block
718 * @qc: Command that we are erroring out
719 *
720 * Leverage ata_to_sense_error() to give us the codes. Fit our
721 * LBA in here if there's room.
722 *
723 * LOCKING:
724 * inherited from caller
725 */
726void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
727{
728 struct scsi_cmnd *cmd = qc->scsicmd;
Tejun Heoe61e0672006-05-15 20:57:40 +0900729 struct ata_taskfile *tf = &qc->result_tf;
Jeff Garzikb0955182005-05-12 15:45:22 -0400730 unsigned char *sb = cmd->sense_buffer;
Tejun Heo246619d2006-05-15 20:58:16 +0900731 int verbose = qc->ap->ops->error_handler == NULL;
Jeff Garzikb0955182005-05-12 15:45:22 -0400732
733 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
734
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400735 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400736
737 /*
Jeff Garzikb0955182005-05-12 15:45:22 -0400738 * Use ata_to_sense_error() to map status register bits
739 * onto sense key, asc & ascq.
740 */
Tejun Heo058e55e2006-04-02 18:51:53 +0900741 if (qc->err_mask ||
742 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400743 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
Tejun Heo246619d2006-05-15 20:58:16 +0900744 &sb[2], &sb[12], &sb[13], verbose);
Jeff Garzikb0955182005-05-12 15:45:22 -0400745 sb[2] &= 0x0f;
746 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
748 sb[0] = 0x70;
Jeff Garzikb0955182005-05-12 15:45:22 -0400749 sb[7] = 0x0a;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400750
Jeff Garzika7dac442005-10-30 04:44:42 -0500751 if (tf->flags & ATA_TFLAG_LBA48) {
752 /* TODO: find solution for LBA48 descriptors */
753 }
754
755 else if (tf->flags & ATA_TFLAG_LBA) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400756 /* A small (28b) LBA will fit in the 32b info field */
757 sb[0] |= 0x80; /* set valid bit */
758 sb[3] = tf->device & 0x0f;
759 sb[4] = tf->lbah;
760 sb[5] = tf->lbam;
761 sb[6] = tf->lbal;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 }
Jeff Garzika7dac442005-10-30 04:44:42 -0500763
764 else {
765 /* TODO: C/H/S */
766 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767}
768
Brian Kinga6cce2a2006-03-17 17:04:15 -0600769static void ata_scsi_sdev_config(struct scsi_device *sdev)
770{
771 sdev->use_10_for_rw = 1;
772 sdev->use_10_for_ms = 1;
773}
774
775static void ata_scsi_dev_config(struct scsi_device *sdev,
776 struct ata_device *dev)
777{
778 unsigned int max_sectors;
779
780 /* TODO: 2048 is an arbitrary number, not the
781 * hardware maximum. This should be increased to
782 * 65534 when Jens Axboe's patch for dynamically
783 * determining max_sectors is merged.
784 */
785 max_sectors = ATA_MAX_SECTORS;
786 if (dev->flags & ATA_DFLAG_LBA48)
Tejun Heo200d5a762006-02-15 16:24:49 +0900787 max_sectors = ATA_MAX_SECTORS_LBA48;
Brian Kinga6cce2a2006-03-17 17:04:15 -0600788 if (dev->max_sectors)
789 max_sectors = dev->max_sectors;
790
791 blk_queue_max_sectors(sdev->request_queue, max_sectors);
792
793 /*
794 * SATA DMA transfers must be multiples of 4 byte, so
795 * we need to pad ATAPI transfers using an extra sg.
796 * Decrement max hw segments accordingly.
797 */
798 if (dev->class == ATA_DEV_ATAPI) {
799 request_queue_t *q = sdev->request_queue;
800 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
801 }
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900802
803 if (dev->flags & ATA_DFLAG_NCQ) {
804 int depth;
805
806 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
807 depth = min(ATA_MAX_QUEUE - 1, depth);
808 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
809 }
Brian Kinga6cce2a2006-03-17 17:04:15 -0600810}
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812/**
813 * ata_scsi_slave_config - Set SCSI device attributes
814 * @sdev: SCSI device to examine
815 *
816 * This is called before we actually start reading
817 * and writing to the device, to configure certain
818 * SCSI mid-layer behaviors.
819 *
820 * LOCKING:
821 * Defined by SCSI layer. We don't really care.
822 */
823
824int ata_scsi_slave_config(struct scsi_device *sdev)
825{
Tejun Heo31534362006-05-31 18:27:36 +0900826 struct ata_port *ap = ata_shost_to_port(sdev->host);
827 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
828
Brian Kinga6cce2a2006-03-17 17:04:15 -0600829 ata_scsi_sdev_config(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
831 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
832
Tejun Heo31534362006-05-31 18:27:36 +0900833 if (dev)
Brian Kinga6cce2a2006-03-17 17:04:15 -0600834 ata_scsi_dev_config(sdev, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836 return 0; /* scsi layer doesn't check return value, sigh */
837}
838
839/**
Tejun Heo83c47bc2006-05-31 18:28:07 +0900840 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
841 * @sdev: SCSI device to be destroyed
842 *
843 * @sdev is about to be destroyed for hot/warm unplugging. If
844 * this unplugging was initiated by libata as indicated by NULL
845 * dev->sdev, this function doesn't have to do anything.
846 * Otherwise, SCSI layer initiated warm-unplug is in progress.
847 * Clear dev->sdev, schedule the device for ATA detach and invoke
848 * EH.
849 *
850 * LOCKING:
851 * Defined by SCSI layer. We don't really care.
852 */
853void ata_scsi_slave_destroy(struct scsi_device *sdev)
854{
855 struct ata_port *ap = ata_shost_to_port(sdev->host);
856 unsigned long flags;
857 struct ata_device *dev;
858
859 if (!ap->ops->error_handler)
860 return;
861
Jeff Garzikba6a1302006-06-22 23:46:10 -0400862 spin_lock_irqsave(ap->lock, flags);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900863 dev = __ata_scsi_find_dev(ap, sdev);
864 if (dev && dev->sdev) {
865 /* SCSI device already in CANCEL state, no need to offline it */
866 dev->sdev = NULL;
867 dev->flags |= ATA_DFLAG_DETACH;
868 ata_port_schedule_eh(ap);
869 }
Jeff Garzikba6a1302006-06-22 23:46:10 -0400870 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900871}
872
873/**
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900874 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
875 * @sdev: SCSI device to configure queue depth for
876 * @queue_depth: new queue depth
877 *
878 * This is libata standard hostt->change_queue_depth callback.
879 * SCSI will call into this callback when user tries to set queue
880 * depth via sysfs.
881 *
882 * LOCKING:
883 * SCSI layer (we don't care)
884 *
885 * RETURNS:
886 * Newly configured queue depth.
887 */
888int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
889{
890 struct ata_port *ap = ata_shost_to_port(sdev->host);
891 struct ata_device *dev;
892 int max_depth;
893
894 if (queue_depth < 1)
895 return sdev->queue_depth;
896
897 dev = ata_scsi_find_dev(ap, sdev);
898 if (!dev || !ata_dev_enabled(dev))
899 return sdev->queue_depth;
900
901 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
902 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
903 if (queue_depth > max_depth)
904 queue_depth = max_depth;
905
906 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
907 return queue_depth;
908}
909
910/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400911 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
912 * @qc: Storage for translated ATA taskfile
913 * @scsicmd: SCSI command to translate
914 *
915 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
916 * (to start). Perhaps these commands should be preceded by
917 * CHECK POWER MODE to see what power mode the device is already in.
918 * [See SAT revision 5 at www.t10.org]
919 *
920 * LOCKING:
921 * spin_lock_irqsave(host_set lock)
922 *
923 * RETURNS:
924 * Zero on success, non-zero on error.
925 */
926
927static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
Jeff Garzik057ace52005-10-22 14:27:05 -0400928 const u8 *scsicmd)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400929{
930 struct ata_taskfile *tf = &qc->tf;
931
932 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
933 tf->protocol = ATA_PROT_NODATA;
934 if (scsicmd[1] & 0x1) {
935 ; /* ignore IMMED bit, violates sat-r05 */
936 }
937 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400938 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400939 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400940 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400941 if (scsicmd[4] & 0x1) {
942 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400943
944 if (qc->dev->flags & ATA_DFLAG_LBA) {
Tejun Heoc44078c2006-05-15 20:57:21 +0900945 tf->flags |= ATA_TFLAG_LBA;
Albert Lee9d5b1302005-10-04 08:48:17 -0400946
947 tf->lbah = 0x0;
948 tf->lbam = 0x0;
949 tf->lbal = 0x0;
950 tf->device |= ATA_LBA;
951 } else {
952 /* CHS */
953 tf->lbal = 0x1; /* sect */
954 tf->lbam = 0x0; /* cyl low */
955 tf->lbah = 0x0; /* cyl high */
956 }
957
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400958 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
959 } else {
960 tf->nsect = 0; /* time period value (0 implies now) */
961 tf->command = ATA_CMD_STANDBY;
962 /* Consider: ATA STANDBY IMMEDIATE command */
963 }
964 /*
965 * Standby and Idle condition timers could be implemented but that
966 * would require libata to implement the Power condition mode page
967 * and allow the user to change it. Changing mode pages requires
968 * MODE SELECT to be implemented.
969 */
970
971 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400972
973invalid_fld:
974 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
975 /* "Invalid field in cbd" */
976 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400977}
978
979
980/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
982 * @qc: Storage for translated ATA taskfile
983 * @scsicmd: SCSI command to translate (ignored)
984 *
985 * Sets up an ATA taskfile to issue FLUSH CACHE or
986 * FLUSH CACHE EXT.
987 *
988 * LOCKING:
989 * spin_lock_irqsave(host_set lock)
990 *
991 * RETURNS:
992 * Zero on success, non-zero on error.
993 */
994
Jeff Garzik057ace52005-10-22 14:27:05 -0400995static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996{
997 struct ata_taskfile *tf = &qc->tf;
998
999 tf->flags |= ATA_TFLAG_DEVICE;
1000 tf->protocol = ATA_PROT_NODATA;
1001
Albert Lee07506692005-10-12 15:04:18 +08001002 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 (ata_id_has_flush_ext(qc->dev->id)))
1004 tf->command = ATA_CMD_FLUSH_EXT;
1005 else
1006 tf->command = ATA_CMD_FLUSH;
1007
1008 return 0;
1009}
1010
1011/**
Albert Lee3aef5232005-10-04 08:47:43 -04001012 * scsi_6_lba_len - Get LBA and transfer length
1013 * @scsicmd: SCSI command to translate
1014 *
1015 * Calculate LBA and transfer length for 6-byte commands.
1016 *
1017 * RETURNS:
1018 * @plba: the LBA
1019 * @plen: the transfer length
1020 */
1021
Jeff Garzik057ace52005-10-22 14:27:05 -04001022static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001023{
1024 u64 lba = 0;
1025 u32 len = 0;
1026
1027 VPRINTK("six-byte command\n");
1028
1029 lba |= ((u64)scsicmd[2]) << 8;
1030 lba |= ((u64)scsicmd[3]);
1031
1032 len |= ((u32)scsicmd[4]);
1033
1034 *plba = lba;
1035 *plen = len;
1036}
1037
1038/**
1039 * scsi_10_lba_len - Get LBA and transfer length
1040 * @scsicmd: SCSI command to translate
1041 *
1042 * Calculate LBA and transfer length for 10-byte commands.
1043 *
1044 * RETURNS:
1045 * @plba: the LBA
1046 * @plen: the transfer length
1047 */
1048
Jeff Garzik057ace52005-10-22 14:27:05 -04001049static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001050{
1051 u64 lba = 0;
1052 u32 len = 0;
1053
1054 VPRINTK("ten-byte command\n");
1055
1056 lba |= ((u64)scsicmd[2]) << 24;
1057 lba |= ((u64)scsicmd[3]) << 16;
1058 lba |= ((u64)scsicmd[4]) << 8;
1059 lba |= ((u64)scsicmd[5]);
1060
1061 len |= ((u32)scsicmd[7]) << 8;
1062 len |= ((u32)scsicmd[8]);
1063
1064 *plba = lba;
1065 *plen = len;
1066}
1067
1068/**
1069 * scsi_16_lba_len - Get LBA and transfer length
1070 * @scsicmd: SCSI command to translate
1071 *
1072 * Calculate LBA and transfer length for 16-byte commands.
1073 *
1074 * RETURNS:
1075 * @plba: the LBA
1076 * @plen: the transfer length
1077 */
1078
Jeff Garzik057ace52005-10-22 14:27:05 -04001079static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001080{
1081 u64 lba = 0;
1082 u32 len = 0;
1083
1084 VPRINTK("sixteen-byte command\n");
1085
1086 lba |= ((u64)scsicmd[2]) << 56;
1087 lba |= ((u64)scsicmd[3]) << 48;
1088 lba |= ((u64)scsicmd[4]) << 40;
1089 lba |= ((u64)scsicmd[5]) << 32;
1090 lba |= ((u64)scsicmd[6]) << 24;
1091 lba |= ((u64)scsicmd[7]) << 16;
1092 lba |= ((u64)scsicmd[8]) << 8;
1093 lba |= ((u64)scsicmd[9]);
1094
1095 len |= ((u32)scsicmd[10]) << 24;
1096 len |= ((u32)scsicmd[11]) << 16;
1097 len |= ((u32)scsicmd[12]) << 8;
1098 len |= ((u32)scsicmd[13]);
1099
1100 *plba = lba;
1101 *plen = len;
1102}
1103
1104/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1106 * @qc: Storage for translated ATA taskfile
1107 * @scsicmd: SCSI command to translate
1108 *
1109 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1110 *
1111 * LOCKING:
1112 * spin_lock_irqsave(host_set lock)
1113 *
1114 * RETURNS:
1115 * Zero on success, non-zero on error.
1116 */
1117
Jeff Garzik057ace52005-10-22 14:27:05 -04001118static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119{
1120 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001121 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -04001123 u64 block;
1124 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
1126 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1127 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Albert Lee3aef5232005-10-04 08:47:43 -04001129 if (scsicmd[0] == VERIFY)
1130 scsi_10_lba_len(scsicmd, &block, &n_block);
1131 else if (scsicmd[0] == VERIFY_16)
1132 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 else
Douglas Gilbertae006512005-10-09 09:09:35 -04001134 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
Albert Lee8bf62ece2005-05-12 15:29:42 -04001136 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -04001137 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001138 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001139 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001140 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001141 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
Albert Lee07506692005-10-12 15:04:18 +08001143 if (dev->flags & ATA_DFLAG_LBA) {
1144 tf->flags |= ATA_TFLAG_LBA;
1145
Albert Leec6a33e22005-10-12 15:12:26 +08001146 if (lba_28_ok(block, n_block)) {
1147 /* use LBA28 */
1148 tf->command = ATA_CMD_VERIFY;
1149 tf->device |= (block >> 24) & 0xf;
1150 } else if (lba_48_ok(block, n_block)) {
1151 if (!(dev->flags & ATA_DFLAG_LBA48))
1152 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001153
1154 /* use LBA48 */
1155 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001156 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
Albert Lee8bf62ece2005-05-12 15:29:42 -04001158 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
Albert Lee8bf62ece2005-05-12 15:29:42 -04001160 tf->hob_lbah = (block >> 40) & 0xff;
1161 tf->hob_lbam = (block >> 32) & 0xff;
1162 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001163 } else
1164 /* request too large even for LBA48 */
1165 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001166
1167 tf->nsect = n_block & 0xff;
1168
1169 tf->lbah = (block >> 16) & 0xff;
1170 tf->lbam = (block >> 8) & 0xff;
1171 tf->lbal = block & 0xff;
1172
1173 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001175 /* CHS */
1176 u32 sect, head, cyl, track;
1177
Albert Leec6a33e22005-10-12 15:12:26 +08001178 if (!lba_28_ok(block, n_block))
1179 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001180
Albert Lee8bf62ece2005-05-12 15:29:42 -04001181 /* Convert LBA to CHS */
1182 track = (u32)block / dev->sectors;
1183 cyl = track / dev->heads;
1184 head = track % dev->heads;
1185 sect = (u32)block % dev->sectors + 1;
1186
Albert Leec187c4b2005-10-04 08:46:51 -04001187 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1188 (u32)block, track, cyl, head, sect);
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001189
1190 /* Check whether the converted CHS can fit.
1191 Cylinder: 0-65535
Albert Lee8bf62ece2005-05-12 15:29:42 -04001192 Head: 0-15
1193 Sector: 1-255*/
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001194 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001195 goto out_of_range;
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001196
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001198 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1199 tf->lbal = sect;
1200 tf->lbam = cyl;
1201 tf->lbah = cyl >> 8;
1202 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 }
1204
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001206
1207invalid_fld:
1208 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1209 /* "Invalid field in cbd" */
1210 return 1;
1211
1212out_of_range:
1213 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1214 /* "Logical Block Address out of range" */
1215 return 1;
1216
1217nothing_to_do:
1218 qc->scsicmd->result = SAM_STAT_GOOD;
1219 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220}
1221
1222/**
1223 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1224 * @qc: Storage for translated ATA taskfile
1225 * @scsicmd: SCSI command to translate
1226 *
1227 * Converts any of six SCSI read/write commands into the
1228 * ATA counterpart, including starting sector (LBA),
1229 * sector count, and taking into account the device's LBA48
1230 * support.
1231 *
1232 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1233 * %WRITE_16 are currently supported.
1234 *
1235 * LOCKING:
1236 * spin_lock_irqsave(host_set lock)
1237 *
1238 * RETURNS:
1239 * Zero on success, non-zero on error.
1240 */
1241
Jeff Garzik057ace52005-10-22 14:27:05 -04001242static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243{
1244 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001245 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -04001246 u64 block;
1247 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248
Tejun Heo27197362006-04-02 18:51:53 +09001249 qc->flags |= ATA_QCFLAG_IO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251
Albert Lee8cbd6df2005-10-12 15:06:27 +08001252 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1253 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001256 /* Calculate the SCSI LBA, transfer length and FUA. */
Albert Lee3aef5232005-10-04 08:47:43 -04001257 switch (scsicmd[0]) {
1258 case READ_10:
1259 case WRITE_10:
1260 scsi_10_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001261 if (unlikely(scsicmd[1] & (1 << 3)))
1262 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001263 break;
1264 case READ_6:
1265 case WRITE_6:
1266 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001267
1268 /* for 6-byte r/w commands, transfer length 0
1269 * means 256 blocks of data, not 0 block.
1270 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001271 if (!n_block)
1272 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -04001273 break;
1274 case READ_16:
1275 case WRITE_16:
1276 scsi_16_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001277 if (unlikely(scsicmd[1] & (1 << 3)))
1278 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001279 break;
1280 default:
Albert Lee8bf62ece2005-05-12 15:29:42 -04001281 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001282 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 }
1284
Albert Lee8bf62ece2005-05-12 15:29:42 -04001285 /* Check and compose ATA command */
1286 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001287 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1288 * length 0 means transfer 0 block of data.
1289 * However, for ATA R/W commands, sector count 0 means
1290 * 256 or 65536 sectors, not 0 sectors as in SCSI.
Alan Coxf51750d2005-11-07 17:06:33 +00001291 *
1292 * WARNING: one or two older ATA drives treat 0 as 0...
Albert Leec187c4b2005-10-04 08:46:51 -04001293 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001294 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001295
Tejun Heo3dc1d882006-05-15 21:03:45 +09001296 if ((dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ) {
1297 /* yay, NCQ */
1298 if (!lba_48_ok(block, n_block))
1299 goto out_of_range;
1300
1301 tf->protocol = ATA_PROT_NCQ;
1302 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
1303
1304 if (tf->flags & ATA_TFLAG_WRITE)
1305 tf->command = ATA_CMD_FPDMA_WRITE;
1306 else
1307 tf->command = ATA_CMD_FPDMA_READ;
1308
1309 qc->nsect = n_block;
1310
1311 tf->nsect = qc->tag << 3;
1312 tf->hob_feature = (n_block >> 8) & 0xff;
1313 tf->feature = n_block & 0xff;
1314
1315 tf->hob_lbah = (block >> 40) & 0xff;
1316 tf->hob_lbam = (block >> 32) & 0xff;
1317 tf->hob_lbal = (block >> 24) & 0xff;
1318 tf->lbah = (block >> 16) & 0xff;
1319 tf->lbam = (block >> 8) & 0xff;
1320 tf->lbal = block & 0xff;
1321
1322 tf->device = 1 << 6;
1323 if (tf->flags & ATA_TFLAG_FUA)
1324 tf->device |= 1 << 7;
1325 } else if (dev->flags & ATA_DFLAG_LBA) {
Albert Lee07506692005-10-12 15:04:18 +08001326 tf->flags |= ATA_TFLAG_LBA;
1327
Albert Leec6a33e22005-10-12 15:12:26 +08001328 if (lba_28_ok(block, n_block)) {
1329 /* use LBA28 */
1330 tf->device |= (block >> 24) & 0xf;
1331 } else if (lba_48_ok(block, n_block)) {
1332 if (!(dev->flags & ATA_DFLAG_LBA48))
Douglas Gilbertae006512005-10-09 09:09:35 -04001333 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001334
Albert Lee07506692005-10-12 15:04:18 +08001335 /* use LBA48 */
1336 tf->flags |= ATA_TFLAG_LBA48;
1337
Albert Lee8bf62ece2005-05-12 15:29:42 -04001338 tf->hob_nsect = (n_block >> 8) & 0xff;
1339
1340 tf->hob_lbah = (block >> 40) & 0xff;
1341 tf->hob_lbam = (block >> 32) & 0xff;
1342 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001343 } else
1344 /* request too large even for LBA48 */
1345 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001346
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001347 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1348 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001349
Albert Lee8bf62ece2005-05-12 15:29:42 -04001350 qc->nsect = n_block;
1351 tf->nsect = n_block & 0xff;
1352
1353 tf->lbah = (block >> 16) & 0xff;
1354 tf->lbam = (block >> 8) & 0xff;
1355 tf->lbal = block & 0xff;
1356
1357 tf->device |= ATA_LBA;
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001358 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001359 /* CHS */
1360 u32 sect, head, cyl, track;
1361
1362 /* The request -may- be too large for CHS addressing. */
Albert Leec6a33e22005-10-12 15:12:26 +08001363 if (!lba_28_ok(block, n_block))
Douglas Gilbertae006512005-10-09 09:09:35 -04001364 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001365
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001366 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1367 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001368
Albert Lee8bf62ece2005-05-12 15:29:42 -04001369 /* Convert LBA to CHS */
1370 track = (u32)block / dev->sectors;
1371 cyl = track / dev->heads;
1372 head = track % dev->heads;
1373 sect = (u32)block % dev->sectors + 1;
1374
Albert Leec187c4b2005-10-04 08:46:51 -04001375 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ece2005-05-12 15:29:42 -04001376 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -04001377
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001378 /* Check whether the converted CHS can fit.
1379 Cylinder: 0-65535
Albert Lee8bf62ece2005-05-12 15:29:42 -04001380 Head: 0-15
1381 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -04001382 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001383 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001384
Albert Lee8bf62ece2005-05-12 15:29:42 -04001385 qc->nsect = n_block;
1386 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1387 tf->lbal = sect;
1388 tf->lbam = cyl;
1389 tf->lbah = cyl >> 8;
1390 tf->device |= head;
1391 }
1392
1393 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001394
1395invalid_fld:
1396 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1397 /* "Invalid field in cbd" */
1398 return 1;
1399
1400out_of_range:
1401 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1402 /* "Logical Block Address out of range" */
1403 return 1;
1404
1405nothing_to_do:
1406 qc->scsicmd->result = SAM_STAT_GOOD;
1407 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408}
1409
Tejun Heo77853bf2006-01-23 13:09:36 +09001410static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411{
1412 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001413 u8 *cdb = cmd->cmnd;
Albert Leea22e2eb2005-12-05 15:38:02 +08001414 int need_sense = (qc->err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
zhao, forrest3057ac32006-06-12 12:01:34 +08001416 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1417 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1418 * cache
1419 */
1420 if (!need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1421 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1422 (qc->tf.feature == SETFEATURES_WC_OFF))) {
1423 qc->ap->eh_info.action |= ATA_EH_REVALIDATE;
1424 ata_port_schedule_eh(qc->ap);
1425 }
1426
Jeff Garzikb0955182005-05-12 15:45:22 -04001427 /* For ATA pass thru (SAT) commands, generate a sense block if
1428 * user mandated it or if there's an error. Note that if we
1429 * generate because the user forced us to, a check condition
1430 * is generated and the ATA register values are returned
1431 * whether the command completed successfully or not. If there
1432 * was no error, SK, ASC and ASCQ will all be zero.
1433 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001434 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1435 ((cdb[2] & 0x20) || need_sense)) {
Jeff Garzikb0955182005-05-12 15:45:22 -04001436 ata_gen_ata_desc_sense(qc);
1437 } else {
1438 if (!need_sense) {
1439 cmd->result = SAM_STAT_GOOD;
1440 } else {
1441 /* TODO: decide which descriptor format to use
1442 * for 48b LBA devices and call that here
1443 * instead of the fixed desc, which is only
1444 * good for smaller LBA (and maybe CHS?)
1445 * devices.
1446 */
1447 ata_gen_fixed_sense(qc);
1448 }
1449 }
1450
Tejun Heo246619d2006-05-15 20:58:16 +09001451 if (need_sense && !qc->ap->ops->error_handler)
Tejun Heoe61e0672006-05-15 20:57:40 +09001452 ata_dump_status(qc->ap->id, &qc->result_tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
1454 qc->scsidone(cmd);
1455
Tejun Heo77853bf2006-01-23 13:09:36 +09001456 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457}
1458
1459/**
Tejun Heo3dc1d882006-05-15 21:03:45 +09001460 * ata_scmd_need_defer - Check whether we need to defer scmd
1461 * @dev: ATA device to which the command is addressed
1462 * @is_io: Is the command IO (and thus possibly NCQ)?
1463 *
1464 * NCQ and non-NCQ commands cannot run together. As upper layer
1465 * only knows the queue depth, we are responsible for maintaining
1466 * exclusion. This function checks whether a new command can be
1467 * issued to @dev.
1468 *
1469 * LOCKING:
1470 * spin_lock_irqsave(host_set lock)
1471 *
1472 * RETURNS:
1473 * 1 if deferring is needed, 0 otherwise.
1474 */
1475static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1476{
1477 struct ata_port *ap = dev->ap;
1478
1479 if (!(dev->flags & ATA_DFLAG_NCQ))
1480 return 0;
1481
1482 if (is_io) {
1483 if (!ata_tag_valid(ap->active_tag))
1484 return 0;
1485 } else {
1486 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1487 return 0;
1488 }
1489 return 1;
1490}
1491
1492/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 * ata_scsi_translate - Translate then issue SCSI command to ATA device
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 * @dev: ATA device to which the command is addressed
1495 * @cmd: SCSI command to execute
1496 * @done: SCSI command completion function
1497 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1498 *
1499 * Our ->queuecommand() function has decided that the SCSI
1500 * command issued can be directly translated into an ATA
1501 * command, rather than handled internally.
1502 *
1503 * This function sets up an ata_queued_cmd structure for the
1504 * SCSI command, and sends that ata_queued_cmd to the hardware.
1505 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001506 * The xlat_func argument (actor) returns 0 if ready to execute
1507 * ATA command, else 1 to finish translation. If 1 is returned
1508 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1509 * to be set reflecting an error condition or clean (early)
1510 * termination.
1511 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 * LOCKING:
1513 * spin_lock_irqsave(host_set lock)
Tejun Heo2115ea92006-05-15 21:03:39 +09001514 *
1515 * RETURNS:
1516 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1517 * needs to be deferred.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 */
Tejun Heo2115ea92006-05-15 21:03:39 +09001519static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1520 void (*done)(struct scsi_cmnd *),
1521 ata_xlat_func_t xlat_func)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522{
1523 struct ata_queued_cmd *qc;
1524 u8 *scsicmd = cmd->cmnd;
Tejun Heo3dc1d882006-05-15 21:03:45 +09001525 int is_io = xlat_func == ata_scsi_rw_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
1527 VPRINTK("ENTER\n");
1528
Tejun Heo3dc1d882006-05-15 21:03:45 +09001529 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1530 goto defer;
1531
Tejun Heo3373efd2006-05-15 20:57:53 +09001532 qc = ata_scsi_qc_new(dev, cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001534 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
1536 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -05001537 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1538 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 if (unlikely(cmd->request_bufflen < 1)) {
Tejun Heof15a1da2006-05-15 20:57:56 +09001540 ata_dev_printk(dev, KERN_WARNING,
1541 "WARNING: zero len r/w req\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001542 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 }
1544
1545 if (cmd->use_sg)
1546 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1547 else
1548 ata_sg_init_one(qc, cmd->request_buffer,
1549 cmd->request_bufflen);
1550
1551 qc->dma_dir = cmd->sc_data_direction;
1552 }
1553
1554 qc->complete_fn = ata_scsi_qc_complete;
1555
1556 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -04001557 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559 /* select device, send command to hardware */
Tejun Heo8e0e6942006-03-31 20:41:11 +09001560 ata_qc_issue(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
1562 VPRINTK("EXIT\n");
Tejun Heo2115ea92006-05-15 21:03:39 +09001563 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Douglas Gilbertae006512005-10-09 09:09:35 -04001565early_finish:
1566 ata_qc_free(qc);
1567 done(cmd);
1568 DPRINTK("EXIT - early finish (good or error)\n");
Tejun Heo2115ea92006-05-15 21:03:39 +09001569 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001570
1571err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001573err_mem:
1574 cmd->result = (DID_ERROR << 16);
1575 done(cmd);
1576 DPRINTK("EXIT - internal\n");
Tejun Heo2115ea92006-05-15 21:03:39 +09001577 return 0;
Tejun Heo3dc1d882006-05-15 21:03:45 +09001578
1579defer:
1580 DPRINTK("EXIT - defer\n");
1581 return SCSI_MLQUEUE_DEVICE_BUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582}
1583
1584/**
1585 * ata_scsi_rbuf_get - Map response buffer.
1586 * @cmd: SCSI command containing buffer to be mapped.
1587 * @buf_out: Pointer to mapped area.
1588 *
1589 * Maps buffer contained within SCSI command @cmd.
1590 *
1591 * LOCKING:
1592 * spin_lock_irqsave(host_set lock)
1593 *
1594 * RETURNS:
1595 * Length of response buffer.
1596 */
1597
1598static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1599{
1600 u8 *buf;
1601 unsigned int buflen;
1602
1603 if (cmd->use_sg) {
1604 struct scatterlist *sg;
1605
1606 sg = (struct scatterlist *) cmd->request_buffer;
1607 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1608 buflen = sg->length;
1609 } else {
1610 buf = cmd->request_buffer;
1611 buflen = cmd->request_bufflen;
1612 }
1613
1614 *buf_out = buf;
1615 return buflen;
1616}
1617
1618/**
1619 * ata_scsi_rbuf_put - Unmap response buffer.
1620 * @cmd: SCSI command containing buffer to be unmapped.
1621 * @buf: buffer to unmap
1622 *
1623 * Unmaps response buffer contained within @cmd.
1624 *
1625 * LOCKING:
1626 * spin_lock_irqsave(host_set lock)
1627 */
1628
1629static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1630{
1631 if (cmd->use_sg) {
1632 struct scatterlist *sg;
1633
1634 sg = (struct scatterlist *) cmd->request_buffer;
1635 kunmap_atomic(buf - sg->offset, KM_USER0);
1636 }
1637}
1638
1639/**
1640 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1641 * @args: device IDENTIFY data / SCSI command of interest.
1642 * @actor: Callback hook for desired SCSI command simulator
1643 *
1644 * Takes care of the hard work of simulating a SCSI command...
1645 * Mapping the response buffer, calling the command's handler,
1646 * and handling the handler's return value. This return value
1647 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001648 * completed successfully (0), or not (in which case cmd->result
1649 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 *
1651 * LOCKING:
1652 * spin_lock_irqsave(host_set lock)
1653 */
1654
1655void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1656 unsigned int (*actor) (struct ata_scsi_args *args,
1657 u8 *rbuf, unsigned int buflen))
1658{
1659 u8 *rbuf;
1660 unsigned int buflen, rc;
1661 struct scsi_cmnd *cmd = args->cmd;
1662
1663 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1664 memset(rbuf, 0, buflen);
1665 rc = actor(args, rbuf, buflen);
1666 ata_scsi_rbuf_put(cmd, rbuf);
1667
Douglas Gilbertae006512005-10-09 09:09:35 -04001668 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001670 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671}
1672
1673/**
1674 * ata_scsiop_inq_std - Simulate INQUIRY command
1675 * @args: device IDENTIFY data / SCSI command of interest.
1676 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1677 * @buflen: Response buffer length.
1678 *
1679 * Returns standard device identification data associated
Jeff Garzikb142eb62006-03-21 20:37:47 -05001680 * with non-VPD INQUIRY command output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 *
1682 * LOCKING:
1683 * spin_lock_irqsave(host_set lock)
1684 */
1685
1686unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1687 unsigned int buflen)
1688{
1689 u8 hdr[] = {
1690 TYPE_DISK,
1691 0,
1692 0x5, /* claim SPC-3 version compatibility */
1693 2,
1694 95 - 4
1695 };
1696
1697 /* set scsi removeable (RMB) bit per ata bit */
1698 if (ata_id_removeable(args->id))
1699 hdr[1] |= (1 << 7);
1700
1701 VPRINTK("ENTER\n");
1702
1703 memcpy(rbuf, hdr, sizeof(hdr));
1704
1705 if (buflen > 35) {
1706 memcpy(&rbuf[8], "ATA ", 8);
Tejun Heo6a62a042006-02-13 10:02:46 +09001707 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1708 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 if (rbuf[32] == 0 || rbuf[32] == ' ')
1710 memcpy(&rbuf[32], "n/a ", 4);
1711 }
1712
1713 if (buflen > 63) {
1714 const u8 versions[] = {
1715 0x60, /* SAM-3 (no version claimed) */
1716
1717 0x03,
1718 0x20, /* SBC-2 (no version claimed) */
1719
1720 0x02,
1721 0x60 /* SPC-3 (no version claimed) */
1722 };
1723
1724 memcpy(rbuf + 59, versions, sizeof(versions));
1725 }
1726
1727 return 0;
1728}
1729
1730/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001731 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 * @args: device IDENTIFY data / SCSI command of interest.
1733 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1734 * @buflen: Response buffer length.
1735 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001736 * Returns list of inquiry VPD pages available.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 *
1738 * LOCKING:
1739 * spin_lock_irqsave(host_set lock)
1740 */
1741
1742unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1743 unsigned int buflen)
1744{
1745 const u8 pages[] = {
1746 0x00, /* page 0x00, this page */
1747 0x80, /* page 0x80, unit serial no page */
1748 0x83 /* page 0x83, device ident page */
1749 };
Jeff Garzikb142eb62006-03-21 20:37:47 -05001750 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751
1752 if (buflen > 6)
1753 memcpy(rbuf + 4, pages, sizeof(pages));
1754
1755 return 0;
1756}
1757
1758/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001759 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 * @args: device IDENTIFY data / SCSI command of interest.
1761 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1762 * @buflen: Response buffer length.
1763 *
1764 * Returns ATA device serial number.
1765 *
1766 * LOCKING:
1767 * spin_lock_irqsave(host_set lock)
1768 */
1769
1770unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1771 unsigned int buflen)
1772{
1773 const u8 hdr[] = {
1774 0,
1775 0x80, /* this page code */
1776 0,
1777 ATA_SERNO_LEN, /* page len */
1778 };
1779 memcpy(rbuf, hdr, sizeof(hdr));
1780
1781 if (buflen > (ATA_SERNO_LEN + 4 - 1))
Tejun Heo6a62a042006-02-13 10:02:46 +09001782 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1783 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
1785 return 0;
1786}
1787
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001789 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 * @args: device IDENTIFY data / SCSI command of interest.
1791 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1792 * @buflen: Response buffer length.
1793 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001794 * Yields two logical unit device identification designators:
1795 * - vendor specific ASCII containing the ATA serial number
1796 * - SAT defined "t10 vendor id based" containing ASCII vendor
1797 * name ("ATA "), model and serial numbers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 *
1799 * LOCKING:
1800 * spin_lock_irqsave(host_set lock)
1801 */
1802
1803unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1804 unsigned int buflen)
1805{
Jeff Garzikb142eb62006-03-21 20:37:47 -05001806 int num;
1807 const int sat_model_serial_desc_len = 68;
1808 const int ata_model_byte_len = 40;
1809
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 rbuf[1] = 0x83; /* this page code */
Jeff Garzikb142eb62006-03-21 20:37:47 -05001811 num = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812
Jeff Garzikb142eb62006-03-21 20:37:47 -05001813 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1814 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001815 rbuf[num + 0] = 2;
Jeff Garzikb142eb62006-03-21 20:37:47 -05001816 rbuf[num + 3] = ATA_SERNO_LEN;
1817 num += 4;
1818 ata_id_string(args->id, (unsigned char *) rbuf + num,
1819 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1820 num += ATA_SERNO_LEN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 }
Jeff Garzikb142eb62006-03-21 20:37:47 -05001822 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1823 /* SAT defined lu model and serial numbers descriptor */
1824 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
Jeff Garzik2e9edbf2006-03-24 09:56:57 -05001825 rbuf[num + 0] = 2;
1826 rbuf[num + 1] = 1;
Jeff Garzikb142eb62006-03-21 20:37:47 -05001827 rbuf[num + 3] = sat_model_serial_desc_len;
1828 num += 4;
1829 memcpy(rbuf + num, "ATA ", 8);
1830 num += 8;
1831 ata_id_string(args->id, (unsigned char *) rbuf + num,
1832 ATA_ID_PROD_OFS, ata_model_byte_len);
1833 num += ata_model_byte_len;
1834 ata_id_string(args->id, (unsigned char *) rbuf + num,
1835 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1836 num += ATA_SERNO_LEN;
1837 }
1838 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 return 0;
1840}
1841
1842/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001843 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 * @args: device IDENTIFY data / SCSI command of interest.
1845 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1846 * @buflen: Response buffer length.
1847 *
1848 * No operation. Simply returns success to caller, to indicate
1849 * that the caller should successfully complete this SCSI command.
1850 *
1851 * LOCKING:
1852 * spin_lock_irqsave(host_set lock)
1853 */
1854
1855unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1856 unsigned int buflen)
1857{
1858 VPRINTK("ENTER\n");
1859 return 0;
1860}
1861
1862/**
1863 * ata_msense_push - Push data onto MODE SENSE data output buffer
1864 * @ptr_io: (input/output) Location to store more output data
1865 * @last: End of output data buffer
1866 * @buf: Pointer to BLOB being added to output buffer
1867 * @buflen: Length of BLOB
1868 *
1869 * Store MODE SENSE data on an output buffer.
1870 *
1871 * LOCKING:
1872 * None.
1873 */
1874
1875static void ata_msense_push(u8 **ptr_io, const u8 *last,
1876 const u8 *buf, unsigned int buflen)
1877{
1878 u8 *ptr = *ptr_io;
1879
1880 if ((ptr + buflen - 1) > last)
1881 return;
1882
1883 memcpy(ptr, buf, buflen);
1884
1885 ptr += buflen;
1886
1887 *ptr_io = ptr;
1888}
1889
1890/**
1891 * ata_msense_caching - Simulate MODE SENSE caching info page
1892 * @id: device IDENTIFY data
1893 * @ptr_io: (input/output) Location to store more output data
1894 * @last: End of output data buffer
1895 *
1896 * Generate a caching info page, which conditionally indicates
1897 * write caching to the SCSI layer, depending on device
1898 * capabilities.
1899 *
1900 * LOCKING:
1901 * None.
1902 */
1903
1904static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1905 const u8 *last)
1906{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001907 u8 page[CACHE_MPAGE_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001909 memcpy(page, def_cache_mpage, sizeof(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 if (ata_id_wcache_enabled(id))
1911 page[2] |= (1 << 2); /* write cache enable */
1912 if (!ata_id_rahead_enabled(id))
1913 page[12] |= (1 << 5); /* disable read ahead */
1914
1915 ata_msense_push(ptr_io, last, page, sizeof(page));
1916 return sizeof(page);
1917}
1918
1919/**
1920 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1921 * @dev: Device associated with this MODE SENSE command
1922 * @ptr_io: (input/output) Location to store more output data
1923 * @last: End of output data buffer
1924 *
1925 * Generate a generic MODE SENSE control mode page.
1926 *
1927 * LOCKING:
1928 * None.
1929 */
1930
1931static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1932{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001933 ata_msense_push(ptr_io, last, def_control_mpage,
1934 sizeof(def_control_mpage));
1935 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936}
1937
1938/**
1939 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1940 * @dev: Device associated with this MODE SENSE command
1941 * @ptr_io: (input/output) Location to store more output data
1942 * @last: End of output data buffer
1943 *
1944 * Generate a generic MODE SENSE r/w error recovery page.
1945 *
1946 * LOCKING:
1947 * None.
1948 */
1949
1950static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1951{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001953 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1954 sizeof(def_rw_recovery_mpage));
1955 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956}
1957
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001958/*
1959 * We can turn this into a real blacklist if it's needed, for now just
1960 * blacklist any Maxtor BANC1G10 revision firmware
1961 */
1962static int ata_dev_supports_fua(u16 *id)
1963{
1964 unsigned char model[41], fw[9];
1965
Jeff Garzikc3c013a2006-02-27 22:31:19 -05001966 if (!libata_fua)
1967 return 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001968 if (!ata_id_has_fua(id))
1969 return 0;
1970
Tejun Heo6a62a042006-02-13 10:02:46 +09001971 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1972 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001973
Tejun Heo2e026712006-02-12 22:47:04 +09001974 if (strcmp(model, "Maxtor"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001975 return 1;
Tejun Heo2e026712006-02-12 22:47:04 +09001976 if (strcmp(fw, "BANC1G10"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001977 return 1;
1978
1979 return 0; /* blacklisted */
1980}
1981
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982/**
1983 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1984 * @args: device IDENTIFY data / SCSI command of interest.
1985 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1986 * @buflen: Response buffer length.
1987 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001988 * Simulate MODE SENSE commands. Assume this is invoked for direct
1989 * access devices (e.g. disks) only. There should be no block
1990 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 *
1992 * LOCKING:
1993 * spin_lock_irqsave(host_set lock)
1994 */
1995
1996unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1997 unsigned int buflen)
1998{
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001999 struct ata_device *dev = args->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 u8 *scsicmd = args->cmd->cmnd, *p, *last;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002001 const u8 sat_blk_desc[] = {
2002 0, 0, 0, 0, /* number of blocks: sat unspecified */
2003 0,
2004 0, 0x2, 0x0 /* block length: 512 bytes */
2005 };
2006 u8 pg, spg;
2007 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002008 u8 dpofua;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009
2010 VPRINTK("ENTER\n");
2011
2012 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002013 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2014 /*
2015 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04002019 switch (page_control) {
2020 case 0: /* current */
2021 break; /* supported */
2022 case 3: /* saved */
2023 goto saving_not_supp;
2024 case 1: /* changeable */
2025 case 2: /* defaults */
2026 default:
2027 goto invalid_fld;
2028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002030 if (six_byte) {
2031 output_len = 4 + (ebd ? 8 : 0);
2032 alloc_len = scsicmd[4];
2033 } else {
2034 output_len = 8 + (ebd ? 8 : 0);
2035 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2036 }
2037 minlen = (alloc_len < buflen) ? alloc_len : buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
2039 p = rbuf + output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002040 last = rbuf + minlen - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002042 pg = scsicmd[2] & 0x3f;
2043 spg = scsicmd[3];
2044 /*
2045 * No mode subpages supported (yet) but asking for _all_
2046 * subpages may be valid
2047 */
2048 if (spg && (spg != ALL_SUB_MPAGES))
2049 goto invalid_fld;
2050
2051 switch(pg) {
2052 case RW_RECOVERY_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 output_len += ata_msense_rw_recovery(&p, last);
2054 break;
2055
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002056 case CACHE_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 output_len += ata_msense_caching(args->id, &p, last);
2058 break;
2059
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002060 case CONTROL_MPAGE: {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 output_len += ata_msense_ctl_mode(&p, last);
2062 break;
2063 }
2064
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002065 case ALL_MPAGES:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 output_len += ata_msense_rw_recovery(&p, last);
2067 output_len += ata_msense_caching(args->id, &p, last);
2068 output_len += ata_msense_ctl_mode(&p, last);
2069 break;
2070
2071 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04002072 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 }
2074
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002075 if (minlen < 1)
2076 return 0;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002077
2078 dpofua = 0;
Alan Coxf79d4092006-05-22 16:55:11 +01002079 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002080 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2081 dpofua = 1 << 4;
2082
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 if (six_byte) {
2084 output_len--;
2085 rbuf[0] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002086 if (minlen > 2)
2087 rbuf[2] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002088 if (ebd) {
2089 if (minlen > 3)
2090 rbuf[3] = sizeof(sat_blk_desc);
2091 if (minlen > 11)
2092 memcpy(rbuf + 4, sat_blk_desc,
2093 sizeof(sat_blk_desc));
2094 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 } else {
2096 output_len -= 2;
2097 rbuf[0] = output_len >> 8;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002098 if (minlen > 1)
2099 rbuf[1] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002100 if (minlen > 3)
2101 rbuf[3] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002102 if (ebd) {
2103 if (minlen > 7)
2104 rbuf[7] = sizeof(sat_blk_desc);
2105 if (minlen > 15)
2106 memcpy(rbuf + 8, sat_blk_desc,
2107 sizeof(sat_blk_desc));
2108 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04002111
2112invalid_fld:
2113 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2114 /* "Invalid field in cbd" */
2115 return 1;
2116
2117saving_not_supp:
2118 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2119 /* "Saving parameters not supported" */
2120 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121}
2122
2123/**
2124 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2125 * @args: device IDENTIFY data / SCSI command of interest.
2126 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2127 * @buflen: Response buffer length.
2128 *
2129 * Simulate READ CAPACITY commands.
2130 *
2131 * LOCKING:
2132 * spin_lock_irqsave(host_set lock)
2133 */
2134
2135unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2136 unsigned int buflen)
2137{
2138 u64 n_sectors;
2139 u32 tmp;
2140
2141 VPRINTK("ENTER\n");
2142
Albert Lee8bf62ece2005-05-12 15:29:42 -04002143 if (ata_id_has_lba(args->id)) {
2144 if (ata_id_has_lba48(args->id))
2145 n_sectors = ata_id_u64(args->id, 100);
2146 else
2147 n_sectors = ata_id_u32(args->id, 60);
2148 } else {
2149 /* CHS default translation */
2150 n_sectors = args->id[1] * args->id[3] * args->id[6];
2151
2152 if (ata_id_current_chs_valid(args->id))
2153 /* CHS current translation */
2154 n_sectors = ata_id_u32(args->id, 57);
2155 }
2156
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 n_sectors--; /* ATA TotalUserSectors - 1 */
2158
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07002160 if( n_sectors >= 0xffffffffULL )
2161 tmp = 0xffffffff ; /* Return max count on overflow */
2162 else
2163 tmp = n_sectors ;
2164
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 /* sector count, 32-bit */
2166 rbuf[0] = tmp >> (8 * 3);
2167 rbuf[1] = tmp >> (8 * 2);
2168 rbuf[2] = tmp >> (8 * 1);
2169 rbuf[3] = tmp;
2170
2171 /* sector size */
2172 tmp = ATA_SECT_SIZE;
2173 rbuf[6] = tmp >> 8;
2174 rbuf[7] = tmp;
2175
2176 } else {
2177 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07002178 tmp = n_sectors >> (8 * 4);
2179 rbuf[2] = tmp >> (8 * 3);
2180 rbuf[3] = tmp >> (8 * 2);
2181 rbuf[4] = tmp >> (8 * 1);
2182 rbuf[5] = tmp;
2183 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 rbuf[6] = tmp >> (8 * 3);
2185 rbuf[7] = tmp >> (8 * 2);
2186 rbuf[8] = tmp >> (8 * 1);
2187 rbuf[9] = tmp;
2188
2189 /* sector size */
2190 tmp = ATA_SECT_SIZE;
2191 rbuf[12] = tmp >> 8;
2192 rbuf[13] = tmp;
2193 }
2194
2195 return 0;
2196}
2197
2198/**
2199 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2200 * @args: device IDENTIFY data / SCSI command of interest.
2201 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2202 * @buflen: Response buffer length.
2203 *
2204 * Simulate REPORT LUNS command.
2205 *
2206 * LOCKING:
2207 * spin_lock_irqsave(host_set lock)
2208 */
2209
2210unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2211 unsigned int buflen)
2212{
2213 VPRINTK("ENTER\n");
2214 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2215
2216 return 0;
2217}
2218
2219/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04002220 * ata_scsi_set_sense - Set SCSI sense data and status
2221 * @cmd: SCSI request to be handled
2222 * @sk: SCSI-defined sense key
2223 * @asc: SCSI-defined additional sense code
2224 * @ascq: SCSI-defined additional sense code qualifier
2225 *
2226 * Helper function that builds a valid fixed format, current
2227 * response code and the given sense key (sk), additional sense
2228 * code (asc) and additional sense code qualifier (ascq) with
2229 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2230 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2231 *
2232 * LOCKING:
2233 * Not required
2234 */
2235
2236void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2237{
2238 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2239
2240 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2241 cmd->sense_buffer[2] = sk;
2242 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2243 cmd->sense_buffer[12] = asc;
2244 cmd->sense_buffer[13] = ascq;
2245}
2246
2247/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 * ata_scsi_badcmd - End a SCSI request with an error
2249 * @cmd: SCSI request to be handled
2250 * @done: SCSI command completion function
2251 * @asc: SCSI-defined additional sense code
2252 * @ascq: SCSI-defined additional sense code qualifier
2253 *
2254 * Helper function that completes a SCSI command with
2255 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2256 * and the specified additional sense codes.
2257 *
2258 * LOCKING:
2259 * spin_lock_irqsave(host_set lock)
2260 */
2261
2262void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2263{
2264 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04002265 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266
2267 done(cmd);
2268}
2269
Tejun Heo77853bf2006-01-23 13:09:36 +09002270static void atapi_sense_complete(struct ata_queued_cmd *qc)
Jeff Garzika939c962005-10-05 17:09:16 -04002271{
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002272 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002273 /* FIXME: not quite right; we don't want the
2274 * translation of taskfile registers into
2275 * a sense descriptors, since that's only
2276 * correct for ATA, not ATAPI
2277 */
2278 ata_gen_ata_desc_sense(qc);
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002279 }
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002280
2281 qc->scsidone(qc->scsicmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002282 ata_qc_free(qc);
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002283}
2284
2285/* is it pointless to prefer PIO for "safety reasons"? */
2286static inline int ata_pio_use_silly(struct ata_port *ap)
2287{
2288 return (ap->flags & ATA_FLAG_PIO_DMA);
2289}
2290
2291static void atapi_request_sense(struct ata_queued_cmd *qc)
2292{
2293 struct ata_port *ap = qc->ap;
2294 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika939c962005-10-05 17:09:16 -04002295
2296 DPRINTK("ATAPI request sense\n");
2297
Jeff Garzika939c962005-10-05 17:09:16 -04002298 /* FIXME: is this needed? */
2299 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2300
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002301 ap->ops->tf_read(ap, &qc->tf);
2302
2303 /* fill these in, for the case where they are -not- overwritten */
2304 cmd->sense_buffer[0] = 0x70;
2305 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2306
2307 ata_qc_reinit(qc);
2308
Jeff Garzika939c962005-10-05 17:09:16 -04002309 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2310 qc->dma_dir = DMA_FROM_DEVICE;
2311
Tejun Heo6e7846e2006-02-12 23:32:58 +09002312 memset(&qc->cdb, 0, qc->dev->cdb_len);
Jeff Garzika939c962005-10-05 17:09:16 -04002313 qc->cdb[0] = REQUEST_SENSE;
2314 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2315
2316 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2317 qc->tf.command = ATA_CMD_PACKET;
2318
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002319 if (ata_pio_use_silly(ap)) {
2320 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2321 qc->tf.feature |= ATAPI_PKT_DMA;
2322 } else {
2323 qc->tf.protocol = ATA_PROT_ATAPI;
2324 qc->tf.lbam = (8 * 1024) & 0xff;
2325 qc->tf.lbah = (8 * 1024) >> 8;
2326 }
Jeff Garzika939c962005-10-05 17:09:16 -04002327 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2328
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002329 qc->complete_fn = atapi_sense_complete;
Jeff Garzika939c962005-10-05 17:09:16 -04002330
Tejun Heo8e0e6942006-03-31 20:41:11 +09002331 ata_qc_issue(qc);
Jeff Garzika939c962005-10-05 17:09:16 -04002332
2333 DPRINTK("EXIT\n");
2334}
2335
Tejun Heo77853bf2006-01-23 13:09:36 +09002336static void atapi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337{
2338 struct scsi_cmnd *cmd = qc->scsicmd;
Albert Leea22e2eb2005-12-05 15:38:02 +08002339 unsigned int err_mask = qc->err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340
Jeff Garzika7dac442005-10-30 04:44:42 -05002341 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002342
Tejun Heo246619d2006-05-15 20:58:16 +09002343 /* handle completion from new EH */
2344 if (unlikely(qc->ap->ops->error_handler &&
2345 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2346
2347 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2348 /* FIXME: not quite right; we don't want the
2349 * translation of taskfile registers into a
2350 * sense descriptors, since that's only
2351 * correct for ATA, not ATAPI
2352 */
2353 ata_gen_ata_desc_sense(qc);
2354 }
2355
2356 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2357 qc->scsidone(cmd);
2358 ata_qc_free(qc);
2359 return;
2360 }
2361
2362 /* successful completion or old EH failure path */
Jeff Garzika7dac442005-10-30 04:44:42 -05002363 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 cmd->result = SAM_STAT_CHECK_CONDITION;
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002365 atapi_request_sense(qc);
Tejun Heo77853bf2006-01-23 13:09:36 +09002366 return;
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002367 } else if (unlikely(err_mask)) {
Jeff Garzika7dac442005-10-30 04:44:42 -05002368 /* FIXME: not quite right; we don't want the
2369 * translation of taskfile registers into
2370 * a sense descriptors, since that's only
2371 * correct for ATA, not ATAPI
2372 */
2373 ata_gen_ata_desc_sense(qc);
Tejun Heo74e6c8c2006-04-02 18:51:53 +09002374 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 u8 *scsicmd = cmd->cmnd;
2376
Tony Battersbyfd71da42005-12-21 16:35:44 -05002377 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 u8 *buf = NULL;
2379 unsigned int buflen;
2380
2381 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002382
2383 /* ATAPI devices typically report zero for their SCSI version,
2384 * and sometimes deviate from the spec WRT response data
2385 * format. If SCSI version is reported as zero like normal,
2386 * then we make the following fixups: 1) Fake MMC-5 version,
2387 * to indicate to the Linux scsi midlayer this is a modern
2388 * device. 2) Ensure response data format / ATAPI information
2389 * are always correct.
2390 */
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002391 if (buf[2] == 0) {
2392 buf[2] = 0x5;
2393 buf[3] = 0x32;
2394 }
2395
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 ata_scsi_rbuf_put(cmd, buf);
2397 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002398
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 cmd->result = SAM_STAT_GOOD;
2400 }
2401
2402 qc->scsidone(cmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002403 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404}
2405/**
2406 * atapi_xlat - Initialize PACKET taskfile
2407 * @qc: command structure to be initialized
2408 * @scsicmd: SCSI CDB associated with this PACKET command
2409 *
2410 * LOCKING:
2411 * spin_lock_irqsave(host_set lock)
2412 *
2413 * RETURNS:
2414 * Zero on success, non-zero on failure.
2415 */
2416
Jeff Garzik057ace52005-10-22 14:27:05 -04002417static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418{
2419 struct scsi_cmnd *cmd = qc->scsicmd;
2420 struct ata_device *dev = qc->dev;
2421 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db052005-04-17 15:26:13 -05002422 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423
2424 if (!using_pio)
2425 /* Check whether ATAPI DMA is safe */
2426 if (ata_check_atapi_dma(qc))
2427 using_pio = 1;
2428
Tejun Heo6e7846e2006-02-12 23:32:58 +09002429 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430
2431 qc->complete_fn = atapi_qc_complete;
2432
2433 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db052005-04-17 15:26:13 -05002434 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 qc->tf.flags |= ATA_TFLAG_WRITE;
2436 DPRINTK("direction: write\n");
2437 }
2438
2439 qc->tf.command = ATA_CMD_PACKET;
2440
2441 /* no data, or PIO data xfer */
2442 if (using_pio || nodata) {
2443 if (nodata)
2444 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2445 else
2446 qc->tf.protocol = ATA_PROT_ATAPI;
2447 qc->tf.lbam = (8 * 1024) & 0xff;
2448 qc->tf.lbah = (8 * 1024) >> 8;
2449 }
2450
2451 /* DMA data xfer */
2452 else {
2453 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2454 qc->tf.feature |= ATAPI_PKT_DMA;
2455
Albert Lee95de7192006-04-04 10:57:18 +08002456 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2457 /* some SATA bridges need us to indicate data xfer direction */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458 qc->tf.feature |= ATAPI_DMADIR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 }
2460
Christoph Hellwig5d5ff442006-06-03 13:21:13 +02002461 qc->nbytes = cmd->request_bufflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462
2463 return 0;
2464}
2465
Tejun Heoab5b3a52006-05-31 18:27:34 +09002466static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2467{
2468 if (likely(id < ATA_MAX_DEVICES))
2469 return &ap->device[id];
2470 return NULL;
2471}
2472
2473static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2474 const struct scsi_device *scsidev)
2475{
2476 /* skip commands not addressed to targets we simulate */
2477 if (unlikely(scsidev->channel || scsidev->lun))
2478 return NULL;
2479
2480 return ata_find_dev(ap, scsidev->id);
2481}
2482
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483/**
Brian King99ba9e02006-06-12 14:54:17 -05002484 * ata_scsi_dev_enabled - determine if device is enabled
2485 * @dev: ATA device
2486 *
2487 * Determine if commands should be sent to the specified device.
2488 *
2489 * LOCKING:
2490 * spin_lock_irqsave(host_set lock)
2491 *
2492 * RETURNS:
2493 * 0 if commands are not allowed / 1 if commands are allowed
2494 */
2495
2496static int ata_scsi_dev_enabled(struct ata_device *dev)
2497{
2498 if (unlikely(!ata_dev_enabled(dev)))
2499 return 0;
2500
2501 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2502 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2503 ata_dev_printk(dev, KERN_WARNING,
2504 "WARNING: ATAPI is %s, device ignored.\n",
2505 atapi_enabled ? "not supported with this driver" : "disabled");
2506 return 0;
2507 }
2508 }
2509
2510 return 1;
2511}
2512
2513/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2515 * @ap: ATA port to which the device is attached
2516 * @scsidev: SCSI device from which we derive the ATA device
2517 *
2518 * Given various information provided in struct scsi_cmnd,
2519 * map that onto an ATA bus, and using that mapping
2520 * determine which ata_device is associated with the
2521 * SCSI command to be sent.
2522 *
2523 * LOCKING:
2524 * spin_lock_irqsave(host_set lock)
2525 *
2526 * RETURNS:
2527 * Associated ATA device, or %NULL if not found.
2528 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002530ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531{
Tejun Heoab5b3a52006-05-31 18:27:34 +09002532 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533
Brian King99ba9e02006-06-12 14:54:17 -05002534 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 return NULL;
2536
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 return dev;
2538}
2539
Jeff Garzikb0955182005-05-12 15:45:22 -04002540/*
2541 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2542 * @byte1: Byte 1 from pass-thru CDB.
2543 *
2544 * RETURNS:
2545 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2546 */
2547static u8
2548ata_scsi_map_proto(u8 byte1)
2549{
2550 switch((byte1 & 0x1e) >> 1) {
2551 case 3: /* Non-data */
2552 return ATA_PROT_NODATA;
2553
2554 case 6: /* DMA */
2555 return ATA_PROT_DMA;
2556
2557 case 4: /* PIO Data-in */
2558 case 5: /* PIO Data-out */
Jeff Garzikb0955182005-05-12 15:45:22 -04002559 return ATA_PROT_PIO;
2560
2561 case 10: /* Device Reset */
2562 case 0: /* Hard Reset */
2563 case 1: /* SRST */
2564 case 2: /* Bus Idle */
2565 case 7: /* Packet */
2566 case 8: /* DMA Queued */
2567 case 9: /* Device Diagnostic */
2568 case 11: /* UDMA Data-in */
2569 case 12: /* UDMA Data-Out */
2570 case 13: /* FPDMA */
2571 default: /* Reserved */
2572 break;
2573 }
2574
2575 return ATA_PROT_UNKNOWN;
2576}
2577
2578/**
2579 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2580 * @qc: command structure to be initialized
Randy Dunlap8e8b77d2005-11-01 21:29:27 -08002581 * @scsicmd: SCSI command to convert
Jeff Garzikb0955182005-05-12 15:45:22 -04002582 *
2583 * Handles either 12 or 16-byte versions of the CDB.
2584 *
2585 * RETURNS:
2586 * Zero on success, non-zero on failure.
2587 */
2588static unsigned int
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002589ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
Jeff Garzikb0955182005-05-12 15:45:22 -04002590{
2591 struct ata_taskfile *tf = &(qc->tf);
2592 struct scsi_cmnd *cmd = qc->scsicmd;
Alan Coxf79d4092006-05-22 16:55:11 +01002593 struct ata_device *dev = qc->dev;
Jeff Garzikb0955182005-05-12 15:45:22 -04002594
2595 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
Tejun Heo9a405252005-12-02 11:49:11 +09002596 goto invalid_fld;
Jeff Garzik8190bdb2006-05-24 01:53:39 -04002597
Alan Coxf79d4092006-05-22 16:55:11 +01002598 /* We may not issue DMA commands if no DMA mode is set */
2599 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2600 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002601
Albert Leef59b0cf2006-03-16 17:59:22 +08002602 if (scsicmd[1] & 0xe0)
2603 /* PIO multi not supported yet */
2604 goto invalid_fld;
2605
Jeff Garzikb0955182005-05-12 15:45:22 -04002606 /*
2607 * 12 and 16 byte CDBs use different offsets to
2608 * provide the various register values.
2609 */
2610 if (scsicmd[0] == ATA_16) {
2611 /*
2612 * 16-byte CDB - may contain extended commands.
2613 *
2614 * If that is the case, copy the upper byte register values.
2615 */
2616 if (scsicmd[1] & 0x01) {
2617 tf->hob_feature = scsicmd[3];
2618 tf->hob_nsect = scsicmd[5];
2619 tf->hob_lbal = scsicmd[7];
2620 tf->hob_lbam = scsicmd[9];
2621 tf->hob_lbah = scsicmd[11];
2622 tf->flags |= ATA_TFLAG_LBA48;
2623 } else
2624 tf->flags &= ~ATA_TFLAG_LBA48;
2625
2626 /*
2627 * Always copy low byte, device and command registers.
2628 */
2629 tf->feature = scsicmd[4];
2630 tf->nsect = scsicmd[6];
2631 tf->lbal = scsicmd[8];
2632 tf->lbam = scsicmd[10];
2633 tf->lbah = scsicmd[12];
2634 tf->device = scsicmd[13];
2635 tf->command = scsicmd[14];
2636 } else {
2637 /*
2638 * 12-byte CDB - incapable of extended commands.
2639 */
2640 tf->flags &= ~ATA_TFLAG_LBA48;
2641
2642 tf->feature = scsicmd[3];
2643 tf->nsect = scsicmd[4];
2644 tf->lbal = scsicmd[5];
2645 tf->lbam = scsicmd[6];
2646 tf->lbah = scsicmd[7];
2647 tf->device = scsicmd[8];
2648 tf->command = scsicmd[9];
2649 }
Mark Lorddcc2d1e2005-11-13 16:22:06 -05002650 /*
2651 * If slave is possible, enforce correct master/slave bit
2652 */
2653 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2654 tf->device = qc->dev->devno ?
2655 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002656
2657 /*
2658 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2659 * SET_FEATURES - XFER MODE must be preceded/succeeded
2660 * by an update to hardware-specific registers for each
2661 * controller (i.e. the reason for ->set_piomode(),
2662 * ->set_dmamode(), and ->post_set_mode() hooks).
2663 */
2664 if ((tf->command == ATA_CMD_SET_FEATURES)
2665 && (tf->feature == SETFEATURES_XFER))
Tejun Heo9a405252005-12-02 11:49:11 +09002666 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002667
2668 /*
2669 * Set flags so that all registers will be written,
2670 * and pass on write indication (used for PIO/DMA
2671 * setup.)
2672 */
2673 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2674
Jeff Garzik0274aa22005-06-22 13:50:56 -04002675 if (cmd->sc_data_direction == DMA_TO_DEVICE)
Jeff Garzikb0955182005-05-12 15:45:22 -04002676 tf->flags |= ATA_TFLAG_WRITE;
2677
2678 /*
2679 * Set transfer length.
2680 *
2681 * TODO: find out if we need to do more here to
2682 * cover scatter/gather case.
2683 */
Christoph Hellwig5d5ff442006-06-03 13:21:13 +02002684 qc->nsect = cmd->request_bufflen / ATA_SECT_SIZE;
Jeff Garzikb0955182005-05-12 15:45:22 -04002685
Tejun Heoe61e0672006-05-15 20:57:40 +09002686 /* request result TF */
2687 qc->flags |= ATA_QCFLAG_RESULT_TF;
2688
Jeff Garzikb0955182005-05-12 15:45:22 -04002689 return 0;
Tejun Heo9a405252005-12-02 11:49:11 +09002690
2691 invalid_fld:
2692 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2693 /* "Invalid field in cdb" */
2694 return 1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002695}
2696
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697/**
2698 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2699 * @dev: ATA device
2700 * @cmd: SCSI command opcode to consider
2701 *
2702 * Look up the SCSI command given, and determine whether the
2703 * SCSI command is to be translated or simulated.
2704 *
2705 * RETURNS:
2706 * Pointer to translation function if possible, %NULL if not.
2707 */
2708
2709static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2710{
2711 switch (cmd) {
2712 case READ_6:
2713 case READ_10:
2714 case READ_16:
2715
2716 case WRITE_6:
2717 case WRITE_10:
2718 case WRITE_16:
2719 return ata_scsi_rw_xlat;
2720
2721 case SYNCHRONIZE_CACHE:
2722 if (ata_try_flush_cache(dev))
2723 return ata_scsi_flush_xlat;
2724 break;
2725
2726 case VERIFY:
2727 case VERIFY_16:
2728 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04002729
2730 case ATA_12:
2731 case ATA_16:
2732 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04002733
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04002734 case START_STOP:
2735 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736 }
2737
2738 return NULL;
2739}
2740
2741/**
2742 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2743 * @ap: ATA port to which the command was being sent
2744 * @cmd: SCSI command to dump
2745 *
2746 * Prints the contents of a SCSI command via printk().
2747 */
2748
2749static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2750 struct scsi_cmnd *cmd)
2751{
2752#ifdef ATA_DEBUG
2753 struct scsi_device *scsidev = cmd->device;
2754 u8 *scsicmd = cmd->cmnd;
2755
2756 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2757 ap->id,
2758 scsidev->channel, scsidev->id, scsidev->lun,
2759 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2760 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2761 scsicmd[8]);
2762#endif
2763}
2764
Tejun Heo2115ea92006-05-15 21:03:39 +09002765static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2766 void (*done)(struct scsi_cmnd *),
2767 struct ata_device *dev)
Brian Kingeb3f0f92006-03-23 17:30:02 -06002768{
Tejun Heo2115ea92006-05-15 21:03:39 +09002769 int rc = 0;
2770
Brian Kingeb3f0f92006-03-23 17:30:02 -06002771 if (dev->class == ATA_DEV_ATA) {
2772 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2773 cmd->cmnd[0]);
2774
2775 if (xlat_func)
Tejun Heo2115ea92006-05-15 21:03:39 +09002776 rc = ata_scsi_translate(dev, cmd, done, xlat_func);
Brian Kingeb3f0f92006-03-23 17:30:02 -06002777 else
Tejun Heo3373efd2006-05-15 20:57:53 +09002778 ata_scsi_simulate(dev, cmd, done);
Brian Kingeb3f0f92006-03-23 17:30:02 -06002779 } else
Tejun Heo2115ea92006-05-15 21:03:39 +09002780 rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);
2781
2782 return rc;
Brian Kingeb3f0f92006-03-23 17:30:02 -06002783}
2784
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785/**
2786 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2787 * @cmd: SCSI command to be sent
2788 * @done: Completion function, called when command is complete
2789 *
2790 * In some cases, this function translates SCSI commands into
2791 * ATA taskfiles, and queues the taskfiles to be sent to
2792 * hardware. In other cases, this function simulates a
2793 * SCSI device by evaluating and responding to certain
2794 * SCSI commands. This creates the overall effect of
2795 * ATA and ATAPI devices appearing as SCSI devices.
2796 *
2797 * LOCKING:
2798 * Releases scsi-layer-held lock, and obtains host_set lock.
2799 *
2800 * RETURNS:
Tejun Heo2115ea92006-05-15 21:03:39 +09002801 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2802 * 0 otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2805{
2806 struct ata_port *ap;
2807 struct ata_device *dev;
2808 struct scsi_device *scsidev = cmd->device;
Jeff Garzik005a5a02005-10-30 23:31:48 -05002809 struct Scsi_Host *shost = scsidev->host;
Tejun Heo2115ea92006-05-15 21:03:39 +09002810 int rc = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811
Jeff Garzik35bb94b2006-04-11 13:12:34 -04002812 ap = ata_shost_to_port(shost);
Jeff Garzik005a5a02005-10-30 23:31:48 -05002813
2814 spin_unlock(shost->host_lock);
Jeff Garzikba6a1302006-06-22 23:46:10 -04002815 spin_lock(ap->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816
2817 ata_scsi_dump_cdb(ap, cmd);
2818
2819 dev = ata_scsi_find_dev(ap, scsidev);
Brian Kingeb3f0f92006-03-23 17:30:02 -06002820 if (likely(dev))
Tejun Heo2115ea92006-05-15 21:03:39 +09002821 rc = __ata_scsi_queuecmd(cmd, done, dev);
Brian Kingeb3f0f92006-03-23 17:30:02 -06002822 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823 cmd->result = (DID_BAD_TARGET << 16);
2824 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825 }
2826
Jeff Garzikba6a1302006-06-22 23:46:10 -04002827 spin_unlock(ap->lock);
Jeff Garzik005a5a02005-10-30 23:31:48 -05002828 spin_lock(shost->host_lock);
Tejun Heo2115ea92006-05-15 21:03:39 +09002829 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830}
2831
2832/**
2833 * ata_scsi_simulate - simulate SCSI command on ATA device
Randy Dunlapc893a3a2006-01-28 13:15:32 -05002834 * @dev: the target device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835 * @cmd: SCSI command being sent to device.
2836 * @done: SCSI command completion function.
2837 *
2838 * Interprets and directly executes a select list of SCSI commands
2839 * that can be handled internally.
2840 *
2841 * LOCKING:
2842 * spin_lock_irqsave(host_set lock)
2843 */
2844
Tejun Heo3373efd2006-05-15 20:57:53 +09002845void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002846 void (*done)(struct scsi_cmnd *))
2847{
2848 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04002849 const u8 *scsicmd = cmd->cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002851 args.dev = dev;
2852 args.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 args.cmd = cmd;
2854 args.done = done;
2855
2856 switch(scsicmd[0]) {
2857 /* no-op's, complete with success */
2858 case SYNCHRONIZE_CACHE:
2859 case REZERO_UNIT:
2860 case SEEK_6:
2861 case SEEK_10:
2862 case TEST_UNIT_READY:
2863 case FORMAT_UNIT: /* FIXME: correct? */
2864 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2865 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2866 break;
2867
2868 case INQUIRY:
2869 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04002870 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2872 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2873 else if (scsicmd[2] == 0x00)
2874 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2875 else if (scsicmd[2] == 0x80)
2876 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2877 else if (scsicmd[2] == 0x83)
2878 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2879 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002880 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 break;
2882
2883 case MODE_SENSE:
2884 case MODE_SENSE_10:
2885 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2886 break;
2887
2888 case MODE_SELECT: /* unconditionally return */
2889 case MODE_SELECT_10: /* bad-field-in-cdb */
Douglas Gilbertae006512005-10-09 09:09:35 -04002890 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891 break;
2892
2893 case READ_CAPACITY:
2894 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2895 break;
2896
2897 case SERVICE_ACTION_IN:
2898 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2899 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2900 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002901 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902 break;
2903
2904 case REPORT_LUNS:
2905 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2906 break;
2907
Jeff Garzikb0955182005-05-12 15:45:22 -04002908 /* mandatory commands we haven't implemented yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002909 case REQUEST_SENSE:
2910
2911 /* all other commands */
2912 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04002913 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2914 /* "Invalid command operation code" */
2915 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916 break;
2917 }
2918}
2919
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002920void ata_scsi_scan_host(struct ata_port *ap)
2921{
2922 unsigned int i;
2923
Tejun Heo198e0fe2006-04-02 18:51:52 +09002924 if (ap->flags & ATA_FLAG_DISABLED)
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002925 return;
2926
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002927 for (i = 0; i < ATA_MAX_DEVICES; i++) {
Tejun Heo3edebac2006-05-31 18:27:40 +09002928 struct ata_device *dev = &ap->device[i];
2929 struct scsi_device *sdev;
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002930
Tejun Heo3edebac2006-05-31 18:27:40 +09002931 if (!ata_dev_enabled(dev) || dev->sdev)
2932 continue;
2933
2934 sdev = __scsi_add_device(ap->host, 0, i, 0, NULL);
2935 if (!IS_ERR(sdev)) {
2936 dev->sdev = sdev;
2937 scsi_device_put(sdev);
2938 }
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002939 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002940}
Tejun Heo0ea035a2006-05-31 18:28:01 +09002941
2942/**
2943 * ata_scsi_offline_dev - offline attached SCSI device
2944 * @dev: ATA device to offline attached SCSI device for
2945 *
2946 * This function is called from ata_eh_hotplug() and responsible
2947 * for taking the SCSI device attached to @dev offline. This
2948 * function is called with host_set lock which protects dev->sdev
2949 * against clearing.
2950 *
2951 * LOCKING:
2952 * spin_lock_irqsave(host_set lock)
2953 *
2954 * RETURNS:
2955 * 1 if attached SCSI device exists, 0 otherwise.
2956 */
2957int ata_scsi_offline_dev(struct ata_device *dev)
2958{
2959 if (dev->sdev) {
2960 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2961 return 1;
2962 }
2963 return 0;
2964}
Tejun Heo580b21022006-05-31 18:28:05 +09002965
2966/**
2967 * ata_scsi_remove_dev - remove attached SCSI device
2968 * @dev: ATA device to remove attached SCSI device for
2969 *
2970 * This function is called from ata_eh_scsi_hotplug() and
2971 * responsible for removing the SCSI device attached to @dev.
2972 *
2973 * LOCKING:
2974 * Kernel thread context (may sleep).
2975 */
2976static void ata_scsi_remove_dev(struct ata_device *dev)
2977{
2978 struct ata_port *ap = dev->ap;
2979 struct scsi_device *sdev;
2980 unsigned long flags;
2981
2982 /* Alas, we need to grab scan_mutex to ensure SCSI device
2983 * state doesn't change underneath us and thus
2984 * scsi_device_get() always succeeds. The mutex locking can
2985 * be removed if there is __scsi_device_get() interface which
2986 * increments reference counts regardless of device state.
2987 */
2988 mutex_lock(&ap->host->scan_mutex);
Jeff Garzikba6a1302006-06-22 23:46:10 -04002989 spin_lock_irqsave(ap->lock, flags);
Tejun Heo580b21022006-05-31 18:28:05 +09002990
2991 /* clearing dev->sdev is protected by host_set lock */
2992 sdev = dev->sdev;
2993 dev->sdev = NULL;
2994
2995 if (sdev) {
2996 /* If user initiated unplug races with us, sdev can go
2997 * away underneath us after the host_set lock and
2998 * scan_mutex are released. Hold onto it.
2999 */
3000 if (scsi_device_get(sdev) == 0) {
3001 /* The following ensures the attached sdev is
3002 * offline on return from ata_scsi_offline_dev()
3003 * regardless it wins or loses the race
3004 * against this function.
3005 */
3006 scsi_device_set_state(sdev, SDEV_OFFLINE);
3007 } else {
3008 WARN_ON(1);
3009 sdev = NULL;
3010 }
3011 }
3012
Jeff Garzikba6a1302006-06-22 23:46:10 -04003013 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo580b21022006-05-31 18:28:05 +09003014 mutex_unlock(&ap->host->scan_mutex);
3015
3016 if (sdev) {
3017 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3018 sdev->sdev_gendev.bus_id);
3019
3020 scsi_remove_device(sdev);
3021 scsi_device_put(sdev);
3022 }
3023}
3024
3025/**
3026 * ata_scsi_hotplug - SCSI part of hotplug
3027 * @data: Pointer to ATA port to perform SCSI hotplug on
3028 *
3029 * Perform SCSI part of hotplug. It's executed from a separate
3030 * workqueue after EH completes. This is necessary because SCSI
3031 * hot plugging requires working EH and hot unplugging is
3032 * synchronized with hot plugging with a mutex.
3033 *
3034 * LOCKING:
3035 * Kernel thread context (may sleep).
3036 */
3037void ata_scsi_hotplug(void *data)
3038{
3039 struct ata_port *ap = data;
3040 int i;
3041
Tejun Heob51e9e52006-06-29 01:29:30 +09003042 if (ap->pflags & ATA_PFLAG_UNLOADING) {
Tejun Heo580b21022006-05-31 18:28:05 +09003043 DPRINTK("ENTER/EXIT - unloading\n");
3044 return;
3045 }
3046
3047 DPRINTK("ENTER\n");
3048
3049 /* unplug detached devices */
3050 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3051 struct ata_device *dev = &ap->device[i];
3052 unsigned long flags;
3053
3054 if (!(dev->flags & ATA_DFLAG_DETACHED))
3055 continue;
3056
Jeff Garzikba6a1302006-06-22 23:46:10 -04003057 spin_lock_irqsave(ap->lock, flags);
Tejun Heo580b21022006-05-31 18:28:05 +09003058 dev->flags &= ~ATA_DFLAG_DETACHED;
Jeff Garzikba6a1302006-06-22 23:46:10 -04003059 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo580b21022006-05-31 18:28:05 +09003060
3061 ata_scsi_remove_dev(dev);
3062 }
3063
3064 /* scan for new ones */
3065 ata_scsi_scan_host(ap);
3066
3067 /* If we scanned while EH was in progress, scan would have
3068 * failed silently. Requeue if there are enabled but
3069 * unattached devices.
3070 */
3071 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3072 struct ata_device *dev = &ap->device[i];
3073 if (ata_dev_enabled(dev) && !dev->sdev) {
3074 queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
3075 break;
3076 }
3077 }
3078
3079 DPRINTK("EXIT\n");
3080}
Tejun Heo83c47bc2006-05-31 18:28:07 +09003081
3082/**
3083 * ata_scsi_user_scan - indication for user-initiated bus scan
3084 * @shost: SCSI host to scan
3085 * @channel: Channel to scan
3086 * @id: ID to scan
3087 * @lun: LUN to scan
3088 *
3089 * This function is called when user explicitly requests bus
3090 * scan. Set probe pending flag and invoke EH.
3091 *
3092 * LOCKING:
3093 * SCSI layer (we don't care)
3094 *
3095 * RETURNS:
3096 * Zero.
3097 */
3098static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3099 unsigned int id, unsigned int lun)
3100{
3101 struct ata_port *ap = ata_shost_to_port(shost);
3102 unsigned long flags;
3103 int rc = 0;
3104
3105 if (!ap->ops->error_handler)
3106 return -EOPNOTSUPP;
3107
3108 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3109 (lun != SCAN_WILD_CARD && lun != 0))
3110 return -EINVAL;
3111
Jeff Garzikba6a1302006-06-22 23:46:10 -04003112 spin_lock_irqsave(ap->lock, flags);
Tejun Heo83c47bc2006-05-31 18:28:07 +09003113
3114 if (id == SCAN_WILD_CARD) {
3115 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3116 ap->eh_info.action |= ATA_EH_SOFTRESET;
3117 } else {
3118 struct ata_device *dev = ata_find_dev(ap, id);
3119
3120 if (dev) {
3121 ap->eh_info.probe_mask |= 1 << dev->devno;
3122 ap->eh_info.action |= ATA_EH_SOFTRESET;
Tejun Heo28324302006-07-03 16:07:26 +09003123 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
Tejun Heo83c47bc2006-05-31 18:28:07 +09003124 } else
3125 rc = -EINVAL;
3126 }
3127
3128 if (rc == 0)
3129 ata_port_schedule_eh(ap);
3130
Jeff Garzikba6a1302006-06-22 23:46:10 -04003131 spin_unlock_irqrestore(ap->lock, flags);
Tejun Heo83c47bc2006-05-31 18:28:07 +09003132
3133 return rc;
3134}
zhao, forrest3057ac32006-06-12 12:01:34 +08003135
3136/**
Tejun Heod0171262006-06-12 22:51:14 +09003137 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3138 * @data: Pointer to ATA port to perform scsi_rescan_device()
zhao, forrest3057ac32006-06-12 12:01:34 +08003139 *
Tejun Heod0171262006-06-12 22:51:14 +09003140 * After ATA pass thru (SAT) commands are executed successfully,
3141 * libata need to propagate the changes to SCSI layer. This
3142 * function must be executed from ata_aux_wq such that sdev
3143 * attach/detach don't race with rescan.
zhao, forrest3057ac32006-06-12 12:01:34 +08003144 *
Tejun Heod0171262006-06-12 22:51:14 +09003145 * LOCKING:
3146 * Kernel thread context (may sleep).
zhao, forrest3057ac32006-06-12 12:01:34 +08003147 */
3148void ata_scsi_dev_rescan(void *data)
3149{
3150 struct ata_port *ap = data;
3151 struct ata_device *dev;
3152 unsigned int i;
3153
3154 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3155 dev = &ap->device[i];
3156
Tejun Heod0171262006-06-12 22:51:14 +09003157 if (ata_dev_enabled(dev) && dev->sdev)
zhao, forrest3057ac32006-06-12 12:01:34 +08003158 scsi_rescan_device(&(dev->sdev->sdev_gendev));
3159 }
3160}