2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/DocBook/libata.*
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <linux/dma-mapping.h>
33 #include <asm/scatterlist.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/acpi.h>
41 * Define if arch has non-standard setup. This is a _PCI_ standard
42 * not a legacy or ISA standard.
44 #ifdef CONFIG_ATA_NONSTANDARD
45 #include <asm/libata-portmap.h>
47 #include <asm-generic/libata-portmap.h>
51 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
54 #undef ATA_DEBUG /* debugging output */
55 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
56 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
57 #undef ATA_NDEBUG /* define to disable quick runtime checks */
60 /* note: prints function name for you */
62 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63 #ifdef ATA_VERBOSE_DEBUG
64 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66 #define VPRINTK(fmt, args...)
67 #endif /* ATA_VERBOSE_DEBUG */
69 #define DPRINTK(fmt, args...)
70 #define VPRINTK(fmt, args...)
71 #endif /* ATA_DEBUG */
73 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75 /* NEW: debug levels */
76 #define HAVE_LIBATA_MSG 1
80 ATA_MSG_INFO = 0x0002,
81 ATA_MSG_PROBE = 0x0004,
82 ATA_MSG_WARN = 0x0008,
83 ATA_MSG_MALLOC = 0x0010,
85 ATA_MSG_INTR = 0x0040,
89 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
90 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
91 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
92 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
95 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
96 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
98 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100 if (dval < 0 || dval >= (sizeof(u32) * 8))
101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
104 return (1 << dval) - 1;
107 /* defines only for the constants which don't work well as enums */
108 #define ATA_TAG_POISON 0xfafbfcfdU
110 /* move to PCI layer? */
111 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
117 /* various global constants */
118 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
121 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
123 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
125 ATA_DEF_BUSY_WAIT = 10000,
126 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
128 ATA_SHT_EMULATED = 1,
129 ATA_SHT_CMD_PER_LUN = 1,
130 ATA_SHT_THIS_ID = -1,
131 ATA_SHT_USE_CLUSTERING = 1,
133 /* struct ata_device stuff */
134 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
135 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
136 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
137 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
138 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
139 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
141 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
142 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
143 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
144 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
146 ATA_DFLAG_DETACH = (1 << 16),
147 ATA_DFLAG_DETACHED = (1 << 17),
149 ATA_DEV_UNKNOWN = 0, /* unknown device */
150 ATA_DEV_ATA = 1, /* ATA device */
151 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
152 ATA_DEV_ATAPI = 3, /* ATAPI device */
153 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
154 ATA_DEV_NONE = 5, /* no device */
156 /* struct ata_port flags */
157 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
158 /* (doesn't imply presence) */
159 ATA_FLAG_SATA = (1 << 1),
160 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
161 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
162 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
163 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
164 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
165 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
166 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
167 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
168 * doesn't handle PIO interrupts */
169 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
170 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
171 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
172 * Register FIS clearing BSY */
173 ATA_FLAG_DEBUGMSG = (1 << 13),
174 ATA_FLAG_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
175 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
176 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
178 /* The following flag belongs to ap->pflags but is kept in
179 * ap->flags because it's referenced in many LLDs and will be
180 * removed in not-too-distant future.
182 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
184 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
186 /* struct ata_port pflags */
187 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
188 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
189 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
190 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
191 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
192 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
193 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
195 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
196 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
197 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
199 /* struct ata_queued_cmd flags */
200 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
201 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
202 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
203 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
204 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
205 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
207 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
208 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
209 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
212 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
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 */
314 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
315 ATA_HORKAGE_DMA_RW_ONLY = (1 << 4), /* ATAPI DMA for RW only */
318 enum hsm_task_states {
319 HSM_ST_IDLE, /* no command on going */
320 HSM_ST_FIRST, /* (waiting the device to)
321 write CDB or first data block */
322 HSM_ST, /* (waiting the device to) transfer data */
323 HSM_ST_LAST, /* (waiting the device to) complete command */
324 HSM_ST_ERR, /* error */
327 enum ata_completion_errors {
328 AC_ERR_DEV = (1 << 0), /* device reported error */
329 AC_ERR_HSM = (1 << 1), /* host state machine violation */
330 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
331 AC_ERR_MEDIA = (1 << 3), /* media error */
332 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
333 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
334 AC_ERR_SYSTEM = (1 << 6), /* system error */
335 AC_ERR_INVALID = (1 << 7), /* invalid argument */
336 AC_ERR_OTHER = (1 << 8), /* unknown */
337 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
340 /* forward declarations */
342 struct ata_port_operations;
344 struct ata_queued_cmd;
347 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
348 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
349 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
350 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
353 void __iomem *cmd_addr;
354 void __iomem *data_addr;
355 void __iomem *error_addr;
356 void __iomem *feature_addr;
357 void __iomem *nsect_addr;
358 void __iomem *lbal_addr;
359 void __iomem *lbam_addr;
360 void __iomem *lbah_addr;
361 void __iomem *device_addr;
362 void __iomem *status_addr;
363 void __iomem *command_addr;
364 void __iomem *altstatus_addr;
365 void __iomem *ctl_addr;
366 void __iomem *bmdma_addr;
367 void __iomem *scr_addr;
370 struct ata_probe_ent {
371 struct list_head node;
373 const struct ata_port_operations *port_ops;
374 struct scsi_host_template *sht;
375 struct ata_ioports port[ATA_MAX_PORTS];
376 unsigned int n_ports;
377 unsigned int dummy_port_mask;
378 unsigned int pio_mask;
379 unsigned int mwdma_mask;
380 unsigned int udma_mask;
383 unsigned int irq_flags;
384 unsigned long port_flags;
385 unsigned long _host_flags;
386 void __iomem * const *iomap;
389 /* port_info for the secondary port. Together with irq2, it's
390 * used to implement non-uniform secondary port. Currently,
391 * the only user is ata_piix combined mode. This workaround
392 * will be removed together with ata_probe_ent when init model
395 const struct ata_port_info *pinfo2;
403 void __iomem * const *iomap;
404 unsigned int n_ports;
406 const struct ata_port_operations *ops;
408 struct ata_port *simplex_claimed; /* channel owning the DMA */
409 struct ata_port *ports[0];
412 struct ata_queued_cmd {
414 struct ata_device *dev;
416 struct scsi_cmnd *scsicmd;
417 void (*scsidone)(struct scsi_cmnd *);
419 struct ata_taskfile tf;
420 u8 cdb[ATAPI_CDB_LEN];
422 unsigned long flags; /* ATA_QCFLAG_xxx */
425 unsigned int orig_n_elem;
429 unsigned int pad_len;
430 unsigned int sect_size;
433 unsigned int curbytes;
436 unsigned int cursg_ofs;
438 struct scatterlist sgent;
439 struct scatterlist pad_sgent;
442 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
443 struct scatterlist *__sg;
445 unsigned int err_mask;
446 struct ata_taskfile result_tf;
447 ata_qc_cb_t complete_fn;
452 struct ata_port_stats {
453 unsigned long unhandled_irq;
454 unsigned long idle_irq;
455 unsigned long rw_reqbuf;
458 struct ata_ering_entry {
460 unsigned int err_mask;
466 struct ata_ering_entry ring[ATA_ERING_SIZE];
471 unsigned int devno; /* 0 or 1 */
472 unsigned long flags; /* ATA_DFLAG_xxx */
473 struct scsi_device *sdev; /* attached SCSI device */
474 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
475 u64 n_sectors; /* size of device, if ATA */
476 unsigned int class; /* ATA_DEV_xxx */
477 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
481 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
483 unsigned int multi_count; /* sectors count for
484 READ/WRITE MULTIPLE */
485 unsigned int max_sectors; /* per-device max sectors */
486 unsigned int cdb_len;
488 /* per-dev xfer mask */
489 unsigned int pio_mask;
490 unsigned int mwdma_mask;
491 unsigned int udma_mask;
493 /* for CHS addressing */
494 u16 cylinders; /* Number of cylinders */
495 u16 heads; /* Number of heads */
496 u16 sectors; /* Number of sectors per track */
499 struct ata_ering ering;
501 unsigned int horkage; /* List of broken features */
502 #ifdef CONFIG_SATA_ACPI
503 /* ACPI objects info */
504 acpi_handle obj_handle;
508 /* Offset into struct ata_device. Fields above it are maintained
509 * acress device init. Fields below are zeroed.
511 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
514 struct ata_device *dev; /* offending device */
515 u32 serror; /* SError from LLDD */
516 unsigned int err_mask; /* port-wide err_mask */
517 unsigned int action; /* ATA_EH_* action mask */
518 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
519 unsigned int flags; /* ATA_EHI_* flags */
521 unsigned long hotplug_timestamp;
522 unsigned int probe_mask;
524 char desc[ATA_EH_DESC_LEN];
528 struct ata_eh_context {
529 struct ata_eh_info i;
530 int tries[ATA_MAX_DEVICES];
531 unsigned int classes[ATA_MAX_DEVICES];
532 unsigned int did_probe_mask;
536 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
537 const struct ata_port_operations *ops;
539 unsigned long flags; /* ATA_FLAG_xxx */
540 unsigned int pflags; /* ATA_PFLAG_xxx */
541 unsigned int print_id; /* user visible unique port ID */
542 unsigned int port_no; /* 0 based port no. inside the host */
544 struct ata_prd *prd; /* our SG list */
545 dma_addr_t prd_dma; /* and its DMA mapping */
547 void *pad; /* array of DMA pad buffers */
550 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
552 u8 ctl; /* cache of ATA control register */
553 u8 last_ctl; /* Cache last written value */
554 unsigned int pio_mask;
555 unsigned int mwdma_mask;
556 unsigned int udma_mask;
557 unsigned int cbl; /* cable type; ATA_CBL_xxx */
558 unsigned int hw_sata_spd_limit;
559 unsigned int sata_spd_limit; /* SATA PHY speed limit */
561 /* record runtime error info, protected by host lock */
562 struct ata_eh_info eh_info;
563 /* EH context owned by EH */
564 struct ata_eh_context eh_context;
566 struct ata_device device[ATA_MAX_DEVICES];
568 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
569 unsigned long qc_allocated;
570 unsigned int qc_active;
572 unsigned int active_tag;
575 struct ata_port_stats stats;
576 struct ata_host *host;
579 void *port_task_data;
580 struct delayed_work port_task;
581 struct delayed_work hotplug_task;
582 struct work_struct scsi_rescan_task;
584 unsigned int hsm_task_state;
587 struct list_head eh_done_q;
588 wait_queue_head_t eh_wait_q;
590 pm_message_t pm_mesg;
595 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
598 struct ata_port_operations {
599 void (*port_disable) (struct ata_port *);
601 void (*dev_config) (struct ata_device *);
603 void (*set_piomode) (struct ata_port *, struct ata_device *);
604 void (*set_dmamode) (struct ata_port *, struct ata_device *);
605 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
607 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
608 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
610 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
611 u8 (*check_status)(struct ata_port *ap);
612 u8 (*check_altstatus)(struct ata_port *ap);
613 void (*dev_select)(struct ata_port *ap, unsigned int device);
615 void (*phy_reset) (struct ata_port *ap); /* obsolete */
616 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
618 void (*post_set_mode) (struct ata_port *ap);
620 int (*cable_detect) (struct ata_port *ap);
622 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
624 void (*bmdma_setup) (struct ata_queued_cmd *qc);
625 void (*bmdma_start) (struct ata_queued_cmd *qc);
627 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
629 void (*qc_prep) (struct ata_queued_cmd *qc);
630 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
632 /* Error handlers. ->error_handler overrides ->eng_timeout and
633 * indicates that new-style EH is in place.
635 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
637 void (*freeze) (struct ata_port *ap);
638 void (*thaw) (struct ata_port *ap);
639 void (*error_handler) (struct ata_port *ap);
640 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
642 irq_handler_t irq_handler;
643 void (*irq_clear) (struct ata_port *);
644 u8 (*irq_on) (struct ata_port *);
645 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
647 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
648 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
651 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
652 int (*port_resume) (struct ata_port *ap);
654 int (*port_start) (struct ata_port *ap);
655 void (*port_stop) (struct ata_port *ap);
657 void (*host_stop) (struct ata_host *host);
659 void (*bmdma_stop) (struct ata_queued_cmd *qc);
660 u8 (*bmdma_status) (struct ata_port *ap);
663 struct ata_port_info {
664 struct scsi_host_template *sht;
666 unsigned long pio_mask;
667 unsigned long mwdma_mask;
668 unsigned long udma_mask;
669 const struct ata_port_operations *port_ops;
674 unsigned short mode; /* ATA mode */
675 unsigned short setup; /* t1 */
676 unsigned short act8b; /* t2 for 8-bit I/O */
677 unsigned short rec8b; /* t2i for 8-bit I/O */
678 unsigned short cyc8b; /* t0 for 8-bit I/O */
679 unsigned short active; /* t2 or tD */
680 unsigned short recover; /* t2i or tK */
681 unsigned short cycle; /* t0 */
682 unsigned short udma; /* t2CYCTYP/2 */
685 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
687 extern const unsigned long sata_deb_timing_normal[];
688 extern const unsigned long sata_deb_timing_hotplug[];
689 extern const unsigned long sata_deb_timing_long[];
691 extern const struct ata_port_operations ata_dummy_port_ops;
693 static inline const unsigned long *
694 sata_ehc_deb_timing(struct ata_eh_context *ehc)
696 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
697 return sata_deb_timing_hotplug;
699 return sata_deb_timing_normal;
702 static inline int ata_port_is_dummy(struct ata_port *ap)
704 return ap->ops == &ata_dummy_port_ops;
707 extern void sata_print_link_status(struct ata_port *ap);
708 extern void ata_port_probe(struct ata_port *);
709 extern void __sata_phy_reset(struct ata_port *ap);
710 extern void sata_phy_reset(struct ata_port *ap);
711 extern void ata_bus_reset(struct ata_port *ap);
712 extern int sata_set_spd(struct ata_port *ap);
713 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
714 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
715 extern int ata_std_prereset(struct ata_port *ap);
716 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
717 extern int sata_port_hardreset(struct ata_port *ap,
718 const unsigned long *timing);
719 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
720 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
721 extern void ata_port_disable(struct ata_port *);
722 extern void ata_std_ports(struct ata_ioports *ioaddr);
724 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
725 unsigned int n_ports);
726 extern void ata_pci_remove_one (struct pci_dev *pdev);
728 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
729 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
730 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
731 extern int ata_pci_device_resume(struct pci_dev *pdev);
733 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
734 #endif /* CONFIG_PCI */
735 extern int ata_device_add(const struct ata_probe_ent *ent);
736 extern void ata_host_detach(struct ata_host *host);
737 extern void ata_host_init(struct ata_host *, struct device *,
738 unsigned long, const struct ata_port_operations *);
739 extern int ata_scsi_detect(struct scsi_host_template *sht);
740 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
741 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
742 extern void ata_sas_port_destroy(struct ata_port *);
743 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
744 struct ata_port_info *, struct Scsi_Host *);
745 extern int ata_sas_port_init(struct ata_port *);
746 extern int ata_sas_port_start(struct ata_port *ap);
747 extern void ata_sas_port_stop(struct ata_port *ap);
748 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
749 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
750 struct ata_port *ap);
751 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
752 extern int sata_scr_valid(struct ata_port *ap);
753 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
754 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
755 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
756 extern int ata_port_online(struct ata_port *ap);
757 extern int ata_port_offline(struct ata_port *ap);
759 extern int ata_scsi_device_resume(struct scsi_device *);
760 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
761 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
762 extern void ata_host_resume(struct ata_host *host);
764 extern int ata_ratelimit(void);
765 extern int ata_busy_sleep(struct ata_port *ap,
766 unsigned long timeout_pat, unsigned long timeout);
767 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
768 void *data, unsigned long delay);
769 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
770 unsigned long interval_msec,
771 unsigned long timeout_msec);
772 extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
775 * Default driver ops implementations
777 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
778 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
779 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
780 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
781 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
782 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
783 extern u8 ata_check_status(struct ata_port *ap);
784 extern u8 ata_altstatus(struct ata_port *ap);
785 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
786 extern int ata_port_start (struct ata_port *ap);
787 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
788 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
789 unsigned int buflen, int write_data);
790 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
791 unsigned int buflen, int write_data);
792 extern void ata_qc_prep(struct ata_queued_cmd *qc);
793 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
794 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
795 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
796 unsigned int buflen);
797 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
798 unsigned int n_elem);
799 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
800 extern void ata_dev_disable(struct ata_device *adev);
801 extern void ata_id_string(const u16 *id, unsigned char *s,
802 unsigned int ofs, unsigned int len);
803 extern void ata_id_c_string(const u16 *id, unsigned char *s,
804 unsigned int ofs, unsigned int len);
805 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
806 extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
807 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
808 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
809 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
810 extern u8 ata_bmdma_status(struct ata_port *ap);
811 extern void ata_bmdma_irq_clear(struct ata_port *ap);
812 extern void ata_bmdma_freeze(struct ata_port *ap);
813 extern void ata_bmdma_thaw(struct ata_port *ap);
814 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
815 ata_reset_fn_t softreset,
816 ata_reset_fn_t hardreset,
817 ata_postreset_fn_t postreset);
818 extern void ata_bmdma_error_handler(struct ata_port *ap);
819 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
820 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
821 u8 status, int in_wq);
822 extern void ata_qc_complete(struct ata_queued_cmd *qc);
823 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
824 void (*finish_qc)(struct ata_queued_cmd *));
825 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
826 void (*done)(struct scsi_cmnd *));
827 extern int ata_std_bios_param(struct scsi_device *sdev,
828 struct block_device *bdev,
829 sector_t capacity, int geom[]);
830 extern int ata_scsi_slave_config(struct scsi_device *sdev);
831 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
832 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
834 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
835 extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
836 extern u8 ata_irq_on(struct ata_port *ap);
837 extern u8 ata_dummy_irq_on(struct ata_port *ap);
838 extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
839 extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
841 extern int ata_cable_40wire(struct ata_port *ap);
842 extern int ata_cable_80wire(struct ata_port *ap);
843 extern int ata_cable_sata(struct ata_port *ap);
844 extern int ata_cable_unknown(struct ata_port *ap);
850 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
851 extern int ata_timing_compute(struct ata_device *, unsigned short,
852 struct ata_timing *, int, int);
853 extern void ata_timing_merge(const struct ata_timing *,
854 const struct ata_timing *, struct ata_timing *,
858 ATA_TIMING_SETUP = (1 << 0),
859 ATA_TIMING_ACT8B = (1 << 1),
860 ATA_TIMING_REC8B = (1 << 2),
861 ATA_TIMING_CYC8B = (1 << 3),
862 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
864 ATA_TIMING_ACTIVE = (1 << 4),
865 ATA_TIMING_RECOVER = (1 << 5),
866 ATA_TIMING_CYCLE = (1 << 6),
867 ATA_TIMING_UDMA = (1 << 7),
868 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
869 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
870 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
871 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
877 unsigned int reg; /* PCI config register to read */
878 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
883 extern struct ata_probe_ent *
884 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
885 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
886 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
887 #endif /* CONFIG_PCI */
892 extern void ata_eng_timeout(struct ata_port *ap);
894 extern void ata_port_schedule_eh(struct ata_port *ap);
895 extern int ata_port_abort(struct ata_port *ap);
896 extern int ata_port_freeze(struct ata_port *ap);
898 extern void ata_eh_freeze_port(struct ata_port *ap);
899 extern void ata_eh_thaw_port(struct ata_port *ap);
901 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
902 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
904 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
905 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
906 ata_postreset_fn_t postreset);
911 #define ata_port_printk(ap, lv, fmt, args...) \
912 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
914 #define ata_dev_printk(dev, lv, fmt, args...) \
915 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
918 * ata_eh_info helpers
920 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
921 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
922 ATA_EH_DESC_LEN - (ehi)->desc_len, \
926 #define ata_ehi_clear_desc(ehi) do { \
927 (ehi)->desc[0] = '\0'; \
928 (ehi)->desc_len = 0; \
931 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
933 if (ehi->flags & ATA_EHI_HOTPLUGGED)
936 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
937 ehi->hotplug_timestamp = jiffies;
939 ehi->action |= ATA_EH_SOFTRESET;
940 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
943 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
945 __ata_ehi_hotplugged(ehi);
946 ehi->err_mask |= AC_ERR_ATA_BUS;
953 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
955 if (sg == &qc->pad_sgent)
959 if (((sg - qc->__sg) + 1) == qc->n_elem)
964 static inline struct scatterlist *
965 ata_qc_first_sg(struct ata_queued_cmd *qc)
970 return &qc->pad_sgent;
974 static inline struct scatterlist *
975 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
977 if (sg == &qc->pad_sgent)
979 if (++sg - qc->__sg < qc->n_elem)
982 return &qc->pad_sgent;
986 #define ata_for_each_sg(sg, qc) \
987 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
989 static inline unsigned int ata_tag_valid(unsigned int tag)
991 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
994 static inline unsigned int ata_tag_internal(unsigned int tag)
996 return tag == ATA_MAX_QUEUE - 1;
1002 static inline unsigned int ata_class_enabled(unsigned int class)
1004 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
1007 static inline unsigned int ata_class_disabled(unsigned int class)
1009 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1012 static inline unsigned int ata_class_absent(unsigned int class)
1014 return !ata_class_enabled(class) && !ata_class_disabled(class);
1017 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1019 return ata_class_enabled(dev->class);
1022 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1024 return ata_class_disabled(dev->class);
1027 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1029 return ata_class_absent(dev->class);
1032 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1034 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1040 static inline int ata_port_max_devices(const struct ata_port *ap)
1042 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1048 static inline u8 ata_chk_status(struct ata_port *ap)
1050 return ap->ops->check_status(ap);
1054 * ata_ncq_enabled - Test whether NCQ is enabled
1055 * @dev: ATA device to test for
1058 * spin_lock_irqsave(host lock)
1061 * 1 if NCQ is enabled for @dev, 0 otherwise.
1063 static inline int ata_ncq_enabled(struct ata_device *dev)
1065 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1066 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1070 * ata_pause - Flush writes and pause 400 nanoseconds.
1071 * @ap: Port to wait for.
1074 * Inherited from caller.
1077 static inline void ata_pause(struct ata_port *ap)
1085 * ata_busy_wait - Wait for a port status register
1086 * @ap: Port to wait for.
1087 * @bits: bits that must be clear
1088 * @max: number of 10uS waits to perform
1090 * Waits up to max*10 microseconds for the selected bits in the port's
1091 * status register to be cleared.
1092 * Returns final value of status register.
1095 * Inherited from caller.
1098 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1105 status = ata_chk_status(ap);
1107 } while (status != 0xff && (status & bits) && (max > 0));
1114 * ata_wait_idle - Wait for a port to be idle.
1115 * @ap: Port to wait for.
1117 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1118 * Returns final value of status register.
1121 * Inherited from caller.
1124 static inline u8 ata_wait_idle(struct ata_port *ap)
1126 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1128 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
1129 if (ata_msg_warn(ap))
1130 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%p\n",
1131 status, ap->ioaddr.status_addr);
1137 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1139 qc->tf.ctl |= ATA_NIEN;
1142 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1145 if (likely(ata_tag_valid(tag)))
1146 return &ap->qcmd[tag];
1150 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1153 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1155 if (unlikely(!qc) || !ap->ops->error_handler)
1158 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1159 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1165 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1167 memset(tf, 0, sizeof(*tf));
1169 tf->ctl = dev->ap->ctl;
1170 if (dev->devno == 0)
1171 tf->device = ATA_DEVICE_OBS;
1173 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1176 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1178 qc->dma_dir = DMA_NONE;
1181 qc->cursg = qc->cursg_ofs = 0;
1182 qc->nbytes = qc->curbytes = 0;
1186 qc->sect_size = ATA_SECT_SIZE;
1188 ata_tf_init(qc->dev, &qc->tf);
1190 /* init result_tf such that it indicates normal completion */
1191 qc->result_tf.command = ATA_DRDY;
1192 qc->result_tf.feature = 0;
1195 static inline int ata_try_flush_cache(const struct ata_device *dev)
1197 return ata_id_wcache_enabled(dev->id) ||
1198 ata_id_has_flush(dev->id) ||
1199 ata_id_has_flush_ext(dev->id);
1202 static inline unsigned int ac_err_mask(u8 status)
1204 if (status & (ATA_BUSY | ATA_DRQ))
1206 if (status & (ATA_ERR | ATA_DF))
1211 static inline unsigned int __ac_err_mask(u8 status)
1213 unsigned int mask = ac_err_mask(status);
1215 return AC_ERR_OTHER;
1219 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1222 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1223 &ap->pad_dma, GFP_KERNEL);
1224 return (ap->pad == NULL) ? -ENOMEM : 0;
1227 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1229 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1232 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1234 return *(struct ata_port **)&host->hostdata[0];
1237 #endif /* __LINUX_LIBATA_H__ */