2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
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)
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.
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.
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/DocBook/libata.*
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <linux/dma-mapping.h>
34 #include <linux/ata.h>
35 #include <linux/workqueue.h>
36 #include <scsi/scsi_host.h>
39 * compile-time options: to be removed as soon as all the drivers are
40 * converted to the new debugging mechanism
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 */
50 /* note: prints function name for you */
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)
56 #define VPRINTK(fmt, args...)
57 #endif /* ATA_VERBOSE_DEBUG */
59 #define DPRINTK(fmt, args...)
60 #define VPRINTK(fmt, args...)
61 #endif /* ATA_DEBUG */
63 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65 /* NEW: debug levels */
66 #define HAVE_LIBATA_MSG 1
70 ATA_MSG_INFO = 0x0002,
71 ATA_MSG_PROBE = 0x0004,
72 ATA_MSG_WARN = 0x0008,
73 ATA_MSG_MALLOC = 0x0010,
75 ATA_MSG_INTR = 0x0040,
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)
88 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
90 if (dval < 0 || dval >= (sizeof(u32) * 8))
91 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
94 return (1 << dval) - 1;
97 /* defines only for the constants which don't work well as enums */
98 #define ATA_TAG_POISON 0xfafbfcfdU
100 /* move to PCI layer? */
101 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
107 /* various global constants */
108 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
112 ATA_MAX_SECTORS = 200, /* FIXME */
114 ATA_DEF_BUSY_WAIT = 10000,
115 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
117 ATA_SHT_EMULATED = 1,
118 ATA_SHT_CMD_PER_LUN = 1,
119 ATA_SHT_THIS_ID = -1,
120 ATA_SHT_USE_CLUSTERING = 1,
122 /* struct ata_device stuff */
123 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
124 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
125 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
127 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
129 ATA_DEV_UNKNOWN = 0, /* unknown device */
130 ATA_DEV_ATA = 1, /* ATA device */
131 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
132 ATA_DEV_ATAPI = 3, /* ATAPI device */
133 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
134 ATA_DEV_NONE = 5, /* no device */
136 /* struct ata_port flags */
137 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
138 /* (doesn't imply presence) */
139 ATA_FLAG_SATA = (1 << 1),
140 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
141 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
142 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
143 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
144 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
145 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
146 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
147 ATA_FLAG_IRQ_MASK = (1 << 9), /* Mask IRQ in PIO xfers */
149 ATA_FLAG_NOINTR = (1 << 16), /* FIXME: Remove this once
150 * proper HSM is in place. */
151 ATA_FLAG_DEBUGMSG = (1 << 17),
152 ATA_FLAG_FLUSH_PORT_TASK = (1 << 18), /* flush port task */
154 ATA_FLAG_DISABLED = (1 << 19), /* port is disabled, ignore it */
155 ATA_FLAG_SUSPENDED = (1 << 20), /* port is suspended */
157 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
159 /* struct ata_queued_cmd flags */
160 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
161 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
162 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
163 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
164 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
165 ATA_QCFLAG_EH_SCHEDULED = (1 << 4), /* EH scheduled */
168 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
170 /* various lengths of time */
171 ATA_TMOUT_PIO = 30 * HZ,
172 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
173 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
174 ATA_TMOUT_CDB = 30 * HZ,
175 ATA_TMOUT_CDB_QUICK = 5 * HZ,
176 ATA_TMOUT_INTERNAL = 30 * HZ,
177 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
191 /* SATA port states */
196 /* encoding various smaller bitmaps into a single
197 * unsigned int bitmap
204 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
205 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
207 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
208 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
209 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
211 /* size of buffer to pad xfers ending on unaligned boundaries */
213 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
215 /* masks for port functions */
216 ATA_PORT_PRIMARY = (1 << 0),
217 ATA_PORT_SECONDARY = (1 << 1),
219 /* how hard are we gonna try to probe/recover devices */
220 ATA_PROBE_MAX_TRIES = 3,
223 enum hsm_task_states {
234 enum ata_completion_errors {
235 AC_ERR_DEV = (1 << 0), /* device reported error */
236 AC_ERR_HSM = (1 << 1), /* host state machine violation */
237 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
238 AC_ERR_MEDIA = (1 << 3), /* media error */
239 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
240 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
241 AC_ERR_SYSTEM = (1 << 6), /* system error */
242 AC_ERR_INVALID = (1 << 7), /* invalid argument */
243 AC_ERR_OTHER = (1 << 8), /* unknown */
246 /* forward declarations */
248 struct ata_port_operations;
250 struct ata_queued_cmd;
253 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
254 typedef void (*ata_probeinit_fn_t)(struct ata_port *);
255 typedef int (*ata_reset_fn_t)(struct ata_port *, unsigned int *);
256 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
259 unsigned long cmd_addr;
260 unsigned long data_addr;
261 unsigned long error_addr;
262 unsigned long feature_addr;
263 unsigned long nsect_addr;
264 unsigned long lbal_addr;
265 unsigned long lbam_addr;
266 unsigned long lbah_addr;
267 unsigned long device_addr;
268 unsigned long status_addr;
269 unsigned long command_addr;
270 unsigned long altstatus_addr;
271 unsigned long ctl_addr;
272 unsigned long bmdma_addr;
273 unsigned long scr_addr;
276 struct ata_probe_ent {
277 struct list_head node;
279 const struct ata_port_operations *port_ops;
280 struct scsi_host_template *sht;
281 struct ata_ioports port[ATA_MAX_PORTS];
282 unsigned int n_ports;
283 unsigned int hard_port_no;
284 unsigned int pio_mask;
285 unsigned int mwdma_mask;
286 unsigned int udma_mask;
287 unsigned int legacy_mode;
289 unsigned int irq_flags;
290 unsigned long host_flags;
291 unsigned long host_set_flags;
292 void __iomem *mmio_base;
296 struct ata_host_set {
300 void __iomem *mmio_base;
301 unsigned int n_ports;
303 const struct ata_port_operations *ops;
305 int simplex_claimed; /* Keep seperate in case we
306 ever need to do this locked */
307 struct ata_port * ports[0];
310 struct ata_queued_cmd {
312 struct ata_device *dev;
314 struct scsi_cmnd *scsicmd;
315 void (*scsidone)(struct scsi_cmnd *);
317 struct ata_taskfile tf;
318 u8 cdb[ATAPI_CDB_LEN];
320 unsigned long flags; /* ATA_QCFLAG_xxx */
323 unsigned int orig_n_elem;
327 unsigned int pad_len;
330 unsigned int cursect;
333 unsigned int curbytes;
336 unsigned int cursg_ofs;
338 struct scatterlist sgent;
339 struct scatterlist pad_sgent;
342 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
343 struct scatterlist *__sg;
345 unsigned int err_mask;
347 ata_qc_cb_t complete_fn;
352 struct ata_host_stats {
353 unsigned long unhandled_irq;
354 unsigned long idle_irq;
355 unsigned long rw_reqbuf;
359 u64 n_sectors; /* size of device, if ATA */
360 unsigned long flags; /* ATA_DFLAG_xxx */
361 unsigned int class; /* ATA_DEV_xxx */
362 unsigned int devno; /* 0 or 1 */
363 u16 *id; /* IDENTIFY xxx DEVICE data */
367 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
369 unsigned int multi_count; /* sectors count for
370 READ/WRITE MULTIPLE */
371 unsigned int max_sectors; /* per-device max sectors */
372 unsigned int cdb_len;
374 /* per-dev xfer mask */
375 unsigned int pio_mask;
376 unsigned int mwdma_mask;
377 unsigned int udma_mask;
379 /* for CHS addressing */
380 u16 cylinders; /* Number of cylinders */
381 u16 heads; /* Number of heads */
382 u16 sectors; /* Number of sectors per track */
386 struct Scsi_Host *host; /* our co-allocated scsi host */
387 const struct ata_port_operations *ops;
388 unsigned long flags; /* ATA_FLAG_xxx */
389 unsigned int id; /* unique id req'd by scsi midlyr */
390 unsigned int port_no; /* unique port #; from zero */
391 unsigned int hard_port_no; /* hardware port #; from zero */
393 struct ata_prd *prd; /* our SG list */
394 dma_addr_t prd_dma; /* and its DMA mapping */
396 void *pad; /* array of DMA pad buffers */
399 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
401 u8 ctl; /* cache of ATA control register */
402 u8 last_ctl; /* Cache last written value */
403 unsigned int pio_mask;
404 unsigned int mwdma_mask;
405 unsigned int udma_mask;
406 unsigned int cbl; /* cable type; ATA_CBL_xxx */
407 unsigned int sata_spd_limit; /* SATA PHY speed limit */
409 struct ata_device device[ATA_MAX_DEVICES];
411 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
412 unsigned long qactive;
413 unsigned int active_tag;
415 struct ata_host_stats stats;
416 struct ata_host_set *host_set;
419 struct work_struct port_task;
421 unsigned int hsm_task_state;
422 unsigned long pio_task_timeout;
425 struct list_head eh_done_q;
430 struct ata_port_operations {
431 void (*port_disable) (struct ata_port *);
433 void (*dev_config) (struct ata_port *, struct ata_device *);
435 void (*set_piomode) (struct ata_port *, struct ata_device *);
436 void (*set_dmamode) (struct ata_port *, struct ata_device *);
437 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
439 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
440 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
442 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
443 u8 (*check_status)(struct ata_port *ap);
444 u8 (*check_altstatus)(struct ata_port *ap);
445 void (*dev_select)(struct ata_port *ap, unsigned int device);
447 void (*phy_reset) (struct ata_port *ap); /* obsolete */
448 void (*set_mode) (struct ata_port *ap);
449 int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
451 void (*post_set_mode) (struct ata_port *ap);
453 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
455 void (*bmdma_setup) (struct ata_queued_cmd *qc);
456 void (*bmdma_start) (struct ata_queued_cmd *qc);
458 void (*qc_prep) (struct ata_queued_cmd *qc);
459 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
461 void (*eng_timeout) (struct ata_port *ap);
463 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
464 void (*irq_clear) (struct ata_port *);
466 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
467 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
470 int (*port_start) (struct ata_port *ap);
471 void (*port_stop) (struct ata_port *ap);
473 void (*host_stop) (struct ata_host_set *host_set);
475 void (*bmdma_stop) (struct ata_queued_cmd *qc);
476 u8 (*bmdma_status) (struct ata_port *ap);
479 struct ata_port_info {
480 struct scsi_host_template *sht;
481 unsigned long host_flags;
482 unsigned long pio_mask;
483 unsigned long mwdma_mask;
484 unsigned long udma_mask;
485 const struct ata_port_operations *port_ops;
490 unsigned short mode; /* ATA mode */
491 unsigned short setup; /* t1 */
492 unsigned short act8b; /* t2 for 8-bit I/O */
493 unsigned short rec8b; /* t2i for 8-bit I/O */
494 unsigned short cyc8b; /* t0 for 8-bit I/O */
495 unsigned short active; /* t2 or tD */
496 unsigned short recover; /* t2i or tK */
497 unsigned short cycle; /* t0 */
498 unsigned short udma; /* t2CYCTYP/2 */
501 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
503 extern void ata_port_probe(struct ata_port *);
504 extern void __sata_phy_reset(struct ata_port *ap);
505 extern void sata_phy_reset(struct ata_port *ap);
506 extern void ata_bus_reset(struct ata_port *ap);
507 extern int sata_set_spd(struct ata_port *ap);
508 extern int ata_drive_probe_reset(struct ata_port *ap,
509 ata_probeinit_fn_t probeinit,
510 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
511 ata_postreset_fn_t postreset, unsigned int *classes);
512 extern void ata_std_probeinit(struct ata_port *ap);
513 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
514 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
515 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
516 extern int ata_dev_revalidate(struct ata_port *ap, struct ata_device *dev,
518 extern void ata_port_disable(struct ata_port *);
519 extern void ata_std_ports(struct ata_ioports *ioaddr);
521 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
522 unsigned int n_ports);
523 extern void ata_pci_remove_one (struct pci_dev *pdev);
524 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
525 extern int ata_pci_device_resume(struct pci_dev *pdev);
526 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
527 #endif /* CONFIG_PCI */
528 extern int ata_device_add(const struct ata_probe_ent *ent);
529 extern void ata_host_set_remove(struct ata_host_set *host_set);
530 extern int ata_scsi_detect(struct scsi_host_template *sht);
531 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
532 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
533 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
534 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
535 extern int ata_scsi_release(struct Scsi_Host *host);
536 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
537 extern int ata_scsi_device_resume(struct scsi_device *);
538 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
539 extern int ata_device_resume(struct ata_port *, struct ata_device *);
540 extern int ata_device_suspend(struct ata_port *, struct ata_device *, pm_message_t state);
541 extern int ata_ratelimit(void);
542 extern unsigned int ata_busy_sleep(struct ata_port *ap,
543 unsigned long timeout_pat,
544 unsigned long timeout);
545 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
546 void *data, unsigned long delay);
547 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
548 unsigned long interval_msec,
549 unsigned long timeout_msec);
552 * Default driver ops implementations
554 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
555 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
556 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
557 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
558 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
559 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
560 extern u8 ata_check_status(struct ata_port *ap);
561 extern u8 ata_altstatus(struct ata_port *ap);
562 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
563 extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
564 extern int ata_port_start (struct ata_port *ap);
565 extern void ata_port_stop (struct ata_port *ap);
566 extern void ata_host_stop (struct ata_host_set *host_set);
567 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
568 extern void ata_qc_prep(struct ata_queued_cmd *qc);
569 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
570 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
571 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
572 unsigned int buflen);
573 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
574 unsigned int n_elem);
575 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
576 extern void ata_id_string(const u16 *id, unsigned char *s,
577 unsigned int ofs, unsigned int len);
578 extern void ata_id_c_string(const u16 *id, unsigned char *s,
579 unsigned int ofs, unsigned int len);
580 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
581 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
582 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
583 extern u8 ata_bmdma_status(struct ata_port *ap);
584 extern void ata_bmdma_irq_clear(struct ata_port *ap);
585 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
586 extern void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
587 struct scsi_cmnd *cmd,
588 void (*done)(struct scsi_cmnd *));
589 extern int ata_std_bios_param(struct scsi_device *sdev,
590 struct block_device *bdev,
591 sector_t capacity, int geom[]);
592 extern int ata_scsi_slave_config(struct scsi_device *sdev);
593 extern struct ata_device *ata_dev_pair(struct ata_port *ap,
594 struct ata_device *adev);
600 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
601 extern int ata_timing_compute(struct ata_device *, unsigned short,
602 struct ata_timing *, int, int);
603 extern void ata_timing_merge(const struct ata_timing *,
604 const struct ata_timing *, struct ata_timing *,
608 ATA_TIMING_SETUP = (1 << 0),
609 ATA_TIMING_ACT8B = (1 << 1),
610 ATA_TIMING_REC8B = (1 << 2),
611 ATA_TIMING_CYC8B = (1 << 3),
612 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
614 ATA_TIMING_ACTIVE = (1 << 4),
615 ATA_TIMING_RECOVER = (1 << 5),
616 ATA_TIMING_CYCLE = (1 << 6),
617 ATA_TIMING_UDMA = (1 << 7),
618 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
619 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
620 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
621 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
627 unsigned int reg; /* PCI config register to read */
628 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
633 extern void ata_pci_host_stop (struct ata_host_set *host_set);
634 extern struct ata_probe_ent *
635 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
636 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
637 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
638 #endif /* CONFIG_PCI */
643 extern void ata_eng_timeout(struct ata_port *ap);
644 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
645 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
649 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
651 if (sg == &qc->pad_sgent)
655 if (((sg - qc->__sg) + 1) == qc->n_elem)
660 static inline struct scatterlist *
661 ata_qc_first_sg(struct ata_queued_cmd *qc)
666 return &qc->pad_sgent;
670 static inline struct scatterlist *
671 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
673 if (sg == &qc->pad_sgent)
675 if (++sg - qc->__sg < qc->n_elem)
678 return &qc->pad_sgent;
682 #define ata_for_each_sg(sg, qc) \
683 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
685 static inline unsigned int ata_tag_valid(unsigned int tag)
687 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
690 static inline unsigned int ata_class_enabled(unsigned int class)
692 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
695 static inline unsigned int ata_class_disabled(unsigned int class)
697 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
700 static inline unsigned int ata_class_absent(unsigned int class)
702 return !ata_class_enabled(class) && !ata_class_disabled(class);
705 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
707 return ata_class_enabled(dev->class);
710 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
712 return ata_class_disabled(dev->class);
715 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
717 return ata_class_absent(dev->class);
720 static inline u8 ata_chk_status(struct ata_port *ap)
722 return ap->ops->check_status(ap);
727 * ata_pause - Flush writes and pause 400 nanoseconds.
728 * @ap: Port to wait for.
731 * Inherited from caller.
734 static inline void ata_pause(struct ata_port *ap)
742 * ata_busy_wait - Wait for a port status register
743 * @ap: Port to wait for.
745 * Waits up to max*10 microseconds for the selected bits in the port's
746 * status register to be cleared.
747 * Returns final value of status register.
750 * Inherited from caller.
753 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
760 status = ata_chk_status(ap);
762 } while ((status & bits) && (max > 0));
769 * ata_wait_idle - Wait for a port to be idle.
770 * @ap: Port to wait for.
772 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
773 * Returns final value of status register.
776 * Inherited from caller.
779 static inline u8 ata_wait_idle(struct ata_port *ap)
781 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
783 if (status & (ATA_BUSY | ATA_DRQ)) {
784 unsigned long l = ap->ioaddr.status_addr;
785 if (ata_msg_warn(ap))
786 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
793 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
795 qc->tf.ctl |= ATA_NIEN;
798 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
801 if (likely(ata_tag_valid(tag)))
802 return &ap->qcmd[tag];
806 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
808 memset(tf, 0, sizeof(*tf));
812 tf->device = ATA_DEVICE_OBS;
814 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
817 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
821 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
823 qc->nbytes = qc->curbytes = 0;
826 ata_tf_init(qc->ap, &qc->tf, qc->dev->devno);
830 * ata_qc_complete - Complete an active ATA command
831 * @qc: Command to complete
832 * @err_mask: ATA Status register contents
834 * Indicate to the mid and upper layers that an ATA
835 * command has completed, with either an ok or not-ok status.
838 * spin_lock_irqsave(host_set lock)
840 static inline void ata_qc_complete(struct ata_queued_cmd *qc)
842 if (unlikely(qc->flags & ATA_QCFLAG_EH_SCHEDULED))
845 __ata_qc_complete(qc);
849 * ata_irq_on - Enable interrupts on a port.
850 * @ap: Port on which interrupts are enabled.
852 * Enable interrupts on a legacy IDE device using MMIO or PIO,
853 * wait for idle, clear any pending interrupts.
856 * Inherited from caller.
859 static inline u8 ata_irq_on(struct ata_port *ap)
861 struct ata_ioports *ioaddr = &ap->ioaddr;
864 ap->ctl &= ~ATA_NIEN;
865 ap->last_ctl = ap->ctl;
867 if (ap->flags & ATA_FLAG_MMIO)
868 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
870 outb(ap->ctl, ioaddr->ctl_addr);
871 tmp = ata_wait_idle(ap);
873 ap->ops->irq_clear(ap);
880 * ata_irq_ack - Acknowledge a device interrupt.
881 * @ap: Port on which interrupts are enabled.
883 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
884 * or BUSY+DRQ clear). Obtain dma status and port status from
885 * device. Clear the interrupt. Return port status.
890 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
892 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
893 u8 host_stat, post_stat, status;
895 status = ata_busy_wait(ap, bits, 1000);
898 printk(KERN_ERR "abnormal status 0x%X\n", status);
900 /* get controller status; clear intr, err bits */
901 if (ap->flags & ATA_FLAG_MMIO) {
902 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
903 host_stat = readb(mmio + ATA_DMA_STATUS);
904 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
905 mmio + ATA_DMA_STATUS);
907 post_stat = readb(mmio + ATA_DMA_STATUS);
909 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
910 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
911 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
913 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
916 if (ata_msg_intr(ap))
917 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
919 host_stat, post_stat, status);
924 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
926 return ap->ops->scr_read(ap, reg);
929 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
931 ap->ops->scr_write(ap, reg, val);
934 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
937 ap->ops->scr_write(ap, reg, val);
938 (void) ap->ops->scr_read(ap, reg);
941 static inline unsigned int sata_dev_present(struct ata_port *ap)
943 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
946 static inline int ata_try_flush_cache(const struct ata_device *dev)
948 return ata_id_wcache_enabled(dev->id) ||
949 ata_id_has_flush(dev->id) ||
950 ata_id_has_flush_ext(dev->id);
953 static inline unsigned int ac_err_mask(u8 status)
955 if (status & ATA_BUSY)
957 if (status & (ATA_ERR | ATA_DF))
962 static inline unsigned int __ac_err_mask(u8 status)
964 unsigned int mask = ac_err_mask(status);
970 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
973 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
974 &ap->pad_dma, GFP_KERNEL);
975 return (ap->pad == NULL) ? -ENOMEM : 0;
978 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
980 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
983 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
985 return (struct ata_port *) &host->hostdata[0];
988 #endif /* __LINUX_LIBATA_H__ */