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