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>
33 #include <asm/scatterlist.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/acpi.h>
41 * Define if arch has non-standard setup. This is a _PCI_ standard
42 * not a legacy or ISA standard.
44 #ifdef CONFIG_ATA_NONSTANDARD
45 #include <asm/libata-portmap.h>
47 #include <asm-generic/libata-portmap.h>
51 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
54 #undef ATA_DEBUG /* debugging output */
55 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
56 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
57 #undef ATA_NDEBUG /* define to disable quick runtime checks */
60 /* note: prints function name for you */
62 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63 #ifdef ATA_VERBOSE_DEBUG
64 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66 #define VPRINTK(fmt, args...)
67 #endif /* ATA_VERBOSE_DEBUG */
69 #define DPRINTK(fmt, args...)
70 #define VPRINTK(fmt, args...)
71 #endif /* ATA_DEBUG */
73 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75 /* NEW: debug levels */
76 #define HAVE_LIBATA_MSG 1
80 ATA_MSG_INFO = 0x0002,
81 ATA_MSG_PROBE = 0x0004,
82 ATA_MSG_WARN = 0x0008,
83 ATA_MSG_MALLOC = 0x0010,
85 ATA_MSG_INTR = 0x0040,
89 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
90 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
91 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
92 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
95 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
96 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
98 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100 if (dval < 0 || dval >= (sizeof(u32) * 8))
101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
104 return (1 << dval) - 1;
107 /* defines only for the constants which don't work well as enums */
108 #define ATA_TAG_POISON 0xfafbfcfdU
110 /* move to PCI layer? */
111 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
117 /* various global constants */
118 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
121 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
123 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
125 ATA_DEF_BUSY_WAIT = 10000,
126 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
128 ATA_SHT_EMULATED = 1,
129 ATA_SHT_CMD_PER_LUN = 1,
130 ATA_SHT_THIS_ID = -1,
131 ATA_SHT_USE_CLUSTERING = 1,
133 /* struct ata_device stuff */
134 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
135 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
136 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
137 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
138 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
139 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
141 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
142 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
143 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
144 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
146 ATA_DFLAG_DETACH = (1 << 16),
147 ATA_DFLAG_DETACHED = (1 << 17),
149 ATA_DEV_UNKNOWN = 0, /* unknown device */
150 ATA_DEV_ATA = 1, /* ATA device */
151 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
152 ATA_DEV_ATAPI = 3, /* ATAPI device */
153 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
154 ATA_DEV_NONE = 5, /* no device */
156 /* struct ata_port flags */
157 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
158 /* (doesn't imply presence) */
159 ATA_FLAG_SATA = (1 << 1),
160 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
161 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
162 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
163 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
164 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
165 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
166 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
167 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
168 * doesn't handle PIO interrupts */
169 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
170 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
171 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
172 * Register FIS clearing BSY */
173 ATA_FLAG_DEBUGMSG = (1 << 13),
174 ATA_FLAG_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
175 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
176 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
178 /* The following flag belongs to ap->pflags but is kept in
179 * ap->flags because it's referenced in many LLDs and will be
180 * removed in not-too-distant future.
182 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
184 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
186 /* struct ata_port pflags */
187 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
188 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
189 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
190 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
191 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
192 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
193 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
195 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
196 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
197 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
199 /* struct ata_queued_cmd flags */
200 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
201 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
202 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
203 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
204 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
205 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
207 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
208 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
209 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
212 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
213 ATA_HOST_STARTED = (1 << 1), /* Host started */
215 /* various lengths of time */
216 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
217 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
218 ATA_TMOUT_INTERNAL = 30 * HZ,
219 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
233 /* SATA port states */
238 /* encoding various smaller bitmaps into a single
239 * unsigned int bitmap
246 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
247 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
249 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
250 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
251 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
253 /* size of buffer to pad xfers ending on unaligned boundaries */
255 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
257 /* masks for port functions */
258 ATA_PORT_PRIMARY = (1 << 0),
259 ATA_PORT_SECONDARY = (1 << 1),
264 /* desc_len for ata_eh_info and context */
265 ATA_EH_DESC_LEN = 80,
267 /* reset / recovery action types */
268 ATA_EH_REVALIDATE = (1 << 0),
269 ATA_EH_SOFTRESET = (1 << 1),
270 ATA_EH_HARDRESET = (1 << 2),
271 ATA_EH_SUSPEND = (1 << 3),
272 ATA_EH_RESUME = (1 << 4),
273 ATA_EH_PM_FREEZE = (1 << 5),
275 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
276 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
277 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
279 /* ata_eh_info->flags */
280 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
281 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
282 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
283 ATA_EHI_QUIET = (1 << 3), /* be quiet */
285 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
286 ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */
287 ATA_EHI_SETMODE = (1 << 18), /* configure transfer mode */
288 ATA_EHI_POST_SETMODE = (1 << 19), /* revaildating after setmode */
290 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
292 /* max repeat if error condition is still set after ->error_handler */
293 ATA_EH_MAX_REPEAT = 5,
295 /* how hard are we gonna try to probe/recover devices */
296 ATA_PROBE_MAX_TRIES = 3,
297 ATA_EH_RESET_TRIES = 3,
298 ATA_EH_DEV_TRIES = 3,
300 /* Drive spinup time (time from power-on to the first D2H FIS)
301 * in msecs - 8s currently. Failing to get ready in this time
302 * isn't critical. It will result in reset failure for
303 * controllers which can't wait for the first D2H FIS. libata
304 * will retry, so it just has to be long enough to spin up
307 ATA_SPINUP_WAIT = 8000,
309 /* Horkage types. May be set by libata or controller on drives
310 (some horkage may be drive/controller pair dependant */
312 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
313 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
314 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
315 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
316 ATA_HORKAGE_DMA_RW_ONLY = (1 << 4), /* ATAPI DMA for RW only */
319 enum hsm_task_states {
320 HSM_ST_IDLE, /* no command on going */
321 HSM_ST_FIRST, /* (waiting the device to)
322 write CDB or first data block */
323 HSM_ST, /* (waiting the device to) transfer data */
324 HSM_ST_LAST, /* (waiting the device to) complete command */
325 HSM_ST_ERR, /* error */
328 enum ata_completion_errors {
329 AC_ERR_DEV = (1 << 0), /* device reported error */
330 AC_ERR_HSM = (1 << 1), /* host state machine violation */
331 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
332 AC_ERR_MEDIA = (1 << 3), /* media error */
333 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
334 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
335 AC_ERR_SYSTEM = (1 << 6), /* system error */
336 AC_ERR_INVALID = (1 << 7), /* invalid argument */
337 AC_ERR_OTHER = (1 << 8), /* unknown */
338 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
341 /* forward declarations */
343 struct ata_port_operations;
345 struct ata_queued_cmd;
348 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
349 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
350 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
351 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
354 void __iomem *cmd_addr;
355 void __iomem *data_addr;
356 void __iomem *error_addr;
357 void __iomem *feature_addr;
358 void __iomem *nsect_addr;
359 void __iomem *lbal_addr;
360 void __iomem *lbam_addr;
361 void __iomem *lbah_addr;
362 void __iomem *device_addr;
363 void __iomem *status_addr;
364 void __iomem *command_addr;
365 void __iomem *altstatus_addr;
366 void __iomem *ctl_addr;
367 void __iomem *bmdma_addr;
368 void __iomem *scr_addr;
371 struct ata_probe_ent {
372 struct list_head node;
374 const struct ata_port_operations *port_ops;
375 struct scsi_host_template *sht;
376 struct ata_ioports port[ATA_MAX_PORTS];
377 unsigned int n_ports;
378 unsigned int dummy_port_mask;
379 unsigned int pio_mask;
380 unsigned int mwdma_mask;
381 unsigned int udma_mask;
384 unsigned int irq_flags;
385 unsigned long port_flags;
386 unsigned long _host_flags;
387 void __iomem * const *iomap;
390 /* port_info for the secondary port. Together with irq2, it's
391 * used to implement non-uniform secondary port. Currently,
392 * the only user is ata_piix combined mode. This workaround
393 * will be removed together with ata_probe_ent when init model
396 const struct ata_port_info *pinfo2;
404 void __iomem * const *iomap;
405 unsigned int n_ports;
407 const struct ata_port_operations *ops;
409 struct ata_port *simplex_claimed; /* channel owning the DMA */
410 struct ata_port *ports[0];
413 struct ata_queued_cmd {
415 struct ata_device *dev;
417 struct scsi_cmnd *scsicmd;
418 void (*scsidone)(struct scsi_cmnd *);
420 struct ata_taskfile tf;
421 u8 cdb[ATAPI_CDB_LEN];
423 unsigned long flags; /* ATA_QCFLAG_xxx */
426 unsigned int orig_n_elem;
430 unsigned int pad_len;
431 unsigned int sect_size;
434 unsigned int curbytes;
437 unsigned int cursg_ofs;
439 struct scatterlist sgent;
440 struct scatterlist pad_sgent;
443 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
444 struct scatterlist *__sg;
446 unsigned int err_mask;
447 struct ata_taskfile result_tf;
448 ata_qc_cb_t complete_fn;
453 struct ata_port_stats {
454 unsigned long unhandled_irq;
455 unsigned long idle_irq;
456 unsigned long rw_reqbuf;
459 struct ata_ering_entry {
461 unsigned int err_mask;
467 struct ata_ering_entry ring[ATA_ERING_SIZE];
472 unsigned int devno; /* 0 or 1 */
473 unsigned long flags; /* ATA_DFLAG_xxx */
474 struct scsi_device *sdev; /* attached SCSI device */
475 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
476 u64 n_sectors; /* size of device, if ATA */
477 unsigned int class; /* ATA_DEV_xxx */
478 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
482 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
484 unsigned int multi_count; /* sectors count for
485 READ/WRITE MULTIPLE */
486 unsigned int max_sectors; /* per-device max sectors */
487 unsigned int cdb_len;
489 /* per-dev xfer mask */
490 unsigned int pio_mask;
491 unsigned int mwdma_mask;
492 unsigned int udma_mask;
494 /* for CHS addressing */
495 u16 cylinders; /* Number of cylinders */
496 u16 heads; /* Number of heads */
497 u16 sectors; /* Number of sectors per track */
500 struct ata_ering ering;
502 unsigned int horkage; /* List of broken features */
503 #ifdef CONFIG_SATA_ACPI
504 /* ACPI objects info */
505 acpi_handle obj_handle;
509 /* Offset into struct ata_device. Fields above it are maintained
510 * acress device init. Fields below are zeroed.
512 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
515 struct ata_device *dev; /* offending device */
516 u32 serror; /* SError from LLDD */
517 unsigned int err_mask; /* port-wide err_mask */
518 unsigned int action; /* ATA_EH_* action mask */
519 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
520 unsigned int flags; /* ATA_EHI_* flags */
522 unsigned long hotplug_timestamp;
523 unsigned int probe_mask;
525 char desc[ATA_EH_DESC_LEN];
529 struct ata_eh_context {
530 struct ata_eh_info i;
531 int tries[ATA_MAX_DEVICES];
532 unsigned int classes[ATA_MAX_DEVICES];
533 unsigned int did_probe_mask;
537 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
538 const struct ata_port_operations *ops;
540 unsigned long flags; /* ATA_FLAG_xxx */
541 unsigned int pflags; /* ATA_PFLAG_xxx */
542 unsigned int print_id; /* user visible unique port ID */
543 unsigned int port_no; /* 0 based port no. inside the host */
545 struct ata_prd *prd; /* our SG list */
546 dma_addr_t prd_dma; /* and its DMA mapping */
548 void *pad; /* array of DMA pad buffers */
551 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
553 u8 ctl; /* cache of ATA control register */
554 u8 last_ctl; /* Cache last written value */
555 unsigned int pio_mask;
556 unsigned int mwdma_mask;
557 unsigned int udma_mask;
558 unsigned int cbl; /* cable type; ATA_CBL_xxx */
559 unsigned int hw_sata_spd_limit;
560 unsigned int sata_spd_limit; /* SATA PHY speed limit */
562 /* record runtime error info, protected by host lock */
563 struct ata_eh_info eh_info;
564 /* EH context owned by EH */
565 struct ata_eh_context eh_context;
567 struct ata_device device[ATA_MAX_DEVICES];
569 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
570 unsigned long qc_allocated;
571 unsigned int qc_active;
573 unsigned int active_tag;
576 struct ata_port_stats stats;
577 struct ata_host *host;
580 void *port_task_data;
581 struct delayed_work port_task;
582 struct delayed_work hotplug_task;
583 struct work_struct scsi_rescan_task;
585 unsigned int hsm_task_state;
588 struct list_head eh_done_q;
589 wait_queue_head_t eh_wait_q;
591 pm_message_t pm_mesg;
596 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
599 struct ata_port_operations {
600 void (*port_disable) (struct ata_port *);
602 void (*dev_config) (struct ata_device *);
604 void (*set_piomode) (struct ata_port *, struct ata_device *);
605 void (*set_dmamode) (struct ata_port *, struct ata_device *);
606 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
608 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
609 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
611 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
612 u8 (*check_status)(struct ata_port *ap);
613 u8 (*check_altstatus)(struct ata_port *ap);
614 void (*dev_select)(struct ata_port *ap, unsigned int device);
616 void (*phy_reset) (struct ata_port *ap); /* obsolete */
617 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
619 void (*post_set_mode) (struct ata_port *ap);
621 int (*cable_detect) (struct ata_port *ap);
623 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
625 void (*bmdma_setup) (struct ata_queued_cmd *qc);
626 void (*bmdma_start) (struct ata_queued_cmd *qc);
628 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
630 void (*qc_prep) (struct ata_queued_cmd *qc);
631 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
633 /* Error handlers. ->error_handler overrides ->eng_timeout and
634 * indicates that new-style EH is in place.
636 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
638 void (*freeze) (struct ata_port *ap);
639 void (*thaw) (struct ata_port *ap);
640 void (*error_handler) (struct ata_port *ap);
641 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
643 irq_handler_t irq_handler;
644 void (*irq_clear) (struct ata_port *);
645 u8 (*irq_on) (struct ata_port *);
646 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
648 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
649 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
652 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
653 int (*port_resume) (struct ata_port *ap);
655 int (*port_start) (struct ata_port *ap);
656 void (*port_stop) (struct ata_port *ap);
658 void (*host_stop) (struct ata_host *host);
660 void (*bmdma_stop) (struct ata_queued_cmd *qc);
661 u8 (*bmdma_status) (struct ata_port *ap);
664 struct ata_port_info {
665 struct scsi_host_template *sht;
667 unsigned long pio_mask;
668 unsigned long mwdma_mask;
669 unsigned long udma_mask;
670 const struct ata_port_operations *port_ops;
675 unsigned short mode; /* ATA mode */
676 unsigned short setup; /* t1 */
677 unsigned short act8b; /* t2 for 8-bit I/O */
678 unsigned short rec8b; /* t2i for 8-bit I/O */
679 unsigned short cyc8b; /* t0 for 8-bit I/O */
680 unsigned short active; /* t2 or tD */
681 unsigned short recover; /* t2i or tK */
682 unsigned short cycle; /* t0 */
683 unsigned short udma; /* t2CYCTYP/2 */
686 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
688 extern const unsigned long sata_deb_timing_normal[];
689 extern const unsigned long sata_deb_timing_hotplug[];
690 extern const unsigned long sata_deb_timing_long[];
692 extern const struct ata_port_operations ata_dummy_port_ops;
694 static inline const unsigned long *
695 sata_ehc_deb_timing(struct ata_eh_context *ehc)
697 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
698 return sata_deb_timing_hotplug;
700 return sata_deb_timing_normal;
703 static inline int ata_port_is_dummy(struct ata_port *ap)
705 return ap->ops == &ata_dummy_port_ops;
708 extern void sata_print_link_status(struct ata_port *ap);
709 extern void ata_port_probe(struct ata_port *);
710 extern void __sata_phy_reset(struct ata_port *ap);
711 extern void sata_phy_reset(struct ata_port *ap);
712 extern void ata_bus_reset(struct ata_port *ap);
713 extern int sata_set_spd(struct ata_port *ap);
714 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
715 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
716 extern int ata_std_prereset(struct ata_port *ap);
717 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
718 extern int sata_port_hardreset(struct ata_port *ap,
719 const unsigned long *timing);
720 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
721 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
722 extern void ata_port_disable(struct ata_port *);
723 extern void ata_std_ports(struct ata_ioports *ioaddr);
725 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
726 unsigned int n_ports);
727 extern void ata_pci_remove_one (struct pci_dev *pdev);
729 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
730 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
731 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
732 extern int ata_pci_device_resume(struct pci_dev *pdev);
734 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
735 #endif /* CONFIG_PCI */
736 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
737 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
738 const struct ata_port_info * const * ppi, int n_ports);
739 extern int ata_host_start(struct ata_host *host);
740 extern int ata_host_register(struct ata_host *host,
741 struct scsi_host_template *sht);
742 extern int ata_host_activate(struct ata_host *host, int irq,
743 irq_handler_t irq_handler, unsigned long irq_flags,
744 struct scsi_host_template *sht);
745 extern int ata_device_add(const struct ata_probe_ent *ent);
746 extern void ata_host_detach(struct ata_host *host);
747 extern void ata_host_init(struct ata_host *, struct device *,
748 unsigned long, const struct ata_port_operations *);
749 extern int ata_scsi_detect(struct scsi_host_template *sht);
750 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
751 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
752 extern void ata_sas_port_destroy(struct ata_port *);
753 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
754 struct ata_port_info *, struct Scsi_Host *);
755 extern int ata_sas_port_init(struct ata_port *);
756 extern int ata_sas_port_start(struct ata_port *ap);
757 extern void ata_sas_port_stop(struct ata_port *ap);
758 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
759 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
760 struct ata_port *ap);
761 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
762 extern int sata_scr_valid(struct ata_port *ap);
763 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
764 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
765 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
766 extern int ata_port_online(struct ata_port *ap);
767 extern int ata_port_offline(struct ata_port *ap);
769 extern int ata_scsi_device_resume(struct scsi_device *);
770 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
771 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
772 extern void ata_host_resume(struct ata_host *host);
774 extern int ata_ratelimit(void);
775 extern int ata_busy_sleep(struct ata_port *ap,
776 unsigned long timeout_pat, unsigned long timeout);
777 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
778 void *data, unsigned long delay);
779 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
780 unsigned long interval_msec,
781 unsigned long timeout_msec);
782 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
785 * Default driver ops implementations
787 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
788 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
789 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
790 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
791 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
792 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
793 extern u8 ata_check_status(struct ata_port *ap);
794 extern u8 ata_altstatus(struct ata_port *ap);
795 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
796 extern int ata_port_start (struct ata_port *ap);
797 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
798 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
799 unsigned int buflen, int write_data);
800 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
801 unsigned int buflen, int write_data);
802 extern void ata_qc_prep(struct ata_queued_cmd *qc);
803 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
804 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
805 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
806 unsigned int buflen);
807 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
808 unsigned int n_elem);
809 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
810 extern void ata_dev_disable(struct ata_device *adev);
811 extern void ata_id_string(const u16 *id, unsigned char *s,
812 unsigned int ofs, unsigned int len);
813 extern void ata_id_c_string(const u16 *id, unsigned char *s,
814 unsigned int ofs, unsigned int len);
815 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
816 extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
817 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
818 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
819 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
820 extern u8 ata_bmdma_status(struct ata_port *ap);
821 extern void ata_bmdma_irq_clear(struct ata_port *ap);
822 extern void ata_bmdma_freeze(struct ata_port *ap);
823 extern void ata_bmdma_thaw(struct ata_port *ap);
824 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
825 ata_reset_fn_t softreset,
826 ata_reset_fn_t hardreset,
827 ata_postreset_fn_t postreset);
828 extern void ata_bmdma_error_handler(struct ata_port *ap);
829 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
830 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
831 u8 status, int in_wq);
832 extern void ata_qc_complete(struct ata_queued_cmd *qc);
833 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
834 void (*finish_qc)(struct ata_queued_cmd *));
835 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
836 void (*done)(struct scsi_cmnd *));
837 extern int ata_std_bios_param(struct scsi_device *sdev,
838 struct block_device *bdev,
839 sector_t capacity, int geom[]);
840 extern int ata_scsi_slave_config(struct scsi_device *sdev);
841 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
842 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
844 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
845 extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
846 extern u8 ata_irq_on(struct ata_port *ap);
847 extern u8 ata_dummy_irq_on(struct ata_port *ap);
848 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
849 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
851 extern int ata_cable_40wire(struct ata_port *ap);
852 extern int ata_cable_80wire(struct ata_port *ap);
853 extern int ata_cable_sata(struct ata_port *ap);
854 extern int ata_cable_unknown(struct ata_port *ap);
860 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
861 extern int ata_timing_compute(struct ata_device *, unsigned short,
862 struct ata_timing *, int, int);
863 extern void ata_timing_merge(const struct ata_timing *,
864 const struct ata_timing *, struct ata_timing *,
868 ATA_TIMING_SETUP = (1 << 0),
869 ATA_TIMING_ACT8B = (1 << 1),
870 ATA_TIMING_REC8B = (1 << 2),
871 ATA_TIMING_CYC8B = (1 << 3),
872 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
874 ATA_TIMING_ACTIVE = (1 << 4),
875 ATA_TIMING_RECOVER = (1 << 5),
876 ATA_TIMING_CYCLE = (1 << 6),
877 ATA_TIMING_UDMA = (1 << 7),
878 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
879 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
880 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
881 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
887 unsigned int reg; /* PCI config register to read */
888 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
893 extern struct ata_probe_ent *
894 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
895 extern int ata_pci_init_native_host(struct ata_host *host,
896 unsigned int port_mask);
897 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
898 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
899 #endif /* CONFIG_PCI */
904 extern void ata_eng_timeout(struct ata_port *ap);
906 extern void ata_port_schedule_eh(struct ata_port *ap);
907 extern int ata_port_abort(struct ata_port *ap);
908 extern int ata_port_freeze(struct ata_port *ap);
910 extern void ata_eh_freeze_port(struct ata_port *ap);
911 extern void ata_eh_thaw_port(struct ata_port *ap);
913 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
914 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
916 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
917 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
918 ata_postreset_fn_t postreset);
923 #define ata_port_printk(ap, lv, fmt, args...) \
924 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
926 #define ata_dev_printk(dev, lv, fmt, args...) \
927 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
930 * ata_eh_info helpers
932 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
933 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
934 ATA_EH_DESC_LEN - (ehi)->desc_len, \
938 #define ata_ehi_clear_desc(ehi) do { \
939 (ehi)->desc[0] = '\0'; \
940 (ehi)->desc_len = 0; \
943 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
945 if (ehi->flags & ATA_EHI_HOTPLUGGED)
948 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
949 ehi->hotplug_timestamp = jiffies;
951 ehi->action |= ATA_EH_SOFTRESET;
952 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
955 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
957 __ata_ehi_hotplugged(ehi);
958 ehi->err_mask |= AC_ERR_ATA_BUS;
965 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
967 if (sg == &qc->pad_sgent)
971 if (((sg - qc->__sg) + 1) == qc->n_elem)
976 static inline struct scatterlist *
977 ata_qc_first_sg(struct ata_queued_cmd *qc)
982 return &qc->pad_sgent;
986 static inline struct scatterlist *
987 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
989 if (sg == &qc->pad_sgent)
991 if (++sg - qc->__sg < qc->n_elem)
994 return &qc->pad_sgent;
998 #define ata_for_each_sg(sg, qc) \
999 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
1001 static inline unsigned int ata_tag_valid(unsigned int tag)
1003 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1006 static inline unsigned int ata_tag_internal(unsigned int tag)
1008 return tag == ATA_MAX_QUEUE - 1;
1014 static inline unsigned int ata_class_enabled(unsigned int class)
1016 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
1019 static inline unsigned int ata_class_disabled(unsigned int class)
1021 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1024 static inline unsigned int ata_class_absent(unsigned int class)
1026 return !ata_class_enabled(class) && !ata_class_disabled(class);
1029 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1031 return ata_class_enabled(dev->class);
1034 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1036 return ata_class_disabled(dev->class);
1039 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1041 return ata_class_absent(dev->class);
1044 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1046 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1052 static inline int ata_port_max_devices(const struct ata_port *ap)
1054 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1060 static inline u8 ata_chk_status(struct ata_port *ap)
1062 return ap->ops->check_status(ap);
1066 * ata_ncq_enabled - Test whether NCQ is enabled
1067 * @dev: ATA device to test for
1070 * spin_lock_irqsave(host lock)
1073 * 1 if NCQ is enabled for @dev, 0 otherwise.
1075 static inline int ata_ncq_enabled(struct ata_device *dev)
1077 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1078 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1082 * ata_pause - Flush writes and pause 400 nanoseconds.
1083 * @ap: Port to wait for.
1086 * Inherited from caller.
1089 static inline void ata_pause(struct ata_port *ap)
1097 * ata_busy_wait - Wait for a port status register
1098 * @ap: Port to wait for.
1099 * @bits: bits that must be clear
1100 * @max: number of 10uS waits to perform
1102 * Waits up to max*10 microseconds for the selected bits in the port's
1103 * status register to be cleared.
1104 * Returns final value of status register.
1107 * Inherited from caller.
1110 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1117 status = ata_chk_status(ap);
1119 } while (status != 0xff && (status & bits) && (max > 0));
1126 * ata_wait_idle - Wait for a port to be idle.
1127 * @ap: Port to wait for.
1129 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1130 * Returns final value of status register.
1133 * Inherited from caller.
1136 static inline u8 ata_wait_idle(struct ata_port *ap)
1138 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1140 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
1141 if (ata_msg_warn(ap))
1142 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%p\n",
1143 status, ap->ioaddr.status_addr);
1149 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1151 qc->tf.ctl |= ATA_NIEN;
1154 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1157 if (likely(ata_tag_valid(tag)))
1158 return &ap->qcmd[tag];
1162 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1165 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1167 if (unlikely(!qc) || !ap->ops->error_handler)
1170 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1171 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1177 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1179 memset(tf, 0, sizeof(*tf));
1181 tf->ctl = dev->ap->ctl;
1182 if (dev->devno == 0)
1183 tf->device = ATA_DEVICE_OBS;
1185 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1188 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1190 qc->dma_dir = DMA_NONE;
1193 qc->cursg = qc->cursg_ofs = 0;
1194 qc->nbytes = qc->curbytes = 0;
1198 qc->sect_size = ATA_SECT_SIZE;
1200 ata_tf_init(qc->dev, &qc->tf);
1202 /* init result_tf such that it indicates normal completion */
1203 qc->result_tf.command = ATA_DRDY;
1204 qc->result_tf.feature = 0;
1207 static inline int ata_try_flush_cache(const struct ata_device *dev)
1209 return ata_id_wcache_enabled(dev->id) ||
1210 ata_id_has_flush(dev->id) ||
1211 ata_id_has_flush_ext(dev->id);
1214 static inline unsigned int ac_err_mask(u8 status)
1216 if (status & (ATA_BUSY | ATA_DRQ))
1218 if (status & (ATA_ERR | ATA_DF))
1223 static inline unsigned int __ac_err_mask(u8 status)
1225 unsigned int mask = ac_err_mask(status);
1227 return AC_ERR_OTHER;
1231 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1234 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1235 &ap->pad_dma, GFP_KERNEL);
1236 return (ap->pad == NULL) ? -ENOMEM : 0;
1239 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1241 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1244 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1246 return *(struct ata_port **)&host->hostdata[0];
1249 #endif /* __LINUX_LIBATA_H__ */