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