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