60dfc5f7e882b410b25a4dcec1109dbfc56b626a
[powerpc.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_SUSPENDED     = (1 << 10), /* device suspended */
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_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
175         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
176         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
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
195         ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
196         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
197         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
198
199         /* struct ata_queued_cmd flags */
200         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
201         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
202         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
203         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
204         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
205         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
206
207         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
208         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
209         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
210
211         /* host set flags */
212         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
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         ATA_EH_SUSPEND          = (1 << 3),
271         ATA_EH_RESUME           = (1 << 4),
272         ATA_EH_PM_FREEZE        = (1 << 5),
273
274         ATA_EH_RESET_MASK       = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
275         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
276                                   ATA_EH_RESUME | ATA_EH_PM_FREEZE,
277
278         /* ata_eh_info->flags */
279         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
280         ATA_EHI_RESUME_LINK     = (1 << 1),  /* resume link (reset modifier) */
281         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
282         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
283
284         ATA_EHI_DID_RESET       = (1 << 16), /* already reset this port */
285         ATA_EHI_PRINTINFO       = (1 << 17), /* print configuration info */
286         ATA_EHI_SETMODE         = (1 << 18), /* configure transfer mode */
287         ATA_EHI_POST_SETMODE    = (1 << 19), /* revaildating after setmode */
288
289         ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
290
291         /* max repeat if error condition is still set after ->error_handler */
292         ATA_EH_MAX_REPEAT       = 5,
293
294         /* how hard are we gonna try to probe/recover devices */
295         ATA_PROBE_MAX_TRIES     = 3,
296         ATA_EH_RESET_TRIES      = 3,
297         ATA_EH_DEV_TRIES        = 3,
298
299         /* Drive spinup time (time from power-on to the first D2H FIS)
300          * in msecs - 8s currently.  Failing to get ready in this time
301          * isn't critical.  It will result in reset failure for
302          * controllers which can't wait for the first D2H FIS.  libata
303          * will retry, so it just has to be long enough to spin up
304          * most devices.
305          */
306         ATA_SPINUP_WAIT         = 8000,
307
308         /* Horkage types. May be set by libata or controller on drives
309            (some horkage may be drive/controller pair dependant */
310
311         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
312         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
313         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
314 };
315
316 enum hsm_task_states {
317         HSM_ST_IDLE,            /* no command on going */
318         HSM_ST,                 /* (waiting the device to) transfer data */
319         HSM_ST_LAST,            /* (waiting the device to) complete command */
320         HSM_ST_ERR,             /* error */
321         HSM_ST_FIRST,           /* (waiting the device to)
322                                    write CDB or first data block */
323 };
324
325 enum ata_completion_errors {
326         AC_ERR_DEV              = (1 << 0), /* device reported error */
327         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
328         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
329         AC_ERR_MEDIA            = (1 << 3), /* media error */
330         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
331         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
332         AC_ERR_SYSTEM           = (1 << 6), /* system error */
333         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
334         AC_ERR_OTHER            = (1 << 8), /* unknown */
335         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
336 };
337
338 /* forward declarations */
339 struct scsi_device;
340 struct ata_port_operations;
341 struct ata_port;
342 struct ata_queued_cmd;
343
344 /* typedefs */
345 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
346 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
347 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
348 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
349
350 struct ata_ioports {
351         void __iomem            *cmd_addr;
352         void __iomem            *data_addr;
353         void __iomem            *error_addr;
354         void __iomem            *feature_addr;
355         void __iomem            *nsect_addr;
356         void __iomem            *lbal_addr;
357         void __iomem            *lbam_addr;
358         void __iomem            *lbah_addr;
359         void __iomem            *device_addr;
360         void __iomem            *status_addr;
361         void __iomem            *command_addr;
362         void __iomem            *altstatus_addr;
363         void __iomem            *ctl_addr;
364         void __iomem            *bmdma_addr;
365         void __iomem            *scr_addr;
366 };
367
368 struct ata_probe_ent {
369         struct list_head        node;
370         struct device           *dev;
371         const struct ata_port_operations *port_ops;
372         struct scsi_host_template *sht;
373         struct ata_ioports      port[ATA_MAX_PORTS];
374         unsigned int            n_ports;
375         unsigned int            dummy_port_mask;
376         unsigned int            pio_mask;
377         unsigned int            mwdma_mask;
378         unsigned int            udma_mask;
379         unsigned long           irq;
380         unsigned long           irq2;
381         unsigned int            irq_flags;
382         unsigned long           port_flags;
383         unsigned long           _host_flags;
384         void __iomem * const    *iomap;
385         void                    *private_data;
386
387         /* port_info for the secondary port.  Together with irq2, it's
388          * used to implement non-uniform secondary port.  Currently,
389          * the only user is ata_piix combined mode.  This workaround
390          * will be removed together with ata_probe_ent when init model
391          * is updated.
392          */
393         const struct ata_port_info *pinfo2;
394 };
395
396 struct ata_host {
397         spinlock_t              lock;
398         struct device           *dev;
399         unsigned long           irq;
400         unsigned long           irq2;
401         void __iomem * const    *iomap;
402         unsigned int            n_ports;
403         void                    *private_data;
404         const struct ata_port_operations *ops;
405         unsigned long           flags;
406         int                     simplex_claimed;        /* Keep seperate in case we
407                                                            ever need to do this locked */
408         struct ata_port         *ports[0];
409 };
410
411 struct ata_queued_cmd {
412         struct ata_port         *ap;
413         struct ata_device       *dev;
414
415         struct scsi_cmnd        *scsicmd;
416         void                    (*scsidone)(struct scsi_cmnd *);
417
418         struct ata_taskfile     tf;
419         u8                      cdb[ATAPI_CDB_LEN];
420
421         unsigned long           flags;          /* ATA_QCFLAG_xxx */
422         unsigned int            tag;
423         unsigned int            n_elem;
424         unsigned int            orig_n_elem;
425
426         int                     dma_dir;
427
428         unsigned int            pad_len;
429
430         unsigned int            nbytes;
431         unsigned int            curbytes;
432
433         unsigned int            cursg;
434         unsigned int            cursg_ofs;
435
436         struct scatterlist      sgent;
437         struct scatterlist      pad_sgent;
438         void                    *buf_virt;
439
440         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
441         struct scatterlist      *__sg;
442
443         unsigned int            err_mask;
444         struct ata_taskfile     result_tf;
445         ata_qc_cb_t             complete_fn;
446
447         void                    *private_data;
448 };
449
450 struct ata_port_stats {
451         unsigned long           unhandled_irq;
452         unsigned long           idle_irq;
453         unsigned long           rw_reqbuf;
454 };
455
456 struct ata_ering_entry {
457         int                     is_io;
458         unsigned int            err_mask;
459         u64                     timestamp;
460 };
461
462 struct ata_ering {
463         int                     cursor;
464         struct ata_ering_entry  ring[ATA_ERING_SIZE];
465 };
466
467 struct ata_device {
468         struct ata_port         *ap;
469         unsigned int            devno;          /* 0 or 1 */
470         unsigned long           flags;          /* ATA_DFLAG_xxx */
471         struct scsi_device      *sdev;          /* attached SCSI device */
472         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
473         u64                     n_sectors;      /* size of device, if ATA */
474         unsigned int            class;          /* ATA_DEV_xxx */
475         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
476         u8                      pio_mode;
477         u8                      dma_mode;
478         u8                      xfer_mode;
479         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
480
481         unsigned int            multi_count;    /* sectors count for
482                                                    READ/WRITE MULTIPLE */
483         unsigned int            max_sectors;    /* per-device max sectors */
484         unsigned int            cdb_len;
485
486         /* per-dev xfer mask */
487         unsigned int            pio_mask;
488         unsigned int            mwdma_mask;
489         unsigned int            udma_mask;
490
491         /* for CHS addressing */
492         u16                     cylinders;      /* Number of cylinders */
493         u16                     heads;          /* Number of heads */
494         u16                     sectors;        /* Number of sectors per track */
495
496         /* error history */
497         struct ata_ering        ering;
498         unsigned int            horkage;        /* List of broken features */
499 #ifdef CONFIG_SATA_ACPI
500         /* ACPI objects info */
501         acpi_handle obj_handle;
502 #endif
503 };
504
505 /* Offset into struct ata_device.  Fields above it are maintained
506  * acress device init.  Fields below are zeroed.
507  */
508 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
509
510 struct ata_eh_info {
511         struct ata_device       *dev;           /* offending device */
512         u32                     serror;         /* SError from LLDD */
513         unsigned int            err_mask;       /* port-wide err_mask */
514         unsigned int            action;         /* ATA_EH_* action mask */
515         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
516         unsigned int            flags;          /* ATA_EHI_* flags */
517
518         unsigned long           hotplug_timestamp;
519         unsigned int            probe_mask;
520
521         char                    desc[ATA_EH_DESC_LEN];
522         int                     desc_len;
523 };
524
525 struct ata_eh_context {
526         struct ata_eh_info      i;
527         int                     tries[ATA_MAX_DEVICES];
528         unsigned int            classes[ATA_MAX_DEVICES];
529         unsigned int            did_probe_mask;
530 };
531
532 struct ata_port {
533         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
534         const struct ata_port_operations *ops;
535         spinlock_t              *lock;
536         unsigned long           flags;  /* ATA_FLAG_xxx */
537         unsigned int            pflags; /* ATA_PFLAG_xxx */
538         unsigned int            id;     /* unique id req'd by scsi midlyr */
539         unsigned int            port_no; /* unique port #; from zero */
540
541         struct ata_prd          *prd;    /* our SG list */
542         dma_addr_t              prd_dma; /* and its DMA mapping */
543
544         void                    *pad;   /* array of DMA pad buffers */
545         dma_addr_t              pad_dma;
546
547         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
548
549         u8                      ctl;    /* cache of ATA control register */
550         u8                      last_ctl;       /* Cache last written value */
551         unsigned int            pio_mask;
552         unsigned int            mwdma_mask;
553         unsigned int            udma_mask;
554         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
555         unsigned int            hw_sata_spd_limit;
556         unsigned int            sata_spd_limit; /* SATA PHY speed limit */
557
558         /* record runtime error info, protected by host lock */
559         struct ata_eh_info      eh_info;
560         /* EH context owned by EH */
561         struct ata_eh_context   eh_context;
562
563         struct ata_device       device[ATA_MAX_DEVICES];
564
565         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
566         unsigned long           qc_allocated;
567         unsigned int            qc_active;
568
569         unsigned int            active_tag;
570         u32                     sactive;
571
572         struct ata_port_stats   stats;
573         struct ata_host         *host;
574         struct device           *dev;
575
576         void                    *port_task_data;
577         struct delayed_work     port_task;
578         struct delayed_work     hotplug_task;
579         struct work_struct      scsi_rescan_task;
580
581         unsigned int            hsm_task_state;
582
583         u32                     msg_enable;
584         struct list_head        eh_done_q;
585         wait_queue_head_t       eh_wait_q;
586
587         pm_message_t            pm_mesg;
588         int                     *pm_result;
589
590         void                    *private_data;
591
592         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
593 };
594
595 struct ata_port_operations {
596         void (*port_disable) (struct ata_port *);
597
598         void (*dev_config) (struct ata_port *, struct ata_device *);
599
600         void (*set_piomode) (struct ata_port *, struct ata_device *);
601         void (*set_dmamode) (struct ata_port *, struct ata_device *);
602         unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
603
604         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
605         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
606
607         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
608         u8   (*check_status)(struct ata_port *ap);
609         u8   (*check_altstatus)(struct ata_port *ap);
610         void (*dev_select)(struct ata_port *ap, unsigned int device);
611
612         void (*phy_reset) (struct ata_port *ap); /* obsolete */
613         int  (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
614
615         void (*post_set_mode) (struct ata_port *ap);
616
617         int  (*check_atapi_dma) (struct ata_queued_cmd *qc);
618
619         void (*bmdma_setup) (struct ata_queued_cmd *qc);
620         void (*bmdma_start) (struct ata_queued_cmd *qc);
621
622         void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
623
624         void (*qc_prep) (struct ata_queued_cmd *qc);
625         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
626
627         /* Error handlers.  ->error_handler overrides ->eng_timeout and
628          * indicates that new-style EH is in place.
629          */
630         void (*eng_timeout) (struct ata_port *ap); /* obsolete */
631
632         void (*freeze) (struct ata_port *ap);
633         void (*thaw) (struct ata_port *ap);
634         void (*error_handler) (struct ata_port *ap);
635         void (*post_internal_cmd) (struct ata_queued_cmd *qc);
636
637         irq_handler_t irq_handler;
638         void (*irq_clear) (struct ata_port *);
639         u8 (*irq_on) (struct ata_port *);
640         u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
641
642         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
643         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
644                            u32 val);
645
646         int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
647         int (*port_resume) (struct ata_port *ap);
648
649         int (*port_start) (struct ata_port *ap);
650         void (*port_stop) (struct ata_port *ap);
651
652         void (*host_stop) (struct ata_host *host);
653
654         void (*bmdma_stop) (struct ata_queued_cmd *qc);
655         u8   (*bmdma_status) (struct ata_port *ap);
656 };
657
658 struct ata_port_info {
659         struct scsi_host_template       *sht;
660         unsigned long           flags;
661         unsigned long           pio_mask;
662         unsigned long           mwdma_mask;
663         unsigned long           udma_mask;
664         const struct ata_port_operations *port_ops;
665         void                    *private_data;
666 };
667
668 struct ata_timing {
669         unsigned short mode;            /* ATA mode */
670         unsigned short setup;           /* t1 */
671         unsigned short act8b;           /* t2 for 8-bit I/O */
672         unsigned short rec8b;           /* t2i for 8-bit I/O */
673         unsigned short cyc8b;           /* t0 for 8-bit I/O */
674         unsigned short active;          /* t2 or tD */
675         unsigned short recover;         /* t2i or tK */
676         unsigned short cycle;           /* t0 */
677         unsigned short udma;            /* t2CYCTYP/2 */
678 };
679
680 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
681
682 extern const unsigned long sata_deb_timing_normal[];
683 extern const unsigned long sata_deb_timing_hotplug[];
684 extern const unsigned long sata_deb_timing_long[];
685
686 extern const struct ata_port_operations ata_dummy_port_ops;
687
688 static inline const unsigned long *
689 sata_ehc_deb_timing(struct ata_eh_context *ehc)
690 {
691         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
692                 return sata_deb_timing_hotplug;
693         else
694                 return sata_deb_timing_normal;
695 }
696
697 static inline int ata_port_is_dummy(struct ata_port *ap)
698 {
699         return ap->ops == &ata_dummy_port_ops;
700 }
701
702 extern void ata_port_probe(struct ata_port *);
703 extern void __sata_phy_reset(struct ata_port *ap);
704 extern void sata_phy_reset(struct ata_port *ap);
705 extern void ata_bus_reset(struct ata_port *ap);
706 extern int sata_set_spd(struct ata_port *ap);
707 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
708 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
709 extern int ata_std_prereset(struct ata_port *ap);
710 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
711 extern int sata_port_hardreset(struct ata_port *ap,
712                                const unsigned long *timing);
713 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
714 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
715 extern void ata_port_disable(struct ata_port *);
716 extern void ata_std_ports(struct ata_ioports *ioaddr);
717 #ifdef CONFIG_PCI
718 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
719                              unsigned int n_ports);
720 extern void ata_pci_remove_one (struct pci_dev *pdev);
721 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
722 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
723 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
724 extern int ata_pci_device_resume(struct pci_dev *pdev);
725 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
726 #endif /* CONFIG_PCI */
727 extern int ata_device_add(const struct ata_probe_ent *ent);
728 extern void ata_host_detach(struct ata_host *host);
729 extern void ata_host_init(struct ata_host *, struct device *,
730                           unsigned long, const struct ata_port_operations *);
731 extern int ata_scsi_detect(struct scsi_host_template *sht);
732 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
733 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
734 extern void ata_sas_port_destroy(struct ata_port *);
735 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
736                                            struct ata_port_info *, struct Scsi_Host *);
737 extern int ata_sas_port_init(struct ata_port *);
738 extern int ata_sas_port_start(struct ata_port *ap);
739 extern void ata_sas_port_stop(struct ata_port *ap);
740 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
741 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
742                             struct ata_port *ap);
743 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
744 extern int sata_scr_valid(struct ata_port *ap);
745 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
746 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
747 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
748 extern int ata_port_online(struct ata_port *ap);
749 extern int ata_port_offline(struct ata_port *ap);
750 extern int ata_scsi_device_resume(struct scsi_device *);
751 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
752 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
753 extern void ata_host_resume(struct ata_host *host);
754 extern int ata_ratelimit(void);
755 extern int ata_busy_sleep(struct ata_port *ap,
756                           unsigned long timeout_pat, unsigned long timeout);
757 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
758                                 void *data, unsigned long delay);
759 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
760                              unsigned long interval_msec,
761                              unsigned long timeout_msec);
762 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
763
764 /*
765  * Default driver ops implementations
766  */
767 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
768 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
769 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
770 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
771 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
772 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
773 extern u8 ata_check_status(struct ata_port *ap);
774 extern u8 ata_altstatus(struct ata_port *ap);
775 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
776 extern int ata_port_start (struct ata_port *ap);
777 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
778 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
779                           unsigned int buflen, int write_data);
780 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
781                                 unsigned int buflen, int write_data);
782 extern void ata_qc_prep(struct ata_queued_cmd *qc);
783 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
784 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
785 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
786                 unsigned int buflen);
787 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
788                  unsigned int n_elem);
789 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
790 extern void ata_id_string(const u16 *id, unsigned char *s,
791                           unsigned int ofs, unsigned int len);
792 extern void ata_id_c_string(const u16 *id, unsigned char *s,
793                             unsigned int ofs, unsigned int len);
794 extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
795 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
796 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
797 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
798 extern u8   ata_bmdma_status(struct ata_port *ap);
799 extern void ata_bmdma_irq_clear(struct ata_port *ap);
800 extern void ata_bmdma_freeze(struct ata_port *ap);
801 extern void ata_bmdma_thaw(struct ata_port *ap);
802 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
803                                ata_reset_fn_t softreset,
804                                ata_reset_fn_t hardreset,
805                                ata_postreset_fn_t postreset);
806 extern void ata_bmdma_error_handler(struct ata_port *ap);
807 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
808 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
809                         u8 status, int in_wq);
810 extern void ata_qc_complete(struct ata_queued_cmd *qc);
811 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
812                                     void (*finish_qc)(struct ata_queued_cmd *));
813 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
814                               void (*done)(struct scsi_cmnd *));
815 extern int ata_std_bios_param(struct scsi_device *sdev,
816                               struct block_device *bdev,
817                               sector_t capacity, int geom[]);
818 extern int ata_scsi_slave_config(struct scsi_device *sdev);
819 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
820 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
821                                        int queue_depth);
822 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
823 extern u8 ata_irq_on(struct ata_port *ap);
824 extern u8 ata_dummy_irq_on(struct ata_port *ap);
825 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
826 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
827
828 /*
829  * Timing helpers
830  */
831
832 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
833 extern int ata_timing_compute(struct ata_device *, unsigned short,
834                               struct ata_timing *, int, int);
835 extern void ata_timing_merge(const struct ata_timing *,
836                              const struct ata_timing *, struct ata_timing *,
837                              unsigned int);
838
839 enum {
840         ATA_TIMING_SETUP        = (1 << 0),
841         ATA_TIMING_ACT8B        = (1 << 1),
842         ATA_TIMING_REC8B        = (1 << 2),
843         ATA_TIMING_CYC8B        = (1 << 3),
844         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
845                                   ATA_TIMING_CYC8B,
846         ATA_TIMING_ACTIVE       = (1 << 4),
847         ATA_TIMING_RECOVER      = (1 << 5),
848         ATA_TIMING_CYCLE        = (1 << 6),
849         ATA_TIMING_UDMA         = (1 << 7),
850         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
851                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
852                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
853                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
854 };
855
856
857 #ifdef CONFIG_PCI
858 struct pci_bits {
859         unsigned int            reg;    /* PCI config register to read */
860         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
861         unsigned long           mask;
862         unsigned long           val;
863 };
864
865 extern struct ata_probe_ent *
866 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
867 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
868 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
869 #endif /* CONFIG_PCI */
870
871 /*
872  * EH
873  */
874 extern void ata_eng_timeout(struct ata_port *ap);
875
876 extern void ata_port_schedule_eh(struct ata_port *ap);
877 extern int ata_port_abort(struct ata_port *ap);
878 extern int ata_port_freeze(struct ata_port *ap);
879
880 extern void ata_eh_freeze_port(struct ata_port *ap);
881 extern void ata_eh_thaw_port(struct ata_port *ap);
882
883 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
884 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
885
886 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
887                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
888                       ata_postreset_fn_t postreset);
889
890 /*
891  * printk helpers
892  */
893 #define ata_port_printk(ap, lv, fmt, args...) \
894         printk(lv"ata%u: "fmt, (ap)->id , ##args)
895
896 #define ata_dev_printk(dev, lv, fmt, args...) \
897         printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
898
899 /*
900  * ata_eh_info helpers
901  */
902 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
903         (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
904                                      ATA_EH_DESC_LEN - (ehi)->desc_len, \
905                                      fmt , ##args); \
906 } while (0)
907
908 #define ata_ehi_clear_desc(ehi) do { \
909         (ehi)->desc[0] = '\0'; \
910         (ehi)->desc_len = 0; \
911 } while (0)
912
913 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
914 {
915         if (ehi->flags & ATA_EHI_HOTPLUGGED)
916                 return;
917
918         ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
919         ehi->hotplug_timestamp = jiffies;
920
921         ehi->action |= ATA_EH_SOFTRESET;
922         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
923 }
924
925 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
926 {
927         __ata_ehi_hotplugged(ehi);
928         ehi->err_mask |= AC_ERR_ATA_BUS;
929 }
930
931 /*
932  * qc helpers
933  */
934 static inline int
935 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
936 {
937         if (sg == &qc->pad_sgent)
938                 return 1;
939         if (qc->pad_len)
940                 return 0;
941         if (((sg - qc->__sg) + 1) == qc->n_elem)
942                 return 1;
943         return 0;
944 }
945
946 static inline struct scatterlist *
947 ata_qc_first_sg(struct ata_queued_cmd *qc)
948 {
949         if (qc->n_elem)
950                 return qc->__sg;
951         if (qc->pad_len)
952                 return &qc->pad_sgent;
953         return NULL;
954 }
955
956 static inline struct scatterlist *
957 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
958 {
959         if (sg == &qc->pad_sgent)
960                 return NULL;
961         if (++sg - qc->__sg < qc->n_elem)
962                 return sg;
963         if (qc->pad_len)
964                 return &qc->pad_sgent;
965         return NULL;
966 }
967
968 #define ata_for_each_sg(sg, qc) \
969         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
970
971 static inline unsigned int ata_tag_valid(unsigned int tag)
972 {
973         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
974 }
975
976 static inline unsigned int ata_tag_internal(unsigned int tag)
977 {
978         return tag == ATA_MAX_QUEUE - 1;
979 }
980
981 /*
982  * device helpers
983  */
984 static inline unsigned int ata_class_enabled(unsigned int class)
985 {
986         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
987 }
988
989 static inline unsigned int ata_class_disabled(unsigned int class)
990 {
991         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
992 }
993
994 static inline unsigned int ata_class_absent(unsigned int class)
995 {
996         return !ata_class_enabled(class) && !ata_class_disabled(class);
997 }
998
999 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1000 {
1001         return ata_class_enabled(dev->class);
1002 }
1003
1004 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1005 {
1006         return ata_class_disabled(dev->class);
1007 }
1008
1009 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1010 {
1011         return ata_class_absent(dev->class);
1012 }
1013
1014 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1015 {
1016         return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1017 }
1018
1019 /*
1020  * port helpers
1021  */
1022 static inline int ata_port_max_devices(const struct ata_port *ap)
1023 {
1024         if (ap->flags & ATA_FLAG_SLAVE_POSS)
1025                 return 2;
1026         return 1;
1027 }
1028
1029
1030 static inline u8 ata_chk_status(struct ata_port *ap)
1031 {
1032         return ap->ops->check_status(ap);
1033 }
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
1154         ata_tf_init(qc->dev, &qc->tf);
1155
1156         /* init result_tf such that it indicates normal completion */
1157         qc->result_tf.command = ATA_DRDY;
1158         qc->result_tf.feature = 0;
1159 }
1160
1161 static inline int ata_try_flush_cache(const struct ata_device *dev)
1162 {
1163         return ata_id_wcache_enabled(dev->id) ||
1164                ata_id_has_flush(dev->id) ||
1165                ata_id_has_flush_ext(dev->id);
1166 }
1167
1168 static inline unsigned int ac_err_mask(u8 status)
1169 {
1170         if (status & (ATA_BUSY | ATA_DRQ))
1171                 return AC_ERR_HSM;
1172         if (status & (ATA_ERR | ATA_DF))
1173                 return AC_ERR_DEV;
1174         return 0;
1175 }
1176
1177 static inline unsigned int __ac_err_mask(u8 status)
1178 {
1179         unsigned int mask = ac_err_mask(status);
1180         if (mask == 0)
1181                 return AC_ERR_OTHER;
1182         return mask;
1183 }
1184
1185 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1186 {
1187         ap->pad_dma = 0;
1188         ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1189                                       &ap->pad_dma, GFP_KERNEL);
1190         return (ap->pad == NULL) ? -ENOMEM : 0;
1191 }
1192
1193 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1194 {
1195         dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1196 }
1197
1198 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1199 {
1200         return (struct ata_port *) &host->hostdata[0];
1201 }
1202
1203 #endif /* __LINUX_LIBATA_H__ */