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