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