[libata] Move some PCI IDs from sata_nv to ahci
[GitHub/mt8127/android_kernel_alcatel_ttab.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
057ace5e 54typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
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
LT
374 qc->n_elem = cmd->use_sg;
375 } else {
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
938 * @scsicmd: SCSI command to translate
939 *
940 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
941 * (to start). Perhaps these commands should be preceded by
942 * CHECK POWER MODE to see what power mode the device is already in.
943 * [See SAT revision 5 at www.t10.org]
944 *
945 * LOCKING:
cca3974e 946 * spin_lock_irqsave(host lock)
972dcafb
DG
947 *
948 * RETURNS:
949 * Zero on success, non-zero on error.
950 */
951
952static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
057ace5e 953 const u8 *scsicmd)
972dcafb
DG
954{
955 struct ata_taskfile *tf = &qc->tf;
956
957 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
958 tf->protocol = ATA_PROT_NODATA;
959 if (scsicmd[1] & 0x1) {
960 ; /* ignore IMMED bit, violates sat-r05 */
961 }
962 if (scsicmd[4] & 0x2)
ae006510 963 goto invalid_fld; /* LOEJ bit set not supported */
972dcafb 964 if (((scsicmd[4] >> 4) & 0xf) != 0)
ae006510 965 goto invalid_fld; /* power conditions not supported */
972dcafb
DG
966 if (scsicmd[4] & 0x1) {
967 tf->nsect = 1; /* 1 sector, lba=0 */
9d5b1302
AL
968
969 if (qc->dev->flags & ATA_DFLAG_LBA) {
c44078c0 970 tf->flags |= ATA_TFLAG_LBA;
9d5b1302
AL
971
972 tf->lbah = 0x0;
973 tf->lbam = 0x0;
974 tf->lbal = 0x0;
975 tf->device |= ATA_LBA;
976 } else {
977 /* CHS */
978 tf->lbal = 0x1; /* sect */
979 tf->lbam = 0x0; /* cyl low */
980 tf->lbah = 0x0; /* cyl high */
981 }
982
972dcafb
DG
983 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
984 } else {
985 tf->nsect = 0; /* time period value (0 implies now) */
986 tf->command = ATA_CMD_STANDBY;
987 /* Consider: ATA STANDBY IMMEDIATE command */
988 }
989 /*
990 * Standby and Idle condition timers could be implemented but that
991 * would require libata to implement the Power condition mode page
992 * and allow the user to change it. Changing mode pages requires
993 * MODE SELECT to be implemented.
994 */
995
996 return 0;
ae006510
DG
997
998invalid_fld:
999 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1000 /* "Invalid field in cbd" */
1001 return 1;
972dcafb
DG
1002}
1003
1004
1da177e4
LT
1005/**
1006 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1007 * @qc: Storage for translated ATA taskfile
1008 * @scsicmd: SCSI command to translate (ignored)
1009 *
1010 * Sets up an ATA taskfile to issue FLUSH CACHE or
1011 * FLUSH CACHE EXT.
1012 *
1013 * LOCKING:
cca3974e 1014 * spin_lock_irqsave(host lock)
1da177e4
LT
1015 *
1016 * RETURNS:
1017 * Zero on success, non-zero on error.
1018 */
1019
057ace5e 1020static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
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
1037 * @scsicmd: SCSI command to translate
1038 *
1039 * Calculate LBA and transfer length for 6-byte commands.
1040 *
1041 * RETURNS:
1042 * @plba: the LBA
1043 * @plen: the transfer length
1044 */
1045
057ace5e 1046static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
1047{
1048 u64 lba = 0;
1049 u32 len = 0;
1050
1051 VPRINTK("six-byte command\n");
1052
1053 lba |= ((u64)scsicmd[2]) << 8;
1054 lba |= ((u64)scsicmd[3]);
1055
1056 len |= ((u32)scsicmd[4]);
1057
1058 *plba = lba;
1059 *plen = len;
1060}
1061
1062/**
1063 * scsi_10_lba_len - Get LBA and transfer length
1064 * @scsicmd: SCSI command to translate
1065 *
1066 * Calculate LBA and transfer length for 10-byte commands.
1067 *
1068 * RETURNS:
1069 * @plba: the LBA
1070 * @plen: the transfer length
1071 */
1072
057ace5e 1073static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
1074{
1075 u64 lba = 0;
1076 u32 len = 0;
1077
1078 VPRINTK("ten-byte command\n");
1079
1080 lba |= ((u64)scsicmd[2]) << 24;
1081 lba |= ((u64)scsicmd[3]) << 16;
1082 lba |= ((u64)scsicmd[4]) << 8;
1083 lba |= ((u64)scsicmd[5]);
1084
1085 len |= ((u32)scsicmd[7]) << 8;
1086 len |= ((u32)scsicmd[8]);
1087
1088 *plba = lba;
1089 *plen = len;
1090}
1091
1092/**
1093 * scsi_16_lba_len - Get LBA and transfer length
1094 * @scsicmd: SCSI command to translate
1095 *
1096 * Calculate LBA and transfer length for 16-byte commands.
1097 *
1098 * RETURNS:
1099 * @plba: the LBA
1100 * @plen: the transfer length
1101 */
1102
057ace5e 1103static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
1104{
1105 u64 lba = 0;
1106 u32 len = 0;
1107
1108 VPRINTK("sixteen-byte command\n");
1109
1110 lba |= ((u64)scsicmd[2]) << 56;
1111 lba |= ((u64)scsicmd[3]) << 48;
1112 lba |= ((u64)scsicmd[4]) << 40;
1113 lba |= ((u64)scsicmd[5]) << 32;
1114 lba |= ((u64)scsicmd[6]) << 24;
1115 lba |= ((u64)scsicmd[7]) << 16;
1116 lba |= ((u64)scsicmd[8]) << 8;
1117 lba |= ((u64)scsicmd[9]);
1118
1119 len |= ((u32)scsicmd[10]) << 24;
1120 len |= ((u32)scsicmd[11]) << 16;
1121 len |= ((u32)scsicmd[12]) << 8;
1122 len |= ((u32)scsicmd[13]);
1123
1124 *plba = lba;
1125 *plen = len;
1126}
1127
1da177e4
LT
1128/**
1129 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1130 * @qc: Storage for translated ATA taskfile
1131 * @scsicmd: SCSI command to translate
1132 *
1133 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1134 *
1135 * LOCKING:
cca3974e 1136 * spin_lock_irqsave(host lock)
1da177e4
LT
1137 *
1138 * RETURNS:
1139 * Zero on success, non-zero on error.
1140 */
1141
057ace5e 1142static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
1143{
1144 struct ata_taskfile *tf = &qc->tf;
8bf62ece 1145 struct ata_device *dev = qc->dev;
1da177e4 1146 u64 dev_sectors = qc->dev->n_sectors;
3aef5231
AL
1147 u64 block;
1148 u32 n_block;
1da177e4
LT
1149
1150 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1151 tf->protocol = ATA_PROT_NODATA;
1da177e4 1152
3aef5231
AL
1153 if (scsicmd[0] == VERIFY)
1154 scsi_10_lba_len(scsicmd, &block, &n_block);
1155 else if (scsicmd[0] == VERIFY_16)
1156 scsi_16_lba_len(scsicmd, &block, &n_block);
1da177e4 1157 else
ae006510 1158 goto invalid_fld;
1da177e4 1159
8bf62ece 1160 if (!n_block)
ae006510 1161 goto nothing_to_do;
8bf62ece 1162 if (block >= dev_sectors)
ae006510 1163 goto out_of_range;
8bf62ece 1164 if ((block + n_block) > dev_sectors)
ae006510 1165 goto out_of_range;
1da177e4 1166
07506697
AL
1167 if (dev->flags & ATA_DFLAG_LBA) {
1168 tf->flags |= ATA_TFLAG_LBA;
1169
c6a33e24
AL
1170 if (lba_28_ok(block, n_block)) {
1171 /* use LBA28 */
1172 tf->command = ATA_CMD_VERIFY;
1173 tf->device |= (block >> 24) & 0xf;
1174 } else if (lba_48_ok(block, n_block)) {
1175 if (!(dev->flags & ATA_DFLAG_LBA48))
1176 goto out_of_range;
07506697
AL
1177
1178 /* use LBA48 */
1179 tf->flags |= ATA_TFLAG_LBA48;
8bf62ece 1180 tf->command = ATA_CMD_VERIFY_EXT;
1da177e4 1181
8bf62ece 1182 tf->hob_nsect = (n_block >> 8) & 0xff;
1da177e4 1183
8bf62ece
AL
1184 tf->hob_lbah = (block >> 40) & 0xff;
1185 tf->hob_lbam = (block >> 32) & 0xff;
1186 tf->hob_lbal = (block >> 24) & 0xff;
c6a33e24
AL
1187 } else
1188 /* request too large even for LBA48 */
1189 goto out_of_range;
8bf62ece
AL
1190
1191 tf->nsect = n_block & 0xff;
1da177e4 1192
8bf62ece
AL
1193 tf->lbah = (block >> 16) & 0xff;
1194 tf->lbam = (block >> 8) & 0xff;
1195 tf->lbal = block & 0xff;
1da177e4 1196
8bf62ece
AL
1197 tf->device |= ATA_LBA;
1198 } else {
1199 /* CHS */
1200 u32 sect, head, cyl, track;
1201
c6a33e24
AL
1202 if (!lba_28_ok(block, n_block))
1203 goto out_of_range;
07506697 1204
8bf62ece
AL
1205 /* Convert LBA to CHS */
1206 track = (u32)block / dev->sectors;
1207 cyl = track / dev->heads;
1208 head = track % dev->heads;
1209 sect = (u32)block % dev->sectors + 1;
1210
c187c4b5
AL
1211 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1212 (u32)block, track, cyl, head, sect);
2e9edbf8
JG
1213
1214 /* Check whether the converted CHS can fit.
1215 Cylinder: 0-65535
8bf62ece
AL
1216 Head: 0-15
1217 Sector: 1-255*/
2e9edbf8 1218 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
ae006510 1219 goto out_of_range;
2e9edbf8 1220
8bf62ece
AL
1221 tf->command = ATA_CMD_VERIFY;
1222 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1223 tf->lbal = sect;
1224 tf->lbam = cyl;
1225 tf->lbah = cyl >> 8;
1226 tf->device |= head;
1227 }
1da177e4
LT
1228
1229 return 0;
ae006510
DG
1230
1231invalid_fld:
1232 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1233 /* "Invalid field in cbd" */
1234 return 1;
1235
1236out_of_range:
1237 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1238 /* "Logical Block Address out of range" */
1239 return 1;
1240
1241nothing_to_do:
1242 qc->scsicmd->result = SAM_STAT_GOOD;
1243 return 1;
1da177e4
LT
1244}
1245
1246/**
1247 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1248 * @qc: Storage for translated ATA taskfile
1249 * @scsicmd: SCSI command to translate
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 */
1265
057ace5e 1266static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4 1267{
bd056d7e 1268 unsigned int tf_flags = 0;
3aef5231
AL
1269 u64 block;
1270 u32 n_block;
bd056d7e 1271 int rc;
1da177e4 1272
8cbd6df1
AL
1273 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1274 scsicmd[0] == WRITE_16)
bd056d7e 1275 tf_flags |= ATA_TFLAG_WRITE;
1da177e4 1276
9a3dccc4 1277 /* Calculate the SCSI LBA, transfer length and FUA. */
3aef5231
AL
1278 switch (scsicmd[0]) {
1279 case READ_10:
1280 case WRITE_10:
1281 scsi_10_lba_len(scsicmd, &block, &n_block);
9a3dccc4 1282 if (unlikely(scsicmd[1] & (1 << 3)))
bd056d7e 1283 tf_flags |= ATA_TFLAG_FUA;
3aef5231
AL
1284 break;
1285 case READ_6:
1286 case WRITE_6:
1287 scsi_6_lba_len(scsicmd, &block, &n_block);
c187c4b5
AL
1288
1289 /* for 6-byte r/w commands, transfer length 0
1290 * means 256 blocks of data, not 0 block.
1291 */
76b2bf9b
JG
1292 if (!n_block)
1293 n_block = 256;
3aef5231
AL
1294 break;
1295 case READ_16:
1296 case WRITE_16:
1297 scsi_16_lba_len(scsicmd, &block, &n_block);
9a3dccc4 1298 if (unlikely(scsicmd[1] & (1 << 3)))
bd056d7e 1299 tf_flags |= ATA_TFLAG_FUA;
3aef5231
AL
1300 break;
1301 default:
8bf62ece 1302 DPRINTK("no-byte command\n");
ae006510 1303 goto invalid_fld;
1da177e4
LT
1304 }
1305
8bf62ece
AL
1306 /* Check and compose ATA command */
1307 if (!n_block)
c187c4b5
AL
1308 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1309 * length 0 means transfer 0 block of data.
1310 * However, for ATA R/W commands, sector count 0 means
1311 * 256 or 65536 sectors, not 0 sectors as in SCSI.
f51750d5
AC
1312 *
1313 * WARNING: one or two older ATA drives treat 0 as 0...
c187c4b5 1314 */
ae006510 1315 goto nothing_to_do;
1da177e4 1316
bd056d7e
TH
1317 qc->flags |= ATA_QCFLAG_IO;
1318 qc->nsect = n_block;
1da177e4 1319
bd056d7e
TH
1320 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1321 qc->tag);
1322 if (likely(rc == 0))
1323 return 0;
ae006510 1324
bd056d7e
TH
1325 if (rc == -ERANGE)
1326 goto out_of_range;
1327 /* treat all other errors as -EINVAL, fall through */
ae006510
DG
1328invalid_fld:
1329 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1330 /* "Invalid field in cbd" */
1331 return 1;
1332
1333out_of_range:
1334 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1335 /* "Logical Block Address out of range" */
1336 return 1;
1337
1338nothing_to_do:
1339 qc->scsicmd->result = SAM_STAT_GOOD;
1340 return 1;
1da177e4
LT
1341}
1342
77853bf2 1343static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1da177e4 1344{
c31f571d 1345 struct ata_port *ap = qc->ap;
1da177e4 1346 struct scsi_cmnd *cmd = qc->scsicmd;
a7dac447 1347 u8 *cdb = cmd->cmnd;
a22e2eb0 1348 int need_sense = (qc->err_mask != 0);
b095518e 1349
3057ac3c 1350 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1351 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1352 * cache
1353 */
c31f571d
TH
1354 if (ap->ops->error_handler &&
1355 !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
3057ac3c 1356 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1357 (qc->tf.feature == SETFEATURES_WC_OFF))) {
c31f571d
TH
1358 ap->eh_info.action |= ATA_EH_REVALIDATE;
1359 ata_port_schedule_eh(ap);
3057ac3c 1360 }
1361
b095518e
JG
1362 /* For ATA pass thru (SAT) commands, generate a sense block if
1363 * user mandated it or if there's an error. Note that if we
1364 * generate because the user forced us to, a check condition
1365 * is generated and the ATA register values are returned
1366 * whether the command completed successfully or not. If there
1367 * was no error, SK, ASC and ASCQ will all be zero.
1368 */
a7dac447
JG
1369 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1370 ((cdb[2] & 0x20) || need_sense)) {
750426aa 1371 ata_gen_passthru_sense(qc);
b095518e
JG
1372 } else {
1373 if (!need_sense) {
1374 cmd->result = SAM_STAT_GOOD;
1375 } else {
1376 /* TODO: decide which descriptor format to use
1377 * for 48b LBA devices and call that here
1378 * instead of the fixed desc, which is only
1379 * good for smaller LBA (and maybe CHS?)
1380 * devices.
1381 */
750426aa 1382 ata_gen_ata_sense(qc);
b095518e
JG
1383 }
1384 }
1da177e4 1385
c31f571d
TH
1386 if (need_sense && !ap->ops->error_handler)
1387 ata_dump_status(ap->id, &qc->result_tf);
1da177e4
LT
1388
1389 qc->scsidone(cmd);
1390
77853bf2 1391 ata_qc_free(qc);
1da177e4
LT
1392}
1393
3dc1d881
TH
1394/**
1395 * ata_scmd_need_defer - Check whether we need to defer scmd
1396 * @dev: ATA device to which the command is addressed
1397 * @is_io: Is the command IO (and thus possibly NCQ)?
1398 *
1399 * NCQ and non-NCQ commands cannot run together. As upper layer
1400 * only knows the queue depth, we are responsible for maintaining
1401 * exclusion. This function checks whether a new command can be
1402 * issued to @dev.
1403 *
1404 * LOCKING:
cca3974e 1405 * spin_lock_irqsave(host lock)
3dc1d881
TH
1406 *
1407 * RETURNS:
1408 * 1 if deferring is needed, 0 otherwise.
1409 */
1410static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1411{
1412 struct ata_port *ap = dev->ap;
1413
1414 if (!(dev->flags & ATA_DFLAG_NCQ))
1415 return 0;
1416
1417 if (is_io) {
1418 if (!ata_tag_valid(ap->active_tag))
1419 return 0;
1420 } else {
1421 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1422 return 0;
1423 }
1424 return 1;
1425}
1426
1da177e4
LT
1427/**
1428 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1da177e4
LT
1429 * @dev: ATA device to which the command is addressed
1430 * @cmd: SCSI command to execute
1431 * @done: SCSI command completion function
1432 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1433 *
1434 * Our ->queuecommand() function has decided that the SCSI
1435 * command issued can be directly translated into an ATA
1436 * command, rather than handled internally.
1437 *
1438 * This function sets up an ata_queued_cmd structure for the
1439 * SCSI command, and sends that ata_queued_cmd to the hardware.
1440 *
ae006510
DG
1441 * The xlat_func argument (actor) returns 0 if ready to execute
1442 * ATA command, else 1 to finish translation. If 1 is returned
1443 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1444 * to be set reflecting an error condition or clean (early)
1445 * termination.
1446 *
1da177e4 1447 * LOCKING:
cca3974e 1448 * spin_lock_irqsave(host lock)
2115ea94
TH
1449 *
1450 * RETURNS:
1451 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1452 * needs to be deferred.
1da177e4 1453 */
2115ea94
TH
1454static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1455 void (*done)(struct scsi_cmnd *),
1456 ata_xlat_func_t xlat_func)
1da177e4
LT
1457{
1458 struct ata_queued_cmd *qc;
1459 u8 *scsicmd = cmd->cmnd;
3dc1d881 1460 int is_io = xlat_func == ata_scsi_rw_xlat;
1da177e4
LT
1461
1462 VPRINTK("ENTER\n");
1463
3dc1d881
TH
1464 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1465 goto defer;
1466
3373efd8 1467 qc = ata_scsi_qc_new(dev, cmd, done);
1da177e4 1468 if (!qc)
ae006510 1469 goto err_mem;
1da177e4
LT
1470
1471 /* data is present; dma-map it */
be7db055
CH
1472 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1473 cmd->sc_data_direction == DMA_TO_DEVICE) {
1da177e4 1474 if (unlikely(cmd->request_bufflen < 1)) {
f15a1daf
TH
1475 ata_dev_printk(dev, KERN_WARNING,
1476 "WARNING: zero len r/w req\n");
ae006510 1477 goto err_did;
1da177e4
LT
1478 }
1479
1480 if (cmd->use_sg)
1481 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1482 else
1483 ata_sg_init_one(qc, cmd->request_buffer,
1484 cmd->request_bufflen);
1485
1486 qc->dma_dir = cmd->sc_data_direction;
1487 }
1488
1489 qc->complete_fn = ata_scsi_qc_complete;
1490
1491 if (xlat_func(qc, scsicmd))
ae006510 1492 goto early_finish;
1da177e4
LT
1493
1494 /* select device, send command to hardware */
8e0e694a 1495 ata_qc_issue(qc);
1da177e4
LT
1496
1497 VPRINTK("EXIT\n");
2115ea94 1498 return 0;
1da177e4 1499
ae006510
DG
1500early_finish:
1501 ata_qc_free(qc);
1502 done(cmd);
1503 DPRINTK("EXIT - early finish (good or error)\n");
2115ea94 1504 return 0;
ae006510
DG
1505
1506err_did:
1da177e4 1507 ata_qc_free(qc);
ae006510
DG
1508 cmd->result = (DID_ERROR << 16);
1509 done(cmd);
253b92ec 1510err_mem:
ae006510 1511 DPRINTK("EXIT - internal\n");
2115ea94 1512 return 0;
3dc1d881
TH
1513
1514defer:
1515 DPRINTK("EXIT - defer\n");
1516 return SCSI_MLQUEUE_DEVICE_BUSY;
1da177e4
LT
1517}
1518
1519/**
1520 * ata_scsi_rbuf_get - Map response buffer.
1521 * @cmd: SCSI command containing buffer to be mapped.
1522 * @buf_out: Pointer to mapped area.
1523 *
1524 * Maps buffer contained within SCSI command @cmd.
1525 *
1526 * LOCKING:
cca3974e 1527 * spin_lock_irqsave(host lock)
1da177e4
LT
1528 *
1529 * RETURNS:
1530 * Length of response buffer.
1531 */
1532
1533static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1534{
1535 u8 *buf;
1536 unsigned int buflen;
1537
1538 if (cmd->use_sg) {
1539 struct scatterlist *sg;
1540
1541 sg = (struct scatterlist *) cmd->request_buffer;
da02d2a1 1542 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1da177e4
LT
1543 buflen = sg->length;
1544 } else {
1545 buf = cmd->request_buffer;
1546 buflen = cmd->request_bufflen;
1547 }
1548
1549 *buf_out = buf;
1550 return buflen;
1551}
1552
1553/**
1554 * ata_scsi_rbuf_put - Unmap response buffer.
1555 * @cmd: SCSI command containing buffer to be unmapped.
1556 * @buf: buffer to unmap
1557 *
1558 * Unmaps response buffer contained within @cmd.
1559 *
1560 * LOCKING:
cca3974e 1561 * spin_lock_irqsave(host lock)
1da177e4
LT
1562 */
1563
1564static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1565{
1566 if (cmd->use_sg) {
1567 struct scatterlist *sg;
1568
1569 sg = (struct scatterlist *) cmd->request_buffer;
da02d2a1 1570 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1da177e4
LT
1571 }
1572}
1573
1574/**
1575 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1576 * @args: device IDENTIFY data / SCSI command of interest.
1577 * @actor: Callback hook for desired SCSI command simulator
1578 *
1579 * Takes care of the hard work of simulating a SCSI command...
1580 * Mapping the response buffer, calling the command's handler,
1581 * and handling the handler's return value. This return value
1582 * indicates whether the handler wishes the SCSI command to be
ae006510
DG
1583 * completed successfully (0), or not (in which case cmd->result
1584 * and sense buffer are assumed to be set).
1da177e4
LT
1585 *
1586 * LOCKING:
cca3974e 1587 * spin_lock_irqsave(host lock)
1da177e4
LT
1588 */
1589
1590void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1591 unsigned int (*actor) (struct ata_scsi_args *args,
1592 u8 *rbuf, unsigned int buflen))
1593{
1594 u8 *rbuf;
1595 unsigned int buflen, rc;
1596 struct scsi_cmnd *cmd = args->cmd;
1597
1598 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1599 memset(rbuf, 0, buflen);
1600 rc = actor(args, rbuf, buflen);
1601 ata_scsi_rbuf_put(cmd, rbuf);
1602
ae006510 1603 if (rc == 0)
1da177e4 1604 cmd->result = SAM_STAT_GOOD;
ae006510 1605 args->done(cmd);
1da177e4
LT
1606}
1607
6a36261e
TH
1608/**
1609 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1610 * @idx: byte index into SCSI response buffer
1611 * @val: value to set
1612 *
1613 * To be used by SCSI command simulator functions. This macros
1614 * expects two local variables, u8 *rbuf and unsigned int buflen,
1615 * are in scope.
1616 *
1617 * LOCKING:
1618 * None.
1619 */
1620#define ATA_SCSI_RBUF_SET(idx, val) do { \
1621 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1622 } while (0)
1623
1da177e4
LT
1624/**
1625 * ata_scsiop_inq_std - Simulate INQUIRY command
1626 * @args: device IDENTIFY data / SCSI command of interest.
1627 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1628 * @buflen: Response buffer length.
1629 *
1630 * Returns standard device identification data associated
b142eb65 1631 * with non-VPD INQUIRY command output.
1da177e4
LT
1632 *
1633 * LOCKING:
cca3974e 1634 * spin_lock_irqsave(host lock)
1da177e4
LT
1635 */
1636
1637unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1638 unsigned int buflen)
1639{
1640 u8 hdr[] = {
1641 TYPE_DISK,
1642 0,
1643 0x5, /* claim SPC-3 version compatibility */
1644 2,
1645 95 - 4
1646 };
1647
1648 /* set scsi removeable (RMB) bit per ata bit */
1649 if (ata_id_removeable(args->id))
1650 hdr[1] |= (1 << 7);
1651
1652 VPRINTK("ENTER\n");
1653
1654 memcpy(rbuf, hdr, sizeof(hdr));
1655
1656 if (buflen > 35) {
1657 memcpy(&rbuf[8], "ATA ", 8);
6a62a04d
TH
1658 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1659 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1da177e4
LT
1660 if (rbuf[32] == 0 || rbuf[32] == ' ')
1661 memcpy(&rbuf[32], "n/a ", 4);
1662 }
1663
1664 if (buflen > 63) {
1665 const u8 versions[] = {
1666 0x60, /* SAM-3 (no version claimed) */
1667
1668 0x03,
1669 0x20, /* SBC-2 (no version claimed) */
1670
1671 0x02,
1672 0x60 /* SPC-3 (no version claimed) */
1673 };
1674
1675 memcpy(rbuf + 59, versions, sizeof(versions));
1676 }
1677
1678 return 0;
1679}
1680
1681/**
b142eb65 1682 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1da177e4
LT
1683 * @args: device IDENTIFY data / SCSI command of interest.
1684 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1685 * @buflen: Response buffer length.
1686 *
b142eb65 1687 * Returns list of inquiry VPD pages available.
1da177e4
LT
1688 *
1689 * LOCKING:
cca3974e 1690 * spin_lock_irqsave(host lock)
1da177e4
LT
1691 */
1692
1693unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1694 unsigned int buflen)
1695{
1696 const u8 pages[] = {
1697 0x00, /* page 0x00, this page */
1698 0x80, /* page 0x80, unit serial no page */
1699 0x83 /* page 0x83, device ident page */
1700 };
b142eb65 1701 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1da177e4
LT
1702
1703 if (buflen > 6)
1704 memcpy(rbuf + 4, pages, sizeof(pages));
1705
1706 return 0;
1707}
1708
1709/**
b142eb65 1710 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1da177e4
LT
1711 * @args: device IDENTIFY data / SCSI command of interest.
1712 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1713 * @buflen: Response buffer length.
1714 *
1715 * Returns ATA device serial number.
1716 *
1717 * LOCKING:
cca3974e 1718 * spin_lock_irqsave(host lock)
1da177e4
LT
1719 */
1720
1721unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1722 unsigned int buflen)
1723{
1724 const u8 hdr[] = {
1725 0,
1726 0x80, /* this page code */
1727 0,
1728 ATA_SERNO_LEN, /* page len */
1729 };
1730 memcpy(rbuf, hdr, sizeof(hdr));
1731
1732 if (buflen > (ATA_SERNO_LEN + 4 - 1))
6a62a04d
TH
1733 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1734 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1da177e4
LT
1735
1736 return 0;
1737}
1738
1da177e4 1739/**
b142eb65 1740 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1da177e4
LT
1741 * @args: device IDENTIFY data / SCSI command of interest.
1742 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1743 * @buflen: Response buffer length.
1744 *
b142eb65
JG
1745 * Yields two logical unit device identification designators:
1746 * - vendor specific ASCII containing the ATA serial number
1747 * - SAT defined "t10 vendor id based" containing ASCII vendor
1748 * name ("ATA "), model and serial numbers.
1da177e4
LT
1749 *
1750 * LOCKING:
cca3974e 1751 * spin_lock_irqsave(host lock)
1da177e4
LT
1752 */
1753
1754unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1755 unsigned int buflen)
1756{
b142eb65
JG
1757 int num;
1758 const int sat_model_serial_desc_len = 68;
1759 const int ata_model_byte_len = 40;
1da177e4 1760
b142eb65
JG
1761 rbuf[1] = 0x83; /* this page code */
1762 num = 4;
1763
1764 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1765 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2e9edbf8 1766 rbuf[num + 0] = 2;
b142eb65
JG
1767 rbuf[num + 3] = ATA_SERNO_LEN;
1768 num += 4;
1769 ata_id_string(args->id, (unsigned char *) rbuf + num,
1770 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1771 num += ATA_SERNO_LEN;
1da177e4 1772 }
b142eb65
JG
1773 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1774 /* SAT defined lu model and serial numbers descriptor */
1775 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2e9edbf8
JG
1776 rbuf[num + 0] = 2;
1777 rbuf[num + 1] = 1;
b142eb65
JG
1778 rbuf[num + 3] = sat_model_serial_desc_len;
1779 num += 4;
1780 memcpy(rbuf + num, "ATA ", 8);
1781 num += 8;
1782 ata_id_string(args->id, (unsigned char *) rbuf + num,
1783 ATA_ID_PROD_OFS, ata_model_byte_len);
1784 num += ata_model_byte_len;
1785 ata_id_string(args->id, (unsigned char *) rbuf + num,
1786 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1787 num += ATA_SERNO_LEN;
1788 }
1789 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1da177e4
LT
1790 return 0;
1791}
1792
1793/**
0cba632b 1794 * ata_scsiop_noop - Command handler that simply returns success.
1da177e4
LT
1795 * @args: device IDENTIFY data / SCSI command of interest.
1796 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1797 * @buflen: Response buffer length.
1798 *
1799 * No operation. Simply returns success to caller, to indicate
1800 * that the caller should successfully complete this SCSI command.
1801 *
1802 * LOCKING:
cca3974e 1803 * spin_lock_irqsave(host lock)
1da177e4
LT
1804 */
1805
1806unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1807 unsigned int buflen)
1808{
1809 VPRINTK("ENTER\n");
1810 return 0;
1811}
1812
1813/**
1814 * ata_msense_push - Push data onto MODE SENSE data output buffer
1815 * @ptr_io: (input/output) Location to store more output data
1816 * @last: End of output data buffer
1817 * @buf: Pointer to BLOB being added to output buffer
1818 * @buflen: Length of BLOB
1819 *
1820 * Store MODE SENSE data on an output buffer.
1821 *
1822 * LOCKING:
1823 * None.
1824 */
1825
1826static void ata_msense_push(u8 **ptr_io, const u8 *last,
1827 const u8 *buf, unsigned int buflen)
1828{
1829 u8 *ptr = *ptr_io;
1830
1831 if ((ptr + buflen - 1) > last)
1832 return;
1833
1834 memcpy(ptr, buf, buflen);
1835
1836 ptr += buflen;
1837
1838 *ptr_io = ptr;
1839}
1840
1841/**
1842 * ata_msense_caching - Simulate MODE SENSE caching info page
1843 * @id: device IDENTIFY data
1844 * @ptr_io: (input/output) Location to store more output data
1845 * @last: End of output data buffer
1846 *
1847 * Generate a caching info page, which conditionally indicates
1848 * write caching to the SCSI layer, depending on device
1849 * capabilities.
1850 *
1851 * LOCKING:
1852 * None.
1853 */
1854
1855static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1856 const u8 *last)
1857{
00ac37f5 1858 u8 page[CACHE_MPAGE_LEN];
1da177e4 1859
00ac37f5 1860 memcpy(page, def_cache_mpage, sizeof(page));
1da177e4
LT
1861 if (ata_id_wcache_enabled(id))
1862 page[2] |= (1 << 2); /* write cache enable */
1863 if (!ata_id_rahead_enabled(id))
1864 page[12] |= (1 << 5); /* disable read ahead */
1865
1866 ata_msense_push(ptr_io, last, page, sizeof(page));
1867 return sizeof(page);
1868}
1869
1870/**
1871 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1872 * @dev: Device associated with this MODE SENSE command
1873 * @ptr_io: (input/output) Location to store more output data
1874 * @last: End of output data buffer
1875 *
1876 * Generate a generic MODE SENSE control mode page.
1877 *
1878 * LOCKING:
1879 * None.
1880 */
1881
1882static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1883{
00ac37f5
DG
1884 ata_msense_push(ptr_io, last, def_control_mpage,
1885 sizeof(def_control_mpage));
1886 return sizeof(def_control_mpage);
1da177e4
LT
1887}
1888
1889/**
1890 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1891 * @dev: Device associated with this MODE SENSE command
1892 * @ptr_io: (input/output) Location to store more output data
1893 * @last: End of output data buffer
1894 *
1895 * Generate a generic MODE SENSE r/w error recovery page.
1896 *
1897 * LOCKING:
1898 * None.
1899 */
1900
1901static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1902{
1da177e4 1903
00ac37f5
DG
1904 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1905 sizeof(def_rw_recovery_mpage));
1906 return sizeof(def_rw_recovery_mpage);
1da177e4
LT
1907}
1908
48bdc8ec
JA
1909/*
1910 * We can turn this into a real blacklist if it's needed, for now just
1911 * blacklist any Maxtor BANC1G10 revision firmware
1912 */
1913static int ata_dev_supports_fua(u16 *id)
1914{
1915 unsigned char model[41], fw[9];
1916
c3c013a2
JG
1917 if (!libata_fua)
1918 return 0;
48bdc8ec
JA
1919 if (!ata_id_has_fua(id))
1920 return 0;
1921
6a62a04d
TH
1922 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1923 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
48bdc8ec 1924
2e02671d 1925 if (strcmp(model, "Maxtor"))
48bdc8ec 1926 return 1;
2e02671d 1927 if (strcmp(fw, "BANC1G10"))
48bdc8ec
JA
1928 return 1;
1929
1930 return 0; /* blacklisted */
1931}
1932
1da177e4
LT
1933/**
1934 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1935 * @args: device IDENTIFY data / SCSI command of interest.
1936 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1937 * @buflen: Response buffer length.
1938 *
00ac37f5
DG
1939 * Simulate MODE SENSE commands. Assume this is invoked for direct
1940 * access devices (e.g. disks) only. There should be no block
1941 * descriptor for other device types.
1da177e4
LT
1942 *
1943 * LOCKING:
cca3974e 1944 * spin_lock_irqsave(host lock)
1da177e4
LT
1945 */
1946
1947unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1948 unsigned int buflen)
1949{
9a3dccc4 1950 struct ata_device *dev = args->dev;
1da177e4 1951 u8 *scsicmd = args->cmd->cmnd, *p, *last;
00ac37f5
DG
1952 const u8 sat_blk_desc[] = {
1953 0, 0, 0, 0, /* number of blocks: sat unspecified */
1954 0,
1955 0, 0x2, 0x0 /* block length: 512 bytes */
1956 };
1957 u8 pg, spg;
1958 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
9a3dccc4 1959 u8 dpofua;
1da177e4
LT
1960
1961 VPRINTK("ENTER\n");
1962
1963 six_byte = (scsicmd[0] == MODE_SENSE);
00ac37f5
DG
1964 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1965 /*
1966 * LLBA bit in msense(10) ignored (compliant)
1da177e4 1967 */
00ac37f5 1968
1da177e4 1969 page_control = scsicmd[2] >> 6;
ae006510
DG
1970 switch (page_control) {
1971 case 0: /* current */
1972 break; /* supported */
1973 case 3: /* saved */
1974 goto saving_not_supp;
1975 case 1: /* changeable */
1976 case 2: /* defaults */
1977 default:
1978 goto invalid_fld;
1979 }
1da177e4 1980
00ac37f5
DG
1981 if (six_byte) {
1982 output_len = 4 + (ebd ? 8 : 0);
1983 alloc_len = scsicmd[4];
1984 } else {
1985 output_len = 8 + (ebd ? 8 : 0);
1986 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1987 }
1988 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1da177e4
LT
1989
1990 p = rbuf + output_len;
00ac37f5 1991 last = rbuf + minlen - 1;
1da177e4 1992
00ac37f5
DG
1993 pg = scsicmd[2] & 0x3f;
1994 spg = scsicmd[3];
1995 /*
1996 * No mode subpages supported (yet) but asking for _all_
1997 * subpages may be valid
1998 */
1999 if (spg && (spg != ALL_SUB_MPAGES))
2000 goto invalid_fld;
2001
2002 switch(pg) {
2003 case RW_RECOVERY_MPAGE:
1da177e4
LT
2004 output_len += ata_msense_rw_recovery(&p, last);
2005 break;
2006
00ac37f5 2007 case CACHE_MPAGE:
1da177e4
LT
2008 output_len += ata_msense_caching(args->id, &p, last);
2009 break;
2010
00ac37f5 2011 case CONTROL_MPAGE: {
1da177e4
LT
2012 output_len += ata_msense_ctl_mode(&p, last);
2013 break;
2014 }
2015
00ac37f5 2016 case ALL_MPAGES:
1da177e4
LT
2017 output_len += ata_msense_rw_recovery(&p, last);
2018 output_len += ata_msense_caching(args->id, &p, last);
2019 output_len += ata_msense_ctl_mode(&p, last);
2020 break;
2021
2022 default: /* invalid page code */
ae006510 2023 goto invalid_fld;
1da177e4
LT
2024 }
2025
00ac37f5
DG
2026 if (minlen < 1)
2027 return 0;
9a3dccc4
TH
2028
2029 dpofua = 0;
f79d409f 2030 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
9a3dccc4
TH
2031 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2032 dpofua = 1 << 4;
2033
1da177e4
LT
2034 if (six_byte) {
2035 output_len--;
2036 rbuf[0] = output_len;
9a3dccc4
TH
2037 if (minlen > 2)
2038 rbuf[2] |= dpofua;
00ac37f5
DG
2039 if (ebd) {
2040 if (minlen > 3)
2041 rbuf[3] = sizeof(sat_blk_desc);
2042 if (minlen > 11)
2043 memcpy(rbuf + 4, sat_blk_desc,
2044 sizeof(sat_blk_desc));
2045 }
1da177e4
LT
2046 } else {
2047 output_len -= 2;
2048 rbuf[0] = output_len >> 8;
00ac37f5
DG
2049 if (minlen > 1)
2050 rbuf[1] = output_len;
9a3dccc4
TH
2051 if (minlen > 3)
2052 rbuf[3] |= dpofua;
00ac37f5
DG
2053 if (ebd) {
2054 if (minlen > 7)
2055 rbuf[7] = sizeof(sat_blk_desc);
2056 if (minlen > 15)
2057 memcpy(rbuf + 8, sat_blk_desc,
2058 sizeof(sat_blk_desc));
2059 }
1da177e4 2060 }
1da177e4 2061 return 0;
ae006510
DG
2062
2063invalid_fld:
2064 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2065 /* "Invalid field in cbd" */
2066 return 1;
2067
2068saving_not_supp:
2069 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2070 /* "Saving parameters not supported" */
2071 return 1;
1da177e4
LT
2072}
2073
2074/**
2075 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2076 * @args: device IDENTIFY data / SCSI command of interest.
2077 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2078 * @buflen: Response buffer length.
2079 *
2080 * Simulate READ CAPACITY commands.
2081 *
2082 * LOCKING:
6a36261e 2083 * None.
1da177e4 2084 */
1da177e4
LT
2085unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2086 unsigned int buflen)
2087{
6a36261e 2088 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
1da177e4
LT
2089
2090 VPRINTK("ENTER\n");
2091
1da177e4 2092 if (args->cmd->cmnd[0] == READ_CAPACITY) {
6a36261e
TH
2093 if (last_lba >= 0xffffffffULL)
2094 last_lba = 0xffffffff;
0c144d0d 2095
1da177e4 2096 /* sector count, 32-bit */
6a36261e
TH
2097 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2098 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2099 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2100 ATA_SCSI_RBUF_SET(3, last_lba);
1da177e4
LT
2101
2102 /* sector size */
6a36261e
TH
2103 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2104 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
1da177e4
LT
2105 } else {
2106 /* sector count, 64-bit */
6a36261e
TH
2107 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2108 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2109 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2110 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2111 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2112 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2113 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2114 ATA_SCSI_RBUF_SET(7, last_lba);
1da177e4
LT
2115
2116 /* sector size */
6a36261e
TH
2117 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2118 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
1da177e4
LT
2119 }
2120
2121 return 0;
2122}
2123
2124/**
2125 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2126 * @args: device IDENTIFY data / SCSI command of interest.
2127 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2128 * @buflen: Response buffer length.
2129 *
2130 * Simulate REPORT LUNS command.
2131 *
2132 * LOCKING:
cca3974e 2133 * spin_lock_irqsave(host lock)
1da177e4
LT
2134 */
2135
2136unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2137 unsigned int buflen)
2138{
2139 VPRINTK("ENTER\n");
2140 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2141
2142 return 0;
2143}
2144
845c5834
DG
2145/**
2146 * ata_scsi_set_sense - Set SCSI sense data and status
2147 * @cmd: SCSI request to be handled
2148 * @sk: SCSI-defined sense key
2149 * @asc: SCSI-defined additional sense code
2150 * @ascq: SCSI-defined additional sense code qualifier
2151 *
2152 * Helper function that builds a valid fixed format, current
2153 * response code and the given sense key (sk), additional sense
2154 * code (asc) and additional sense code qualifier (ascq) with
2155 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2156 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2157 *
2158 * LOCKING:
2159 * Not required
2160 */
2161
2162void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2163{
2164 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2165
2166 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2167 cmd->sense_buffer[2] = sk;
2168 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2169 cmd->sense_buffer[12] = asc;
2170 cmd->sense_buffer[13] = ascq;
2171}
2172
1da177e4
LT
2173/**
2174 * ata_scsi_badcmd - End a SCSI request with an error
2175 * @cmd: SCSI request to be handled
2176 * @done: SCSI command completion function
2177 * @asc: SCSI-defined additional sense code
2178 * @ascq: SCSI-defined additional sense code qualifier
2179 *
2180 * Helper function that completes a SCSI command with
2181 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2182 * and the specified additional sense codes.
2183 *
2184 * LOCKING:
cca3974e 2185 * spin_lock_irqsave(host lock)
1da177e4
LT
2186 */
2187
2188void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2189{
2190 DPRINTK("ENTER\n");
ae006510 2191 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1da177e4
LT
2192
2193 done(cmd);
2194}
2195
77853bf2 2196static void atapi_sense_complete(struct ata_queued_cmd *qc)
a939c963 2197{
74e6c8c3 2198 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
c6e6e666
JG
2199 /* FIXME: not quite right; we don't want the
2200 * translation of taskfile registers into
2201 * a sense descriptors, since that's only
2202 * correct for ATA, not ATAPI
2203 */
750426aa 2204 ata_gen_passthru_sense(qc);
74e6c8c3 2205 }
a939c963 2206
c6e6e666 2207 qc->scsidone(qc->scsicmd);
77853bf2 2208 ata_qc_free(qc);
c6e6e666 2209}
a939c963 2210
c6e6e666
JG
2211/* is it pointless to prefer PIO for "safety reasons"? */
2212static inline int ata_pio_use_silly(struct ata_port *ap)
2213{
2214 return (ap->flags & ATA_FLAG_PIO_DMA);
2215}
2216
2217static void atapi_request_sense(struct ata_queued_cmd *qc)
2218{
2219 struct ata_port *ap = qc->ap;
2220 struct scsi_cmnd *cmd = qc->scsicmd;
2221
2222 DPRINTK("ATAPI request sense\n");
a939c963
JG
2223
2224 /* FIXME: is this needed? */
2225 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2226
c6e6e666
JG
2227 ap->ops->tf_read(ap, &qc->tf);
2228
2229 /* fill these in, for the case where they are -not- overwritten */
2230 cmd->sense_buffer[0] = 0x70;
2231 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2232
2233 ata_qc_reinit(qc);
2234
a939c963
JG
2235 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2236 qc->dma_dir = DMA_FROM_DEVICE;
2237
6e7846e9 2238 memset(&qc->cdb, 0, qc->dev->cdb_len);
a939c963
JG
2239 qc->cdb[0] = REQUEST_SENSE;
2240 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2241
2242 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2243 qc->tf.command = ATA_CMD_PACKET;
2244
c6e6e666
JG
2245 if (ata_pio_use_silly(ap)) {
2246 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2247 qc->tf.feature |= ATAPI_PKT_DMA;
2248 } else {
2249 qc->tf.protocol = ATA_PROT_ATAPI;
2250 qc->tf.lbam = (8 * 1024) & 0xff;
2251 qc->tf.lbah = (8 * 1024) >> 8;
2252 }
a939c963
JG
2253 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2254
c6e6e666 2255 qc->complete_fn = atapi_sense_complete;
a939c963 2256
8e0e694a 2257 ata_qc_issue(qc);
a939c963
JG
2258
2259 DPRINTK("EXIT\n");
2260}
2261
77853bf2 2262static void atapi_qc_complete(struct ata_queued_cmd *qc)
1da177e4
LT
2263{
2264 struct scsi_cmnd *cmd = qc->scsicmd;
a22e2eb0 2265 unsigned int err_mask = qc->err_mask;
1da177e4 2266
a7dac447 2267 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
e12669e7 2268
246619da
TH
2269 /* handle completion from new EH */
2270 if (unlikely(qc->ap->ops->error_handler &&
2271 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2272
2273 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2274 /* FIXME: not quite right; we don't want the
2275 * translation of taskfile registers into a
2276 * sense descriptors, since that's only
2277 * correct for ATA, not ATAPI
2278 */
750426aa 2279 ata_gen_passthru_sense(qc);
246619da
TH
2280 }
2281
22aac089
TH
2282 /* SCSI EH automatically locks door if sdev->locked is
2283 * set. Sometimes door lock request continues to
2284 * fail, for example, when no media is present. This
2285 * creates a loop - SCSI EH issues door lock which
2286 * fails and gets invoked again to acquire sense data
2287 * for the failed command.
2288 *
2289 * If door lock fails, always clear sdev->locked to
2290 * avoid this infinite loop.
2291 */
2292 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2293 qc->dev->sdev->locked = 0;
2294
246619da
TH
2295 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2296 qc->scsidone(cmd);
2297 ata_qc_free(qc);
2298 return;
2299 }
2300
2301 /* successful completion or old EH failure path */
a7dac447 2302 if (unlikely(err_mask & AC_ERR_DEV)) {
1da177e4 2303 cmd->result = SAM_STAT_CHECK_CONDITION;
c6e6e666 2304 atapi_request_sense(qc);
77853bf2 2305 return;
74e6c8c3 2306 } else if (unlikely(err_mask)) {
a7dac447
JG
2307 /* FIXME: not quite right; we don't want the
2308 * translation of taskfile registers into
2309 * a sense descriptors, since that's only
2310 * correct for ATA, not ATAPI
2311 */
750426aa 2312 ata_gen_passthru_sense(qc);
74e6c8c3 2313 } else {
1da177e4
LT
2314 u8 *scsicmd = cmd->cmnd;
2315
fd71da46 2316 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
1da177e4
LT
2317 u8 *buf = NULL;
2318 unsigned int buflen;
2319
2320 buflen = ata_scsi_rbuf_get(cmd, &buf);
a15dbeb4
JG
2321
2322 /* ATAPI devices typically report zero for their SCSI version,
2323 * and sometimes deviate from the spec WRT response data
2324 * format. If SCSI version is reported as zero like normal,
2325 * then we make the following fixups: 1) Fake MMC-5 version,
2326 * to indicate to the Linux scsi midlayer this is a modern
2327 * device. 2) Ensure response data format / ATAPI information
2328 * are always correct.
a15dbeb4
JG
2329 */
2330 if (buf[2] == 0) {
2331 buf[2] = 0x5;
2332 buf[3] = 0x32;
2333 }
2334
1da177e4
LT
2335 ata_scsi_rbuf_put(cmd, buf);
2336 }
a15dbeb4 2337
1da177e4
LT
2338 cmd->result = SAM_STAT_GOOD;
2339 }
2340
2341 qc->scsidone(cmd);
77853bf2 2342 ata_qc_free(qc);
1da177e4
LT
2343}
2344/**
2345 * atapi_xlat - Initialize PACKET taskfile
2346 * @qc: command structure to be initialized
2347 * @scsicmd: SCSI CDB associated with this PACKET command
2348 *
2349 * LOCKING:
cca3974e 2350 * spin_lock_irqsave(host lock)
1da177e4
LT
2351 *
2352 * RETURNS:
2353 * Zero on success, non-zero on failure.
2354 */
2355
057ace5e 2356static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
2357{
2358 struct scsi_cmnd *cmd = qc->scsicmd;
2359 struct ata_device *dev = qc->dev;
2360 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db055 2361 int nodata = (cmd->sc_data_direction == DMA_NONE);
1da177e4
LT
2362
2363 if (!using_pio)
2364 /* Check whether ATAPI DMA is safe */
2365 if (ata_check_atapi_dma(qc))
2366 using_pio = 1;
2367
6e7846e9 2368 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
1da177e4
LT
2369
2370 qc->complete_fn = atapi_qc_complete;
2371
2372 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db055 2373 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
1da177e4
LT
2374 qc->tf.flags |= ATA_TFLAG_WRITE;
2375 DPRINTK("direction: write\n");
2376 }
2377
2378 qc->tf.command = ATA_CMD_PACKET;
2379
2380 /* no data, or PIO data xfer */
2381 if (using_pio || nodata) {
2382 if (nodata)
2383 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2384 else
2385 qc->tf.protocol = ATA_PROT_ATAPI;
2386 qc->tf.lbam = (8 * 1024) & 0xff;
2387 qc->tf.lbah = (8 * 1024) >> 8;
2388 }
2389
2390 /* DMA data xfer */
2391 else {
2392 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2393 qc->tf.feature |= ATAPI_PKT_DMA;
2394
95de719a
AL
2395 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2396 /* some SATA bridges need us to indicate data xfer direction */
1da177e4 2397 qc->tf.feature |= ATAPI_DMADIR;
1da177e4
LT
2398 }
2399
5d5ff44f 2400 qc->nbytes = cmd->request_bufflen;
1da177e4
LT
2401
2402 return 0;
2403}
2404
ab5b3a5b
TH
2405static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2406{
2407 if (likely(id < ATA_MAX_DEVICES))
2408 return &ap->device[id];
2409 return NULL;
2410}
2411
2412static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2413 const struct scsi_device *scsidev)
2414{
2415 /* skip commands not addressed to targets we simulate */
2416 if (unlikely(scsidev->channel || scsidev->lun))
2417 return NULL;
2418
2419 return ata_find_dev(ap, scsidev->id);
2420}
2421
99ba9e09
BK
2422/**
2423 * ata_scsi_dev_enabled - determine if device is enabled
2424 * @dev: ATA device
2425 *
2426 * Determine if commands should be sent to the specified device.
2427 *
2428 * LOCKING:
cca3974e 2429 * spin_lock_irqsave(host lock)
99ba9e09
BK
2430 *
2431 * RETURNS:
2432 * 0 if commands are not allowed / 1 if commands are allowed
2433 */
2434
2435static int ata_scsi_dev_enabled(struct ata_device *dev)
2436{
2437 if (unlikely(!ata_dev_enabled(dev)))
2438 return 0;
2439
2440 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2441 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2442 ata_dev_printk(dev, KERN_WARNING,
2443 "WARNING: ATAPI is %s, device ignored.\n",
2444 atapi_enabled ? "not supported with this driver" : "disabled");
2445 return 0;
2446 }
2447 }
2448
2449 return 1;
2450}
2451
1da177e4
LT
2452/**
2453 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2454 * @ap: ATA port to which the device is attached
2455 * @scsidev: SCSI device from which we derive the ATA device
2456 *
2457 * Given various information provided in struct scsi_cmnd,
2458 * map that onto an ATA bus, and using that mapping
2459 * determine which ata_device is associated with the
2460 * SCSI command to be sent.
2461 *
2462 * LOCKING:
cca3974e 2463 * spin_lock_irqsave(host lock)
1da177e4
LT
2464 *
2465 * RETURNS:
2466 * Associated ATA device, or %NULL if not found.
2467 */
1da177e4 2468static struct ata_device *
057ace5e 2469ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
1da177e4 2470{
ab5b3a5b 2471 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
1da177e4 2472
99ba9e09 2473 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
1da177e4
LT
2474 return NULL;
2475
1da177e4
LT
2476 return dev;
2477}
2478
b095518e
JG
2479/*
2480 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2481 * @byte1: Byte 1 from pass-thru CDB.
2482 *
2483 * RETURNS:
2484 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2485 */
2486static u8
2487ata_scsi_map_proto(u8 byte1)
2488{
2489 switch((byte1 & 0x1e) >> 1) {
2490 case 3: /* Non-data */
2491 return ATA_PROT_NODATA;
2492
2493 case 6: /* DMA */
2494 return ATA_PROT_DMA;
2495
2496 case 4: /* PIO Data-in */
2497 case 5: /* PIO Data-out */
b095518e
JG
2498 return ATA_PROT_PIO;
2499
2500 case 10: /* Device Reset */
2501 case 0: /* Hard Reset */
2502 case 1: /* SRST */
2503 case 2: /* Bus Idle */
2504 case 7: /* Packet */
2505 case 8: /* DMA Queued */
2506 case 9: /* Device Diagnostic */
2507 case 11: /* UDMA Data-in */
2508 case 12: /* UDMA Data-Out */
2509 case 13: /* FPDMA */
2510 default: /* Reserved */
2511 break;
2512 }
2513
2514 return ATA_PROT_UNKNOWN;
2515}
2516
2517/**
2518 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2519 * @qc: command structure to be initialized
8e8b77dd 2520 * @scsicmd: SCSI command to convert
b095518e
JG
2521 *
2522 * Handles either 12 or 16-byte versions of the CDB.
2523 *
2524 * RETURNS:
2525 * Zero on success, non-zero on failure.
2526 */
2527static unsigned int
00ac37f5 2528ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
b095518e
JG
2529{
2530 struct ata_taskfile *tf = &(qc->tf);
2531 struct scsi_cmnd *cmd = qc->scsicmd;
f79d409f 2532 struct ata_device *dev = qc->dev;
b095518e
JG
2533
2534 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
9a405257 2535 goto invalid_fld;
8190bdb9 2536
f79d409f
AC
2537 /* We may not issue DMA commands if no DMA mode is set */
2538 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2539 goto invalid_fld;
b095518e 2540
f59b0cf8
AL
2541 if (scsicmd[1] & 0xe0)
2542 /* PIO multi not supported yet */
2543 goto invalid_fld;
2544
b095518e
JG
2545 /*
2546 * 12 and 16 byte CDBs use different offsets to
2547 * provide the various register values.
2548 */
2549 if (scsicmd[0] == ATA_16) {
2550 /*
2551 * 16-byte CDB - may contain extended commands.
2552 *
2553 * If that is the case, copy the upper byte register values.
2554 */
2555 if (scsicmd[1] & 0x01) {
2556 tf->hob_feature = scsicmd[3];
2557 tf->hob_nsect = scsicmd[5];
2558 tf->hob_lbal = scsicmd[7];
2559 tf->hob_lbam = scsicmd[9];
2560 tf->hob_lbah = scsicmd[11];
2561 tf->flags |= ATA_TFLAG_LBA48;
2562 } else
2563 tf->flags &= ~ATA_TFLAG_LBA48;
2564
2565 /*
2566 * Always copy low byte, device and command registers.
2567 */
2568 tf->feature = scsicmd[4];
2569 tf->nsect = scsicmd[6];
2570 tf->lbal = scsicmd[8];
2571 tf->lbam = scsicmd[10];
2572 tf->lbah = scsicmd[12];
2573 tf->device = scsicmd[13];
2574 tf->command = scsicmd[14];
2575 } else {
2576 /*
2577 * 12-byte CDB - incapable of extended commands.
2578 */
2579 tf->flags &= ~ATA_TFLAG_LBA48;
2580
2581 tf->feature = scsicmd[3];
2582 tf->nsect = scsicmd[4];
2583 tf->lbal = scsicmd[5];
2584 tf->lbam = scsicmd[6];
2585 tf->lbah = scsicmd[7];
2586 tf->device = scsicmd[8];
2587 tf->command = scsicmd[9];
2588 }
dcc2d1e7
ML
2589 /*
2590 * If slave is possible, enforce correct master/slave bit
2591 */
2592 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2593 tf->device = qc->dev->devno ?
2594 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
b095518e
JG
2595
2596 /*
2597 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2598 * SET_FEATURES - XFER MODE must be preceded/succeeded
2599 * by an update to hardware-specific registers for each
2600 * controller (i.e. the reason for ->set_piomode(),
2601 * ->set_dmamode(), and ->post_set_mode() hooks).
2602 */
2603 if ((tf->command == ATA_CMD_SET_FEATURES)
2604 && (tf->feature == SETFEATURES_XFER))
9a405257 2605 goto invalid_fld;
b095518e
JG
2606
2607 /*
2608 * Set flags so that all registers will be written,
2609 * and pass on write indication (used for PIO/DMA
2610 * setup.)
2611 */
2612 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2613
0274aa25 2614 if (cmd->sc_data_direction == DMA_TO_DEVICE)
b095518e
JG
2615 tf->flags |= ATA_TFLAG_WRITE;
2616
2617 /*
2618 * Set transfer length.
2619 *
2620 * TODO: find out if we need to do more here to
2621 * cover scatter/gather case.
2622 */
5d5ff44f 2623 qc->nsect = cmd->request_bufflen / ATA_SECT_SIZE;
b095518e 2624
e61e0672
TH
2625 /* request result TF */
2626 qc->flags |= ATA_QCFLAG_RESULT_TF;
2627
b095518e 2628 return 0;
9a405257
TH
2629
2630 invalid_fld:
2631 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2632 /* "Invalid field in cdb" */
2633 return 1;
b095518e
JG
2634}
2635
1da177e4
LT
2636/**
2637 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2638 * @dev: ATA device
2639 * @cmd: SCSI command opcode to consider
2640 *
2641 * Look up the SCSI command given, and determine whether the
2642 * SCSI command is to be translated or simulated.
2643 *
2644 * RETURNS:
2645 * Pointer to translation function if possible, %NULL if not.
2646 */
2647
2648static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2649{
2650 switch (cmd) {
2651 case READ_6:
2652 case READ_10:
2653 case READ_16:
2654
2655 case WRITE_6:
2656 case WRITE_10:
2657 case WRITE_16:
2658 return ata_scsi_rw_xlat;
2659
2660 case SYNCHRONIZE_CACHE:
2661 if (ata_try_flush_cache(dev))
2662 return ata_scsi_flush_xlat;
2663 break;
2664
2665 case VERIFY:
2666 case VERIFY_16:
2667 return ata_scsi_verify_xlat;
b095518e
JG
2668
2669 case ATA_12:
2670 case ATA_16:
2671 return ata_scsi_pass_thru;
da61396d 2672
972dcafb
DG
2673 case START_STOP:
2674 return ata_scsi_start_stop_xlat;
1da177e4
LT
2675 }
2676
2677 return NULL;
2678}
2679
2680/**
2681 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2682 * @ap: ATA port to which the command was being sent
2683 * @cmd: SCSI command to dump
2684 *
2685 * Prints the contents of a SCSI command via printk().
2686 */
2687
2688static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2689 struct scsi_cmnd *cmd)
2690{
2691#ifdef ATA_DEBUG
2692 struct scsi_device *scsidev = cmd->device;
2693 u8 *scsicmd = cmd->cmnd;
2694
2695 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2696 ap->id,
2697 scsidev->channel, scsidev->id, scsidev->lun,
2698 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2699 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2700 scsicmd[8]);
2701#endif
2702}
2703
2115ea94
TH
2704static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2705 void (*done)(struct scsi_cmnd *),
2706 struct ata_device *dev)
eb3f0f9c 2707{
2115ea94
TH
2708 int rc = 0;
2709
eb3f0f9c
BK
2710 if (dev->class == ATA_DEV_ATA) {
2711 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2712 cmd->cmnd[0]);
2713
2714 if (xlat_func)
2115ea94 2715 rc = ata_scsi_translate(dev, cmd, done, xlat_func);
eb3f0f9c 2716 else
3373efd8 2717 ata_scsi_simulate(dev, cmd, done);
eb3f0f9c 2718 } else
2115ea94
TH
2719 rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);
2720
2721 return rc;
eb3f0f9c
BK
2722}
2723
1da177e4
LT
2724/**
2725 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2726 * @cmd: SCSI command to be sent
2727 * @done: Completion function, called when command is complete
2728 *
2729 * In some cases, this function translates SCSI commands into
2730 * ATA taskfiles, and queues the taskfiles to be sent to
2731 * hardware. In other cases, this function simulates a
2732 * SCSI device by evaluating and responding to certain
2733 * SCSI commands. This creates the overall effect of
2734 * ATA and ATAPI devices appearing as SCSI devices.
2735 *
2736 * LOCKING:
cca3974e 2737 * Releases scsi-layer-held lock, and obtains host lock.
1da177e4
LT
2738 *
2739 * RETURNS:
2115ea94
TH
2740 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2741 * 0 otherwise.
1da177e4 2742 */
1da177e4
LT
2743int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2744{
2745 struct ata_port *ap;
2746 struct ata_device *dev;
2747 struct scsi_device *scsidev = cmd->device;
005a5a06 2748 struct Scsi_Host *shost = scsidev->host;
2115ea94 2749 int rc = 0;
1da177e4 2750
35bb94b1 2751 ap = ata_shost_to_port(shost);
005a5a06
JG
2752
2753 spin_unlock(shost->host_lock);
ba6a1308 2754 spin_lock(ap->lock);
1da177e4
LT
2755
2756 ata_scsi_dump_cdb(ap, cmd);
2757
2758 dev = ata_scsi_find_dev(ap, scsidev);
eb3f0f9c 2759 if (likely(dev))
2115ea94 2760 rc = __ata_scsi_queuecmd(cmd, done, dev);
eb3f0f9c 2761 else {
1da177e4
LT
2762 cmd->result = (DID_BAD_TARGET << 16);
2763 done(cmd);
1da177e4
LT
2764 }
2765
ba6a1308 2766 spin_unlock(ap->lock);
005a5a06 2767 spin_lock(shost->host_lock);
2115ea94 2768 return rc;
1da177e4
LT
2769}
2770
2771/**
2772 * ata_scsi_simulate - simulate SCSI command on ATA device
c893a3ae 2773 * @dev: the target device
1da177e4
LT
2774 * @cmd: SCSI command being sent to device.
2775 * @done: SCSI command completion function.
2776 *
2777 * Interprets and directly executes a select list of SCSI commands
2778 * that can be handled internally.
2779 *
2780 * LOCKING:
cca3974e 2781 * spin_lock_irqsave(host lock)
1da177e4
LT
2782 */
2783
3373efd8 2784void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT
2785 void (*done)(struct scsi_cmnd *))
2786{
2787 struct ata_scsi_args args;
057ace5e 2788 const u8 *scsicmd = cmd->cmnd;
1da177e4 2789
9a3dccc4
TH
2790 args.dev = dev;
2791 args.id = dev->id;
1da177e4
LT
2792 args.cmd = cmd;
2793 args.done = done;
2794
2795 switch(scsicmd[0]) {
2796 /* no-op's, complete with success */
2797 case SYNCHRONIZE_CACHE:
2798 case REZERO_UNIT:
2799 case SEEK_6:
2800 case SEEK_10:
2801 case TEST_UNIT_READY:
2802 case FORMAT_UNIT: /* FIXME: correct? */
2803 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2804 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2805 break;
2806
2807 case INQUIRY:
2808 if (scsicmd[1] & 2) /* is CmdDt set? */
ae006510 2809 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2810 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2811 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2812 else if (scsicmd[2] == 0x00)
2813 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2814 else if (scsicmd[2] == 0x80)
2815 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2816 else if (scsicmd[2] == 0x83)
2817 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2818 else
ae006510 2819 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2820 break;
2821
2822 case MODE_SENSE:
2823 case MODE_SENSE_10:
2824 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2825 break;
2826
2827 case MODE_SELECT: /* unconditionally return */
2828 case MODE_SELECT_10: /* bad-field-in-cdb */
ae006510 2829 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2830 break;
2831
2832 case READ_CAPACITY:
2833 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2834 break;
2835
2836 case SERVICE_ACTION_IN:
2837 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2838 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2839 else
ae006510 2840 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2841 break;
2842
2843 case REPORT_LUNS:
2844 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2845 break;
2846
b095518e 2847 /* mandatory commands we haven't implemented yet */
1da177e4
LT
2848 case REQUEST_SENSE:
2849
2850 /* all other commands */
2851 default:
ae006510
DG
2852 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2853 /* "Invalid command operation code" */
2854 done(cmd);
1da177e4
LT
2855 break;
2856 }
2857}
2858
644dd0cc
JG
2859void ata_scsi_scan_host(struct ata_port *ap)
2860{
2861 unsigned int i;
2862
198e0fed 2863 if (ap->flags & ATA_FLAG_DISABLED)
644dd0cc
JG
2864 return;
2865
3f19ee8c 2866 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3edebac4
TH
2867 struct ata_device *dev = &ap->device[i];
2868 struct scsi_device *sdev;
2869
2870 if (!ata_dev_enabled(dev) || dev->sdev)
2871 continue;
3f19ee8c 2872
cca3974e 2873 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
3edebac4
TH
2874 if (!IS_ERR(sdev)) {
2875 dev->sdev = sdev;
2876 scsi_device_put(sdev);
2877 }
3f19ee8c 2878 }
644dd0cc 2879}
0ea035a3
TH
2880
2881/**
2882 * ata_scsi_offline_dev - offline attached SCSI device
2883 * @dev: ATA device to offline attached SCSI device for
2884 *
2885 * This function is called from ata_eh_hotplug() and responsible
2886 * for taking the SCSI device attached to @dev offline. This
cca3974e 2887 * function is called with host lock which protects dev->sdev
0ea035a3
TH
2888 * against clearing.
2889 *
2890 * LOCKING:
cca3974e 2891 * spin_lock_irqsave(host lock)
0ea035a3
TH
2892 *
2893 * RETURNS:
2894 * 1 if attached SCSI device exists, 0 otherwise.
2895 */
2896int ata_scsi_offline_dev(struct ata_device *dev)
2897{
2898 if (dev->sdev) {
2899 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2900 return 1;
2901 }
2902 return 0;
2903}
580b2102
TH
2904
2905/**
2906 * ata_scsi_remove_dev - remove attached SCSI device
2907 * @dev: ATA device to remove attached SCSI device for
2908 *
2909 * This function is called from ata_eh_scsi_hotplug() and
2910 * responsible for removing the SCSI device attached to @dev.
2911 *
2912 * LOCKING:
2913 * Kernel thread context (may sleep).
2914 */
2915static void ata_scsi_remove_dev(struct ata_device *dev)
2916{
2917 struct ata_port *ap = dev->ap;
2918 struct scsi_device *sdev;
2919 unsigned long flags;
2920
2921 /* Alas, we need to grab scan_mutex to ensure SCSI device
2922 * state doesn't change underneath us and thus
2923 * scsi_device_get() always succeeds. The mutex locking can
2924 * be removed if there is __scsi_device_get() interface which
2925 * increments reference counts regardless of device state.
2926 */
cca3974e 2927 mutex_lock(&ap->scsi_host->scan_mutex);
ba6a1308 2928 spin_lock_irqsave(ap->lock, flags);
580b2102 2929
cca3974e 2930 /* clearing dev->sdev is protected by host lock */
580b2102
TH
2931 sdev = dev->sdev;
2932 dev->sdev = NULL;
2933
2934 if (sdev) {
2935 /* If user initiated unplug races with us, sdev can go
cca3974e 2936 * away underneath us after the host lock and
580b2102
TH
2937 * scan_mutex are released. Hold onto it.
2938 */
2939 if (scsi_device_get(sdev) == 0) {
2940 /* The following ensures the attached sdev is
2941 * offline on return from ata_scsi_offline_dev()
2942 * regardless it wins or loses the race
2943 * against this function.
2944 */
2945 scsi_device_set_state(sdev, SDEV_OFFLINE);
2946 } else {
2947 WARN_ON(1);
2948 sdev = NULL;
2949 }
2950 }
2951
ba6a1308 2952 spin_unlock_irqrestore(ap->lock, flags);
cca3974e 2953 mutex_unlock(&ap->scsi_host->scan_mutex);
580b2102
TH
2954
2955 if (sdev) {
2956 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
2957 sdev->sdev_gendev.bus_id);
2958
2959 scsi_remove_device(sdev);
2960 scsi_device_put(sdev);
2961 }
2962}
2963
2964/**
2965 * ata_scsi_hotplug - SCSI part of hotplug
65f27f38 2966 * @work: Pointer to ATA port to perform SCSI hotplug on
580b2102
TH
2967 *
2968 * Perform SCSI part of hotplug. It's executed from a separate
2969 * workqueue after EH completes. This is necessary because SCSI
2970 * hot plugging requires working EH and hot unplugging is
2971 * synchronized with hot plugging with a mutex.
2972 *
2973 * LOCKING:
2974 * Kernel thread context (may sleep).
2975 */
65f27f38 2976void ata_scsi_hotplug(struct work_struct *work)
580b2102 2977{
65f27f38
DH
2978 struct ata_port *ap =
2979 container_of(work, struct ata_port, hotplug_task.work);
580b2102
TH
2980 int i;
2981
b51e9e5d 2982 if (ap->pflags & ATA_PFLAG_UNLOADING) {
580b2102
TH
2983 DPRINTK("ENTER/EXIT - unloading\n");
2984 return;
2985 }
2986
2987 DPRINTK("ENTER\n");
2988
2989 /* unplug detached devices */
2990 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2991 struct ata_device *dev = &ap->device[i];
2992 unsigned long flags;
2993
2994 if (!(dev->flags & ATA_DFLAG_DETACHED))
2995 continue;
2996
ba6a1308 2997 spin_lock_irqsave(ap->lock, flags);
580b2102 2998 dev->flags &= ~ATA_DFLAG_DETACHED;
ba6a1308 2999 spin_unlock_irqrestore(ap->lock, flags);
580b2102
TH
3000
3001 ata_scsi_remove_dev(dev);
3002 }
3003
3004 /* scan for new ones */
3005 ata_scsi_scan_host(ap);
3006
3007 /* If we scanned while EH was in progress, scan would have
3008 * failed silently. Requeue if there are enabled but
3009 * unattached devices.
3010 */
3011 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3012 struct ata_device *dev = &ap->device[i];
3013 if (ata_dev_enabled(dev) && !dev->sdev) {
3014 queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
3015 break;
3016 }
3017 }
3018
3019 DPRINTK("EXIT\n");
3020}
83c47bcb
TH
3021
3022/**
3023 * ata_scsi_user_scan - indication for user-initiated bus scan
3024 * @shost: SCSI host to scan
3025 * @channel: Channel to scan
3026 * @id: ID to scan
3027 * @lun: LUN to scan
3028 *
3029 * This function is called when user explicitly requests bus
3030 * scan. Set probe pending flag and invoke EH.
3031 *
3032 * LOCKING:
3033 * SCSI layer (we don't care)
3034 *
3035 * RETURNS:
3036 * Zero.
3037 */
3038static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3039 unsigned int id, unsigned int lun)
3040{
3041 struct ata_port *ap = ata_shost_to_port(shost);
3042 unsigned long flags;
3043 int rc = 0;
3044
3045 if (!ap->ops->error_handler)
3046 return -EOPNOTSUPP;
3047
3048 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3049 (lun != SCAN_WILD_CARD && lun != 0))
3050 return -EINVAL;
3051
ba6a1308 3052 spin_lock_irqsave(ap->lock, flags);
83c47bcb
TH
3053
3054 if (id == SCAN_WILD_CARD) {
3055 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3056 ap->eh_info.action |= ATA_EH_SOFTRESET;
3057 } else {
3058 struct ata_device *dev = ata_find_dev(ap, id);
3059
3060 if (dev) {
3061 ap->eh_info.probe_mask |= 1 << dev->devno;
3062 ap->eh_info.action |= ATA_EH_SOFTRESET;
28324304 3063 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
83c47bcb
TH
3064 } else
3065 rc = -EINVAL;
3066 }
3067
309afcb5 3068 if (rc == 0) {
83c47bcb 3069 ata_port_schedule_eh(ap);
309afcb5
TH
3070 spin_unlock_irqrestore(ap->lock, flags);
3071 ata_port_wait_eh(ap);
3072 } else
3073 spin_unlock_irqrestore(ap->lock, flags);
83c47bcb
TH
3074
3075 return rc;
3076}
3057ac3c 3077
3078/**
d0171269 3079 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
65f27f38 3080 * @work: Pointer to ATA port to perform scsi_rescan_device()
3057ac3c 3081 *
d0171269
TH
3082 * After ATA pass thru (SAT) commands are executed successfully,
3083 * libata need to propagate the changes to SCSI layer. This
3084 * function must be executed from ata_aux_wq such that sdev
3085 * attach/detach don't race with rescan.
3057ac3c 3086 *
d0171269
TH
3087 * LOCKING:
3088 * Kernel thread context (may sleep).
3057ac3c 3089 */
65f27f38 3090void ata_scsi_dev_rescan(struct work_struct *work)
3057ac3c 3091{
65f27f38
DH
3092 struct ata_port *ap =
3093 container_of(work, struct ata_port, scsi_rescan_task);
f84e7e41 3094 unsigned long flags;
3057ac3c 3095 unsigned int i;
3096
f84e7e41
TH
3097 spin_lock_irqsave(ap->lock, flags);
3098
3057ac3c 3099 for (i = 0; i < ATA_MAX_DEVICES; i++) {
f84e7e41
TH
3100 struct ata_device *dev = &ap->device[i];
3101 struct scsi_device *sdev = dev->sdev;
3057ac3c 3102
f84e7e41
TH
3103 if (!ata_dev_enabled(dev) || !sdev)
3104 continue;
3105 if (scsi_device_get(sdev))
3106 continue;
3107
3108 spin_unlock_irqrestore(ap->lock, flags);
3109 scsi_rescan_device(&(sdev->sdev_gendev));
3110 scsi_device_put(sdev);
3111 spin_lock_irqsave(ap->lock, flags);
3057ac3c 3112 }
f84e7e41
TH
3113
3114 spin_unlock_irqrestore(ap->lock, flags);
3057ac3c 3115}
80289167
BK
3116
3117/**
3118 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4f931374 3119 * @host: ATA host container for all SAS ports
80289167 3120 * @port_info: Information from low-level host driver
cca3974e 3121 * @shost: SCSI host that the scsi device is attached to
80289167
BK
3122 *
3123 * LOCKING:
3124 * PCI/etc. bus probe sem.
3125 *
3126 * RETURNS:
3127 * ata_port pointer on success / NULL on failure.
3128 */
3129
cca3974e 3130struct ata_port *ata_sas_port_alloc(struct ata_host *host,
80289167 3131 struct ata_port_info *port_info,
cca3974e 3132 struct Scsi_Host *shost)
80289167
BK
3133{
3134 struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
3135 struct ata_probe_ent *ent;
3136
3137 if (!ap)
3138 return NULL;
3139
cca3974e 3140 ent = ata_probe_ent_alloc(host->dev, port_info);
80289167
BK
3141 if (!ent) {
3142 kfree(ap);
3143 return NULL;
3144 }
3145
cca3974e
JG
3146 ata_port_init(ap, host, ent, 0);
3147 ap->lock = shost->host_lock;
80289167
BK
3148 kfree(ent);
3149 return ap;
3150}
3151EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3152
3153/**
3154 * ata_sas_port_start - Set port up for dma.
3155 * @ap: Port to initialize
3156 *
3157 * Called just after data structures for each port are
3158 * initialized. Allocates DMA pad.
3159 *
3160 * May be used as the port_start() entry in ata_port_operations.
3161 *
3162 * LOCKING:
3163 * Inherited from caller.
3164 */
3165int ata_sas_port_start(struct ata_port *ap)
3166{
3167 return ata_pad_alloc(ap, ap->dev);
3168}
3169EXPORT_SYMBOL_GPL(ata_sas_port_start);
3170
3171/**
3172 * ata_port_stop - Undo ata_sas_port_start()
3173 * @ap: Port to shut down
3174 *
3175 * Frees the DMA pad.
3176 *
3177 * May be used as the port_stop() entry in ata_port_operations.
3178 *
3179 * LOCKING:
3180 * Inherited from caller.
3181 */
3182
3183void ata_sas_port_stop(struct ata_port *ap)
3184{
3185 ata_pad_free(ap, ap->dev);
3186}
3187EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3188
3189/**
3190 * ata_sas_port_init - Initialize a SATA device
3191 * @ap: SATA port to initialize
3192 *
3193 * LOCKING:
3194 * PCI/etc. bus probe sem.
3195 *
3196 * RETURNS:
3197 * Zero on success, non-zero on error.
3198 */
3199
3200int ata_sas_port_init(struct ata_port *ap)
3201{
3202 int rc = ap->ops->port_start(ap);
3203
3204 if (!rc)
3205 rc = ata_bus_probe(ap);
3206
3207 return rc;
3208}
3209EXPORT_SYMBOL_GPL(ata_sas_port_init);
3210
3211/**
3212 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3213 * @ap: SATA port to destroy
3214 *
3215 */
3216
3217void ata_sas_port_destroy(struct ata_port *ap)
3218{
3219 ap->ops->port_stop(ap);
3220 kfree(ap);
3221}
3222EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3223
3224/**
3225 * ata_sas_slave_configure - Default slave_config routine for libata devices
3226 * @sdev: SCSI device to configure
3227 * @ap: ATA port to which SCSI device is attached
3228 *
3229 * RETURNS:
3230 * Zero.
3231 */
3232
3233int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3234{
3235 ata_scsi_sdev_config(sdev);
3236 ata_scsi_dev_config(sdev, ap->device);
3237 return 0;
3238}
3239EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3240
3241/**
3242 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3243 * @cmd: SCSI command to be sent
3244 * @done: Completion function, called when command is complete
3245 * @ap: ATA port to which the command is being sent
3246 *
3247 * RETURNS:
08475a19
BK
3248 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3249 * 0 otherwise.
80289167
BK
3250 */
3251
3252int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3253 struct ata_port *ap)
3254{
08475a19
BK
3255 int rc = 0;
3256
80289167
BK
3257 ata_scsi_dump_cdb(ap, cmd);
3258
3259 if (likely(ata_scsi_dev_enabled(ap->device)))
08475a19 3260 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
80289167
BK
3261 else {
3262 cmd->result = (DID_BAD_TARGET << 16);
3263 done(cmd);
3264 }
08475a19 3265 return rc;
80289167
BK
3266}
3267EXPORT_SYMBOL_GPL(ata_sas_queuecmd);