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