Merge branch 'master'
[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         /* Masks for port functions */
161         ATA_PORT_PRIMARY        = (1 << 0),
162         ATA_PORT_SECONDARY      = (1 << 1),
163 };
164
165 enum hsm_task_states {
166         HSM_ST_UNKNOWN,         /* state unknown */
167         HSM_ST_IDLE,            /* no command on going */
168         HSM_ST_POLL,            /* same as HSM_ST, waits longer */
169         HSM_ST_TMOUT,           /* timeout */
170         HSM_ST,                 /* (waiting the device to) transfer data */
171         HSM_ST_LAST,            /* (waiting the device to) complete command */
172         HSM_ST_LAST_POLL,       /* same as HSM_ST_LAST, waits longer */
173         HSM_ST_ERR,             /* error */
174         HSM_ST_FIRST,           /* (waiting the device to)
175                                    write CDB or first data block */
176 };
177
178 enum ata_completion_errors {
179         AC_ERR_OTHER            = (1 << 0),
180         AC_ERR_DEV              = (1 << 1),
181         AC_ERR_ATA_BUS          = (1 << 2),
182         AC_ERR_HOST_BUS         = (1 << 3),
183 };
184
185 /* forward declarations */
186 struct scsi_device;
187 struct ata_port_operations;
188 struct ata_port;
189 struct ata_queued_cmd;
190
191 /* typedefs */
192 typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, unsigned int err_mask);
193
194 struct ata_ioports {
195         unsigned long           cmd_addr;
196         unsigned long           data_addr;
197         unsigned long           error_addr;
198         unsigned long           feature_addr;
199         unsigned long           nsect_addr;
200         unsigned long           lbal_addr;
201         unsigned long           lbam_addr;
202         unsigned long           lbah_addr;
203         unsigned long           device_addr;
204         unsigned long           status_addr;
205         unsigned long           command_addr;
206         unsigned long           altstatus_addr;
207         unsigned long           ctl_addr;
208         unsigned long           bmdma_addr;
209         unsigned long           scr_addr;
210 };
211
212 struct ata_probe_ent {
213         struct list_head        node;
214         struct device           *dev;
215         const struct ata_port_operations *port_ops;
216         Scsi_Host_Template      *sht;
217         struct ata_ioports      port[ATA_MAX_PORTS];
218         unsigned int            n_ports;
219         unsigned int            hard_port_no;
220         unsigned int            pio_mask;
221         unsigned int            mwdma_mask;
222         unsigned int            udma_mask;
223         unsigned int            legacy_mode;
224         unsigned long           irq;
225         unsigned int            irq_flags;
226         unsigned long           host_flags;
227         void __iomem            *mmio_base;
228         void                    *private_data;
229 };
230
231 struct ata_host_set {
232         spinlock_t              lock;
233         struct device           *dev;
234         unsigned long           irq;
235         void __iomem            *mmio_base;
236         unsigned int            n_ports;
237         void                    *private_data;
238         const struct ata_port_operations *ops;
239         struct ata_port *       ports[0];
240 };
241
242 struct ata_queued_cmd {
243         struct ata_port         *ap;
244         struct ata_device       *dev;
245
246         struct scsi_cmnd        *scsicmd;
247         void                    (*scsidone)(struct scsi_cmnd *);
248
249         struct ata_taskfile     tf;
250         u8                      cdb[ATAPI_CDB_LEN];
251
252         unsigned long           flags;          /* ATA_QCFLAG_xxx */
253         unsigned int            tag;
254         unsigned int            n_elem;
255
256         int                     dma_dir;
257
258         unsigned int            nsect;
259         unsigned int            cursect;
260
261         unsigned int            nbytes;
262         unsigned int            curbytes;
263
264         unsigned int            cursg;
265         unsigned int            cursg_ofs;
266
267         struct scatterlist      sgent;
268         void                    *buf_virt;
269
270         struct scatterlist      *sg;
271
272         ata_qc_cb_t             complete_fn;
273
274         struct completion       *waiting;
275
276         void                    *private_data;
277 };
278
279 struct ata_host_stats {
280         unsigned long           unhandled_irq;
281         unsigned long           idle_irq;
282         unsigned long           rw_reqbuf;
283 };
284
285 struct ata_device {
286         u64                     n_sectors;      /* size of device, if ATA */
287         unsigned long           flags;          /* ATA_DFLAG_xxx */
288         unsigned int            class;          /* ATA_DEV_xxx */
289         unsigned int            devno;          /* 0 or 1 */
290         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
291         u8                      pio_mode;
292         u8                      dma_mode;
293         u8                      xfer_mode;
294         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
295
296         unsigned int            multi_count;    /* sectors count for
297                                                    READ/WRITE MULTIPLE */
298
299         /* for CHS addressing */
300         u16                     cylinders;      /* Number of cylinders */
301         u16                     heads;          /* Number of heads */
302         u16                     sectors;        /* Number of sectors per track */
303 };
304
305 struct ata_port {
306         struct Scsi_Host        *host;  /* our co-allocated scsi host */
307         const struct ata_port_operations *ops;
308         unsigned long           flags;  /* ATA_FLAG_xxx */
309         unsigned int            id;     /* unique id req'd by scsi midlyr */
310         unsigned int            port_no; /* unique port #; from zero */
311         unsigned int            hard_port_no;   /* hardware port #; from zero */
312
313         struct ata_prd          *prd;    /* our SG list */
314         dma_addr_t              prd_dma; /* and its DMA mapping */
315
316         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
317
318         u8                      ctl;    /* cache of ATA control register */
319         u8                      last_ctl;       /* Cache last written value */
320         unsigned int            bus_state;
321         unsigned int            port_state;
322         unsigned int            pio_mask;
323         unsigned int            mwdma_mask;
324         unsigned int            udma_mask;
325         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
326         unsigned int            cdb_len;
327
328         struct ata_device       device[ATA_MAX_DEVICES];
329
330         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
331         unsigned long           qactive;
332         unsigned int            active_tag;
333
334         struct ata_host_stats   stats;
335         struct ata_host_set     *host_set;
336
337         struct work_struct      dataout_task;
338
339         struct work_struct      pio_task;
340         unsigned int            hsm_task_state;
341         unsigned long           pio_task_timeout;
342
343         void                    *private_data;
344 };
345
346 struct ata_port_operations {
347         void (*port_disable) (struct ata_port *);
348
349         void (*dev_config) (struct ata_port *, struct ata_device *);
350
351         void (*set_piomode) (struct ata_port *, struct ata_device *);
352         void (*set_dmamode) (struct ata_port *, struct ata_device *);
353
354         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
355         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
356
357         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
358         u8   (*check_status)(struct ata_port *ap);
359         u8   (*check_altstatus)(struct ata_port *ap);
360         void (*dev_select)(struct ata_port *ap, unsigned int device);
361
362         void (*phy_reset) (struct ata_port *ap);
363         void (*post_set_mode) (struct ata_port *ap);
364
365         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
366
367         void (*bmdma_setup) (struct ata_queued_cmd *qc);
368         void (*bmdma_start) (struct ata_queued_cmd *qc);
369
370         void (*qc_prep) (struct ata_queued_cmd *qc);
371         int (*qc_issue) (struct ata_queued_cmd *qc);
372
373         void (*eng_timeout) (struct ata_port *ap);
374
375         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
376         void (*irq_clear) (struct ata_port *);
377
378         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
379         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
380                            u32 val);
381
382         int (*port_start) (struct ata_port *ap);
383         void (*port_stop) (struct ata_port *ap);
384
385         void (*host_stop) (struct ata_host_set *host_set);
386
387         void (*bmdma_stop) (struct ata_queued_cmd *qc);
388         u8   (*bmdma_status) (struct ata_port *ap);
389 };
390
391 struct ata_port_info {
392         Scsi_Host_Template      *sht;
393         unsigned long           host_flags;
394         unsigned long           pio_mask;
395         unsigned long           mwdma_mask;
396         unsigned long           udma_mask;
397         const struct ata_port_operations *port_ops;
398 };
399
400 struct ata_timing {
401         unsigned short mode;            /* ATA mode */
402         unsigned short setup;           /* t1 */
403         unsigned short act8b;           /* t2 for 8-bit I/O */
404         unsigned short rec8b;           /* t2i for 8-bit I/O */
405         unsigned short cyc8b;           /* t0 for 8-bit I/O */
406         unsigned short active;          /* t2 or tD */
407         unsigned short recover;         /* t2i or tK */
408         unsigned short cycle;           /* t0 */
409         unsigned short udma;            /* t2CYCTYP/2 */
410 };
411
412 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
413
414 extern void ata_port_probe(struct ata_port *);
415 extern void __sata_phy_reset(struct ata_port *ap);
416 extern void sata_phy_reset(struct ata_port *ap);
417 extern void ata_bus_reset(struct ata_port *ap);
418 extern void ata_port_disable(struct ata_port *);
419 extern void ata_std_ports(struct ata_ioports *ioaddr);
420 #ifdef CONFIG_PCI
421 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
422                              unsigned int n_ports);
423 extern void ata_pci_remove_one (struct pci_dev *pdev);
424 #endif /* CONFIG_PCI */
425 extern int ata_device_add(const struct ata_probe_ent *ent);
426 extern void ata_host_set_remove(struct ata_host_set *host_set);
427 extern int ata_scsi_detect(Scsi_Host_Template *sht);
428 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
429 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
430 extern int ata_scsi_error(struct Scsi_Host *host);
431 extern int ata_scsi_release(struct Scsi_Host *host);
432 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
433 extern int ata_ratelimit(void);
434
435 /*
436  * Default driver ops implementations
437  */
438 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
439 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
440 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
441 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
442 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
443 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
444 extern u8 ata_check_status(struct ata_port *ap);
445 extern u8 ata_altstatus(struct ata_port *ap);
446 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
447 extern int ata_port_start (struct ata_port *ap);
448 extern void ata_port_stop (struct ata_port *ap);
449 extern void ata_host_stop (struct ata_host_set *host_set);
450 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
451 extern void ata_qc_prep(struct ata_queued_cmd *qc);
452 extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
453 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
454                 unsigned int buflen);
455 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
456                  unsigned int n_elem);
457 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
458 extern void ata_dev_id_string(const u16 *id, unsigned char *s,
459                               unsigned int ofs, unsigned int len);
460 extern void ata_dev_config(struct ata_port *ap, unsigned int i);
461 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
462 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
463 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
464 extern u8   ata_bmdma_status(struct ata_port *ap);
465 extern void ata_bmdma_irq_clear(struct ata_port *ap);
466 extern void ata_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask);
467 extern void ata_eng_timeout(struct ata_port *ap);
468 extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
469                               void (*done)(struct scsi_cmnd *));
470 extern int ata_std_bios_param(struct scsi_device *sdev,
471                               struct block_device *bdev,
472                               sector_t capacity, int geom[]);
473 extern int ata_scsi_slave_config(struct scsi_device *sdev);
474
475 /*
476  * Timing helpers
477  */
478 extern int ata_timing_compute(struct ata_device *, unsigned short,
479                               struct ata_timing *, int, int);
480 extern void ata_timing_merge(const struct ata_timing *,
481                              const struct ata_timing *, struct ata_timing *,
482                              unsigned int);
483
484 enum {
485         ATA_TIMING_SETUP        = (1 << 0),
486         ATA_TIMING_ACT8B        = (1 << 1),
487         ATA_TIMING_REC8B        = (1 << 2),
488         ATA_TIMING_CYC8B        = (1 << 3),
489         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
490                                   ATA_TIMING_CYC8B,
491         ATA_TIMING_ACTIVE       = (1 << 4),
492         ATA_TIMING_RECOVER      = (1 << 5),
493         ATA_TIMING_CYCLE        = (1 << 6),
494         ATA_TIMING_UDMA         = (1 << 7),
495         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
496                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
497                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
498                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
499 };
500
501
502 #ifdef CONFIG_PCI
503 struct pci_bits {
504         unsigned int            reg;    /* PCI config register to read */
505         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
506         unsigned long           mask;
507         unsigned long           val;
508 };
509
510 extern void ata_pci_host_stop (struct ata_host_set *host_set);
511 extern struct ata_probe_ent *
512 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
513 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
514
515 #endif /* CONFIG_PCI */
516
517
518 static inline unsigned int ata_tag_valid(unsigned int tag)
519 {
520         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
521 }
522
523 static inline unsigned int ata_dev_present(const struct ata_device *dev)
524 {
525         return ((dev->class == ATA_DEV_ATA) ||
526                 (dev->class == ATA_DEV_ATAPI));
527 }
528
529 static inline u8 ata_chk_status(struct ata_port *ap)
530 {
531         return ap->ops->check_status(ap);
532 }
533
534
535 /**
536  *      ata_pause - Flush writes and pause 400 nanoseconds.
537  *      @ap: Port to wait for.
538  *
539  *      LOCKING:
540  *      Inherited from caller.
541  */
542
543 static inline void ata_pause(struct ata_port *ap)
544 {
545         ata_altstatus(ap);
546         ndelay(400);
547 }
548
549
550 /**
551  *      ata_busy_wait - Wait for a port status register
552  *      @ap: Port to wait for.
553  *
554  *      Waits up to max*10 microseconds for the selected bits in the port's
555  *      status register to be cleared.
556  *      Returns final value of status register.
557  *
558  *      LOCKING:
559  *      Inherited from caller.
560  */
561
562 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
563                                unsigned int max)
564 {
565         u8 status;
566
567         do {
568                 udelay(10);
569                 status = ata_chk_status(ap);
570                 max--;
571         } while ((status & bits) && (max > 0));
572
573         return status;
574 }
575
576
577 /**
578  *      ata_wait_idle - Wait for a port to be idle.
579  *      @ap: Port to wait for.
580  *
581  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
582  *      Returns final value of status register.
583  *
584  *      LOCKING:
585  *      Inherited from caller.
586  */
587
588 static inline u8 ata_wait_idle(struct ata_port *ap)
589 {
590         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
591
592         if (status & (ATA_BUSY | ATA_DRQ)) {
593                 unsigned long l = ap->ioaddr.status_addr;
594                 printk(KERN_WARNING
595                        "ATA: abnormal status 0x%X on port 0x%lX\n",
596                        status, l);
597         }
598
599         return status;
600 }
601
602 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
603 {
604         qc->tf.ctl |= ATA_NIEN;
605 }
606
607 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
608                                                       unsigned int tag)
609 {
610         if (likely(ata_tag_valid(tag)))
611                 return &ap->qcmd[tag];
612         return NULL;
613 }
614
615 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
616 {
617         memset(tf, 0, sizeof(*tf));
618
619         tf->ctl = ap->ctl;
620         if (device == 0)
621                 tf->device = ATA_DEVICE_OBS;
622         else
623                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
624 }
625
626
627 /**
628  *      ata_irq_on - Enable interrupts on a port.
629  *      @ap: Port on which interrupts are enabled.
630  *
631  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
632  *      wait for idle, clear any pending interrupts.
633  *
634  *      LOCKING:
635  *      Inherited from caller.
636  */
637
638 static inline u8 ata_irq_on(struct ata_port *ap)
639 {
640         struct ata_ioports *ioaddr = &ap->ioaddr;
641         u8 tmp;
642
643         ap->ctl &= ~ATA_NIEN;
644         ap->last_ctl = ap->ctl;
645
646         if (ap->flags & ATA_FLAG_MMIO)
647                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
648         else
649                 outb(ap->ctl, ioaddr->ctl_addr);
650         tmp = ata_wait_idle(ap);
651
652         ap->ops->irq_clear(ap);
653
654         return tmp;
655 }
656
657
658 /**
659  *      ata_irq_ack - Acknowledge a device interrupt.
660  *      @ap: Port on which interrupts are enabled.
661  *
662  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
663  *      or BUSY+DRQ clear).  Obtain dma status and port status from
664  *      device.  Clear the interrupt.  Return port status.
665  *
666  *      LOCKING:
667  */
668
669 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
670 {
671         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
672         u8 host_stat, post_stat, status;
673
674         status = ata_busy_wait(ap, bits, 1000);
675         if (status & bits)
676                 DPRINTK("abnormal status 0x%X\n", status);
677
678         /* get controller status; clear intr, err bits */
679         if (ap->flags & ATA_FLAG_MMIO) {
680                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
681                 host_stat = readb(mmio + ATA_DMA_STATUS);
682                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
683                        mmio + ATA_DMA_STATUS);
684
685                 post_stat = readb(mmio + ATA_DMA_STATUS);
686         } else {
687                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
688                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
689                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
690
691                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
692         }
693
694         VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
695                 host_stat, post_stat, status);
696
697         return status;
698 }
699
700 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
701 {
702         return ap->ops->scr_read(ap, reg);
703 }
704
705 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
706 {
707         ap->ops->scr_write(ap, reg, val);
708 }
709
710 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
711                                    u32 val)
712 {
713         ap->ops->scr_write(ap, reg, val);
714         (void) ap->ops->scr_read(ap, reg);
715 }
716
717 static inline unsigned int sata_dev_present(struct ata_port *ap)
718 {
719         return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
720 }
721
722 static inline int ata_try_flush_cache(const struct ata_device *dev)
723 {
724         return ata_id_wcache_enabled(dev->id) ||
725                ata_id_has_flush(dev->id) ||
726                ata_id_has_flush_ext(dev->id);
727 }
728
729 static inline unsigned int ac_err_mask(u8 status)
730 {
731         if (status & ATA_BUSY)
732                 return AC_ERR_ATA_BUS;
733         if (status & (ATA_ERR | ATA_DF))
734                 return AC_ERR_DEV;
735         return 0;
736 }
737
738 static inline unsigned int __ac_err_mask(u8 status)
739 {
740         unsigned int mask = ac_err_mask(status);
741         if (mask == 0)
742                 return AC_ERR_OTHER;
743         return mask;
744 }
745
746 #endif /* __LINUX_LIBATA_H__ */