]> err.no Git - linux-2.6/blob - drivers/scsi/libata-scsi.c
[PATCH] libata-ncq: implement NCQ command translation and exclusion
[linux-2.6] / drivers / scsi / libata-scsi.c
1 /*
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  *
34  */
35
36 #include <linux/kernel.h>
37 #include <linux/blkdev.h>
38 #include <linux/spinlock.h>
39 #include <scsi/scsi.h>
40 #include <scsi/scsi_host.h>
41 #include <scsi/scsi_eh.h>
42 #include <scsi/scsi_device.h>
43 #include <scsi/scsi_request.h>
44 #include <scsi/scsi_transport.h>
45 #include <linux/libata.h>
46 #include <linux/hdreg.h>
47 #include <asm/uaccess.h>
48
49 #include "libata.h"
50
51 #define SECTOR_SIZE     512
52
53 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
54 static struct ata_device *
55 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
56
57 #define RW_RECOVERY_MPAGE 0x1
58 #define RW_RECOVERY_MPAGE_LEN 12
59 #define CACHE_MPAGE 0x8
60 #define CACHE_MPAGE_LEN 20
61 #define CONTROL_MPAGE 0xa
62 #define CONTROL_MPAGE_LEN 12
63 #define ALL_MPAGES 0x3f
64 #define ALL_SUB_MPAGES 0xff
65
66
67 static const u8 def_rw_recovery_mpage[] = {
68         RW_RECOVERY_MPAGE,
69         RW_RECOVERY_MPAGE_LEN - 2,
70         (1 << 7) |      /* AWRE, sat-r06 say it shall be 0 */
71             (1 << 6),   /* ARRE (auto read reallocation) */
72         0,              /* read retry count */
73         0, 0, 0, 0,
74         0,              /* write retry count */
75         0, 0, 0
76 };
77
78 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
79         CACHE_MPAGE,
80         CACHE_MPAGE_LEN - 2,
81         0,              /* contains WCE, needs to be 0 for logic */
82         0, 0, 0, 0, 0, 0, 0, 0, 0,
83         0,              /* contains DRA, needs to be 0 for logic */
84         0, 0, 0, 0, 0, 0, 0
85 };
86
87 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
88         CONTROL_MPAGE,
89         CONTROL_MPAGE_LEN - 2,
90         2,      /* DSENSE=0, GLTSD=1 */
91         0,      /* [QAM+QERR may be 1, see 05-359r1] */
92         0, 0, 0, 0, 0xff, 0xff,
93         0, 30   /* extended self test time, see 05-359r1 */
94 };
95
96 /*
97  * libata transport template.  libata doesn't do real transport stuff.
98  * It just needs the eh_timed_out hook.
99  */
100 struct scsi_transport_template ata_scsi_transport_template = {
101         .eh_strategy_handler    = ata_scsi_error,
102         .eh_timed_out           = ata_scsi_timed_out,
103 };
104
105
106 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
107                                    void (*done)(struct scsi_cmnd *))
108 {
109         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
110         /* "Invalid field in cbd" */
111         done(cmd);
112 }
113
114 /**
115  *      ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
116  *      @sdev: SCSI device for which BIOS geometry is to be determined
117  *      @bdev: block device associated with @sdev
118  *      @capacity: capacity of SCSI device
119  *      @geom: location to which geometry will be output
120  *
121  *      Generic bios head/sector/cylinder calculator
122  *      used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
123  *      mapping. Some situations may arise where the disk is not
124  *      bootable if this is not used.
125  *
126  *      LOCKING:
127  *      Defined by the SCSI layer.  We don't really care.
128  *
129  *      RETURNS:
130  *      Zero.
131  */
132 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
133                        sector_t capacity, int geom[])
134 {
135         geom[0] = 255;
136         geom[1] = 63;
137         sector_div(capacity, 255*63);
138         geom[2] = capacity;
139
140         return 0;
141 }
142
143 /**
144  *      ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
145  *      @scsidev: Device to which we are issuing command
146  *      @arg: User provided data for issuing command
147  *
148  *      LOCKING:
149  *      Defined by the SCSI layer.  We don't really care.
150  *
151  *      RETURNS:
152  *      Zero on success, negative errno on error.
153  */
154
155 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
156 {
157         int rc = 0;
158         u8 scsi_cmd[MAX_COMMAND_SIZE];
159         u8 args[4], *argbuf = NULL;
160         int argsize = 0;
161         struct scsi_sense_hdr sshdr;
162         enum dma_data_direction data_dir;
163
164         if (arg == NULL)
165                 return -EINVAL;
166
167         if (copy_from_user(args, arg, sizeof(args)))
168                 return -EFAULT;
169
170         memset(scsi_cmd, 0, sizeof(scsi_cmd));
171
172         if (args[3]) {
173                 argsize = SECTOR_SIZE * args[3];
174                 argbuf = kmalloc(argsize, GFP_KERNEL);
175                 if (argbuf == NULL) {
176                         rc = -ENOMEM;
177                         goto error;
178                 }
179
180                 scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
181                 scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
182                                             block count in sector count field */
183                 data_dir = DMA_FROM_DEVICE;
184         } else {
185                 scsi_cmd[1]  = (3 << 1); /* Non-data */
186                 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
187                 data_dir = DMA_NONE;
188         }
189
190         scsi_cmd[0] = ATA_16;
191
192         scsi_cmd[4] = args[2];
193         if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
194                 scsi_cmd[6]  = args[3];
195                 scsi_cmd[8]  = args[1];
196                 scsi_cmd[10] = 0x4f;
197                 scsi_cmd[12] = 0xc2;
198         } else {
199                 scsi_cmd[6]  = args[1];
200         }
201         scsi_cmd[14] = args[0];
202
203         /* Good values for timeout and retries?  Values below
204            from scsi_ioctl_send_command() for default case... */
205         if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
206                              &sshdr, (10*HZ), 5)) {
207                 rc = -EIO;
208                 goto error;
209         }
210
211         /* Need code to retrieve data from check condition? */
212
213         if ((argbuf)
214          && copy_to_user(arg + sizeof(args), argbuf, argsize))
215                 rc = -EFAULT;
216 error:
217         if (argbuf)
218                 kfree(argbuf);
219
220         return rc;
221 }
222
223 /**
224  *      ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
225  *      @scsidev: Device to which we are issuing command
226  *      @arg: User provided data for issuing command
227  *
228  *      LOCKING:
229  *      Defined by the SCSI layer.  We don't really care.
230  *
231  *      RETURNS:
232  *      Zero on success, negative errno on error.
233  */
234 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
235 {
236         int rc = 0;
237         u8 scsi_cmd[MAX_COMMAND_SIZE];
238         u8 args[7];
239         struct scsi_sense_hdr sshdr;
240
241         if (arg == NULL)
242                 return -EINVAL;
243
244         if (copy_from_user(args, arg, sizeof(args)))
245                 return -EFAULT;
246
247         memset(scsi_cmd, 0, sizeof(scsi_cmd));
248         scsi_cmd[0]  = ATA_16;
249         scsi_cmd[1]  = (3 << 1); /* Non-data */
250         /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
251         scsi_cmd[4]  = args[1];
252         scsi_cmd[6]  = args[2];
253         scsi_cmd[8]  = args[3];
254         scsi_cmd[10] = args[4];
255         scsi_cmd[12] = args[5];
256         scsi_cmd[14] = args[0];
257
258         /* Good values for timeout and retries?  Values below
259            from scsi_ioctl_send_command() for default case... */
260         if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
261                              (10*HZ), 5))
262                 rc = -EIO;
263
264         /* Need code to retrieve data from check condition? */
265         return rc;
266 }
267
268 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
269 {
270         int val = -EINVAL, rc = -EINVAL;
271
272         switch (cmd) {
273         case ATA_IOC_GET_IO32:
274                 val = 0;
275                 if (copy_to_user(arg, &val, 1))
276                         return -EFAULT;
277                 return 0;
278
279         case ATA_IOC_SET_IO32:
280                 val = (unsigned long) arg;
281                 if (val != 0)
282                         return -EINVAL;
283                 return 0;
284
285         case HDIO_DRIVE_CMD:
286                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
287                         return -EACCES;
288                 return ata_cmd_ioctl(scsidev, arg);
289
290         case HDIO_DRIVE_TASK:
291                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
292                         return -EACCES;
293                 return ata_task_ioctl(scsidev, arg);
294
295         default:
296                 rc = -ENOTTY;
297                 break;
298         }
299
300         return rc;
301 }
302
303 /**
304  *      ata_scsi_qc_new - acquire new ata_queued_cmd reference
305  *      @dev: ATA device to which the new command is attached
306  *      @cmd: SCSI command that originated this ATA command
307  *      @done: SCSI command completion function
308  *
309  *      Obtain a reference to an unused ata_queued_cmd structure,
310  *      which is the basic libata structure representing a single
311  *      ATA command sent to the hardware.
312  *
313  *      If a command was available, fill in the SCSI-specific
314  *      portions of the structure with information on the
315  *      current command.
316  *
317  *      LOCKING:
318  *      spin_lock_irqsave(host_set lock)
319  *
320  *      RETURNS:
321  *      Command allocated, or %NULL if none available.
322  */
323 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
324                                        struct scsi_cmnd *cmd,
325                                        void (*done)(struct scsi_cmnd *))
326 {
327         struct ata_queued_cmd *qc;
328
329         qc = ata_qc_new_init(dev);
330         if (qc) {
331                 qc->scsicmd = cmd;
332                 qc->scsidone = done;
333
334                 if (cmd->use_sg) {
335                         qc->__sg = (struct scatterlist *) cmd->request_buffer;
336                         qc->n_elem = cmd->use_sg;
337                 } else {
338                         qc->__sg = &qc->sgent;
339                         qc->n_elem = 1;
340                 }
341         } else {
342                 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
343                 done(cmd);
344         }
345
346         return qc;
347 }
348
349 /**
350  *      ata_dump_status - user friendly display of error info
351  *      @id: id of the port in question
352  *      @tf: ptr to filled out taskfile
353  *
354  *      Decode and dump the ATA error/status registers for the user so
355  *      that they have some idea what really happened at the non
356  *      make-believe layer.
357  *
358  *      LOCKING:
359  *      inherited from caller
360  */
361 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
362 {
363         u8 stat = tf->command, err = tf->feature;
364
365         printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
366         if (stat & ATA_BUSY) {
367                 printk("Busy }\n");     /* Data is not valid in this case */
368         } else {
369                 if (stat & 0x40)        printk("DriveReady ");
370                 if (stat & 0x20)        printk("DeviceFault ");
371                 if (stat & 0x10)        printk("SeekComplete ");
372                 if (stat & 0x08)        printk("DataRequest ");
373                 if (stat & 0x04)        printk("CorrectedError ");
374                 if (stat & 0x02)        printk("Index ");
375                 if (stat & 0x01)        printk("Error ");
376                 printk("}\n");
377
378                 if (err) {
379                         printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
380                         if (err & 0x04)         printk("DriveStatusError ");
381                         if (err & 0x80) {
382                                 if (err & 0x04) printk("BadCRC ");
383                                 else            printk("Sector ");
384                         }
385                         if (err & 0x40)         printk("UncorrectableError ");
386                         if (err & 0x10)         printk("SectorIdNotFound ");
387                         if (err & 0x02)         printk("TrackZeroNotFound ");
388                         if (err & 0x01)         printk("AddrMarkNotFound ");
389                         printk("}\n");
390                 }
391         }
392 }
393
394 int ata_scsi_device_resume(struct scsi_device *sdev)
395 {
396         struct ata_port *ap = ata_shost_to_port(sdev->host);
397         struct ata_device *dev = &ap->device[sdev->id];
398
399         return ata_device_resume(dev);
400 }
401
402 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
403 {
404         struct ata_port *ap = ata_shost_to_port(sdev->host);
405         struct ata_device *dev = &ap->device[sdev->id];
406
407         return ata_device_suspend(dev, state);
408 }
409
410 /**
411  *      ata_to_sense_error - convert ATA error to SCSI error
412  *      @id: ATA device number
413  *      @drv_stat: value contained in ATA status register
414  *      @drv_err: value contained in ATA error register
415  *      @sk: the sense key we'll fill out
416  *      @asc: the additional sense code we'll fill out
417  *      @ascq: the additional sense code qualifier we'll fill out
418  *      @verbose: be verbose
419  *
420  *      Converts an ATA error into a SCSI error.  Fill out pointers to
421  *      SK, ASC, and ASCQ bytes for later use in fixed or descriptor
422  *      format sense blocks.
423  *
424  *      LOCKING:
425  *      spin_lock_irqsave(host_set lock)
426  */
427 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
428                         u8 *ascq, int verbose)
429 {
430         int i;
431
432         /* Based on the 3ware driver translation table */
433         static const unsigned char sense_table[][4] = {
434                 /* BBD|ECC|ID|MAR */
435                 {0xd1,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
436                 /* BBD|ECC|ID */
437                 {0xd0,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
438                 /* ECC|MC|MARK */
439                 {0x61,          HARDWARE_ERROR, 0x00, 0x00},    // Device fault                 Hardware error
440                 /* ICRC|ABRT */         /* NB: ICRC & !ABRT is BBD */
441                 {0x84,          ABORTED_COMMAND, 0x47, 0x00},   // Data CRC error               SCSI parity error
442                 /* MC|ID|ABRT|TRK0|MARK */
443                 {0x37,          NOT_READY, 0x04, 0x00},         // Unit offline                 Not ready
444                 /* MCR|MARK */
445                 {0x09,          NOT_READY, 0x04, 0x00},         // Unrecovered disk error       Not ready
446                 /*  Bad address mark */
447                 {0x01,          MEDIUM_ERROR, 0x13, 0x00},      // Address mark not found       Address mark not found for data field
448                 /* TRK0 */
449                 {0x02,          HARDWARE_ERROR, 0x00, 0x00},    // Track 0 not found              Hardware error
450                 /* Abort & !ICRC */
451                 {0x04,          ABORTED_COMMAND, 0x00, 0x00},   // Aborted command              Aborted command
452                 /* Media change request */
453                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change request   FIXME: faking offline
454                 /* SRV */
455                 {0x10,          ABORTED_COMMAND, 0x14, 0x00},   // ID not found                 Recorded entity not found
456                 /* Media change */
457                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change           FIXME: faking offline
458                 /* ECC */
459                 {0x40,          MEDIUM_ERROR, 0x11, 0x04},      // Uncorrectable ECC error      Unrecovered read error
460                 /* BBD - block marked bad */
461                 {0x80,          MEDIUM_ERROR, 0x11, 0x04},      // Block marked bad               Medium error, unrecovered read error
462                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
463         };
464         static const unsigned char stat_table[][4] = {
465                 /* Must be first because BUSY means no other bits valid */
466                 {0x80,          ABORTED_COMMAND, 0x47, 0x00},   // Busy, fake parity for now
467                 {0x20,          HARDWARE_ERROR,  0x00, 0x00},   // Device fault
468                 {0x08,          ABORTED_COMMAND, 0x47, 0x00},   // Timed out in xfer, fake parity for now
469                 {0x04,          RECOVERED_ERROR, 0x11, 0x00},   // Recovered ECC error    Medium error, recovered
470                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
471         };
472
473         /*
474          *      Is this an error we can process/parse
475          */
476         if (drv_stat & ATA_BUSY) {
477                 drv_err = 0;    /* Ignore the err bits, they're invalid */
478         }
479
480         if (drv_err) {
481                 /* Look for drv_err */
482                 for (i = 0; sense_table[i][0] != 0xFF; i++) {
483                         /* Look for best matches first */
484                         if ((sense_table[i][0] & drv_err) ==
485                             sense_table[i][0]) {
486                                 *sk = sense_table[i][1];
487                                 *asc = sense_table[i][2];
488                                 *ascq = sense_table[i][3];
489                                 goto translate_done;
490                         }
491                 }
492                 /* No immediate match */
493                 if (verbose)
494                         printk(KERN_WARNING "ata%u: no sense translation for "
495                                "error 0x%02x\n", id, drv_err);
496         }
497
498         /* Fall back to interpreting status bits */
499         for (i = 0; stat_table[i][0] != 0xFF; i++) {
500                 if (stat_table[i][0] & drv_stat) {
501                         *sk = stat_table[i][1];
502                         *asc = stat_table[i][2];
503                         *ascq = stat_table[i][3];
504                         goto translate_done;
505                 }
506         }
507         /* No error?  Undecoded? */
508         if (verbose)
509                 printk(KERN_WARNING "ata%u: no sense translation for "
510                        "status: 0x%02x\n", id, drv_stat);
511
512         /* We need a sensible error return here, which is tricky, and one
513            that won't cause people to do things like return a disk wrongly */
514         *sk = ABORTED_COMMAND;
515         *asc = 0x00;
516         *ascq = 0x00;
517
518  translate_done:
519         if (verbose)
520                 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
521                        "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
522                        id, drv_stat, drv_err, *sk, *asc, *ascq);
523         return;
524 }
525
526 /*
527  *      ata_gen_ata_desc_sense - Generate check condition sense block.
528  *      @qc: Command that completed.
529  *
530  *      This function is specific to the ATA descriptor format sense
531  *      block specified for the ATA pass through commands.  Regardless
532  *      of whether the command errored or not, return a sense
533  *      block. Copy all controller registers into the sense
534  *      block. Clear sense key, ASC & ASCQ if there is no error.
535  *
536  *      LOCKING:
537  *      spin_lock_irqsave(host_set lock)
538  */
539 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
540 {
541         struct scsi_cmnd *cmd = qc->scsicmd;
542         struct ata_taskfile *tf = &qc->result_tf;
543         unsigned char *sb = cmd->sense_buffer;
544         unsigned char *desc = sb + 8;
545         int verbose = qc->ap->ops->error_handler == NULL;
546
547         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
548
549         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
550
551         /*
552          * Use ata_to_sense_error() to map status register bits
553          * onto sense key, asc & ascq.
554          */
555         if (qc->err_mask ||
556             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
557                 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
558                                    &sb[1], &sb[2], &sb[3], verbose);
559                 sb[1] &= 0x0f;
560         }
561
562         /*
563          * Sense data is current and format is descriptor.
564          */
565         sb[0] = 0x72;
566
567         desc[0] = 0x09;
568
569         /*
570          * Set length of additional sense data.
571          * Since we only populate descriptor 0, the total
572          * length is the same (fixed) length as descriptor 0.
573          */
574         desc[1] = sb[7] = 14;
575
576         /*
577          * Copy registers into sense buffer.
578          */
579         desc[2] = 0x00;
580         desc[3] = tf->feature;  /* == error reg */
581         desc[5] = tf->nsect;
582         desc[7] = tf->lbal;
583         desc[9] = tf->lbam;
584         desc[11] = tf->lbah;
585         desc[12] = tf->device;
586         desc[13] = tf->command; /* == status reg */
587
588         /*
589          * Fill in Extend bit, and the high order bytes
590          * if applicable.
591          */
592         if (tf->flags & ATA_TFLAG_LBA48) {
593                 desc[2] |= 0x01;
594                 desc[4] = tf->hob_nsect;
595                 desc[6] = tf->hob_lbal;
596                 desc[8] = tf->hob_lbam;
597                 desc[10] = tf->hob_lbah;
598         }
599 }
600
601 /**
602  *      ata_gen_fixed_sense - generate a SCSI fixed sense block
603  *      @qc: Command that we are erroring out
604  *
605  *      Leverage ata_to_sense_error() to give us the codes.  Fit our
606  *      LBA in here if there's room.
607  *
608  *      LOCKING:
609  *      inherited from caller
610  */
611 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
612 {
613         struct scsi_cmnd *cmd = qc->scsicmd;
614         struct ata_taskfile *tf = &qc->result_tf;
615         unsigned char *sb = cmd->sense_buffer;
616         int verbose = qc->ap->ops->error_handler == NULL;
617
618         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
619
620         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
621
622         /*
623          * Use ata_to_sense_error() to map status register bits
624          * onto sense key, asc & ascq.
625          */
626         if (qc->err_mask ||
627             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
628                 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
629                                    &sb[2], &sb[12], &sb[13], verbose);
630                 sb[2] &= 0x0f;
631         }
632
633         sb[0] = 0x70;
634         sb[7] = 0x0a;
635
636         if (tf->flags & ATA_TFLAG_LBA48) {
637                 /* TODO: find solution for LBA48 descriptors */
638         }
639
640         else if (tf->flags & ATA_TFLAG_LBA) {
641                 /* A small (28b) LBA will fit in the 32b info field */
642                 sb[0] |= 0x80;          /* set valid bit */
643                 sb[3] = tf->device & 0x0f;
644                 sb[4] = tf->lbah;
645                 sb[5] = tf->lbam;
646                 sb[6] = tf->lbal;
647         }
648
649         else {
650                 /* TODO: C/H/S */
651         }
652 }
653
654 static void ata_scsi_sdev_config(struct scsi_device *sdev)
655 {
656         sdev->use_10_for_rw = 1;
657         sdev->use_10_for_ms = 1;
658 }
659
660 static void ata_scsi_dev_config(struct scsi_device *sdev,
661                                 struct ata_device *dev)
662 {
663         unsigned int max_sectors;
664
665         /* TODO: 2048 is an arbitrary number, not the
666          * hardware maximum.  This should be increased to
667          * 65534 when Jens Axboe's patch for dynamically
668          * determining max_sectors is merged.
669          */
670         max_sectors = ATA_MAX_SECTORS;
671         if (dev->flags & ATA_DFLAG_LBA48)
672                 max_sectors = 2048;
673         if (dev->max_sectors)
674                 max_sectors = dev->max_sectors;
675
676         blk_queue_max_sectors(sdev->request_queue, max_sectors);
677
678         /*
679          * SATA DMA transfers must be multiples of 4 byte, so
680          * we need to pad ATAPI transfers using an extra sg.
681          * Decrement max hw segments accordingly.
682          */
683         if (dev->class == ATA_DEV_ATAPI) {
684                 request_queue_t *q = sdev->request_queue;
685                 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
686         }
687 }
688
689 /**
690  *      ata_scsi_slave_config - Set SCSI device attributes
691  *      @sdev: SCSI device to examine
692  *
693  *      This is called before we actually start reading
694  *      and writing to the device, to configure certain
695  *      SCSI mid-layer behaviors.
696  *
697  *      LOCKING:
698  *      Defined by SCSI layer.  We don't really care.
699  */
700
701 int ata_scsi_slave_config(struct scsi_device *sdev)
702 {
703         ata_scsi_sdev_config(sdev);
704
705         blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
706
707         if (sdev->id < ATA_MAX_DEVICES) {
708                 struct ata_port *ap;
709                 struct ata_device *dev;
710
711                 ap = ata_shost_to_port(sdev->host);
712                 dev = &ap->device[sdev->id];
713
714                 ata_scsi_dev_config(sdev, dev);
715         }
716
717         return 0;       /* scsi layer doesn't check return value, sigh */
718 }
719
720 /**
721  *      ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
722  *      @qc: Storage for translated ATA taskfile
723  *      @scsicmd: SCSI command to translate
724  *
725  *      Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
726  *      (to start). Perhaps these commands should be preceded by
727  *      CHECK POWER MODE to see what power mode the device is already in.
728  *      [See SAT revision 5 at www.t10.org]
729  *
730  *      LOCKING:
731  *      spin_lock_irqsave(host_set lock)
732  *
733  *      RETURNS:
734  *      Zero on success, non-zero on error.
735  */
736
737 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
738                                              const u8 *scsicmd)
739 {
740         struct ata_taskfile *tf = &qc->tf;
741
742         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
743         tf->protocol = ATA_PROT_NODATA;
744         if (scsicmd[1] & 0x1) {
745                 ;       /* ignore IMMED bit, violates sat-r05 */
746         }
747         if (scsicmd[4] & 0x2)
748                 goto invalid_fld;       /* LOEJ bit set not supported */
749         if (((scsicmd[4] >> 4) & 0xf) != 0)
750                 goto invalid_fld;       /* power conditions not supported */
751         if (scsicmd[4] & 0x1) {
752                 tf->nsect = 1;  /* 1 sector, lba=0 */
753
754                 if (qc->dev->flags & ATA_DFLAG_LBA) {
755                         tf->flags |= ATA_TFLAG_LBA;
756
757                         tf->lbah = 0x0;
758                         tf->lbam = 0x0;
759                         tf->lbal = 0x0;
760                         tf->device |= ATA_LBA;
761                 } else {
762                         /* CHS */
763                         tf->lbal = 0x1; /* sect */
764                         tf->lbam = 0x0; /* cyl low */
765                         tf->lbah = 0x0; /* cyl high */
766                 }
767
768                 tf->command = ATA_CMD_VERIFY;   /* READ VERIFY */
769         } else {
770                 tf->nsect = 0;  /* time period value (0 implies now) */
771                 tf->command = ATA_CMD_STANDBY;
772                 /* Consider: ATA STANDBY IMMEDIATE command */
773         }
774         /*
775          * Standby and Idle condition timers could be implemented but that
776          * would require libata to implement the Power condition mode page
777          * and allow the user to change it. Changing mode pages requires
778          * MODE SELECT to be implemented.
779          */
780
781         return 0;
782
783 invalid_fld:
784         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
785         /* "Invalid field in cbd" */
786         return 1;
787 }
788
789
790 /**
791  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
792  *      @qc: Storage for translated ATA taskfile
793  *      @scsicmd: SCSI command to translate (ignored)
794  *
795  *      Sets up an ATA taskfile to issue FLUSH CACHE or
796  *      FLUSH CACHE EXT.
797  *
798  *      LOCKING:
799  *      spin_lock_irqsave(host_set lock)
800  *
801  *      RETURNS:
802  *      Zero on success, non-zero on error.
803  */
804
805 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
806 {
807         struct ata_taskfile *tf = &qc->tf;
808
809         tf->flags |= ATA_TFLAG_DEVICE;
810         tf->protocol = ATA_PROT_NODATA;
811
812         if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
813             (ata_id_has_flush_ext(qc->dev->id)))
814                 tf->command = ATA_CMD_FLUSH_EXT;
815         else
816                 tf->command = ATA_CMD_FLUSH;
817
818         return 0;
819 }
820
821 /**
822  *      scsi_6_lba_len - Get LBA and transfer length
823  *      @scsicmd: SCSI command to translate
824  *
825  *      Calculate LBA and transfer length for 6-byte commands.
826  *
827  *      RETURNS:
828  *      @plba: the LBA
829  *      @plen: the transfer length
830  */
831
832 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
833 {
834         u64 lba = 0;
835         u32 len = 0;
836
837         VPRINTK("six-byte command\n");
838
839         lba |= ((u64)scsicmd[2]) << 8;
840         lba |= ((u64)scsicmd[3]);
841
842         len |= ((u32)scsicmd[4]);
843
844         *plba = lba;
845         *plen = len;
846 }
847
848 /**
849  *      scsi_10_lba_len - Get LBA and transfer length
850  *      @scsicmd: SCSI command to translate
851  *
852  *      Calculate LBA and transfer length for 10-byte commands.
853  *
854  *      RETURNS:
855  *      @plba: the LBA
856  *      @plen: the transfer length
857  */
858
859 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
860 {
861         u64 lba = 0;
862         u32 len = 0;
863
864         VPRINTK("ten-byte command\n");
865
866         lba |= ((u64)scsicmd[2]) << 24;
867         lba |= ((u64)scsicmd[3]) << 16;
868         lba |= ((u64)scsicmd[4]) << 8;
869         lba |= ((u64)scsicmd[5]);
870
871         len |= ((u32)scsicmd[7]) << 8;
872         len |= ((u32)scsicmd[8]);
873
874         *plba = lba;
875         *plen = len;
876 }
877
878 /**
879  *      scsi_16_lba_len - Get LBA and transfer length
880  *      @scsicmd: SCSI command to translate
881  *
882  *      Calculate LBA and transfer length for 16-byte commands.
883  *
884  *      RETURNS:
885  *      @plba: the LBA
886  *      @plen: the transfer length
887  */
888
889 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
890 {
891         u64 lba = 0;
892         u32 len = 0;
893
894         VPRINTK("sixteen-byte command\n");
895
896         lba |= ((u64)scsicmd[2]) << 56;
897         lba |= ((u64)scsicmd[3]) << 48;
898         lba |= ((u64)scsicmd[4]) << 40;
899         lba |= ((u64)scsicmd[5]) << 32;
900         lba |= ((u64)scsicmd[6]) << 24;
901         lba |= ((u64)scsicmd[7]) << 16;
902         lba |= ((u64)scsicmd[8]) << 8;
903         lba |= ((u64)scsicmd[9]);
904
905         len |= ((u32)scsicmd[10]) << 24;
906         len |= ((u32)scsicmd[11]) << 16;
907         len |= ((u32)scsicmd[12]) << 8;
908         len |= ((u32)scsicmd[13]);
909
910         *plba = lba;
911         *plen = len;
912 }
913
914 /**
915  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
916  *      @qc: Storage for translated ATA taskfile
917  *      @scsicmd: SCSI command to translate
918  *
919  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
920  *
921  *      LOCKING:
922  *      spin_lock_irqsave(host_set lock)
923  *
924  *      RETURNS:
925  *      Zero on success, non-zero on error.
926  */
927
928 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
929 {
930         struct ata_taskfile *tf = &qc->tf;
931         struct ata_device *dev = qc->dev;
932         u64 dev_sectors = qc->dev->n_sectors;
933         u64 block;
934         u32 n_block;
935
936         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
937         tf->protocol = ATA_PROT_NODATA;
938
939         if (scsicmd[0] == VERIFY)
940                 scsi_10_lba_len(scsicmd, &block, &n_block);
941         else if (scsicmd[0] == VERIFY_16)
942                 scsi_16_lba_len(scsicmd, &block, &n_block);
943         else
944                 goto invalid_fld;
945
946         if (!n_block)
947                 goto nothing_to_do;
948         if (block >= dev_sectors)
949                 goto out_of_range;
950         if ((block + n_block) > dev_sectors)
951                 goto out_of_range;
952
953         if (dev->flags & ATA_DFLAG_LBA) {
954                 tf->flags |= ATA_TFLAG_LBA;
955
956                 if (lba_28_ok(block, n_block)) {
957                         /* use LBA28 */
958                         tf->command = ATA_CMD_VERIFY;
959                         tf->device |= (block >> 24) & 0xf;
960                 } else if (lba_48_ok(block, n_block)) {
961                         if (!(dev->flags & ATA_DFLAG_LBA48))
962                                 goto out_of_range;
963
964                         /* use LBA48 */
965                         tf->flags |= ATA_TFLAG_LBA48;
966                         tf->command = ATA_CMD_VERIFY_EXT;
967
968                         tf->hob_nsect = (n_block >> 8) & 0xff;
969
970                         tf->hob_lbah = (block >> 40) & 0xff;
971                         tf->hob_lbam = (block >> 32) & 0xff;
972                         tf->hob_lbal = (block >> 24) & 0xff;
973                 } else
974                         /* request too large even for LBA48 */
975                         goto out_of_range;
976
977                 tf->nsect = n_block & 0xff;
978
979                 tf->lbah = (block >> 16) & 0xff;
980                 tf->lbam = (block >> 8) & 0xff;
981                 tf->lbal = block & 0xff;
982
983                 tf->device |= ATA_LBA;
984         } else {
985                 /* CHS */
986                 u32 sect, head, cyl, track;
987
988                 if (!lba_28_ok(block, n_block))
989                         goto out_of_range;
990
991                 /* Convert LBA to CHS */
992                 track = (u32)block / dev->sectors;
993                 cyl   = track / dev->heads;
994                 head  = track % dev->heads;
995                 sect  = (u32)block % dev->sectors + 1;
996
997                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
998                         (u32)block, track, cyl, head, sect);
999
1000                 /* Check whether the converted CHS can fit.
1001                    Cylinder: 0-65535
1002                    Head: 0-15
1003                    Sector: 1-255*/
1004                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1005                         goto out_of_range;
1006
1007                 tf->command = ATA_CMD_VERIFY;
1008                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1009                 tf->lbal = sect;
1010                 tf->lbam = cyl;
1011                 tf->lbah = cyl >> 8;
1012                 tf->device |= head;
1013         }
1014
1015         return 0;
1016
1017 invalid_fld:
1018         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1019         /* "Invalid field in cbd" */
1020         return 1;
1021
1022 out_of_range:
1023         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1024         /* "Logical Block Address out of range" */
1025         return 1;
1026
1027 nothing_to_do:
1028         qc->scsicmd->result = SAM_STAT_GOOD;
1029         return 1;
1030 }
1031
1032 /**
1033  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1034  *      @qc: Storage for translated ATA taskfile
1035  *      @scsicmd: SCSI command to translate
1036  *
1037  *      Converts any of six SCSI read/write commands into the
1038  *      ATA counterpart, including starting sector (LBA),
1039  *      sector count, and taking into account the device's LBA48
1040  *      support.
1041  *
1042  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1043  *      %WRITE_16 are currently supported.
1044  *
1045  *      LOCKING:
1046  *      spin_lock_irqsave(host_set lock)
1047  *
1048  *      RETURNS:
1049  *      Zero on success, non-zero on error.
1050  */
1051
1052 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1053 {
1054         struct ata_taskfile *tf = &qc->tf;
1055         struct ata_device *dev = qc->dev;
1056         u64 block;
1057         u32 n_block;
1058
1059         qc->flags |= ATA_QCFLAG_IO;
1060         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1061
1062         if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1063             scsicmd[0] == WRITE_16)
1064                 tf->flags |= ATA_TFLAG_WRITE;
1065
1066         /* Calculate the SCSI LBA, transfer length and FUA. */
1067         switch (scsicmd[0]) {
1068         case READ_10:
1069         case WRITE_10:
1070                 scsi_10_lba_len(scsicmd, &block, &n_block);
1071                 if (unlikely(scsicmd[1] & (1 << 3)))
1072                         tf->flags |= ATA_TFLAG_FUA;
1073                 break;
1074         case READ_6:
1075         case WRITE_6:
1076                 scsi_6_lba_len(scsicmd, &block, &n_block);
1077
1078                 /* for 6-byte r/w commands, transfer length 0
1079                  * means 256 blocks of data, not 0 block.
1080                  */
1081                 if (!n_block)
1082                         n_block = 256;
1083                 break;
1084         case READ_16:
1085         case WRITE_16:
1086                 scsi_16_lba_len(scsicmd, &block, &n_block);
1087                 if (unlikely(scsicmd[1] & (1 << 3)))
1088                         tf->flags |= ATA_TFLAG_FUA;
1089                 break;
1090         default:
1091                 DPRINTK("no-byte command\n");
1092                 goto invalid_fld;
1093         }
1094
1095         /* Check and compose ATA command */
1096         if (!n_block)
1097                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1098                  * length 0 means transfer 0 block of data.
1099                  * However, for ATA R/W commands, sector count 0 means
1100                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
1101                  *
1102                  * WARNING: one or two older ATA drives treat 0 as 0...
1103                  */
1104                 goto nothing_to_do;
1105
1106         if ((dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ) {
1107                 /* yay, NCQ */
1108                 if (!lba_48_ok(block, n_block))
1109                         goto out_of_range;
1110
1111                 tf->protocol = ATA_PROT_NCQ;
1112                 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
1113
1114                 if (tf->flags & ATA_TFLAG_WRITE)
1115                         tf->command = ATA_CMD_FPDMA_WRITE;
1116                 else
1117                         tf->command = ATA_CMD_FPDMA_READ;
1118
1119                 qc->nsect = n_block;
1120
1121                 tf->nsect = qc->tag << 3;
1122                 tf->hob_feature = (n_block >> 8) & 0xff;
1123                 tf->feature = n_block & 0xff;
1124
1125                 tf->hob_lbah = (block >> 40) & 0xff;
1126                 tf->hob_lbam = (block >> 32) & 0xff;
1127                 tf->hob_lbal = (block >> 24) & 0xff;
1128                 tf->lbah = (block >> 16) & 0xff;
1129                 tf->lbam = (block >> 8) & 0xff;
1130                 tf->lbal = block & 0xff;
1131
1132                 tf->device = 1 << 6;
1133                 if (tf->flags & ATA_TFLAG_FUA)
1134                         tf->device |= 1 << 7;
1135         } else if (dev->flags & ATA_DFLAG_LBA) {
1136                 tf->flags |= ATA_TFLAG_LBA;
1137
1138                 if (lba_28_ok(block, n_block)) {
1139                         /* use LBA28 */
1140                         tf->device |= (block >> 24) & 0xf;
1141                 } else if (lba_48_ok(block, n_block)) {
1142                         if (!(dev->flags & ATA_DFLAG_LBA48))
1143                                 goto out_of_range;
1144
1145                         /* use LBA48 */
1146                         tf->flags |= ATA_TFLAG_LBA48;
1147
1148                         tf->hob_nsect = (n_block >> 8) & 0xff;
1149
1150                         tf->hob_lbah = (block >> 40) & 0xff;
1151                         tf->hob_lbam = (block >> 32) & 0xff;
1152                         tf->hob_lbal = (block >> 24) & 0xff;
1153                 } else
1154                         /* request too large even for LBA48 */
1155                         goto out_of_range;
1156
1157                 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1158                         goto invalid_fld;
1159
1160                 qc->nsect = n_block;
1161                 tf->nsect = n_block & 0xff;
1162
1163                 tf->lbah = (block >> 16) & 0xff;
1164                 tf->lbam = (block >> 8) & 0xff;
1165                 tf->lbal = block & 0xff;
1166
1167                 tf->device |= ATA_LBA;
1168         } else {
1169                 /* CHS */
1170                 u32 sect, head, cyl, track;
1171
1172                 /* The request -may- be too large for CHS addressing. */
1173                 if (!lba_28_ok(block, n_block))
1174                         goto out_of_range;
1175
1176                 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1177                         goto invalid_fld;
1178
1179                 /* Convert LBA to CHS */
1180                 track = (u32)block / dev->sectors;
1181                 cyl   = track / dev->heads;
1182                 head  = track % dev->heads;
1183                 sect  = (u32)block % dev->sectors + 1;
1184
1185                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1186                         (u32)block, track, cyl, head, sect);
1187
1188                 /* Check whether the converted CHS can fit.
1189                    Cylinder: 0-65535
1190                    Head: 0-15
1191                    Sector: 1-255*/
1192                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1193                         goto out_of_range;
1194
1195                 qc->nsect = n_block;
1196                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1197                 tf->lbal = sect;
1198                 tf->lbam = cyl;
1199                 tf->lbah = cyl >> 8;
1200                 tf->device |= head;
1201         }
1202
1203         return 0;
1204
1205 invalid_fld:
1206         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1207         /* "Invalid field in cbd" */
1208         return 1;
1209
1210 out_of_range:
1211         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1212         /* "Logical Block Address out of range" */
1213         return 1;
1214
1215 nothing_to_do:
1216         qc->scsicmd->result = SAM_STAT_GOOD;
1217         return 1;
1218 }
1219
1220 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1221 {
1222         struct scsi_cmnd *cmd = qc->scsicmd;
1223         u8 *cdb = cmd->cmnd;
1224         int need_sense = (qc->err_mask != 0);
1225
1226         /* For ATA pass thru (SAT) commands, generate a sense block if
1227          * user mandated it or if there's an error.  Note that if we
1228          * generate because the user forced us to, a check condition
1229          * is generated and the ATA register values are returned
1230          * whether the command completed successfully or not. If there
1231          * was no error, SK, ASC and ASCQ will all be zero.
1232          */
1233         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1234             ((cdb[2] & 0x20) || need_sense)) {
1235                 ata_gen_ata_desc_sense(qc);
1236         } else {
1237                 if (!need_sense) {
1238                         cmd->result = SAM_STAT_GOOD;
1239                 } else {
1240                         /* TODO: decide which descriptor format to use
1241                          * for 48b LBA devices and call that here
1242                          * instead of the fixed desc, which is only
1243                          * good for smaller LBA (and maybe CHS?)
1244                          * devices.
1245                          */
1246                         ata_gen_fixed_sense(qc);
1247                 }
1248         }
1249
1250         if (need_sense && !qc->ap->ops->error_handler)
1251                 ata_dump_status(qc->ap->id, &qc->result_tf);
1252
1253         qc->scsidone(cmd);
1254
1255         ata_qc_free(qc);
1256 }
1257
1258 /**
1259  *      ata_scmd_need_defer - Check whether we need to defer scmd
1260  *      @dev: ATA device to which the command is addressed
1261  *      @is_io: Is the command IO (and thus possibly NCQ)?
1262  *
1263  *      NCQ and non-NCQ commands cannot run together.  As upper layer
1264  *      only knows the queue depth, we are responsible for maintaining
1265  *      exclusion.  This function checks whether a new command can be
1266  *      issued to @dev.
1267  *
1268  *      LOCKING:
1269  *      spin_lock_irqsave(host_set lock)
1270  *
1271  *      RETURNS:
1272  *      1 if deferring is needed, 0 otherwise.
1273  */
1274 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1275 {
1276         struct ata_port *ap = dev->ap;
1277
1278         if (!(dev->flags & ATA_DFLAG_NCQ))
1279                 return 0;
1280
1281         if (is_io) {
1282                 if (!ata_tag_valid(ap->active_tag))
1283                         return 0;
1284         } else {
1285                 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1286                         return 0;
1287         }
1288         return 1;
1289 }
1290
1291 /**
1292  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1293  *      @dev: ATA device to which the command is addressed
1294  *      @cmd: SCSI command to execute
1295  *      @done: SCSI command completion function
1296  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1297  *
1298  *      Our ->queuecommand() function has decided that the SCSI
1299  *      command issued can be directly translated into an ATA
1300  *      command, rather than handled internally.
1301  *
1302  *      This function sets up an ata_queued_cmd structure for the
1303  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1304  *
1305  *      The xlat_func argument (actor) returns 0 if ready to execute
1306  *      ATA command, else 1 to finish translation. If 1 is returned
1307  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1308  *      to be set reflecting an error condition or clean (early)
1309  *      termination.
1310  *
1311  *      LOCKING:
1312  *      spin_lock_irqsave(host_set lock)
1313  *
1314  *      RETURNS:
1315  *      0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1316  *      needs to be deferred.
1317  */
1318 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1319                               void (*done)(struct scsi_cmnd *),
1320                               ata_xlat_func_t xlat_func)
1321 {
1322         struct ata_queued_cmd *qc;
1323         u8 *scsicmd = cmd->cmnd;
1324         int is_io = xlat_func == ata_scsi_rw_xlat;
1325
1326         VPRINTK("ENTER\n");
1327
1328         if (unlikely(ata_scmd_need_defer(dev, is_io)))
1329                 goto defer;
1330
1331         qc = ata_scsi_qc_new(dev, cmd, done);
1332         if (!qc)
1333                 goto err_mem;
1334
1335         /* data is present; dma-map it */
1336         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1337             cmd->sc_data_direction == DMA_TO_DEVICE) {
1338                 if (unlikely(cmd->request_bufflen < 1)) {
1339                         ata_dev_printk(dev, KERN_WARNING,
1340                                        "WARNING: zero len r/w req\n");
1341                         goto err_did;
1342                 }
1343
1344                 if (cmd->use_sg)
1345                         ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1346                 else
1347                         ata_sg_init_one(qc, cmd->request_buffer,
1348                                         cmd->request_bufflen);
1349
1350                 qc->dma_dir = cmd->sc_data_direction;
1351         }
1352
1353         qc->complete_fn = ata_scsi_qc_complete;
1354
1355         if (xlat_func(qc, scsicmd))
1356                 goto early_finish;
1357
1358         /* select device, send command to hardware */
1359         ata_qc_issue(qc);
1360
1361         VPRINTK("EXIT\n");
1362         return 0;
1363
1364 early_finish:
1365         ata_qc_free(qc);
1366         done(cmd);
1367         DPRINTK("EXIT - early finish (good or error)\n");
1368         return 0;
1369
1370 err_did:
1371         ata_qc_free(qc);
1372 err_mem:
1373         cmd->result = (DID_ERROR << 16);
1374         done(cmd);
1375         DPRINTK("EXIT - internal\n");
1376         return 0;
1377
1378 defer:
1379         DPRINTK("EXIT - defer\n");
1380         return SCSI_MLQUEUE_DEVICE_BUSY;
1381 }
1382
1383 /**
1384  *      ata_scsi_rbuf_get - Map response buffer.
1385  *      @cmd: SCSI command containing buffer to be mapped.
1386  *      @buf_out: Pointer to mapped area.
1387  *
1388  *      Maps buffer contained within SCSI command @cmd.
1389  *
1390  *      LOCKING:
1391  *      spin_lock_irqsave(host_set lock)
1392  *
1393  *      RETURNS:
1394  *      Length of response buffer.
1395  */
1396
1397 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1398 {
1399         u8 *buf;
1400         unsigned int buflen;
1401
1402         if (cmd->use_sg) {
1403                 struct scatterlist *sg;
1404
1405                 sg = (struct scatterlist *) cmd->request_buffer;
1406                 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1407                 buflen = sg->length;
1408         } else {
1409                 buf = cmd->request_buffer;
1410                 buflen = cmd->request_bufflen;
1411         }
1412
1413         *buf_out = buf;
1414         return buflen;
1415 }
1416
1417 /**
1418  *      ata_scsi_rbuf_put - Unmap response buffer.
1419  *      @cmd: SCSI command containing buffer to be unmapped.
1420  *      @buf: buffer to unmap
1421  *
1422  *      Unmaps response buffer contained within @cmd.
1423  *
1424  *      LOCKING:
1425  *      spin_lock_irqsave(host_set lock)
1426  */
1427
1428 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1429 {
1430         if (cmd->use_sg) {
1431                 struct scatterlist *sg;
1432
1433                 sg = (struct scatterlist *) cmd->request_buffer;
1434                 kunmap_atomic(buf - sg->offset, KM_USER0);
1435         }
1436 }
1437
1438 /**
1439  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1440  *      @args: device IDENTIFY data / SCSI command of interest.
1441  *      @actor: Callback hook for desired SCSI command simulator
1442  *
1443  *      Takes care of the hard work of simulating a SCSI command...
1444  *      Mapping the response buffer, calling the command's handler,
1445  *      and handling the handler's return value.  This return value
1446  *      indicates whether the handler wishes the SCSI command to be
1447  *      completed successfully (0), or not (in which case cmd->result
1448  *      and sense buffer are assumed to be set).
1449  *
1450  *      LOCKING:
1451  *      spin_lock_irqsave(host_set lock)
1452  */
1453
1454 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1455                         unsigned int (*actor) (struct ata_scsi_args *args,
1456                                            u8 *rbuf, unsigned int buflen))
1457 {
1458         u8 *rbuf;
1459         unsigned int buflen, rc;
1460         struct scsi_cmnd *cmd = args->cmd;
1461
1462         buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1463         memset(rbuf, 0, buflen);
1464         rc = actor(args, rbuf, buflen);
1465         ata_scsi_rbuf_put(cmd, rbuf);
1466
1467         if (rc == 0)
1468                 cmd->result = SAM_STAT_GOOD;
1469         args->done(cmd);
1470 }
1471
1472 /**
1473  *      ata_scsiop_inq_std - Simulate INQUIRY command
1474  *      @args: device IDENTIFY data / SCSI command of interest.
1475  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1476  *      @buflen: Response buffer length.
1477  *
1478  *      Returns standard device identification data associated
1479  *      with non-VPD INQUIRY command output.
1480  *
1481  *      LOCKING:
1482  *      spin_lock_irqsave(host_set lock)
1483  */
1484
1485 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1486                                unsigned int buflen)
1487 {
1488         u8 hdr[] = {
1489                 TYPE_DISK,
1490                 0,
1491                 0x5,    /* claim SPC-3 version compatibility */
1492                 2,
1493                 95 - 4
1494         };
1495
1496         /* set scsi removeable (RMB) bit per ata bit */
1497         if (ata_id_removeable(args->id))
1498                 hdr[1] |= (1 << 7);
1499
1500         VPRINTK("ENTER\n");
1501
1502         memcpy(rbuf, hdr, sizeof(hdr));
1503
1504         if (buflen > 35) {
1505                 memcpy(&rbuf[8], "ATA     ", 8);
1506                 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1507                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1508                 if (rbuf[32] == 0 || rbuf[32] == ' ')
1509                         memcpy(&rbuf[32], "n/a ", 4);
1510         }
1511
1512         if (buflen > 63) {
1513                 const u8 versions[] = {
1514                         0x60,   /* SAM-3 (no version claimed) */
1515
1516                         0x03,
1517                         0x20,   /* SBC-2 (no version claimed) */
1518
1519                         0x02,
1520                         0x60    /* SPC-3 (no version claimed) */
1521                 };
1522
1523                 memcpy(rbuf + 59, versions, sizeof(versions));
1524         }
1525
1526         return 0;
1527 }
1528
1529 /**
1530  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1531  *      @args: device IDENTIFY data / SCSI command of interest.
1532  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1533  *      @buflen: Response buffer length.
1534  *
1535  *      Returns list of inquiry VPD pages available.
1536  *
1537  *      LOCKING:
1538  *      spin_lock_irqsave(host_set lock)
1539  */
1540
1541 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1542                               unsigned int buflen)
1543 {
1544         const u8 pages[] = {
1545                 0x00,   /* page 0x00, this page */
1546                 0x80,   /* page 0x80, unit serial no page */
1547                 0x83    /* page 0x83, device ident page */
1548         };
1549         rbuf[3] = sizeof(pages);        /* number of supported VPD pages */
1550
1551         if (buflen > 6)
1552                 memcpy(rbuf + 4, pages, sizeof(pages));
1553
1554         return 0;
1555 }
1556
1557 /**
1558  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1559  *      @args: device IDENTIFY data / SCSI command of interest.
1560  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1561  *      @buflen: Response buffer length.
1562  *
1563  *      Returns ATA device serial number.
1564  *
1565  *      LOCKING:
1566  *      spin_lock_irqsave(host_set lock)
1567  */
1568
1569 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1570                               unsigned int buflen)
1571 {
1572         const u8 hdr[] = {
1573                 0,
1574                 0x80,                   /* this page code */
1575                 0,
1576                 ATA_SERNO_LEN,          /* page len */
1577         };
1578         memcpy(rbuf, hdr, sizeof(hdr));
1579
1580         if (buflen > (ATA_SERNO_LEN + 4 - 1))
1581                 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1582                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1583
1584         return 0;
1585 }
1586
1587 /**
1588  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1589  *      @args: device IDENTIFY data / SCSI command of interest.
1590  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1591  *      @buflen: Response buffer length.
1592  *
1593  *      Yields two logical unit device identification designators:
1594  *       - vendor specific ASCII containing the ATA serial number
1595  *       - SAT defined "t10 vendor id based" containing ASCII vendor
1596  *         name ("ATA     "), model and serial numbers.
1597  *
1598  *      LOCKING:
1599  *      spin_lock_irqsave(host_set lock)
1600  */
1601
1602 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1603                               unsigned int buflen)
1604 {
1605         int num;
1606         const int sat_model_serial_desc_len = 68;
1607         const int ata_model_byte_len = 40;
1608
1609         rbuf[1] = 0x83;                 /* this page code */
1610         num = 4;
1611
1612         if (buflen > (ATA_SERNO_LEN + num + 3)) {
1613                 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1614                 rbuf[num + 0] = 2;
1615                 rbuf[num + 3] = ATA_SERNO_LEN;
1616                 num += 4;
1617                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1618                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1619                 num += ATA_SERNO_LEN;
1620         }
1621         if (buflen > (sat_model_serial_desc_len + num + 3)) {
1622                 /* SAT defined lu model and serial numbers descriptor */
1623                 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1624                 rbuf[num + 0] = 2;
1625                 rbuf[num + 1] = 1;
1626                 rbuf[num + 3] = sat_model_serial_desc_len;
1627                 num += 4;
1628                 memcpy(rbuf + num, "ATA     ", 8);
1629                 num += 8;
1630                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1631                               ATA_ID_PROD_OFS, ata_model_byte_len);
1632                 num += ata_model_byte_len;
1633                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1634                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1635                 num += ATA_SERNO_LEN;
1636         }
1637         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
1638         return 0;
1639 }
1640
1641 /**
1642  *      ata_scsiop_noop - Command handler that simply returns success.
1643  *      @args: device IDENTIFY data / SCSI command of interest.
1644  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1645  *      @buflen: Response buffer length.
1646  *
1647  *      No operation.  Simply returns success to caller, to indicate
1648  *      that the caller should successfully complete this SCSI command.
1649  *
1650  *      LOCKING:
1651  *      spin_lock_irqsave(host_set lock)
1652  */
1653
1654 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1655                             unsigned int buflen)
1656 {
1657         VPRINTK("ENTER\n");
1658         return 0;
1659 }
1660
1661 /**
1662  *      ata_msense_push - Push data onto MODE SENSE data output buffer
1663  *      @ptr_io: (input/output) Location to store more output data
1664  *      @last: End of output data buffer
1665  *      @buf: Pointer to BLOB being added to output buffer
1666  *      @buflen: Length of BLOB
1667  *
1668  *      Store MODE SENSE data on an output buffer.
1669  *
1670  *      LOCKING:
1671  *      None.
1672  */
1673
1674 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1675                             const u8 *buf, unsigned int buflen)
1676 {
1677         u8 *ptr = *ptr_io;
1678
1679         if ((ptr + buflen - 1) > last)
1680                 return;
1681
1682         memcpy(ptr, buf, buflen);
1683
1684         ptr += buflen;
1685
1686         *ptr_io = ptr;
1687 }
1688
1689 /**
1690  *      ata_msense_caching - Simulate MODE SENSE caching info page
1691  *      @id: device IDENTIFY data
1692  *      @ptr_io: (input/output) Location to store more output data
1693  *      @last: End of output data buffer
1694  *
1695  *      Generate a caching info page, which conditionally indicates
1696  *      write caching to the SCSI layer, depending on device
1697  *      capabilities.
1698  *
1699  *      LOCKING:
1700  *      None.
1701  */
1702
1703 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1704                                        const u8 *last)
1705 {
1706         u8 page[CACHE_MPAGE_LEN];
1707
1708         memcpy(page, def_cache_mpage, sizeof(page));
1709         if (ata_id_wcache_enabled(id))
1710                 page[2] |= (1 << 2);    /* write cache enable */
1711         if (!ata_id_rahead_enabled(id))
1712                 page[12] |= (1 << 5);   /* disable read ahead */
1713
1714         ata_msense_push(ptr_io, last, page, sizeof(page));
1715         return sizeof(page);
1716 }
1717
1718 /**
1719  *      ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1720  *      @dev: Device associated with this MODE SENSE command
1721  *      @ptr_io: (input/output) Location to store more output data
1722  *      @last: End of output data buffer
1723  *
1724  *      Generate a generic MODE SENSE control mode page.
1725  *
1726  *      LOCKING:
1727  *      None.
1728  */
1729
1730 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1731 {
1732         ata_msense_push(ptr_io, last, def_control_mpage,
1733                         sizeof(def_control_mpage));
1734         return sizeof(def_control_mpage);
1735 }
1736
1737 /**
1738  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1739  *      @dev: Device associated with this MODE SENSE command
1740  *      @ptr_io: (input/output) Location to store more output data
1741  *      @last: End of output data buffer
1742  *
1743  *      Generate a generic MODE SENSE r/w error recovery page.
1744  *
1745  *      LOCKING:
1746  *      None.
1747  */
1748
1749 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1750 {
1751
1752         ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1753                         sizeof(def_rw_recovery_mpage));
1754         return sizeof(def_rw_recovery_mpage);
1755 }
1756
1757 /*
1758  * We can turn this into a real blacklist if it's needed, for now just
1759  * blacklist any Maxtor BANC1G10 revision firmware
1760  */
1761 static int ata_dev_supports_fua(u16 *id)
1762 {
1763         unsigned char model[41], fw[9];
1764
1765         if (!libata_fua)
1766                 return 0;
1767         if (!ata_id_has_fua(id))
1768                 return 0;
1769
1770         ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1771         ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1772
1773         if (strcmp(model, "Maxtor"))
1774                 return 1;
1775         if (strcmp(fw, "BANC1G10"))
1776                 return 1;
1777
1778         return 0; /* blacklisted */
1779 }
1780
1781 /**
1782  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1783  *      @args: device IDENTIFY data / SCSI command of interest.
1784  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1785  *      @buflen: Response buffer length.
1786  *
1787  *      Simulate MODE SENSE commands. Assume this is invoked for direct
1788  *      access devices (e.g. disks) only. There should be no block
1789  *      descriptor for other device types.
1790  *
1791  *      LOCKING:
1792  *      spin_lock_irqsave(host_set lock)
1793  */
1794
1795 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1796                                   unsigned int buflen)
1797 {
1798         struct ata_device *dev = args->dev;
1799         u8 *scsicmd = args->cmd->cmnd, *p, *last;
1800         const u8 sat_blk_desc[] = {
1801                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
1802                 0,
1803                 0, 0x2, 0x0     /* block length: 512 bytes */
1804         };
1805         u8 pg, spg;
1806         unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1807         u8 dpofua;
1808
1809         VPRINTK("ENTER\n");
1810
1811         six_byte = (scsicmd[0] == MODE_SENSE);
1812         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
1813         /*
1814          * LLBA bit in msense(10) ignored (compliant)
1815          */
1816
1817         page_control = scsicmd[2] >> 6;
1818         switch (page_control) {
1819         case 0: /* current */
1820                 break;  /* supported */
1821         case 3: /* saved */
1822                 goto saving_not_supp;
1823         case 1: /* changeable */
1824         case 2: /* defaults */
1825         default:
1826                 goto invalid_fld;
1827         }
1828
1829         if (six_byte) {
1830                 output_len = 4 + (ebd ? 8 : 0);
1831                 alloc_len = scsicmd[4];
1832         } else {
1833                 output_len = 8 + (ebd ? 8 : 0);
1834                 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1835         }
1836         minlen = (alloc_len < buflen) ? alloc_len : buflen;
1837
1838         p = rbuf + output_len;
1839         last = rbuf + minlen - 1;
1840
1841         pg = scsicmd[2] & 0x3f;
1842         spg = scsicmd[3];
1843         /*
1844          * No mode subpages supported (yet) but asking for _all_
1845          * subpages may be valid
1846          */
1847         if (spg && (spg != ALL_SUB_MPAGES))
1848                 goto invalid_fld;
1849
1850         switch(pg) {
1851         case RW_RECOVERY_MPAGE:
1852                 output_len += ata_msense_rw_recovery(&p, last);
1853                 break;
1854
1855         case CACHE_MPAGE:
1856                 output_len += ata_msense_caching(args->id, &p, last);
1857                 break;
1858
1859         case CONTROL_MPAGE: {
1860                 output_len += ata_msense_ctl_mode(&p, last);
1861                 break;
1862                 }
1863
1864         case ALL_MPAGES:
1865                 output_len += ata_msense_rw_recovery(&p, last);
1866                 output_len += ata_msense_caching(args->id, &p, last);
1867                 output_len += ata_msense_ctl_mode(&p, last);
1868                 break;
1869
1870         default:                /* invalid page code */
1871                 goto invalid_fld;
1872         }
1873
1874         if (minlen < 1)
1875                 return 0;
1876
1877         dpofua = 0;
1878         if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1879             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1880                 dpofua = 1 << 4;
1881
1882         if (six_byte) {
1883                 output_len--;
1884                 rbuf[0] = output_len;
1885                 if (minlen > 2)
1886                         rbuf[2] |= dpofua;
1887                 if (ebd) {
1888                         if (minlen > 3)
1889                                 rbuf[3] = sizeof(sat_blk_desc);
1890                         if (minlen > 11)
1891                                 memcpy(rbuf + 4, sat_blk_desc,
1892                                        sizeof(sat_blk_desc));
1893                 }
1894         } else {
1895                 output_len -= 2;
1896                 rbuf[0] = output_len >> 8;
1897                 if (minlen > 1)
1898                         rbuf[1] = output_len;
1899                 if (minlen > 3)
1900                         rbuf[3] |= dpofua;
1901                 if (ebd) {
1902                         if (minlen > 7)
1903                                 rbuf[7] = sizeof(sat_blk_desc);
1904                         if (minlen > 15)
1905                                 memcpy(rbuf + 8, sat_blk_desc,
1906                                        sizeof(sat_blk_desc));
1907                 }
1908         }
1909         return 0;
1910
1911 invalid_fld:
1912         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1913         /* "Invalid field in cbd" */
1914         return 1;
1915
1916 saving_not_supp:
1917         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1918          /* "Saving parameters not supported" */
1919         return 1;
1920 }
1921
1922 /**
1923  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1924  *      @args: device IDENTIFY data / SCSI command of interest.
1925  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1926  *      @buflen: Response buffer length.
1927  *
1928  *      Simulate READ CAPACITY commands.
1929  *
1930  *      LOCKING:
1931  *      spin_lock_irqsave(host_set lock)
1932  */
1933
1934 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1935                                 unsigned int buflen)
1936 {
1937         u64 n_sectors;
1938         u32 tmp;
1939
1940         VPRINTK("ENTER\n");
1941
1942         if (ata_id_has_lba(args->id)) {
1943                 if (ata_id_has_lba48(args->id))
1944                         n_sectors = ata_id_u64(args->id, 100);
1945                 else
1946                         n_sectors = ata_id_u32(args->id, 60);
1947         } else {
1948                 /* CHS default translation */
1949                 n_sectors = args->id[1] * args->id[3] * args->id[6];
1950
1951                 if (ata_id_current_chs_valid(args->id))
1952                         /* CHS current translation */
1953                         n_sectors = ata_id_u32(args->id, 57);
1954         }
1955
1956         n_sectors--;            /* ATA TotalUserSectors - 1 */
1957
1958         if (args->cmd->cmnd[0] == READ_CAPACITY) {
1959                 if( n_sectors >= 0xffffffffULL )
1960                         tmp = 0xffffffff ;  /* Return max count on overflow */
1961                 else
1962                         tmp = n_sectors ;
1963
1964                 /* sector count, 32-bit */
1965                 rbuf[0] = tmp >> (8 * 3);
1966                 rbuf[1] = tmp >> (8 * 2);
1967                 rbuf[2] = tmp >> (8 * 1);
1968                 rbuf[3] = tmp;
1969
1970                 /* sector size */
1971                 tmp = ATA_SECT_SIZE;
1972                 rbuf[6] = tmp >> 8;
1973                 rbuf[7] = tmp;
1974
1975         } else {
1976                 /* sector count, 64-bit */
1977                 tmp = n_sectors >> (8 * 4);
1978                 rbuf[2] = tmp >> (8 * 3);
1979                 rbuf[3] = tmp >> (8 * 2);
1980                 rbuf[4] = tmp >> (8 * 1);
1981                 rbuf[5] = tmp;
1982                 tmp = n_sectors;
1983                 rbuf[6] = tmp >> (8 * 3);
1984                 rbuf[7] = tmp >> (8 * 2);
1985                 rbuf[8] = tmp >> (8 * 1);
1986                 rbuf[9] = tmp;
1987
1988                 /* sector size */
1989                 tmp = ATA_SECT_SIZE;
1990                 rbuf[12] = tmp >> 8;
1991                 rbuf[13] = tmp;
1992         }
1993
1994         return 0;
1995 }
1996
1997 /**
1998  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
1999  *      @args: device IDENTIFY data / SCSI command of interest.
2000  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2001  *      @buflen: Response buffer length.
2002  *
2003  *      Simulate REPORT LUNS command.
2004  *
2005  *      LOCKING:
2006  *      spin_lock_irqsave(host_set lock)
2007  */
2008
2009 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2010                                    unsigned int buflen)
2011 {
2012         VPRINTK("ENTER\n");
2013         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2014
2015         return 0;
2016 }
2017
2018 /**
2019  *      ata_scsi_set_sense - Set SCSI sense data and status
2020  *      @cmd: SCSI request to be handled
2021  *      @sk: SCSI-defined sense key
2022  *      @asc: SCSI-defined additional sense code
2023  *      @ascq: SCSI-defined additional sense code qualifier
2024  *
2025  *      Helper function that builds a valid fixed format, current
2026  *      response code and the given sense key (sk), additional sense
2027  *      code (asc) and additional sense code qualifier (ascq) with
2028  *      a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2029  *      DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2030  *
2031  *      LOCKING:
2032  *      Not required
2033  */
2034
2035 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2036 {
2037         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2038
2039         cmd->sense_buffer[0] = 0x70;    /* fixed format, current */
2040         cmd->sense_buffer[2] = sk;
2041         cmd->sense_buffer[7] = 18 - 8;  /* additional sense length */
2042         cmd->sense_buffer[12] = asc;
2043         cmd->sense_buffer[13] = ascq;
2044 }
2045
2046 /**
2047  *      ata_scsi_badcmd - End a SCSI request with an error
2048  *      @cmd: SCSI request to be handled
2049  *      @done: SCSI command completion function
2050  *      @asc: SCSI-defined additional sense code
2051  *      @ascq: SCSI-defined additional sense code qualifier
2052  *
2053  *      Helper function that completes a SCSI command with
2054  *      %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2055  *      and the specified additional sense codes.
2056  *
2057  *      LOCKING:
2058  *      spin_lock_irqsave(host_set lock)
2059  */
2060
2061 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2062 {
2063         DPRINTK("ENTER\n");
2064         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2065
2066         done(cmd);
2067 }
2068
2069 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2070 {
2071         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2072                 /* FIXME: not quite right; we don't want the
2073                  * translation of taskfile registers into
2074                  * a sense descriptors, since that's only
2075                  * correct for ATA, not ATAPI
2076                  */
2077                 ata_gen_ata_desc_sense(qc);
2078         }
2079
2080         qc->scsidone(qc->scsicmd);
2081         ata_qc_free(qc);
2082 }
2083
2084 /* is it pointless to prefer PIO for "safety reasons"? */
2085 static inline int ata_pio_use_silly(struct ata_port *ap)
2086 {
2087         return (ap->flags & ATA_FLAG_PIO_DMA);
2088 }
2089
2090 static void atapi_request_sense(struct ata_queued_cmd *qc)
2091 {
2092         struct ata_port *ap = qc->ap;
2093         struct scsi_cmnd *cmd = qc->scsicmd;
2094
2095         DPRINTK("ATAPI request sense\n");
2096
2097         /* FIXME: is this needed? */
2098         memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2099
2100         ap->ops->tf_read(ap, &qc->tf);
2101
2102         /* fill these in, for the case where they are -not- overwritten */
2103         cmd->sense_buffer[0] = 0x70;
2104         cmd->sense_buffer[2] = qc->tf.feature >> 4;
2105
2106         ata_qc_reinit(qc);
2107
2108         ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2109         qc->dma_dir = DMA_FROM_DEVICE;
2110
2111         memset(&qc->cdb, 0, qc->dev->cdb_len);
2112         qc->cdb[0] = REQUEST_SENSE;
2113         qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2114
2115         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2116         qc->tf.command = ATA_CMD_PACKET;
2117
2118         if (ata_pio_use_silly(ap)) {
2119                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2120                 qc->tf.feature |= ATAPI_PKT_DMA;
2121         } else {
2122                 qc->tf.protocol = ATA_PROT_ATAPI;
2123                 qc->tf.lbam = (8 * 1024) & 0xff;
2124                 qc->tf.lbah = (8 * 1024) >> 8;
2125         }
2126         qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2127
2128         qc->complete_fn = atapi_sense_complete;
2129
2130         ata_qc_issue(qc);
2131
2132         DPRINTK("EXIT\n");
2133 }
2134
2135 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2136 {
2137         struct scsi_cmnd *cmd = qc->scsicmd;
2138         unsigned int err_mask = qc->err_mask;
2139
2140         VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2141
2142         /* handle completion from new EH */
2143         if (unlikely(qc->ap->ops->error_handler &&
2144                      (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2145
2146                 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2147                         /* FIXME: not quite right; we don't want the
2148                          * translation of taskfile registers into a
2149                          * sense descriptors, since that's only
2150                          * correct for ATA, not ATAPI
2151                          */
2152                         ata_gen_ata_desc_sense(qc);
2153                 }
2154
2155                 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2156                 qc->scsidone(cmd);
2157                 ata_qc_free(qc);
2158                 return;
2159         }
2160
2161         /* successful completion or old EH failure path */
2162         if (unlikely(err_mask & AC_ERR_DEV)) {
2163                 cmd->result = SAM_STAT_CHECK_CONDITION;
2164                 atapi_request_sense(qc);
2165                 return;
2166         } else if (unlikely(err_mask)) {
2167                 /* FIXME: not quite right; we don't want the
2168                  * translation of taskfile registers into
2169                  * a sense descriptors, since that's only
2170                  * correct for ATA, not ATAPI
2171                  */
2172                 ata_gen_ata_desc_sense(qc);
2173         } else {
2174                 u8 *scsicmd = cmd->cmnd;
2175
2176                 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2177                         u8 *buf = NULL;
2178                         unsigned int buflen;
2179
2180                         buflen = ata_scsi_rbuf_get(cmd, &buf);
2181
2182         /* ATAPI devices typically report zero for their SCSI version,
2183          * and sometimes deviate from the spec WRT response data
2184          * format.  If SCSI version is reported as zero like normal,
2185          * then we make the following fixups:  1) Fake MMC-5 version,
2186          * to indicate to the Linux scsi midlayer this is a modern
2187          * device.  2) Ensure response data format / ATAPI information
2188          * are always correct.
2189          */
2190                         if (buf[2] == 0) {
2191                                 buf[2] = 0x5;
2192                                 buf[3] = 0x32;
2193                         }
2194
2195                         ata_scsi_rbuf_put(cmd, buf);
2196                 }
2197
2198                 cmd->result = SAM_STAT_GOOD;
2199         }
2200
2201         qc->scsidone(cmd);
2202         ata_qc_free(qc);
2203 }
2204 /**
2205  *      atapi_xlat - Initialize PACKET taskfile
2206  *      @qc: command structure to be initialized
2207  *      @scsicmd: SCSI CDB associated with this PACKET command
2208  *
2209  *      LOCKING:
2210  *      spin_lock_irqsave(host_set lock)
2211  *
2212  *      RETURNS:
2213  *      Zero on success, non-zero on failure.
2214  */
2215
2216 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2217 {
2218         struct scsi_cmnd *cmd = qc->scsicmd;
2219         struct ata_device *dev = qc->dev;
2220         int using_pio = (dev->flags & ATA_DFLAG_PIO);
2221         int nodata = (cmd->sc_data_direction == DMA_NONE);
2222
2223         if (!using_pio)
2224                 /* Check whether ATAPI DMA is safe */
2225                 if (ata_check_atapi_dma(qc))
2226                         using_pio = 1;
2227
2228         memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2229
2230         qc->complete_fn = atapi_qc_complete;
2231
2232         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2233         if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2234                 qc->tf.flags |= ATA_TFLAG_WRITE;
2235                 DPRINTK("direction: write\n");
2236         }
2237
2238         qc->tf.command = ATA_CMD_PACKET;
2239
2240         /* no data, or PIO data xfer */
2241         if (using_pio || nodata) {
2242                 if (nodata)
2243                         qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2244                 else
2245                         qc->tf.protocol = ATA_PROT_ATAPI;
2246                 qc->tf.lbam = (8 * 1024) & 0xff;
2247                 qc->tf.lbah = (8 * 1024) >> 8;
2248         }
2249
2250         /* DMA data xfer */
2251         else {
2252                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2253                 qc->tf.feature |= ATAPI_PKT_DMA;
2254
2255                 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2256                         /* some SATA bridges need us to indicate data xfer direction */
2257                         qc->tf.feature |= ATAPI_DMADIR;
2258         }
2259
2260         qc->nbytes = cmd->bufflen;
2261
2262         return 0;
2263 }
2264
2265 /**
2266  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2267  *      @ap: ATA port to which the device is attached
2268  *      @scsidev: SCSI device from which we derive the ATA device
2269  *
2270  *      Given various information provided in struct scsi_cmnd,
2271  *      map that onto an ATA bus, and using that mapping
2272  *      determine which ata_device is associated with the
2273  *      SCSI command to be sent.
2274  *
2275  *      LOCKING:
2276  *      spin_lock_irqsave(host_set lock)
2277  *
2278  *      RETURNS:
2279  *      Associated ATA device, or %NULL if not found.
2280  */
2281
2282 static struct ata_device *
2283 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2284 {
2285         struct ata_device *dev;
2286
2287         /* skip commands not addressed to targets we simulate */
2288         if (likely(scsidev->id < ATA_MAX_DEVICES))
2289                 dev = &ap->device[scsidev->id];
2290         else
2291                 return NULL;
2292
2293         if (unlikely((scsidev->channel != 0) ||
2294                      (scsidev->lun != 0)))
2295                 return NULL;
2296
2297         if (unlikely(!ata_dev_enabled(dev)))
2298                 return NULL;
2299
2300         if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2301                 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2302                         ata_dev_printk(dev, KERN_WARNING,
2303                                 "WARNING: ATAPI is %s, device ignored.\n",
2304                                 atapi_enabled ? "not supported with this driver" : "disabled");
2305                         return NULL;
2306                 }
2307         }
2308
2309         return dev;
2310 }
2311
2312 /*
2313  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2314  *      @byte1: Byte 1 from pass-thru CDB.
2315  *
2316  *      RETURNS:
2317  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2318  */
2319 static u8
2320 ata_scsi_map_proto(u8 byte1)
2321 {
2322         switch((byte1 & 0x1e) >> 1) {
2323                 case 3:         /* Non-data */
2324                         return ATA_PROT_NODATA;
2325
2326                 case 6:         /* DMA */
2327                         return ATA_PROT_DMA;
2328
2329                 case 4:         /* PIO Data-in */
2330                 case 5:         /* PIO Data-out */
2331                         return ATA_PROT_PIO;
2332
2333                 case 10:        /* Device Reset */
2334                 case 0:         /* Hard Reset */
2335                 case 1:         /* SRST */
2336                 case 2:         /* Bus Idle */
2337                 case 7:         /* Packet */
2338                 case 8:         /* DMA Queued */
2339                 case 9:         /* Device Diagnostic */
2340                 case 11:        /* UDMA Data-in */
2341                 case 12:        /* UDMA Data-Out */
2342                 case 13:        /* FPDMA */
2343                 default:        /* Reserved */
2344                         break;
2345         }
2346
2347         return ATA_PROT_UNKNOWN;
2348 }
2349
2350 /**
2351  *      ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2352  *      @qc: command structure to be initialized
2353  *      @scsicmd: SCSI command to convert
2354  *
2355  *      Handles either 12 or 16-byte versions of the CDB.
2356  *
2357  *      RETURNS:
2358  *      Zero on success, non-zero on failure.
2359  */
2360 static unsigned int
2361 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2362 {
2363         struct ata_taskfile *tf = &(qc->tf);
2364         struct scsi_cmnd *cmd = qc->scsicmd;
2365
2366         if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2367                 goto invalid_fld;
2368
2369         if (scsicmd[1] & 0xe0)
2370                 /* PIO multi not supported yet */
2371                 goto invalid_fld;
2372
2373         /*
2374          * 12 and 16 byte CDBs use different offsets to
2375          * provide the various register values.
2376          */
2377         if (scsicmd[0] == ATA_16) {
2378                 /*
2379                  * 16-byte CDB - may contain extended commands.
2380                  *
2381                  * If that is the case, copy the upper byte register values.
2382                  */
2383                 if (scsicmd[1] & 0x01) {
2384                         tf->hob_feature = scsicmd[3];
2385                         tf->hob_nsect = scsicmd[5];
2386                         tf->hob_lbal = scsicmd[7];
2387                         tf->hob_lbam = scsicmd[9];
2388                         tf->hob_lbah = scsicmd[11];
2389                         tf->flags |= ATA_TFLAG_LBA48;
2390                 } else
2391                         tf->flags &= ~ATA_TFLAG_LBA48;
2392
2393                 /*
2394                  * Always copy low byte, device and command registers.
2395                  */
2396                 tf->feature = scsicmd[4];
2397                 tf->nsect = scsicmd[6];
2398                 tf->lbal = scsicmd[8];
2399                 tf->lbam = scsicmd[10];
2400                 tf->lbah = scsicmd[12];
2401                 tf->device = scsicmd[13];
2402                 tf->command = scsicmd[14];
2403         } else {
2404                 /*
2405                  * 12-byte CDB - incapable of extended commands.
2406                  */
2407                 tf->flags &= ~ATA_TFLAG_LBA48;
2408
2409                 tf->feature = scsicmd[3];
2410                 tf->nsect = scsicmd[4];
2411                 tf->lbal = scsicmd[5];
2412                 tf->lbam = scsicmd[6];
2413                 tf->lbah = scsicmd[7];
2414                 tf->device = scsicmd[8];
2415                 tf->command = scsicmd[9];
2416         }
2417         /*
2418          * If slave is possible, enforce correct master/slave bit
2419         */
2420         if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2421                 tf->device = qc->dev->devno ?
2422                         tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2423
2424         /*
2425          * Filter SET_FEATURES - XFER MODE command -- otherwise,
2426          * SET_FEATURES - XFER MODE must be preceded/succeeded
2427          * by an update to hardware-specific registers for each
2428          * controller (i.e. the reason for ->set_piomode(),
2429          * ->set_dmamode(), and ->post_set_mode() hooks).
2430          */
2431         if ((tf->command == ATA_CMD_SET_FEATURES)
2432          && (tf->feature == SETFEATURES_XFER))
2433                 goto invalid_fld;
2434
2435         /*
2436          * Set flags so that all registers will be written,
2437          * and pass on write indication (used for PIO/DMA
2438          * setup.)
2439          */
2440         tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2441
2442         if (cmd->sc_data_direction == DMA_TO_DEVICE)
2443                 tf->flags |= ATA_TFLAG_WRITE;
2444
2445         /*
2446          * Set transfer length.
2447          *
2448          * TODO: find out if we need to do more here to
2449          *       cover scatter/gather case.
2450          */
2451         qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2452
2453         /* request result TF */
2454         qc->flags |= ATA_QCFLAG_RESULT_TF;
2455
2456         return 0;
2457
2458  invalid_fld:
2459         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2460         /* "Invalid field in cdb" */
2461         return 1;
2462 }
2463
2464 /**
2465  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
2466  *      @dev: ATA device
2467  *      @cmd: SCSI command opcode to consider
2468  *
2469  *      Look up the SCSI command given, and determine whether the
2470  *      SCSI command is to be translated or simulated.
2471  *
2472  *      RETURNS:
2473  *      Pointer to translation function if possible, %NULL if not.
2474  */
2475
2476 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2477 {
2478         switch (cmd) {
2479         case READ_6:
2480         case READ_10:
2481         case READ_16:
2482
2483         case WRITE_6:
2484         case WRITE_10:
2485         case WRITE_16:
2486                 return ata_scsi_rw_xlat;
2487
2488         case SYNCHRONIZE_CACHE:
2489                 if (ata_try_flush_cache(dev))
2490                         return ata_scsi_flush_xlat;
2491                 break;
2492
2493         case VERIFY:
2494         case VERIFY_16:
2495                 return ata_scsi_verify_xlat;
2496
2497         case ATA_12:
2498         case ATA_16:
2499                 return ata_scsi_pass_thru;
2500
2501         case START_STOP:
2502                 return ata_scsi_start_stop_xlat;
2503         }
2504
2505         return NULL;
2506 }
2507
2508 /**
2509  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2510  *      @ap: ATA port to which the command was being sent
2511  *      @cmd: SCSI command to dump
2512  *
2513  *      Prints the contents of a SCSI command via printk().
2514  */
2515
2516 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2517                                      struct scsi_cmnd *cmd)
2518 {
2519 #ifdef ATA_DEBUG
2520         struct scsi_device *scsidev = cmd->device;
2521         u8 *scsicmd = cmd->cmnd;
2522
2523         DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2524                 ap->id,
2525                 scsidev->channel, scsidev->id, scsidev->lun,
2526                 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2527                 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2528                 scsicmd[8]);
2529 #endif
2530 }
2531
2532 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2533                                       void (*done)(struct scsi_cmnd *),
2534                                       struct ata_device *dev)
2535 {
2536         int rc = 0;
2537
2538         if (dev->class == ATA_DEV_ATA) {
2539                 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2540                                                               cmd->cmnd[0]);
2541
2542                 if (xlat_func)
2543                         rc = ata_scsi_translate(dev, cmd, done, xlat_func);
2544                 else
2545                         ata_scsi_simulate(dev, cmd, done);
2546         } else
2547                 rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);
2548
2549         return rc;
2550 }
2551
2552 /**
2553  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2554  *      @cmd: SCSI command to be sent
2555  *      @done: Completion function, called when command is complete
2556  *
2557  *      In some cases, this function translates SCSI commands into
2558  *      ATA taskfiles, and queues the taskfiles to be sent to
2559  *      hardware.  In other cases, this function simulates a
2560  *      SCSI device by evaluating and responding to certain
2561  *      SCSI commands.  This creates the overall effect of
2562  *      ATA and ATAPI devices appearing as SCSI devices.
2563  *
2564  *      LOCKING:
2565  *      Releases scsi-layer-held lock, and obtains host_set lock.
2566  *
2567  *      RETURNS:
2568  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2569  *      0 otherwise.
2570  */
2571 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2572 {
2573         struct ata_port *ap;
2574         struct ata_device *dev;
2575         struct scsi_device *scsidev = cmd->device;
2576         struct Scsi_Host *shost = scsidev->host;
2577         int rc = 0;
2578
2579         ap = ata_shost_to_port(shost);
2580
2581         spin_unlock(shost->host_lock);
2582         spin_lock(&ap->host_set->lock);
2583
2584         ata_scsi_dump_cdb(ap, cmd);
2585
2586         dev = ata_scsi_find_dev(ap, scsidev);
2587         if (likely(dev))
2588                 rc = __ata_scsi_queuecmd(cmd, done, dev);
2589         else {
2590                 cmd->result = (DID_BAD_TARGET << 16);
2591                 done(cmd);
2592         }
2593
2594         spin_unlock(&ap->host_set->lock);
2595         spin_lock(shost->host_lock);
2596         return rc;
2597 }
2598
2599 /**
2600  *      ata_scsi_simulate - simulate SCSI command on ATA device
2601  *      @dev: the target device
2602  *      @cmd: SCSI command being sent to device.
2603  *      @done: SCSI command completion function.
2604  *
2605  *      Interprets and directly executes a select list of SCSI commands
2606  *      that can be handled internally.
2607  *
2608  *      LOCKING:
2609  *      spin_lock_irqsave(host_set lock)
2610  */
2611
2612 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2613                       void (*done)(struct scsi_cmnd *))
2614 {
2615         struct ata_scsi_args args;
2616         const u8 *scsicmd = cmd->cmnd;
2617
2618         args.dev = dev;
2619         args.id = dev->id;
2620         args.cmd = cmd;
2621         args.done = done;
2622
2623         switch(scsicmd[0]) {
2624                 /* no-op's, complete with success */
2625                 case SYNCHRONIZE_CACHE:
2626                 case REZERO_UNIT:
2627                 case SEEK_6:
2628                 case SEEK_10:
2629                 case TEST_UNIT_READY:
2630                 case FORMAT_UNIT:               /* FIXME: correct? */
2631                 case SEND_DIAGNOSTIC:           /* FIXME: correct? */
2632                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2633                         break;
2634
2635                 case INQUIRY:
2636                         if (scsicmd[1] & 2)                /* is CmdDt set?  */
2637                                 ata_scsi_invalid_field(cmd, done);
2638                         else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
2639                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2640                         else if (scsicmd[2] == 0x00)
2641                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2642                         else if (scsicmd[2] == 0x80)
2643                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2644                         else if (scsicmd[2] == 0x83)
2645                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2646                         else
2647                                 ata_scsi_invalid_field(cmd, done);
2648                         break;
2649
2650                 case MODE_SENSE:
2651                 case MODE_SENSE_10:
2652                         ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2653                         break;
2654
2655                 case MODE_SELECT:       /* unconditionally return */
2656                 case MODE_SELECT_10:    /* bad-field-in-cdb */
2657                         ata_scsi_invalid_field(cmd, done);
2658                         break;
2659
2660                 case READ_CAPACITY:
2661                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2662                         break;
2663
2664                 case SERVICE_ACTION_IN:
2665                         if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2666                                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2667                         else
2668                                 ata_scsi_invalid_field(cmd, done);
2669                         break;
2670
2671                 case REPORT_LUNS:
2672                         ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2673                         break;
2674
2675                 /* mandatory commands we haven't implemented yet */
2676                 case REQUEST_SENSE:
2677
2678                 /* all other commands */
2679                 default:
2680                         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2681                         /* "Invalid command operation code" */
2682                         done(cmd);
2683                         break;
2684         }
2685 }
2686
2687 void ata_scsi_scan_host(struct ata_port *ap)
2688 {
2689         struct ata_device *dev;
2690         unsigned int i;
2691
2692         if (ap->flags & ATA_FLAG_DISABLED)
2693                 return;
2694
2695         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2696                 dev = &ap->device[i];
2697
2698                 if (ata_dev_enabled(dev))
2699                         scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2700         }
2701 }
2702
2703 /**
2704  *      ata_schedule_scsi_eh - schedule EH for SCSI host
2705  *      @shost: SCSI host to invoke error handling on.
2706  *
2707  *      Schedule SCSI EH without scmd.  This is a hack.
2708  *
2709  *      LOCKING:
2710  *      spin_lock_irqsave(host_set lock)
2711  **/
2712 void ata_schedule_scsi_eh(struct Scsi_Host *shost)
2713 {
2714         unsigned long flags;
2715
2716         spin_lock_irqsave(shost->host_lock, flags);
2717
2718         if (scsi_host_set_state(shost, SHOST_RECOVERY) == 0 ||
2719             scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY) == 0) {
2720                 shost->host_eh_scheduled++;
2721                 scsi_eh_wakeup(shost);
2722         }
2723
2724         spin_unlock_irqrestore(shost->host_lock, flags);
2725 }