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,
119 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
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_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
141 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
142 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
144 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
145 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
146 ATA_DFLAG_SPUNDOWN = (1 << 10), /* XXX: for spindown_compat */
147 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
149 ATA_DFLAG_DETACH = (1 << 16),
150 ATA_DFLAG_DETACHED = (1 << 17),
152 ATA_DEV_UNKNOWN = 0, /* unknown device */
153 ATA_DEV_ATA = 1, /* ATA device */
154 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
155 ATA_DEV_ATAPI = 3, /* ATAPI device */
156 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
157 ATA_DEV_NONE = 5, /* no device */
159 /* struct ata_port flags */
160 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
161 /* (doesn't imply presence) */
162 ATA_FLAG_SATA = (1 << 1),
163 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
164 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
165 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
166 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
167 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
168 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
169 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
170 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
171 * doesn't handle PIO interrupts */
172 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
173 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
174 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
175 * Register FIS clearing BSY */
176 ATA_FLAG_DEBUGMSG = (1 << 13),
177 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
178 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
179 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
181 /* The following flag belongs to ap->pflags but is kept in
182 * ap->flags because it's referenced in many LLDs and will be
183 * removed in not-too-distant future.
185 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
187 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
189 /* struct ata_port pflags */
190 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
191 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
192 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
193 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
194 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
195 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
196 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
197 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
199 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
200 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
201 ATA_PFLAG_GTM_VALID = (1 << 19), /* acpi_gtm data valid */
203 /* struct ata_queued_cmd flags */
204 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
205 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
206 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
207 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
208 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
209 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
211 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
212 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
213 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
216 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
217 ATA_HOST_STARTED = (1 << 1), /* Host started */
219 /* various lengths of time */
220 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
221 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
222 ATA_TMOUT_INTERNAL = 30 * HZ,
223 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
237 /* SATA port states */
242 /* encoding various smaller bitmaps into a single
243 * unsigned int bitmap
250 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
251 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
253 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
254 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
255 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
257 /* size of buffer to pad xfers ending on unaligned boundaries */
259 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
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),
272 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
273 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
275 /* ata_eh_info->flags */
276 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
277 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
278 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
279 ATA_EHI_QUIET = (1 << 3), /* be quiet */
281 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
282 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
283 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
284 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
285 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
287 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
288 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
290 /* max repeat if error condition is still set after ->error_handler */
291 ATA_EH_MAX_REPEAT = 5,
293 /* how hard are we gonna try to probe/recover devices */
294 ATA_PROBE_MAX_TRIES = 3,
295 ATA_EH_DEV_TRIES = 3,
297 /* Horkage types. May be set by libata or controller on drives
298 (some horkage may be drive/controller pair dependant */
300 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
301 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
302 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
303 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
306 enum hsm_task_states {
307 HSM_ST_IDLE, /* no command on going */
308 HSM_ST_FIRST, /* (waiting the device to)
309 write CDB or first data block */
310 HSM_ST, /* (waiting the device to) transfer data */
311 HSM_ST_LAST, /* (waiting the device to) complete command */
312 HSM_ST_ERR, /* error */
315 enum ata_completion_errors {
316 AC_ERR_DEV = (1 << 0), /* device reported error */
317 AC_ERR_HSM = (1 << 1), /* host state machine violation */
318 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
319 AC_ERR_MEDIA = (1 << 3), /* media error */
320 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
321 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
322 AC_ERR_SYSTEM = (1 << 6), /* system error */
323 AC_ERR_INVALID = (1 << 7), /* invalid argument */
324 AC_ERR_OTHER = (1 << 8), /* unknown */
325 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
326 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
329 /* forward declarations */
331 struct ata_port_operations;
333 struct ata_queued_cmd;
336 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
337 typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
338 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
339 unsigned long deadline);
340 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
343 void __iomem *cmd_addr;
344 void __iomem *data_addr;
345 void __iomem *error_addr;
346 void __iomem *feature_addr;
347 void __iomem *nsect_addr;
348 void __iomem *lbal_addr;
349 void __iomem *lbam_addr;
350 void __iomem *lbah_addr;
351 void __iomem *device_addr;
352 void __iomem *status_addr;
353 void __iomem *command_addr;
354 void __iomem *altstatus_addr;
355 void __iomem *ctl_addr;
356 void __iomem *bmdma_addr;
357 void __iomem *scr_addr;
365 void __iomem * const *iomap;
366 unsigned int n_ports;
368 const struct ata_port_operations *ops;
370 #ifdef CONFIG_ATA_ACPI
371 acpi_handle acpi_handle;
373 struct ata_port *simplex_claimed; /* channel owning the DMA */
374 struct ata_port *ports[0];
377 struct ata_queued_cmd {
379 struct ata_device *dev;
381 struct scsi_cmnd *scsicmd;
382 void (*scsidone)(struct scsi_cmnd *);
384 struct ata_taskfile tf;
385 u8 cdb[ATAPI_CDB_LEN];
387 unsigned long flags; /* ATA_QCFLAG_xxx */
390 unsigned int orig_n_elem;
394 unsigned int pad_len;
395 unsigned int sect_size;
398 unsigned int curbytes;
401 unsigned int cursg_ofs;
403 struct scatterlist sgent;
404 struct scatterlist pad_sgent;
407 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
408 struct scatterlist *__sg;
410 unsigned int err_mask;
411 struct ata_taskfile result_tf;
412 ata_qc_cb_t complete_fn;
417 struct ata_port_stats {
418 unsigned long unhandled_irq;
419 unsigned long idle_irq;
420 unsigned long rw_reqbuf;
423 struct ata_ering_entry {
425 unsigned int err_mask;
431 struct ata_ering_entry ring[ATA_ERING_SIZE];
436 unsigned int devno; /* 0 or 1 */
437 unsigned long flags; /* ATA_DFLAG_xxx */
438 unsigned int horkage; /* List of broken features */
439 struct scsi_device *sdev; /* attached SCSI device */
440 #ifdef CONFIG_ATA_ACPI
441 acpi_handle acpi_handle;
443 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
444 u64 n_sectors; /* size of device, if ATA */
445 unsigned int class; /* ATA_DEV_xxx */
446 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
450 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
452 unsigned int multi_count; /* sectors count for
453 READ/WRITE MULTIPLE */
454 unsigned int max_sectors; /* per-device max sectors */
455 unsigned int cdb_len;
457 /* per-dev xfer mask */
458 unsigned int pio_mask;
459 unsigned int mwdma_mask;
460 unsigned int udma_mask;
462 /* for CHS addressing */
463 u16 cylinders; /* Number of cylinders */
464 u16 heads; /* Number of heads */
465 u16 sectors; /* Number of sectors per track */
468 struct ata_ering ering;
472 /* Offset into struct ata_device. Fields above it are maintained
473 * acress device init. Fields below are zeroed.
475 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
478 struct ata_device *dev; /* offending device */
479 u32 serror; /* SError from LLDD */
480 unsigned int err_mask; /* port-wide err_mask */
481 unsigned int action; /* ATA_EH_* action mask */
482 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
483 unsigned int flags; /* ATA_EHI_* flags */
485 unsigned int probe_mask;
487 char desc[ATA_EH_DESC_LEN];
491 struct ata_eh_context {
492 struct ata_eh_info i;
493 int tries[ATA_MAX_DEVICES];
494 unsigned int classes[ATA_MAX_DEVICES];
495 unsigned int did_probe_mask;
498 struct ata_acpi_drive
504 struct ata_acpi_gtm {
505 struct ata_acpi_drive drive[2];
510 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
511 const struct ata_port_operations *ops;
513 unsigned long flags; /* ATA_FLAG_xxx */
514 unsigned int pflags; /* ATA_PFLAG_xxx */
515 unsigned int print_id; /* user visible unique port ID */
516 unsigned int port_no; /* 0 based port no. inside the host */
518 struct ata_prd *prd; /* our SG list */
519 dma_addr_t prd_dma; /* and its DMA mapping */
521 void *pad; /* array of DMA pad buffers */
524 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
526 u8 ctl; /* cache of ATA control register */
527 u8 last_ctl; /* Cache last written value */
528 unsigned int pio_mask;
529 unsigned int mwdma_mask;
530 unsigned int udma_mask;
531 unsigned int cbl; /* cable type; ATA_CBL_xxx */
532 unsigned int hw_sata_spd_limit;
533 unsigned int sata_spd_limit; /* SATA PHY speed limit */
534 unsigned int sata_spd; /* current SATA PHY speed */
536 /* record runtime error info, protected by host lock */
537 struct ata_eh_info eh_info;
538 /* EH context owned by EH */
539 struct ata_eh_context eh_context;
541 struct ata_device device[ATA_MAX_DEVICES];
543 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
544 unsigned long qc_allocated;
545 unsigned int qc_active;
547 unsigned int active_tag;
550 struct ata_port_stats stats;
551 struct ata_host *host;
554 void *port_task_data;
555 struct delayed_work port_task;
556 struct delayed_work hotplug_task;
557 struct work_struct scsi_rescan_task;
559 unsigned int hsm_task_state;
562 struct list_head eh_done_q;
563 wait_queue_head_t eh_wait_q;
565 pm_message_t pm_mesg;
568 struct timer_list fastdrain_timer;
569 unsigned long fastdrain_cnt;
573 #ifdef CONFIG_ATA_ACPI
574 acpi_handle acpi_handle;
575 struct ata_acpi_gtm acpi_gtm;
577 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
580 struct ata_port_operations {
581 void (*port_disable) (struct ata_port *);
583 void (*dev_config) (struct ata_device *);
585 void (*set_piomode) (struct ata_port *, struct ata_device *);
586 void (*set_dmamode) (struct ata_port *, struct ata_device *);
587 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
589 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
590 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
592 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
593 u8 (*check_status)(struct ata_port *ap);
594 u8 (*check_altstatus)(struct ata_port *ap);
595 void (*dev_select)(struct ata_port *ap, unsigned int device);
597 void (*phy_reset) (struct ata_port *ap); /* obsolete */
598 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
600 int (*cable_detect) (struct ata_port *ap);
602 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
604 void (*bmdma_setup) (struct ata_queued_cmd *qc);
605 void (*bmdma_start) (struct ata_queued_cmd *qc);
607 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
609 void (*qc_prep) (struct ata_queued_cmd *qc);
610 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
612 /* Error handlers. ->error_handler overrides ->eng_timeout and
613 * indicates that new-style EH is in place.
615 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
617 void (*freeze) (struct ata_port *ap);
618 void (*thaw) (struct ata_port *ap);
619 void (*error_handler) (struct ata_port *ap);
620 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
622 irq_handler_t irq_handler;
623 void (*irq_clear) (struct ata_port *);
624 u8 (*irq_on) (struct ata_port *);
625 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
627 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
628 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
630 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
631 int (*port_resume) (struct ata_port *ap);
633 int (*port_start) (struct ata_port *ap);
634 void (*port_stop) (struct ata_port *ap);
636 void (*host_stop) (struct ata_host *host);
638 void (*bmdma_stop) (struct ata_queued_cmd *qc);
639 u8 (*bmdma_status) (struct ata_port *ap);
642 struct ata_port_info {
643 struct scsi_host_template *sht;
645 unsigned long pio_mask;
646 unsigned long mwdma_mask;
647 unsigned long udma_mask;
648 const struct ata_port_operations *port_ops;
649 irq_handler_t irq_handler;
654 unsigned short mode; /* ATA mode */
655 unsigned short setup; /* t1 */
656 unsigned short act8b; /* t2 for 8-bit I/O */
657 unsigned short rec8b; /* t2i for 8-bit I/O */
658 unsigned short cyc8b; /* t0 for 8-bit I/O */
659 unsigned short active; /* t2 or tD */
660 unsigned short recover; /* t2i or tK */
661 unsigned short cycle; /* t0 */
662 unsigned short udma; /* t2CYCTYP/2 */
665 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
667 extern const unsigned long sata_deb_timing_normal[];
668 extern const unsigned long sata_deb_timing_hotplug[];
669 extern const unsigned long sata_deb_timing_long[];
671 extern const struct ata_port_operations ata_dummy_port_ops;
672 extern const struct ata_port_info ata_dummy_port_info;
674 static inline const unsigned long *
675 sata_ehc_deb_timing(struct ata_eh_context *ehc)
677 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
678 return sata_deb_timing_hotplug;
680 return sata_deb_timing_normal;
683 static inline int ata_port_is_dummy(struct ata_port *ap)
685 return ap->ops == &ata_dummy_port_ops;
688 extern void sata_print_link_status(struct ata_port *ap);
689 extern void ata_port_probe(struct ata_port *);
690 extern void __sata_phy_reset(struct ata_port *ap);
691 extern void sata_phy_reset(struct ata_port *ap);
692 extern void ata_bus_reset(struct ata_port *ap);
693 extern int sata_set_spd(struct ata_port *ap);
694 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param,
695 unsigned long deadline);
696 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param,
697 unsigned long deadline);
698 extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
699 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
700 unsigned long deadline);
701 extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
702 unsigned long deadline);
703 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
704 unsigned long deadline);
705 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
706 extern void ata_port_disable(struct ata_port *);
707 extern void ata_std_ports(struct ata_ioports *ioaddr);
709 extern int ata_pci_init_one (struct pci_dev *pdev,
710 const struct ata_port_info * const * ppi);
711 extern void ata_pci_remove_one (struct pci_dev *pdev);
713 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
714 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
715 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
716 extern int ata_pci_device_resume(struct pci_dev *pdev);
718 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
719 #endif /* CONFIG_PCI */
720 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
721 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
722 const struct ata_port_info * const * ppi, int n_ports);
723 extern int ata_host_start(struct ata_host *host);
724 extern int ata_host_register(struct ata_host *host,
725 struct scsi_host_template *sht);
726 extern int ata_host_activate(struct ata_host *host, int irq,
727 irq_handler_t irq_handler, unsigned long irq_flags,
728 struct scsi_host_template *sht);
729 extern void ata_host_detach(struct ata_host *host);
730 extern void ata_host_init(struct ata_host *, struct device *,
731 unsigned long, const struct ata_port_operations *);
732 extern int ata_scsi_detect(struct scsi_host_template *sht);
733 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
734 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
735 extern void ata_sas_port_destroy(struct ata_port *);
736 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
737 struct ata_port_info *, struct Scsi_Host *);
738 extern int ata_sas_port_init(struct ata_port *);
739 extern int ata_sas_port_start(struct ata_port *ap);
740 extern void ata_sas_port_stop(struct ata_port *ap);
741 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
742 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
743 struct ata_port *ap);
744 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
745 extern int sata_scr_valid(struct ata_port *ap);
746 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
747 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
748 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
749 extern int ata_port_online(struct ata_port *ap);
750 extern int ata_port_offline(struct ata_port *ap);
752 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
753 extern void ata_host_resume(struct ata_host *host);
755 extern int ata_ratelimit(void);
756 extern int ata_busy_sleep(struct ata_port *ap,
757 unsigned long timeout_pat, unsigned long timeout);
758 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
759 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
760 void *data, unsigned long delay);
761 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
762 unsigned long interval_msec,
763 unsigned long timeout_msec);
764 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
767 * Default driver ops implementations
769 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
770 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
771 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
772 u8 pmp, int is_cmd, u8 *fis);
773 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
774 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
775 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
776 extern u8 ata_check_status(struct ata_port *ap);
777 extern u8 ata_altstatus(struct ata_port *ap);
778 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
779 extern int ata_port_start (struct ata_port *ap);
780 extern int ata_sff_port_start (struct ata_port *ap);
781 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
782 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
783 unsigned int buflen, int write_data);
784 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
785 unsigned int buflen, int write_data);
786 extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
787 extern void ata_qc_prep(struct ata_queued_cmd *qc);
788 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
789 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
790 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
791 unsigned int buflen);
792 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
793 unsigned int n_elem);
794 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
795 extern void ata_dev_disable(struct ata_device *adev);
796 extern void ata_id_string(const u16 *id, unsigned char *s,
797 unsigned int ofs, unsigned int len);
798 extern void ata_id_c_string(const u16 *id, unsigned char *s,
799 unsigned int ofs, unsigned int len);
800 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
801 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
802 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
803 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
804 extern u8 ata_bmdma_status(struct ata_port *ap);
805 extern void ata_bmdma_irq_clear(struct ata_port *ap);
806 extern void ata_bmdma_freeze(struct ata_port *ap);
807 extern void ata_bmdma_thaw(struct ata_port *ap);
808 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
809 ata_reset_fn_t softreset,
810 ata_reset_fn_t hardreset,
811 ata_postreset_fn_t postreset);
812 extern void ata_bmdma_error_handler(struct ata_port *ap);
813 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
814 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
815 u8 status, int in_wq);
816 extern void ata_qc_complete(struct ata_queued_cmd *qc);
817 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
818 void (*finish_qc)(struct ata_queued_cmd *));
819 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
820 void (*done)(struct scsi_cmnd *));
821 extern int ata_std_bios_param(struct scsi_device *sdev,
822 struct block_device *bdev,
823 sector_t capacity, int geom[]);
824 extern int ata_scsi_slave_config(struct scsi_device *sdev);
825 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
826 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
828 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
829 extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
830 extern u8 ata_irq_on(struct ata_port *ap);
831 extern u8 ata_dummy_irq_on(struct ata_port *ap);
832 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
833 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
835 extern int ata_cable_40wire(struct ata_port *ap);
836 extern int ata_cable_80wire(struct ata_port *ap);
837 extern int ata_cable_sata(struct ata_port *ap);
838 extern int ata_cable_unknown(struct ata_port *ap);
844 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
845 extern int ata_timing_compute(struct ata_device *, unsigned short,
846 struct ata_timing *, int, int);
847 extern void ata_timing_merge(const struct ata_timing *,
848 const struct ata_timing *, struct ata_timing *,
852 ATA_TIMING_SETUP = (1 << 0),
853 ATA_TIMING_ACT8B = (1 << 1),
854 ATA_TIMING_REC8B = (1 << 2),
855 ATA_TIMING_CYC8B = (1 << 3),
856 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
858 ATA_TIMING_ACTIVE = (1 << 4),
859 ATA_TIMING_RECOVER = (1 << 5),
860 ATA_TIMING_CYCLE = (1 << 6),
861 ATA_TIMING_UDMA = (1 << 7),
862 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
863 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
864 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
865 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
871 unsigned int reg; /* PCI config register to read */
872 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
877 extern int ata_pci_init_sff_host(struct ata_host *host);
878 extern int ata_pci_init_bmdma(struct ata_host *host);
879 extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
880 const struct ata_port_info * const * ppi,
881 struct ata_host **r_host);
882 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
883 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
884 #endif /* CONFIG_PCI */
889 extern void ata_eng_timeout(struct ata_port *ap);
891 extern void ata_port_schedule_eh(struct ata_port *ap);
892 extern int ata_port_abort(struct ata_port *ap);
893 extern int ata_port_freeze(struct ata_port *ap);
895 extern void ata_eh_freeze_port(struct ata_port *ap);
896 extern void ata_eh_thaw_port(struct ata_port *ap);
898 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
899 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
901 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
902 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
903 ata_postreset_fn_t postreset);
908 #define ata_port_printk(ap, lv, fmt, args...) \
909 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
911 #define ata_dev_printk(dev, lv, fmt, args...) \
912 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
915 * ata_eh_info helpers
917 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
918 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
919 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
921 static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
923 ehi->flags |= ATA_EHI_RESUME_LINK;
924 ehi->action |= ATA_EH_SOFTRESET;
925 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
928 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
930 ata_ehi_schedule_probe(ehi);
931 ehi->flags |= ATA_EHI_HOTPLUGGED;
932 ehi->err_mask |= AC_ERR_ATA_BUS;
939 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
941 if (sg == &qc->pad_sgent)
945 if (((sg - qc->__sg) + 1) == qc->n_elem)
950 static inline struct scatterlist *
951 ata_qc_first_sg(struct ata_queued_cmd *qc)
956 return &qc->pad_sgent;
960 static inline struct scatterlist *
961 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
963 if (sg == &qc->pad_sgent)
965 if (++sg - qc->__sg < qc->n_elem)
968 return &qc->pad_sgent;
972 #define ata_for_each_sg(sg, qc) \
973 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
975 static inline unsigned int ata_tag_valid(unsigned int tag)
977 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
980 static inline unsigned int ata_tag_internal(unsigned int tag)
982 return tag == ATA_MAX_QUEUE - 1;
988 static inline unsigned int ata_class_enabled(unsigned int class)
990 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
993 static inline unsigned int ata_class_disabled(unsigned int class)
995 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
998 static inline unsigned int ata_class_absent(unsigned int class)
1000 return !ata_class_enabled(class) && !ata_class_disabled(class);
1003 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1005 return ata_class_enabled(dev->class);
1008 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1010 return ata_class_disabled(dev->class);
1013 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1015 return ata_class_absent(dev->class);
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);
1035 * ata_ncq_enabled - Test whether NCQ is enabled
1036 * @dev: ATA device to test for
1039 * spin_lock_irqsave(host lock)
1042 * 1 if NCQ is enabled for @dev, 0 otherwise.
1044 static inline int ata_ncq_enabled(struct ata_device *dev)
1046 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1047 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1051 * ata_pause - Flush writes and pause 400 nanoseconds.
1052 * @ap: Port to wait for.
1055 * Inherited from caller.
1058 static inline void ata_pause(struct ata_port *ap)
1066 * ata_busy_wait - Wait for a port status register
1067 * @ap: Port to wait for.
1068 * @bits: bits that must be clear
1069 * @max: number of 10uS waits to perform
1071 * Waits up to max*10 microseconds for the selected bits in the port's
1072 * status register to be cleared.
1073 * Returns final value of status register.
1076 * Inherited from caller.
1079 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1086 status = ata_chk_status(ap);
1088 } while (status != 0xff && (status & bits) && (max > 0));
1095 * ata_wait_idle - Wait for a port to be idle.
1096 * @ap: Port to wait for.
1098 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1099 * Returns final value of status register.
1102 * Inherited from caller.
1105 static inline u8 ata_wait_idle(struct ata_port *ap)
1107 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1109 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1110 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1111 status, ap->ioaddr.status_addr);
1116 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1118 qc->tf.ctl |= ATA_NIEN;
1121 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1124 if (likely(ata_tag_valid(tag)))
1125 return &ap->qcmd[tag];
1129 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1132 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1134 if (unlikely(!qc) || !ap->ops->error_handler)
1137 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1138 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1144 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1146 memset(tf, 0, sizeof(*tf));
1148 tf->ctl = dev->ap->ctl;
1149 if (dev->devno == 0)
1150 tf->device = ATA_DEVICE_OBS;
1152 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1155 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1157 qc->dma_dir = DMA_NONE;
1160 qc->cursg = qc->cursg_ofs = 0;
1161 qc->nbytes = qc->curbytes = 0;
1165 qc->sect_size = ATA_SECT_SIZE;
1167 ata_tf_init(qc->dev, &qc->tf);
1169 /* init result_tf such that it indicates normal completion */
1170 qc->result_tf.command = ATA_DRDY;
1171 qc->result_tf.feature = 0;
1174 static inline int ata_try_flush_cache(const struct ata_device *dev)
1176 return ata_id_wcache_enabled(dev->id) ||
1177 ata_id_has_flush(dev->id) ||
1178 ata_id_has_flush_ext(dev->id);
1181 static inline unsigned int ac_err_mask(u8 status)
1183 if (status & (ATA_BUSY | ATA_DRQ))
1185 if (status & (ATA_ERR | ATA_DF))
1190 static inline unsigned int __ac_err_mask(u8 status)
1192 unsigned int mask = ac_err_mask(status);
1194 return AC_ERR_OTHER;
1198 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1201 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1202 &ap->pad_dma, GFP_KERNEL);
1203 return (ap->pad == NULL) ? -ENOMEM : 0;
1206 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1208 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1211 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1213 return *(struct ata_port **)&host->hostdata[0];
1216 #endif /* __LINUX_LIBATA_H__ */