7b2116ddd26a423f68e544f547fd9a595252eff7
[linux-3.10.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_ATAPI         /* define to enable ATAPI support */
44 #undef ATA_ENABLE_PATA          /* define to enable PATA support in some
45                                  * low-level drivers */
46 #undef ATAPI_ENABLE_DMADIR      /* enables ATAPI DMADIR bridge support */
47
48
49 /* note: prints function name for you */
50 #ifdef ATA_DEBUG
51 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
52 #ifdef ATA_VERBOSE_DEBUG
53 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
54 #else
55 #define VPRINTK(fmt, args...)
56 #endif  /* ATA_VERBOSE_DEBUG */
57 #else
58 #define DPRINTK(fmt, args...)
59 #define VPRINTK(fmt, args...)
60 #endif  /* ATA_DEBUG */
61
62 #ifdef ATA_NDEBUG
63 #define assert(expr)
64 #else
65 #define assert(expr) \
66         if(unlikely(!(expr))) {                                   \
67         printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \
68         #expr,__FILE__,__FUNCTION__,__LINE__);          \
69         }
70 #endif
71
72 /* defines only for the constants which don't work well as enums */
73 #define ATA_TAG_POISON          0xfafbfcfdU
74
75 /* move to PCI layer? */
76 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
77 {
78         return &pdev->dev;
79 }
80
81 enum {
82         /* various global constants */
83         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
84         ATA_MAX_PORTS           = 8,
85         ATA_DEF_QUEUE           = 1,
86         ATA_MAX_QUEUE           = 1,
87         ATA_MAX_SECTORS         = 200,  /* FIXME */
88         ATA_MAX_BUS             = 2,
89         ATA_DEF_BUSY_WAIT       = 10000,
90         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
91
92         ATA_SHT_EMULATED        = 1,
93         ATA_SHT_CMD_PER_LUN     = 1,
94         ATA_SHT_THIS_ID         = -1,
95         ATA_SHT_USE_CLUSTERING  = 0,
96
97         /* struct ata_device stuff */
98         ATA_DFLAG_LBA48         = (1 << 0), /* device supports LBA48 */
99         ATA_DFLAG_PIO           = (1 << 1), /* device currently in PIO mode */
100         ATA_DFLAG_LOCK_SECTORS  = (1 << 2), /* don't adjust max_sectors */
101         ATA_DFLAG_LBA           = (1 << 3), /* device supports LBA */
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_NOINTR         = (1 << 9), /* FIXME: Remove this once
121                                              * proper HSM is in place. */
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_CDB           = 30 * HZ,
134         ATA_TMOUT_CDB_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
161 enum pio_task_states {
162         PIO_ST_UNKNOWN,
163         PIO_ST_IDLE,
164         PIO_ST_POLL,
165         PIO_ST_TMOUT,
166         PIO_ST,
167         PIO_ST_LAST,
168         PIO_ST_LAST_POLL,
169         PIO_ST_ERR,
170 };
171
172 /* forward declarations */
173 struct scsi_device;
174 struct ata_port_operations;
175 struct ata_port;
176 struct ata_queued_cmd;
177
178 /* typedefs */
179 typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, u8 drv_stat);
180
181 struct ata_ioports {
182         unsigned long           cmd_addr;
183         unsigned long           data_addr;
184         unsigned long           error_addr;
185         unsigned long           feature_addr;
186         unsigned long           nsect_addr;
187         unsigned long           lbal_addr;
188         unsigned long           lbam_addr;
189         unsigned long           lbah_addr;
190         unsigned long           device_addr;
191         unsigned long           status_addr;
192         unsigned long           command_addr;
193         unsigned long           altstatus_addr;
194         unsigned long           ctl_addr;
195         unsigned long           bmdma_addr;
196         unsigned long           scr_addr;
197 };
198
199 struct ata_probe_ent {
200         struct list_head        node;
201         struct device           *dev;
202         struct ata_port_operations      *port_ops;
203         Scsi_Host_Template      *sht;
204         struct ata_ioports      port[ATA_MAX_PORTS];
205         unsigned int            n_ports;
206         unsigned int            hard_port_no;
207         unsigned int            pio_mask;
208         unsigned int            mwdma_mask;
209         unsigned int            udma_mask;
210         unsigned int            legacy_mode;
211         unsigned long           irq;
212         unsigned int            irq_flags;
213         unsigned long           host_flags;
214         void __iomem            *mmio_base;
215         void                    *private_data;
216 };
217
218 struct ata_host_set {
219         spinlock_t              lock;
220         struct device           *dev;
221         unsigned long           irq;
222         void __iomem            *mmio_base;
223         unsigned int            n_ports;
224         void                    *private_data;
225         struct ata_port_operations *ops;
226         struct ata_port *       ports[0];
227 };
228
229 struct ata_queued_cmd {
230         struct ata_port         *ap;
231         struct ata_device       *dev;
232
233         struct scsi_cmnd        *scsicmd;
234         void                    (*scsidone)(struct scsi_cmnd *);
235
236         struct ata_taskfile     tf;
237         u8                      cdb[ATAPI_CDB_LEN];
238
239         unsigned long           flags;          /* ATA_QCFLAG_xxx */
240         unsigned int            tag;
241         unsigned int            n_elem;
242
243         int                     dma_dir;
244
245         unsigned int            nsect;
246         unsigned int            cursect;
247
248         unsigned int            nbytes;
249         unsigned int            curbytes;
250
251         unsigned int            cursg;
252         unsigned int            cursg_ofs;
253
254         struct scatterlist      sgent;
255         void                    *buf_virt;
256
257         struct scatterlist      *sg;
258
259         ata_qc_cb_t             complete_fn;
260
261         struct completion       *waiting;
262
263         void                    *private_data;
264 };
265
266 struct ata_host_stats {
267         unsigned long           unhandled_irq;
268         unsigned long           idle_irq;
269         unsigned long           rw_reqbuf;
270 };
271
272 struct ata_device {
273         u64                     n_sectors;      /* size of device, if ATA */
274         unsigned long           flags;          /* ATA_DFLAG_xxx */
275         unsigned int            class;          /* ATA_DEV_xxx */
276         unsigned int            devno;          /* 0 or 1 */
277         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
278         u8                      pio_mode;
279         u8                      dma_mode;
280         u8                      xfer_mode;
281         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
282
283         /* cache info about current transfer mode */
284         u8                      xfer_protocol;  /* taskfile xfer protocol */
285         u8                      read_cmd;       /* opcode to use on read */
286         u8                      write_cmd;      /* opcode to use on write */
287
288         /* for CHS addressing */
289         u16                     cylinders;      /* Number of cylinders */
290         u16                     heads;          /* Number of heads */
291         u16                     sectors;        /* Number of sectors per track */
292 };
293
294 struct ata_port {
295         struct Scsi_Host        *host;  /* our co-allocated scsi host */
296         struct ata_port_operations      *ops;
297         unsigned long           flags;  /* ATA_FLAG_xxx */
298         unsigned int            id;     /* unique id req'd by scsi midlyr */
299         unsigned int            port_no; /* unique port #; from zero */
300         unsigned int            hard_port_no;   /* hardware port #; from zero */
301
302         struct ata_prd          *prd;    /* our SG list */
303         dma_addr_t              prd_dma; /* and its DMA mapping */
304
305         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
306
307         u8                      ctl;    /* cache of ATA control register */
308         u8                      last_ctl;       /* Cache last written value */
309         unsigned int            bus_state;
310         unsigned int            port_state;
311         unsigned int            pio_mask;
312         unsigned int            mwdma_mask;
313         unsigned int            udma_mask;
314         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
315         unsigned int            cdb_len;
316
317         struct ata_device       device[ATA_MAX_DEVICES];
318
319         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
320         unsigned long           qactive;
321         unsigned int            active_tag;
322
323         struct ata_host_stats   stats;
324         struct ata_host_set     *host_set;
325
326         struct work_struct      packet_task;
327
328         struct work_struct      pio_task;
329         unsigned int            pio_task_state;
330         unsigned long           pio_task_timeout;
331
332         void                    *private_data;
333 };
334
335 struct ata_port_operations {
336         void (*port_disable) (struct ata_port *);
337
338         void (*dev_config) (struct ata_port *, struct ata_device *);
339
340         void (*set_piomode) (struct ata_port *, struct ata_device *);
341         void (*set_dmamode) (struct ata_port *, struct ata_device *);
342
343         void (*tf_load) (struct ata_port *ap, struct ata_taskfile *tf);
344         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
345
346         void (*exec_command)(struct ata_port *ap, struct ata_taskfile *tf);
347         u8   (*check_status)(struct ata_port *ap);
348         u8   (*check_altstatus)(struct ata_port *ap);
349         u8   (*check_err)(struct ata_port *ap);
350         void (*dev_select)(struct ata_port *ap, unsigned int device);
351
352         void (*phy_reset) (struct ata_port *ap);
353         void (*post_set_mode) (struct ata_port *ap);
354
355         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
356
357         void (*bmdma_setup) (struct ata_queued_cmd *qc);
358         void (*bmdma_start) (struct ata_queued_cmd *qc);
359
360         void (*qc_prep) (struct ata_queued_cmd *qc);
361         int (*qc_issue) (struct ata_queued_cmd *qc);
362
363         void (*eng_timeout) (struct ata_port *ap);
364
365         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
366         void (*irq_clear) (struct ata_port *);
367
368         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
369         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
370                            u32 val);
371
372         int (*port_start) (struct ata_port *ap);
373         void (*port_stop) (struct ata_port *ap);
374
375         void (*host_stop) (struct ata_host_set *host_set);
376
377         void (*bmdma_stop) (struct ata_queued_cmd *qc);
378         u8   (*bmdma_status) (struct ata_port *ap);
379 };
380
381 struct ata_port_info {
382         Scsi_Host_Template      *sht;
383         unsigned long           host_flags;
384         unsigned long           pio_mask;
385         unsigned long           mwdma_mask;
386         unsigned long           udma_mask;
387         struct ata_port_operations      *port_ops;
388 };
389
390
391 extern void ata_port_probe(struct ata_port *);
392 extern void __sata_phy_reset(struct ata_port *ap);
393 extern void sata_phy_reset(struct ata_port *ap);
394 extern void ata_bus_reset(struct ata_port *ap);
395 extern void ata_port_disable(struct ata_port *);
396 extern void ata_std_ports(struct ata_ioports *ioaddr);
397 #ifdef CONFIG_PCI
398 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
399                              unsigned int n_ports);
400 extern void ata_pci_remove_one (struct pci_dev *pdev);
401 #endif /* CONFIG_PCI */
402 extern int ata_device_add(struct ata_probe_ent *ent);
403 extern int ata_scsi_detect(Scsi_Host_Template *sht);
404 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
405 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
406 extern int ata_scsi_error(struct Scsi_Host *host);
407 extern int ata_scsi_release(struct Scsi_Host *host);
408 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
409 /*
410  * Default driver ops implementations
411  */
412 extern void ata_tf_load(struct ata_port *ap, struct ata_taskfile *tf);
413 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
414 extern void ata_tf_to_fis(struct ata_taskfile *tf, u8 *fis, u8 pmp);
415 extern void ata_tf_from_fis(u8 *fis, struct ata_taskfile *tf);
416 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
417 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
418 extern u8 ata_check_status(struct ata_port *ap);
419 extern u8 ata_altstatus(struct ata_port *ap);
420 extern u8 ata_chk_err(struct ata_port *ap);
421 extern void ata_exec_command(struct ata_port *ap, struct ata_taskfile *tf);
422 extern int ata_port_start (struct ata_port *ap);
423 extern void ata_port_stop (struct ata_port *ap);
424 extern void ata_host_stop (struct ata_host_set *host_set);
425 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
426 extern void ata_qc_prep(struct ata_queued_cmd *qc);
427 extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
428 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
429                 unsigned int buflen);
430 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
431                  unsigned int n_elem);
432 extern unsigned int ata_dev_classify(struct ata_taskfile *tf);
433 extern void ata_dev_id_string(u16 *id, unsigned char *s,
434                               unsigned int ofs, unsigned int len);
435 extern void ata_dev_config(struct ata_port *ap, unsigned int i);
436 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
437 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
438 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
439 extern u8   ata_bmdma_status(struct ata_port *ap);
440 extern void ata_bmdma_irq_clear(struct ata_port *ap);
441 extern void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat);
442 extern void ata_eng_timeout(struct ata_port *ap);
443 extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
444                               void (*done)(struct scsi_cmnd *));
445 extern int ata_std_bios_param(struct scsi_device *sdev,
446                               struct block_device *bdev,
447                               sector_t capacity, int geom[]);
448 extern int ata_scsi_slave_config(struct scsi_device *sdev);
449
450
451 #ifdef CONFIG_PCI
452 struct pci_bits {
453         unsigned int            reg;    /* PCI config register to read */
454         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
455         unsigned long           mask;
456         unsigned long           val;
457 };
458
459 extern struct ata_probe_ent *
460 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port);
461 extern int pci_test_config_bits(struct pci_dev *pdev, struct pci_bits *bits);
462
463 #endif /* CONFIG_PCI */
464
465
466 static inline unsigned int ata_tag_valid(unsigned int tag)
467 {
468         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
469 }
470
471 static inline unsigned int ata_dev_present(struct ata_device *dev)
472 {
473         return ((dev->class == ATA_DEV_ATA) ||
474                 (dev->class == ATA_DEV_ATAPI));
475 }
476
477 static inline u8 ata_chk_status(struct ata_port *ap)
478 {
479         return ap->ops->check_status(ap);
480 }
481
482
483 /**
484  *      ata_pause - Flush writes and pause 400 nanoseconds.
485  *      @ap: Port to wait for.
486  *
487  *      LOCKING:
488  *      Inherited from caller.
489  */
490
491 static inline void ata_pause(struct ata_port *ap)
492 {
493         ata_altstatus(ap);
494         ndelay(400);
495 }
496
497
498 /**
499  *      ata_busy_wait - Wait for a port status register
500  *      @ap: Port to wait for.
501  *
502  *      Waits up to max*10 microseconds for the selected bits in the port's
503  *      status register to be cleared.
504  *      Returns final value of status register.
505  *
506  *      LOCKING:
507  *      Inherited from caller.
508  */
509
510 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
511                                unsigned int max)
512 {
513         u8 status;
514
515         do {
516                 udelay(10);
517                 status = ata_chk_status(ap);
518                 max--;
519         } while ((status & bits) && (max > 0));
520
521         return status;
522 }
523
524
525 /**
526  *      ata_wait_idle - Wait for a port to be idle.
527  *      @ap: Port to wait for.
528  *
529  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
530  *      Returns final value of status register.
531  *
532  *      LOCKING:
533  *      Inherited from caller.
534  */
535
536 static inline u8 ata_wait_idle(struct ata_port *ap)
537 {
538         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
539
540         if (status & (ATA_BUSY | ATA_DRQ)) {
541                 unsigned long l = ap->ioaddr.status_addr;
542                 printk(KERN_WARNING
543                        "ATA: abnormal status 0x%X on port 0x%lX\n",
544                        status, l);
545         }
546
547         return status;
548 }
549
550 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
551 {
552         qc->tf.ctl |= ATA_NIEN;
553 }
554
555 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
556                                                       unsigned int tag)
557 {
558         if (likely(ata_tag_valid(tag)))
559                 return &ap->qcmd[tag];
560         return NULL;
561 }
562
563 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
564 {
565         memset(tf, 0, sizeof(*tf));
566
567         tf->ctl = ap->ctl;
568         if (device == 0)
569                 tf->device = ATA_DEVICE_OBS;
570         else
571                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
572 }
573
574
575 /**
576  *      ata_irq_on - Enable interrupts on a port.
577  *      @ap: Port on which interrupts are enabled.
578  *
579  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
580  *      wait for idle, clear any pending interrupts.
581  *
582  *      LOCKING:
583  *      Inherited from caller.
584  */
585
586 static inline u8 ata_irq_on(struct ata_port *ap)
587 {
588         struct ata_ioports *ioaddr = &ap->ioaddr;
589         u8 tmp;
590
591         ap->ctl &= ~ATA_NIEN;
592         ap->last_ctl = ap->ctl;
593
594         if (ap->flags & ATA_FLAG_MMIO)
595                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
596         else
597                 outb(ap->ctl, ioaddr->ctl_addr);
598         tmp = ata_wait_idle(ap);
599
600         ap->ops->irq_clear(ap);
601
602         return tmp;
603 }
604
605
606 /**
607  *      ata_irq_ack - Acknowledge a device interrupt.
608  *      @ap: Port on which interrupts are enabled.
609  *
610  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
611  *      or BUSY+DRQ clear).  Obtain dma status and port status from
612  *      device.  Clear the interrupt.  Return port status.
613  *
614  *      LOCKING:
615  */
616
617 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
618 {
619         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
620         u8 host_stat, post_stat, status;
621
622         status = ata_busy_wait(ap, bits, 1000);
623         if (status & bits)
624                 DPRINTK("abnormal status 0x%X\n", status);
625
626         /* get controller status; clear intr, err bits */
627         if (ap->flags & ATA_FLAG_MMIO) {
628                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
629                 host_stat = readb(mmio + ATA_DMA_STATUS);
630                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
631                        mmio + ATA_DMA_STATUS);
632
633                 post_stat = readb(mmio + ATA_DMA_STATUS);
634         } else {
635                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
636                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
637                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
638
639                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
640         }
641
642         VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
643                 host_stat, post_stat, status);
644
645         return status;
646 }
647
648 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
649 {
650         return ap->ops->scr_read(ap, reg);
651 }
652
653 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
654 {
655         ap->ops->scr_write(ap, reg, val);
656 }
657
658 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
659                                    u32 val)
660 {
661         ap->ops->scr_write(ap, reg, val);
662         (void) ap->ops->scr_read(ap, reg);
663 }
664
665 static inline unsigned int sata_dev_present(struct ata_port *ap)
666 {
667         return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
668 }
669
670 static inline int ata_try_flush_cache(struct ata_device *dev)
671 {
672         return ata_id_wcache_enabled(dev->id) ||
673                ata_id_has_flush(dev->id) ||
674                ata_id_has_flush_ext(dev->id);
675 }
676
677 #endif /* __LINUX_LIBATA_H__ */