4b4cf6cf4acca136f52e91245175c6aced5aeb01
[linux-2.6.git] / include / linux / libata.h
1 /*
2  *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
3  *  Copyright 2003-2005 Jeff Garzik
4  *
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2, or (at your option)
9  *  any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; see the file COPYING.  If not, write to
18  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19  *
20  *
21  *  libata documentation is available via 'make {ps|pdf}docs',
22  *  as Documentation/DocBook/libata.*
23  *
24  */
25
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
28
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <asm/io.h>
33 #include <linux/ata.h>
34 #include <linux/workqueue.h>
35
36 /*
37  * compile-time options
38  */
39 #undef ATA_DEBUG                /* debugging output */
40 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
41 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
42 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
43 #undef ATA_ENABLE_PATA          /* define to enable PATA support in some
44                                  * low-level drivers */
45 #undef ATAPI_ENABLE_DMADIR      /* enables ATAPI DMADIR bridge support */
46
47
48 /* note: prints function name for you */
49 #ifdef ATA_DEBUG
50 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
51 #ifdef ATA_VERBOSE_DEBUG
52 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
53 #else
54 #define VPRINTK(fmt, args...)
55 #endif  /* ATA_VERBOSE_DEBUG */
56 #else
57 #define DPRINTK(fmt, args...)
58 #define VPRINTK(fmt, args...)
59 #endif  /* ATA_DEBUG */
60
61 #ifdef ATA_NDEBUG
62 #define assert(expr)
63 #else
64 #define assert(expr) \
65         if(unlikely(!(expr))) {                                   \
66         printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \
67         #expr,__FILE__,__FUNCTION__,__LINE__);          \
68         }
69 #endif
70
71 /* defines only for the constants which don't work well as enums */
72 #define ATA_TAG_POISON          0xfafbfcfdU
73
74 /* move to PCI layer? */
75 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
76 {
77         return &pdev->dev;
78 }
79
80 enum {
81         /* various global constants */
82         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
83         ATA_MAX_PORTS           = 8,
84         ATA_DEF_QUEUE           = 1,
85         ATA_MAX_QUEUE           = 1,
86         ATA_MAX_SECTORS         = 200,  /* FIXME */
87         ATA_MAX_BUS             = 2,
88         ATA_DEF_BUSY_WAIT       = 10000,
89         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
90
91         ATA_SHT_EMULATED        = 1,
92         ATA_SHT_CMD_PER_LUN     = 1,
93         ATA_SHT_THIS_ID         = -1,
94         ATA_SHT_USE_CLUSTERING  = 1,
95
96         /* struct ata_device stuff */
97         ATA_DFLAG_LBA48         = (1 << 0), /* device supports LBA48 */
98         ATA_DFLAG_PIO           = (1 << 1), /* device currently in PIO mode */
99         ATA_DFLAG_LOCK_SECTORS  = (1 << 2), /* don't adjust max_sectors */
100         ATA_DFLAG_LBA           = (1 << 3), /* device supports LBA */
101         ATA_DFLAG_CDB_INTR      = (1 << 4), /* device asserts INTRQ when ready for CDB */
102
103         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
104         ATA_DEV_ATA             = 1,    /* ATA device */
105         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
106         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
107         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
108         ATA_DEV_NONE            = 5,    /* no device */
109
110         /* struct ata_port flags */
111         ATA_FLAG_SLAVE_POSS     = (1 << 1), /* host supports slave dev */
112                                             /* (doesn't imply presence) */
113         ATA_FLAG_PORT_DISABLED  = (1 << 2), /* port is disabled, ignore it */
114         ATA_FLAG_SATA           = (1 << 3),
115         ATA_FLAG_NO_LEGACY      = (1 << 4), /* no legacy mode check */
116         ATA_FLAG_SRST           = (1 << 5), /* use ATA SRST, not E.D.D. */
117         ATA_FLAG_MMIO           = (1 << 6), /* use MMIO, not PIO */
118         ATA_FLAG_SATA_RESET     = (1 << 7), /* use COMRESET */
119         ATA_FLAG_PIO_DMA        = (1 << 8), /* PIO cmds via DMA */
120         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
121                                              * doesn't handle PIO interrupts */
122
123         ATA_QCFLAG_ACTIVE       = (1 << 1), /* cmd not yet ack'd to scsi lyer */
124         ATA_QCFLAG_SG           = (1 << 3), /* have s/g table? */
125         ATA_QCFLAG_SINGLE       = (1 << 4), /* no s/g, just a single buffer */
126         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
127
128         /* various lengths of time */
129         ATA_TMOUT_EDD           = 5 * HZ,       /* hueristic */
130         ATA_TMOUT_PIO           = 30 * HZ,
131         ATA_TMOUT_BOOT          = 30 * HZ,      /* hueristic */
132         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* hueristic */
133         ATA_TMOUT_DATAOUT       = 30 * HZ,
134         ATA_TMOUT_DATAOUT_QUICK = 5 * HZ,
135
136         /* ATA bus states */
137         BUS_UNKNOWN             = 0,
138         BUS_DMA                 = 1,
139         BUS_IDLE                = 2,
140         BUS_NOINTR              = 3,
141         BUS_NODATA              = 4,
142         BUS_TIMER               = 5,
143         BUS_PIO                 = 6,
144         BUS_EDD                 = 7,
145         BUS_IDENTIFY            = 8,
146         BUS_PACKET              = 9,
147
148         /* SATA port states */
149         PORT_UNKNOWN            = 0,
150         PORT_ENABLED            = 1,
151         PORT_DISABLED           = 2,
152
153         /* encoding various smaller bitmaps into a single
154          * unsigned long bitmap
155          */
156         ATA_SHIFT_UDMA          = 0,
157         ATA_SHIFT_MWDMA         = 8,
158         ATA_SHIFT_PIO           = 11,
159
160         /* size of buffer to pad xfers ending on unaligned boundaries */
161         ATA_DMA_PAD_SZ          = 4,
162         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
163         
164         /* Masks for port functions */
165         ATA_PORT_PRIMARY        = (1 << 0),
166         ATA_PORT_SECONDARY      = (1 << 1),
167 };
168
169 enum hsm_task_states {
170         HSM_ST_UNKNOWN,         /* state unknown */
171         HSM_ST_IDLE,            /* no command on going */
172         HSM_ST_POLL,            /* same as HSM_ST, waits longer */
173         HSM_ST_TMOUT,           /* timeout */
174         HSM_ST,                 /* (waiting the device to) transfer data */
175         HSM_ST_LAST,            /* (waiting the device to) complete command */
176         HSM_ST_LAST_POLL,       /* same as HSM_ST_LAST, waits longer */
177         HSM_ST_ERR,             /* error */
178         HSM_ST_FIRST,           /* (waiting the device to)
179                                    write CDB or first data block */
180 };
181
182 enum ata_completion_errors {
183         AC_ERR_OTHER            = (1 << 0),
184         AC_ERR_DEV              = (1 << 1),
185         AC_ERR_ATA_BUS          = (1 << 2),
186         AC_ERR_HOST_BUS         = (1 << 3),
187 };
188
189 /* forward declarations */
190 struct scsi_device;
191 struct ata_port_operations;
192 struct ata_port;
193 struct ata_queued_cmd;
194
195 /* typedefs */
196 typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, unsigned int err_mask);
197
198 struct ata_ioports {
199         unsigned long           cmd_addr;
200         unsigned long           data_addr;
201         unsigned long           error_addr;
202         unsigned long           feature_addr;
203         unsigned long           nsect_addr;
204         unsigned long           lbal_addr;
205         unsigned long           lbam_addr;
206         unsigned long           lbah_addr;
207         unsigned long           device_addr;
208         unsigned long           status_addr;
209         unsigned long           command_addr;
210         unsigned long           altstatus_addr;
211         unsigned long           ctl_addr;
212         unsigned long           bmdma_addr;
213         unsigned long           scr_addr;
214 };
215
216 struct ata_probe_ent {
217         struct list_head        node;
218         struct device           *dev;
219         const struct ata_port_operations *port_ops;
220         Scsi_Host_Template      *sht;
221         struct ata_ioports      port[ATA_MAX_PORTS];
222         unsigned int            n_ports;
223         unsigned int            hard_port_no;
224         unsigned int            pio_mask;
225         unsigned int            mwdma_mask;
226         unsigned int            udma_mask;
227         unsigned int            legacy_mode;
228         unsigned long           irq;
229         unsigned int            irq_flags;
230         unsigned long           host_flags;
231         void __iomem            *mmio_base;
232         void                    *private_data;
233 };
234
235 struct ata_host_set {
236         spinlock_t              lock;
237         struct device           *dev;
238         unsigned long           irq;
239         void __iomem            *mmio_base;
240         unsigned int            n_ports;
241         void                    *private_data;
242         const struct ata_port_operations *ops;
243         struct ata_port *       ports[0];
244 };
245
246 struct ata_queued_cmd {
247         struct ata_port         *ap;
248         struct ata_device       *dev;
249
250         struct scsi_cmnd        *scsicmd;
251         void                    (*scsidone)(struct scsi_cmnd *);
252
253         struct ata_taskfile     tf;
254         u8                      cdb[ATAPI_CDB_LEN];
255
256         unsigned long           flags;          /* ATA_QCFLAG_xxx */
257         unsigned int            tag;
258         unsigned int            n_elem;
259         unsigned int            orig_n_elem;
260
261         int                     dma_dir;
262
263         unsigned int            pad_len;
264
265         unsigned int            nsect;
266         unsigned int            cursect;
267
268         unsigned int            nbytes;
269         unsigned int            curbytes;
270
271         unsigned int            cursg;
272         unsigned int            cursg_ofs;
273
274         struct scatterlist      sgent;
275         struct scatterlist      pad_sgent;
276         void                    *buf_virt;
277
278         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
279         struct scatterlist      *__sg;
280
281         ata_qc_cb_t             complete_fn;
282
283         struct completion       *waiting;
284
285         void                    *private_data;
286 };
287
288 struct ata_host_stats {
289         unsigned long           unhandled_irq;
290         unsigned long           idle_irq;
291         unsigned long           rw_reqbuf;
292 };
293
294 struct ata_device {
295         u64                     n_sectors;      /* size of device, if ATA */
296         unsigned long           flags;          /* ATA_DFLAG_xxx */
297         unsigned int            class;          /* ATA_DEV_xxx */
298         unsigned int            devno;          /* 0 or 1 */
299         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
300         u8                      pio_mode;
301         u8                      dma_mode;
302         u8                      xfer_mode;
303         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
304
305         unsigned int            multi_count;    /* sectors count for
306                                                    READ/WRITE MULTIPLE */
307
308         /* for CHS addressing */
309         u16                     cylinders;      /* Number of cylinders */
310         u16                     heads;          /* Number of heads */
311         u16                     sectors;        /* Number of sectors per track */
312 };
313
314 struct ata_port {
315         struct Scsi_Host        *host;  /* our co-allocated scsi host */
316         const struct ata_port_operations *ops;
317         unsigned long           flags;  /* ATA_FLAG_xxx */
318         unsigned int            id;     /* unique id req'd by scsi midlyr */
319         unsigned int            port_no; /* unique port #; from zero */
320         unsigned int            hard_port_no;   /* hardware port #; from zero */
321
322         struct ata_prd          *prd;    /* our SG list */
323         dma_addr_t              prd_dma; /* and its DMA mapping */
324
325         void                    *pad;   /* array of DMA pad buffers */
326         dma_addr_t              pad_dma;
327
328         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
329
330         u8                      ctl;    /* cache of ATA control register */
331         u8                      last_ctl;       /* Cache last written value */
332         unsigned int            bus_state;
333         unsigned int            port_state;
334         unsigned int            pio_mask;
335         unsigned int            mwdma_mask;
336         unsigned int            udma_mask;
337         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
338         unsigned int            cdb_len;
339
340         struct ata_device       device[ATA_MAX_DEVICES];
341
342         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
343         unsigned long           qactive;
344         unsigned int            active_tag;
345
346         struct ata_host_stats   stats;
347         struct ata_host_set     *host_set;
348
349         struct work_struct      dataout_task;
350
351         struct work_struct      pio_task;
352         unsigned int            hsm_task_state;
353         unsigned long           pio_task_timeout;
354
355         void                    *private_data;
356 };
357
358 struct ata_port_operations {
359         void (*port_disable) (struct ata_port *);
360
361         void (*dev_config) (struct ata_port *, struct ata_device *);
362
363         void (*set_piomode) (struct ata_port *, struct ata_device *);
364         void (*set_dmamode) (struct ata_port *, struct ata_device *);
365
366         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
367         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
368
369         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
370         u8   (*check_status)(struct ata_port *ap);
371         u8   (*check_altstatus)(struct ata_port *ap);
372         void (*dev_select)(struct ata_port *ap, unsigned int device);
373
374         void (*phy_reset) (struct ata_port *ap);
375         void (*post_set_mode) (struct ata_port *ap);
376
377         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
378
379         void (*bmdma_setup) (struct ata_queued_cmd *qc);
380         void (*bmdma_start) (struct ata_queued_cmd *qc);
381
382         void (*qc_prep) (struct ata_queued_cmd *qc);
383         int (*qc_issue) (struct ata_queued_cmd *qc);
384
385         void (*eng_timeout) (struct ata_port *ap);
386
387         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
388         void (*irq_clear) (struct ata_port *);
389
390         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
391         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
392                            u32 val);
393
394         int (*port_start) (struct ata_port *ap);
395         void (*port_stop) (struct ata_port *ap);
396
397         void (*host_stop) (struct ata_host_set *host_set);
398
399         void (*bmdma_stop) (struct ata_queued_cmd *qc);
400         u8   (*bmdma_status) (struct ata_port *ap);
401 };
402
403 struct ata_port_info {
404         Scsi_Host_Template      *sht;
405         unsigned long           host_flags;
406         unsigned long           pio_mask;
407         unsigned long           mwdma_mask;
408         unsigned long           udma_mask;
409         const struct ata_port_operations *port_ops;
410 };
411
412 struct ata_timing {
413         unsigned short mode;            /* ATA mode */
414         unsigned short setup;           /* t1 */
415         unsigned short act8b;           /* t2 for 8-bit I/O */
416         unsigned short rec8b;           /* t2i for 8-bit I/O */
417         unsigned short cyc8b;           /* t0 for 8-bit I/O */
418         unsigned short active;          /* t2 or tD */
419         unsigned short recover;         /* t2i or tK */
420         unsigned short cycle;           /* t0 */
421         unsigned short udma;            /* t2CYCTYP/2 */
422 };
423
424 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
425
426 extern void ata_port_probe(struct ata_port *);
427 extern void __sata_phy_reset(struct ata_port *ap);
428 extern void sata_phy_reset(struct ata_port *ap);
429 extern void ata_bus_reset(struct ata_port *ap);
430 extern void ata_port_disable(struct ata_port *);
431 extern void ata_std_ports(struct ata_ioports *ioaddr);
432 #ifdef CONFIG_PCI
433 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
434                              unsigned int n_ports);
435 extern void ata_pci_remove_one (struct pci_dev *pdev);
436 #endif /* CONFIG_PCI */
437 extern int ata_device_add(const struct ata_probe_ent *ent);
438 extern void ata_host_set_remove(struct ata_host_set *host_set);
439 extern int ata_scsi_detect(Scsi_Host_Template *sht);
440 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
441 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
442 extern int ata_scsi_error(struct Scsi_Host *host);
443 extern int ata_scsi_release(struct Scsi_Host *host);
444 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
445 extern int ata_ratelimit(void);
446
447 /*
448  * Default driver ops implementations
449  */
450 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
451 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
452 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
453 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
454 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
455 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
456 extern u8 ata_check_status(struct ata_port *ap);
457 extern u8 ata_altstatus(struct ata_port *ap);
458 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
459 extern int ata_port_start (struct ata_port *ap);
460 extern void ata_port_stop (struct ata_port *ap);
461 extern void ata_host_stop (struct ata_host_set *host_set);
462 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
463 extern void ata_qc_prep(struct ata_queued_cmd *qc);
464 extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
465 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
466                 unsigned int buflen);
467 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
468                  unsigned int n_elem);
469 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
470 extern void ata_dev_id_string(const u16 *id, unsigned char *s,
471                               unsigned int ofs, unsigned int len);
472 extern void ata_dev_config(struct ata_port *ap, unsigned int i);
473 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
474 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
475 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
476 extern u8   ata_bmdma_status(struct ata_port *ap);
477 extern void ata_bmdma_irq_clear(struct ata_port *ap);
478 extern void ata_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask);
479 extern void ata_eng_timeout(struct ata_port *ap);
480 extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
481                               void (*done)(struct scsi_cmnd *));
482 extern int ata_std_bios_param(struct scsi_device *sdev,
483                               struct block_device *bdev,
484                               sector_t capacity, int geom[]);
485 extern int ata_scsi_slave_config(struct scsi_device *sdev);
486
487 /*
488  * Timing helpers
489  */
490 extern int ata_timing_compute(struct ata_device *, unsigned short,
491                               struct ata_timing *, int, int);
492 extern void ata_timing_merge(const struct ata_timing *,
493                              const struct ata_timing *, struct ata_timing *,
494                              unsigned int);
495
496 enum {
497         ATA_TIMING_SETUP        = (1 << 0),
498         ATA_TIMING_ACT8B        = (1 << 1),
499         ATA_TIMING_REC8B        = (1 << 2),
500         ATA_TIMING_CYC8B        = (1 << 3),
501         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
502                                   ATA_TIMING_CYC8B,
503         ATA_TIMING_ACTIVE       = (1 << 4),
504         ATA_TIMING_RECOVER      = (1 << 5),
505         ATA_TIMING_CYCLE        = (1 << 6),
506         ATA_TIMING_UDMA         = (1 << 7),
507         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
508                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
509                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
510                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
511 };
512
513
514 #ifdef CONFIG_PCI
515 struct pci_bits {
516         unsigned int            reg;    /* PCI config register to read */
517         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
518         unsigned long           mask;
519         unsigned long           val;
520 };
521
522 extern void ata_pci_host_stop (struct ata_host_set *host_set);
523 extern struct ata_probe_ent *
524 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
525 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
526
527 #endif /* CONFIG_PCI */
528
529
530 static inline int
531 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
532 {
533         if (sg == &qc->pad_sgent)
534                 return 1;
535         if (qc->pad_len)
536                 return 0;
537         if (((sg - qc->__sg) + 1) == qc->n_elem)
538                 return 1;
539         return 0;
540 }
541
542 static inline struct scatterlist *
543 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
544 {
545         if (sg == &qc->pad_sgent)
546                 return NULL;
547         if (++sg - qc->__sg < qc->n_elem)
548                 return sg;
549         return qc->pad_len ? &qc->pad_sgent : NULL;
550 }
551
552 #define ata_for_each_sg(sg, qc) \
553         for (sg = qc->__sg; sg; sg = ata_qc_next_sg(sg, qc))
554
555 static inline unsigned int ata_tag_valid(unsigned int tag)
556 {
557         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
558 }
559
560 static inline unsigned int ata_dev_present(const struct ata_device *dev)
561 {
562         return ((dev->class == ATA_DEV_ATA) ||
563                 (dev->class == ATA_DEV_ATAPI));
564 }
565
566 static inline u8 ata_chk_status(struct ata_port *ap)
567 {
568         return ap->ops->check_status(ap);
569 }
570
571
572 /**
573  *      ata_pause - Flush writes and pause 400 nanoseconds.
574  *      @ap: Port to wait for.
575  *
576  *      LOCKING:
577  *      Inherited from caller.
578  */
579
580 static inline void ata_pause(struct ata_port *ap)
581 {
582         ata_altstatus(ap);
583         ndelay(400);
584 }
585
586
587 /**
588  *      ata_busy_wait - Wait for a port status register
589  *      @ap: Port to wait for.
590  *
591  *      Waits up to max*10 microseconds for the selected bits in the port's
592  *      status register to be cleared.
593  *      Returns final value of status register.
594  *
595  *      LOCKING:
596  *      Inherited from caller.
597  */
598
599 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
600                                unsigned int max)
601 {
602         u8 status;
603
604         do {
605                 udelay(10);
606                 status = ata_chk_status(ap);
607                 max--;
608         } while ((status & bits) && (max > 0));
609
610         return status;
611 }
612
613
614 /**
615  *      ata_wait_idle - Wait for a port to be idle.
616  *      @ap: Port to wait for.
617  *
618  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
619  *      Returns final value of status register.
620  *
621  *      LOCKING:
622  *      Inherited from caller.
623  */
624
625 static inline u8 ata_wait_idle(struct ata_port *ap)
626 {
627         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
628
629         if (status & (ATA_BUSY | ATA_DRQ)) {
630                 unsigned long l = ap->ioaddr.status_addr;
631                 printk(KERN_WARNING
632                        "ATA: abnormal status 0x%X on port 0x%lX\n",
633                        status, l);
634         }
635
636         return status;
637 }
638
639 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
640 {
641         qc->tf.ctl |= ATA_NIEN;
642 }
643
644 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
645                                                       unsigned int tag)
646 {
647         if (likely(ata_tag_valid(tag)))
648                 return &ap->qcmd[tag];
649         return NULL;
650 }
651
652 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
653 {
654         memset(tf, 0, sizeof(*tf));
655
656         tf->ctl = ap->ctl;
657         if (device == 0)
658                 tf->device = ATA_DEVICE_OBS;
659         else
660                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
661 }
662
663
664 /**
665  *      ata_irq_on - Enable interrupts on a port.
666  *      @ap: Port on which interrupts are enabled.
667  *
668  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
669  *      wait for idle, clear any pending interrupts.
670  *
671  *      LOCKING:
672  *      Inherited from caller.
673  */
674
675 static inline u8 ata_irq_on(struct ata_port *ap)
676 {
677         struct ata_ioports *ioaddr = &ap->ioaddr;
678         u8 tmp;
679
680         ap->ctl &= ~ATA_NIEN;
681         ap->last_ctl = ap->ctl;
682
683         if (ap->flags & ATA_FLAG_MMIO)
684                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
685         else
686                 outb(ap->ctl, ioaddr->ctl_addr);
687         tmp = ata_wait_idle(ap);
688
689         ap->ops->irq_clear(ap);
690
691         return tmp;
692 }
693
694
695 /**
696  *      ata_irq_ack - Acknowledge a device interrupt.
697  *      @ap: Port on which interrupts are enabled.
698  *
699  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
700  *      or BUSY+DRQ clear).  Obtain dma status and port status from
701  *      device.  Clear the interrupt.  Return port status.
702  *
703  *      LOCKING:
704  */
705
706 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
707 {
708         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
709         u8 host_stat, post_stat, status;
710
711         status = ata_busy_wait(ap, bits, 1000);
712         if (status & bits)
713                 DPRINTK("abnormal status 0x%X\n", status);
714
715         /* get controller status; clear intr, err bits */
716         if (ap->flags & ATA_FLAG_MMIO) {
717                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
718                 host_stat = readb(mmio + ATA_DMA_STATUS);
719                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
720                        mmio + ATA_DMA_STATUS);
721
722                 post_stat = readb(mmio + ATA_DMA_STATUS);
723         } else {
724                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
725                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
726                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
727
728                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
729         }
730
731         VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
732                 host_stat, post_stat, status);
733
734         return status;
735 }
736
737 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
738 {
739         return ap->ops->scr_read(ap, reg);
740 }
741
742 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
743 {
744         ap->ops->scr_write(ap, reg, val);
745 }
746
747 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
748                                    u32 val)
749 {
750         ap->ops->scr_write(ap, reg, val);
751         (void) ap->ops->scr_read(ap, reg);
752 }
753
754 static inline unsigned int sata_dev_present(struct ata_port *ap)
755 {
756         return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
757 }
758
759 static inline int ata_try_flush_cache(const struct ata_device *dev)
760 {
761         return ata_id_wcache_enabled(dev->id) ||
762                ata_id_has_flush(dev->id) ||
763                ata_id_has_flush_ext(dev->id);
764 }
765
766 static inline unsigned int ac_err_mask(u8 status)
767 {
768         if (status & ATA_BUSY)
769                 return AC_ERR_ATA_BUS;
770         if (status & (ATA_ERR | ATA_DF))
771                 return AC_ERR_DEV;
772         return 0;
773 }
774
775 static inline unsigned int __ac_err_mask(u8 status)
776 {
777         unsigned int mask = ac_err_mask(status);
778         if (mask == 0)
779                 return AC_ERR_OTHER;
780         return mask;
781 }
782
783 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
784 {
785         ap->pad_dma = 0;
786         ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
787                                      &ap->pad_dma, GFP_KERNEL);
788         return (ap->pad == NULL) ? -ENOMEM : 0;
789 }
790
791 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
792 {
793         dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
794 }
795
796 #endif /* __LINUX_LIBATA_H__ */