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