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