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