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