c2215469a101c3d02576af0e14d855ffc3878e9e
[sfrench/cifs-2.6.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/io.h>
34 #include <linux/ata.h>
35 #include <linux/workqueue.h>
36
37 /*
38  * compile-time options: to be removed as soon as all the drivers are
39  * converted to the new debugging mechanism
40  */
41 #undef ATA_DEBUG                /* debugging output */
42 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
43 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
44 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
45 #undef ATA_ENABLE_PATA          /* define to enable PATA support in some
46                                  * low-level drivers */
47 #undef ATAPI_ENABLE_DMADIR      /* enables ATAPI DMADIR bridge support */
48
49
50 /* note: prints function name for you */
51 #ifdef ATA_DEBUG
52 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
53 #ifdef ATA_VERBOSE_DEBUG
54 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
55 #else
56 #define VPRINTK(fmt, args...)
57 #endif  /* ATA_VERBOSE_DEBUG */
58 #else
59 #define DPRINTK(fmt, args...)
60 #define VPRINTK(fmt, args...)
61 #endif  /* ATA_DEBUG */
62
63 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64
65 /* NEW: debug levels */
66 #define HAVE_LIBATA_MSG 1
67
68 enum {
69         ATA_MSG_DRV     = 0x0001,
70         ATA_MSG_INFO    = 0x0002,
71         ATA_MSG_PROBE   = 0x0004,
72         ATA_MSG_WARN    = 0x0008,
73         ATA_MSG_MALLOC  = 0x0010,
74         ATA_MSG_CTL     = 0x0020,
75         ATA_MSG_INTR    = 0x0040,
76         ATA_MSG_ERR     = 0x0080,
77 };
78
79 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
80 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
81 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
82 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
83 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
84 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
85 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
86 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
87
88 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
89 {
90         if (dval < 0 || dval >= (sizeof(u32) * 8))
91                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
92         if (!dval)
93                 return 0;
94         return (1 << dval) - 1;
95 }
96
97 /* defines only for the constants which don't work well as enums */
98 #define ATA_TAG_POISON          0xfafbfcfdU
99
100 /* move to PCI layer? */
101 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
102 {
103         return &pdev->dev;
104 }
105
106 enum {
107         /* various global constants */
108         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
109         ATA_MAX_PORTS           = 8,
110         ATA_DEF_QUEUE           = 1,
111         ATA_MAX_QUEUE           = 1,
112         ATA_MAX_SECTORS         = 200,  /* FIXME */
113         ATA_MAX_SECTORS_LBA48   = 65535,
114         ATA_MAX_BUS             = 2,
115         ATA_DEF_BUSY_WAIT       = 10000,
116         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
117
118         ATA_SHT_EMULATED        = 1,
119         ATA_SHT_CMD_PER_LUN     = 1,
120         ATA_SHT_THIS_ID         = -1,
121         ATA_SHT_USE_CLUSTERING  = 1,
122
123         /* struct ata_device stuff */
124         ATA_DFLAG_LBA48         = (1 << 0), /* device supports LBA48 */
125         ATA_DFLAG_PIO           = (1 << 1), /* device currently in PIO mode */
126         ATA_DFLAG_LBA           = (1 << 2), /* device supports LBA */
127
128         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
129         ATA_DEV_ATA             = 1,    /* ATA device */
130         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
131         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
132         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
133         ATA_DEV_NONE            = 5,    /* no device */
134
135         /* struct ata_port flags */
136         ATA_FLAG_SLAVE_POSS     = (1 << 1), /* host supports slave dev */
137                                             /* (doesn't imply presence) */
138         ATA_FLAG_PORT_DISABLED  = (1 << 2), /* port is disabled, ignore it */
139         ATA_FLAG_SATA           = (1 << 3),
140         ATA_FLAG_NO_LEGACY      = (1 << 4), /* no legacy mode check */
141         ATA_FLAG_SRST           = (1 << 5), /* (obsolete) use ATA SRST, not E.D.D. */
142         ATA_FLAG_MMIO           = (1 << 6), /* use MMIO, not PIO */
143         ATA_FLAG_SATA_RESET     = (1 << 7), /* (obsolete) use COMRESET */
144         ATA_FLAG_PIO_DMA        = (1 << 8), /* PIO cmds via DMA */
145         ATA_FLAG_NOINTR         = (1 << 9), /* FIXME: Remove this once
146                                              * proper HSM is in place. */
147         ATA_FLAG_DEBUGMSG       = (1 << 10),
148         ATA_FLAG_NO_ATAPI       = (1 << 11), /* No ATAPI support */
149
150         ATA_FLAG_SUSPENDED      = (1 << 12), /* port is suspended */
151
152         ATA_FLAG_PIO_LBA48      = (1 << 13), /* Host DMA engine is LBA28 only */
153         ATA_FLAG_IRQ_MASK       = (1 << 14), /* Mask IRQ in PIO xfers */
154
155         ATA_FLAG_FLUSH_PORT_TASK = (1 << 15), /* Flush port task */
156         ATA_FLAG_IN_EH          = (1 << 16), /* EH in progress */
157
158         ATA_QCFLAG_ACTIVE       = (1 << 1), /* cmd not yet ack'd to scsi lyer */
159         ATA_QCFLAG_SG           = (1 << 3), /* have s/g table? */
160         ATA_QCFLAG_SINGLE       = (1 << 4), /* no s/g, just a single buffer */
161         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
162         ATA_QCFLAG_EH_SCHEDULED = (1 << 5), /* EH scheduled */
163
164         /* host set flags */
165         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host_set only */
166         
167         /* various lengths of time */
168         ATA_TMOUT_PIO           = 30 * HZ,
169         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
170         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
171         ATA_TMOUT_CDB           = 30 * HZ,
172         ATA_TMOUT_CDB_QUICK     = 5 * HZ,
173         ATA_TMOUT_INTERNAL      = 30 * HZ,
174         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
175
176         /* ATA bus states */
177         BUS_UNKNOWN             = 0,
178         BUS_DMA                 = 1,
179         BUS_IDLE                = 2,
180         BUS_NOINTR              = 3,
181         BUS_NODATA              = 4,
182         BUS_TIMER               = 5,
183         BUS_PIO                 = 6,
184         BUS_EDD                 = 7,
185         BUS_IDENTIFY            = 8,
186         BUS_PACKET              = 9,
187
188         /* SATA port states */
189         PORT_UNKNOWN            = 0,
190         PORT_ENABLED            = 1,
191         PORT_DISABLED           = 2,
192
193         /* encoding various smaller bitmaps into a single
194          * unsigned int bitmap
195          */
196         ATA_BITS_PIO            = 5,
197         ATA_BITS_MWDMA          = 3,
198         ATA_BITS_UDMA           = 8,
199
200         ATA_SHIFT_PIO           = 0,
201         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
202         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
203
204         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
205         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
206         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
207
208         /* size of buffer to pad xfers ending on unaligned boundaries */
209         ATA_DMA_PAD_SZ          = 4,
210         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
211         
212         /* Masks for port functions */
213         ATA_PORT_PRIMARY        = (1 << 0),
214         ATA_PORT_SECONDARY      = (1 << 1),
215 };
216
217 enum hsm_task_states {
218         HSM_ST_UNKNOWN,
219         HSM_ST_IDLE,
220         HSM_ST_POLL,
221         HSM_ST_TMOUT,
222         HSM_ST,
223         HSM_ST_LAST,
224         HSM_ST_LAST_POLL,
225         HSM_ST_ERR,
226 };
227
228 enum ata_completion_errors {
229         AC_ERR_DEV              = (1 << 0), /* device reported error */
230         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
231         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
232         AC_ERR_MEDIA            = (1 << 3), /* media error */
233         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
234         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
235         AC_ERR_SYSTEM           = (1 << 6), /* system error */
236         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
237         AC_ERR_OTHER            = (1 << 8), /* unknown */
238 };
239
240 /* forward declarations */
241 struct scsi_device;
242 struct ata_port_operations;
243 struct ata_port;
244 struct ata_queued_cmd;
245
246 /* typedefs */
247 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
248 typedef void (*ata_probeinit_fn_t)(struct ata_port *);
249 typedef int (*ata_reset_fn_t)(struct ata_port *, int, unsigned int *);
250 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
251
252 struct ata_ioports {
253         unsigned long           cmd_addr;
254         unsigned long           data_addr;
255         unsigned long           error_addr;
256         unsigned long           feature_addr;
257         unsigned long           nsect_addr;
258         unsigned long           lbal_addr;
259         unsigned long           lbam_addr;
260         unsigned long           lbah_addr;
261         unsigned long           device_addr;
262         unsigned long           status_addr;
263         unsigned long           command_addr;
264         unsigned long           altstatus_addr;
265         unsigned long           ctl_addr;
266         unsigned long           bmdma_addr;
267         unsigned long           scr_addr;
268 };
269
270 struct ata_probe_ent {
271         struct list_head        node;
272         struct device           *dev;
273         const struct ata_port_operations *port_ops;
274         struct scsi_host_template *sht;
275         struct ata_ioports      port[ATA_MAX_PORTS];
276         unsigned int            n_ports;
277         unsigned int            hard_port_no;
278         unsigned int            pio_mask;
279         unsigned int            mwdma_mask;
280         unsigned int            udma_mask;
281         unsigned int            legacy_mode;
282         unsigned long           irq;
283         unsigned int            irq_flags;
284         unsigned long           host_flags;
285         unsigned long           host_set_flags;
286         void __iomem            *mmio_base;
287         void                    *private_data;
288 };
289
290 struct ata_host_set {
291         spinlock_t              lock;
292         struct device           *dev;
293         unsigned long           irq;
294         void __iomem            *mmio_base;
295         unsigned int            n_ports;
296         void                    *private_data;
297         const struct ata_port_operations *ops;
298         unsigned long           flags;
299         int                     simplex_claimed;        /* Keep seperate in case we
300                                                            ever need to do this locked */
301         struct ata_port *       ports[0];
302 };
303
304 struct ata_queued_cmd {
305         struct ata_port         *ap;
306         struct ata_device       *dev;
307
308         struct scsi_cmnd        *scsicmd;
309         void                    (*scsidone)(struct scsi_cmnd *);
310
311         struct ata_taskfile     tf;
312         u8                      cdb[ATAPI_CDB_LEN];
313
314         unsigned long           flags;          /* ATA_QCFLAG_xxx */
315         unsigned int            tag;
316         unsigned int            n_elem;
317         unsigned int            orig_n_elem;
318
319         int                     dma_dir;
320
321         unsigned int            pad_len;
322
323         unsigned int            nsect;
324         unsigned int            cursect;
325
326         unsigned int            nbytes;
327         unsigned int            curbytes;
328
329         unsigned int            cursg;
330         unsigned int            cursg_ofs;
331
332         struct scatterlist      sgent;
333         struct scatterlist      pad_sgent;
334         void                    *buf_virt;
335
336         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
337         struct scatterlist      *__sg;
338
339         unsigned int            err_mask;
340
341         ata_qc_cb_t             complete_fn;
342
343         void                    *private_data;
344 };
345
346 struct ata_host_stats {
347         unsigned long           unhandled_irq;
348         unsigned long           idle_irq;
349         unsigned long           rw_reqbuf;
350 };
351
352 struct ata_device {
353         u64                     n_sectors;      /* size of device, if ATA */
354         unsigned long           flags;          /* ATA_DFLAG_xxx */
355         unsigned int            class;          /* ATA_DEV_xxx */
356         unsigned int            devno;          /* 0 or 1 */
357         u16                     *id;            /* IDENTIFY xxx DEVICE data */
358         u8                      pio_mode;
359         u8                      dma_mode;
360         u8                      xfer_mode;
361         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
362
363         unsigned int            multi_count;    /* sectors count for
364                                                    READ/WRITE MULTIPLE */
365         unsigned int            max_sectors;    /* per-device max sectors */
366         unsigned int            cdb_len;
367
368         /* per-dev xfer mask */
369         unsigned int            pio_mask;
370         unsigned int            mwdma_mask;
371         unsigned int            udma_mask;
372
373         /* for CHS addressing */
374         u16                     cylinders;      /* Number of cylinders */
375         u16                     heads;          /* Number of heads */
376         u16                     sectors;        /* Number of sectors per track */
377 };
378
379 struct ata_port {
380         struct Scsi_Host        *host;  /* our co-allocated scsi host */
381         const struct ata_port_operations *ops;
382         unsigned long           flags;  /* ATA_FLAG_xxx */
383         unsigned int            id;     /* unique id req'd by scsi midlyr */
384         unsigned int            port_no; /* unique port #; from zero */
385         unsigned int            hard_port_no;   /* hardware port #; from zero */
386
387         struct ata_prd          *prd;    /* our SG list */
388         dma_addr_t              prd_dma; /* and its DMA mapping */
389
390         void                    *pad;   /* array of DMA pad buffers */
391         dma_addr_t              pad_dma;
392
393         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
394
395         u8                      ctl;    /* cache of ATA control register */
396         u8                      last_ctl;       /* Cache last written value */
397         unsigned int            pio_mask;
398         unsigned int            mwdma_mask;
399         unsigned int            udma_mask;
400         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
401
402         struct ata_device       device[ATA_MAX_DEVICES];
403
404         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
405         unsigned long           qactive;
406         unsigned int            active_tag;
407
408         struct ata_host_stats   stats;
409         struct ata_host_set     *host_set;
410         struct device           *dev;
411
412         struct work_struct      port_task;
413
414         unsigned int            hsm_task_state;
415         unsigned long           pio_task_timeout;
416
417         u32                     msg_enable;
418         struct list_head        eh_done_q;
419
420         void                    *private_data;
421 };
422
423 struct ata_port_operations {
424         void (*port_disable) (struct ata_port *);
425
426         void (*dev_config) (struct ata_port *, struct ata_device *);
427
428         void (*set_piomode) (struct ata_port *, struct ata_device *);
429         void (*set_dmamode) (struct ata_port *, struct ata_device *);
430         unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
431
432         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
433         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
434
435         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
436         u8   (*check_status)(struct ata_port *ap);
437         u8   (*check_altstatus)(struct ata_port *ap);
438         void (*dev_select)(struct ata_port *ap, unsigned int device);
439
440         void (*phy_reset) (struct ata_port *ap); /* obsolete */
441         void (*set_mode) (struct ata_port *ap);
442         int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
443
444         void (*post_set_mode) (struct ata_port *ap);
445
446         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
447
448         void (*bmdma_setup) (struct ata_queued_cmd *qc);
449         void (*bmdma_start) (struct ata_queued_cmd *qc);
450
451         void (*qc_prep) (struct ata_queued_cmd *qc);
452         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
453
454         void (*eng_timeout) (struct ata_port *ap);
455
456         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
457         void (*irq_clear) (struct ata_port *);
458
459         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
460         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
461                            u32 val);
462
463         int (*port_start) (struct ata_port *ap);
464         void (*port_stop) (struct ata_port *ap);
465
466         void (*host_stop) (struct ata_host_set *host_set);
467
468         void (*bmdma_stop) (struct ata_queued_cmd *qc);
469         u8   (*bmdma_status) (struct ata_port *ap);
470 };
471
472 struct ata_port_info {
473         struct scsi_host_template       *sht;
474         unsigned long           host_flags;
475         unsigned long           pio_mask;
476         unsigned long           mwdma_mask;
477         unsigned long           udma_mask;
478         const struct ata_port_operations *port_ops;
479         void                    *private_data;
480 };
481
482 struct ata_timing {
483         unsigned short mode;            /* ATA mode */
484         unsigned short setup;           /* t1 */
485         unsigned short act8b;           /* t2 for 8-bit I/O */
486         unsigned short rec8b;           /* t2i for 8-bit I/O */
487         unsigned short cyc8b;           /* t0 for 8-bit I/O */
488         unsigned short active;          /* t2 or tD */
489         unsigned short recover;         /* t2i or tK */
490         unsigned short cycle;           /* t0 */
491         unsigned short udma;            /* t2CYCTYP/2 */
492 };
493
494 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
495
496 extern void ata_port_probe(struct ata_port *);
497 extern void __sata_phy_reset(struct ata_port *ap);
498 extern void sata_phy_reset(struct ata_port *ap);
499 extern void ata_bus_reset(struct ata_port *ap);
500 extern int ata_drive_probe_reset(struct ata_port *ap,
501                         ata_probeinit_fn_t probeinit,
502                         ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
503                         ata_postreset_fn_t postreset, unsigned int *classes);
504 extern void ata_std_probeinit(struct ata_port *ap);
505 extern int ata_std_softreset(struct ata_port *ap, int verbose,
506                              unsigned int *classes);
507 extern int sata_std_hardreset(struct ata_port *ap, int verbose,
508                               unsigned int *class);
509 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
510 extern int ata_dev_revalidate(struct ata_port *ap, struct ata_device *dev,
511                               int post_reset);
512 extern void ata_port_disable(struct ata_port *);
513 extern void ata_std_ports(struct ata_ioports *ioaddr);
514 #ifdef CONFIG_PCI
515 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
516                              unsigned int n_ports);
517 extern void ata_pci_remove_one (struct pci_dev *pdev);
518 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
519 extern int ata_pci_device_resume(struct pci_dev *pdev);
520 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
521 #endif /* CONFIG_PCI */
522 extern int ata_device_add(const struct ata_probe_ent *ent);
523 extern void ata_host_set_remove(struct ata_host_set *host_set);
524 extern int ata_scsi_detect(struct scsi_host_template *sht);
525 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
526 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
527 extern int ata_scsi_error(struct Scsi_Host *host);
528 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
529 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
530 extern int ata_scsi_release(struct Scsi_Host *host);
531 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
532 extern int ata_scsi_device_resume(struct scsi_device *);
533 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
534 extern int ata_device_resume(struct ata_port *, struct ata_device *);
535 extern int ata_device_suspend(struct ata_port *, struct ata_device *, pm_message_t state);
536 extern int ata_ratelimit(void);
537 extern unsigned int ata_busy_sleep(struct ata_port *ap,
538                                    unsigned long timeout_pat,
539                                    unsigned long timeout);
540 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
541                                 void *data, unsigned long delay);
542
543 /*
544  * Default driver ops implementations
545  */
546 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
547 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
548 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
549 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
550 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
551 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
552 extern u8 ata_check_status(struct ata_port *ap);
553 extern u8 ata_altstatus(struct ata_port *ap);
554 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
555 extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
556 extern int ata_port_start (struct ata_port *ap);
557 extern void ata_port_stop (struct ata_port *ap);
558 extern void ata_host_stop (struct ata_host_set *host_set);
559 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
560 extern void ata_qc_prep(struct ata_queued_cmd *qc);
561 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
562 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
563 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
564                 unsigned int buflen);
565 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
566                  unsigned int n_elem);
567 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
568 extern void ata_id_string(const u16 *id, unsigned char *s,
569                           unsigned int ofs, unsigned int len);
570 extern void ata_id_c_string(const u16 *id, unsigned char *s,
571                             unsigned int ofs, unsigned int len);
572 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
573 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
574 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
575 extern u8   ata_bmdma_status(struct ata_port *ap);
576 extern void ata_bmdma_irq_clear(struct ata_port *ap);
577 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
578 extern void ata_eng_timeout(struct ata_port *ap);
579 extern void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
580                               struct scsi_cmnd *cmd,
581                               void (*done)(struct scsi_cmnd *));
582 extern int ata_std_bios_param(struct scsi_device *sdev,
583                               struct block_device *bdev,
584                               sector_t capacity, int geom[]);
585 extern int ata_scsi_slave_config(struct scsi_device *sdev);
586 extern struct ata_device *ata_dev_pair(struct ata_port *ap, 
587                                        struct ata_device *adev);
588
589 /*
590  * Timing helpers
591  */
592
593 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
594 extern int ata_timing_compute(struct ata_device *, unsigned short,
595                               struct ata_timing *, int, int);
596 extern void ata_timing_merge(const struct ata_timing *,
597                              const struct ata_timing *, struct ata_timing *,
598                              unsigned int);
599
600 enum {
601         ATA_TIMING_SETUP        = (1 << 0),
602         ATA_TIMING_ACT8B        = (1 << 1),
603         ATA_TIMING_REC8B        = (1 << 2),
604         ATA_TIMING_CYC8B        = (1 << 3),
605         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
606                                   ATA_TIMING_CYC8B,
607         ATA_TIMING_ACTIVE       = (1 << 4),
608         ATA_TIMING_RECOVER      = (1 << 5),
609         ATA_TIMING_CYCLE        = (1 << 6),
610         ATA_TIMING_UDMA         = (1 << 7),
611         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
612                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
613                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
614                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
615 };
616
617
618 #ifdef CONFIG_PCI
619 struct pci_bits {
620         unsigned int            reg;    /* PCI config register to read */
621         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
622         unsigned long           mask;
623         unsigned long           val;
624 };
625
626 extern void ata_pci_host_stop (struct ata_host_set *host_set);
627 extern struct ata_probe_ent *
628 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
629 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
630 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
631 #endif /* CONFIG_PCI */
632
633
634 static inline int
635 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
636 {
637         if (sg == &qc->pad_sgent)
638                 return 1;
639         if (qc->pad_len)
640                 return 0;
641         if (((sg - qc->__sg) + 1) == qc->n_elem)
642                 return 1;
643         return 0;
644 }
645
646 static inline struct scatterlist *
647 ata_qc_first_sg(struct ata_queued_cmd *qc)
648 {
649         if (qc->n_elem)
650                 return qc->__sg;
651         if (qc->pad_len)
652                 return &qc->pad_sgent;
653         return NULL;
654 }
655
656 static inline struct scatterlist *
657 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
658 {
659         if (sg == &qc->pad_sgent)
660                 return NULL;
661         if (++sg - qc->__sg < qc->n_elem)
662                 return sg;
663         if (qc->pad_len)
664                 return &qc->pad_sgent;
665         return NULL;
666 }
667
668 #define ata_for_each_sg(sg, qc) \
669         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
670
671 static inline unsigned int ata_tag_valid(unsigned int tag)
672 {
673         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
674 }
675
676 static inline unsigned int ata_class_present(unsigned int class)
677 {
678         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
679 }
680
681 static inline unsigned int ata_dev_present(const struct ata_device *dev)
682 {
683         return ata_class_present(dev->class);
684 }
685
686 static inline u8 ata_chk_status(struct ata_port *ap)
687 {
688         return ap->ops->check_status(ap);
689 }
690
691
692 /**
693  *      ata_pause - Flush writes and pause 400 nanoseconds.
694  *      @ap: Port to wait for.
695  *
696  *      LOCKING:
697  *      Inherited from caller.
698  */
699
700 static inline void ata_pause(struct ata_port *ap)
701 {
702         ata_altstatus(ap);
703         ndelay(400);
704 }
705
706
707 /**
708  *      ata_busy_wait - Wait for a port status register
709  *      @ap: Port to wait for.
710  *
711  *      Waits up to max*10 microseconds for the selected bits in the port's
712  *      status register to be cleared.
713  *      Returns final value of status register.
714  *
715  *      LOCKING:
716  *      Inherited from caller.
717  */
718
719 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
720                                unsigned int max)
721 {
722         u8 status;
723
724         do {
725                 udelay(10);
726                 status = ata_chk_status(ap);
727                 max--;
728         } while ((status & bits) && (max > 0));
729
730         return status;
731 }
732
733
734 /**
735  *      ata_wait_idle - Wait for a port to be idle.
736  *      @ap: Port to wait for.
737  *
738  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
739  *      Returns final value of status register.
740  *
741  *      LOCKING:
742  *      Inherited from caller.
743  */
744
745 static inline u8 ata_wait_idle(struct ata_port *ap)
746 {
747         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
748
749         if (status & (ATA_BUSY | ATA_DRQ)) {
750                 unsigned long l = ap->ioaddr.status_addr;
751                 if (ata_msg_warn(ap))
752                         printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
753                                 status, l);
754         }
755
756         return status;
757 }
758
759 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
760 {
761         qc->tf.ctl |= ATA_NIEN;
762 }
763
764 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
765                                                       unsigned int tag)
766 {
767         if (likely(ata_tag_valid(tag)))
768                 return &ap->qcmd[tag];
769         return NULL;
770 }
771
772 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
773 {
774         memset(tf, 0, sizeof(*tf));
775
776         tf->ctl = ap->ctl;
777         if (device == 0)
778                 tf->device = ATA_DEVICE_OBS;
779         else
780                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
781 }
782
783 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
784 {
785         qc->__sg = NULL;
786         qc->flags = 0;
787         qc->cursect = qc->cursg = qc->cursg_ofs = 0;
788         qc->nsect = 0;
789         qc->nbytes = qc->curbytes = 0;
790         qc->err_mask = 0;
791
792         ata_tf_init(qc->ap, &qc->tf, qc->dev->devno);
793 }
794
795 /**
796  *      ata_qc_complete - Complete an active ATA command
797  *      @qc: Command to complete
798  *      @err_mask: ATA Status register contents
799  *
800  *      Indicate to the mid and upper layers that an ATA
801  *      command has completed, with either an ok or not-ok status.
802  *
803  *      LOCKING:
804  *      spin_lock_irqsave(host_set lock)
805  */
806 static inline void ata_qc_complete(struct ata_queued_cmd *qc)
807 {
808         if (unlikely(qc->flags & ATA_QCFLAG_EH_SCHEDULED))
809                 return;
810
811         __ata_qc_complete(qc);
812 }
813
814 /**
815  *      ata_irq_on - Enable interrupts on a port.
816  *      @ap: Port on which interrupts are enabled.
817  *
818  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
819  *      wait for idle, clear any pending interrupts.
820  *
821  *      LOCKING:
822  *      Inherited from caller.
823  */
824
825 static inline u8 ata_irq_on(struct ata_port *ap)
826 {
827         struct ata_ioports *ioaddr = &ap->ioaddr;
828         u8 tmp;
829
830         ap->ctl &= ~ATA_NIEN;
831         ap->last_ctl = ap->ctl;
832
833         if (ap->flags & ATA_FLAG_MMIO)
834                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
835         else
836                 outb(ap->ctl, ioaddr->ctl_addr);
837         tmp = ata_wait_idle(ap);
838
839         ap->ops->irq_clear(ap);
840
841         return tmp;
842 }
843
844
845 /**
846  *      ata_irq_ack - Acknowledge a device interrupt.
847  *      @ap: Port on which interrupts are enabled.
848  *
849  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
850  *      or BUSY+DRQ clear).  Obtain dma status and port status from
851  *      device.  Clear the interrupt.  Return port status.
852  *
853  *      LOCKING:
854  */
855
856 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
857 {
858         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
859         u8 host_stat, post_stat, status;
860
861         status = ata_busy_wait(ap, bits, 1000);
862         if (status & bits)
863                 if (ata_msg_err(ap))
864                         printk(KERN_ERR "abnormal status 0x%X\n", status);
865
866         /* get controller status; clear intr, err bits */
867         if (ap->flags & ATA_FLAG_MMIO) {
868                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
869                 host_stat = readb(mmio + ATA_DMA_STATUS);
870                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
871                        mmio + ATA_DMA_STATUS);
872
873                 post_stat = readb(mmio + ATA_DMA_STATUS);
874         } else {
875                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
876                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
877                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
878
879                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
880         }
881
882         if (ata_msg_intr(ap))
883                 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
884                         __FUNCTION__,
885                         host_stat, post_stat, status);
886
887         return status;
888 }
889
890 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
891 {
892         return ap->ops->scr_read(ap, reg);
893 }
894
895 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
896 {
897         ap->ops->scr_write(ap, reg, val);
898 }
899
900 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
901                                    u32 val)
902 {
903         ap->ops->scr_write(ap, reg, val);
904         (void) ap->ops->scr_read(ap, reg);
905 }
906
907 static inline unsigned int sata_dev_present(struct ata_port *ap)
908 {
909         return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
910 }
911
912 static inline int ata_try_flush_cache(const struct ata_device *dev)
913 {
914         return ata_id_wcache_enabled(dev->id) ||
915                ata_id_has_flush(dev->id) ||
916                ata_id_has_flush_ext(dev->id);
917 }
918
919 static inline unsigned int ac_err_mask(u8 status)
920 {
921         if (status & ATA_BUSY)
922                 return AC_ERR_HSM;
923         if (status & (ATA_ERR | ATA_DF))
924                 return AC_ERR_DEV;
925         return 0;
926 }
927
928 static inline unsigned int __ac_err_mask(u8 status)
929 {
930         unsigned int mask = ac_err_mask(status);
931         if (mask == 0)
932                 return AC_ERR_OTHER;
933         return mask;
934 }
935
936 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
937 {
938         ap->pad_dma = 0;
939         ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
940                                      &ap->pad_dma, GFP_KERNEL);
941         return (ap->pad == NULL) ? -ENOMEM : 0;
942 }
943
944 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
945 {
946         dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
947 }
948
949 #endif /* __LINUX_LIBATA_H__ */