i2c-piix4: Add support for the ATI SB700
[linux-2.6] / 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_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
200         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
201         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
202         ATA_PFLAG_GTM_VALID     = (1 << 19), /* acpi_gtm data valid */
203
204         /* struct ata_queued_cmd flags */
205         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
206         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
207         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
208         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
209         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
210         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
211
212         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
213         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
214         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
215
216         /* host set flags */
217         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
218         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
219
220         /* various lengths of time */
221         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
222         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
223         ATA_TMOUT_INTERNAL      = 30 * HZ,
224         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
225
226         /* ATA bus states */
227         BUS_UNKNOWN             = 0,
228         BUS_DMA                 = 1,
229         BUS_IDLE                = 2,
230         BUS_NOINTR              = 3,
231         BUS_NODATA              = 4,
232         BUS_TIMER               = 5,
233         BUS_PIO                 = 6,
234         BUS_EDD                 = 7,
235         BUS_IDENTIFY            = 8,
236         BUS_PACKET              = 9,
237
238         /* SATA port states */
239         PORT_UNKNOWN            = 0,
240         PORT_ENABLED            = 1,
241         PORT_DISABLED           = 2,
242
243         /* encoding various smaller bitmaps into a single
244          * unsigned int bitmap
245          */
246         ATA_BITS_PIO            = 7,
247         ATA_BITS_MWDMA          = 5,
248         ATA_BITS_UDMA           = 8,
249
250         ATA_SHIFT_PIO           = 0,
251         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
252         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
253
254         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
255         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
256         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
257
258         /* size of buffer to pad xfers ending on unaligned boundaries */
259         ATA_DMA_PAD_SZ          = 4,
260         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
261
262         /* ering size */
263         ATA_ERING_SIZE          = 32,
264
265         /* desc_len for ata_eh_info and context */
266         ATA_EH_DESC_LEN         = 80,
267
268         /* reset / recovery action types */
269         ATA_EH_REVALIDATE       = (1 << 0),
270         ATA_EH_SOFTRESET        = (1 << 1),
271         ATA_EH_HARDRESET        = (1 << 2),
272
273         ATA_EH_RESET_MASK       = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
274         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE,
275
276         /* ata_eh_info->flags */
277         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
278         ATA_EHI_RESUME_LINK     = (1 << 1),  /* resume link (reset modifier) */
279         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
280         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
281
282         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
283         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
284         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
285         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
286         ATA_EHI_POST_SETMODE    = (1 << 20), /* revaildating after setmode */
287
288         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
289         ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
290
291         /* max repeat if error condition is still set after ->error_handler */
292         ATA_EH_MAX_REPEAT       = 5,
293
294         /* how hard are we gonna try to probe/recover devices */
295         ATA_PROBE_MAX_TRIES     = 3,
296         ATA_EH_DEV_TRIES        = 3,
297
298         /* Horkage types. May be set by libata or controller on drives
299            (some horkage may be drive/controller pair dependant */
300
301         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
302         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
303         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
304         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
305 };
306
307 enum hsm_task_states {
308         HSM_ST_IDLE,            /* no command on going */
309         HSM_ST_FIRST,           /* (waiting the device to)
310                                    write CDB or first data block */
311         HSM_ST,                 /* (waiting the device to) transfer data */
312         HSM_ST_LAST,            /* (waiting the device to) complete command */
313         HSM_ST_ERR,             /* error */
314 };
315
316 enum ata_completion_errors {
317         AC_ERR_DEV              = (1 << 0), /* device reported error */
318         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
319         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
320         AC_ERR_MEDIA            = (1 << 3), /* media error */
321         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
322         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
323         AC_ERR_SYSTEM           = (1 << 6), /* system error */
324         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
325         AC_ERR_OTHER            = (1 << 8), /* unknown */
326         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
327 };
328
329 /* forward declarations */
330 struct scsi_device;
331 struct ata_port_operations;
332 struct ata_port;
333 struct ata_queued_cmd;
334
335 /* typedefs */
336 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
337 typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
338 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
339                               unsigned long deadline);
340 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
341
342 struct ata_ioports {
343         void __iomem            *cmd_addr;
344         void __iomem            *data_addr;
345         void __iomem            *error_addr;
346         void __iomem            *feature_addr;
347         void __iomem            *nsect_addr;
348         void __iomem            *lbal_addr;
349         void __iomem            *lbam_addr;
350         void __iomem            *lbah_addr;
351         void __iomem            *device_addr;
352         void __iomem            *status_addr;
353         void __iomem            *command_addr;
354         void __iomem            *altstatus_addr;
355         void __iomem            *ctl_addr;
356         void __iomem            *bmdma_addr;
357         void __iomem            *scr_addr;
358 };
359
360 struct ata_host {
361         spinlock_t              lock;
362         struct device           *dev;
363         unsigned long           irq;
364         unsigned long           irq2;
365         void __iomem * const    *iomap;
366         unsigned int            n_ports;
367         void                    *private_data;
368         const struct ata_port_operations *ops;
369         unsigned long           flags;
370 #ifdef CONFIG_ATA_ACPI
371         acpi_handle             acpi_handle;
372 #endif
373         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
374         struct ata_port         *ports[0];
375 };
376
377 struct ata_queued_cmd {
378         struct ata_port         *ap;
379         struct ata_device       *dev;
380
381         struct scsi_cmnd        *scsicmd;
382         void                    (*scsidone)(struct scsi_cmnd *);
383
384         struct ata_taskfile     tf;
385         u8                      cdb[ATAPI_CDB_LEN];
386
387         unsigned long           flags;          /* ATA_QCFLAG_xxx */
388         unsigned int            tag;
389         unsigned int            n_elem;
390         unsigned int            orig_n_elem;
391
392         int                     dma_dir;
393
394         unsigned int            pad_len;
395         unsigned int            sect_size;
396
397         unsigned int            nbytes;
398         unsigned int            curbytes;
399
400         unsigned int            cursg;
401         unsigned int            cursg_ofs;
402
403         struct scatterlist      sgent;
404         struct scatterlist      pad_sgent;
405         void                    *buf_virt;
406
407         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
408         struct scatterlist      *__sg;
409
410         unsigned int            err_mask;
411         struct ata_taskfile     result_tf;
412         ata_qc_cb_t             complete_fn;
413
414         void                    *private_data;
415 };
416
417 struct ata_port_stats {
418         unsigned long           unhandled_irq;
419         unsigned long           idle_irq;
420         unsigned long           rw_reqbuf;
421 };
422
423 struct ata_ering_entry {
424         int                     is_io;
425         unsigned int            err_mask;
426         u64                     timestamp;
427 };
428
429 struct ata_ering {
430         int                     cursor;
431         struct ata_ering_entry  ring[ATA_ERING_SIZE];
432 };
433
434 struct ata_device {
435         struct ata_port         *ap;
436         unsigned int            devno;          /* 0 or 1 */
437         unsigned long           flags;          /* ATA_DFLAG_xxx */
438         struct scsi_device      *sdev;          /* attached SCSI device */
439 #ifdef CONFIG_ATA_ACPI
440         acpi_handle             acpi_handle;
441 #endif
442         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
443         u64                     n_sectors;      /* size of device, if ATA */
444         unsigned int            class;          /* ATA_DEV_xxx */
445         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
446         u8                      pio_mode;
447         u8                      dma_mode;
448         u8                      xfer_mode;
449         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
450
451         unsigned int            multi_count;    /* sectors count for
452                                                    READ/WRITE MULTIPLE */
453         unsigned int            max_sectors;    /* per-device max sectors */
454         unsigned int            cdb_len;
455
456         /* per-dev xfer mask */
457         unsigned int            pio_mask;
458         unsigned int            mwdma_mask;
459         unsigned int            udma_mask;
460
461         /* for CHS addressing */
462         u16                     cylinders;      /* Number of cylinders */
463         u16                     heads;          /* Number of heads */
464         u16                     sectors;        /* Number of sectors per track */
465
466         /* error history */
467         struct ata_ering        ering;
468         int                     spdn_cnt;
469         unsigned int            horkage;        /* List of broken features */
470 };
471
472 /* Offset into struct ata_device.  Fields above it are maintained
473  * acress device init.  Fields below are zeroed.
474  */
475 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
476
477 struct ata_eh_info {
478         struct ata_device       *dev;           /* offending device */
479         u32                     serror;         /* SError from LLDD */
480         unsigned int            err_mask;       /* port-wide err_mask */
481         unsigned int            action;         /* ATA_EH_* action mask */
482         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
483         unsigned int            flags;          /* ATA_EHI_* flags */
484
485         unsigned int            probe_mask;
486
487         char                    desc[ATA_EH_DESC_LEN];
488         int                     desc_len;
489 };
490
491 struct ata_eh_context {
492         struct ata_eh_info      i;
493         int                     tries[ATA_MAX_DEVICES];
494         unsigned int            classes[ATA_MAX_DEVICES];
495         unsigned int            did_probe_mask;
496 };
497
498 struct ata_acpi_drive
499 {
500         u32 pio;
501         u32 dma;
502 } __packed;
503
504 struct ata_acpi_gtm {
505         struct ata_acpi_drive drive[2];
506         u32 flags;
507 } __packed;
508
509 struct ata_port {
510         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
511         const struct ata_port_operations *ops;
512         spinlock_t              *lock;
513         unsigned long           flags;  /* ATA_FLAG_xxx */
514         unsigned int            pflags; /* ATA_PFLAG_xxx */
515         unsigned int            print_id; /* user visible unique port ID */
516         unsigned int            port_no; /* 0 based port no. inside the host */
517
518         struct ata_prd          *prd;    /* our SG list */
519         dma_addr_t              prd_dma; /* and its DMA mapping */
520
521         void                    *pad;   /* array of DMA pad buffers */
522         dma_addr_t              pad_dma;
523
524         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
525
526         u8                      ctl;    /* cache of ATA control register */
527         u8                      last_ctl;       /* Cache last written value */
528         unsigned int            pio_mask;
529         unsigned int            mwdma_mask;
530         unsigned int            udma_mask;
531         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
532         unsigned int            hw_sata_spd_limit;
533         unsigned int            sata_spd_limit; /* SATA PHY speed limit */
534
535         /* record runtime error info, protected by host lock */
536         struct ata_eh_info      eh_info;
537         /* EH context owned by EH */
538         struct ata_eh_context   eh_context;
539
540         struct ata_device       device[ATA_MAX_DEVICES];
541
542         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
543         unsigned long           qc_allocated;
544         unsigned int            qc_active;
545
546         unsigned int            active_tag;
547         u32                     sactive;
548
549         struct ata_port_stats   stats;
550         struct ata_host         *host;
551         struct device           *dev;
552
553         void                    *port_task_data;
554         struct delayed_work     port_task;
555         struct delayed_work     hotplug_task;
556         struct work_struct      scsi_rescan_task;
557
558         unsigned int            hsm_task_state;
559
560         u32                     msg_enable;
561         struct list_head        eh_done_q;
562         wait_queue_head_t       eh_wait_q;
563
564         pm_message_t            pm_mesg;
565         int                     *pm_result;
566
567         void                    *private_data;
568
569 #ifdef CONFIG_ATA_ACPI
570         acpi_handle             acpi_handle;
571         struct ata_acpi_gtm     acpi_gtm;
572 #endif
573         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
574 };
575
576 struct ata_port_operations {
577         void (*port_disable) (struct ata_port *);
578
579         void (*dev_config) (struct ata_device *);
580
581         void (*set_piomode) (struct ata_port *, struct ata_device *);
582         void (*set_dmamode) (struct ata_port *, struct ata_device *);
583         unsigned long (*mode_filter) (struct ata_device *, unsigned long);
584
585         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
586         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
587
588         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
589         u8   (*check_status)(struct ata_port *ap);
590         u8   (*check_altstatus)(struct ata_port *ap);
591         void (*dev_select)(struct ata_port *ap, unsigned int device);
592
593         void (*phy_reset) (struct ata_port *ap); /* obsolete */
594         int  (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
595
596         int (*cable_detect) (struct ata_port *ap);
597
598         int  (*check_atapi_dma) (struct ata_queued_cmd *qc);
599
600         void (*bmdma_setup) (struct ata_queued_cmd *qc);
601         void (*bmdma_start) (struct ata_queued_cmd *qc);
602
603         void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
604
605         void (*qc_prep) (struct ata_queued_cmd *qc);
606         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
607
608         /* Error handlers.  ->error_handler overrides ->eng_timeout and
609          * indicates that new-style EH is in place.
610          */
611         void (*eng_timeout) (struct ata_port *ap); /* obsolete */
612
613         void (*freeze) (struct ata_port *ap);
614         void (*thaw) (struct ata_port *ap);
615         void (*error_handler) (struct ata_port *ap);
616         void (*post_internal_cmd) (struct ata_queued_cmd *qc);
617
618         irq_handler_t irq_handler;
619         void (*irq_clear) (struct ata_port *);
620         u8 (*irq_on) (struct ata_port *);
621         u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
622
623         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
624         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
625                            u32 val);
626
627         int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
628         int (*port_resume) (struct ata_port *ap);
629
630         int (*port_start) (struct ata_port *ap);
631         void (*port_stop) (struct ata_port *ap);
632
633         void (*host_stop) (struct ata_host *host);
634
635         void (*bmdma_stop) (struct ata_queued_cmd *qc);
636         u8   (*bmdma_status) (struct ata_port *ap);
637 };
638
639 struct ata_port_info {
640         struct scsi_host_template       *sht;
641         unsigned long           flags;
642         unsigned long           pio_mask;
643         unsigned long           mwdma_mask;
644         unsigned long           udma_mask;
645         const struct ata_port_operations *port_ops;
646         irq_handler_t           irq_handler;
647         void                    *private_data;
648 };
649
650 struct ata_timing {
651         unsigned short mode;            /* ATA mode */
652         unsigned short setup;           /* t1 */
653         unsigned short act8b;           /* t2 for 8-bit I/O */
654         unsigned short rec8b;           /* t2i for 8-bit I/O */
655         unsigned short cyc8b;           /* t0 for 8-bit I/O */
656         unsigned short active;          /* t2 or tD */
657         unsigned short recover;         /* t2i or tK */
658         unsigned short cycle;           /* t0 */
659         unsigned short udma;            /* t2CYCTYP/2 */
660 };
661
662 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
663
664 extern const unsigned long sata_deb_timing_normal[];
665 extern const unsigned long sata_deb_timing_hotplug[];
666 extern const unsigned long sata_deb_timing_long[];
667
668 extern const struct ata_port_operations ata_dummy_port_ops;
669 extern const struct ata_port_info ata_dummy_port_info;
670
671 static inline const unsigned long *
672 sata_ehc_deb_timing(struct ata_eh_context *ehc)
673 {
674         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
675                 return sata_deb_timing_hotplug;
676         else
677                 return sata_deb_timing_normal;
678 }
679
680 static inline int ata_port_is_dummy(struct ata_port *ap)
681 {
682         return ap->ops == &ata_dummy_port_ops;
683 }
684
685 extern void sata_print_link_status(struct ata_port *ap);
686 extern void ata_port_probe(struct ata_port *);
687 extern void __sata_phy_reset(struct ata_port *ap);
688 extern void sata_phy_reset(struct ata_port *ap);
689 extern void ata_bus_reset(struct ata_port *ap);
690 extern int sata_set_spd(struct ata_port *ap);
691 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param,
692                              unsigned long deadline);
693 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param,
694                            unsigned long deadline);
695 extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
696 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
697                              unsigned long deadline);
698 extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
699                                unsigned long deadline);
700 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
701                               unsigned long deadline);
702 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
703 extern void ata_port_disable(struct ata_port *);
704 extern void ata_std_ports(struct ata_ioports *ioaddr);
705 #ifdef CONFIG_PCI
706 extern int ata_pci_init_one (struct pci_dev *pdev,
707                              const struct ata_port_info * const * ppi);
708 extern void ata_pci_remove_one (struct pci_dev *pdev);
709 #ifdef CONFIG_PM
710 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
711 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
712 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
713 extern int ata_pci_device_resume(struct pci_dev *pdev);
714 #endif
715 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
716 #endif /* CONFIG_PCI */
717 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
718 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
719                         const struct ata_port_info * const * ppi, int n_ports);
720 extern int ata_host_start(struct ata_host *host);
721 extern int ata_host_register(struct ata_host *host,
722                              struct scsi_host_template *sht);
723 extern int ata_host_activate(struct ata_host *host, int irq,
724                              irq_handler_t irq_handler, unsigned long irq_flags,
725                              struct scsi_host_template *sht);
726 extern void ata_host_detach(struct ata_host *host);
727 extern void ata_host_init(struct ata_host *, struct device *,
728                           unsigned long, const struct ata_port_operations *);
729 extern int ata_scsi_detect(struct scsi_host_template *sht);
730 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
731 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
732 extern void ata_sas_port_destroy(struct ata_port *);
733 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
734                                            struct ata_port_info *, struct Scsi_Host *);
735 extern int ata_sas_port_init(struct ata_port *);
736 extern int ata_sas_port_start(struct ata_port *ap);
737 extern void ata_sas_port_stop(struct ata_port *ap);
738 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
739 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
740                             struct ata_port *ap);
741 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
742 extern int sata_scr_valid(struct ata_port *ap);
743 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
744 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
745 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
746 extern int ata_port_online(struct ata_port *ap);
747 extern int ata_port_offline(struct ata_port *ap);
748 #ifdef CONFIG_PM
749 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
750 extern void ata_host_resume(struct ata_host *host);
751 #endif
752 extern int ata_ratelimit(void);
753 extern int ata_busy_sleep(struct ata_port *ap,
754                           unsigned long timeout_pat, unsigned long timeout);
755 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
756 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
757                                 void *data, unsigned long delay);
758 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
759                              unsigned long interval_msec,
760                              unsigned long timeout_msec);
761 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
762
763 /*
764  * Default driver ops implementations
765  */
766 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
767 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
768 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
769 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
770 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
771 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
772 extern u8 ata_check_status(struct ata_port *ap);
773 extern u8 ata_altstatus(struct ata_port *ap);
774 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
775 extern int ata_port_start (struct ata_port *ap);
776 extern int ata_sff_port_start (struct ata_port *ap);
777 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
778 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
779                           unsigned int buflen, int write_data);
780 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
781                                 unsigned int buflen, int write_data);
782 extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
783 extern void ata_qc_prep(struct ata_queued_cmd *qc);
784 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
785 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
786 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
787                 unsigned int buflen);
788 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
789                  unsigned int n_elem);
790 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
791 extern void ata_dev_disable(struct ata_device *adev);
792 extern void ata_id_string(const u16 *id, unsigned char *s,
793                           unsigned int ofs, unsigned int len);
794 extern void ata_id_c_string(const u16 *id, unsigned char *s,
795                             unsigned int ofs, unsigned int len);
796 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
797 extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
798 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
799 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
800 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
801 extern u8   ata_bmdma_status(struct ata_port *ap);
802 extern void ata_bmdma_irq_clear(struct ata_port *ap);
803 extern void ata_bmdma_freeze(struct ata_port *ap);
804 extern void ata_bmdma_thaw(struct ata_port *ap);
805 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
806                                ata_reset_fn_t softreset,
807                                ata_reset_fn_t hardreset,
808                                ata_postreset_fn_t postreset);
809 extern void ata_bmdma_error_handler(struct ata_port *ap);
810 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
811 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
812                         u8 status, int in_wq);
813 extern void ata_qc_complete(struct ata_queued_cmd *qc);
814 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
815                                     void (*finish_qc)(struct ata_queued_cmd *));
816 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
817                               void (*done)(struct scsi_cmnd *));
818 extern int ata_std_bios_param(struct scsi_device *sdev,
819                               struct block_device *bdev,
820                               sector_t capacity, int geom[]);
821 extern int ata_scsi_slave_config(struct scsi_device *sdev);
822 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
823 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
824                                        int queue_depth);
825 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
826 extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
827 extern u8 ata_irq_on(struct ata_port *ap);
828 extern u8 ata_dummy_irq_on(struct ata_port *ap);
829 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
830 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
831
832 extern int ata_cable_40wire(struct ata_port *ap);
833 extern int ata_cable_80wire(struct ata_port *ap);
834 extern int ata_cable_sata(struct ata_port *ap);
835 extern int ata_cable_unknown(struct ata_port *ap);
836
837 /*
838  * Timing helpers
839  */
840
841 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
842 extern int ata_timing_compute(struct ata_device *, unsigned short,
843                               struct ata_timing *, int, int);
844 extern void ata_timing_merge(const struct ata_timing *,
845                              const struct ata_timing *, struct ata_timing *,
846                              unsigned int);
847
848 enum {
849         ATA_TIMING_SETUP        = (1 << 0),
850         ATA_TIMING_ACT8B        = (1 << 1),
851         ATA_TIMING_REC8B        = (1 << 2),
852         ATA_TIMING_CYC8B        = (1 << 3),
853         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
854                                   ATA_TIMING_CYC8B,
855         ATA_TIMING_ACTIVE       = (1 << 4),
856         ATA_TIMING_RECOVER      = (1 << 5),
857         ATA_TIMING_CYCLE        = (1 << 6),
858         ATA_TIMING_UDMA         = (1 << 7),
859         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
860                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
861                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
862                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
863 };
864
865
866 #ifdef CONFIG_PCI
867 struct pci_bits {
868         unsigned int            reg;    /* PCI config register to read */
869         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
870         unsigned long           mask;
871         unsigned long           val;
872 };
873
874 extern int ata_pci_init_native_host(struct ata_host *host);
875 extern int ata_pci_init_bmdma(struct ata_host *host);
876 extern int ata_pci_prepare_native_host(struct pci_dev *pdev,
877                                 const struct ata_port_info * const * ppi,
878                                 struct ata_host **r_host);
879 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
880 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
881 #endif /* CONFIG_PCI */
882
883 /*
884  * EH
885  */
886 extern void ata_eng_timeout(struct ata_port *ap);
887
888 extern void ata_port_schedule_eh(struct ata_port *ap);
889 extern int ata_port_abort(struct ata_port *ap);
890 extern int ata_port_freeze(struct ata_port *ap);
891
892 extern void ata_eh_freeze_port(struct ata_port *ap);
893 extern void ata_eh_thaw_port(struct ata_port *ap);
894
895 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
896 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
897
898 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
899                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
900                       ata_postreset_fn_t postreset);
901
902 /*
903  * printk helpers
904  */
905 #define ata_port_printk(ap, lv, fmt, args...) \
906         printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
907
908 #define ata_dev_printk(dev, lv, fmt, args...) \
909         printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
910
911 /*
912  * ata_eh_info helpers
913  */
914 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
915         (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
916                                      ATA_EH_DESC_LEN - (ehi)->desc_len, \
917                                      fmt , ##args); \
918 } while (0)
919
920 #define ata_ehi_clear_desc(ehi) do { \
921         (ehi)->desc[0] = '\0'; \
922         (ehi)->desc_len = 0; \
923 } while (0)
924
925 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
926 {
927         ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
928         ehi->action |= ATA_EH_SOFTRESET;
929         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
930 }
931
932 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
933 {
934         __ata_ehi_hotplugged(ehi);
935         ehi->err_mask |= AC_ERR_ATA_BUS;
936 }
937
938 /*
939  * qc helpers
940  */
941 static inline int
942 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
943 {
944         if (sg == &qc->pad_sgent)
945                 return 1;
946         if (qc->pad_len)
947                 return 0;
948         if (((sg - qc->__sg) + 1) == qc->n_elem)
949                 return 1;
950         return 0;
951 }
952
953 static inline struct scatterlist *
954 ata_qc_first_sg(struct ata_queued_cmd *qc)
955 {
956         if (qc->n_elem)
957                 return qc->__sg;
958         if (qc->pad_len)
959                 return &qc->pad_sgent;
960         return NULL;
961 }
962
963 static inline struct scatterlist *
964 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
965 {
966         if (sg == &qc->pad_sgent)
967                 return NULL;
968         if (++sg - qc->__sg < qc->n_elem)
969                 return sg;
970         if (qc->pad_len)
971                 return &qc->pad_sgent;
972         return NULL;
973 }
974
975 #define ata_for_each_sg(sg, qc) \
976         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
977
978 static inline unsigned int ata_tag_valid(unsigned int tag)
979 {
980         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
981 }
982
983 static inline unsigned int ata_tag_internal(unsigned int tag)
984 {
985         return tag == ATA_MAX_QUEUE - 1;
986 }
987
988 /*
989  * device helpers
990  */
991 static inline unsigned int ata_class_enabled(unsigned int class)
992 {
993         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
994 }
995
996 static inline unsigned int ata_class_disabled(unsigned int class)
997 {
998         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
999 }
1000
1001 static inline unsigned int ata_class_absent(unsigned int class)
1002 {
1003         return !ata_class_enabled(class) && !ata_class_disabled(class);
1004 }
1005
1006 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1007 {
1008         return ata_class_enabled(dev->class);
1009 }
1010
1011 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1012 {
1013         return ata_class_disabled(dev->class);
1014 }
1015
1016 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1017 {
1018         return ata_class_absent(dev->class);
1019 }
1020
1021 /*
1022  * port helpers
1023  */
1024 static inline int ata_port_max_devices(const struct ata_port *ap)
1025 {
1026         if (ap->flags & ATA_FLAG_SLAVE_POSS)
1027                 return 2;
1028         return 1;
1029 }
1030
1031
1032 static inline u8 ata_chk_status(struct ata_port *ap)
1033 {
1034         return ap->ops->check_status(ap);
1035 }
1036
1037 /**
1038  *      ata_ncq_enabled - Test whether NCQ is enabled
1039  *      @dev: ATA device to test for
1040  *
1041  *      LOCKING:
1042  *      spin_lock_irqsave(host lock)
1043  *
1044  *      RETURNS:
1045  *      1 if NCQ is enabled for @dev, 0 otherwise.
1046  */
1047 static inline int ata_ncq_enabled(struct ata_device *dev)
1048 {
1049         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1050                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1051 }
1052
1053 /**
1054  *      ata_pause - Flush writes and pause 400 nanoseconds.
1055  *      @ap: Port to wait for.
1056  *
1057  *      LOCKING:
1058  *      Inherited from caller.
1059  */
1060
1061 static inline void ata_pause(struct ata_port *ap)
1062 {
1063         ata_altstatus(ap);
1064         ndelay(400);
1065 }
1066
1067
1068 /**
1069  *      ata_busy_wait - Wait for a port status register
1070  *      @ap: Port to wait for.
1071  *      @bits: bits that must be clear
1072  *      @max: number of 10uS waits to perform
1073  *
1074  *      Waits up to max*10 microseconds for the selected bits in the port's
1075  *      status register to be cleared.
1076  *      Returns final value of status register.
1077  *
1078  *      LOCKING:
1079  *      Inherited from caller.
1080  */
1081
1082 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1083                                unsigned int max)
1084 {
1085         u8 status;
1086
1087         do {
1088                 udelay(10);
1089                 status = ata_chk_status(ap);
1090                 max--;
1091         } while (status != 0xff && (status & bits) && (max > 0));
1092
1093         return status;
1094 }
1095
1096
1097 /**
1098  *      ata_wait_idle - Wait for a port to be idle.
1099  *      @ap: Port to wait for.
1100  *
1101  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1102  *      Returns final value of status register.
1103  *
1104  *      LOCKING:
1105  *      Inherited from caller.
1106  */
1107
1108 static inline u8 ata_wait_idle(struct ata_port *ap)
1109 {
1110         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1111
1112         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1113                 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1114                         status, ap->ioaddr.status_addr);
1115
1116         return status;
1117 }
1118
1119 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1120 {
1121         qc->tf.ctl |= ATA_NIEN;
1122 }
1123
1124 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1125                                                        unsigned int tag)
1126 {
1127         if (likely(ata_tag_valid(tag)))
1128                 return &ap->qcmd[tag];
1129         return NULL;
1130 }
1131
1132 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1133                                                      unsigned int tag)
1134 {
1135         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1136
1137         if (unlikely(!qc) || !ap->ops->error_handler)
1138                 return qc;
1139
1140         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1141                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1142                 return qc;
1143
1144         return NULL;
1145 }
1146
1147 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1148 {
1149         memset(tf, 0, sizeof(*tf));
1150
1151         tf->ctl = dev->ap->ctl;
1152         if (dev->devno == 0)
1153                 tf->device = ATA_DEVICE_OBS;
1154         else
1155                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1156 }
1157
1158 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1159 {
1160         qc->dma_dir = DMA_NONE;
1161         qc->__sg = NULL;
1162         qc->flags = 0;
1163         qc->cursg = qc->cursg_ofs = 0;
1164         qc->nbytes = qc->curbytes = 0;
1165         qc->n_elem = 0;
1166         qc->err_mask = 0;
1167         qc->pad_len = 0;
1168         qc->sect_size = ATA_SECT_SIZE;
1169
1170         ata_tf_init(qc->dev, &qc->tf);
1171
1172         /* init result_tf such that it indicates normal completion */
1173         qc->result_tf.command = ATA_DRDY;
1174         qc->result_tf.feature = 0;
1175 }
1176
1177 static inline int ata_try_flush_cache(const struct ata_device *dev)
1178 {
1179         return ata_id_wcache_enabled(dev->id) ||
1180                ata_id_has_flush(dev->id) ||
1181                ata_id_has_flush_ext(dev->id);
1182 }
1183
1184 static inline unsigned int ac_err_mask(u8 status)
1185 {
1186         if (status & (ATA_BUSY | ATA_DRQ))
1187                 return AC_ERR_HSM;
1188         if (status & (ATA_ERR | ATA_DF))
1189                 return AC_ERR_DEV;
1190         return 0;
1191 }
1192
1193 static inline unsigned int __ac_err_mask(u8 status)
1194 {
1195         unsigned int mask = ac_err_mask(status);
1196         if (mask == 0)
1197                 return AC_ERR_OTHER;
1198         return mask;
1199 }
1200
1201 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1202 {
1203         ap->pad_dma = 0;
1204         ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1205                                       &ap->pad_dma, GFP_KERNEL);
1206         return (ap->pad == NULL) ? -ENOMEM : 0;
1207 }
1208
1209 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1210 {
1211         dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1212 }
1213
1214 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1215 {
1216         return *(struct ata_port **)&host->hostdata[0];
1217 }
1218
1219 #endif /* __LINUX_LIBATA_H__ */