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>
40 * Define if arch has non-standard setup. This is a _PCI_ standard
41 * not a legacy or ISA standard.
43 #ifdef CONFIG_ATA_NONSTANDARD
44 #include <asm/libata-portmap.h>
46 #include <asm-generic/libata-portmap.h>
50 * compile-time options: to be removed as soon as all the drivers are
51 * converted to the new debugging mechanism
53 #undef ATA_DEBUG /* debugging output */
54 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
55 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
56 #undef ATA_NDEBUG /* define to disable quick runtime checks */
57 #define ATA_ENABLE_PATA /* define to enable PATA support in some
58 * low-level drivers */
61 /* note: prints function name for you */
63 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64 #ifdef ATA_VERBOSE_DEBUG
65 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
67 #define VPRINTK(fmt, args...)
68 #endif /* ATA_VERBOSE_DEBUG */
70 #define DPRINTK(fmt, args...)
71 #define VPRINTK(fmt, args...)
72 #endif /* ATA_DEBUG */
74 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
76 /* NEW: debug levels */
77 #define HAVE_LIBATA_MSG 1
81 ATA_MSG_INFO = 0x0002,
82 ATA_MSG_PROBE = 0x0004,
83 ATA_MSG_WARN = 0x0008,
84 ATA_MSG_MALLOC = 0x0010,
86 ATA_MSG_INTR = 0x0040,
90 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
91 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
92 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
93 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
94 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
96 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
97 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
99 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
101 if (dval < 0 || dval >= (sizeof(u32) * 8))
102 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
105 return (1 << dval) - 1;
108 /* defines only for the constants which don't work well as enums */
109 #define ATA_TAG_POISON 0xfafbfcfdU
111 /* move to PCI layer? */
112 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
118 /* various global constants */
119 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
122 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
124 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
126 ATA_DEF_BUSY_WAIT = 10000,
127 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
129 ATA_SHT_EMULATED = 1,
130 ATA_SHT_CMD_PER_LUN = 1,
131 ATA_SHT_THIS_ID = -1,
132 ATA_SHT_USE_CLUSTERING = 1,
134 /* struct ata_device stuff */
135 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
136 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
137 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
138 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
139 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
140 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
142 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
143 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
144 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
145 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
147 ATA_DFLAG_DETACH = (1 << 16),
148 ATA_DFLAG_DETACHED = (1 << 17),
150 ATA_DEV_UNKNOWN = 0, /* unknown device */
151 ATA_DEV_ATA = 1, /* ATA device */
152 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
153 ATA_DEV_ATAPI = 3, /* ATAPI device */
154 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
155 ATA_DEV_NONE = 5, /* no device */
157 /* struct ata_port flags */
158 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
159 /* (doesn't imply presence) */
160 ATA_FLAG_SATA = (1 << 1),
161 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
162 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
163 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
164 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
165 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
166 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
167 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
168 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
169 * doesn't handle PIO interrupts */
170 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
171 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
172 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
173 * Register FIS clearing BSY */
174 ATA_FLAG_DEBUGMSG = (1 << 13),
175 ATA_FLAG_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
176 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
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 */
214 /* various lengths of time */
215 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
216 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
217 ATA_TMOUT_INTERNAL = 30 * HZ,
218 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
232 /* SATA port states */
237 /* encoding various smaller bitmaps into a single
238 * unsigned int bitmap
245 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
246 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
248 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
249 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
250 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
252 /* size of buffer to pad xfers ending on unaligned boundaries */
254 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
256 /* masks for port functions */
257 ATA_PORT_PRIMARY = (1 << 0),
258 ATA_PORT_SECONDARY = (1 << 1),
263 /* desc_len for ata_eh_info and context */
264 ATA_EH_DESC_LEN = 80,
266 /* reset / recovery action types */
267 ATA_EH_REVALIDATE = (1 << 0),
268 ATA_EH_SOFTRESET = (1 << 1),
269 ATA_EH_HARDRESET = (1 << 2),
270 ATA_EH_SUSPEND = (1 << 3),
271 ATA_EH_RESUME = (1 << 4),
272 ATA_EH_PM_FREEZE = (1 << 5),
274 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
275 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
276 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
278 /* ata_eh_info->flags */
279 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
280 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
281 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
282 ATA_EHI_QUIET = (1 << 3), /* be quiet */
284 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
285 ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */
286 ATA_EHI_SETMODE = (1 << 18), /* configure transfer mode */
287 ATA_EHI_POST_SETMODE = (1 << 19), /* revaildating after setmode */
289 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
291 /* max repeat if error condition is still set after ->error_handler */
292 ATA_EH_MAX_REPEAT = 5,
294 /* how hard are we gonna try to probe/recover devices */
295 ATA_PROBE_MAX_TRIES = 3,
296 ATA_EH_RESET_TRIES = 3,
297 ATA_EH_DEV_TRIES = 3,
299 /* Drive spinup time (time from power-on to the first D2H FIS)
300 * in msecs - 8s currently. Failing to get ready in this time
301 * isn't critical. It will result in reset failure for
302 * controllers which can't wait for the first D2H FIS. libata
303 * will retry, so it just has to be long enough to spin up
306 ATA_SPINUP_WAIT = 8000,
308 /* Horkage types. May be set by libata or controller on drives
309 (some horkage may be drive/controller pair dependant */
311 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
312 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
313 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
316 enum hsm_task_states {
317 HSM_ST_IDLE, /* no command on going */
318 HSM_ST, /* (waiting the device to) transfer data */
319 HSM_ST_LAST, /* (waiting the device to) complete command */
320 HSM_ST_ERR, /* error */
321 HSM_ST_FIRST, /* (waiting the device to)
322 write CDB or first data block */
325 enum ata_completion_errors {
326 AC_ERR_DEV = (1 << 0), /* device reported error */
327 AC_ERR_HSM = (1 << 1), /* host state machine violation */
328 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
329 AC_ERR_MEDIA = (1 << 3), /* media error */
330 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
331 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
332 AC_ERR_SYSTEM = (1 << 6), /* system error */
333 AC_ERR_INVALID = (1 << 7), /* invalid argument */
334 AC_ERR_OTHER = (1 << 8), /* unknown */
335 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
338 /* forward declarations */
340 struct ata_port_operations;
342 struct ata_queued_cmd;
345 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
346 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
347 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
348 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
351 unsigned long cmd_addr;
352 unsigned long data_addr;
353 unsigned long error_addr;
354 unsigned long feature_addr;
355 unsigned long nsect_addr;
356 unsigned long lbal_addr;
357 unsigned long lbam_addr;
358 unsigned long lbah_addr;
359 unsigned long device_addr;
360 unsigned long status_addr;
361 unsigned long command_addr;
362 unsigned long altstatus_addr;
363 unsigned long ctl_addr;
364 unsigned long bmdma_addr;
365 unsigned long scr_addr;
368 struct ata_probe_ent {
369 struct list_head node;
371 const struct ata_port_operations *port_ops;
372 struct scsi_host_template *sht;
373 struct ata_ioports port[ATA_MAX_PORTS];
374 unsigned int n_ports;
375 unsigned int dummy_port_mask;
376 unsigned int pio_mask;
377 unsigned int mwdma_mask;
378 unsigned int udma_mask;
381 unsigned int irq_flags;
382 unsigned long port_flags;
383 unsigned long _host_flags;
384 void __iomem *mmio_base;
387 /* port_info for the secondary port. Together with irq2, it's
388 * used to implement non-uniform secondary port. Currently,
389 * the only user is ata_piix combined mode. This workaround
390 * will be removed together with ata_probe_ent when init model
393 const struct ata_port_info *pinfo2;
401 void __iomem *mmio_base;
402 unsigned int n_ports;
404 const struct ata_port_operations *ops;
406 int simplex_claimed; /* Keep seperate in case we
407 ever need to do this locked */
408 struct ata_port *ports[0];
411 struct ata_queued_cmd {
413 struct ata_device *dev;
415 struct scsi_cmnd *scsicmd;
416 void (*scsidone)(struct scsi_cmnd *);
418 struct ata_taskfile tf;
419 u8 cdb[ATAPI_CDB_LEN];
421 unsigned long flags; /* ATA_QCFLAG_xxx */
424 unsigned int orig_n_elem;
428 unsigned int pad_len;
431 unsigned int cursect;
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;
501 unsigned int horkage; /* List of broken features */
504 /* Offset into struct ata_device. Fields above it are maintained
505 * acress device init. Fields below are zeroed.
507 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
510 struct ata_device *dev; /* offending device */
511 u32 serror; /* SError from LLDD */
512 unsigned int err_mask; /* port-wide err_mask */
513 unsigned int action; /* ATA_EH_* action mask */
514 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
515 unsigned int flags; /* ATA_EHI_* flags */
517 unsigned long hotplug_timestamp;
518 unsigned int probe_mask;
520 char desc[ATA_EH_DESC_LEN];
524 struct ata_eh_context {
525 struct ata_eh_info i;
526 int tries[ATA_MAX_DEVICES];
527 unsigned int classes[ATA_MAX_DEVICES];
528 unsigned int did_probe_mask;
532 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
533 const struct ata_port_operations *ops;
535 unsigned long flags; /* ATA_FLAG_xxx */
536 unsigned int pflags; /* ATA_PFLAG_xxx */
537 unsigned int id; /* unique id req'd by scsi midlyr */
538 unsigned int port_no; /* unique port #; from zero */
540 struct ata_prd *prd; /* our SG list */
541 dma_addr_t prd_dma; /* and its DMA mapping */
543 void *pad; /* array of DMA pad buffers */
546 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
548 u8 ctl; /* cache of ATA control register */
549 u8 last_ctl; /* Cache last written value */
550 unsigned int pio_mask;
551 unsigned int mwdma_mask;
552 unsigned int udma_mask;
553 unsigned int cbl; /* cable type; ATA_CBL_xxx */
554 unsigned int hw_sata_spd_limit;
555 unsigned int sata_spd_limit; /* SATA PHY speed limit */
557 /* record runtime error info, protected by host lock */
558 struct ata_eh_info eh_info;
559 /* EH context owned by EH */
560 struct ata_eh_context eh_context;
562 struct ata_device device[ATA_MAX_DEVICES];
564 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
565 unsigned long qc_allocated;
566 unsigned int qc_active;
568 unsigned int active_tag;
571 struct ata_port_stats stats;
572 struct ata_host *host;
575 void *port_task_data;
576 struct delayed_work port_task;
577 struct delayed_work hotplug_task;
578 struct work_struct scsi_rescan_task;
580 unsigned int hsm_task_state;
583 struct list_head eh_done_q;
584 wait_queue_head_t eh_wait_q;
586 pm_message_t pm_mesg;
591 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
594 struct ata_port_operations {
595 void (*port_disable) (struct ata_port *);
597 void (*dev_config) (struct ata_port *, struct ata_device *);
599 void (*set_piomode) (struct ata_port *, struct ata_device *);
600 void (*set_dmamode) (struct ata_port *, struct ata_device *);
601 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
603 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
604 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
606 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
607 u8 (*check_status)(struct ata_port *ap);
608 u8 (*check_altstatus)(struct ata_port *ap);
609 void (*dev_select)(struct ata_port *ap, unsigned int device);
611 void (*phy_reset) (struct ata_port *ap); /* obsolete */
612 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
614 void (*post_set_mode) (struct ata_port *ap);
616 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
618 void (*bmdma_setup) (struct ata_queued_cmd *qc);
619 void (*bmdma_start) (struct ata_queued_cmd *qc);
621 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
623 void (*qc_prep) (struct ata_queued_cmd *qc);
624 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
626 /* Error handlers. ->error_handler overrides ->eng_timeout and
627 * indicates that new-style EH is in place.
629 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
631 void (*freeze) (struct ata_port *ap);
632 void (*thaw) (struct ata_port *ap);
633 void (*error_handler) (struct ata_port *ap);
634 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
636 irq_handler_t irq_handler;
637 void (*irq_clear) (struct ata_port *);
639 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
640 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
643 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
644 int (*port_resume) (struct ata_port *ap);
646 int (*port_start) (struct ata_port *ap);
647 void (*port_stop) (struct ata_port *ap);
649 void (*host_stop) (struct ata_host *host);
651 void (*bmdma_stop) (struct ata_queued_cmd *qc);
652 u8 (*bmdma_status) (struct ata_port *ap);
655 struct ata_port_info {
656 struct scsi_host_template *sht;
658 unsigned long pio_mask;
659 unsigned long mwdma_mask;
660 unsigned long udma_mask;
661 const struct ata_port_operations *port_ops;
666 unsigned short mode; /* ATA mode */
667 unsigned short setup; /* t1 */
668 unsigned short act8b; /* t2 for 8-bit I/O */
669 unsigned short rec8b; /* t2i for 8-bit I/O */
670 unsigned short cyc8b; /* t0 for 8-bit I/O */
671 unsigned short active; /* t2 or tD */
672 unsigned short recover; /* t2i or tK */
673 unsigned short cycle; /* t0 */
674 unsigned short udma; /* t2CYCTYP/2 */
677 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
679 extern const unsigned long sata_deb_timing_normal[];
680 extern const unsigned long sata_deb_timing_hotplug[];
681 extern const unsigned long sata_deb_timing_long[];
683 extern const struct ata_port_operations ata_dummy_port_ops;
685 static inline const unsigned long *
686 sata_ehc_deb_timing(struct ata_eh_context *ehc)
688 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
689 return sata_deb_timing_hotplug;
691 return sata_deb_timing_normal;
694 static inline int ata_port_is_dummy(struct ata_port *ap)
696 return ap->ops == &ata_dummy_port_ops;
699 extern void ata_port_probe(struct ata_port *);
700 extern void __sata_phy_reset(struct ata_port *ap);
701 extern void sata_phy_reset(struct ata_port *ap);
702 extern void ata_bus_reset(struct ata_port *ap);
703 extern int sata_set_spd(struct ata_port *ap);
704 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
705 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
706 extern int ata_std_prereset(struct ata_port *ap);
707 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
708 extern int sata_port_hardreset(struct ata_port *ap,
709 const unsigned long *timing);
710 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
711 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
712 extern void ata_port_disable(struct ata_port *);
713 extern void ata_std_ports(struct ata_ioports *ioaddr);
715 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
716 unsigned int n_ports);
717 extern void ata_pci_remove_one (struct pci_dev *pdev);
718 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
719 extern void ata_pci_device_do_resume(struct pci_dev *pdev);
720 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
721 extern int ata_pci_device_resume(struct pci_dev *pdev);
722 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
723 #endif /* CONFIG_PCI */
724 extern int ata_device_add(const struct ata_probe_ent *ent);
725 extern void ata_port_detach(struct ata_port *ap);
726 extern void ata_host_init(struct ata_host *, struct device *,
727 unsigned long, const struct ata_port_operations *);
728 extern void ata_host_remove(struct ata_host *host);
729 extern int ata_scsi_detect(struct scsi_host_template *sht);
730 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
731 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
732 extern int ata_scsi_release(struct Scsi_Host *host);
733 extern void ata_sas_port_destroy(struct ata_port *);
734 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
735 struct ata_port_info *, struct Scsi_Host *);
736 extern int ata_sas_port_init(struct ata_port *);
737 extern int ata_sas_port_start(struct ata_port *ap);
738 extern void ata_sas_port_stop(struct ata_port *ap);
739 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
740 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
741 struct ata_port *ap);
742 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
743 extern int sata_scr_valid(struct ata_port *ap);
744 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
745 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
746 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
747 extern int ata_port_online(struct ata_port *ap);
748 extern int ata_port_offline(struct ata_port *ap);
749 extern int ata_scsi_device_resume(struct scsi_device *);
750 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
751 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
752 extern void ata_host_resume(struct ata_host *host);
753 extern int ata_ratelimit(void);
754 extern int ata_busy_sleep(struct ata_port *ap,
755 unsigned long timeout_pat, unsigned long timeout);
756 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
757 void *data, unsigned long delay);
758 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
759 unsigned long interval_msec,
760 unsigned long timeout_msec);
763 * Default driver ops implementations
765 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
766 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
767 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
768 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
769 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
770 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
771 extern u8 ata_check_status(struct ata_port *ap);
772 extern u8 ata_altstatus(struct ata_port *ap);
773 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
774 extern int ata_port_start (struct ata_port *ap);
775 extern void ata_port_stop (struct ata_port *ap);
776 extern void ata_host_stop (struct ata_host *host);
777 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
778 extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
779 unsigned int buflen, int write_data);
780 extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
781 unsigned int buflen, int write_data);
782 extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
783 unsigned int buflen, int write_data);
784 extern void ata_qc_prep(struct ata_queued_cmd *qc);
785 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
786 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
787 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
788 unsigned int buflen);
789 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
790 unsigned int n_elem);
791 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
792 extern void ata_id_string(const u16 *id, unsigned char *s,
793 unsigned int ofs, unsigned int len);
794 extern void ata_id_c_string(const u16 *id, unsigned char *s,
795 unsigned int ofs, unsigned int len);
796 extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
797 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
798 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
799 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
800 extern u8 ata_bmdma_status(struct ata_port *ap);
801 extern void ata_bmdma_irq_clear(struct ata_port *ap);
802 extern void ata_bmdma_freeze(struct ata_port *ap);
803 extern void ata_bmdma_thaw(struct ata_port *ap);
804 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
805 ata_reset_fn_t softreset,
806 ata_reset_fn_t hardreset,
807 ata_postreset_fn_t postreset);
808 extern void ata_bmdma_error_handler(struct ata_port *ap);
809 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
810 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
811 u8 status, int in_wq);
812 extern void ata_qc_complete(struct ata_queued_cmd *qc);
813 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
814 void (*finish_qc)(struct ata_queued_cmd *));
815 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
816 void (*done)(struct scsi_cmnd *));
817 extern int ata_std_bios_param(struct scsi_device *sdev,
818 struct block_device *bdev,
819 sector_t capacity, int geom[]);
820 extern int ata_scsi_slave_config(struct scsi_device *sdev);
821 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
822 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
824 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
830 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
831 extern int ata_timing_compute(struct ata_device *, unsigned short,
832 struct ata_timing *, int, int);
833 extern void ata_timing_merge(const struct ata_timing *,
834 const struct ata_timing *, struct ata_timing *,
838 ATA_TIMING_SETUP = (1 << 0),
839 ATA_TIMING_ACT8B = (1 << 1),
840 ATA_TIMING_REC8B = (1 << 2),
841 ATA_TIMING_CYC8B = (1 << 3),
842 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
844 ATA_TIMING_ACTIVE = (1 << 4),
845 ATA_TIMING_RECOVER = (1 << 5),
846 ATA_TIMING_CYCLE = (1 << 6),
847 ATA_TIMING_UDMA = (1 << 7),
848 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
849 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
850 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
851 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
857 unsigned int reg; /* PCI config register to read */
858 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
863 extern void ata_pci_host_stop (struct ata_host *host);
864 extern struct ata_probe_ent *
865 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
866 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
867 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
868 #endif /* CONFIG_PCI */
873 extern void ata_eng_timeout(struct ata_port *ap);
875 extern void ata_port_schedule_eh(struct ata_port *ap);
876 extern int ata_port_abort(struct ata_port *ap);
877 extern int ata_port_freeze(struct ata_port *ap);
879 extern void ata_eh_freeze_port(struct ata_port *ap);
880 extern void ata_eh_thaw_port(struct ata_port *ap);
882 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
883 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
885 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
886 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
887 ata_postreset_fn_t postreset);
892 #define ata_port_printk(ap, lv, fmt, args...) \
893 printk(lv"ata%u: "fmt, (ap)->id , ##args)
895 #define ata_dev_printk(dev, lv, fmt, args...) \
896 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
899 * ata_eh_info helpers
901 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
902 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
903 ATA_EH_DESC_LEN - (ehi)->desc_len, \
907 #define ata_ehi_clear_desc(ehi) do { \
908 (ehi)->desc[0] = '\0'; \
909 (ehi)->desc_len = 0; \
912 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
914 if (ehi->flags & ATA_EHI_HOTPLUGGED)
917 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
918 ehi->hotplug_timestamp = jiffies;
920 ehi->action |= ATA_EH_SOFTRESET;
921 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
924 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
926 __ata_ehi_hotplugged(ehi);
927 ehi->err_mask |= AC_ERR_ATA_BUS;
934 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
936 if (sg == &qc->pad_sgent)
940 if (((sg - qc->__sg) + 1) == qc->n_elem)
945 static inline struct scatterlist *
946 ata_qc_first_sg(struct ata_queued_cmd *qc)
951 return &qc->pad_sgent;
955 static inline struct scatterlist *
956 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
958 if (sg == &qc->pad_sgent)
960 if (++sg - qc->__sg < qc->n_elem)
963 return &qc->pad_sgent;
967 #define ata_for_each_sg(sg, qc) \
968 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
970 static inline unsigned int ata_tag_valid(unsigned int tag)
972 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
975 static inline unsigned int ata_tag_internal(unsigned int tag)
977 return tag == ATA_MAX_QUEUE - 1;
983 static inline unsigned int ata_class_enabled(unsigned int class)
985 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
988 static inline unsigned int ata_class_disabled(unsigned int class)
990 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
993 static inline unsigned int ata_class_absent(unsigned int class)
995 return !ata_class_enabled(class) && !ata_class_disabled(class);
998 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1000 return ata_class_enabled(dev->class);
1003 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1005 return ata_class_disabled(dev->class);
1008 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1010 return ata_class_absent(dev->class);
1013 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1015 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1021 static inline int ata_port_max_devices(const struct ata_port *ap)
1023 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1029 static inline u8 ata_chk_status(struct ata_port *ap)
1031 return ap->ops->check_status(ap);
1036 * ata_pause - Flush writes and pause 400 nanoseconds.
1037 * @ap: Port to wait for.
1040 * Inherited from caller.
1043 static inline void ata_pause(struct ata_port *ap)
1051 * ata_busy_wait - Wait for a port status register
1052 * @ap: Port to wait for.
1053 * @bits: bits that must be clear
1054 * @max: number of 10uS waits to perform
1056 * Waits up to max*10 microseconds for the selected bits in the port's
1057 * status register to be cleared.
1058 * Returns final value of status register.
1061 * Inherited from caller.
1064 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1071 status = ata_chk_status(ap);
1073 } while (status != 0xff && (status & bits) && (max > 0));
1080 * ata_wait_idle - Wait for a port to be idle.
1081 * @ap: Port to wait for.
1083 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1084 * Returns final value of status register.
1087 * Inherited from caller.
1090 static inline u8 ata_wait_idle(struct ata_port *ap)
1092 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1094 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
1095 unsigned long l = ap->ioaddr.status_addr;
1096 if (ata_msg_warn(ap))
1097 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1104 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1106 qc->tf.ctl |= ATA_NIEN;
1109 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1112 if (likely(ata_tag_valid(tag)))
1113 return &ap->qcmd[tag];
1117 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1120 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1122 if (unlikely(!qc) || !ap->ops->error_handler)
1125 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1126 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1132 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1134 memset(tf, 0, sizeof(*tf));
1136 tf->ctl = dev->ap->ctl;
1137 if (dev->devno == 0)
1138 tf->device = ATA_DEVICE_OBS;
1140 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1143 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1145 qc->dma_dir = DMA_NONE;
1148 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1150 qc->nbytes = qc->curbytes = 0;
1155 ata_tf_init(qc->dev, &qc->tf);
1157 /* init result_tf such that it indicates normal completion */
1158 qc->result_tf.command = ATA_DRDY;
1159 qc->result_tf.feature = 0;
1163 * ata_irq_ack - Acknowledge a device interrupt.
1164 * @ap: Port on which interrupts are enabled.
1166 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1167 * or BUSY+DRQ clear). Obtain dma status and port status from
1168 * device. Clear the interrupt. Return port status.
1173 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1175 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1176 u8 host_stat, post_stat, status;
1178 status = ata_busy_wait(ap, bits, 1000);
1180 if (ata_msg_err(ap))
1181 printk(KERN_ERR "abnormal status 0x%X\n", status);
1183 /* get controller status; clear intr, err bits */
1184 if (ap->flags & ATA_FLAG_MMIO) {
1185 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1186 host_stat = readb(mmio + ATA_DMA_STATUS);
1187 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1188 mmio + ATA_DMA_STATUS);
1190 post_stat = readb(mmio + ATA_DMA_STATUS);
1192 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1193 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1194 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1196 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1199 if (ata_msg_intr(ap))
1200 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1202 host_stat, post_stat, status);
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 = dma_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 dma_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__ */