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_PATA /* define to enable PATA support in some
44 * low-level drivers */
45 #undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */
48 /* note: prints function name for you */
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)
54 #define VPRINTK(fmt, args...)
55 #endif /* ATA_VERBOSE_DEBUG */
57 #define DPRINTK(fmt, args...)
58 #define VPRINTK(fmt, args...)
59 #endif /* ATA_DEBUG */
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__); \
71 /* defines only for the constants which don't work well as enums */
72 #define ATA_TAG_POISON 0xfafbfcfdU
74 /* move to PCI layer? */
75 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
81 /* various global constants */
82 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
86 ATA_MAX_SECTORS = 200, /* FIXME */
88 ATA_DEF_BUSY_WAIT = 10000,
89 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
92 ATA_SHT_CMD_PER_LUN = 1,
94 ATA_SHT_USE_CLUSTERING = 0,
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 */
101 ATA_DEV_UNKNOWN = 0, /* unknown device */
102 ATA_DEV_ATA = 1, /* ATA device */
103 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
104 ATA_DEV_ATAPI = 3, /* ATAPI device */
105 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
106 ATA_DEV_NONE = 5, /* no device */
108 /* struct ata_port flags */
109 ATA_FLAG_SLAVE_POSS = (1 << 1), /* host supports slave dev */
110 /* (doesn't imply presence) */
111 ATA_FLAG_PORT_DISABLED = (1 << 2), /* port is disabled, ignore it */
112 ATA_FLAG_SATA = (1 << 3),
113 ATA_FLAG_NO_LEGACY = (1 << 4), /* no legacy mode check */
114 ATA_FLAG_SRST = (1 << 5), /* use ATA SRST, not E.D.D. */
115 ATA_FLAG_MMIO = (1 << 6), /* use MMIO, not PIO */
116 ATA_FLAG_SATA_RESET = (1 << 7), /* use COMRESET */
117 ATA_FLAG_PIO_DMA = (1 << 8), /* PIO cmds via DMA */
118 ATA_FLAG_NOINTR = (1 << 9), /* FIXME: Remove this once
119 * proper HSM is in place. */
121 ATA_QCFLAG_ACTIVE = (1 << 1), /* cmd not yet ack'd to scsi lyer */
122 ATA_QCFLAG_SG = (1 << 3), /* have s/g table? */
123 ATA_QCFLAG_SINGLE = (1 << 4), /* no s/g, just a single buffer */
124 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
126 /* various lengths of time */
127 ATA_TMOUT_EDD = 5 * HZ, /* hueristic */
128 ATA_TMOUT_PIO = 30 * HZ,
129 ATA_TMOUT_BOOT = 30 * HZ, /* hueristic */
130 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* hueristic */
131 ATA_TMOUT_CDB = 30 * HZ,
132 ATA_TMOUT_CDB_QUICK = 5 * HZ,
146 /* SATA port states */
151 /* encoding various smaller bitmaps into a single
152 * unsigned long bitmap
158 /* size of buffer to pad xfers ending on unaligned boundaries */
160 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
163 enum pio_task_states {
174 /* forward declarations */
176 struct ata_port_operations;
178 struct ata_queued_cmd;
181 typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, u8 drv_stat);
184 unsigned long cmd_addr;
185 unsigned long data_addr;
186 unsigned long error_addr;
187 unsigned long feature_addr;
188 unsigned long nsect_addr;
189 unsigned long lbal_addr;
190 unsigned long lbam_addr;
191 unsigned long lbah_addr;
192 unsigned long device_addr;
193 unsigned long status_addr;
194 unsigned long command_addr;
195 unsigned long altstatus_addr;
196 unsigned long ctl_addr;
197 unsigned long bmdma_addr;
198 unsigned long scr_addr;
201 struct ata_probe_ent {
202 struct list_head node;
204 struct ata_port_operations *port_ops;
205 Scsi_Host_Template *sht;
206 struct ata_ioports port[ATA_MAX_PORTS];
207 unsigned int n_ports;
208 unsigned int hard_port_no;
209 unsigned int pio_mask;
210 unsigned int mwdma_mask;
211 unsigned int udma_mask;
212 unsigned int legacy_mode;
214 unsigned int irq_flags;
215 unsigned long host_flags;
216 void __iomem *mmio_base;
220 struct ata_host_set {
224 void __iomem *mmio_base;
225 unsigned int n_ports;
227 struct ata_port_operations *ops;
228 struct ata_port * ports[0];
231 struct ata_queued_cmd {
233 struct ata_device *dev;
235 struct scsi_cmnd *scsicmd;
236 void (*scsidone)(struct scsi_cmnd *);
238 struct ata_taskfile tf;
239 u8 cdb[ATAPI_CDB_LEN];
241 unsigned long flags; /* ATA_QCFLAG_xxx */
244 unsigned int orig_n_elem;
248 unsigned int pad_len;
251 unsigned int cursect;
254 unsigned int curbytes;
257 unsigned int cursg_ofs;
259 struct scatterlist sgent;
260 struct scatterlist pad_sgent;
263 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
264 struct scatterlist *__sg;
266 ata_qc_cb_t complete_fn;
268 struct completion *waiting;
273 struct ata_host_stats {
274 unsigned long unhandled_irq;
275 unsigned long idle_irq;
276 unsigned long rw_reqbuf;
280 u64 n_sectors; /* size of device, if ATA */
281 unsigned long flags; /* ATA_DFLAG_xxx */
282 unsigned int class; /* ATA_DEV_xxx */
283 unsigned int devno; /* 0 or 1 */
284 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
288 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
290 /* cache info about current transfer mode */
291 u8 xfer_protocol; /* taskfile xfer protocol */
292 u8 read_cmd; /* opcode to use on read */
293 u8 write_cmd; /* opcode to use on write */
297 struct Scsi_Host *host; /* our co-allocated scsi host */
298 struct ata_port_operations *ops;
299 unsigned long flags; /* ATA_FLAG_xxx */
300 unsigned int id; /* unique id req'd by scsi midlyr */
301 unsigned int port_no; /* unique port #; from zero */
302 unsigned int hard_port_no; /* hardware port #; from zero */
304 struct ata_prd *prd; /* our SG list */
305 dma_addr_t prd_dma; /* and its DMA mapping */
307 void *pad; /* array of DMA pad buffers */
310 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
312 u8 ctl; /* cache of ATA control register */
313 u8 last_ctl; /* Cache last written value */
314 unsigned int bus_state;
315 unsigned int port_state;
316 unsigned int pio_mask;
317 unsigned int mwdma_mask;
318 unsigned int udma_mask;
319 unsigned int cbl; /* cable type; ATA_CBL_xxx */
320 unsigned int cdb_len;
322 struct ata_device device[ATA_MAX_DEVICES];
324 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
325 unsigned long qactive;
326 unsigned int active_tag;
328 struct ata_host_stats stats;
329 struct ata_host_set *host_set;
331 struct work_struct packet_task;
333 struct work_struct pio_task;
334 unsigned int pio_task_state;
335 unsigned long pio_task_timeout;
340 struct ata_port_operations {
341 void (*port_disable) (struct ata_port *);
343 void (*dev_config) (struct ata_port *, struct ata_device *);
345 void (*set_piomode) (struct ata_port *, struct ata_device *);
346 void (*set_dmamode) (struct ata_port *, struct ata_device *);
348 void (*tf_load) (struct ata_port *ap, struct ata_taskfile *tf);
349 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
351 void (*exec_command)(struct ata_port *ap, struct ata_taskfile *tf);
352 u8 (*check_status)(struct ata_port *ap);
353 u8 (*check_altstatus)(struct ata_port *ap);
354 u8 (*check_err)(struct ata_port *ap);
355 void (*dev_select)(struct ata_port *ap, unsigned int device);
357 void (*phy_reset) (struct ata_port *ap);
358 void (*post_set_mode) (struct ata_port *ap);
360 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
362 void (*bmdma_setup) (struct ata_queued_cmd *qc);
363 void (*bmdma_start) (struct ata_queued_cmd *qc);
365 void (*qc_prep) (struct ata_queued_cmd *qc);
366 int (*qc_issue) (struct ata_queued_cmd *qc);
368 void (*eng_timeout) (struct ata_port *ap);
370 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
371 void (*irq_clear) (struct ata_port *);
373 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
374 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
377 int (*port_start) (struct ata_port *ap);
378 void (*port_stop) (struct ata_port *ap);
380 void (*host_stop) (struct ata_host_set *host_set);
382 void (*bmdma_stop) (struct ata_queued_cmd *qc);
383 u8 (*bmdma_status) (struct ata_port *ap);
386 struct ata_port_info {
387 Scsi_Host_Template *sht;
388 unsigned long host_flags;
389 unsigned long pio_mask;
390 unsigned long mwdma_mask;
391 unsigned long udma_mask;
392 struct ata_port_operations *port_ops;
396 extern void ata_port_probe(struct ata_port *);
397 extern void __sata_phy_reset(struct ata_port *ap);
398 extern void sata_phy_reset(struct ata_port *ap);
399 extern void ata_bus_reset(struct ata_port *ap);
400 extern void ata_port_disable(struct ata_port *);
401 extern void ata_std_ports(struct ata_ioports *ioaddr);
403 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
404 unsigned int n_ports);
405 extern void ata_pci_remove_one (struct pci_dev *pdev);
406 #endif /* CONFIG_PCI */
407 extern int ata_device_add(struct ata_probe_ent *ent);
408 extern void ata_host_set_remove(struct ata_host_set *host_set);
409 extern int ata_scsi_detect(Scsi_Host_Template *sht);
410 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
411 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
412 extern int ata_scsi_error(struct Scsi_Host *host);
413 extern int ata_scsi_release(struct Scsi_Host *host);
414 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
416 * Default driver ops implementations
418 extern void ata_tf_load(struct ata_port *ap, struct ata_taskfile *tf);
419 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
420 extern void ata_tf_to_fis(struct ata_taskfile *tf, u8 *fis, u8 pmp);
421 extern void ata_tf_from_fis(u8 *fis, struct ata_taskfile *tf);
422 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
423 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
424 extern u8 ata_check_status(struct ata_port *ap);
425 extern u8 ata_altstatus(struct ata_port *ap);
426 extern u8 ata_chk_err(struct ata_port *ap);
427 extern void ata_exec_command(struct ata_port *ap, struct ata_taskfile *tf);
428 extern int ata_port_start (struct ata_port *ap);
429 extern void ata_port_stop (struct ata_port *ap);
430 extern void ata_host_stop (struct ata_host_set *host_set);
431 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
432 extern void ata_qc_prep(struct ata_queued_cmd *qc);
433 extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
434 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
435 unsigned int buflen);
436 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
437 unsigned int n_elem);
438 extern unsigned int ata_dev_classify(struct ata_taskfile *tf);
439 extern void ata_dev_id_string(u16 *id, unsigned char *s,
440 unsigned int ofs, unsigned int len);
441 extern void ata_dev_config(struct ata_port *ap, unsigned int i);
442 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
443 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
444 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
445 extern u8 ata_bmdma_status(struct ata_port *ap);
446 extern void ata_bmdma_irq_clear(struct ata_port *ap);
447 extern void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat);
448 extern void ata_eng_timeout(struct ata_port *ap);
449 extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
450 void (*done)(struct scsi_cmnd *));
451 extern int ata_std_bios_param(struct scsi_device *sdev,
452 struct block_device *bdev,
453 sector_t capacity, int geom[]);
454 extern int ata_scsi_slave_config(struct scsi_device *sdev);
459 unsigned int reg; /* PCI config register to read */
460 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
465 extern void ata_pci_host_stop (struct ata_host_set *host_set);
466 extern struct ata_probe_ent *
467 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port);
468 extern int pci_test_config_bits(struct pci_dev *pdev, struct pci_bits *bits);
470 #endif /* CONFIG_PCI */
473 static inline struct scatterlist *
474 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
476 if (sg == &qc->pad_sgent)
478 if (++sg - qc->__sg < qc->n_elem)
480 return qc->pad_len ? &qc->pad_sgent : NULL;
483 #define ata_for_each_sg(sg, qc) \
484 for (sg = qc->__sg; sg; sg = ata_qc_next_sg(sg, qc))
486 static inline unsigned int ata_tag_valid(unsigned int tag)
488 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
491 static inline unsigned int ata_dev_present(struct ata_device *dev)
493 return ((dev->class == ATA_DEV_ATA) ||
494 (dev->class == ATA_DEV_ATAPI));
497 static inline u8 ata_chk_status(struct ata_port *ap)
499 return ap->ops->check_status(ap);
504 * ata_pause - Flush writes and pause 400 nanoseconds.
505 * @ap: Port to wait for.
508 * Inherited from caller.
511 static inline void ata_pause(struct ata_port *ap)
519 * ata_busy_wait - Wait for a port status register
520 * @ap: Port to wait for.
522 * Waits up to max*10 microseconds for the selected bits in the port's
523 * status register to be cleared.
524 * Returns final value of status register.
527 * Inherited from caller.
530 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
537 status = ata_chk_status(ap);
539 } while ((status & bits) && (max > 0));
546 * ata_wait_idle - Wait for a port to be idle.
547 * @ap: Port to wait for.
549 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
550 * Returns final value of status register.
553 * Inherited from caller.
556 static inline u8 ata_wait_idle(struct ata_port *ap)
558 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
560 if (status & (ATA_BUSY | ATA_DRQ)) {
561 unsigned long l = ap->ioaddr.status_addr;
563 "ATA: abnormal status 0x%X on port 0x%lX\n",
570 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
572 qc->tf.ctl |= ATA_NIEN;
575 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
578 if (likely(ata_tag_valid(tag)))
579 return &ap->qcmd[tag];
583 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
585 memset(tf, 0, sizeof(*tf));
589 tf->device = ATA_DEVICE_OBS;
591 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
596 * ata_irq_on - Enable interrupts on a port.
597 * @ap: Port on which interrupts are enabled.
599 * Enable interrupts on a legacy IDE device using MMIO or PIO,
600 * wait for idle, clear any pending interrupts.
603 * Inherited from caller.
606 static inline u8 ata_irq_on(struct ata_port *ap)
608 struct ata_ioports *ioaddr = &ap->ioaddr;
611 ap->ctl &= ~ATA_NIEN;
612 ap->last_ctl = ap->ctl;
614 if (ap->flags & ATA_FLAG_MMIO)
615 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
617 outb(ap->ctl, ioaddr->ctl_addr);
618 tmp = ata_wait_idle(ap);
620 ap->ops->irq_clear(ap);
627 * ata_irq_ack - Acknowledge a device interrupt.
628 * @ap: Port on which interrupts are enabled.
630 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
631 * or BUSY+DRQ clear). Obtain dma status and port status from
632 * device. Clear the interrupt. Return port status.
637 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
639 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
640 u8 host_stat, post_stat, status;
642 status = ata_busy_wait(ap, bits, 1000);
644 DPRINTK("abnormal status 0x%X\n", status);
646 /* get controller status; clear intr, err bits */
647 if (ap->flags & ATA_FLAG_MMIO) {
648 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
649 host_stat = readb(mmio + ATA_DMA_STATUS);
650 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
651 mmio + ATA_DMA_STATUS);
653 post_stat = readb(mmio + ATA_DMA_STATUS);
655 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
656 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
657 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
659 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
662 VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
663 host_stat, post_stat, status);
668 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
670 return ap->ops->scr_read(ap, reg);
673 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
675 ap->ops->scr_write(ap, reg, val);
678 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
681 ap->ops->scr_write(ap, reg, val);
682 (void) ap->ops->scr_read(ap, reg);
685 static inline unsigned int sata_dev_present(struct ata_port *ap)
687 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
690 static inline int ata_try_flush_cache(struct ata_device *dev)
692 return ata_id_wcache_enabled(dev->id) ||
693 ata_id_has_flush(dev->id) ||
694 ata_id_has_flush_ext(dev->id);
697 #endif /* __LINUX_LIBATA_H__ */