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,
111 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
113 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
114 ATA_MAX_SECTORS = 200, /* FIXME */
115 ATA_MAX_SECTORS_LBA48 = 65535,
117 ATA_DEF_BUSY_WAIT = 10000,
118 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
120 ATA_SHT_EMULATED = 1,
121 ATA_SHT_CMD_PER_LUN = 1,
122 ATA_SHT_THIS_ID = -1,
123 ATA_SHT_USE_CLUSTERING = 1,
125 /* struct ata_device stuff */
126 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
127 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
128 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
129 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
130 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
132 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
133 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
135 ATA_DFLAG_DETACH = (1 << 16),
136 ATA_DFLAG_DETACHED = (1 << 17),
138 ATA_DEV_UNKNOWN = 0, /* unknown device */
139 ATA_DEV_ATA = 1, /* ATA device */
140 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
141 ATA_DEV_ATAPI = 3, /* ATAPI device */
142 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
143 ATA_DEV_NONE = 5, /* no device */
145 /* struct ata_port flags */
146 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
147 /* (doesn't imply presence) */
148 ATA_FLAG_SATA = (1 << 1),
149 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
150 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
151 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
152 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
153 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
154 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
155 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
156 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
157 * doesn't handle PIO interrupts */
158 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
159 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
160 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
161 * Register FIS clearing BSY */
163 ATA_FLAG_DEBUGMSG = (1 << 13),
164 ATA_FLAG_FLUSH_PORT_TASK = (1 << 14), /* flush port task */
166 ATA_FLAG_EH_PENDING = (1 << 15), /* EH pending */
167 ATA_FLAG_EH_IN_PROGRESS = (1 << 16), /* EH in progress */
168 ATA_FLAG_FROZEN = (1 << 17), /* port is frozen */
169 ATA_FLAG_RECOVERED = (1 << 18), /* recovery action performed */
170 ATA_FLAG_LOADING = (1 << 19), /* boot/loading probe */
171 ATA_FLAG_UNLOADING = (1 << 20), /* module is unloading */
172 ATA_FLAG_SCSI_HOTPLUG = (1 << 21), /* SCSI hotplug scheduled */
174 ATA_FLAG_DISABLED = (1 << 22), /* port is disabled, ignore it */
175 ATA_FLAG_SUSPENDED = (1 << 23), /* port is suspended (power) */
177 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
179 /* struct ata_queued_cmd flags */
180 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
181 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
182 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
183 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
184 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
185 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
187 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
188 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
189 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
192 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
194 /* various lengths of time */
195 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
196 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
197 ATA_TMOUT_INTERNAL = 30 * HZ,
198 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
212 /* SATA port states */
217 /* encoding various smaller bitmaps into a single
218 * unsigned int bitmap
225 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
226 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
228 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
229 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
230 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
232 /* size of buffer to pad xfers ending on unaligned boundaries */
234 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
236 /* masks for port functions */
237 ATA_PORT_PRIMARY = (1 << 0),
238 ATA_PORT_SECONDARY = (1 << 1),
243 /* desc_len for ata_eh_info and context */
244 ATA_EH_DESC_LEN = 80,
246 /* reset / recovery action types */
247 ATA_EH_REVALIDATE = (1 << 0),
248 ATA_EH_SOFTRESET = (1 << 1),
249 ATA_EH_HARDRESET = (1 << 2),
251 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
253 /* ata_eh_info->flags */
254 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
256 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
258 /* max repeat if error condition is still set after ->error_handler */
259 ATA_EH_MAX_REPEAT = 5,
261 /* how hard are we gonna try to probe/recover devices */
262 ATA_PROBE_MAX_TRIES = 3,
263 ATA_EH_RESET_TRIES = 3,
264 ATA_EH_DEV_TRIES = 3,
266 /* Drive spinup time (time from power-on to the first D2H FIS)
267 * in msecs - 8s currently. Failing to get ready in this time
268 * isn't critical. It will result in reset failure for
269 * controllers which can't wait for the first D2H FIS. libata
270 * will retry, so it just has to be long enough to spin up
273 ATA_SPINUP_WAIT = 8000,
276 enum hsm_task_states {
277 HSM_ST_UNKNOWN, /* state unknown */
278 HSM_ST_IDLE, /* no command on going */
279 HSM_ST, /* (waiting the device to) transfer data */
280 HSM_ST_LAST, /* (waiting the device to) complete command */
281 HSM_ST_ERR, /* error */
282 HSM_ST_FIRST, /* (waiting the device to)
283 write CDB or first data block */
286 enum ata_completion_errors {
287 AC_ERR_DEV = (1 << 0), /* device reported error */
288 AC_ERR_HSM = (1 << 1), /* host state machine violation */
289 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
290 AC_ERR_MEDIA = (1 << 3), /* media error */
291 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
292 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
293 AC_ERR_SYSTEM = (1 << 6), /* system error */
294 AC_ERR_INVALID = (1 << 7), /* invalid argument */
295 AC_ERR_OTHER = (1 << 8), /* unknown */
298 /* forward declarations */
300 struct ata_port_operations;
302 struct ata_queued_cmd;
305 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
306 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
307 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
308 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
311 unsigned long cmd_addr;
312 unsigned long data_addr;
313 unsigned long error_addr;
314 unsigned long feature_addr;
315 unsigned long nsect_addr;
316 unsigned long lbal_addr;
317 unsigned long lbam_addr;
318 unsigned long lbah_addr;
319 unsigned long device_addr;
320 unsigned long status_addr;
321 unsigned long command_addr;
322 unsigned long altstatus_addr;
323 unsigned long ctl_addr;
324 unsigned long bmdma_addr;
325 unsigned long scr_addr;
328 struct ata_probe_ent {
329 struct list_head node;
331 const struct ata_port_operations *port_ops;
332 struct scsi_host_template *sht;
333 struct ata_ioports port[ATA_MAX_PORTS];
334 unsigned int n_ports;
335 unsigned int hard_port_no;
336 unsigned int pio_mask;
337 unsigned int mwdma_mask;
338 unsigned int udma_mask;
339 unsigned int legacy_mode;
341 unsigned int irq_flags;
342 unsigned long host_flags;
343 unsigned long host_set_flags;
344 void __iomem *mmio_base;
348 struct ata_host_set {
352 void __iomem *mmio_base;
353 unsigned int n_ports;
355 const struct ata_port_operations *ops;
357 int simplex_claimed; /* Keep seperate in case we
358 ever need to do this locked */
359 struct ata_host_set *next; /* for legacy mode */
360 struct ata_port *ports[0];
363 struct ata_queued_cmd {
365 struct ata_device *dev;
367 struct scsi_cmnd *scsicmd;
368 void (*scsidone)(struct scsi_cmnd *);
370 struct ata_taskfile tf;
371 u8 cdb[ATAPI_CDB_LEN];
373 unsigned long flags; /* ATA_QCFLAG_xxx */
376 unsigned int orig_n_elem;
380 unsigned int pad_len;
383 unsigned int cursect;
386 unsigned int curbytes;
389 unsigned int cursg_ofs;
391 struct scatterlist sgent;
392 struct scatterlist pad_sgent;
395 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
396 struct scatterlist *__sg;
398 unsigned int err_mask;
399 struct ata_taskfile result_tf;
400 ata_qc_cb_t complete_fn;
405 struct ata_host_stats {
406 unsigned long unhandled_irq;
407 unsigned long idle_irq;
408 unsigned long rw_reqbuf;
411 struct ata_ering_entry {
413 unsigned int err_mask;
419 struct ata_ering_entry ring[ATA_ERING_SIZE];
424 unsigned int devno; /* 0 or 1 */
425 unsigned long flags; /* ATA_DFLAG_xxx */
426 struct scsi_device *sdev; /* attached SCSI device */
427 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
428 u64 n_sectors; /* size of device, if ATA */
429 unsigned int class; /* ATA_DEV_xxx */
430 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
434 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
436 unsigned int multi_count; /* sectors count for
437 READ/WRITE MULTIPLE */
438 unsigned int max_sectors; /* per-device max sectors */
439 unsigned int cdb_len;
441 /* per-dev xfer mask */
442 unsigned int pio_mask;
443 unsigned int mwdma_mask;
444 unsigned int udma_mask;
446 /* for CHS addressing */
447 u16 cylinders; /* Number of cylinders */
448 u16 heads; /* Number of heads */
449 u16 sectors; /* Number of sectors per track */
452 struct ata_ering ering;
455 /* Offset into struct ata_device. Fields above it are maintained
456 * acress device init. Fields below are zeroed.
458 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
461 struct ata_device *dev; /* offending device */
462 u32 serror; /* SError from LLDD */
463 unsigned int err_mask; /* port-wide err_mask */
464 unsigned int action; /* ATA_EH_* action mask */
465 unsigned int flags; /* ATA_EHI_* flags */
467 unsigned long hotplug_timestamp;
468 unsigned int probe_mask;
470 char desc[ATA_EH_DESC_LEN];
474 struct ata_eh_context {
475 struct ata_eh_info i;
476 int tries[ATA_MAX_DEVICES];
477 unsigned int classes[ATA_MAX_DEVICES];
478 unsigned int did_probe_mask;
482 struct Scsi_Host *host; /* our co-allocated scsi host */
483 const struct ata_port_operations *ops;
484 unsigned long flags; /* ATA_FLAG_xxx */
485 unsigned int id; /* unique id req'd by scsi midlyr */
486 unsigned int port_no; /* unique port #; from zero */
487 unsigned int hard_port_no; /* hardware port #; from zero */
489 struct ata_prd *prd; /* our SG list */
490 dma_addr_t prd_dma; /* and its DMA mapping */
492 void *pad; /* array of DMA pad buffers */
495 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
497 u8 ctl; /* cache of ATA control register */
498 u8 last_ctl; /* Cache last written value */
499 unsigned int pio_mask;
500 unsigned int mwdma_mask;
501 unsigned int udma_mask;
502 unsigned int cbl; /* cable type; ATA_CBL_xxx */
503 unsigned int hw_sata_spd_limit;
504 unsigned int sata_spd_limit; /* SATA PHY speed limit */
506 /* record runtime error info, protected by host_set lock */
507 struct ata_eh_info eh_info;
508 /* EH context owned by EH */
509 struct ata_eh_context eh_context;
511 struct ata_device device[ATA_MAX_DEVICES];
513 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
514 unsigned long qc_allocated;
515 unsigned int qc_active;
517 unsigned int active_tag;
520 struct ata_host_stats stats;
521 struct ata_host_set *host_set;
524 struct work_struct port_task;
525 struct work_struct hotplug_task;
526 struct work_struct scsi_rescan_task;
528 unsigned int hsm_task_state;
531 struct list_head eh_done_q;
532 wait_queue_head_t eh_wait_q;
536 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
539 struct ata_port_operations {
540 void (*port_disable) (struct ata_port *);
542 void (*dev_config) (struct ata_port *, struct ata_device *);
544 void (*set_piomode) (struct ata_port *, struct ata_device *);
545 void (*set_dmamode) (struct ata_port *, struct ata_device *);
546 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
548 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
549 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
551 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
552 u8 (*check_status)(struct ata_port *ap);
553 u8 (*check_altstatus)(struct ata_port *ap);
554 void (*dev_select)(struct ata_port *ap, unsigned int device);
556 void (*phy_reset) (struct ata_port *ap); /* obsolete */
557 void (*set_mode) (struct ata_port *ap);
559 void (*post_set_mode) (struct ata_port *ap);
561 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
563 void (*bmdma_setup) (struct ata_queued_cmd *qc);
564 void (*bmdma_start) (struct ata_queued_cmd *qc);
566 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
568 void (*qc_prep) (struct ata_queued_cmd *qc);
569 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
571 /* Error handlers. ->error_handler overrides ->eng_timeout and
572 * indicates that new-style EH is in place.
574 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
576 void (*freeze) (struct ata_port *ap);
577 void (*thaw) (struct ata_port *ap);
578 void (*error_handler) (struct ata_port *ap);
579 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
581 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
582 void (*irq_clear) (struct ata_port *);
584 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
585 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
588 int (*port_start) (struct ata_port *ap);
589 void (*port_stop) (struct ata_port *ap);
591 void (*host_stop) (struct ata_host_set *host_set);
593 void (*bmdma_stop) (struct ata_queued_cmd *qc);
594 u8 (*bmdma_status) (struct ata_port *ap);
597 struct ata_port_info {
598 struct scsi_host_template *sht;
599 unsigned long host_flags;
600 unsigned long pio_mask;
601 unsigned long mwdma_mask;
602 unsigned long udma_mask;
603 const struct ata_port_operations *port_ops;
608 unsigned short mode; /* ATA mode */
609 unsigned short setup; /* t1 */
610 unsigned short act8b; /* t2 for 8-bit I/O */
611 unsigned short rec8b; /* t2i for 8-bit I/O */
612 unsigned short cyc8b; /* t0 for 8-bit I/O */
613 unsigned short active; /* t2 or tD */
614 unsigned short recover; /* t2i or tK */
615 unsigned short cycle; /* t0 */
616 unsigned short udma; /* t2CYCTYP/2 */
619 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
621 extern const unsigned long sata_deb_timing_boot[];
622 extern const unsigned long sata_deb_timing_eh[];
623 extern const unsigned long sata_deb_timing_before_fsrst[];
625 extern void ata_port_probe(struct ata_port *);
626 extern void __sata_phy_reset(struct ata_port *ap);
627 extern void sata_phy_reset(struct ata_port *ap);
628 extern void ata_bus_reset(struct ata_port *ap);
629 extern int sata_set_spd(struct ata_port *ap);
630 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
631 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
632 extern int ata_std_prereset(struct ata_port *ap);
633 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
634 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
635 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
636 extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
637 extern void ata_port_disable(struct ata_port *);
638 extern void ata_std_ports(struct ata_ioports *ioaddr);
640 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
641 unsigned int n_ports);
642 extern void ata_pci_remove_one (struct pci_dev *pdev);
643 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
644 extern int ata_pci_device_resume(struct pci_dev *pdev);
645 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
646 #endif /* CONFIG_PCI */
647 extern int ata_device_add(const struct ata_probe_ent *ent);
648 extern void ata_port_detach(struct ata_port *ap);
649 extern void ata_host_set_remove(struct ata_host_set *host_set);
650 extern int ata_scsi_detect(struct scsi_host_template *sht);
651 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
652 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
653 extern int ata_scsi_release(struct Scsi_Host *host);
654 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
655 extern int sata_scr_valid(struct ata_port *ap);
656 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
657 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
658 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
659 extern int ata_port_online(struct ata_port *ap);
660 extern int ata_port_offline(struct ata_port *ap);
661 extern int ata_scsi_device_resume(struct scsi_device *);
662 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
663 extern int ata_device_resume(struct ata_device *);
664 extern int ata_device_suspend(struct ata_device *, pm_message_t state);
665 extern int ata_ratelimit(void);
666 extern unsigned int ata_busy_sleep(struct ata_port *ap,
667 unsigned long timeout_pat,
668 unsigned long timeout);
669 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
670 void *data, unsigned long delay);
671 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
672 unsigned long interval_msec,
673 unsigned long timeout_msec);
676 * Default driver ops implementations
678 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
679 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
680 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
681 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
682 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
683 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
684 extern u8 ata_check_status(struct ata_port *ap);
685 extern u8 ata_altstatus(struct ata_port *ap);
686 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
687 extern int ata_port_start (struct ata_port *ap);
688 extern void ata_port_stop (struct ata_port *ap);
689 extern void ata_host_stop (struct ata_host_set *host_set);
690 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
691 extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
692 unsigned int buflen, int write_data);
693 extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
694 unsigned int buflen, int write_data);
695 extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
696 unsigned int buflen, int write_data);
697 extern void ata_qc_prep(struct ata_queued_cmd *qc);
698 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
699 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
700 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
701 unsigned int buflen);
702 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
703 unsigned int n_elem);
704 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
705 extern void ata_id_string(const u16 *id, unsigned char *s,
706 unsigned int ofs, unsigned int len);
707 extern void ata_id_c_string(const u16 *id, unsigned char *s,
708 unsigned int ofs, unsigned int len);
709 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
710 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
711 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
712 extern u8 ata_bmdma_status(struct ata_port *ap);
713 extern void ata_bmdma_irq_clear(struct ata_port *ap);
714 extern void ata_bmdma_freeze(struct ata_port *ap);
715 extern void ata_bmdma_thaw(struct ata_port *ap);
716 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
717 ata_reset_fn_t softreset,
718 ata_reset_fn_t hardreset,
719 ata_postreset_fn_t postreset);
720 extern void ata_bmdma_error_handler(struct ata_port *ap);
721 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
722 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
723 u8 status, int in_wq);
724 extern void ata_qc_complete(struct ata_queued_cmd *qc);
725 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
726 void (*finish_qc)(struct ata_queued_cmd *));
727 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
728 void (*done)(struct scsi_cmnd *));
729 extern int ata_std_bios_param(struct scsi_device *sdev,
730 struct block_device *bdev,
731 sector_t capacity, int geom[]);
732 extern int ata_scsi_slave_config(struct scsi_device *sdev);
733 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
734 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
736 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
742 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
743 extern int ata_timing_compute(struct ata_device *, unsigned short,
744 struct ata_timing *, int, int);
745 extern void ata_timing_merge(const struct ata_timing *,
746 const struct ata_timing *, struct ata_timing *,
750 ATA_TIMING_SETUP = (1 << 0),
751 ATA_TIMING_ACT8B = (1 << 1),
752 ATA_TIMING_REC8B = (1 << 2),
753 ATA_TIMING_CYC8B = (1 << 3),
754 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
756 ATA_TIMING_ACTIVE = (1 << 4),
757 ATA_TIMING_RECOVER = (1 << 5),
758 ATA_TIMING_CYCLE = (1 << 6),
759 ATA_TIMING_UDMA = (1 << 7),
760 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
761 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
762 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
763 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
769 unsigned int reg; /* PCI config register to read */
770 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
775 extern void ata_pci_host_stop (struct ata_host_set *host_set);
776 extern struct ata_probe_ent *
777 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
778 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
779 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
780 #endif /* CONFIG_PCI */
785 extern void ata_eng_timeout(struct ata_port *ap);
787 extern void ata_port_schedule_eh(struct ata_port *ap);
788 extern int ata_port_abort(struct ata_port *ap);
789 extern int ata_port_freeze(struct ata_port *ap);
791 extern void ata_eh_freeze_port(struct ata_port *ap);
792 extern void ata_eh_thaw_port(struct ata_port *ap);
794 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
795 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
797 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
798 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
799 ata_postreset_fn_t postreset);
804 #define ata_port_printk(ap, lv, fmt, args...) \
805 printk(lv"ata%u: "fmt, (ap)->id , ##args)
807 #define ata_dev_printk(dev, lv, fmt, args...) \
808 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
811 * ata_eh_info helpers
813 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
814 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
815 ATA_EH_DESC_LEN - (ehi)->desc_len, \
819 #define ata_ehi_clear_desc(ehi) do { \
820 (ehi)->desc[0] = '\0'; \
821 (ehi)->desc_len = 0; \
824 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
826 if (ehi->flags & ATA_EHI_HOTPLUGGED)
829 ehi->flags |= ATA_EHI_HOTPLUGGED;
830 ehi->hotplug_timestamp = jiffies;
832 ehi->err_mask |= AC_ERR_ATA_BUS;
833 ehi->action |= ATA_EH_SOFTRESET;
834 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
841 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
843 if (sg == &qc->pad_sgent)
847 if (((sg - qc->__sg) + 1) == qc->n_elem)
852 static inline struct scatterlist *
853 ata_qc_first_sg(struct ata_queued_cmd *qc)
858 return &qc->pad_sgent;
862 static inline struct scatterlist *
863 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
865 if (sg == &qc->pad_sgent)
867 if (++sg - qc->__sg < qc->n_elem)
870 return &qc->pad_sgent;
874 #define ata_for_each_sg(sg, qc) \
875 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
877 static inline unsigned int ata_tag_valid(unsigned int tag)
879 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
882 static inline unsigned int ata_tag_internal(unsigned int tag)
884 return tag == ATA_MAX_QUEUE - 1;
887 static inline unsigned int ata_class_enabled(unsigned int class)
889 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
892 static inline unsigned int ata_class_disabled(unsigned int class)
894 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
897 static inline unsigned int ata_class_absent(unsigned int class)
899 return !ata_class_enabled(class) && !ata_class_disabled(class);
902 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
904 return ata_class_enabled(dev->class);
907 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
909 return ata_class_disabled(dev->class);
912 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
914 return ata_class_absent(dev->class);
917 static inline u8 ata_chk_status(struct ata_port *ap)
919 return ap->ops->check_status(ap);
924 * ata_pause - Flush writes and pause 400 nanoseconds.
925 * @ap: Port to wait for.
928 * Inherited from caller.
931 static inline void ata_pause(struct ata_port *ap)
939 * ata_busy_wait - Wait for a port status register
940 * @ap: Port to wait for.
942 * Waits up to max*10 microseconds for the selected bits in the port's
943 * status register to be cleared.
944 * Returns final value of status register.
947 * Inherited from caller.
950 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
957 status = ata_chk_status(ap);
959 } while ((status & bits) && (max > 0));
966 * ata_wait_idle - Wait for a port to be idle.
967 * @ap: Port to wait for.
969 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
970 * Returns final value of status register.
973 * Inherited from caller.
976 static inline u8 ata_wait_idle(struct ata_port *ap)
978 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
980 if (status & (ATA_BUSY | ATA_DRQ)) {
981 unsigned long l = ap->ioaddr.status_addr;
982 if (ata_msg_warn(ap))
983 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
990 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
992 qc->tf.ctl |= ATA_NIEN;
995 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
998 if (likely(ata_tag_valid(tag)))
999 return &ap->qcmd[tag];
1003 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1006 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1008 if (unlikely(!qc) || !ap->ops->error_handler)
1011 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1012 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1018 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1020 memset(tf, 0, sizeof(*tf));
1022 tf->ctl = dev->ap->ctl;
1023 if (dev->devno == 0)
1024 tf->device = ATA_DEVICE_OBS;
1026 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1029 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1033 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1035 qc->nbytes = qc->curbytes = 0;
1038 ata_tf_init(qc->dev, &qc->tf);
1040 /* init result_tf such that it indicates normal completion */
1041 qc->result_tf.command = ATA_DRDY;
1042 qc->result_tf.feature = 0;
1046 * ata_irq_on - Enable interrupts on a port.
1047 * @ap: Port on which interrupts are enabled.
1049 * Enable interrupts on a legacy IDE device using MMIO or PIO,
1050 * wait for idle, clear any pending interrupts.
1053 * Inherited from caller.
1056 static inline u8 ata_irq_on(struct ata_port *ap)
1058 struct ata_ioports *ioaddr = &ap->ioaddr;
1061 ap->ctl &= ~ATA_NIEN;
1062 ap->last_ctl = ap->ctl;
1064 if (ap->flags & ATA_FLAG_MMIO)
1065 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1067 outb(ap->ctl, ioaddr->ctl_addr);
1068 tmp = ata_wait_idle(ap);
1070 ap->ops->irq_clear(ap);
1077 * ata_irq_ack - Acknowledge a device interrupt.
1078 * @ap: Port on which interrupts are enabled.
1080 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1081 * or BUSY+DRQ clear). Obtain dma status and port status from
1082 * device. Clear the interrupt. Return port status.
1087 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1089 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1090 u8 host_stat, post_stat, status;
1092 status = ata_busy_wait(ap, bits, 1000);
1094 if (ata_msg_err(ap))
1095 printk(KERN_ERR "abnormal status 0x%X\n", status);
1097 /* get controller status; clear intr, err bits */
1098 if (ap->flags & ATA_FLAG_MMIO) {
1099 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1100 host_stat = readb(mmio + ATA_DMA_STATUS);
1101 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1102 mmio + ATA_DMA_STATUS);
1104 post_stat = readb(mmio + ATA_DMA_STATUS);
1106 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1107 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1108 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1110 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1113 if (ata_msg_intr(ap))
1114 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1116 host_stat, post_stat, status);
1121 static inline int ata_try_flush_cache(const struct ata_device *dev)
1123 return ata_id_wcache_enabled(dev->id) ||
1124 ata_id_has_flush(dev->id) ||
1125 ata_id_has_flush_ext(dev->id);
1128 static inline unsigned int ac_err_mask(u8 status)
1130 if (status & (ATA_BUSY | ATA_DRQ))
1132 if (status & (ATA_ERR | ATA_DF))
1137 static inline unsigned int __ac_err_mask(u8 status)
1139 unsigned int mask = ac_err_mask(status);
1141 return AC_ERR_OTHER;
1145 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1148 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1149 &ap->pad_dma, GFP_KERNEL);
1150 return (ap->pad == NULL) ? -ENOMEM : 0;
1153 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1155 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1158 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1160 return (struct ata_port *) &host->hostdata[0];
1163 #endif /* __LINUX_LIBATA_H__ */