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_SPUNDOWN = (1 << 10), /* XXX: for spindown_compat */
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_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
175 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
176 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
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 */
194 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
196 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
197 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
198 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
200 /* struct ata_queued_cmd flags */
201 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
202 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
203 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
204 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
205 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
206 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
208 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
209 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
210 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
213 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
214 ATA_HOST_STARTED = (1 << 1), /* Host started */
216 /* various lengths of time */
217 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
218 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
219 ATA_TMOUT_INTERNAL = 30 * HZ,
220 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
234 /* SATA port states */
239 /* encoding various smaller bitmaps into a single
240 * unsigned int bitmap
247 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
248 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
250 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
251 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
252 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
254 /* size of buffer to pad xfers ending on unaligned boundaries */
256 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
261 /* desc_len for ata_eh_info and context */
262 ATA_EH_DESC_LEN = 80,
264 /* reset / recovery action types */
265 ATA_EH_REVALIDATE = (1 << 0),
266 ATA_EH_SOFTRESET = (1 << 1),
267 ATA_EH_HARDRESET = (1 << 2),
269 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
270 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
272 /* ata_eh_info->flags */
273 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
274 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
275 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
276 ATA_EHI_QUIET = (1 << 3), /* be quiet */
278 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
279 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
280 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
281 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
282 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
284 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
285 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
287 /* max repeat if error condition is still set after ->error_handler */
288 ATA_EH_MAX_REPEAT = 5,
290 /* how hard are we gonna try to probe/recover devices */
291 ATA_PROBE_MAX_TRIES = 3,
292 ATA_EH_DEV_TRIES = 3,
294 /* Horkage types. May be set by libata or controller on drives
295 (some horkage may be drive/controller pair dependant */
297 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
298 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
299 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
300 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
303 enum hsm_task_states {
304 HSM_ST_IDLE, /* no command on going */
305 HSM_ST_FIRST, /* (waiting the device to)
306 write CDB or first data block */
307 HSM_ST, /* (waiting the device to) transfer data */
308 HSM_ST_LAST, /* (waiting the device to) complete command */
309 HSM_ST_ERR, /* error */
312 enum ata_completion_errors {
313 AC_ERR_DEV = (1 << 0), /* device reported error */
314 AC_ERR_HSM = (1 << 1), /* host state machine violation */
315 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
316 AC_ERR_MEDIA = (1 << 3), /* media error */
317 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
318 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
319 AC_ERR_SYSTEM = (1 << 6), /* system error */
320 AC_ERR_INVALID = (1 << 7), /* invalid argument */
321 AC_ERR_OTHER = (1 << 8), /* unknown */
322 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
325 /* forward declarations */
327 struct ata_port_operations;
329 struct ata_queued_cmd;
332 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
333 typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
334 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
335 unsigned long deadline);
336 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
339 void __iomem *cmd_addr;
340 void __iomem *data_addr;
341 void __iomem *error_addr;
342 void __iomem *feature_addr;
343 void __iomem *nsect_addr;
344 void __iomem *lbal_addr;
345 void __iomem *lbam_addr;
346 void __iomem *lbah_addr;
347 void __iomem *device_addr;
348 void __iomem *status_addr;
349 void __iomem *command_addr;
350 void __iomem *altstatus_addr;
351 void __iomem *ctl_addr;
352 void __iomem *bmdma_addr;
353 void __iomem *scr_addr;
361 void __iomem * const *iomap;
362 unsigned int n_ports;
364 const struct ata_port_operations *ops;
366 struct ata_port *simplex_claimed; /* channel owning the DMA */
367 struct ata_port *ports[0];
370 struct ata_queued_cmd {
372 struct ata_device *dev;
374 struct scsi_cmnd *scsicmd;
375 void (*scsidone)(struct scsi_cmnd *);
377 struct ata_taskfile tf;
378 u8 cdb[ATAPI_CDB_LEN];
380 unsigned long flags; /* ATA_QCFLAG_xxx */
383 unsigned int orig_n_elem;
387 unsigned int pad_len;
388 unsigned int sect_size;
391 unsigned int curbytes;
394 unsigned int cursg_ofs;
396 struct scatterlist sgent;
397 struct scatterlist pad_sgent;
400 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
401 struct scatterlist *__sg;
403 unsigned int err_mask;
404 struct ata_taskfile result_tf;
405 ata_qc_cb_t complete_fn;
410 struct ata_port_stats {
411 unsigned long unhandled_irq;
412 unsigned long idle_irq;
413 unsigned long rw_reqbuf;
416 struct ata_ering_entry {
418 unsigned int err_mask;
424 struct ata_ering_entry ring[ATA_ERING_SIZE];
429 unsigned int devno; /* 0 or 1 */
430 unsigned long flags; /* ATA_DFLAG_xxx */
431 struct scsi_device *sdev; /* attached SCSI device */
432 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
433 u64 n_sectors; /* size of device, if ATA */
434 unsigned int class; /* ATA_DEV_xxx */
435 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
439 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
441 unsigned int multi_count; /* sectors count for
442 READ/WRITE MULTIPLE */
443 unsigned int max_sectors; /* per-device max sectors */
444 unsigned int cdb_len;
446 /* per-dev xfer mask */
447 unsigned int pio_mask;
448 unsigned int mwdma_mask;
449 unsigned int udma_mask;
451 /* for CHS addressing */
452 u16 cylinders; /* Number of cylinders */
453 u16 heads; /* Number of heads */
454 u16 sectors; /* Number of sectors per track */
457 struct ata_ering ering;
459 unsigned int horkage; /* List of broken features */
460 #ifdef CONFIG_ATA_ACPI
461 /* ACPI objects info */
462 acpi_handle obj_handle;
466 /* Offset into struct ata_device. Fields above it are maintained
467 * acress device init. Fields below are zeroed.
469 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
472 struct ata_device *dev; /* offending device */
473 u32 serror; /* SError from LLDD */
474 unsigned int err_mask; /* port-wide err_mask */
475 unsigned int action; /* ATA_EH_* action mask */
476 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
477 unsigned int flags; /* ATA_EHI_* flags */
479 unsigned int probe_mask;
481 char desc[ATA_EH_DESC_LEN];
485 struct ata_eh_context {
486 struct ata_eh_info i;
487 int tries[ATA_MAX_DEVICES];
488 unsigned int classes[ATA_MAX_DEVICES];
489 unsigned int did_probe_mask;
493 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
494 const struct ata_port_operations *ops;
496 unsigned long flags; /* ATA_FLAG_xxx */
497 unsigned int pflags; /* ATA_PFLAG_xxx */
498 unsigned int print_id; /* user visible unique port ID */
499 unsigned int port_no; /* 0 based port no. inside the host */
501 struct ata_prd *prd; /* our SG list */
502 dma_addr_t prd_dma; /* and its DMA mapping */
504 void *pad; /* array of DMA pad buffers */
507 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
509 u8 ctl; /* cache of ATA control register */
510 u8 last_ctl; /* Cache last written value */
511 unsigned int pio_mask;
512 unsigned int mwdma_mask;
513 unsigned int udma_mask;
514 unsigned int cbl; /* cable type; ATA_CBL_xxx */
515 unsigned int hw_sata_spd_limit;
516 unsigned int sata_spd_limit; /* SATA PHY speed limit */
518 /* record runtime error info, protected by host lock */
519 struct ata_eh_info eh_info;
520 /* EH context owned by EH */
521 struct ata_eh_context eh_context;
523 struct ata_device device[ATA_MAX_DEVICES];
525 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
526 unsigned long qc_allocated;
527 unsigned int qc_active;
529 unsigned int active_tag;
532 struct ata_port_stats stats;
533 struct ata_host *host;
536 void *port_task_data;
537 struct delayed_work port_task;
538 struct delayed_work hotplug_task;
539 struct work_struct scsi_rescan_task;
541 unsigned int hsm_task_state;
544 struct list_head eh_done_q;
545 wait_queue_head_t eh_wait_q;
547 pm_message_t pm_mesg;
552 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
555 struct ata_port_operations {
556 void (*port_disable) (struct ata_port *);
558 void (*dev_config) (struct ata_device *);
560 void (*set_piomode) (struct ata_port *, struct ata_device *);
561 void (*set_dmamode) (struct ata_port *, struct ata_device *);
562 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
564 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
565 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
567 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
568 u8 (*check_status)(struct ata_port *ap);
569 u8 (*check_altstatus)(struct ata_port *ap);
570 void (*dev_select)(struct ata_port *ap, unsigned int device);
572 void (*phy_reset) (struct ata_port *ap); /* obsolete */
573 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
575 int (*cable_detect) (struct ata_port *ap);
577 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
579 void (*bmdma_setup) (struct ata_queued_cmd *qc);
580 void (*bmdma_start) (struct ata_queued_cmd *qc);
582 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
584 void (*qc_prep) (struct ata_queued_cmd *qc);
585 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
587 /* Error handlers. ->error_handler overrides ->eng_timeout and
588 * indicates that new-style EH is in place.
590 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
592 void (*freeze) (struct ata_port *ap);
593 void (*thaw) (struct ata_port *ap);
594 void (*error_handler) (struct ata_port *ap);
595 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
597 irq_handler_t irq_handler;
598 void (*irq_clear) (struct ata_port *);
599 u8 (*irq_on) (struct ata_port *);
600 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
602 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
603 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
606 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
607 int (*port_resume) (struct ata_port *ap);
609 int (*port_start) (struct ata_port *ap);
610 void (*port_stop) (struct ata_port *ap);
612 void (*host_stop) (struct ata_host *host);
614 void (*bmdma_stop) (struct ata_queued_cmd *qc);
615 u8 (*bmdma_status) (struct ata_port *ap);
618 struct ata_port_info {
619 struct scsi_host_template *sht;
621 unsigned long pio_mask;
622 unsigned long mwdma_mask;
623 unsigned long udma_mask;
624 const struct ata_port_operations *port_ops;
625 irq_handler_t irq_handler;
630 unsigned short mode; /* ATA mode */
631 unsigned short setup; /* t1 */
632 unsigned short act8b; /* t2 for 8-bit I/O */
633 unsigned short rec8b; /* t2i for 8-bit I/O */
634 unsigned short cyc8b; /* t0 for 8-bit I/O */
635 unsigned short active; /* t2 or tD */
636 unsigned short recover; /* t2i or tK */
637 unsigned short cycle; /* t0 */
638 unsigned short udma; /* t2CYCTYP/2 */
641 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
643 extern const unsigned long sata_deb_timing_normal[];
644 extern const unsigned long sata_deb_timing_hotplug[];
645 extern const unsigned long sata_deb_timing_long[];
647 extern const struct ata_port_operations ata_dummy_port_ops;
648 extern const struct ata_port_info ata_dummy_port_info;
650 static inline const unsigned long *
651 sata_ehc_deb_timing(struct ata_eh_context *ehc)
653 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
654 return sata_deb_timing_hotplug;
656 return sata_deb_timing_normal;
659 static inline int ata_port_is_dummy(struct ata_port *ap)
661 return ap->ops == &ata_dummy_port_ops;
664 extern void sata_print_link_status(struct ata_port *ap);
665 extern void ata_port_probe(struct ata_port *);
666 extern void __sata_phy_reset(struct ata_port *ap);
667 extern void sata_phy_reset(struct ata_port *ap);
668 extern void ata_bus_reset(struct ata_port *ap);
669 extern int sata_set_spd(struct ata_port *ap);
670 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param,
671 unsigned long deadline);
672 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param,
673 unsigned long deadline);
674 extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
675 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
676 unsigned long deadline);
677 extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
678 unsigned long deadline);
679 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
680 unsigned long deadline);
681 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
682 extern void ata_port_disable(struct ata_port *);
683 extern void ata_std_ports(struct ata_ioports *ioaddr);
685 extern int ata_pci_init_one (struct pci_dev *pdev,
686 const struct ata_port_info * const * ppi);
687 extern void ata_pci_remove_one (struct pci_dev *pdev);
689 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
690 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
691 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
692 extern int ata_pci_device_resume(struct pci_dev *pdev);
694 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
695 #endif /* CONFIG_PCI */
696 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
697 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
698 const struct ata_port_info * const * ppi, int n_ports);
699 extern int ata_host_start(struct ata_host *host);
700 extern int ata_host_register(struct ata_host *host,
701 struct scsi_host_template *sht);
702 extern int ata_host_activate(struct ata_host *host, int irq,
703 irq_handler_t irq_handler, unsigned long irq_flags,
704 struct scsi_host_template *sht);
705 extern void ata_host_detach(struct ata_host *host);
706 extern void ata_host_init(struct ata_host *, struct device *,
707 unsigned long, const struct ata_port_operations *);
708 extern int ata_scsi_detect(struct scsi_host_template *sht);
709 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
710 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
711 extern void ata_sas_port_destroy(struct ata_port *);
712 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
713 struct ata_port_info *, struct Scsi_Host *);
714 extern int ata_sas_port_init(struct ata_port *);
715 extern int ata_sas_port_start(struct ata_port *ap);
716 extern void ata_sas_port_stop(struct ata_port *ap);
717 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
718 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
719 struct ata_port *ap);
720 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
721 extern int sata_scr_valid(struct ata_port *ap);
722 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
723 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
724 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
725 extern int ata_port_online(struct ata_port *ap);
726 extern int ata_port_offline(struct ata_port *ap);
728 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
729 extern void ata_host_resume(struct ata_host *host);
731 extern int ata_ratelimit(void);
732 extern int ata_busy_sleep(struct ata_port *ap,
733 unsigned long timeout_pat, unsigned long timeout);
734 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
735 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
736 void *data, unsigned long delay);
737 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
738 unsigned long interval_msec,
739 unsigned long timeout_msec);
740 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
743 * Default driver ops implementations
745 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
746 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
747 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
748 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
749 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
750 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
751 extern u8 ata_check_status(struct ata_port *ap);
752 extern u8 ata_altstatus(struct ata_port *ap);
753 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
754 extern int ata_port_start (struct ata_port *ap);
755 extern int ata_sff_port_start (struct ata_port *ap);
756 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
757 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
758 unsigned int buflen, int write_data);
759 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
760 unsigned int buflen, int write_data);
761 extern void ata_qc_prep(struct ata_queued_cmd *qc);
762 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
763 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
764 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
765 unsigned int buflen);
766 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
767 unsigned int n_elem);
768 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
769 extern void ata_dev_disable(struct ata_device *adev);
770 extern void ata_id_string(const u16 *id, unsigned char *s,
771 unsigned int ofs, unsigned int len);
772 extern void ata_id_c_string(const u16 *id, unsigned char *s,
773 unsigned int ofs, unsigned int len);
774 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
775 extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
776 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
777 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
778 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
779 extern u8 ata_bmdma_status(struct ata_port *ap);
780 extern void ata_bmdma_irq_clear(struct ata_port *ap);
781 extern void ata_bmdma_freeze(struct ata_port *ap);
782 extern void ata_bmdma_thaw(struct ata_port *ap);
783 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
784 ata_reset_fn_t softreset,
785 ata_reset_fn_t hardreset,
786 ata_postreset_fn_t postreset);
787 extern void ata_bmdma_error_handler(struct ata_port *ap);
788 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
789 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
790 u8 status, int in_wq);
791 extern void ata_qc_complete(struct ata_queued_cmd *qc);
792 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
793 void (*finish_qc)(struct ata_queued_cmd *));
794 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
795 void (*done)(struct scsi_cmnd *));
796 extern int ata_std_bios_param(struct scsi_device *sdev,
797 struct block_device *bdev,
798 sector_t capacity, int geom[]);
799 extern int ata_scsi_slave_config(struct scsi_device *sdev);
800 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
801 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
803 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
804 extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
805 extern u8 ata_irq_on(struct ata_port *ap);
806 extern u8 ata_dummy_irq_on(struct ata_port *ap);
807 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
808 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
810 extern int ata_cable_40wire(struct ata_port *ap);
811 extern int ata_cable_80wire(struct ata_port *ap);
812 extern int ata_cable_sata(struct ata_port *ap);
813 extern int ata_cable_unknown(struct ata_port *ap);
819 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
820 extern int ata_timing_compute(struct ata_device *, unsigned short,
821 struct ata_timing *, int, int);
822 extern void ata_timing_merge(const struct ata_timing *,
823 const struct ata_timing *, struct ata_timing *,
827 ATA_TIMING_SETUP = (1 << 0),
828 ATA_TIMING_ACT8B = (1 << 1),
829 ATA_TIMING_REC8B = (1 << 2),
830 ATA_TIMING_CYC8B = (1 << 3),
831 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
833 ATA_TIMING_ACTIVE = (1 << 4),
834 ATA_TIMING_RECOVER = (1 << 5),
835 ATA_TIMING_CYCLE = (1 << 6),
836 ATA_TIMING_UDMA = (1 << 7),
837 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
838 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
839 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
840 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
846 unsigned int reg; /* PCI config register to read */
847 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
852 extern int ata_pci_init_native_host(struct ata_host *host);
853 extern int ata_pci_init_bmdma(struct ata_host *host);
854 extern int ata_pci_prepare_native_host(struct pci_dev *pdev,
855 const struct ata_port_info * const * ppi,
856 struct ata_host **r_host);
857 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
858 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
859 #endif /* CONFIG_PCI */
864 extern void ata_eng_timeout(struct ata_port *ap);
866 extern void ata_port_schedule_eh(struct ata_port *ap);
867 extern int ata_port_abort(struct ata_port *ap);
868 extern int ata_port_freeze(struct ata_port *ap);
870 extern void ata_eh_freeze_port(struct ata_port *ap);
871 extern void ata_eh_thaw_port(struct ata_port *ap);
873 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
874 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
876 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
877 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
878 ata_postreset_fn_t postreset);
883 #define ata_port_printk(ap, lv, fmt, args...) \
884 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
886 #define ata_dev_printk(dev, lv, fmt, args...) \
887 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
890 * ata_eh_info helpers
892 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
893 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
894 ATA_EH_DESC_LEN - (ehi)->desc_len, \
898 #define ata_ehi_clear_desc(ehi) do { \
899 (ehi)->desc[0] = '\0'; \
900 (ehi)->desc_len = 0; \
903 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
905 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
906 ehi->action |= ATA_EH_SOFTRESET;
907 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
910 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
912 __ata_ehi_hotplugged(ehi);
913 ehi->err_mask |= AC_ERR_ATA_BUS;
920 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
922 if (sg == &qc->pad_sgent)
926 if (((sg - qc->__sg) + 1) == qc->n_elem)
931 static inline struct scatterlist *
932 ata_qc_first_sg(struct ata_queued_cmd *qc)
937 return &qc->pad_sgent;
941 static inline struct scatterlist *
942 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
944 if (sg == &qc->pad_sgent)
946 if (++sg - qc->__sg < qc->n_elem)
949 return &qc->pad_sgent;
953 #define ata_for_each_sg(sg, qc) \
954 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
956 static inline unsigned int ata_tag_valid(unsigned int tag)
958 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
961 static inline unsigned int ata_tag_internal(unsigned int tag)
963 return tag == ATA_MAX_QUEUE - 1;
969 static inline unsigned int ata_class_enabled(unsigned int class)
971 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
974 static inline unsigned int ata_class_disabled(unsigned int class)
976 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
979 static inline unsigned int ata_class_absent(unsigned int class)
981 return !ata_class_enabled(class) && !ata_class_disabled(class);
984 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
986 return ata_class_enabled(dev->class);
989 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
991 return ata_class_disabled(dev->class);
994 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
996 return ata_class_absent(dev->class);
1002 static inline int ata_port_max_devices(const struct ata_port *ap)
1004 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1010 static inline u8 ata_chk_status(struct ata_port *ap)
1012 return ap->ops->check_status(ap);
1016 * ata_ncq_enabled - Test whether NCQ is enabled
1017 * @dev: ATA device to test for
1020 * spin_lock_irqsave(host lock)
1023 * 1 if NCQ is enabled for @dev, 0 otherwise.
1025 static inline int ata_ncq_enabled(struct ata_device *dev)
1027 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1028 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1032 * ata_pause - Flush writes and pause 400 nanoseconds.
1033 * @ap: Port to wait for.
1036 * Inherited from caller.
1039 static inline void ata_pause(struct ata_port *ap)
1047 * ata_busy_wait - Wait for a port status register
1048 * @ap: Port to wait for.
1049 * @bits: bits that must be clear
1050 * @max: number of 10uS waits to perform
1052 * Waits up to max*10 microseconds for the selected bits in the port's
1053 * status register to be cleared.
1054 * Returns final value of status register.
1057 * Inherited from caller.
1060 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1067 status = ata_chk_status(ap);
1069 } while (status != 0xff && (status & bits) && (max > 0));
1076 * ata_wait_idle - Wait for a port to be idle.
1077 * @ap: Port to wait for.
1079 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1080 * Returns final value of status register.
1083 * Inherited from caller.
1086 static inline u8 ata_wait_idle(struct ata_port *ap)
1088 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1090 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1091 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1092 status, ap->ioaddr.status_addr);
1097 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1099 qc->tf.ctl |= ATA_NIEN;
1102 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1105 if (likely(ata_tag_valid(tag)))
1106 return &ap->qcmd[tag];
1110 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1113 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1115 if (unlikely(!qc) || !ap->ops->error_handler)
1118 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1119 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1125 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1127 memset(tf, 0, sizeof(*tf));
1129 tf->ctl = dev->ap->ctl;
1130 if (dev->devno == 0)
1131 tf->device = ATA_DEVICE_OBS;
1133 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1136 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1138 qc->dma_dir = DMA_NONE;
1141 qc->cursg = qc->cursg_ofs = 0;
1142 qc->nbytes = qc->curbytes = 0;
1146 qc->sect_size = ATA_SECT_SIZE;
1148 ata_tf_init(qc->dev, &qc->tf);
1150 /* init result_tf such that it indicates normal completion */
1151 qc->result_tf.command = ATA_DRDY;
1152 qc->result_tf.feature = 0;
1155 static inline int ata_try_flush_cache(const struct ata_device *dev)
1157 return ata_id_wcache_enabled(dev->id) ||
1158 ata_id_has_flush(dev->id) ||
1159 ata_id_has_flush_ext(dev->id);
1162 static inline unsigned int ac_err_mask(u8 status)
1164 if (status & (ATA_BUSY | ATA_DRQ))
1166 if (status & (ATA_ERR | ATA_DF))
1171 static inline unsigned int __ac_err_mask(u8 status)
1173 unsigned int mask = ac_err_mask(status);
1175 return AC_ERR_OTHER;
1179 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1182 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1183 &ap->pad_dma, GFP_KERNEL);
1184 return (ap->pad == NULL) ? -ENOMEM : 0;
1187 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1189 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1192 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1194 return *(struct ata_port **)&host->hostdata[0];
1197 #endif /* __LINUX_LIBATA_H__ */