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