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