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