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