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