libata: change ATA_QCFLAG_DMAMAP semantics
[pandora-kernel.git] / drivers / ata / libata-core.c
1 /*
2  *  libata-core.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 http://www.t13.org/ and
31  *  http://www.sata-io.org/
32  *
33  *  Standards documents from:
34  *      http://www.t13.org (ATA standards, PCI DMA IDE spec)
35  *      http://www.t10.org (SCSI MMC - for ATAPI MMC)
36  *      http://www.sata-io.org (SATA)
37  *      http://www.compactflash.org (CF)
38  *      http://www.qic.org (QIC157 - Tape and DSC)
39  *      http://www.ce-ata.org (CE-ATA: not supported)
40  *
41  */
42
43 #include <linux/kernel.h>
44 #include <linux/module.h>
45 #include <linux/pci.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/mm.h>
49 #include <linux/highmem.h>
50 #include <linux/spinlock.h>
51 #include <linux/blkdev.h>
52 #include <linux/delay.h>
53 #include <linux/timer.h>
54 #include <linux/interrupt.h>
55 #include <linux/completion.h>
56 #include <linux/suspend.h>
57 #include <linux/workqueue.h>
58 #include <linux/jiffies.h>
59 #include <linux/scatterlist.h>
60 #include <linux/io.h>
61 #include <scsi/scsi.h>
62 #include <scsi/scsi_cmnd.h>
63 #include <scsi/scsi_host.h>
64 #include <linux/libata.h>
65 #include <asm/semaphore.h>
66 #include <asm/byteorder.h>
67 #include <linux/cdrom.h>
68
69 #include "libata.h"
70
71
72 /* debounce timing parameters in msecs { interval, duration, timeout } */
73 const unsigned long sata_deb_timing_normal[]            = {   5,  100, 2000 };
74 const unsigned long sata_deb_timing_hotplug[]           = {  25,  500, 2000 };
75 const unsigned long sata_deb_timing_long[]              = { 100, 2000, 5000 };
76
77 static unsigned int ata_dev_init_params(struct ata_device *dev,
78                                         u16 heads, u16 sectors);
79 static unsigned int ata_dev_set_xfermode(struct ata_device *dev);
80 static unsigned int ata_dev_set_feature(struct ata_device *dev,
81                                         u8 enable, u8 feature);
82 static void ata_dev_xfermask(struct ata_device *dev);
83 static unsigned long ata_dev_blacklisted(const struct ata_device *dev);
84
85 unsigned int ata_print_id = 1;
86 static struct workqueue_struct *ata_wq;
87
88 struct workqueue_struct *ata_aux_wq;
89
90 int atapi_enabled = 1;
91 module_param(atapi_enabled, int, 0444);
92 MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on)");
93
94 int atapi_dmadir = 0;
95 module_param(atapi_dmadir, int, 0444);
96 MODULE_PARM_DESC(atapi_dmadir, "Enable ATAPI DMADIR bridge support (0=off, 1=on)");
97
98 int atapi_passthru16 = 1;
99 module_param(atapi_passthru16, int, 0444);
100 MODULE_PARM_DESC(atapi_passthru16, "Enable ATA_16 passthru for ATAPI devices; on by default (0=off, 1=on)");
101
102 int libata_fua = 0;
103 module_param_named(fua, libata_fua, int, 0444);
104 MODULE_PARM_DESC(fua, "FUA support (0=off, 1=on)");
105
106 static int ata_ignore_hpa;
107 module_param_named(ignore_hpa, ata_ignore_hpa, int, 0644);
108 MODULE_PARM_DESC(ignore_hpa, "Ignore HPA limit (0=keep BIOS limits, 1=ignore limits, using full disk)");
109
110 static int libata_dma_mask = ATA_DMA_MASK_ATA|ATA_DMA_MASK_ATAPI|ATA_DMA_MASK_CFA;
111 module_param_named(dma, libata_dma_mask, int, 0444);
112 MODULE_PARM_DESC(dma, "DMA enable/disable (0x1==ATA, 0x2==ATAPI, 0x4==CF)");
113
114 static int ata_probe_timeout = ATA_TMOUT_INTERNAL / HZ;
115 module_param(ata_probe_timeout, int, 0444);
116 MODULE_PARM_DESC(ata_probe_timeout, "Set ATA probing timeout (seconds)");
117
118 int libata_noacpi = 0;
119 module_param_named(noacpi, libata_noacpi, int, 0444);
120 MODULE_PARM_DESC(noacpi, "Disables the use of ACPI in probe/suspend/resume when set");
121
122 int libata_allow_tpm = 0;
123 module_param_named(allow_tpm, libata_allow_tpm, int, 0444);
124 MODULE_PARM_DESC(allow_tpm, "Permit the use of TPM commands");
125
126 MODULE_AUTHOR("Jeff Garzik");
127 MODULE_DESCRIPTION("Library module for ATA devices");
128 MODULE_LICENSE("GPL");
129 MODULE_VERSION(DRV_VERSION);
130
131
132 /**
133  *      ata_tf_to_fis - Convert ATA taskfile to SATA FIS structure
134  *      @tf: Taskfile to convert
135  *      @pmp: Port multiplier port
136  *      @is_cmd: This FIS is for command
137  *      @fis: Buffer into which data will output
138  *
139  *      Converts a standard ATA taskfile to a Serial ATA
140  *      FIS structure (Register - Host to Device).
141  *
142  *      LOCKING:
143  *      Inherited from caller.
144  */
145 void ata_tf_to_fis(const struct ata_taskfile *tf, u8 pmp, int is_cmd, u8 *fis)
146 {
147         fis[0] = 0x27;                  /* Register - Host to Device FIS */
148         fis[1] = pmp & 0xf;             /* Port multiplier number*/
149         if (is_cmd)
150                 fis[1] |= (1 << 7);     /* bit 7 indicates Command FIS */
151
152         fis[2] = tf->command;
153         fis[3] = tf->feature;
154
155         fis[4] = tf->lbal;
156         fis[5] = tf->lbam;
157         fis[6] = tf->lbah;
158         fis[7] = tf->device;
159
160         fis[8] = tf->hob_lbal;
161         fis[9] = tf->hob_lbam;
162         fis[10] = tf->hob_lbah;
163         fis[11] = tf->hob_feature;
164
165         fis[12] = tf->nsect;
166         fis[13] = tf->hob_nsect;
167         fis[14] = 0;
168         fis[15] = tf->ctl;
169
170         fis[16] = 0;
171         fis[17] = 0;
172         fis[18] = 0;
173         fis[19] = 0;
174 }
175
176 /**
177  *      ata_tf_from_fis - Convert SATA FIS to ATA taskfile
178  *      @fis: Buffer from which data will be input
179  *      @tf: Taskfile to output
180  *
181  *      Converts a serial ATA FIS structure to a standard ATA taskfile.
182  *
183  *      LOCKING:
184  *      Inherited from caller.
185  */
186
187 void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf)
188 {
189         tf->command     = fis[2];       /* status */
190         tf->feature     = fis[3];       /* error */
191
192         tf->lbal        = fis[4];
193         tf->lbam        = fis[5];
194         tf->lbah        = fis[6];
195         tf->device      = fis[7];
196
197         tf->hob_lbal    = fis[8];
198         tf->hob_lbam    = fis[9];
199         tf->hob_lbah    = fis[10];
200
201         tf->nsect       = fis[12];
202         tf->hob_nsect   = fis[13];
203 }
204
205 static const u8 ata_rw_cmds[] = {
206         /* pio multi */
207         ATA_CMD_READ_MULTI,
208         ATA_CMD_WRITE_MULTI,
209         ATA_CMD_READ_MULTI_EXT,
210         ATA_CMD_WRITE_MULTI_EXT,
211         0,
212         0,
213         0,
214         ATA_CMD_WRITE_MULTI_FUA_EXT,
215         /* pio */
216         ATA_CMD_PIO_READ,
217         ATA_CMD_PIO_WRITE,
218         ATA_CMD_PIO_READ_EXT,
219         ATA_CMD_PIO_WRITE_EXT,
220         0,
221         0,
222         0,
223         0,
224         /* dma */
225         ATA_CMD_READ,
226         ATA_CMD_WRITE,
227         ATA_CMD_READ_EXT,
228         ATA_CMD_WRITE_EXT,
229         0,
230         0,
231         0,
232         ATA_CMD_WRITE_FUA_EXT
233 };
234
235 /**
236  *      ata_rwcmd_protocol - set taskfile r/w commands and protocol
237  *      @tf: command to examine and configure
238  *      @dev: device tf belongs to
239  *
240  *      Examine the device configuration and tf->flags to calculate
241  *      the proper read/write commands and protocol to use.
242  *
243  *      LOCKING:
244  *      caller.
245  */
246 static int ata_rwcmd_protocol(struct ata_taskfile *tf, struct ata_device *dev)
247 {
248         u8 cmd;
249
250         int index, fua, lba48, write;
251
252         fua = (tf->flags & ATA_TFLAG_FUA) ? 4 : 0;
253         lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
254         write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;
255
256         if (dev->flags & ATA_DFLAG_PIO) {
257                 tf->protocol = ATA_PROT_PIO;
258                 index = dev->multi_count ? 0 : 8;
259         } else if (lba48 && (dev->link->ap->flags & ATA_FLAG_PIO_LBA48)) {
260                 /* Unable to use DMA due to host limitation */
261                 tf->protocol = ATA_PROT_PIO;
262                 index = dev->multi_count ? 0 : 8;
263         } else {
264                 tf->protocol = ATA_PROT_DMA;
265                 index = 16;
266         }
267
268         cmd = ata_rw_cmds[index + fua + lba48 + write];
269         if (cmd) {
270                 tf->command = cmd;
271                 return 0;
272         }
273         return -1;
274 }
275
276 /**
277  *      ata_tf_read_block - Read block address from ATA taskfile
278  *      @tf: ATA taskfile of interest
279  *      @dev: ATA device @tf belongs to
280  *
281  *      LOCKING:
282  *      None.
283  *
284  *      Read block address from @tf.  This function can handle all
285  *      three address formats - LBA, LBA48 and CHS.  tf->protocol and
286  *      flags select the address format to use.
287  *
288  *      RETURNS:
289  *      Block address read from @tf.
290  */
291 u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev)
292 {
293         u64 block = 0;
294
295         if (tf->flags & ATA_TFLAG_LBA) {
296                 if (tf->flags & ATA_TFLAG_LBA48) {
297                         block |= (u64)tf->hob_lbah << 40;
298                         block |= (u64)tf->hob_lbam << 32;
299                         block |= tf->hob_lbal << 24;
300                 } else
301                         block |= (tf->device & 0xf) << 24;
302
303                 block |= tf->lbah << 16;
304                 block |= tf->lbam << 8;
305                 block |= tf->lbal;
306         } else {
307                 u32 cyl, head, sect;
308
309                 cyl = tf->lbam | (tf->lbah << 8);
310                 head = tf->device & 0xf;
311                 sect = tf->lbal;
312
313                 block = (cyl * dev->heads + head) * dev->sectors + sect;
314         }
315
316         return block;
317 }
318
319 /**
320  *      ata_build_rw_tf - Build ATA taskfile for given read/write request
321  *      @tf: Target ATA taskfile
322  *      @dev: ATA device @tf belongs to
323  *      @block: Block address
324  *      @n_block: Number of blocks
325  *      @tf_flags: RW/FUA etc...
326  *      @tag: tag
327  *
328  *      LOCKING:
329  *      None.
330  *
331  *      Build ATA taskfile @tf for read/write request described by
332  *      @block, @n_block, @tf_flags and @tag on @dev.
333  *
334  *      RETURNS:
335  *
336  *      0 on success, -ERANGE if the request is too large for @dev,
337  *      -EINVAL if the request is invalid.
338  */
339 int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
340                     u64 block, u32 n_block, unsigned int tf_flags,
341                     unsigned int tag)
342 {
343         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
344         tf->flags |= tf_flags;
345
346         if (ata_ncq_enabled(dev) && likely(tag != ATA_TAG_INTERNAL)) {
347                 /* yay, NCQ */
348                 if (!lba_48_ok(block, n_block))
349                         return -ERANGE;
350
351                 tf->protocol = ATA_PROT_NCQ;
352                 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
353
354                 if (tf->flags & ATA_TFLAG_WRITE)
355                         tf->command = ATA_CMD_FPDMA_WRITE;
356                 else
357                         tf->command = ATA_CMD_FPDMA_READ;
358
359                 tf->nsect = tag << 3;
360                 tf->hob_feature = (n_block >> 8) & 0xff;
361                 tf->feature = n_block & 0xff;
362
363                 tf->hob_lbah = (block >> 40) & 0xff;
364                 tf->hob_lbam = (block >> 32) & 0xff;
365                 tf->hob_lbal = (block >> 24) & 0xff;
366                 tf->lbah = (block >> 16) & 0xff;
367                 tf->lbam = (block >> 8) & 0xff;
368                 tf->lbal = block & 0xff;
369
370                 tf->device = 1 << 6;
371                 if (tf->flags & ATA_TFLAG_FUA)
372                         tf->device |= 1 << 7;
373         } else if (dev->flags & ATA_DFLAG_LBA) {
374                 tf->flags |= ATA_TFLAG_LBA;
375
376                 if (lba_28_ok(block, n_block)) {
377                         /* use LBA28 */
378                         tf->device |= (block >> 24) & 0xf;
379                 } else if (lba_48_ok(block, n_block)) {
380                         if (!(dev->flags & ATA_DFLAG_LBA48))
381                                 return -ERANGE;
382
383                         /* use LBA48 */
384                         tf->flags |= ATA_TFLAG_LBA48;
385
386                         tf->hob_nsect = (n_block >> 8) & 0xff;
387
388                         tf->hob_lbah = (block >> 40) & 0xff;
389                         tf->hob_lbam = (block >> 32) & 0xff;
390                         tf->hob_lbal = (block >> 24) & 0xff;
391                 } else
392                         /* request too large even for LBA48 */
393                         return -ERANGE;
394
395                 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
396                         return -EINVAL;
397
398                 tf->nsect = n_block & 0xff;
399
400                 tf->lbah = (block >> 16) & 0xff;
401                 tf->lbam = (block >> 8) & 0xff;
402                 tf->lbal = block & 0xff;
403
404                 tf->device |= ATA_LBA;
405         } else {
406                 /* CHS */
407                 u32 sect, head, cyl, track;
408
409                 /* The request -may- be too large for CHS addressing. */
410                 if (!lba_28_ok(block, n_block))
411                         return -ERANGE;
412
413                 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
414                         return -EINVAL;
415
416                 /* Convert LBA to CHS */
417                 track = (u32)block / dev->sectors;
418                 cyl   = track / dev->heads;
419                 head  = track % dev->heads;
420                 sect  = (u32)block % dev->sectors + 1;
421
422                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
423                         (u32)block, track, cyl, head, sect);
424
425                 /* Check whether the converted CHS can fit.
426                    Cylinder: 0-65535
427                    Head: 0-15
428                    Sector: 1-255*/
429                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
430                         return -ERANGE;
431
432                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
433                 tf->lbal = sect;
434                 tf->lbam = cyl;
435                 tf->lbah = cyl >> 8;
436                 tf->device |= head;
437         }
438
439         return 0;
440 }
441
442 /**
443  *      ata_pack_xfermask - Pack pio, mwdma and udma masks into xfer_mask
444  *      @pio_mask: pio_mask
445  *      @mwdma_mask: mwdma_mask
446  *      @udma_mask: udma_mask
447  *
448  *      Pack @pio_mask, @mwdma_mask and @udma_mask into a single
449  *      unsigned int xfer_mask.
450  *
451  *      LOCKING:
452  *      None.
453  *
454  *      RETURNS:
455  *      Packed xfer_mask.
456  */
457 unsigned long ata_pack_xfermask(unsigned long pio_mask,
458                                 unsigned long mwdma_mask,
459                                 unsigned long udma_mask)
460 {
461         return ((pio_mask << ATA_SHIFT_PIO) & ATA_MASK_PIO) |
462                 ((mwdma_mask << ATA_SHIFT_MWDMA) & ATA_MASK_MWDMA) |
463                 ((udma_mask << ATA_SHIFT_UDMA) & ATA_MASK_UDMA);
464 }
465
466 /**
467  *      ata_unpack_xfermask - Unpack xfer_mask into pio, mwdma and udma masks
468  *      @xfer_mask: xfer_mask to unpack
469  *      @pio_mask: resulting pio_mask
470  *      @mwdma_mask: resulting mwdma_mask
471  *      @udma_mask: resulting udma_mask
472  *
473  *      Unpack @xfer_mask into @pio_mask, @mwdma_mask and @udma_mask.
474  *      Any NULL distination masks will be ignored.
475  */
476 void ata_unpack_xfermask(unsigned long xfer_mask, unsigned long *pio_mask,
477                          unsigned long *mwdma_mask, unsigned long *udma_mask)
478 {
479         if (pio_mask)
480                 *pio_mask = (xfer_mask & ATA_MASK_PIO) >> ATA_SHIFT_PIO;
481         if (mwdma_mask)
482                 *mwdma_mask = (xfer_mask & ATA_MASK_MWDMA) >> ATA_SHIFT_MWDMA;
483         if (udma_mask)
484                 *udma_mask = (xfer_mask & ATA_MASK_UDMA) >> ATA_SHIFT_UDMA;
485 }
486
487 static const struct ata_xfer_ent {
488         int shift, bits;
489         u8 base;
490 } ata_xfer_tbl[] = {
491         { ATA_SHIFT_PIO, ATA_NR_PIO_MODES, XFER_PIO_0 },
492         { ATA_SHIFT_MWDMA, ATA_NR_MWDMA_MODES, XFER_MW_DMA_0 },
493         { ATA_SHIFT_UDMA, ATA_NR_UDMA_MODES, XFER_UDMA_0 },
494         { -1, },
495 };
496
497 /**
498  *      ata_xfer_mask2mode - Find matching XFER_* for the given xfer_mask
499  *      @xfer_mask: xfer_mask of interest
500  *
501  *      Return matching XFER_* value for @xfer_mask.  Only the highest
502  *      bit of @xfer_mask is considered.
503  *
504  *      LOCKING:
505  *      None.
506  *
507  *      RETURNS:
508  *      Matching XFER_* value, 0xff if no match found.
509  */
510 u8 ata_xfer_mask2mode(unsigned long xfer_mask)
511 {
512         int highbit = fls(xfer_mask) - 1;
513         const struct ata_xfer_ent *ent;
514
515         for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
516                 if (highbit >= ent->shift && highbit < ent->shift + ent->bits)
517                         return ent->base + highbit - ent->shift;
518         return 0xff;
519 }
520
521 /**
522  *      ata_xfer_mode2mask - Find matching xfer_mask for XFER_*
523  *      @xfer_mode: XFER_* of interest
524  *
525  *      Return matching xfer_mask for @xfer_mode.
526  *
527  *      LOCKING:
528  *      None.
529  *
530  *      RETURNS:
531  *      Matching xfer_mask, 0 if no match found.
532  */
533 unsigned long ata_xfer_mode2mask(u8 xfer_mode)
534 {
535         const struct ata_xfer_ent *ent;
536
537         for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
538                 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
539                         return ((2 << (ent->shift + xfer_mode - ent->base)) - 1)
540                                 & ~((1 << ent->shift) - 1);
541         return 0;
542 }
543
544 /**
545  *      ata_xfer_mode2shift - Find matching xfer_shift for XFER_*
546  *      @xfer_mode: XFER_* of interest
547  *
548  *      Return matching xfer_shift for @xfer_mode.
549  *
550  *      LOCKING:
551  *      None.
552  *
553  *      RETURNS:
554  *      Matching xfer_shift, -1 if no match found.
555  */
556 int ata_xfer_mode2shift(unsigned long xfer_mode)
557 {
558         const struct ata_xfer_ent *ent;
559
560         for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
561                 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
562                         return ent->shift;
563         return -1;
564 }
565
566 /**
567  *      ata_mode_string - convert xfer_mask to string
568  *      @xfer_mask: mask of bits supported; only highest bit counts.
569  *
570  *      Determine string which represents the highest speed
571  *      (highest bit in @modemask).
572  *
573  *      LOCKING:
574  *      None.
575  *
576  *      RETURNS:
577  *      Constant C string representing highest speed listed in
578  *      @mode_mask, or the constant C string "<n/a>".
579  */
580 const char *ata_mode_string(unsigned long xfer_mask)
581 {
582         static const char * const xfer_mode_str[] = {
583                 "PIO0",
584                 "PIO1",
585                 "PIO2",
586                 "PIO3",
587                 "PIO4",
588                 "PIO5",
589                 "PIO6",
590                 "MWDMA0",
591                 "MWDMA1",
592                 "MWDMA2",
593                 "MWDMA3",
594                 "MWDMA4",
595                 "UDMA/16",
596                 "UDMA/25",
597                 "UDMA/33",
598                 "UDMA/44",
599                 "UDMA/66",
600                 "UDMA/100",
601                 "UDMA/133",
602                 "UDMA7",
603         };
604         int highbit;
605
606         highbit = fls(xfer_mask) - 1;
607         if (highbit >= 0 && highbit < ARRAY_SIZE(xfer_mode_str))
608                 return xfer_mode_str[highbit];
609         return "<n/a>";
610 }
611
612 static const char *sata_spd_string(unsigned int spd)
613 {
614         static const char * const spd_str[] = {
615                 "1.5 Gbps",
616                 "3.0 Gbps",
617         };
618
619         if (spd == 0 || (spd - 1) >= ARRAY_SIZE(spd_str))
620                 return "<unknown>";
621         return spd_str[spd - 1];
622 }
623
624 void ata_dev_disable(struct ata_device *dev)
625 {
626         if (ata_dev_enabled(dev)) {
627                 if (ata_msg_drv(dev->link->ap))
628                         ata_dev_printk(dev, KERN_WARNING, "disabled\n");
629                 ata_acpi_on_disable(dev);
630                 ata_down_xfermask_limit(dev, ATA_DNXFER_FORCE_PIO0 |
631                                              ATA_DNXFER_QUIET);
632                 dev->class++;
633         }
634 }
635
636 static int ata_dev_set_dipm(struct ata_device *dev, enum link_pm policy)
637 {
638         struct ata_link *link = dev->link;
639         struct ata_port *ap = link->ap;
640         u32 scontrol;
641         unsigned int err_mask;
642         int rc;
643
644         /*
645          * disallow DIPM for drivers which haven't set
646          * ATA_FLAG_IPM.  This is because when DIPM is enabled,
647          * phy ready will be set in the interrupt status on
648          * state changes, which will cause some drivers to
649          * think there are errors - additionally drivers will
650          * need to disable hot plug.
651          */
652         if (!(ap->flags & ATA_FLAG_IPM) || !ata_dev_enabled(dev)) {
653                 ap->pm_policy = NOT_AVAILABLE;
654                 return -EINVAL;
655         }
656
657         /*
658          * For DIPM, we will only enable it for the
659          * min_power setting.
660          *
661          * Why?  Because Disks are too stupid to know that
662          * If the host rejects a request to go to SLUMBER
663          * they should retry at PARTIAL, and instead it
664          * just would give up.  So, for medium_power to
665          * work at all, we need to only allow HIPM.
666          */
667         rc = sata_scr_read(link, SCR_CONTROL, &scontrol);
668         if (rc)
669                 return rc;
670
671         switch (policy) {
672         case MIN_POWER:
673                 /* no restrictions on IPM transitions */
674                 scontrol &= ~(0x3 << 8);
675                 rc = sata_scr_write(link, SCR_CONTROL, scontrol);
676                 if (rc)
677                         return rc;
678
679                 /* enable DIPM */
680                 if (dev->flags & ATA_DFLAG_DIPM)
681                         err_mask = ata_dev_set_feature(dev,
682                                         SETFEATURES_SATA_ENABLE, SATA_DIPM);
683                 break;
684         case MEDIUM_POWER:
685                 /* allow IPM to PARTIAL */
686                 scontrol &= ~(0x1 << 8);
687                 scontrol |= (0x2 << 8);
688                 rc = sata_scr_write(link, SCR_CONTROL, scontrol);
689                 if (rc)
690                         return rc;
691
692                 /*
693                  * we don't have to disable DIPM since IPM flags
694                  * disallow transitions to SLUMBER, which effectively
695                  * disable DIPM if it does not support PARTIAL
696                  */
697                 break;
698         case NOT_AVAILABLE:
699         case MAX_PERFORMANCE:
700                 /* disable all IPM transitions */
701                 scontrol |= (0x3 << 8);
702                 rc = sata_scr_write(link, SCR_CONTROL, scontrol);
703                 if (rc)
704                         return rc;
705
706                 /*
707                  * we don't have to disable DIPM since IPM flags
708                  * disallow all transitions which effectively
709                  * disable DIPM anyway.
710                  */
711                 break;
712         }
713
714         /* FIXME: handle SET FEATURES failure */
715         (void) err_mask;
716
717         return 0;
718 }
719
720 /**
721  *      ata_dev_enable_pm - enable SATA interface power management
722  *      @dev:  device to enable power management
723  *      @policy: the link power management policy
724  *
725  *      Enable SATA Interface power management.  This will enable
726  *      Device Interface Power Management (DIPM) for min_power
727  *      policy, and then call driver specific callbacks for
728  *      enabling Host Initiated Power management.
729  *
730  *      Locking: Caller.
731  *      Returns: -EINVAL if IPM is not supported, 0 otherwise.
732  */
733 void ata_dev_enable_pm(struct ata_device *dev, enum link_pm policy)
734 {
735         int rc = 0;
736         struct ata_port *ap = dev->link->ap;
737
738         /* set HIPM first, then DIPM */
739         if (ap->ops->enable_pm)
740                 rc = ap->ops->enable_pm(ap, policy);
741         if (rc)
742                 goto enable_pm_out;
743         rc = ata_dev_set_dipm(dev, policy);
744
745 enable_pm_out:
746         if (rc)
747                 ap->pm_policy = MAX_PERFORMANCE;
748         else
749                 ap->pm_policy = policy;
750         return /* rc */;        /* hopefully we can use 'rc' eventually */
751 }
752
753 #ifdef CONFIG_PM
754 /**
755  *      ata_dev_disable_pm - disable SATA interface power management
756  *      @dev: device to disable power management
757  *
758  *      Disable SATA Interface power management.  This will disable
759  *      Device Interface Power Management (DIPM) without changing
760  *      policy,  call driver specific callbacks for disabling Host
761  *      Initiated Power management.
762  *
763  *      Locking: Caller.
764  *      Returns: void
765  */
766 static void ata_dev_disable_pm(struct ata_device *dev)
767 {
768         struct ata_port *ap = dev->link->ap;
769
770         ata_dev_set_dipm(dev, MAX_PERFORMANCE);
771         if (ap->ops->disable_pm)
772                 ap->ops->disable_pm(ap);
773 }
774 #endif  /* CONFIG_PM */
775
776 void ata_lpm_schedule(struct ata_port *ap, enum link_pm policy)
777 {
778         ap->pm_policy = policy;
779         ap->link.eh_info.action |= ATA_EHI_LPM;
780         ap->link.eh_info.flags |= ATA_EHI_NO_AUTOPSY;
781         ata_port_schedule_eh(ap);
782 }
783
784 #ifdef CONFIG_PM
785 static void ata_lpm_enable(struct ata_host *host)
786 {
787         struct ata_link *link;
788         struct ata_port *ap;
789         struct ata_device *dev;
790         int i;
791
792         for (i = 0; i < host->n_ports; i++) {
793                 ap = host->ports[i];
794                 ata_port_for_each_link(link, ap) {
795                         ata_link_for_each_dev(dev, link)
796                                 ata_dev_disable_pm(dev);
797                 }
798         }
799 }
800
801 static void ata_lpm_disable(struct ata_host *host)
802 {
803         int i;
804
805         for (i = 0; i < host->n_ports; i++) {
806                 struct ata_port *ap = host->ports[i];
807                 ata_lpm_schedule(ap, ap->pm_policy);
808         }
809 }
810 #endif  /* CONFIG_PM */
811
812
813 /**
814  *      ata_devchk - PATA device presence detection
815  *      @ap: ATA channel to examine
816  *      @device: Device to examine (starting at zero)
817  *
818  *      This technique was originally described in
819  *      Hale Landis's ATADRVR (www.ata-atapi.com), and
820  *      later found its way into the ATA/ATAPI spec.
821  *
822  *      Write a pattern to the ATA shadow registers,
823  *      and if a device is present, it will respond by
824  *      correctly storing and echoing back the
825  *      ATA shadow register contents.
826  *
827  *      LOCKING:
828  *      caller.
829  */
830
831 static unsigned int ata_devchk(struct ata_port *ap, unsigned int device)
832 {
833         struct ata_ioports *ioaddr = &ap->ioaddr;
834         u8 nsect, lbal;
835
836         ap->ops->dev_select(ap, device);
837
838         iowrite8(0x55, ioaddr->nsect_addr);
839         iowrite8(0xaa, ioaddr->lbal_addr);
840
841         iowrite8(0xaa, ioaddr->nsect_addr);
842         iowrite8(0x55, ioaddr->lbal_addr);
843
844         iowrite8(0x55, ioaddr->nsect_addr);
845         iowrite8(0xaa, ioaddr->lbal_addr);
846
847         nsect = ioread8(ioaddr->nsect_addr);
848         lbal = ioread8(ioaddr->lbal_addr);
849
850         if ((nsect == 0x55) && (lbal == 0xaa))
851                 return 1;       /* we found a device */
852
853         return 0;               /* nothing found */
854 }
855
856 /**
857  *      ata_dev_classify - determine device type based on ATA-spec signature
858  *      @tf: ATA taskfile register set for device to be identified
859  *
860  *      Determine from taskfile register contents whether a device is
861  *      ATA or ATAPI, as per "Signature and persistence" section
862  *      of ATA/PI spec (volume 1, sect 5.14).
863  *
864  *      LOCKING:
865  *      None.
866  *
867  *      RETURNS:
868  *      Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, %ATA_DEV_PMP or
869  *      %ATA_DEV_UNKNOWN the event of failure.
870  */
871 unsigned int ata_dev_classify(const struct ata_taskfile *tf)
872 {
873         /* Apple's open source Darwin code hints that some devices only
874          * put a proper signature into the LBA mid/high registers,
875          * So, we only check those.  It's sufficient for uniqueness.
876          *
877          * ATA/ATAPI-7 (d1532v1r1: Feb. 19, 2003) specified separate
878          * signatures for ATA and ATAPI devices attached on SerialATA,
879          * 0x3c/0xc3 and 0x69/0x96 respectively.  However, SerialATA
880          * spec has never mentioned about using different signatures
881          * for ATA/ATAPI devices.  Then, Serial ATA II: Port
882          * Multiplier specification began to use 0x69/0x96 to identify
883          * port multpliers and 0x3c/0xc3 to identify SEMB device.
884          * ATA/ATAPI-7 dropped descriptions about 0x3c/0xc3 and
885          * 0x69/0x96 shortly and described them as reserved for
886          * SerialATA.
887          *
888          * We follow the current spec and consider that 0x69/0x96
889          * identifies a port multiplier and 0x3c/0xc3 a SEMB device.
890          */
891         if ((tf->lbam == 0) && (tf->lbah == 0)) {
892                 DPRINTK("found ATA device by sig\n");
893                 return ATA_DEV_ATA;
894         }
895
896         if ((tf->lbam == 0x14) && (tf->lbah == 0xeb)) {
897                 DPRINTK("found ATAPI device by sig\n");
898                 return ATA_DEV_ATAPI;
899         }
900
901         if ((tf->lbam == 0x69) && (tf->lbah == 0x96)) {
902                 DPRINTK("found PMP device by sig\n");
903                 return ATA_DEV_PMP;
904         }
905
906         if ((tf->lbam == 0x3c) && (tf->lbah == 0xc3)) {
907                 printk(KERN_INFO "ata: SEMB device ignored\n");
908                 return ATA_DEV_SEMB_UNSUP; /* not yet */
909         }
910
911         DPRINTK("unknown device\n");
912         return ATA_DEV_UNKNOWN;
913 }
914
915 /**
916  *      ata_dev_try_classify - Parse returned ATA device signature
917  *      @dev: ATA device to classify (starting at zero)
918  *      @present: device seems present
919  *      @r_err: Value of error register on completion
920  *
921  *      After an event -- SRST, E.D.D., or SATA COMRESET -- occurs,
922  *      an ATA/ATAPI-defined set of values is placed in the ATA
923  *      shadow registers, indicating the results of device detection
924  *      and diagnostics.
925  *
926  *      Select the ATA device, and read the values from the ATA shadow
927  *      registers.  Then parse according to the Error register value,
928  *      and the spec-defined values examined by ata_dev_classify().
929  *
930  *      LOCKING:
931  *      caller.
932  *
933  *      RETURNS:
934  *      Device type - %ATA_DEV_ATA, %ATA_DEV_ATAPI or %ATA_DEV_NONE.
935  */
936 unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
937                                   u8 *r_err)
938 {
939         struct ata_port *ap = dev->link->ap;
940         struct ata_taskfile tf;
941         unsigned int class;
942         u8 err;
943
944         ap->ops->dev_select(ap, dev->devno);
945
946         memset(&tf, 0, sizeof(tf));
947
948         ap->ops->tf_read(ap, &tf);
949         err = tf.feature;
950         if (r_err)
951                 *r_err = err;
952
953         /* see if device passed diags: if master then continue and warn later */
954         if (err == 0 && dev->devno == 0)
955                 /* diagnostic fail : do nothing _YET_ */
956                 dev->horkage |= ATA_HORKAGE_DIAGNOSTIC;
957         else if (err == 1)
958                 /* do nothing */ ;
959         else if ((dev->devno == 0) && (err == 0x81))
960                 /* do nothing */ ;
961         else
962                 return ATA_DEV_NONE;
963
964         /* determine if device is ATA or ATAPI */
965         class = ata_dev_classify(&tf);
966
967         if (class == ATA_DEV_UNKNOWN) {
968                 /* If the device failed diagnostic, it's likely to
969                  * have reported incorrect device signature too.
970                  * Assume ATA device if the device seems present but
971                  * device signature is invalid with diagnostic
972                  * failure.
973                  */
974                 if (present && (dev->horkage & ATA_HORKAGE_DIAGNOSTIC))
975                         class = ATA_DEV_ATA;
976                 else
977                         class = ATA_DEV_NONE;
978         } else if ((class == ATA_DEV_ATA) && (ata_chk_status(ap) == 0))
979                 class = ATA_DEV_NONE;
980
981         return class;
982 }
983
984 /**
985  *      ata_id_string - Convert IDENTIFY DEVICE page into string
986  *      @id: IDENTIFY DEVICE results we will examine
987  *      @s: string into which data is output
988  *      @ofs: offset into identify device page
989  *      @len: length of string to return. must be an even number.
990  *
991  *      The strings in the IDENTIFY DEVICE page are broken up into
992  *      16-bit chunks.  Run through the string, and output each
993  *      8-bit chunk linearly, regardless of platform.
994  *
995  *      LOCKING:
996  *      caller.
997  */
998
999 void ata_id_string(const u16 *id, unsigned char *s,
1000                    unsigned int ofs, unsigned int len)
1001 {
1002         unsigned int c;
1003
1004         while (len > 0) {
1005                 c = id[ofs] >> 8;
1006                 *s = c;
1007                 s++;
1008
1009                 c = id[ofs] & 0xff;
1010                 *s = c;
1011                 s++;
1012
1013                 ofs++;
1014                 len -= 2;
1015         }
1016 }
1017
1018 /**
1019  *      ata_id_c_string - Convert IDENTIFY DEVICE page into C string
1020  *      @id: IDENTIFY DEVICE results we will examine
1021  *      @s: string into which data is output
1022  *      @ofs: offset into identify device page
1023  *      @len: length of string to return. must be an odd number.
1024  *
1025  *      This function is identical to ata_id_string except that it
1026  *      trims trailing spaces and terminates the resulting string with
1027  *      null.  @len must be actual maximum length (even number) + 1.
1028  *
1029  *      LOCKING:
1030  *      caller.
1031  */
1032 void ata_id_c_string(const u16 *id, unsigned char *s,
1033                      unsigned int ofs, unsigned int len)
1034 {
1035         unsigned char *p;
1036
1037         WARN_ON(!(len & 1));
1038
1039         ata_id_string(id, s, ofs, len - 1);
1040
1041         p = s + strnlen(s, len - 1);
1042         while (p > s && p[-1] == ' ')
1043                 p--;
1044         *p = '\0';
1045 }
1046
1047 static u64 ata_id_n_sectors(const u16 *id)
1048 {
1049         if (ata_id_has_lba(id)) {
1050                 if (ata_id_has_lba48(id))
1051                         return ata_id_u64(id, 100);
1052                 else
1053                         return ata_id_u32(id, 60);
1054         } else {
1055                 if (ata_id_current_chs_valid(id))
1056                         return ata_id_u32(id, 57);
1057                 else
1058                         return id[1] * id[3] * id[6];
1059         }
1060 }
1061
1062 static u64 ata_tf_to_lba48(struct ata_taskfile *tf)
1063 {
1064         u64 sectors = 0;
1065
1066         sectors |= ((u64)(tf->hob_lbah & 0xff)) << 40;
1067         sectors |= ((u64)(tf->hob_lbam & 0xff)) << 32;
1068         sectors |= (tf->hob_lbal & 0xff) << 24;
1069         sectors |= (tf->lbah & 0xff) << 16;
1070         sectors |= (tf->lbam & 0xff) << 8;
1071         sectors |= (tf->lbal & 0xff);
1072
1073         return ++sectors;
1074 }
1075
1076 static u64 ata_tf_to_lba(struct ata_taskfile *tf)
1077 {
1078         u64 sectors = 0;
1079
1080         sectors |= (tf->device & 0x0f) << 24;
1081         sectors |= (tf->lbah & 0xff) << 16;
1082         sectors |= (tf->lbam & 0xff) << 8;
1083         sectors |= (tf->lbal & 0xff);
1084
1085         return ++sectors;
1086 }
1087
1088 /**
1089  *      ata_read_native_max_address - Read native max address
1090  *      @dev: target device
1091  *      @max_sectors: out parameter for the result native max address
1092  *
1093  *      Perform an LBA48 or LBA28 native size query upon the device in
1094  *      question.
1095  *
1096  *      RETURNS:
1097  *      0 on success, -EACCES if command is aborted by the drive.
1098  *      -EIO on other errors.
1099  */
1100 static int ata_read_native_max_address(struct ata_device *dev, u64 *max_sectors)
1101 {
1102         unsigned int err_mask;
1103         struct ata_taskfile tf;
1104         int lba48 = ata_id_has_lba48(dev->id);
1105
1106         ata_tf_init(dev, &tf);
1107
1108         /* always clear all address registers */
1109         tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1110
1111         if (lba48) {
1112                 tf.command = ATA_CMD_READ_NATIVE_MAX_EXT;
1113                 tf.flags |= ATA_TFLAG_LBA48;
1114         } else
1115                 tf.command = ATA_CMD_READ_NATIVE_MAX;
1116
1117         tf.protocol |= ATA_PROT_NODATA;
1118         tf.device |= ATA_LBA;
1119
1120         err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1121         if (err_mask) {
1122                 ata_dev_printk(dev, KERN_WARNING, "failed to read native "
1123                                "max address (err_mask=0x%x)\n", err_mask);
1124                 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
1125                         return -EACCES;
1126                 return -EIO;
1127         }
1128
1129         if (lba48)
1130                 *max_sectors = ata_tf_to_lba48(&tf);
1131         else
1132                 *max_sectors = ata_tf_to_lba(&tf);
1133         if (dev->horkage & ATA_HORKAGE_HPA_SIZE)
1134                 (*max_sectors)--;
1135         return 0;
1136 }
1137
1138 /**
1139  *      ata_set_max_sectors - Set max sectors
1140  *      @dev: target device
1141  *      @new_sectors: new max sectors value to set for the device
1142  *
1143  *      Set max sectors of @dev to @new_sectors.
1144  *
1145  *      RETURNS:
1146  *      0 on success, -EACCES if command is aborted or denied (due to
1147  *      previous non-volatile SET_MAX) by the drive.  -EIO on other
1148  *      errors.
1149  */
1150 static int ata_set_max_sectors(struct ata_device *dev, u64 new_sectors)
1151 {
1152         unsigned int err_mask;
1153         struct ata_taskfile tf;
1154         int lba48 = ata_id_has_lba48(dev->id);
1155
1156         new_sectors--;
1157
1158         ata_tf_init(dev, &tf);
1159
1160         tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1161
1162         if (lba48) {
1163                 tf.command = ATA_CMD_SET_MAX_EXT;
1164                 tf.flags |= ATA_TFLAG_LBA48;
1165
1166                 tf.hob_lbal = (new_sectors >> 24) & 0xff;
1167                 tf.hob_lbam = (new_sectors >> 32) & 0xff;
1168                 tf.hob_lbah = (new_sectors >> 40) & 0xff;
1169         } else {
1170                 tf.command = ATA_CMD_SET_MAX;
1171
1172                 tf.device |= (new_sectors >> 24) & 0xf;
1173         }
1174
1175         tf.protocol |= ATA_PROT_NODATA;
1176         tf.device |= ATA_LBA;
1177
1178         tf.lbal = (new_sectors >> 0) & 0xff;
1179         tf.lbam = (new_sectors >> 8) & 0xff;
1180         tf.lbah = (new_sectors >> 16) & 0xff;
1181
1182         err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1183         if (err_mask) {
1184                 ata_dev_printk(dev, KERN_WARNING, "failed to set "
1185                                "max address (err_mask=0x%x)\n", err_mask);
1186                 if (err_mask == AC_ERR_DEV &&
1187                     (tf.feature & (ATA_ABORTED | ATA_IDNF)))
1188                         return -EACCES;
1189                 return -EIO;
1190         }
1191
1192         return 0;
1193 }
1194
1195 /**
1196  *      ata_hpa_resize          -       Resize a device with an HPA set
1197  *      @dev: Device to resize
1198  *
1199  *      Read the size of an LBA28 or LBA48 disk with HPA features and resize
1200  *      it if required to the full size of the media. The caller must check
1201  *      the drive has the HPA feature set enabled.
1202  *
1203  *      RETURNS:
1204  *      0 on success, -errno on failure.
1205  */
1206 static int ata_hpa_resize(struct ata_device *dev)
1207 {
1208         struct ata_eh_context *ehc = &dev->link->eh_context;
1209         int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
1210         u64 sectors = ata_id_n_sectors(dev->id);
1211         u64 native_sectors;
1212         int rc;
1213
1214         /* do we need to do it? */
1215         if (dev->class != ATA_DEV_ATA ||
1216             !ata_id_has_lba(dev->id) || !ata_id_hpa_enabled(dev->id) ||
1217             (dev->horkage & ATA_HORKAGE_BROKEN_HPA))
1218                 return 0;
1219
1220         /* read native max address */
1221         rc = ata_read_native_max_address(dev, &native_sectors);
1222         if (rc) {
1223                 /* If HPA isn't going to be unlocked, skip HPA
1224                  * resizing from the next try.
1225                  */
1226                 if (!ata_ignore_hpa) {
1227                         ata_dev_printk(dev, KERN_WARNING, "HPA support seems "
1228                                        "broken, will skip HPA handling\n");
1229                         dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
1230
1231                         /* we can continue if device aborted the command */
1232                         if (rc == -EACCES)
1233                                 rc = 0;
1234                 }
1235
1236                 return rc;
1237         }
1238
1239         /* nothing to do? */
1240         if (native_sectors <= sectors || !ata_ignore_hpa) {
1241                 if (!print_info || native_sectors == sectors)
1242                         return 0;
1243
1244                 if (native_sectors > sectors)
1245                         ata_dev_printk(dev, KERN_INFO,
1246                                 "HPA detected: current %llu, native %llu\n",
1247                                 (unsigned long long)sectors,
1248                                 (unsigned long long)native_sectors);
1249                 else if (native_sectors < sectors)
1250                         ata_dev_printk(dev, KERN_WARNING,
1251                                 "native sectors (%llu) is smaller than "
1252                                 "sectors (%llu)\n",
1253                                 (unsigned long long)native_sectors,
1254                                 (unsigned long long)sectors);
1255                 return 0;
1256         }
1257
1258         /* let's unlock HPA */
1259         rc = ata_set_max_sectors(dev, native_sectors);
1260         if (rc == -EACCES) {
1261                 /* if device aborted the command, skip HPA resizing */
1262                 ata_dev_printk(dev, KERN_WARNING, "device aborted resize "
1263                                "(%llu -> %llu), skipping HPA handling\n",
1264                                (unsigned long long)sectors,
1265                                (unsigned long long)native_sectors);
1266                 dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
1267                 return 0;
1268         } else if (rc)
1269                 return rc;
1270
1271         /* re-read IDENTIFY data */
1272         rc = ata_dev_reread_id(dev, 0);
1273         if (rc) {
1274                 ata_dev_printk(dev, KERN_ERR, "failed to re-read IDENTIFY "
1275                                "data after HPA resizing\n");
1276                 return rc;
1277         }
1278
1279         if (print_info) {
1280                 u64 new_sectors = ata_id_n_sectors(dev->id);
1281                 ata_dev_printk(dev, KERN_INFO,
1282                         "HPA unlocked: %llu -> %llu, native %llu\n",
1283                         (unsigned long long)sectors,
1284                         (unsigned long long)new_sectors,
1285                         (unsigned long long)native_sectors);
1286         }
1287
1288         return 0;
1289 }
1290
1291 /**
1292  *      ata_noop_dev_select - Select device 0/1 on ATA bus
1293  *      @ap: ATA channel to manipulate
1294  *      @device: ATA device (numbered from zero) to select
1295  *
1296  *      This function performs no actual function.
1297  *
1298  *      May be used as the dev_select() entry in ata_port_operations.
1299  *
1300  *      LOCKING:
1301  *      caller.
1302  */
1303 void ata_noop_dev_select(struct ata_port *ap, unsigned int device)
1304 {
1305 }
1306
1307
1308 /**
1309  *      ata_std_dev_select - Select device 0/1 on ATA bus
1310  *      @ap: ATA channel to manipulate
1311  *      @device: ATA device (numbered from zero) to select
1312  *
1313  *      Use the method defined in the ATA specification to
1314  *      make either device 0, or device 1, active on the
1315  *      ATA channel.  Works with both PIO and MMIO.
1316  *
1317  *      May be used as the dev_select() entry in ata_port_operations.
1318  *
1319  *      LOCKING:
1320  *      caller.
1321  */
1322
1323 void ata_std_dev_select(struct ata_port *ap, unsigned int device)
1324 {
1325         u8 tmp;
1326
1327         if (device == 0)
1328                 tmp = ATA_DEVICE_OBS;
1329         else
1330                 tmp = ATA_DEVICE_OBS | ATA_DEV1;
1331
1332         iowrite8(tmp, ap->ioaddr.device_addr);
1333         ata_pause(ap);          /* needed; also flushes, for mmio */
1334 }
1335
1336 /**
1337  *      ata_dev_select - Select device 0/1 on ATA bus
1338  *      @ap: ATA channel to manipulate
1339  *      @device: ATA device (numbered from zero) to select
1340  *      @wait: non-zero to wait for Status register BSY bit to clear
1341  *      @can_sleep: non-zero if context allows sleeping
1342  *
1343  *      Use the method defined in the ATA specification to
1344  *      make either device 0, or device 1, active on the
1345  *      ATA channel.
1346  *
1347  *      This is a high-level version of ata_std_dev_select(),
1348  *      which additionally provides the services of inserting
1349  *      the proper pauses and status polling, where needed.
1350  *
1351  *      LOCKING:
1352  *      caller.
1353  */
1354
1355 void ata_dev_select(struct ata_port *ap, unsigned int device,
1356                            unsigned int wait, unsigned int can_sleep)
1357 {
1358         if (ata_msg_probe(ap))
1359                 ata_port_printk(ap, KERN_INFO, "ata_dev_select: ENTER, "
1360                                 "device %u, wait %u\n", device, wait);
1361
1362         if (wait)
1363                 ata_wait_idle(ap);
1364
1365         ap->ops->dev_select(ap, device);
1366
1367         if (wait) {
1368                 if (can_sleep && ap->link.device[device].class == ATA_DEV_ATAPI)
1369                         msleep(150);
1370                 ata_wait_idle(ap);
1371         }
1372 }
1373
1374 /**
1375  *      ata_dump_id - IDENTIFY DEVICE info debugging output
1376  *      @id: IDENTIFY DEVICE page to dump
1377  *
1378  *      Dump selected 16-bit words from the given IDENTIFY DEVICE
1379  *      page.
1380  *
1381  *      LOCKING:
1382  *      caller.
1383  */
1384
1385 static inline void ata_dump_id(const u16 *id)
1386 {
1387         DPRINTK("49==0x%04x  "
1388                 "53==0x%04x  "
1389                 "63==0x%04x  "
1390                 "64==0x%04x  "
1391                 "75==0x%04x  \n",
1392                 id[49],
1393                 id[53],
1394                 id[63],
1395                 id[64],
1396                 id[75]);
1397         DPRINTK("80==0x%04x  "
1398                 "81==0x%04x  "
1399                 "82==0x%04x  "
1400                 "83==0x%04x  "
1401                 "84==0x%04x  \n",
1402                 id[80],
1403                 id[81],
1404                 id[82],
1405                 id[83],
1406                 id[84]);
1407         DPRINTK("88==0x%04x  "
1408                 "93==0x%04x\n",
1409                 id[88],
1410                 id[93]);
1411 }
1412
1413 /**
1414  *      ata_id_xfermask - Compute xfermask from the given IDENTIFY data
1415  *      @id: IDENTIFY data to compute xfer mask from
1416  *
1417  *      Compute the xfermask for this device. This is not as trivial
1418  *      as it seems if we must consider early devices correctly.
1419  *
1420  *      FIXME: pre IDE drive timing (do we care ?).
1421  *
1422  *      LOCKING:
1423  *      None.
1424  *
1425  *      RETURNS:
1426  *      Computed xfermask
1427  */
1428 unsigned long ata_id_xfermask(const u16 *id)
1429 {
1430         unsigned long pio_mask, mwdma_mask, udma_mask;
1431
1432         /* Usual case. Word 53 indicates word 64 is valid */
1433         if (id[ATA_ID_FIELD_VALID] & (1 << 1)) {
1434                 pio_mask = id[ATA_ID_PIO_MODES] & 0x03;
1435                 pio_mask <<= 3;
1436                 pio_mask |= 0x7;
1437         } else {
1438                 /* If word 64 isn't valid then Word 51 high byte holds
1439                  * the PIO timing number for the maximum. Turn it into
1440                  * a mask.
1441                  */
1442                 u8 mode = (id[ATA_ID_OLD_PIO_MODES] >> 8) & 0xFF;
1443                 if (mode < 5)   /* Valid PIO range */
1444                         pio_mask = (2 << mode) - 1;
1445                 else
1446                         pio_mask = 1;
1447
1448                 /* But wait.. there's more. Design your standards by
1449                  * committee and you too can get a free iordy field to
1450                  * process. However its the speeds not the modes that
1451                  * are supported... Note drivers using the timing API
1452                  * will get this right anyway
1453                  */
1454         }
1455
1456         mwdma_mask = id[ATA_ID_MWDMA_MODES] & 0x07;
1457
1458         if (ata_id_is_cfa(id)) {
1459                 /*
1460                  *      Process compact flash extended modes
1461                  */
1462                 int pio = id[163] & 0x7;
1463                 int dma = (id[163] >> 3) & 7;
1464
1465                 if (pio)
1466                         pio_mask |= (1 << 5);
1467                 if (pio > 1)
1468                         pio_mask |= (1 << 6);
1469                 if (dma)
1470                         mwdma_mask |= (1 << 3);
1471                 if (dma > 1)
1472                         mwdma_mask |= (1 << 4);
1473         }
1474
1475         udma_mask = 0;
1476         if (id[ATA_ID_FIELD_VALID] & (1 << 2))
1477                 udma_mask = id[ATA_ID_UDMA_MODES] & 0xff;
1478
1479         return ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
1480 }
1481
1482 /**
1483  *      ata_port_queue_task - Queue port_task
1484  *      @ap: The ata_port to queue port_task for
1485  *      @fn: workqueue function to be scheduled
1486  *      @data: data for @fn to use
1487  *      @delay: delay time for workqueue function
1488  *
1489  *      Schedule @fn(@data) for execution after @delay jiffies using
1490  *      port_task.  There is one port_task per port and it's the
1491  *      user(low level driver)'s responsibility to make sure that only
1492  *      one task is active at any given time.
1493  *
1494  *      libata core layer takes care of synchronization between
1495  *      port_task and EH.  ata_port_queue_task() may be ignored for EH
1496  *      synchronization.
1497  *
1498  *      LOCKING:
1499  *      Inherited from caller.
1500  */
1501 void ata_port_queue_task(struct ata_port *ap, work_func_t fn, void *data,
1502                          unsigned long delay)
1503 {
1504         PREPARE_DELAYED_WORK(&ap->port_task, fn);
1505         ap->port_task_data = data;
1506
1507         /* may fail if ata_port_flush_task() in progress */
1508         queue_delayed_work(ata_wq, &ap->port_task, delay);
1509 }
1510
1511 /**
1512  *      ata_port_flush_task - Flush port_task
1513  *      @ap: The ata_port to flush port_task for
1514  *
1515  *      After this function completes, port_task is guranteed not to
1516  *      be running or scheduled.
1517  *
1518  *      LOCKING:
1519  *      Kernel thread context (may sleep)
1520  */
1521 void ata_port_flush_task(struct ata_port *ap)
1522 {
1523         DPRINTK("ENTER\n");
1524
1525         cancel_rearming_delayed_work(&ap->port_task);
1526
1527         if (ata_msg_ctl(ap))
1528                 ata_port_printk(ap, KERN_DEBUG, "%s: EXIT\n", __FUNCTION__);
1529 }
1530
1531 static void ata_qc_complete_internal(struct ata_queued_cmd *qc)
1532 {
1533         struct completion *waiting = qc->private_data;
1534
1535         complete(waiting);
1536 }
1537
1538 /**
1539  *      ata_exec_internal_sg - execute libata internal command
1540  *      @dev: Device to which the command is sent
1541  *      @tf: Taskfile registers for the command and the result
1542  *      @cdb: CDB for packet command
1543  *      @dma_dir: Data tranfer direction of the command
1544  *      @sgl: sg list for the data buffer of the command
1545  *      @n_elem: Number of sg entries
1546  *      @timeout: Timeout in msecs (0 for default)
1547  *
1548  *      Executes libata internal command with timeout.  @tf contains
1549  *      command on entry and result on return.  Timeout and error
1550  *      conditions are reported via return value.  No recovery action
1551  *      is taken after a command times out.  It's caller's duty to
1552  *      clean up after timeout.
1553  *
1554  *      LOCKING:
1555  *      None.  Should be called with kernel context, might sleep.
1556  *
1557  *      RETURNS:
1558  *      Zero on success, AC_ERR_* mask on failure
1559  */
1560 unsigned ata_exec_internal_sg(struct ata_device *dev,
1561                               struct ata_taskfile *tf, const u8 *cdb,
1562                               int dma_dir, struct scatterlist *sgl,
1563                               unsigned int n_elem, unsigned long timeout)
1564 {
1565         struct ata_link *link = dev->link;
1566         struct ata_port *ap = link->ap;
1567         u8 command = tf->command;
1568         struct ata_queued_cmd *qc;
1569         unsigned int tag, preempted_tag;
1570         u32 preempted_sactive, preempted_qc_active;
1571         int preempted_nr_active_links;
1572         DECLARE_COMPLETION_ONSTACK(wait);
1573         unsigned long flags;
1574         unsigned int err_mask;
1575         int rc;
1576
1577         spin_lock_irqsave(ap->lock, flags);
1578
1579         /* no internal command while frozen */
1580         if (ap->pflags & ATA_PFLAG_FROZEN) {
1581                 spin_unlock_irqrestore(ap->lock, flags);
1582                 return AC_ERR_SYSTEM;
1583         }
1584
1585         /* initialize internal qc */
1586
1587         /* XXX: Tag 0 is used for drivers with legacy EH as some
1588          * drivers choke if any other tag is given.  This breaks
1589          * ata_tag_internal() test for those drivers.  Don't use new
1590          * EH stuff without converting to it.
1591          */
1592         if (ap->ops->error_handler)
1593                 tag = ATA_TAG_INTERNAL;
1594         else
1595                 tag = 0;
1596
1597         if (test_and_set_bit(tag, &ap->qc_allocated))
1598                 BUG();
1599         qc = __ata_qc_from_tag(ap, tag);
1600
1601         qc->tag = tag;
1602         qc->scsicmd = NULL;
1603         qc->ap = ap;
1604         qc->dev = dev;
1605         ata_qc_reinit(qc);
1606
1607         preempted_tag = link->active_tag;
1608         preempted_sactive = link->sactive;
1609         preempted_qc_active = ap->qc_active;
1610         preempted_nr_active_links = ap->nr_active_links;
1611         link->active_tag = ATA_TAG_POISON;
1612         link->sactive = 0;
1613         ap->qc_active = 0;
1614         ap->nr_active_links = 0;
1615
1616         /* prepare & issue qc */
1617         qc->tf = *tf;
1618         if (cdb)
1619                 memcpy(qc->cdb, cdb, ATAPI_CDB_LEN);
1620         qc->flags |= ATA_QCFLAG_RESULT_TF;
1621         qc->dma_dir = dma_dir;
1622         if (dma_dir != DMA_NONE) {
1623                 unsigned int i, buflen = 0;
1624                 struct scatterlist *sg;
1625
1626                 for_each_sg(sgl, sg, n_elem, i)
1627                         buflen += sg->length;
1628
1629                 ata_sg_init(qc, sgl, n_elem);
1630                 qc->nbytes = buflen;
1631         }
1632
1633         qc->private_data = &wait;
1634         qc->complete_fn = ata_qc_complete_internal;
1635
1636         ata_qc_issue(qc);
1637
1638         spin_unlock_irqrestore(ap->lock, flags);
1639
1640         if (!timeout)
1641                 timeout = ata_probe_timeout * 1000 / HZ;
1642
1643         rc = wait_for_completion_timeout(&wait, msecs_to_jiffies(timeout));
1644
1645         ata_port_flush_task(ap);
1646
1647         if (!rc) {
1648                 spin_lock_irqsave(ap->lock, flags);
1649
1650                 /* We're racing with irq here.  If we lose, the
1651                  * following test prevents us from completing the qc
1652                  * twice.  If we win, the port is frozen and will be
1653                  * cleaned up by ->post_internal_cmd().
1654                  */
1655                 if (qc->flags & ATA_QCFLAG_ACTIVE) {
1656                         qc->err_mask |= AC_ERR_TIMEOUT;
1657
1658                         if (ap->ops->error_handler)
1659                                 ata_port_freeze(ap);
1660                         else
1661                                 ata_qc_complete(qc);
1662
1663                         if (ata_msg_warn(ap))
1664                                 ata_dev_printk(dev, KERN_WARNING,
1665                                         "qc timeout (cmd 0x%x)\n", command);
1666                 }
1667
1668                 spin_unlock_irqrestore(ap->lock, flags);
1669         }
1670
1671         /* do post_internal_cmd */
1672         if (ap->ops->post_internal_cmd)
1673                 ap->ops->post_internal_cmd(qc);
1674
1675         /* perform minimal error analysis */
1676         if (qc->flags & ATA_QCFLAG_FAILED) {
1677                 if (qc->result_tf.command & (ATA_ERR | ATA_DF))
1678                         qc->err_mask |= AC_ERR_DEV;
1679
1680                 if (!qc->err_mask)
1681                         qc->err_mask |= AC_ERR_OTHER;
1682
1683                 if (qc->err_mask & ~AC_ERR_OTHER)
1684                         qc->err_mask &= ~AC_ERR_OTHER;
1685         }
1686
1687         /* finish up */
1688         spin_lock_irqsave(ap->lock, flags);
1689
1690         *tf = qc->result_tf;
1691         err_mask = qc->err_mask;
1692
1693         ata_qc_free(qc);
1694         link->active_tag = preempted_tag;
1695         link->sactive = preempted_sactive;
1696         ap->qc_active = preempted_qc_active;
1697         ap->nr_active_links = preempted_nr_active_links;
1698
1699         /* XXX - Some LLDDs (sata_mv) disable port on command failure.
1700          * Until those drivers are fixed, we detect the condition
1701          * here, fail the command with AC_ERR_SYSTEM and reenable the
1702          * port.
1703          *
1704          * Note that this doesn't change any behavior as internal
1705          * command failure results in disabling the device in the
1706          * higher layer for LLDDs without new reset/EH callbacks.
1707          *
1708          * Kill the following code as soon as those drivers are fixed.
1709          */
1710         if (ap->flags & ATA_FLAG_DISABLED) {
1711                 err_mask |= AC_ERR_SYSTEM;
1712                 ata_port_probe(ap);
1713         }
1714
1715         spin_unlock_irqrestore(ap->lock, flags);
1716
1717         return err_mask;
1718 }
1719
1720 /**
1721  *      ata_exec_internal - execute libata internal command
1722  *      @dev: Device to which the command is sent
1723  *      @tf: Taskfile registers for the command and the result
1724  *      @cdb: CDB for packet command
1725  *      @dma_dir: Data tranfer direction of the command
1726  *      @buf: Data buffer of the command
1727  *      @buflen: Length of data buffer
1728  *      @timeout: Timeout in msecs (0 for default)
1729  *
1730  *      Wrapper around ata_exec_internal_sg() which takes simple
1731  *      buffer instead of sg list.
1732  *
1733  *      LOCKING:
1734  *      None.  Should be called with kernel context, might sleep.
1735  *
1736  *      RETURNS:
1737  *      Zero on success, AC_ERR_* mask on failure
1738  */
1739 unsigned ata_exec_internal(struct ata_device *dev,
1740                            struct ata_taskfile *tf, const u8 *cdb,
1741                            int dma_dir, void *buf, unsigned int buflen,
1742                            unsigned long timeout)
1743 {
1744         struct scatterlist *psg = NULL, sg;
1745         unsigned int n_elem = 0;
1746
1747         if (dma_dir != DMA_NONE) {
1748                 WARN_ON(!buf);
1749                 sg_init_one(&sg, buf, buflen);
1750                 psg = &sg;
1751                 n_elem++;
1752         }
1753
1754         return ata_exec_internal_sg(dev, tf, cdb, dma_dir, psg, n_elem,
1755                                     timeout);
1756 }
1757
1758 /**
1759  *      ata_do_simple_cmd - execute simple internal command
1760  *      @dev: Device to which the command is sent
1761  *      @cmd: Opcode to execute
1762  *
1763  *      Execute a 'simple' command, that only consists of the opcode
1764  *      'cmd' itself, without filling any other registers
1765  *
1766  *      LOCKING:
1767  *      Kernel thread context (may sleep).
1768  *
1769  *      RETURNS:
1770  *      Zero on success, AC_ERR_* mask on failure
1771  */
1772 unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd)
1773 {
1774         struct ata_taskfile tf;
1775
1776         ata_tf_init(dev, &tf);
1777
1778         tf.command = cmd;
1779         tf.flags |= ATA_TFLAG_DEVICE;
1780         tf.protocol = ATA_PROT_NODATA;
1781
1782         return ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1783 }
1784
1785 /**
1786  *      ata_pio_need_iordy      -       check if iordy needed
1787  *      @adev: ATA device
1788  *
1789  *      Check if the current speed of the device requires IORDY. Used
1790  *      by various controllers for chip configuration.
1791  */
1792
1793 unsigned int ata_pio_need_iordy(const struct ata_device *adev)
1794 {
1795         /* Controller doesn't support  IORDY. Probably a pointless check
1796            as the caller should know this */
1797         if (adev->link->ap->flags & ATA_FLAG_NO_IORDY)
1798                 return 0;
1799         /* PIO3 and higher it is mandatory */
1800         if (adev->pio_mode > XFER_PIO_2)
1801                 return 1;
1802         /* We turn it on when possible */
1803         if (ata_id_has_iordy(adev->id))
1804                 return 1;
1805         return 0;
1806 }
1807
1808 /**
1809  *      ata_pio_mask_no_iordy   -       Return the non IORDY mask
1810  *      @adev: ATA device
1811  *
1812  *      Compute the highest mode possible if we are not using iordy. Return
1813  *      -1 if no iordy mode is available.
1814  */
1815
1816 static u32 ata_pio_mask_no_iordy(const struct ata_device *adev)
1817 {
1818         /* If we have no drive specific rule, then PIO 2 is non IORDY */
1819         if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE */
1820                 u16 pio = adev->id[ATA_ID_EIDE_PIO];
1821                 /* Is the speed faster than the drive allows non IORDY ? */
1822                 if (pio) {
1823                         /* This is cycle times not frequency - watch the logic! */
1824                         if (pio > 240)  /* PIO2 is 240nS per cycle */
1825                                 return 3 << ATA_SHIFT_PIO;
1826                         return 7 << ATA_SHIFT_PIO;
1827                 }
1828         }
1829         return 3 << ATA_SHIFT_PIO;
1830 }
1831
1832 /**
1833  *      ata_dev_read_id - Read ID data from the specified device
1834  *      @dev: target device
1835  *      @p_class: pointer to class of the target device (may be changed)
1836  *      @flags: ATA_READID_* flags
1837  *      @id: buffer to read IDENTIFY data into
1838  *
1839  *      Read ID data from the specified device.  ATA_CMD_ID_ATA is
1840  *      performed on ATA devices and ATA_CMD_ID_ATAPI on ATAPI
1841  *      devices.  This function also issues ATA_CMD_INIT_DEV_PARAMS
1842  *      for pre-ATA4 drives.
1843  *
1844  *      FIXME: ATA_CMD_ID_ATA is optional for early drives and right
1845  *      now we abort if we hit that case.
1846  *
1847  *      LOCKING:
1848  *      Kernel thread context (may sleep)
1849  *
1850  *      RETURNS:
1851  *      0 on success, -errno otherwise.
1852  */
1853 int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
1854                     unsigned int flags, u16 *id)
1855 {
1856         struct ata_port *ap = dev->link->ap;
1857         unsigned int class = *p_class;
1858         struct ata_taskfile tf;
1859         unsigned int err_mask = 0;
1860         const char *reason;
1861         int may_fallback = 1, tried_spinup = 0;
1862         int rc;
1863
1864         if (ata_msg_ctl(ap))
1865                 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER\n", __FUNCTION__);
1866
1867         ata_dev_select(ap, dev->devno, 1, 1); /* select device 0/1 */
1868  retry:
1869         ata_tf_init(dev, &tf);
1870
1871         switch (class) {
1872         case ATA_DEV_ATA:
1873                 tf.command = ATA_CMD_ID_ATA;
1874                 break;
1875         case ATA_DEV_ATAPI:
1876                 tf.command = ATA_CMD_ID_ATAPI;
1877                 break;
1878         default:
1879                 rc = -ENODEV;
1880                 reason = "unsupported class";
1881                 goto err_out;
1882         }
1883
1884         tf.protocol = ATA_PROT_PIO;
1885
1886         /* Some devices choke if TF registers contain garbage.  Make
1887          * sure those are properly initialized.
1888          */
1889         tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1890
1891         /* Device presence detection is unreliable on some
1892          * controllers.  Always poll IDENTIFY if available.
1893          */
1894         tf.flags |= ATA_TFLAG_POLLING;
1895
1896         err_mask = ata_exec_internal(dev, &tf, NULL, DMA_FROM_DEVICE,
1897                                      id, sizeof(id[0]) * ATA_ID_WORDS, 0);
1898         if (err_mask) {
1899                 if (err_mask & AC_ERR_NODEV_HINT) {
1900                         DPRINTK("ata%u.%d: NODEV after polling detection\n",
1901                                 ap->print_id, dev->devno);
1902                         return -ENOENT;
1903                 }
1904
1905                 /* Device or controller might have reported the wrong
1906                  * device class.  Give a shot at the other IDENTIFY if
1907                  * the current one is aborted by the device.
1908                  */
1909                 if (may_fallback &&
1910                     (err_mask == AC_ERR_DEV) && (tf.feature & ATA_ABORTED)) {
1911                         may_fallback = 0;
1912
1913                         if (class == ATA_DEV_ATA)
1914                                 class = ATA_DEV_ATAPI;
1915                         else
1916                                 class = ATA_DEV_ATA;
1917                         goto retry;
1918                 }
1919
1920                 rc = -EIO;
1921                 reason = "I/O error";
1922                 goto err_out;
1923         }
1924
1925         /* Falling back doesn't make sense if ID data was read
1926          * successfully at least once.
1927          */
1928         may_fallback = 0;
1929
1930         swap_buf_le16(id, ATA_ID_WORDS);
1931
1932         /* sanity check */
1933         rc = -EINVAL;
1934         reason = "device reports invalid type";
1935
1936         if (class == ATA_DEV_ATA) {
1937                 if (!ata_id_is_ata(id) && !ata_id_is_cfa(id))
1938                         goto err_out;
1939         } else {
1940                 if (ata_id_is_ata(id))
1941                         goto err_out;
1942         }
1943
1944         if (!tried_spinup && (id[2] == 0x37c8 || id[2] == 0x738c)) {
1945                 tried_spinup = 1;
1946                 /*
1947                  * Drive powered-up in standby mode, and requires a specific
1948                  * SET_FEATURES spin-up subcommand before it will accept
1949                  * anything other than the original IDENTIFY command.
1950                  */
1951                 err_mask = ata_dev_set_feature(dev, SETFEATURES_SPINUP, 0);
1952                 if (err_mask && id[2] != 0x738c) {
1953                         rc = -EIO;
1954                         reason = "SPINUP failed";
1955                         goto err_out;
1956                 }
1957                 /*
1958                  * If the drive initially returned incomplete IDENTIFY info,
1959                  * we now must reissue the IDENTIFY command.
1960                  */
1961                 if (id[2] == 0x37c8)
1962                         goto retry;
1963         }
1964
1965         if ((flags & ATA_READID_POSTRESET) && class == ATA_DEV_ATA) {
1966                 /*
1967                  * The exact sequence expected by certain pre-ATA4 drives is:
1968                  * SRST RESET
1969                  * IDENTIFY (optional in early ATA)
1970                  * INITIALIZE DEVICE PARAMETERS (later IDE and ATA)
1971                  * anything else..
1972                  * Some drives were very specific about that exact sequence.
1973                  *
1974                  * Note that ATA4 says lba is mandatory so the second check
1975                  * shoud never trigger.
1976                  */
1977                 if (ata_id_major_version(id) < 4 || !ata_id_has_lba(id)) {
1978                         err_mask = ata_dev_init_params(dev, id[3], id[6]);
1979                         if (err_mask) {
1980                                 rc = -EIO;
1981                                 reason = "INIT_DEV_PARAMS failed";
1982                                 goto err_out;
1983                         }
1984
1985                         /* current CHS translation info (id[53-58]) might be
1986                          * changed. reread the identify device info.
1987                          */
1988                         flags &= ~ATA_READID_POSTRESET;
1989                         goto retry;
1990                 }
1991         }
1992
1993         *p_class = class;
1994
1995         return 0;
1996
1997  err_out:
1998         if (ata_msg_warn(ap))
1999                 ata_dev_printk(dev, KERN_WARNING, "failed to IDENTIFY "
2000                                "(%s, err_mask=0x%x)\n", reason, err_mask);
2001         return rc;
2002 }
2003
2004 static inline u8 ata_dev_knobble(struct ata_device *dev)
2005 {
2006         struct ata_port *ap = dev->link->ap;
2007         return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(dev->id)));
2008 }
2009
2010 static void ata_dev_config_ncq(struct ata_device *dev,
2011                                char *desc, size_t desc_sz)
2012 {
2013         struct ata_port *ap = dev->link->ap;
2014         int hdepth = 0, ddepth = ata_id_queue_depth(dev->id);
2015
2016         if (!ata_id_has_ncq(dev->id)) {
2017                 desc[0] = '\0';
2018                 return;
2019         }
2020         if (dev->horkage & ATA_HORKAGE_NONCQ) {
2021                 snprintf(desc, desc_sz, "NCQ (not used)");
2022                 return;
2023         }
2024         if (ap->flags & ATA_FLAG_NCQ) {
2025                 hdepth = min(ap->scsi_host->can_queue, ATA_MAX_QUEUE - 1);
2026                 dev->flags |= ATA_DFLAG_NCQ;
2027         }
2028
2029         if (hdepth >= ddepth)
2030                 snprintf(desc, desc_sz, "NCQ (depth %d)", ddepth);
2031         else
2032                 snprintf(desc, desc_sz, "NCQ (depth %d/%d)", hdepth, ddepth);
2033 }
2034
2035 /**
2036  *      ata_dev_configure - Configure the specified ATA/ATAPI device
2037  *      @dev: Target device to configure
2038  *
2039  *      Configure @dev according to @dev->id.  Generic and low-level
2040  *      driver specific fixups are also applied.
2041  *
2042  *      LOCKING:
2043  *      Kernel thread context (may sleep)
2044  *
2045  *      RETURNS:
2046  *      0 on success, -errno otherwise
2047  */
2048 int ata_dev_configure(struct ata_device *dev)
2049 {
2050         struct ata_port *ap = dev->link->ap;
2051         struct ata_eh_context *ehc = &dev->link->eh_context;
2052         int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
2053         const u16 *id = dev->id;
2054         unsigned long xfer_mask;
2055         char revbuf[7];         /* XYZ-99\0 */
2056         char fwrevbuf[ATA_ID_FW_REV_LEN+1];
2057         char modelbuf[ATA_ID_PROD_LEN+1];
2058         int rc;
2059
2060         if (!ata_dev_enabled(dev) && ata_msg_info(ap)) {
2061                 ata_dev_printk(dev, KERN_INFO, "%s: ENTER/EXIT -- nodev\n",
2062                                __FUNCTION__);
2063                 return 0;
2064         }
2065
2066         if (ata_msg_probe(ap))
2067                 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER\n", __FUNCTION__);
2068
2069         /* set horkage */
2070         dev->horkage |= ata_dev_blacklisted(dev);
2071
2072         /* let ACPI work its magic */
2073         rc = ata_acpi_on_devcfg(dev);
2074         if (rc)
2075                 return rc;
2076
2077         /* massage HPA, do it early as it might change IDENTIFY data */
2078         rc = ata_hpa_resize(dev);
2079         if (rc)
2080                 return rc;
2081
2082         /* print device capabilities */
2083         if (ata_msg_probe(ap))
2084                 ata_dev_printk(dev, KERN_DEBUG,
2085                                "%s: cfg 49:%04x 82:%04x 83:%04x 84:%04x "
2086                                "85:%04x 86:%04x 87:%04x 88:%04x\n",
2087                                __FUNCTION__,
2088                                id[49], id[82], id[83], id[84],
2089                                id[85], id[86], id[87], id[88]);
2090
2091         /* initialize to-be-configured parameters */
2092         dev->flags &= ~ATA_DFLAG_CFG_MASK;
2093         dev->max_sectors = 0;
2094         dev->cdb_len = 0;
2095         dev->n_sectors = 0;
2096         dev->cylinders = 0;
2097         dev->heads = 0;
2098         dev->sectors = 0;
2099
2100         /*
2101          * common ATA, ATAPI feature tests
2102          */
2103
2104         /* find max transfer mode; for printk only */
2105         xfer_mask = ata_id_xfermask(id);
2106
2107         if (ata_msg_probe(ap))
2108                 ata_dump_id(id);
2109
2110         /* SCSI only uses 4-char revisions, dump full 8 chars from ATA */
2111         ata_id_c_string(dev->id, fwrevbuf, ATA_ID_FW_REV,
2112                         sizeof(fwrevbuf));
2113
2114         ata_id_c_string(dev->id, modelbuf, ATA_ID_PROD,
2115                         sizeof(modelbuf));
2116
2117         /* ATA-specific feature tests */
2118         if (dev->class == ATA_DEV_ATA) {
2119                 if (ata_id_is_cfa(id)) {
2120                         if (id[162] & 1) /* CPRM may make this media unusable */
2121                                 ata_dev_printk(dev, KERN_WARNING,
2122                                                "supports DRM functions and may "
2123                                                "not be fully accessable.\n");
2124                         snprintf(revbuf, 7, "CFA");
2125                 } else {
2126                         snprintf(revbuf, 7, "ATA-%d", ata_id_major_version(id));
2127                         /* Warn the user if the device has TPM extensions */
2128                         if (ata_id_has_tpm(id))
2129                                 ata_dev_printk(dev, KERN_WARNING,
2130                                                "supports DRM functions and may "
2131                                                "not be fully accessable.\n");
2132                 }
2133
2134                 dev->n_sectors = ata_id_n_sectors(id);
2135
2136                 if (dev->id[59] & 0x100)
2137                         dev->multi_count = dev->id[59] & 0xff;
2138
2139                 if (ata_id_has_lba(id)) {
2140                         const char *lba_desc;
2141                         char ncq_desc[20];
2142
2143                         lba_desc = "LBA";
2144                         dev->flags |= ATA_DFLAG_LBA;
2145                         if (ata_id_has_lba48(id)) {
2146                                 dev->flags |= ATA_DFLAG_LBA48;
2147                                 lba_desc = "LBA48";
2148
2149                                 if (dev->n_sectors >= (1UL << 28) &&
2150                                     ata_id_has_flush_ext(id))
2151                                         dev->flags |= ATA_DFLAG_FLUSH_EXT;
2152                         }
2153
2154                         /* config NCQ */
2155                         ata_dev_config_ncq(dev, ncq_desc, sizeof(ncq_desc));
2156
2157                         /* print device info to dmesg */
2158                         if (ata_msg_drv(ap) && print_info) {
2159                                 ata_dev_printk(dev, KERN_INFO,
2160                                         "%s: %s, %s, max %s\n",
2161                                         revbuf, modelbuf, fwrevbuf,
2162                                         ata_mode_string(xfer_mask));
2163                                 ata_dev_printk(dev, KERN_INFO,
2164                                         "%Lu sectors, multi %u: %s %s\n",
2165                                         (unsigned long long)dev->n_sectors,
2166                                         dev->multi_count, lba_desc, ncq_desc);
2167                         }
2168                 } else {
2169                         /* CHS */
2170
2171                         /* Default translation */
2172                         dev->cylinders  = id[1];
2173                         dev->heads      = id[3];
2174                         dev->sectors    = id[6];
2175
2176                         if (ata_id_current_chs_valid(id)) {
2177                                 /* Current CHS translation is valid. */
2178                                 dev->cylinders = id[54];
2179                                 dev->heads     = id[55];
2180                                 dev->sectors   = id[56];
2181                         }
2182
2183                         /* print device info to dmesg */
2184                         if (ata_msg_drv(ap) && print_info) {
2185                                 ata_dev_printk(dev, KERN_INFO,
2186                                         "%s: %s, %s, max %s\n",
2187                                         revbuf, modelbuf, fwrevbuf,
2188                                         ata_mode_string(xfer_mask));
2189                                 ata_dev_printk(dev, KERN_INFO,
2190                                         "%Lu sectors, multi %u, CHS %u/%u/%u\n",
2191                                         (unsigned long long)dev->n_sectors,
2192                                         dev->multi_count, dev->cylinders,
2193                                         dev->heads, dev->sectors);
2194                         }
2195                 }
2196
2197                 dev->cdb_len = 16;
2198         }
2199
2200         /* ATAPI-specific feature tests */
2201         else if (dev->class == ATA_DEV_ATAPI) {
2202                 const char *cdb_intr_string = "";
2203                 const char *atapi_an_string = "";
2204                 u32 sntf;
2205
2206                 rc = atapi_cdb_len(id);
2207                 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
2208                         if (ata_msg_warn(ap))
2209                                 ata_dev_printk(dev, KERN_WARNING,
2210                                                "unsupported CDB len\n");
2211                         rc = -EINVAL;
2212                         goto err_out_nosup;
2213                 }
2214                 dev->cdb_len = (unsigned int) rc;
2215
2216                 /* Enable ATAPI AN if both the host and device have
2217                  * the support.  If PMP is attached, SNTF is required
2218                  * to enable ATAPI AN to discern between PHY status
2219                  * changed notifications and ATAPI ANs.
2220                  */
2221                 if ((ap->flags & ATA_FLAG_AN) && ata_id_has_atapi_AN(id) &&
2222                     (!ap->nr_pmp_links ||
2223                      sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf) == 0)) {
2224                         unsigned int err_mask;
2225
2226                         /* issue SET feature command to turn this on */
2227                         err_mask = ata_dev_set_feature(dev,
2228                                         SETFEATURES_SATA_ENABLE, SATA_AN);
2229                         if (err_mask)
2230                                 ata_dev_printk(dev, KERN_ERR,
2231                                         "failed to enable ATAPI AN "
2232                                         "(err_mask=0x%x)\n", err_mask);
2233                         else {
2234                                 dev->flags |= ATA_DFLAG_AN;
2235                                 atapi_an_string = ", ATAPI AN";
2236                         }
2237                 }
2238
2239                 if (ata_id_cdb_intr(dev->id)) {
2240                         dev->flags |= ATA_DFLAG_CDB_INTR;
2241                         cdb_intr_string = ", CDB intr";
2242                 }
2243
2244                 /* print device info to dmesg */
2245                 if (ata_msg_drv(ap) && print_info)
2246                         ata_dev_printk(dev, KERN_INFO,
2247                                        "ATAPI: %s, %s, max %s%s%s\n",
2248                                        modelbuf, fwrevbuf,
2249                                        ata_mode_string(xfer_mask),
2250                                        cdb_intr_string, atapi_an_string);
2251         }
2252
2253         /* determine max_sectors */
2254         dev->max_sectors = ATA_MAX_SECTORS;
2255         if (dev->flags & ATA_DFLAG_LBA48)
2256                 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2257
2258         if (!(dev->horkage & ATA_HORKAGE_IPM)) {
2259                 if (ata_id_has_hipm(dev->id))
2260                         dev->flags |= ATA_DFLAG_HIPM;
2261                 if (ata_id_has_dipm(dev->id))
2262                         dev->flags |= ATA_DFLAG_DIPM;
2263         }
2264
2265         if (dev->horkage & ATA_HORKAGE_DIAGNOSTIC) {
2266                 /* Let the user know. We don't want to disallow opens for
2267                    rescue purposes, or in case the vendor is just a blithering
2268                    idiot */
2269                 if (print_info) {
2270                         ata_dev_printk(dev, KERN_WARNING,
2271 "Drive reports diagnostics failure. This may indicate a drive\n");
2272                         ata_dev_printk(dev, KERN_WARNING,
2273 "fault or invalid emulation. Contact drive vendor for information.\n");
2274                 }
2275         }
2276
2277         /* limit bridge transfers to udma5, 200 sectors */
2278         if (ata_dev_knobble(dev)) {
2279                 if (ata_msg_drv(ap) && print_info)
2280                         ata_dev_printk(dev, KERN_INFO,
2281                                        "applying bridge limits\n");
2282                 dev->udma_mask &= ATA_UDMA5;
2283                 dev->max_sectors = ATA_MAX_SECTORS;
2284         }
2285
2286         if ((dev->class == ATA_DEV_ATAPI) &&
2287             (atapi_command_packet_set(id) == TYPE_TAPE)) {
2288                 dev->max_sectors = ATA_MAX_SECTORS_TAPE;
2289                 dev->horkage |= ATA_HORKAGE_STUCK_ERR;
2290         }
2291
2292         if (dev->horkage & ATA_HORKAGE_MAX_SEC_128)
2293                 dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_128,
2294                                          dev->max_sectors);
2295
2296         if (ata_dev_blacklisted(dev) & ATA_HORKAGE_IPM) {
2297                 dev->horkage |= ATA_HORKAGE_IPM;
2298
2299                 /* reset link pm_policy for this port to no pm */
2300                 ap->pm_policy = MAX_PERFORMANCE;
2301         }
2302
2303         if (ap->ops->dev_config)
2304                 ap->ops->dev_config(dev);
2305
2306         if (ata_msg_probe(ap))
2307                 ata_dev_printk(dev, KERN_DEBUG, "%s: EXIT, drv_stat = 0x%x\n",
2308                         __FUNCTION__, ata_chk_status(ap));
2309         return 0;
2310
2311 err_out_nosup:
2312         if (ata_msg_probe(ap))
2313                 ata_dev_printk(dev, KERN_DEBUG,
2314                                "%s: EXIT, err\n", __FUNCTION__);
2315         return rc;
2316 }
2317
2318 /**
2319  *      ata_cable_40wire        -       return 40 wire cable type
2320  *      @ap: port
2321  *
2322  *      Helper method for drivers which want to hardwire 40 wire cable
2323  *      detection.
2324  */
2325
2326 int ata_cable_40wire(struct ata_port *ap)
2327 {
2328         return ATA_CBL_PATA40;
2329 }
2330
2331 /**
2332  *      ata_cable_80wire        -       return 80 wire cable type
2333  *      @ap: port
2334  *
2335  *      Helper method for drivers which want to hardwire 80 wire cable
2336  *      detection.
2337  */
2338
2339 int ata_cable_80wire(struct ata_port *ap)
2340 {
2341         return ATA_CBL_PATA80;
2342 }
2343
2344 /**
2345  *      ata_cable_unknown       -       return unknown PATA cable.
2346  *      @ap: port
2347  *
2348  *      Helper method for drivers which have no PATA cable detection.
2349  */
2350
2351 int ata_cable_unknown(struct ata_port *ap)
2352 {
2353         return ATA_CBL_PATA_UNK;
2354 }
2355
2356 /**
2357  *      ata_cable_ignore        -       return ignored PATA cable.
2358  *      @ap: port
2359  *
2360  *      Helper method for drivers which don't use cable type to limit
2361  *      transfer mode.
2362  */
2363 int ata_cable_ignore(struct ata_port *ap)
2364 {
2365         return ATA_CBL_PATA_IGN;
2366 }
2367
2368 /**
2369  *      ata_cable_sata  -       return SATA cable type
2370  *      @ap: port
2371  *
2372  *      Helper method for drivers which have SATA cables
2373  */
2374
2375 int ata_cable_sata(struct ata_port *ap)
2376 {
2377         return ATA_CBL_SATA;
2378 }
2379
2380 /**
2381  *      ata_bus_probe - Reset and probe ATA bus
2382  *      @ap: Bus to probe
2383  *
2384  *      Master ATA bus probing function.  Initiates a hardware-dependent
2385  *      bus reset, then attempts to identify any devices found on
2386  *      the bus.
2387  *
2388  *      LOCKING:
2389  *      PCI/etc. bus probe sem.
2390  *
2391  *      RETURNS:
2392  *      Zero on success, negative errno otherwise.
2393  */
2394
2395 int ata_bus_probe(struct ata_port *ap)
2396 {
2397         unsigned int classes[ATA_MAX_DEVICES];
2398         int tries[ATA_MAX_DEVICES];
2399         int rc;
2400         struct ata_device *dev;
2401
2402         ata_port_probe(ap);
2403
2404         ata_link_for_each_dev(dev, &ap->link)
2405                 tries[dev->devno] = ATA_PROBE_MAX_TRIES;
2406
2407  retry:
2408         ata_link_for_each_dev(dev, &ap->link) {
2409                 /* If we issue an SRST then an ATA drive (not ATAPI)
2410                  * may change configuration and be in PIO0 timing. If
2411                  * we do a hard reset (or are coming from power on)
2412                  * this is true for ATA or ATAPI. Until we've set a
2413                  * suitable controller mode we should not touch the
2414                  * bus as we may be talking too fast.
2415                  */
2416                 dev->pio_mode = XFER_PIO_0;
2417
2418                 /* If the controller has a pio mode setup function
2419                  * then use it to set the chipset to rights. Don't
2420                  * touch the DMA setup as that will be dealt with when
2421                  * configuring devices.
2422                  */
2423                 if (ap->ops->set_piomode)
2424                         ap->ops->set_piomode(ap, dev);
2425         }
2426
2427         /* reset and determine device classes */
2428         ap->ops->phy_reset(ap);
2429
2430         ata_link_for_each_dev(dev, &ap->link) {
2431                 if (!(ap->flags & ATA_FLAG_DISABLED) &&
2432                     dev->class != ATA_DEV_UNKNOWN)
2433                         classes[dev->devno] = dev->class;
2434                 else
2435                         classes[dev->devno] = ATA_DEV_NONE;
2436
2437                 dev->class = ATA_DEV_UNKNOWN;
2438         }
2439
2440         ata_port_probe(ap);
2441
2442         /* read IDENTIFY page and configure devices. We have to do the identify
2443            specific sequence bass-ackwards so that PDIAG- is released by
2444            the slave device */
2445
2446         ata_link_for_each_dev(dev, &ap->link) {
2447                 if (tries[dev->devno])
2448                         dev->class = classes[dev->devno];
2449
2450                 if (!ata_dev_enabled(dev))
2451                         continue;
2452
2453                 rc = ata_dev_read_id(dev, &dev->class, ATA_READID_POSTRESET,
2454                                      dev->id);
2455                 if (rc)
2456                         goto fail;
2457         }
2458
2459         /* Now ask for the cable type as PDIAG- should have been released */
2460         if (ap->ops->cable_detect)
2461                 ap->cbl = ap->ops->cable_detect(ap);
2462
2463         /* We may have SATA bridge glue hiding here irrespective of the
2464            reported cable types and sensed types */
2465         ata_link_for_each_dev(dev, &ap->link) {
2466                 if (!ata_dev_enabled(dev))
2467                         continue;
2468                 /* SATA drives indicate we have a bridge. We don't know which
2469                    end of the link the bridge is which is a problem */
2470                 if (ata_id_is_sata(dev->id))
2471                         ap->cbl = ATA_CBL_SATA;
2472         }
2473
2474         /* After the identify sequence we can now set up the devices. We do
2475            this in the normal order so that the user doesn't get confused */
2476
2477         ata_link_for_each_dev(dev, &ap->link) {
2478                 if (!ata_dev_enabled(dev))
2479                         continue;
2480
2481                 ap->link.eh_context.i.flags |= ATA_EHI_PRINTINFO;
2482                 rc = ata_dev_configure(dev);
2483                 ap->link.eh_context.i.flags &= ~ATA_EHI_PRINTINFO;
2484                 if (rc)
2485                         goto fail;
2486         }
2487
2488         /* configure transfer mode */
2489         rc = ata_set_mode(&ap->link, &dev);
2490         if (rc)
2491                 goto fail;
2492
2493         ata_link_for_each_dev(dev, &ap->link)
2494                 if (ata_dev_enabled(dev))
2495                         return 0;
2496
2497         /* no device present, disable port */
2498         ata_port_disable(ap);
2499         return -ENODEV;
2500
2501  fail:
2502         tries[dev->devno]--;
2503
2504         switch (rc) {
2505         case -EINVAL:
2506                 /* eeek, something went very wrong, give up */
2507                 tries[dev->devno] = 0;
2508                 break;
2509
2510         case -ENODEV:
2511                 /* give it just one more chance */
2512                 tries[dev->devno] = min(tries[dev->devno], 1);
2513         case -EIO:
2514                 if (tries[dev->devno] == 1) {
2515                         /* This is the last chance, better to slow
2516                          * down than lose it.
2517                          */
2518                         sata_down_spd_limit(&ap->link);
2519                         ata_down_xfermask_limit(dev, ATA_DNXFER_PIO);
2520                 }
2521         }
2522
2523         if (!tries[dev->devno])
2524                 ata_dev_disable(dev);
2525
2526         goto retry;
2527 }
2528
2529 /**
2530  *      ata_port_probe - Mark port as enabled
2531  *      @ap: Port for which we indicate enablement
2532  *
2533  *      Modify @ap data structure such that the system
2534  *      thinks that the entire port is enabled.
2535  *
2536  *      LOCKING: host lock, or some other form of
2537  *      serialization.
2538  */
2539
2540 void ata_port_probe(struct ata_port *ap)
2541 {
2542         ap->flags &= ~ATA_FLAG_DISABLED;
2543 }
2544
2545 /**
2546  *      sata_print_link_status - Print SATA link status
2547  *      @link: SATA link to printk link status about
2548  *
2549  *      This function prints link speed and status of a SATA link.
2550  *
2551  *      LOCKING:
2552  *      None.
2553  */
2554 void sata_print_link_status(struct ata_link *link)
2555 {
2556         u32 sstatus, scontrol, tmp;
2557
2558         if (sata_scr_read(link, SCR_STATUS, &sstatus))
2559                 return;
2560         sata_scr_read(link, SCR_CONTROL, &scontrol);
2561
2562         if (ata_link_online(link)) {
2563                 tmp = (sstatus >> 4) & 0xf;
2564                 ata_link_printk(link, KERN_INFO,
2565                                 "SATA link up %s (SStatus %X SControl %X)\n",
2566                                 sata_spd_string(tmp), sstatus, scontrol);
2567         } else {
2568                 ata_link_printk(link, KERN_INFO,
2569                                 "SATA link down (SStatus %X SControl %X)\n",
2570                                 sstatus, scontrol);
2571         }
2572 }
2573
2574 /**
2575  *      ata_dev_pair            -       return other device on cable
2576  *      @adev: device
2577  *
2578  *      Obtain the other device on the same cable, or if none is
2579  *      present NULL is returned
2580  */
2581
2582 struct ata_device *ata_dev_pair(struct ata_device *adev)
2583 {
2584         struct ata_link *link = adev->link;
2585         struct ata_device *pair = &link->device[1 - adev->devno];
2586         if (!ata_dev_enabled(pair))
2587                 return NULL;
2588         return pair;
2589 }
2590
2591 /**
2592  *      ata_port_disable - Disable port.
2593  *      @ap: Port to be disabled.
2594  *
2595  *      Modify @ap data structure such that the system
2596  *      thinks that the entire port is disabled, and should
2597  *      never attempt to probe or communicate with devices
2598  *      on this port.
2599  *
2600  *      LOCKING: host lock, or some other form of
2601  *      serialization.
2602  */
2603
2604 void ata_port_disable(struct ata_port *ap)
2605 {
2606         ap->link.device[0].class = ATA_DEV_NONE;
2607         ap->link.device[1].class = ATA_DEV_NONE;
2608         ap->flags |= ATA_FLAG_DISABLED;
2609 }
2610
2611 /**
2612  *      sata_down_spd_limit - adjust SATA spd limit downward
2613  *      @link: Link to adjust SATA spd limit for
2614  *
2615  *      Adjust SATA spd limit of @link downward.  Note that this
2616  *      function only adjusts the limit.  The change must be applied
2617  *      using sata_set_spd().
2618  *
2619  *      LOCKING:
2620  *      Inherited from caller.
2621  *
2622  *      RETURNS:
2623  *      0 on success, negative errno on failure
2624  */
2625 int sata_down_spd_limit(struct ata_link *link)
2626 {
2627         u32 sstatus, spd, mask;
2628         int rc, highbit;
2629
2630         if (!sata_scr_valid(link))
2631                 return -EOPNOTSUPP;
2632
2633         /* If SCR can be read, use it to determine the current SPD.
2634          * If not, use cached value in link->sata_spd.
2635          */
2636         rc = sata_scr_read(link, SCR_STATUS, &sstatus);
2637         if (rc == 0)
2638                 spd = (sstatus >> 4) & 0xf;
2639         else
2640                 spd = link->sata_spd;
2641
2642         mask = link->sata_spd_limit;
2643         if (mask <= 1)
2644                 return -EINVAL;
2645
2646         /* unconditionally mask off the highest bit */
2647         highbit = fls(mask) - 1;
2648         mask &= ~(1 << highbit);
2649
2650         /* Mask off all speeds higher than or equal to the current
2651          * one.  Force 1.5Gbps if current SPD is not available.
2652          */
2653         if (spd > 1)
2654                 mask &= (1 << (spd - 1)) - 1;
2655         else
2656                 mask &= 1;
2657
2658         /* were we already at the bottom? */
2659         if (!mask)
2660                 return -EINVAL;
2661
2662         link->sata_spd_limit = mask;
2663
2664         ata_link_printk(link, KERN_WARNING, "limiting SATA link speed to %s\n",
2665                         sata_spd_string(fls(mask)));
2666
2667         return 0;
2668 }
2669
2670 static int __sata_set_spd_needed(struct ata_link *link, u32 *scontrol)
2671 {
2672         struct ata_link *host_link = &link->ap->link;
2673         u32 limit, target, spd;
2674
2675         limit = link->sata_spd_limit;
2676
2677         /* Don't configure downstream link faster than upstream link.
2678          * It doesn't speed up anything and some PMPs choke on such
2679          * configuration.
2680          */
2681         if (!ata_is_host_link(link) && host_link->sata_spd)
2682                 limit &= (1 << host_link->sata_spd) - 1;
2683
2684         if (limit == UINT_MAX)
2685                 target = 0;
2686         else
2687                 target = fls(limit);
2688
2689         spd = (*scontrol >> 4) & 0xf;
2690         *scontrol = (*scontrol & ~0xf0) | ((target & 0xf) << 4);
2691
2692         return spd != target;
2693 }
2694
2695 /**
2696  *      sata_set_spd_needed - is SATA spd configuration needed
2697  *      @link: Link in question
2698  *
2699  *      Test whether the spd limit in SControl matches
2700  *      @link->sata_spd_limit.  This function is used to determine
2701  *      whether hardreset is necessary to apply SATA spd
2702  *      configuration.
2703  *
2704  *      LOCKING:
2705  *      Inherited from caller.
2706  *
2707  *      RETURNS:
2708  *      1 if SATA spd configuration is needed, 0 otherwise.
2709  */
2710 int sata_set_spd_needed(struct ata_link *link)
2711 {
2712         u32 scontrol;
2713
2714         if (sata_scr_read(link, SCR_CONTROL, &scontrol))
2715                 return 1;
2716
2717         return __sata_set_spd_needed(link, &scontrol);
2718 }
2719
2720 /**
2721  *      sata_set_spd - set SATA spd according to spd limit
2722  *      @link: Link to set SATA spd for
2723  *
2724  *      Set SATA spd of @link according to sata_spd_limit.
2725  *
2726  *      LOCKING:
2727  *      Inherited from caller.
2728  *
2729  *      RETURNS:
2730  *      0 if spd doesn't need to be changed, 1 if spd has been
2731  *      changed.  Negative errno if SCR registers are inaccessible.
2732  */
2733 int sata_set_spd(struct ata_link *link)
2734 {
2735         u32 scontrol;
2736         int rc;
2737
2738         if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
2739                 return rc;
2740
2741         if (!__sata_set_spd_needed(link, &scontrol))
2742                 return 0;
2743
2744         if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
2745                 return rc;
2746
2747         return 1;
2748 }
2749
2750 /*
2751  * This mode timing computation functionality is ported over from
2752  * drivers/ide/ide-timing.h and was originally written by Vojtech Pavlik
2753  */
2754 /*
2755  * PIO 0-4, MWDMA 0-2 and UDMA 0-6 timings (in nanoseconds).
2756  * These were taken from ATA/ATAPI-6 standard, rev 0a, except
2757  * for UDMA6, which is currently supported only by Maxtor drives.
2758  *
2759  * For PIO 5/6 MWDMA 3/4 see the CFA specification 3.0.
2760  */
2761
2762 static const struct ata_timing ata_timing[] = {
2763 /*      { XFER_PIO_SLOW, 120, 290, 240, 960, 290, 240, 960,   0 }, */
2764         { XFER_PIO_0,     70, 290, 240, 600, 165, 150, 600,   0 },
2765         { XFER_PIO_1,     50, 290,  93, 383, 125, 100, 383,   0 },
2766         { XFER_PIO_2,     30, 290,  40, 330, 100,  90, 240,   0 },
2767         { XFER_PIO_3,     30,  80,  70, 180,  80,  70, 180,   0 },
2768         { XFER_PIO_4,     25,  70,  25, 120,  70,  25, 120,   0 },
2769         { XFER_PIO_5,     15,  65,  25, 100,  65,  25, 100,   0 },
2770         { XFER_PIO_6,     10,  55,  20,  80,  55,  20,  80,   0 },
2771
2772         { XFER_SW_DMA_0, 120,   0,   0,   0, 480, 480, 960,   0 },
2773         { XFER_SW_DMA_1,  90,   0,   0,   0, 240, 240, 480,   0 },
2774         { XFER_SW_DMA_2,  60,   0,   0,   0, 120, 120, 240,   0 },
2775
2776         { XFER_MW_DMA_0,  60,   0,   0,   0, 215, 215, 480,   0 },
2777         { XFER_MW_DMA_1,  45,   0,   0,   0,  80,  50, 150,   0 },
2778         { XFER_MW_DMA_2,  25,   0,   0,   0,  70,  25, 120,   0 },
2779         { XFER_MW_DMA_3,  25,   0,   0,   0,  65,  25, 100,   0 },
2780         { XFER_MW_DMA_4,  25,   0,   0,   0,  55,  20,  80,   0 },
2781
2782 /*      { XFER_UDMA_SLOW,  0,   0,   0,   0,   0,   0,   0, 150 }, */
2783         { XFER_UDMA_0,     0,   0,   0,   0,   0,   0,   0, 120 },
2784         { XFER_UDMA_1,     0,   0,   0,   0,   0,   0,   0,  80 },
2785         { XFER_UDMA_2,     0,   0,   0,   0,   0,   0,   0,  60 },
2786         { XFER_UDMA_3,     0,   0,   0,   0,   0,   0,   0,  45 },
2787         { XFER_UDMA_4,     0,   0,   0,   0,   0,   0,   0,  30 },
2788         { XFER_UDMA_5,     0,   0,   0,   0,   0,   0,   0,  20 },
2789         { XFER_UDMA_6,     0,   0,   0,   0,   0,   0,   0,  15 },
2790
2791         { 0xFF }
2792 };
2793
2794 #define ENOUGH(v, unit)         (((v)-1)/(unit)+1)
2795 #define EZ(v, unit)             ((v)?ENOUGH(v, unit):0)
2796
2797 static void ata_timing_quantize(const struct ata_timing *t, struct ata_timing *q, int T, int UT)
2798 {
2799         q->setup   = EZ(t->setup   * 1000,  T);
2800         q->act8b   = EZ(t->act8b   * 1000,  T);
2801         q->rec8b   = EZ(t->rec8b   * 1000,  T);
2802         q->cyc8b   = EZ(t->cyc8b   * 1000,  T);
2803         q->active  = EZ(t->active  * 1000,  T);
2804         q->recover = EZ(t->recover * 1000,  T);
2805         q->cycle   = EZ(t->cycle   * 1000,  T);
2806         q->udma    = EZ(t->udma    * 1000, UT);
2807 }
2808
2809 void ata_timing_merge(const struct ata_timing *a, const struct ata_timing *b,
2810                       struct ata_timing *m, unsigned int what)
2811 {
2812         if (what & ATA_TIMING_SETUP  ) m->setup   = max(a->setup,   b->setup);
2813         if (what & ATA_TIMING_ACT8B  ) m->act8b   = max(a->act8b,   b->act8b);
2814         if (what & ATA_TIMING_REC8B  ) m->rec8b   = max(a->rec8b,   b->rec8b);
2815         if (what & ATA_TIMING_CYC8B  ) m->cyc8b   = max(a->cyc8b,   b->cyc8b);
2816         if (what & ATA_TIMING_ACTIVE ) m->active  = max(a->active,  b->active);
2817         if (what & ATA_TIMING_RECOVER) m->recover = max(a->recover, b->recover);
2818         if (what & ATA_TIMING_CYCLE  ) m->cycle   = max(a->cycle,   b->cycle);
2819         if (what & ATA_TIMING_UDMA   ) m->udma    = max(a->udma,    b->udma);
2820 }
2821
2822 const struct ata_timing *ata_timing_find_mode(u8 xfer_mode)
2823 {
2824         const struct ata_timing *t = ata_timing;
2825
2826         while (xfer_mode > t->mode)
2827                 t++;
2828
2829         if (xfer_mode == t->mode)
2830                 return t;
2831         return NULL;
2832 }
2833
2834 int ata_timing_compute(struct ata_device *adev, unsigned short speed,
2835                        struct ata_timing *t, int T, int UT)
2836 {
2837         const struct ata_timing *s;
2838         struct ata_timing p;
2839
2840         /*
2841          * Find the mode.
2842          */
2843
2844         if (!(s = ata_timing_find_mode(speed)))
2845                 return -EINVAL;
2846
2847         memcpy(t, s, sizeof(*s));
2848
2849         /*
2850          * If the drive is an EIDE drive, it can tell us it needs extended
2851          * PIO/MW_DMA cycle timing.
2852          */
2853
2854         if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE drive */
2855                 memset(&p, 0, sizeof(p));
2856                 if (speed >= XFER_PIO_0 && speed <= XFER_SW_DMA_0) {
2857                         if (speed <= XFER_PIO_2) p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO];
2858                                             else p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO_IORDY];
2859                 } else if (speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2) {
2860                         p.cycle = adev->id[ATA_ID_EIDE_DMA_MIN];
2861                 }
2862                 ata_timing_merge(&p, t, t, ATA_TIMING_CYCLE | ATA_TIMING_CYC8B);
2863         }
2864
2865         /*
2866          * Convert the timing to bus clock counts.
2867          */
2868
2869         ata_timing_quantize(t, t, T, UT);
2870
2871         /*
2872          * Even in DMA/UDMA modes we still use PIO access for IDENTIFY,
2873          * S.M.A.R.T * and some other commands. We have to ensure that the
2874          * DMA cycle timing is slower/equal than the fastest PIO timing.
2875          */
2876
2877         if (speed > XFER_PIO_6) {
2878                 ata_timing_compute(adev, adev->pio_mode, &p, T, UT);
2879                 ata_timing_merge(&p, t, t, ATA_TIMING_ALL);
2880         }
2881
2882         /*
2883          * Lengthen active & recovery time so that cycle time is correct.
2884          */
2885
2886         if (t->act8b + t->rec8b < t->cyc8b) {
2887                 t->act8b += (t->cyc8b - (t->act8b + t->rec8b)) / 2;
2888                 t->rec8b = t->cyc8b - t->act8b;
2889         }
2890
2891         if (t->active + t->recover < t->cycle) {
2892                 t->active += (t->cycle - (t->active + t->recover)) / 2;
2893                 t->recover = t->cycle - t->active;
2894         }
2895
2896         /* In a few cases quantisation may produce enough errors to
2897            leave t->cycle too low for the sum of active and recovery
2898            if so we must correct this */
2899         if (t->active + t->recover > t->cycle)
2900                 t->cycle = t->active + t->recover;
2901
2902         return 0;
2903 }
2904
2905 /**
2906  *      ata_timing_cycle2mode - find xfer mode for the specified cycle duration
2907  *      @xfer_shift: ATA_SHIFT_* value for transfer type to examine.
2908  *      @cycle: cycle duration in ns
2909  *
2910  *      Return matching xfer mode for @cycle.  The returned mode is of
2911  *      the transfer type specified by @xfer_shift.  If @cycle is too
2912  *      slow for @xfer_shift, 0xff is returned.  If @cycle is faster
2913  *      than the fastest known mode, the fasted mode is returned.
2914  *
2915  *      LOCKING:
2916  *      None.
2917  *
2918  *      RETURNS:
2919  *      Matching xfer_mode, 0xff if no match found.
2920  */
2921 u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle)
2922 {
2923         u8 base_mode = 0xff, last_mode = 0xff;
2924         const struct ata_xfer_ent *ent;
2925         const struct ata_timing *t;
2926
2927         for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
2928                 if (ent->shift == xfer_shift)
2929                         base_mode = ent->base;
2930
2931         for (t = ata_timing_find_mode(base_mode);
2932              t && ata_xfer_mode2shift(t->mode) == xfer_shift; t++) {
2933                 unsigned short this_cycle;
2934
2935                 switch (xfer_shift) {
2936                 case ATA_SHIFT_PIO:
2937                 case ATA_SHIFT_MWDMA:
2938                         this_cycle = t->cycle;
2939                         break;
2940                 case ATA_SHIFT_UDMA:
2941                         this_cycle = t->udma;
2942                         break;
2943                 default:
2944                         return 0xff;
2945                 }
2946
2947                 if (cycle > this_cycle)
2948                         break;
2949
2950                 last_mode = t->mode;
2951         }
2952
2953         return last_mode;
2954 }
2955
2956 /**
2957  *      ata_down_xfermask_limit - adjust dev xfer masks downward
2958  *      @dev: Device to adjust xfer masks
2959  *      @sel: ATA_DNXFER_* selector
2960  *
2961  *      Adjust xfer masks of @dev downward.  Note that this function
2962  *      does not apply the change.  Invoking ata_set_mode() afterwards
2963  *      will apply the limit.
2964  *
2965  *      LOCKING:
2966  *      Inherited from caller.
2967  *
2968  *      RETURNS:
2969  *      0 on success, negative errno on failure
2970  */
2971 int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel)
2972 {
2973         char buf[32];
2974         unsigned long orig_mask, xfer_mask;
2975         unsigned long pio_mask, mwdma_mask, udma_mask;
2976         int quiet, highbit;
2977
2978         quiet = !!(sel & ATA_DNXFER_QUIET);
2979         sel &= ~ATA_DNXFER_QUIET;
2980
2981         xfer_mask = orig_mask = ata_pack_xfermask(dev->pio_mask,
2982                                                   dev->mwdma_mask,
2983                                                   dev->udma_mask);
2984         ata_unpack_xfermask(xfer_mask, &pio_mask, &mwdma_mask, &udma_mask);
2985
2986         switch (sel) {
2987         case ATA_DNXFER_PIO:
2988                 highbit = fls(pio_mask) - 1;
2989                 pio_mask &= ~(1 << highbit);
2990                 break;
2991
2992         case ATA_DNXFER_DMA:
2993                 if (udma_mask) {
2994                         highbit = fls(udma_mask) - 1;
2995                         udma_mask &= ~(1 << highbit);
2996                         if (!udma_mask)
2997                                 return -ENOENT;
2998                 } else if (mwdma_mask) {
2999                         highbit = fls(mwdma_mask) - 1;
3000                         mwdma_mask &= ~(1 << highbit);
3001                         if (!mwdma_mask)
3002                                 return -ENOENT;
3003                 }
3004                 break;
3005
3006         case ATA_DNXFER_40C:
3007                 udma_mask &= ATA_UDMA_MASK_40C;
3008                 break;
3009
3010         case ATA_DNXFER_FORCE_PIO0:
3011                 pio_mask &= 1;
3012         case ATA_DNXFER_FORCE_PIO:
3013                 mwdma_mask = 0;
3014                 udma_mask = 0;
3015                 break;
3016
3017         default:
3018                 BUG();
3019         }
3020
3021         xfer_mask &= ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
3022
3023         if (!(xfer_mask & ATA_MASK_PIO) || xfer_mask == orig_mask)
3024                 return -ENOENT;
3025
3026         if (!quiet) {
3027                 if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
3028                         snprintf(buf, sizeof(buf), "%s:%s",
3029                                  ata_mode_string(xfer_mask),
3030                                  ata_mode_string(xfer_mask & ATA_MASK_PIO));
3031                 else
3032                         snprintf(buf, sizeof(buf), "%s",
3033                                  ata_mode_string(xfer_mask));
3034
3035                 ata_dev_printk(dev, KERN_WARNING,
3036                                "limiting speed to %s\n", buf);
3037         }
3038
3039         ata_unpack_xfermask(xfer_mask, &dev->pio_mask, &dev->mwdma_mask,
3040                             &dev->udma_mask);
3041
3042         return 0;
3043 }
3044
3045 static int ata_dev_set_mode(struct ata_device *dev)
3046 {
3047         struct ata_eh_context *ehc = &dev->link->eh_context;
3048         unsigned int err_mask;
3049         int rc;
3050
3051         dev->flags &= ~ATA_DFLAG_PIO;
3052         if (dev->xfer_shift == ATA_SHIFT_PIO)
3053                 dev->flags |= ATA_DFLAG_PIO;
3054
3055         err_mask = ata_dev_set_xfermode(dev);
3056
3057         /* Old CFA may refuse this command, which is just fine */
3058         if (dev->xfer_shift == ATA_SHIFT_PIO && ata_id_is_cfa(dev->id))
3059                 err_mask &= ~AC_ERR_DEV;
3060
3061         /* Some very old devices and some bad newer ones fail any kind of
3062            SET_XFERMODE request but support PIO0-2 timings and no IORDY */
3063         if (dev->xfer_shift == ATA_SHIFT_PIO && !ata_id_has_iordy(dev->id) &&
3064                         dev->pio_mode <= XFER_PIO_2)
3065                 err_mask &= ~AC_ERR_DEV;
3066
3067         /* Early MWDMA devices do DMA but don't allow DMA mode setting.
3068            Don't fail an MWDMA0 set IFF the device indicates it is in MWDMA0 */
3069         if (dev->xfer_shift == ATA_SHIFT_MWDMA && 
3070             dev->dma_mode == XFER_MW_DMA_0 &&
3071             (dev->id[63] >> 8) & 1)
3072                 err_mask &= ~AC_ERR_DEV;
3073
3074         if (err_mask) {
3075                 ata_dev_printk(dev, KERN_ERR, "failed to set xfermode "
3076                                "(err_mask=0x%x)\n", err_mask);
3077                 return -EIO;
3078         }
3079
3080         ehc->i.flags |= ATA_EHI_POST_SETMODE;
3081         rc = ata_dev_revalidate(dev, ATA_DEV_UNKNOWN, 0);
3082         ehc->i.flags &= ~ATA_EHI_POST_SETMODE;
3083         if (rc)
3084                 return rc;
3085
3086         DPRINTK("xfer_shift=%u, xfer_mode=0x%x\n",
3087                 dev->xfer_shift, (int)dev->xfer_mode);
3088
3089         ata_dev_printk(dev, KERN_INFO, "configured for %s\n",
3090                        ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)));
3091         return 0;
3092 }
3093
3094 /**
3095  *      ata_do_set_mode - Program timings and issue SET FEATURES - XFER
3096  *      @link: link on which timings will be programmed
3097  *      @r_failed_dev: out paramter for failed device
3098  *
3099  *      Standard implementation of the function used to tune and set
3100  *      ATA device disk transfer mode (PIO3, UDMA6, etc.).  If
3101  *      ata_dev_set_mode() fails, pointer to the failing device is
3102  *      returned in @r_failed_dev.
3103  *
3104  *      LOCKING:
3105  *      PCI/etc. bus probe sem.
3106  *
3107  *      RETURNS:
3108  *      0 on success, negative errno otherwise
3109  */
3110
3111 int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
3112 {
3113         struct ata_port *ap = link->ap;
3114         struct ata_device *dev;
3115         int rc = 0, used_dma = 0, found = 0;
3116
3117         /* step 1: calculate xfer_mask */
3118         ata_link_for_each_dev(dev, link) {
3119                 unsigned long pio_mask, dma_mask;
3120                 unsigned int mode_mask;
3121
3122                 if (!ata_dev_enabled(dev))
3123                         continue;
3124
3125                 mode_mask = ATA_DMA_MASK_ATA;
3126                 if (dev->class == ATA_DEV_ATAPI)
3127                         mode_mask = ATA_DMA_MASK_ATAPI;
3128                 else if (ata_id_is_cfa(dev->id))
3129                         mode_mask = ATA_DMA_MASK_CFA;
3130
3131                 ata_dev_xfermask(dev);
3132
3133                 pio_mask = ata_pack_xfermask(dev->pio_mask, 0, 0);
3134                 dma_mask = ata_pack_xfermask(0, dev->mwdma_mask, dev->udma_mask);
3135
3136                 if (libata_dma_mask & mode_mask)
3137                         dma_mask = ata_pack_xfermask(0, dev->mwdma_mask, dev->udma_mask);
3138                 else
3139                         dma_mask = 0;
3140
3141                 dev->pio_mode = ata_xfer_mask2mode(pio_mask);
3142                 dev->dma_mode = ata_xfer_mask2mode(dma_mask);
3143
3144                 found = 1;
3145                 if (dev->dma_mode != 0xff)
3146                         used_dma = 1;
3147         }
3148         if (!found)
3149                 goto out;
3150
3151         /* step 2: always set host PIO timings */
3152         ata_link_for_each_dev(dev, link) {
3153                 if (!ata_dev_enabled(dev))
3154                         continue;
3155
3156                 if (dev->pio_mode == 0xff) {
3157                         ata_dev_printk(dev, KERN_WARNING, "no PIO support\n");
3158                         rc = -EINVAL;
3159                         goto out;
3160                 }
3161
3162                 dev->xfer_mode = dev->pio_mode;
3163                 dev->xfer_shift = ATA_SHIFT_PIO;
3164                 if (ap->ops->set_piomode)
3165                         ap->ops->set_piomode(ap, dev);
3166         }
3167
3168         /* step 3: set host DMA timings */
3169         ata_link_for_each_dev(dev, link) {
3170                 if (!ata_dev_enabled(dev) || dev->dma_mode == 0xff)
3171                         continue;
3172
3173                 dev->xfer_mode = dev->dma_mode;
3174                 dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
3175                 if (ap->ops->set_dmamode)
3176                         ap->ops->set_dmamode(ap, dev);
3177         }
3178
3179         /* step 4: update devices' xfer mode */
3180         ata_link_for_each_dev(dev, link) {
3181                 /* don't update suspended devices' xfer mode */
3182                 if (!ata_dev_enabled(dev))
3183                         continue;
3184
3185                 rc = ata_dev_set_mode(dev);
3186                 if (rc)
3187                         goto out;
3188         }
3189
3190         /* Record simplex status. If we selected DMA then the other
3191          * host channels are not permitted to do so.
3192          */
3193         if (used_dma && (ap->host->flags & ATA_HOST_SIMPLEX))
3194                 ap->host->simplex_claimed = ap;
3195
3196  out:
3197         if (rc)
3198                 *r_failed_dev = dev;
3199         return rc;
3200 }
3201
3202 /**
3203  *      ata_tf_to_host - issue ATA taskfile to host controller
3204  *      @ap: port to which command is being issued
3205  *      @tf: ATA taskfile register set
3206  *
3207  *      Issues ATA taskfile register set to ATA host controller,
3208  *      with proper synchronization with interrupt handler and
3209  *      other threads.
3210  *
3211  *      LOCKING:
3212  *      spin_lock_irqsave(host lock)
3213  */
3214
3215 static inline void ata_tf_to_host(struct ata_port *ap,
3216                                   const struct ata_taskfile *tf)
3217 {
3218         ap->ops->tf_load(ap, tf);
3219         ap->ops->exec_command(ap, tf);
3220 }
3221
3222 /**
3223  *      ata_busy_sleep - sleep until BSY clears, or timeout
3224  *      @ap: port containing status register to be polled
3225  *      @tmout_pat: impatience timeout
3226  *      @tmout: overall timeout
3227  *
3228  *      Sleep until ATA Status register bit BSY clears,
3229  *      or a timeout occurs.
3230  *
3231  *      LOCKING:
3232  *      Kernel thread context (may sleep).
3233  *
3234  *      RETURNS:
3235  *      0 on success, -errno otherwise.
3236  */
3237 int ata_busy_sleep(struct ata_port *ap,
3238                    unsigned long tmout_pat, unsigned long tmout)
3239 {
3240         unsigned long timer_start, timeout;
3241         u8 status;
3242
3243         status = ata_busy_wait(ap, ATA_BUSY, 300);
3244         timer_start = jiffies;
3245         timeout = timer_start + tmout_pat;
3246         while (status != 0xff && (status & ATA_BUSY) &&
3247                time_before(jiffies, timeout)) {
3248                 msleep(50);
3249                 status = ata_busy_wait(ap, ATA_BUSY, 3);
3250         }
3251
3252         if (status != 0xff && (status & ATA_BUSY))
3253                 ata_port_printk(ap, KERN_WARNING,
3254                                 "port is slow to respond, please be patient "
3255                                 "(Status 0x%x)\n", status);
3256
3257         timeout = timer_start + tmout;
3258         while (status != 0xff && (status & ATA_BUSY) &&
3259                time_before(jiffies, timeout)) {
3260                 msleep(50);
3261                 status = ata_chk_status(ap);
3262         }
3263
3264         if (status == 0xff)
3265                 return -ENODEV;
3266
3267         if (status & ATA_BUSY) {
3268                 ata_port_printk(ap, KERN_ERR, "port failed to respond "
3269                                 "(%lu secs, Status 0x%x)\n",
3270                                 tmout / HZ, status);
3271                 return -EBUSY;
3272         }
3273
3274         return 0;
3275 }
3276
3277 /**
3278  *      ata_wait_after_reset - wait before checking status after reset
3279  *      @ap: port containing status register to be polled
3280  *      @deadline: deadline jiffies for the operation
3281  *
3282  *      After reset, we need to pause a while before reading status.
3283  *      Also, certain combination of controller and device report 0xff
3284  *      for some duration (e.g. until SATA PHY is up and running)
3285  *      which is interpreted as empty port in ATA world.  This
3286  *      function also waits for such devices to get out of 0xff
3287  *      status.
3288  *
3289  *      LOCKING:
3290  *      Kernel thread context (may sleep).
3291  */
3292 void ata_wait_after_reset(struct ata_port *ap, unsigned long deadline)
3293 {
3294         unsigned long until = jiffies + ATA_TMOUT_FF_WAIT;
3295
3296         if (time_before(until, deadline))
3297                 deadline = until;
3298
3299         /* Spec mandates ">= 2ms" before checking status.  We wait
3300          * 150ms, because that was the magic delay used for ATAPI
3301          * devices in Hale Landis's ATADRVR, for the period of time
3302          * between when the ATA command register is written, and then
3303          * status is checked.  Because waiting for "a while" before
3304          * checking status is fine, post SRST, we perform this magic
3305          * delay here as well.
3306          *
3307          * Old drivers/ide uses the 2mS rule and then waits for ready.
3308          */
3309         msleep(150);
3310
3311         /* Wait for 0xff to clear.  Some SATA devices take a long time
3312          * to clear 0xff after reset.  For example, HHD424020F7SV00
3313          * iVDR needs >= 800ms while.  Quantum GoVault needs even more
3314          * than that.
3315          *
3316          * Note that some PATA controllers (pata_ali) explode if
3317          * status register is read more than once when there's no
3318          * device attached.
3319          */
3320         if (ap->flags & ATA_FLAG_SATA) {
3321                 while (1) {
3322                         u8 status = ata_chk_status(ap);
3323
3324                         if (status != 0xff || time_after(jiffies, deadline))
3325                                 return;
3326
3327                         msleep(50);
3328                 }
3329         }
3330 }
3331
3332 /**
3333  *      ata_wait_ready - sleep until BSY clears, or timeout
3334  *      @ap: port containing status register to be polled
3335  *      @deadline: deadline jiffies for the operation
3336  *
3337  *      Sleep until ATA Status register bit BSY clears, or timeout
3338  *      occurs.
3339  *
3340  *      LOCKING:
3341  *      Kernel thread context (may sleep).
3342  *
3343  *      RETURNS:
3344  *      0 on success, -errno otherwise.
3345  */
3346 int ata_wait_ready(struct ata_port *ap, unsigned long deadline)
3347 {
3348         unsigned long start = jiffies;
3349         int warned = 0;
3350
3351         while (1) {
3352                 u8 status = ata_chk_status(ap);
3353                 unsigned long now = jiffies;
3354
3355                 if (!(status & ATA_BUSY))
3356                         return 0;
3357                 if (!ata_link_online(&ap->link) && status == 0xff)
3358                         return -ENODEV;
3359                 if (time_after(now, deadline))
3360                         return -EBUSY;
3361
3362                 if (!warned && time_after(now, start + 5 * HZ) &&
3363                     (deadline - now > 3 * HZ)) {
3364                         ata_port_printk(ap, KERN_WARNING,
3365                                 "port is slow to respond, please be patient "
3366                                 "(Status 0x%x)\n", status);
3367                         warned = 1;
3368                 }
3369
3370                 msleep(50);
3371         }
3372 }
3373
3374 static int ata_bus_post_reset(struct ata_port *ap, unsigned int devmask,
3375                               unsigned long deadline)
3376 {
3377         struct ata_ioports *ioaddr = &ap->ioaddr;
3378         unsigned int dev0 = devmask & (1 << 0);
3379         unsigned int dev1 = devmask & (1 << 1);
3380         int rc, ret = 0;
3381
3382         /* if device 0 was found in ata_devchk, wait for its
3383          * BSY bit to clear
3384          */
3385         if (dev0) {
3386                 rc = ata_wait_ready(ap, deadline);
3387                 if (rc) {
3388                         if (rc != -ENODEV)
3389                                 return rc;
3390                         ret = rc;
3391                 }
3392         }
3393
3394         /* if device 1 was found in ata_devchk, wait for register
3395          * access briefly, then wait for BSY to clear.
3396          */
3397         if (dev1) {
3398                 int i;
3399
3400                 ap->ops->dev_select(ap, 1);
3401
3402                 /* Wait for register access.  Some ATAPI devices fail
3403                  * to set nsect/lbal after reset, so don't waste too
3404                  * much time on it.  We're gonna wait for !BSY anyway.
3405                  */
3406                 for (i = 0; i < 2; i++) {
3407                         u8 nsect, lbal;
3408
3409                         nsect = ioread8(ioaddr->nsect_addr);
3410                         lbal = ioread8(ioaddr->lbal_addr);
3411                         if ((nsect == 1) && (lbal == 1))
3412                                 break;
3413                         msleep(50);     /* give drive a breather */
3414                 }
3415
3416                 rc = ata_wait_ready(ap, deadline);
3417                 if (rc) {
3418                         if (rc != -ENODEV)
3419                                 return rc;
3420                         ret = rc;
3421                 }
3422         }
3423
3424         /* is all this really necessary? */
3425         ap->ops->dev_select(ap, 0);
3426         if (dev1)
3427                 ap->ops->dev_select(ap, 1);
3428         if (dev0)
3429                 ap->ops->dev_select(ap, 0);
3430
3431         return ret;
3432 }
3433
3434 static int ata_bus_softreset(struct ata_port *ap, unsigned int devmask,
3435                              unsigned long deadline)
3436 {
3437         struct ata_ioports *ioaddr = &ap->ioaddr;
3438
3439         DPRINTK("ata%u: bus reset via SRST\n", ap->print_id);
3440
3441         /* software reset.  causes dev0 to be selected */
3442         iowrite8(ap->ctl, ioaddr->ctl_addr);
3443         udelay(20);     /* FIXME: flush */
3444         iowrite8(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
3445         udelay(20);     /* FIXME: flush */
3446         iowrite8(ap->ctl, ioaddr->ctl_addr);
3447
3448         /* wait a while before checking status */
3449         ata_wait_after_reset(ap, deadline);
3450
3451         /* Before we perform post reset processing we want to see if
3452          * the bus shows 0xFF because the odd clown forgets the D7
3453          * pulldown resistor.
3454          */
3455         if (ata_chk_status(ap) == 0xFF)
3456                 return -ENODEV;
3457
3458         return ata_bus_post_reset(ap, devmask, deadline);
3459 }
3460
3461 /**
3462  *      ata_bus_reset - reset host port and associated ATA channel