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