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>
33 #include <linux/ata.h>
34 #include <linux/workqueue.h>
37 * compile-time options
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 */
49 /* note: prints function name for you */
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)
55 #define VPRINTK(fmt, args...)
56 #endif /* ATA_VERBOSE_DEBUG */
58 #define DPRINTK(fmt, args...)
59 #define VPRINTK(fmt, args...)
60 #endif /* ATA_DEBUG */
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__); \
72 /* defines only for the constants which don't work well as enums */
73 #define ATA_TAG_POISON 0xfafbfcfdU
75 /* move to PCI layer? */
76 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
82 /* various global constants */
83 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
87 ATA_MAX_SECTORS = 200, /* FIXME */
89 ATA_DEF_BUSY_WAIT = 10000,
90 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
93 ATA_SHT_CMD_PER_LUN = 1,
95 ATA_SHT_USE_CLUSTERING = 0,
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 */
102 ATA_DEV_UNKNOWN = 0, /* unknown device */
103 ATA_DEV_ATA = 1, /* ATA device */
104 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
105 ATA_DEV_ATAPI = 3, /* ATAPI device */
106 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
107 ATA_DEV_NONE = 5, /* no device */
109 /* struct ata_port flags */
110 ATA_FLAG_SLAVE_POSS = (1 << 1), /* host supports slave dev */
111 /* (doesn't imply presence) */
112 ATA_FLAG_PORT_DISABLED = (1 << 2), /* port is disabled, ignore it */
113 ATA_FLAG_SATA = (1 << 3),
114 ATA_FLAG_NO_LEGACY = (1 << 4), /* no legacy mode check */
115 ATA_FLAG_SRST = (1 << 5), /* use ATA SRST, not E.D.D. */
116 ATA_FLAG_MMIO = (1 << 6), /* use MMIO, not PIO */
117 ATA_FLAG_SATA_RESET = (1 << 7), /* use COMRESET */
118 ATA_FLAG_PIO_DMA = (1 << 8), /* PIO cmds via DMA */
120 ATA_QCFLAG_ACTIVE = (1 << 1), /* cmd not yet ack'd to scsi lyer */
121 ATA_QCFLAG_SG = (1 << 3), /* have s/g table? */
122 ATA_QCFLAG_SINGLE = (1 << 4), /* no s/g, just a single buffer */
123 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
125 /* various lengths of time */
126 ATA_TMOUT_EDD = 5 * HZ, /* hueristic */
127 ATA_TMOUT_PIO = 30 * HZ,
128 ATA_TMOUT_BOOT = 30 * HZ, /* hueristic */
129 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* hueristic */
130 ATA_TMOUT_CDB = 30 * HZ,
131 ATA_TMOUT_CDB_QUICK = 5 * HZ,
145 /* SATA port states */
150 /* encoding various smaller bitmaps into a single
151 * unsigned long bitmap
158 enum pio_task_states {
169 /* forward declarations */
171 struct ata_port_operations;
173 struct ata_queued_cmd;
176 typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, u8 drv_stat);
179 unsigned long cmd_addr;
180 unsigned long data_addr;
181 unsigned long error_addr;
182 unsigned long feature_addr;
183 unsigned long nsect_addr;
184 unsigned long lbal_addr;
185 unsigned long lbam_addr;
186 unsigned long lbah_addr;
187 unsigned long device_addr;
188 unsigned long status_addr;
189 unsigned long command_addr;
190 unsigned long altstatus_addr;
191 unsigned long ctl_addr;
192 unsigned long bmdma_addr;
193 unsigned long scr_addr;
196 struct ata_probe_ent {
197 struct list_head node;
199 struct ata_port_operations *port_ops;
200 Scsi_Host_Template *sht;
201 struct ata_ioports port[ATA_MAX_PORTS];
202 unsigned int n_ports;
203 unsigned int hard_port_no;
204 unsigned int pio_mask;
205 unsigned int mwdma_mask;
206 unsigned int udma_mask;
207 unsigned int legacy_mode;
209 unsigned int irq_flags;
210 unsigned long host_flags;
211 void __iomem *mmio_base;
215 struct ata_host_set {
219 void __iomem *mmio_base;
220 unsigned int n_ports;
222 struct ata_port_operations *ops;
223 struct ata_port * ports[0];
226 struct ata_queued_cmd {
228 struct ata_device *dev;
230 struct scsi_cmnd *scsicmd;
231 void (*scsidone)(struct scsi_cmnd *);
233 struct ata_taskfile tf;
234 u8 cdb[ATAPI_CDB_LEN];
236 unsigned long flags; /* ATA_QCFLAG_xxx */
243 unsigned int cursect;
246 unsigned int curbytes;
249 unsigned int cursg_ofs;
251 struct scatterlist sgent;
254 struct scatterlist *sg;
256 ata_qc_cb_t complete_fn;
258 struct completion *waiting;
263 struct ata_host_stats {
264 unsigned long unhandled_irq;
265 unsigned long idle_irq;
266 unsigned long rw_reqbuf;
270 u64 n_sectors; /* size of device, if ATA */
271 unsigned long flags; /* ATA_DFLAG_xxx */
272 unsigned int class; /* ATA_DEV_xxx */
273 unsigned int devno; /* 0 or 1 */
274 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
278 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
280 /* cache info about current transfer mode */
281 u8 xfer_protocol; /* taskfile xfer protocol */
282 u8 read_cmd; /* opcode to use on read */
283 u8 write_cmd; /* opcode to use on write */
287 struct Scsi_Host *host; /* our co-allocated scsi host */
288 struct ata_port_operations *ops;
289 unsigned long flags; /* ATA_FLAG_xxx */
290 unsigned int id; /* unique id req'd by scsi midlyr */
291 unsigned int port_no; /* unique port #; from zero */
292 unsigned int hard_port_no; /* hardware port #; from zero */
294 struct ata_prd *prd; /* our SG list */
295 dma_addr_t prd_dma; /* and its DMA mapping */
297 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
299 u8 ctl; /* cache of ATA control register */
300 u8 last_ctl; /* Cache last written value */
301 unsigned int bus_state;
302 unsigned int port_state;
303 unsigned int pio_mask;
304 unsigned int mwdma_mask;
305 unsigned int udma_mask;
306 unsigned int cbl; /* cable type; ATA_CBL_xxx */
307 unsigned int cdb_len;
309 struct ata_device device[ATA_MAX_DEVICES];
311 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
312 unsigned long qactive;
313 unsigned int active_tag;
315 struct ata_host_stats stats;
316 struct ata_host_set *host_set;
318 struct work_struct packet_task;
320 struct work_struct pio_task;
321 unsigned int pio_task_state;
322 unsigned long pio_task_timeout;
327 struct ata_port_operations {
328 void (*port_disable) (struct ata_port *);
330 void (*dev_config) (struct ata_port *, struct ata_device *);
332 void (*set_piomode) (struct ata_port *, struct ata_device *);
333 void (*set_dmamode) (struct ata_port *, struct ata_device *);
335 void (*tf_load) (struct ata_port *ap, struct ata_taskfile *tf);
336 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
338 void (*exec_command)(struct ata_port *ap, struct ata_taskfile *tf);
339 u8 (*check_status)(struct ata_port *ap);
340 u8 (*check_altstatus)(struct ata_port *ap);
341 u8 (*check_err)(struct ata_port *ap);
342 void (*dev_select)(struct ata_port *ap, unsigned int device);
344 void (*phy_reset) (struct ata_port *ap);
345 void (*post_set_mode) (struct ata_port *ap);
347 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
349 void (*bmdma_setup) (struct ata_queued_cmd *qc);
350 void (*bmdma_start) (struct ata_queued_cmd *qc);
352 void (*qc_prep) (struct ata_queued_cmd *qc);
353 int (*qc_issue) (struct ata_queued_cmd *qc);
355 void (*eng_timeout) (struct ata_port *ap);
357 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
358 void (*irq_clear) (struct ata_port *);
360 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
361 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
364 int (*port_start) (struct ata_port *ap);
365 void (*port_stop) (struct ata_port *ap);
367 void (*host_stop) (struct ata_host_set *host_set);
369 void (*bmdma_stop) (struct ata_port *ap);
370 u8 (*bmdma_status) (struct ata_port *ap);
373 struct ata_port_info {
374 Scsi_Host_Template *sht;
375 unsigned long host_flags;
376 unsigned long pio_mask;
377 unsigned long mwdma_mask;
378 unsigned long udma_mask;
379 struct ata_port_operations *port_ops;
383 extern void ata_port_probe(struct ata_port *);
384 extern void __sata_phy_reset(struct ata_port *ap);
385 extern void sata_phy_reset(struct ata_port *ap);
386 extern void ata_bus_reset(struct ata_port *ap);
387 extern void ata_port_disable(struct ata_port *);
388 extern void ata_std_ports(struct ata_ioports *ioaddr);
390 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
391 unsigned int n_ports);
392 extern void ata_pci_remove_one (struct pci_dev *pdev);
393 #endif /* CONFIG_PCI */
394 extern int ata_device_add(struct ata_probe_ent *ent);
395 extern int ata_scsi_detect(Scsi_Host_Template *sht);
396 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
397 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
398 extern int ata_scsi_error(struct Scsi_Host *host);
399 extern int ata_scsi_release(struct Scsi_Host *host);
400 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
402 * Default driver ops implementations
404 extern void ata_tf_load(struct ata_port *ap, struct ata_taskfile *tf);
405 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
406 extern void ata_tf_to_fis(struct ata_taskfile *tf, u8 *fis, u8 pmp);
407 extern void ata_tf_from_fis(u8 *fis, struct ata_taskfile *tf);
408 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
409 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
410 extern u8 ata_check_status(struct ata_port *ap);
411 extern u8 ata_altstatus(struct ata_port *ap);
412 extern u8 ata_chk_err(struct ata_port *ap);
413 extern void ata_exec_command(struct ata_port *ap, struct ata_taskfile *tf);
414 extern int ata_port_start (struct ata_port *ap);
415 extern void ata_port_stop (struct ata_port *ap);
416 extern void ata_host_stop (struct ata_host_set *host_set);
417 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
418 extern void ata_qc_prep(struct ata_queued_cmd *qc);
419 extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
420 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
421 unsigned int buflen);
422 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
423 unsigned int n_elem);
424 extern unsigned int ata_dev_classify(struct ata_taskfile *tf);
425 extern void ata_dev_id_string(u16 *id, unsigned char *s,
426 unsigned int ofs, unsigned int len);
427 extern void ata_dev_config(struct ata_port *ap, unsigned int i);
428 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
429 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
430 extern void ata_bmdma_stop(struct ata_port *ap);
431 extern u8 ata_bmdma_status(struct ata_port *ap);
432 extern void ata_bmdma_irq_clear(struct ata_port *ap);
433 extern void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat);
434 extern void ata_eng_timeout(struct ata_port *ap);
435 extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
436 void (*done)(struct scsi_cmnd *));
437 extern int ata_std_bios_param(struct scsi_device *sdev,
438 struct block_device *bdev,
439 sector_t capacity, int geom[]);
440 extern int ata_scsi_slave_config(struct scsi_device *sdev);
445 unsigned int reg; /* PCI config register to read */
446 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
451 extern struct ata_probe_ent *
452 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port);
453 extern int pci_test_config_bits(struct pci_dev *pdev, struct pci_bits *bits);
455 #endif /* CONFIG_PCI */
458 static inline unsigned int ata_tag_valid(unsigned int tag)
460 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
463 static inline unsigned int ata_dev_present(struct ata_device *dev)
465 return ((dev->class == ATA_DEV_ATA) ||
466 (dev->class == ATA_DEV_ATAPI));
469 static inline u8 ata_chk_status(struct ata_port *ap)
471 return ap->ops->check_status(ap);
476 * ata_pause - Flush writes and pause 400 nanoseconds.
477 * @ap: Port to wait for.
480 * Inherited from caller.
483 static inline void ata_pause(struct ata_port *ap)
491 * ata_busy_wait - Wait for a port status register
492 * @ap: Port to wait for.
494 * Waits up to max*10 microseconds for the selected bits in the port's
495 * status register to be cleared.
496 * Returns final value of status register.
499 * Inherited from caller.
502 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
509 status = ata_chk_status(ap);
511 } while ((status & bits) && (max > 0));
518 * ata_wait_idle - Wait for a port to be idle.
519 * @ap: Port to wait for.
521 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
522 * Returns final value of status register.
525 * Inherited from caller.
528 static inline u8 ata_wait_idle(struct ata_port *ap)
530 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
532 if (status & (ATA_BUSY | ATA_DRQ)) {
533 unsigned long l = ap->ioaddr.status_addr;
535 "ATA: abnormal status 0x%X on port 0x%lX\n",
542 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
544 qc->tf.ctl |= ATA_NIEN;
547 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
550 if (likely(ata_tag_valid(tag)))
551 return &ap->qcmd[tag];
555 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
557 memset(tf, 0, sizeof(*tf));
561 tf->device = ATA_DEVICE_OBS;
563 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
568 * ata_irq_on - Enable interrupts on a port.
569 * @ap: Port on which interrupts are enabled.
571 * Enable interrupts on a legacy IDE device using MMIO or PIO,
572 * wait for idle, clear any pending interrupts.
575 * Inherited from caller.
578 static inline u8 ata_irq_on(struct ata_port *ap)
580 struct ata_ioports *ioaddr = &ap->ioaddr;
583 ap->ctl &= ~ATA_NIEN;
584 ap->last_ctl = ap->ctl;
586 if (ap->flags & ATA_FLAG_MMIO)
587 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
589 outb(ap->ctl, ioaddr->ctl_addr);
590 tmp = ata_wait_idle(ap);
592 ap->ops->irq_clear(ap);
599 * ata_irq_ack - Acknowledge a device interrupt.
600 * @ap: Port on which interrupts are enabled.
602 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
603 * or BUSY+DRQ clear). Obtain dma status and port status from
604 * device. Clear the interrupt. Return port status.
609 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
611 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
612 u8 host_stat, post_stat, status;
614 status = ata_busy_wait(ap, bits, 1000);
616 DPRINTK("abnormal status 0x%X\n", status);
618 /* get controller status; clear intr, err bits */
619 if (ap->flags & ATA_FLAG_MMIO) {
620 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
621 host_stat = readb(mmio + ATA_DMA_STATUS);
622 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
623 mmio + ATA_DMA_STATUS);
625 post_stat = readb(mmio + ATA_DMA_STATUS);
627 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
628 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
629 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
631 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
634 VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
635 host_stat, post_stat, status);
640 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
642 return ap->ops->scr_read(ap, reg);
645 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
647 ap->ops->scr_write(ap, reg, val);
650 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
653 ap->ops->scr_write(ap, reg, val);
654 (void) ap->ops->scr_read(ap, reg);
657 static inline unsigned int sata_dev_present(struct ata_port *ap)
659 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
662 static inline int ata_try_flush_cache(struct ata_device *dev)
664 return ata_id_wcache_enabled(dev->id) ||
665 ata_id_has_flush(dev->id) ||
666 ata_id_has_flush_ext(dev->id);
669 #endif /* __LINUX_LIBATA_H__ */