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>
38 * compile-time options: to be removed as soon as all the drivers are
39 * converted to the new debugging mechanism
41 #undef ATA_DEBUG /* debugging output */
42 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
43 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
44 #undef ATA_NDEBUG /* define to disable quick runtime checks */
45 #undef ATA_ENABLE_PATA /* define to enable PATA support in some
46 * low-level drivers */
47 #undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */
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_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
126 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
128 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
130 ATA_DEV_UNKNOWN = 0, /* unknown device */
131 ATA_DEV_ATA = 1, /* ATA device */
132 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
133 ATA_DEV_ATAPI = 3, /* ATAPI device */
134 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
135 ATA_DEV_NONE = 5, /* no device */
137 /* struct ata_port flags */
138 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
139 /* (doesn't imply presence) */
140 ATA_FLAG_SATA = (1 << 1),
141 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
142 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
143 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
144 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
145 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
146 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
147 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
148 ATA_FLAG_IRQ_MASK = (1 << 9), /* Mask IRQ in PIO xfers */
149 ATA_FLAG_PIO_POLLING = (1 << 10), /* use polling PIO if LLD
150 * doesn't handle PIO interrupts */
152 ATA_FLAG_DEBUGMSG = (1 << 17),
153 ATA_FLAG_FLUSH_PORT_TASK = (1 << 18), /* flush port task */
155 ATA_FLAG_DISABLED = (1 << 19), /* port is disabled, ignore it */
156 ATA_FLAG_SUSPENDED = (1 << 20), /* port is suspended */
158 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
160 /* struct ata_queued_cmd flags */
161 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
162 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
163 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
164 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
165 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
166 ATA_QCFLAG_EH_SCHEDULED = (1 << 4), /* EH scheduled */
169 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
171 /* various lengths of time */
172 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
173 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
174 ATA_TMOUT_INTERNAL = 30 * HZ,
175 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
189 /* SATA port states */
194 /* encoding various smaller bitmaps into a single
195 * unsigned int bitmap
202 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
203 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
205 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
206 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
207 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
209 /* size of buffer to pad xfers ending on unaligned boundaries */
211 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
213 /* masks for port functions */
214 ATA_PORT_PRIMARY = (1 << 0),
215 ATA_PORT_SECONDARY = (1 << 1),
217 /* how hard are we gonna try to probe/recover devices */
218 ATA_PROBE_MAX_TRIES = 3,
221 enum hsm_task_states {
222 HSM_ST_UNKNOWN, /* state unknown */
223 HSM_ST_IDLE, /* no command on going */
224 HSM_ST, /* (waiting the device to) transfer data */
225 HSM_ST_LAST, /* (waiting the device to) complete command */
226 HSM_ST_ERR, /* error */
227 HSM_ST_FIRST, /* (waiting the device to)
228 write CDB or first data block */
231 enum ata_completion_errors {
232 AC_ERR_DEV = (1 << 0), /* device reported error */
233 AC_ERR_HSM = (1 << 1), /* host state machine violation */
234 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
235 AC_ERR_MEDIA = (1 << 3), /* media error */
236 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
237 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
238 AC_ERR_SYSTEM = (1 << 6), /* system error */
239 AC_ERR_INVALID = (1 << 7), /* invalid argument */
240 AC_ERR_OTHER = (1 << 8), /* unknown */
243 /* forward declarations */
245 struct ata_port_operations;
247 struct ata_queued_cmd;
250 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
251 typedef void (*ata_probeinit_fn_t)(struct ata_port *);
252 typedef int (*ata_reset_fn_t)(struct ata_port *, int, unsigned int *);
253 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
256 unsigned long cmd_addr;
257 unsigned long data_addr;
258 unsigned long error_addr;
259 unsigned long feature_addr;
260 unsigned long nsect_addr;
261 unsigned long lbal_addr;
262 unsigned long lbam_addr;
263 unsigned long lbah_addr;
264 unsigned long device_addr;
265 unsigned long status_addr;
266 unsigned long command_addr;
267 unsigned long altstatus_addr;
268 unsigned long ctl_addr;
269 unsigned long bmdma_addr;
270 unsigned long scr_addr;
273 struct ata_probe_ent {
274 struct list_head node;
276 const struct ata_port_operations *port_ops;
277 struct scsi_host_template *sht;
278 struct ata_ioports port[ATA_MAX_PORTS];
279 unsigned int n_ports;
280 unsigned int hard_port_no;
281 unsigned int pio_mask;
282 unsigned int mwdma_mask;
283 unsigned int udma_mask;
284 unsigned int legacy_mode;
286 unsigned int irq_flags;
287 unsigned long host_flags;
288 unsigned long host_set_flags;
289 void __iomem *mmio_base;
293 struct ata_host_set {
297 void __iomem *mmio_base;
298 unsigned int n_ports;
300 const struct ata_port_operations *ops;
302 int simplex_claimed; /* Keep seperate in case we
303 ever need to do this locked */
304 struct ata_port * ports[0];
307 struct ata_queued_cmd {
309 struct ata_device *dev;
311 struct scsi_cmnd *scsicmd;
312 void (*scsidone)(struct scsi_cmnd *);
314 struct ata_taskfile tf;
315 u8 cdb[ATAPI_CDB_LEN];
317 unsigned long flags; /* ATA_QCFLAG_xxx */
320 unsigned int orig_n_elem;
324 unsigned int pad_len;
327 unsigned int cursect;
330 unsigned int curbytes;
333 unsigned int cursg_ofs;
335 struct scatterlist sgent;
336 struct scatterlist pad_sgent;
339 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
340 struct scatterlist *__sg;
342 unsigned int err_mask;
344 ata_qc_cb_t complete_fn;
349 struct ata_host_stats {
350 unsigned long unhandled_irq;
351 unsigned long idle_irq;
352 unsigned long rw_reqbuf;
356 u64 n_sectors; /* size of device, if ATA */
357 unsigned long flags; /* ATA_DFLAG_xxx */
358 unsigned int class; /* ATA_DEV_xxx */
359 unsigned int devno; /* 0 or 1 */
360 u16 *id; /* IDENTIFY xxx DEVICE data */
364 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
366 unsigned int multi_count; /* sectors count for
367 READ/WRITE MULTIPLE */
368 unsigned int max_sectors; /* per-device max sectors */
369 unsigned int cdb_len;
371 /* per-dev xfer mask */
372 unsigned int pio_mask;
373 unsigned int mwdma_mask;
374 unsigned int udma_mask;
376 /* for CHS addressing */
377 u16 cylinders; /* Number of cylinders */
378 u16 heads; /* Number of heads */
379 u16 sectors; /* Number of sectors per track */
383 struct Scsi_Host *host; /* our co-allocated scsi host */
384 const struct ata_port_operations *ops;
385 unsigned long flags; /* ATA_FLAG_xxx */
386 unsigned int id; /* unique id req'd by scsi midlyr */
387 unsigned int port_no; /* unique port #; from zero */
388 unsigned int hard_port_no; /* hardware port #; from zero */
390 struct ata_prd *prd; /* our SG list */
391 dma_addr_t prd_dma; /* and its DMA mapping */
393 void *pad; /* array of DMA pad buffers */
396 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
398 u8 ctl; /* cache of ATA control register */
399 u8 last_ctl; /* Cache last written value */
400 unsigned int pio_mask;
401 unsigned int mwdma_mask;
402 unsigned int udma_mask;
403 unsigned int cbl; /* cable type; ATA_CBL_xxx */
404 unsigned int sata_spd_limit; /* SATA PHY speed limit */
406 struct ata_device device[ATA_MAX_DEVICES];
408 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
409 unsigned long qactive;
410 unsigned int active_tag;
412 struct ata_host_stats stats;
413 struct ata_host_set *host_set;
416 struct work_struct port_task;
418 unsigned int hsm_task_state;
421 struct list_head eh_done_q;
426 struct ata_port_operations {
427 void (*port_disable) (struct ata_port *);
429 void (*dev_config) (struct ata_port *, struct ata_device *);
431 void (*set_piomode) (struct ata_port *, struct ata_device *);
432 void (*set_dmamode) (struct ata_port *, struct ata_device *);
433 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
435 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
436 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
438 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
439 u8 (*check_status)(struct ata_port *ap);
440 u8 (*check_altstatus)(struct ata_port *ap);
441 void (*dev_select)(struct ata_port *ap, unsigned int device);
443 void (*phy_reset) (struct ata_port *ap); /* obsolete */
444 void (*set_mode) (struct ata_port *ap);
445 int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
447 void (*post_set_mode) (struct ata_port *ap);
449 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
451 void (*bmdma_setup) (struct ata_queued_cmd *qc);
452 void (*bmdma_start) (struct ata_queued_cmd *qc);
454 void (*qc_prep) (struct ata_queued_cmd *qc);
455 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
457 void (*eng_timeout) (struct ata_port *ap);
459 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
460 void (*irq_clear) (struct ata_port *);
462 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
463 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
466 int (*port_start) (struct ata_port *ap);
467 void (*port_stop) (struct ata_port *ap);
469 void (*host_stop) (struct ata_host_set *host_set);
471 void (*bmdma_stop) (struct ata_queued_cmd *qc);
472 u8 (*bmdma_status) (struct ata_port *ap);
475 struct ata_port_info {
476 struct scsi_host_template *sht;
477 unsigned long host_flags;
478 unsigned long pio_mask;
479 unsigned long mwdma_mask;
480 unsigned long udma_mask;
481 const struct ata_port_operations *port_ops;
486 unsigned short mode; /* ATA mode */
487 unsigned short setup; /* t1 */
488 unsigned short act8b; /* t2 for 8-bit I/O */
489 unsigned short rec8b; /* t2i for 8-bit I/O */
490 unsigned short cyc8b; /* t0 for 8-bit I/O */
491 unsigned short active; /* t2 or tD */
492 unsigned short recover; /* t2i or tK */
493 unsigned short cycle; /* t0 */
494 unsigned short udma; /* t2CYCTYP/2 */
497 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
499 extern void ata_port_probe(struct ata_port *);
500 extern void __sata_phy_reset(struct ata_port *ap);
501 extern void sata_phy_reset(struct ata_port *ap);
502 extern void ata_bus_reset(struct ata_port *ap);
503 extern int ata_drive_probe_reset(struct ata_port *ap,
504 ata_probeinit_fn_t probeinit,
505 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
506 ata_postreset_fn_t postreset, unsigned int *classes);
507 extern void ata_std_probeinit(struct ata_port *ap);
508 extern int ata_std_softreset(struct ata_port *ap, int verbose,
509 unsigned int *classes);
510 extern int sata_std_hardreset(struct ata_port *ap, int verbose,
511 unsigned int *class);
512 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
513 extern int ata_dev_revalidate(struct ata_port *ap, struct ata_device *dev,
515 extern void ata_port_disable(struct ata_port *);
516 extern void ata_std_ports(struct ata_ioports *ioaddr);
518 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
519 unsigned int n_ports);
520 extern void ata_pci_remove_one (struct pci_dev *pdev);
521 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
522 extern int ata_pci_device_resume(struct pci_dev *pdev);
523 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
524 #endif /* CONFIG_PCI */
525 extern int ata_device_add(const struct ata_probe_ent *ent);
526 extern void ata_host_set_remove(struct ata_host_set *host_set);
527 extern int ata_scsi_detect(struct scsi_host_template *sht);
528 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
529 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
530 extern int ata_scsi_release(struct Scsi_Host *host);
531 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
532 extern int ata_scsi_device_resume(struct scsi_device *);
533 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
534 extern int ata_device_resume(struct ata_port *, struct ata_device *);
535 extern int ata_device_suspend(struct ata_port *, struct ata_device *, pm_message_t state);
536 extern int ata_ratelimit(void);
537 extern unsigned int ata_busy_sleep(struct ata_port *ap,
538 unsigned long timeout_pat,
539 unsigned long timeout);
540 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
541 void *data, unsigned long delay);
544 * Default driver ops implementations
546 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
547 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
548 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
549 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
550 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
551 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
552 extern u8 ata_check_status(struct ata_port *ap);
553 extern u8 ata_altstatus(struct ata_port *ap);
554 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
555 extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
556 extern int ata_port_start (struct ata_port *ap);
557 extern void ata_port_stop (struct ata_port *ap);
558 extern void ata_host_stop (struct ata_host_set *host_set);
559 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
560 extern void ata_qc_prep(struct ata_queued_cmd *qc);
561 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
562 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
563 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
564 unsigned int buflen);
565 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
566 unsigned int n_elem);
567 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
568 extern void ata_id_string(const u16 *id, unsigned char *s,
569 unsigned int ofs, unsigned int len);
570 extern void ata_id_c_string(const u16 *id, unsigned char *s,
571 unsigned int ofs, unsigned int len);
572 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
573 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
574 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
575 extern u8 ata_bmdma_status(struct ata_port *ap);
576 extern void ata_bmdma_irq_clear(struct ata_port *ap);
577 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
578 extern void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
579 struct scsi_cmnd *cmd,
580 void (*done)(struct scsi_cmnd *));
581 extern int ata_std_bios_param(struct scsi_device *sdev,
582 struct block_device *bdev,
583 sector_t capacity, int geom[]);
584 extern int ata_scsi_slave_config(struct scsi_device *sdev);
585 extern struct ata_device *ata_dev_pair(struct ata_port *ap,
586 struct ata_device *adev);
592 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
593 extern int ata_timing_compute(struct ata_device *, unsigned short,
594 struct ata_timing *, int, int);
595 extern void ata_timing_merge(const struct ata_timing *,
596 const struct ata_timing *, struct ata_timing *,
600 ATA_TIMING_SETUP = (1 << 0),
601 ATA_TIMING_ACT8B = (1 << 1),
602 ATA_TIMING_REC8B = (1 << 2),
603 ATA_TIMING_CYC8B = (1 << 3),
604 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
606 ATA_TIMING_ACTIVE = (1 << 4),
607 ATA_TIMING_RECOVER = (1 << 5),
608 ATA_TIMING_CYCLE = (1 << 6),
609 ATA_TIMING_UDMA = (1 << 7),
610 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
611 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
612 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
613 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
619 unsigned int reg; /* PCI config register to read */
620 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
625 extern void ata_pci_host_stop (struct ata_host_set *host_set);
626 extern struct ata_probe_ent *
627 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
628 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
629 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
630 #endif /* CONFIG_PCI */
635 extern int ata_scsi_error(struct Scsi_Host *host);
636 extern void ata_eng_timeout(struct ata_port *ap);
637 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
638 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
642 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
644 if (sg == &qc->pad_sgent)
648 if (((sg - qc->__sg) + 1) == qc->n_elem)
653 static inline struct scatterlist *
654 ata_qc_first_sg(struct ata_queued_cmd *qc)
659 return &qc->pad_sgent;
663 static inline struct scatterlist *
664 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
666 if (sg == &qc->pad_sgent)
668 if (++sg - qc->__sg < qc->n_elem)
671 return &qc->pad_sgent;
675 #define ata_for_each_sg(sg, qc) \
676 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
678 static inline unsigned int ata_tag_valid(unsigned int tag)
680 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
683 static inline unsigned int ata_class_enabled(unsigned int class)
685 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
688 static inline unsigned int ata_class_disabled(unsigned int class)
690 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
693 static inline unsigned int ata_class_absent(unsigned int class)
695 return !ata_class_enabled(class) && !ata_class_disabled(class);
698 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
700 return ata_class_enabled(dev->class);
703 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
705 return ata_class_disabled(dev->class);
708 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
710 return ata_class_absent(dev->class);
713 static inline u8 ata_chk_status(struct ata_port *ap)
715 return ap->ops->check_status(ap);
720 * ata_pause - Flush writes and pause 400 nanoseconds.
721 * @ap: Port to wait for.
724 * Inherited from caller.
727 static inline void ata_pause(struct ata_port *ap)
735 * ata_busy_wait - Wait for a port status register
736 * @ap: Port to wait for.
738 * Waits up to max*10 microseconds for the selected bits in the port's
739 * status register to be cleared.
740 * Returns final value of status register.
743 * Inherited from caller.
746 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
753 status = ata_chk_status(ap);
755 } while ((status & bits) && (max > 0));
762 * ata_wait_idle - Wait for a port to be idle.
763 * @ap: Port to wait for.
765 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
766 * Returns final value of status register.
769 * Inherited from caller.
772 static inline u8 ata_wait_idle(struct ata_port *ap)
774 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
776 if (status & (ATA_BUSY | ATA_DRQ)) {
777 unsigned long l = ap->ioaddr.status_addr;
778 if (ata_msg_warn(ap))
779 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
786 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
788 qc->tf.ctl |= ATA_NIEN;
791 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
794 if (likely(ata_tag_valid(tag)))
795 return &ap->qcmd[tag];
799 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
801 memset(tf, 0, sizeof(*tf));
805 tf->device = ATA_DEVICE_OBS;
807 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
810 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
814 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
816 qc->nbytes = qc->curbytes = 0;
819 ata_tf_init(qc->ap, &qc->tf, qc->dev->devno);
823 * ata_qc_complete - Complete an active ATA command
824 * @qc: Command to complete
825 * @err_mask: ATA Status register contents
827 * Indicate to the mid and upper layers that an ATA
828 * command has completed, with either an ok or not-ok status.
831 * spin_lock_irqsave(host_set lock)
833 static inline void ata_qc_complete(struct ata_queued_cmd *qc)
835 if (unlikely(qc->flags & ATA_QCFLAG_EH_SCHEDULED))
838 __ata_qc_complete(qc);
842 * ata_irq_on - Enable interrupts on a port.
843 * @ap: Port on which interrupts are enabled.
845 * Enable interrupts on a legacy IDE device using MMIO or PIO,
846 * wait for idle, clear any pending interrupts.
849 * Inherited from caller.
852 static inline u8 ata_irq_on(struct ata_port *ap)
854 struct ata_ioports *ioaddr = &ap->ioaddr;
857 ap->ctl &= ~ATA_NIEN;
858 ap->last_ctl = ap->ctl;
860 if (ap->flags & ATA_FLAG_MMIO)
861 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
863 outb(ap->ctl, ioaddr->ctl_addr);
864 tmp = ata_wait_idle(ap);
866 ap->ops->irq_clear(ap);
873 * ata_irq_ack - Acknowledge a device interrupt.
874 * @ap: Port on which interrupts are enabled.
876 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
877 * or BUSY+DRQ clear). Obtain dma status and port status from
878 * device. Clear the interrupt. Return port status.
883 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
885 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
886 u8 host_stat, post_stat, status;
888 status = ata_busy_wait(ap, bits, 1000);
891 printk(KERN_ERR "abnormal status 0x%X\n", status);
893 /* get controller status; clear intr, err bits */
894 if (ap->flags & ATA_FLAG_MMIO) {
895 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
896 host_stat = readb(mmio + ATA_DMA_STATUS);
897 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
898 mmio + ATA_DMA_STATUS);
900 post_stat = readb(mmio + ATA_DMA_STATUS);
902 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
903 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
904 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
906 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
909 if (ata_msg_intr(ap))
910 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
912 host_stat, post_stat, status);
917 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
919 return ap->ops->scr_read(ap, reg);
922 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
924 ap->ops->scr_write(ap, reg, val);
927 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
930 ap->ops->scr_write(ap, reg, val);
931 (void) ap->ops->scr_read(ap, reg);
934 static inline unsigned int sata_dev_present(struct ata_port *ap)
936 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
939 static inline int ata_try_flush_cache(const struct ata_device *dev)
941 return ata_id_wcache_enabled(dev->id) ||
942 ata_id_has_flush(dev->id) ||
943 ata_id_has_flush_ext(dev->id);
946 static inline unsigned int ac_err_mask(u8 status)
948 if (status & ATA_BUSY)
950 if (status & (ATA_ERR | ATA_DF))
955 static inline unsigned int __ac_err_mask(u8 status)
957 unsigned int mask = ac_err_mask(status);
963 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
966 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
967 &ap->pad_dma, GFP_KERNEL);
968 return (ap->pad == NULL) ? -ENOMEM : 0;
971 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
973 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
976 #endif /* __LINUX_LIBATA_H__ */