62fa8cf677a130a70d4d878490bdbd93cdba3123
[linux-2.6.git] / include / linux / libata.h
1 /*
2  *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
3  *  Copyright 2003-2005 Jeff Garzik
4  *
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2, or (at your option)
9  *  any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; see the file COPYING.  If not, write to
18  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19  *
20  *
21  *  libata documentation is available via 'make {ps|pdf}docs',
22  *  as Documentation/DocBook/libata.*
23  *
24  */
25
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
28
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <linux/dma-mapping.h>
33 #include <asm/scatterlist.h>
34 #include <linux/io.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/acpi.h>
39
40 /*
41  * Define if arch has non-standard setup.  This is a _PCI_ standard
42  * not a legacy or ISA standard.
43  */
44 #ifdef CONFIG_ATA_NONSTANDARD
45 #include <asm/libata-portmap.h>
46 #else
47 #include <asm-generic/libata-portmap.h>
48 #endif
49
50 /*
51  * compile-time options: to be removed as soon as all the drivers are
52  * converted to the new debugging mechanism
53  */
54 #undef ATA_DEBUG                /* debugging output */
55 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
56 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
57 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
58
59
60 /* note: prints function name for you */
61 #ifdef ATA_DEBUG
62 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63 #ifdef ATA_VERBOSE_DEBUG
64 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65 #else
66 #define VPRINTK(fmt, args...)
67 #endif  /* ATA_VERBOSE_DEBUG */
68 #else
69 #define DPRINTK(fmt, args...)
70 #define VPRINTK(fmt, args...)
71 #endif  /* ATA_DEBUG */
72
73 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
74
75 /* NEW: debug levels */
76 #define HAVE_LIBATA_MSG 1
77
78 enum {
79         ATA_MSG_DRV     = 0x0001,
80         ATA_MSG_INFO    = 0x0002,
81         ATA_MSG_PROBE   = 0x0004,
82         ATA_MSG_WARN    = 0x0008,
83         ATA_MSG_MALLOC  = 0x0010,
84         ATA_MSG_CTL     = 0x0020,
85         ATA_MSG_INTR    = 0x0040,
86         ATA_MSG_ERR     = 0x0080,
87 };
88
89 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
90 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
91 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
92 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
95 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
96 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
97
98 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
99 {
100         if (dval < 0 || dval >= (sizeof(u32) * 8))
101                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
102         if (!dval)
103                 return 0;
104         return (1 << dval) - 1;
105 }
106
107 /* defines only for the constants which don't work well as enums */
108 #define ATA_TAG_POISON          0xfafbfcfdU
109
110 /* move to PCI layer? */
111 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
112 {
113         return &pdev->dev;
114 }
115
116 enum {
117         /* various global constants */
118         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
119         LIBATA_DUMB_MAX_PRD     = ATA_MAX_PRD / 4,      /* Worst case */
120         ATA_MAX_PORTS           = 8,
121         ATA_DEF_QUEUE           = 1,
122         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
123         ATA_MAX_QUEUE           = 32,
124         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
125         ATA_MAX_BUS             = 2,
126         ATA_DEF_BUSY_WAIT       = 10000,
127         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
128
129         ATA_SHT_EMULATED        = 1,
130         ATA_SHT_CMD_PER_LUN     = 1,
131         ATA_SHT_THIS_ID         = -1,
132         ATA_SHT_USE_CLUSTERING  = 1,
133
134         /* struct ata_device stuff */
135         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
136         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
137         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
138         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
139         ATA_DFLAG_FLUSH_EXT     = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
140         ATA_DFLAG_ACPI_PENDING  = (1 << 5), /* ACPI resume action pending */
141         ATA_DFLAG_ACPI_FAILED   = (1 << 6), /* ACPI on devcfg has failed */
142         ATA_DFLAG_CFG_MASK      = (1 << 8) - 1,
143
144         ATA_DFLAG_PIO           = (1 << 8), /* device limited to PIO mode */
145         ATA_DFLAG_NCQ_OFF       = (1 << 9), /* device limited to non-NCQ mode */
146         ATA_DFLAG_SPUNDOWN      = (1 << 10), /* XXX: for spindown_compat */
147         ATA_DFLAG_INIT_MASK     = (1 << 16) - 1,
148
149         ATA_DFLAG_DETACH        = (1 << 16),
150         ATA_DFLAG_DETACHED      = (1 << 17),
151
152         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
153         ATA_DEV_ATA             = 1,    /* ATA device */
154         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
155         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
156         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
157         ATA_DEV_NONE            = 5,    /* no device */
158
159         /* struct ata_port flags */
160         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
161                                             /* (doesn't imply presence) */
162         ATA_FLAG_SATA           = (1 << 1),
163         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
164         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
165         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
166         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
167         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
168         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
169         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
170         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
171                                              * doesn't handle PIO interrupts */
172         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
173         ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
174         ATA_FLAG_SKIP_D2H_BSY   = (1 << 12), /* can't wait for the first D2H
175                                               * Register FIS clearing BSY */
176         ATA_FLAG_DEBUGMSG       = (1 << 13),
177         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
178         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
179         ATA_FLAG_ACPI_SATA      = (1 << 17), /* need native SATA ACPI layout */
180
181         /* The following flag belongs to ap->pflags but is kept in
182          * ap->flags because it's referenced in many LLDs and will be
183          * removed in not-too-distant future.
184          */
185         ATA_FLAG_DISABLED       = (1 << 23), /* port is disabled, ignore it */
186
187         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
188
189         /* struct ata_port pflags */
190         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
191         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
192         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
193         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
194         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
195         ATA_PFLAG_UNLOADING     = (1 << 5), /* module is unloading */
196         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
197         ATA_PFLAG_INITIALIZING  = (1 << 7), /* being initialized, don't touch */
198
199         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
200         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
201         ATA_PFLAG_GTM_VALID     = (1 << 19), /* acpi_gtm data valid */
202
203         /* struct ata_queued_cmd flags */
204         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
205         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
206         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
207         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
208         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
209         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
210
211         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
212         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
213         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
214
215         /* host set flags */
216         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
217         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
218
219         /* bits 24:31 of host->flags are reserved for LLD specific flags */
220
221         /* various lengths of time */
222         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
223         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
224         ATA_TMOUT_INTERNAL      = 30 * HZ,
225         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
226
227         /* ATA bus states */
228         BUS_UNKNOWN             = 0,
229         BUS_DMA                 = 1,
230         BUS_IDLE                = 2,
231         BUS_NOINTR              = 3,
232         BUS_NODATA              = 4,
233         BUS_TIMER               = 5,
234         BUS_PIO                 = 6,
235         BUS_EDD                 = 7,
236         BUS_IDENTIFY            = 8,
237         BUS_PACKET              = 9,
238
239         /* SATA port states */
240         PORT_UNKNOWN            = 0,
241         PORT_ENABLED            = 1,
242         PORT_DISABLED           = 2,
243
244         /* encoding various smaller bitmaps into a single
245          * unsigned int bitmap
246          */
247         ATA_BITS_PIO            = 7,
248         ATA_BITS_MWDMA          = 5,
249         ATA_BITS_UDMA           = 8,
250
251         ATA_SHIFT_PIO           = 0,
252         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
253         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
254
255         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
256         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
257         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
258
259         /* size of buffer to pad xfers ending on unaligned boundaries */
260         ATA_DMA_PAD_SZ          = 4,
261         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
262
263         /* ering size */
264         ATA_ERING_SIZE          = 32,
265
266         /* desc_len for ata_eh_info and context */
267         ATA_EH_DESC_LEN         = 80,
268
269         /* reset / recovery action types */
270         ATA_EH_REVALIDATE       = (1 << 0),
271         ATA_EH_SOFTRESET        = (1 << 1),
272         ATA_EH_HARDRESET        = (1 << 2),
273
274         ATA_EH_RESET_MASK       = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
275         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE,
276
277         /* ata_eh_info->flags */
278         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
279         ATA_EHI_RESUME_LINK     = (1 << 1),  /* resume link (reset modifier) */
280         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
281         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
282
283         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
284         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
285         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
286         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
287         ATA_EHI_POST_SETMODE    = (1 << 20), /* revaildating after setmode */
288
289         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
290         ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
291
292         /* max repeat if error condition is still set after ->error_handler */
293         ATA_EH_MAX_REPEAT       = 5,
294
295         /* how hard are we gonna try to probe/recover devices */
296         ATA_PROBE_MAX_TRIES     = 3,
297         ATA_EH_DEV_TRIES        = 3,
298
299         /* Horkage types. May be set by libata or controller on drives
300            (some horkage may be drive/controller pair dependant */
301
302         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
303         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
304         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
305         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
306         ATA_HORKAGE_BROKEN_HPA  = (1 << 4),     /* Broken HPA */
307 };
308
309 enum hsm_task_states {
310         HSM_ST_IDLE,            /* no command on going */
311         HSM_ST_FIRST,           /* (waiting the device to)
312                                    write CDB or first data block */
313         HSM_ST,                 /* (waiting the device to) transfer data */
314         HSM_ST_LAST,            /* (waiting the device to) complete command */
315         HSM_ST_ERR,             /* error */
316 };
317
318 enum ata_completion_errors {
319         AC_ERR_DEV              = (1 << 0), /* device reported error */
320         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
321         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
322         AC_ERR_MEDIA            = (1 << 3), /* media error */
323         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
324         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
325         AC_ERR_SYSTEM           = (1 << 6), /* system error */
326         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
327         AC_ERR_OTHER            = (1 << 8), /* unknown */
328         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
329         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
330 };
331
332 /* forward declarations */
333 struct scsi_device;
334 struct ata_port_operations;
335 struct ata_port;
336 struct ata_queued_cmd;
337
338 /* typedefs */
339 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
340 typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
341 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
342                               unsigned long deadline);
343 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
344
345 struct ata_ioports {
346         void __iomem            *cmd_addr;
347         void __iomem            *data_addr;
348         void __iomem            *error_addr;
349         void __iomem            *feature_addr;
350         void __iomem            *nsect_addr;
351         void __iomem            *lbal_addr;
352         void __iomem            *lbam_addr;
353         void __iomem            *lbah_addr;
354         void __iomem            *device_addr;
355         void __iomem            *status_addr;
356         void __iomem            *command_addr;
357         void __iomem            *altstatus_addr;
358         void __iomem            *ctl_addr;
359         void __iomem            *bmdma_addr;
360         void __iomem            *scr_addr;
361 };
362
363 struct ata_host {
364         spinlock_t              lock;
365         struct device           *dev;
366         unsigned long           irq;
367         unsigned long           irq2;
368         void __iomem * const    *iomap;
369         unsigned int            n_ports;
370         void                    *private_data;
371         const struct ata_port_operations *ops;
372         unsigned long           flags;
373 #ifdef CONFIG_ATA_ACPI
374         acpi_handle             acpi_handle;
375 #endif
376         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
377         struct ata_port         *ports[0];
378 };
379
380 struct ata_queued_cmd {
381         struct ata_port         *ap;
382         struct ata_device       *dev;
383
384         struct scsi_cmnd        *scsicmd;
385         void                    (*scsidone)(struct scsi_cmnd *);
386
387         struct ata_taskfile     tf;
388         u8                      cdb[ATAPI_CDB_LEN];
389
390         unsigned long           flags;          /* ATA_QCFLAG_xxx */
391         unsigned int            tag;
392         unsigned int            n_elem;
393         unsigned int            orig_n_elem;
394
395         int                     dma_dir;
396
397         unsigned int            pad_len;
398         unsigned int            sect_size;
399
400         unsigned int            nbytes;
401         unsigned int            curbytes;
402
403         unsigned int            cursg;
404         unsigned int            cursg_ofs;
405
406         struct scatterlist      sgent;
407         struct scatterlist      pad_sgent;
408         void                    *buf_virt;
409
410         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
411         struct scatterlist      *__sg;
412
413         unsigned int            err_mask;
414         struct ata_taskfile     result_tf;
415         ata_qc_cb_t             complete_fn;
416
417         void                    *private_data;
418         void                    *lldd_task;
419 };
420
421 struct ata_port_stats {
422         unsigned long           unhandled_irq;
423         unsigned long           idle_irq;
424         unsigned long           rw_reqbuf;
425 };
426
427 struct ata_ering_entry {
428         int                     is_io;
429         unsigned int            err_mask;
430         u64                     timestamp;
431 };
432
433 struct ata_ering {
434         int                     cursor;
435         struct ata_ering_entry  ring[ATA_ERING_SIZE];
436 };
437
438 struct ata_device {
439         struct ata_link         *link;
440         unsigned int            devno;          /* 0 or 1 */
441         unsigned long           flags;          /* ATA_DFLAG_xxx */
442         unsigned int            horkage;        /* List of broken features */
443         struct scsi_device      *sdev;          /* attached SCSI device */
444 #ifdef CONFIG_ATA_ACPI
445         acpi_handle             acpi_handle;
446 #endif
447         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
448         u64                     n_sectors;      /* size of device, if ATA */
449         unsigned int            class;          /* ATA_DEV_xxx */
450         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
451         u8                      pio_mode;
452         u8                      dma_mode;
453         u8                      xfer_mode;
454         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
455
456         unsigned int            multi_count;    /* sectors count for
457                                                    READ/WRITE MULTIPLE */
458         unsigned int            max_sectors;    /* per-device max sectors */
459         unsigned int            cdb_len;
460
461         /* per-dev xfer mask */
462         unsigned int            pio_mask;
463         unsigned int            mwdma_mask;
464         unsigned int            udma_mask;
465
466         /* for CHS addressing */
467         u16                     cylinders;      /* Number of cylinders */
468         u16                     heads;          /* Number of heads */
469         u16                     sectors;        /* Number of sectors per track */
470
471         /* error history */
472         struct ata_ering        ering;
473         int                     spdn_cnt;
474 };
475
476 /* Offset into struct ata_device.  Fields above it are maintained
477  * acress device init.  Fields below are zeroed.
478  */
479 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
480
481 struct ata_eh_info {
482         struct ata_device       *dev;           /* offending device */
483         u32                     serror;         /* SError from LLDD */
484         unsigned int            err_mask;       /* port-wide err_mask */
485         unsigned int            action;         /* ATA_EH_* action mask */
486         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
487         unsigned int            flags;          /* ATA_EHI_* flags */
488
489         unsigned int            probe_mask;
490
491         char                    desc[ATA_EH_DESC_LEN];
492         int                     desc_len;
493 };
494
495 struct ata_eh_context {
496         struct ata_eh_info      i;
497         int                     tries[ATA_MAX_DEVICES];
498         unsigned int            classes[ATA_MAX_DEVICES];
499         unsigned int            did_probe_mask;
500 };
501
502 struct ata_acpi_drive
503 {
504         u32 pio;
505         u32 dma;
506 } __packed;
507
508 struct ata_acpi_gtm {
509         struct ata_acpi_drive drive[2];
510         u32 flags;
511 } __packed;
512
513 struct ata_link {
514         struct ata_port         *ap;
515
516         unsigned int            active_tag;     /* active tag on this link */
517         u32                     sactive;        /* active NCQ commands */
518
519         unsigned int            hw_sata_spd_limit;
520         unsigned int            sata_spd_limit;
521         unsigned int            sata_spd;       /* current SATA PHY speed */
522
523         /* record runtime error info, protected by host_set lock */
524         struct ata_eh_info      eh_info;
525         /* EH context */
526         struct ata_eh_context   eh_context;
527
528         struct ata_device       device[ATA_MAX_DEVICES];
529 };
530
531 struct ata_port {
532         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
533         const struct ata_port_operations *ops;
534         spinlock_t              *lock;
535         unsigned long           flags;  /* ATA_FLAG_xxx */
536         unsigned int            pflags; /* ATA_PFLAG_xxx */
537         unsigned int            print_id; /* user visible unique port ID */
538         unsigned int            port_no; /* 0 based port no. inside the host */
539
540         struct ata_prd          *prd;    /* our SG list */
541         dma_addr_t              prd_dma; /* and its DMA mapping */
542
543         void                    *pad;   /* array of DMA pad buffers */
544         dma_addr_t              pad_dma;
545
546         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
547
548         u8                      ctl;    /* cache of ATA control register */
549         u8                      last_ctl;       /* Cache last written value */
550         unsigned int            pio_mask;
551         unsigned int            mwdma_mask;
552         unsigned int            udma_mask;
553         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
554
555         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
556         unsigned long           qc_allocated;
557         unsigned int            qc_active;
558
559         struct ata_link         link;   /* host default link */
560
561         struct ata_port_stats   stats;
562         struct ata_host         *host;
563         struct device           *dev;
564
565         void                    *port_task_data;
566         struct delayed_work     port_task;
567         struct delayed_work     hotplug_task;
568         struct work_struct      scsi_rescan_task;
569
570         unsigned int            hsm_task_state;
571
572         u32                     msg_enable;
573         struct list_head        eh_done_q;
574         wait_queue_head_t       eh_wait_q;
575
576         pm_message_t            pm_mesg;
577         int                     *pm_result;
578
579         struct timer_list       fastdrain_timer;
580         unsigned long           fastdrain_cnt;
581
582         void                    *private_data;
583
584 #ifdef CONFIG_ATA_ACPI
585         acpi_handle             acpi_handle;
586         struct ata_acpi_gtm     acpi_gtm;
587 #endif
588         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
589 };
590
591 struct ata_port_operations {
592         void (*port_disable) (struct ata_port *);
593
594         void (*dev_config) (struct ata_device *);
595
596         void (*set_piomode) (struct ata_port *, struct ata_device *);
597         void (*set_dmamode) (struct ata_port *, struct ata_device *);
598         unsigned long (*mode_filter) (struct ata_device *, unsigned long);
599
600         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
601         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
602
603         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
604         u8   (*check_status)(struct ata_port *ap);
605         u8   (*check_altstatus)(struct ata_port *ap);
606         void (*dev_select)(struct ata_port *ap, unsigned int device);
607
608         void (*phy_reset) (struct ata_port *ap); /* obsolete */
609         int  (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
610
611         int (*cable_detect) (struct ata_port *ap);
612
613         int  (*check_atapi_dma) (struct ata_queued_cmd *qc);
614
615         void (*bmdma_setup) (struct ata_queued_cmd *qc);
616         void (*bmdma_start) (struct ata_queued_cmd *qc);
617
618         void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
619
620         void (*qc_prep) (struct ata_queued_cmd *qc);
621         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
622
623         /* Error handlers.  ->error_handler overrides ->eng_timeout and
624          * indicates that new-style EH is in place.
625          */
626         void (*eng_timeout) (struct ata_port *ap); /* obsolete */
627
628         void (*freeze) (struct ata_port *ap);
629         void (*thaw) (struct ata_port *ap);
630         void (*error_handler) (struct ata_port *ap);
631         void (*post_internal_cmd) (struct ata_queued_cmd *qc);
632
633         irq_handler_t irq_handler;
634         void (*irq_clear) (struct ata_port *);
635         u8 (*irq_on) (struct ata_port *);
636         u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
637
638         int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
639         int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
640
641         int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
642         int (*port_resume) (struct ata_port *ap);
643
644         int (*port_start) (struct ata_port *ap);
645         void (*port_stop) (struct ata_port *ap);
646
647         void (*host_stop) (struct ata_host *host);
648
649         void (*bmdma_stop) (struct ata_queued_cmd *qc);
650         u8   (*bmdma_status) (struct ata_port *ap);
651 };
652
653 struct ata_port_info {
654         struct scsi_host_template       *sht;
655         unsigned long           flags;
656         unsigned long           pio_mask;
657         unsigned long           mwdma_mask;
658         unsigned long           udma_mask;
659         const struct ata_port_operations *port_ops;
660         irq_handler_t           irq_handler;
661         void                    *private_data;
662 };
663
664 struct ata_timing {
665         unsigned short mode;            /* ATA mode */
666         unsigned short setup;           /* t1 */
667         unsigned short act8b;           /* t2 for 8-bit I/O */
668         unsigned short rec8b;           /* t2i for 8-bit I/O */
669         unsigned short cyc8b;           /* t0 for 8-bit I/O */
670         unsigned short active;          /* t2 or tD */
671         unsigned short recover;         /* t2i or tK */
672         unsigned short cycle;           /* t0 */
673         unsigned short udma;            /* t2CYCTYP/2 */
674 };
675
676 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
677
678 extern const unsigned long sata_deb_timing_normal[];
679 extern const unsigned long sata_deb_timing_hotplug[];
680 extern const unsigned long sata_deb_timing_long[];
681
682 extern const struct ata_port_operations ata_dummy_port_ops;
683 extern const struct ata_port_info ata_dummy_port_info;
684
685 static inline const unsigned long *
686 sata_ehc_deb_timing(struct ata_eh_context *ehc)
687 {
688         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
689                 return sata_deb_timing_hotplug;
690         else
691                 return sata_deb_timing_normal;
692 }
693
694 static inline int ata_port_is_dummy(struct ata_port *ap)
695 {
696         return ap->ops == &ata_dummy_port_ops;
697 }
698
699 extern void sata_print_link_status(struct ata_port *ap);
700 extern void ata_port_probe(struct ata_port *);
701 extern void __sata_phy_reset(struct ata_port *ap);
702 extern void sata_phy_reset(struct ata_port *ap);
703 extern void ata_bus_reset(struct ata_port *ap);
704 extern int sata_set_spd(struct ata_port *ap);
705 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param,
706                              unsigned long deadline);
707 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param,
708                            unsigned long deadline);
709 extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
710 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
711                              unsigned long deadline);
712 extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
713                                unsigned long deadline);
714 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
715                               unsigned long deadline);
716 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
717 extern void ata_port_disable(struct ata_port *);
718 extern void ata_std_ports(struct ata_ioports *ioaddr);
719 #ifdef CONFIG_PCI
720 extern int ata_pci_init_one (struct pci_dev *pdev,
721                              const struct ata_port_info * const * ppi);
722 extern void ata_pci_remove_one (struct pci_dev *pdev);
723 #ifdef CONFIG_PM
724 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
725 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
726 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
727 extern int ata_pci_device_resume(struct pci_dev *pdev);
728 #endif
729 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
730 #endif /* CONFIG_PCI */
731 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
732 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
733                         const struct ata_port_info * const * ppi, int n_ports);
734 extern int ata_host_start(struct ata_host *host);
735 extern int ata_host_register(struct ata_host *host,
736                              struct scsi_host_template *sht);
737 extern int ata_host_activate(struct ata_host *host, int irq,
738                              irq_handler_t irq_handler, unsigned long irq_flags,
739                              struct scsi_host_template *sht);
740 extern void ata_host_detach(struct ata_host *host);
741 extern void ata_host_init(struct ata_host *, struct device *,
742                           unsigned long, const struct ata_port_operations *);
743 extern int ata_scsi_detect(struct scsi_host_template *sht);
744 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
745 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
746 extern void ata_sas_port_destroy(struct ata_port *);
747 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
748                                            struct ata_port_info *, struct Scsi_Host *);
749 extern int ata_sas_port_init(struct ata_port *);
750 extern int ata_sas_port_start(struct ata_port *ap);
751 extern void ata_sas_port_stop(struct ata_port *ap);
752 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
753 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
754                             struct ata_port *ap);
755 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
756 extern int sata_scr_valid(struct ata_port *ap);
757 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
758 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
759 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
760 extern int ata_port_online(struct ata_port *ap);
761 extern int ata_port_offline(struct ata_port *ap);
762 #ifdef CONFIG_PM
763 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
764 extern void ata_host_resume(struct ata_host *host);
765 #endif
766 extern int ata_ratelimit(void);
767 extern int ata_busy_sleep(struct ata_port *ap,
768                           unsigned long timeout_pat, unsigned long timeout);
769 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
770 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
771                                 void *data, unsigned long delay);
772 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
773                              unsigned long interval_msec,
774                              unsigned long timeout_msec);
775 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
776
777 /*
778  * Default driver ops implementations
779  */
780 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
781 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
782 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
783                           u8 pmp, int is_cmd, u8 *fis);
784 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
785 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
786 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
787 extern u8 ata_check_status(struct ata_port *ap);
788 extern u8 ata_altstatus(struct ata_port *ap);
789 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
790 extern int ata_port_start (struct ata_port *ap);
791 extern int ata_sff_port_start (struct ata_port *ap);
792 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
793 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
794                           unsigned int buflen, int write_data);
795 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
796                                 unsigned int buflen, int write_data);
797 extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
798 extern void ata_qc_prep(struct ata_queued_cmd *qc);
799 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
800 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
801 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
802                 unsigned int buflen);
803 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
804                  unsigned int n_elem);
805 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
806 extern void ata_dev_disable(struct ata_device *adev);
807 extern void ata_id_string(const u16 *id, unsigned char *s,
808                           unsigned int ofs, unsigned int len);
809 extern void ata_id_c_string(const u16 *id, unsigned char *s,
810                             unsigned int ofs, unsigned int len);
811 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
812 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
813 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
814 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
815 extern u8   ata_bmdma_status(struct ata_port *ap);
816 extern void ata_bmdma_irq_clear(struct ata_port *ap);
817 extern void ata_bmdma_freeze(struct ata_port *ap);
818 extern void ata_bmdma_thaw(struct ata_port *ap);
819 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
820                                ata_reset_fn_t softreset,
821                                ata_reset_fn_t hardreset,
822                                ata_postreset_fn_t postreset);
823 extern void ata_bmdma_error_handler(struct ata_port *ap);
824 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
825 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
826                         u8 status, int in_wq);
827 extern void ata_qc_complete(struct ata_queued_cmd *qc);
828 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
829                                     void (*finish_qc)(struct ata_queued_cmd *));
830 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
831                               void (*done)(struct scsi_cmnd *));
832 extern int ata_std_bios_param(struct scsi_device *sdev,
833                               struct block_device *bdev,
834                               sector_t capacity, int geom[]);
835 extern int ata_scsi_slave_config(struct scsi_device *sdev);
836 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
837 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
838                                        int queue_depth);
839 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
840 extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
841 extern u8 ata_irq_on(struct ata_port *ap);
842 extern u8 ata_dummy_irq_on(struct ata_port *ap);
843 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
844 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
845
846 extern int ata_cable_40wire(struct ata_port *ap);
847 extern int ata_cable_80wire(struct ata_port *ap);
848 extern int ata_cable_sata(struct ata_port *ap);
849 extern int ata_cable_unknown(struct ata_port *ap);
850
851 /*
852  * Timing helpers
853  */
854
855 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
856 extern int ata_timing_compute(struct ata_device *, unsigned short,
857                               struct ata_timing *, int, int);
858 extern void ata_timing_merge(const struct ata_timing *,
859                              const struct ata_timing *, struct ata_timing *,
860                              unsigned int);
861
862 enum {
863         ATA_TIMING_SETUP        = (1 << 0),
864         ATA_TIMING_ACT8B        = (1 << 1),
865         ATA_TIMING_REC8B        = (1 << 2),
866         ATA_TIMING_CYC8B        = (1 << 3),
867         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
868                                   ATA_TIMING_CYC8B,
869         ATA_TIMING_ACTIVE       = (1 << 4),
870         ATA_TIMING_RECOVER      = (1 << 5),
871         ATA_TIMING_CYCLE        = (1 << 6),
872         ATA_TIMING_UDMA         = (1 << 7),
873         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
874                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
875                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
876                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
877 };
878
879
880 #ifdef CONFIG_PCI
881 struct pci_bits {
882         unsigned int            reg;    /* PCI config register to read */
883         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
884         unsigned long           mask;
885         unsigned long           val;
886 };
887
888 extern int ata_pci_init_sff_host(struct ata_host *host);
889 extern int ata_pci_init_bmdma(struct ata_host *host);
890 extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
891                                     const struct ata_port_info * const * ppi,
892                                     struct ata_host **r_host);
893 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
894 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
895 #endif /* CONFIG_PCI */
896
897 /*
898  * EH
899  */
900 extern void ata_eng_timeout(struct ata_port *ap);
901
902 extern void ata_port_schedule_eh(struct ata_port *ap);
903 extern int ata_port_abort(struct ata_port *ap);
904 extern int ata_port_freeze(struct ata_port *ap);
905
906 extern void ata_eh_freeze_port(struct ata_port *ap);
907 extern void ata_eh_thaw_port(struct ata_port *ap);
908
909 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
910 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
911
912 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
913                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
914                       ata_postreset_fn_t postreset);
915
916 /*
917  * printk helpers
918  */
919 #define ata_port_printk(ap, lv, fmt, args...) \
920         printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
921
922 #define ata_link_printk(link, lv, fmt, args...) \
923         printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args)
924
925 #define ata_dev_printk(dev, lv, fmt, args...) \
926         printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, (dev)->devno , ##args)
927
928 /*
929  * ata_eh_info helpers
930  */
931 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
932 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
933 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
934
935 static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
936 {
937         ehi->flags |= ATA_EHI_RESUME_LINK;
938         ehi->action |= ATA_EH_SOFTRESET;
939         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
940 }
941
942 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
943 {
944         ata_ehi_schedule_probe(ehi);
945         ehi->flags |= ATA_EHI_HOTPLUGGED;
946         ehi->err_mask |= AC_ERR_ATA_BUS;
947 }
948
949 /*
950  * qc helpers
951  */
952 static inline int
953 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
954 {
955         if (sg == &qc->pad_sgent)
956                 return 1;
957         if (qc->pad_len)
958                 return 0;
959         if (((sg - qc->__sg) + 1) == qc->n_elem)
960                 return 1;
961         return 0;
962 }
963
964 static inline struct scatterlist *
965 ata_qc_first_sg(struct ata_queued_cmd *qc)
966 {
967         if (qc->n_elem)
968                 return qc->__sg;
969         if (qc->pad_len)
970                 return &qc->pad_sgent;
971         return NULL;
972 }
973
974 static inline struct scatterlist *
975 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
976 {
977         if (sg == &qc->pad_sgent)
978                 return NULL;
979         if (++sg - qc->__sg < qc->n_elem)
980                 return sg;
981         if (qc->pad_len)
982                 return &qc->pad_sgent;
983         return NULL;
984 }
985
986 #define ata_for_each_sg(sg, qc) \
987         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
988
989 static inline unsigned int ata_tag_valid(unsigned int tag)
990 {
991         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
992 }
993
994 static inline unsigned int ata_tag_internal(unsigned int tag)
995 {
996         return tag == ATA_MAX_QUEUE - 1;
997 }
998
999 /*
1000  * device helpers
1001  */
1002 static inline unsigned int ata_class_enabled(unsigned int class)
1003 {
1004         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
1005 }
1006
1007 static inline unsigned int ata_class_disabled(unsigned int class)
1008 {
1009         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1010 }
1011
1012 static inline unsigned int ata_class_absent(unsigned int class)
1013 {
1014         return !ata_class_enabled(class) && !ata_class_disabled(class);
1015 }
1016
1017 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1018 {
1019         return ata_class_enabled(dev->class);
1020 }
1021
1022 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1023 {
1024         return ata_class_disabled(dev->class);
1025 }
1026
1027 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1028 {
1029         return ata_class_absent(dev->class);
1030 }
1031
1032 /*
1033  * link helpers
1034  */
1035 static inline int ata_link_max_devices(const struct ata_link *link)
1036 {
1037         if (link->ap->flags & ATA_FLAG_SLAVE_POSS)
1038                 return 2;
1039         return 1;
1040 }
1041
1042 #define ata_port_for_each_link(lk, ap) \
1043         for ((lk) = &(ap)->link; (lk); (lk) = NULL)
1044
1045 #define ata_link_for_each_dev(dev, link) \
1046         for ((dev) = (link)->device; \
1047              (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1048              (dev)++)
1049
1050 #define ata_link_for_each_dev_reverse(dev, link) \
1051         for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1052              (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1053
1054 static inline u8 ata_chk_status(struct ata_port *ap)
1055 {
1056         return ap->ops->check_status(ap);
1057 }
1058
1059 /**
1060  *      ata_ncq_enabled - Test whether NCQ is enabled
1061  *      @dev: ATA device to test for
1062  *
1063  *      LOCKING:
1064  *      spin_lock_irqsave(host lock)
1065  *
1066  *      RETURNS:
1067  *      1 if NCQ is enabled for @dev, 0 otherwise.
1068  */
1069 static inline int ata_ncq_enabled(struct ata_device *dev)
1070 {
1071         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1072                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1073 }
1074
1075 /**
1076  *      ata_pause - Flush writes and pause 400 nanoseconds.
1077  *      @ap: Port to wait for.
1078  *
1079  *      LOCKING:
1080  *      Inherited from caller.
1081  */
1082
1083 static inline void ata_pause(struct ata_port *ap)
1084 {
1085         ata_altstatus(ap);
1086         ndelay(400);
1087 }
1088
1089
1090 /**
1091  *      ata_busy_wait - Wait for a port status register
1092  *      @ap: Port to wait for.
1093  *      @bits: bits that must be clear
1094  *      @max: number of 10uS waits to perform
1095  *
1096  *      Waits up to max*10 microseconds for the selected bits in the port's
1097  *      status register to be cleared.
1098  *      Returns final value of status register.
1099  *
1100  *      LOCKING:
1101  *      Inherited from caller.
1102  */
1103
1104 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1105                                unsigned int max)
1106 {
1107         u8 status;
1108
1109         do {
1110                 udelay(10);
1111                 status = ata_chk_status(ap);
1112                 max--;
1113         } while (status != 0xff && (status & bits) && (max > 0));
1114
1115         return status;
1116 }
1117
1118
1119 /**
1120  *      ata_wait_idle - Wait for a port to be idle.
1121  *      @ap: Port to wait for.
1122  *
1123  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1124  *      Returns final value of status register.
1125  *
1126  *      LOCKING:
1127  *      Inherited from caller.
1128  */
1129
1130 static inline u8 ata_wait_idle(struct ata_port *ap)
1131 {
1132         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1133
1134         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1135                 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1136                         status, ap->ioaddr.status_addr);
1137
1138         return status;
1139 }
1140
1141 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1142 {
1143         qc->tf.ctl |= ATA_NIEN;
1144 }
1145
1146 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1147                                                        unsigned int tag)
1148 {
1149         if (likely(ata_tag_valid(tag)))
1150                 return &ap->qcmd[tag];
1151         return NULL;
1152 }
1153
1154 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1155                                                      unsigned int tag)
1156 {
1157         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1158
1159         if (unlikely(!qc) || !ap->ops->error_handler)
1160                 return qc;
1161
1162         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1163                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1164                 return qc;
1165
1166         return NULL;
1167 }
1168
1169 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1170 {
1171         memset(tf, 0, sizeof(*tf));
1172
1173         tf->ctl = dev->link->ap->ctl;
1174         if (dev->devno == 0)
1175                 tf->device = ATA_DEVICE_OBS;
1176         else
1177                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1178 }
1179
1180 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1181 {
1182         qc->dma_dir = DMA_NONE;
1183         qc->__sg = NULL;
1184         qc->flags = 0;
1185         qc->cursg = qc->cursg_ofs = 0;
1186         qc->nbytes = qc->curbytes = 0;
1187         qc->n_elem = 0;
1188         qc->err_mask = 0;
1189         qc->pad_len = 0;
1190         qc->sect_size = ATA_SECT_SIZE;
1191
1192         ata_tf_init(qc->dev, &qc->tf);
1193
1194         /* init result_tf such that it indicates normal completion */
1195         qc->result_tf.command = ATA_DRDY;
1196         qc->result_tf.feature = 0;
1197 }
1198
1199 static inline int ata_try_flush_cache(const struct ata_device *dev)
1200 {
1201         return ata_id_wcache_enabled(dev->id) ||
1202                ata_id_has_flush(dev->id) ||
1203                ata_id_has_flush_ext(dev->id);
1204 }
1205
1206 static inline unsigned int ac_err_mask(u8 status)
1207 {
1208         if (status & (ATA_BUSY | ATA_DRQ))
1209                 return AC_ERR_HSM;
1210         if (status & (ATA_ERR | ATA_DF))
1211                 return AC_ERR_DEV;
1212         return 0;
1213 }
1214
1215 static inline unsigned int __ac_err_mask(u8 status)
1216 {
1217         unsigned int mask = ac_err_mask(status);
1218         if (mask == 0)
1219                 return AC_ERR_OTHER;
1220         return mask;
1221 }
1222
1223 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1224 {
1225         ap->pad_dma = 0;
1226         ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1227                                       &ap->pad_dma, GFP_KERNEL);
1228         return (ap->pad == NULL) ? -ENOMEM : 0;
1229 }
1230
1231 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1232 {
1233         dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1234 }
1235
1236 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1237 {
1238         return *(struct ata_port **)&host->hostdata[0];
1239 }
1240
1241 #endif /* __LINUX_LIBATA_H__ */