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