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/jiffies.h>
31 #include <linux/interrupt.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/scatterlist.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/acpi.h>
39 #include <linux/cdrom.h>
42 * Define if arch has non-standard setup. This is a _PCI_ standard
43 * not a legacy or ISA standard.
45 #ifdef CONFIG_ATA_NONSTANDARD
46 #include <asm/libata-portmap.h>
48 #include <asm-generic/libata-portmap.h>
52 * compile-time options: to be removed as soon as all the drivers are
53 * converted to the new debugging mechanism
55 #undef ATA_DEBUG /* debugging output */
56 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
57 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
58 #undef ATA_NDEBUG /* define to disable quick runtime checks */
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
112 /* various global constants */
113 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
114 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
118 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
119 ATA_SHORT_PAUSE = 16,
121 ATAPI_MAX_DRAIN = 16 << 10,
123 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
125 ATA_SHT_EMULATED = 1,
126 ATA_SHT_CMD_PER_LUN = 1,
127 ATA_SHT_THIS_ID = -1,
128 ATA_SHT_USE_CLUSTERING = 1,
130 /* struct ata_device stuff */
131 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
132 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
133 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
134 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
135 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
136 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
137 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
138 ATA_DFLAG_AN = (1 << 7), /* AN configured */
139 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */
140 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */
141 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
142 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
144 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
145 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
146 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
147 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
148 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
149 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
151 ATA_DFLAG_DETACH = (1 << 24),
152 ATA_DFLAG_DETACHED = (1 << 25),
154 ATA_DEV_UNKNOWN = 0, /* unknown device */
155 ATA_DEV_ATA = 1, /* ATA device */
156 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
157 ATA_DEV_ATAPI = 3, /* ATAPI device */
158 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
159 ATA_DEV_PMP = 5, /* SATA port multiplier */
160 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
161 ATA_DEV_SEMB = 7, /* SEMB */
162 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
163 ATA_DEV_NONE = 9, /* no device */
165 /* struct ata_link flags */
166 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
167 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
168 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
169 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
170 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
171 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
173 /* struct ata_port flags */
174 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
175 /* (doesn't imply presence) */
176 ATA_FLAG_SATA = (1 << 1),
177 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
178 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
179 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
180 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
181 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
182 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
183 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
184 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
185 * doesn't handle PIO interrupts */
186 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
187 ATA_FLAG_DEBUGMSG = (1 << 13),
188 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
189 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
190 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
191 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
192 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
193 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
195 /* The following flag belongs to ap->pflags but is kept in
196 * ap->flags because it's referenced in many LLDs and will be
197 * removed in not-too-distant future.
199 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
201 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
203 /* struct ata_port pflags */
204 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
205 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
206 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
207 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
208 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
209 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
210 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
211 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
212 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
214 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
215 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
216 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
218 /* struct ata_queued_cmd flags */
219 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
220 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
221 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
222 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
223 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
224 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
225 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
227 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
228 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
229 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
232 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
233 ATA_HOST_STARTED = (1 << 1), /* Host started */
235 /* bits 24:31 of host->flags are reserved for LLD specific flags */
237 /* various lengths of time */
238 ATA_TMOUT_BOOT = 30000, /* heuristic */
239 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
240 ATA_TMOUT_INTERNAL_QUICK = 5000,
242 /* FIXME: GoVault needs 2s but we can't afford that without
243 * parallel probing. 800ms is enough for iVDR disk
244 * HHD424020F7SV00. Increase to 2secs when parallel probing
247 ATA_TMOUT_FF_WAIT = 800,
249 /* Spec mandates to wait for ">= 2ms" before checking status
250 * after reset. We wait 150ms, because that was the magic
251 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
252 * the period of time between when the ATA command register is
253 * written, and then status is checked. Because waiting for
254 * "a while" before checking status is fine, post SRST, we
255 * perform this magic delay here as well.
257 * Old drivers/ide uses the 2mS rule and then waits for ready.
259 ATA_WAIT_AFTER_RESET = 150,
261 /* If PMP is supported, we have to do follow-up SRST. As some
262 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
263 * advised to wait only for the following duration before
266 ATA_TMOUT_PMP_SRST_WAIT = 1000,
280 /* SATA port states */
285 /* encoding various smaller bitmaps into a single
286 * unsigned long bitmap
288 ATA_NR_PIO_MODES = 7,
289 ATA_NR_MWDMA_MODES = 5,
290 ATA_NR_UDMA_MODES = 8,
293 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
294 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
296 /* size of buffer to pad xfers ending on unaligned boundaries */
302 /* return values for ->qc_defer */
306 /* desc_len for ata_eh_info and context */
307 ATA_EH_DESC_LEN = 80,
309 /* reset / recovery action types */
310 ATA_EH_REVALIDATE = (1 << 0),
311 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
312 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
313 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
314 ATA_EH_ENABLE_LINK = (1 << 3),
315 ATA_EH_LPM = (1 << 4), /* link power management action */
317 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
319 /* ata_eh_info->flags */
320 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
321 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
322 ATA_EHI_QUIET = (1 << 3), /* be quiet */
324 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
325 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
326 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
327 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
328 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
330 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
332 /* max tries if error condition is still set after ->error_handler */
333 ATA_EH_MAX_TRIES = 5,
335 /* how hard are we gonna try to probe/recover devices */
336 ATA_PROBE_MAX_TRIES = 3,
337 ATA_EH_DEV_TRIES = 3,
338 ATA_EH_PMP_TRIES = 5,
339 ATA_EH_PMP_LINK_TRIES = 3,
341 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
343 /* This should match the actual table size of
344 * ata_eh_cmd_timeout_table in libata-eh.c.
346 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5,
348 /* Horkage types. May be set by libata or controller on drives
349 (some horkage may be drive/controller pair dependant */
351 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
352 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
353 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
354 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
355 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
356 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
357 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
358 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
359 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
360 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
362 /* DMA mask for user DMA control: User visible values; DO NOT
364 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
365 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
366 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
368 /* ATAPI command types */
369 ATAPI_READ = 0, /* READs */
370 ATAPI_WRITE = 1, /* WRITEs */
371 ATAPI_READ_CD = 2, /* READ CD [MSF] */
372 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
373 ATAPI_MISC = 4, /* the rest */
375 /* Timing constants */
376 ATA_TIMING_SETUP = (1 << 0),
377 ATA_TIMING_ACT8B = (1 << 1),
378 ATA_TIMING_REC8B = (1 << 2),
379 ATA_TIMING_CYC8B = (1 << 3),
380 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
382 ATA_TIMING_ACTIVE = (1 << 4),
383 ATA_TIMING_RECOVER = (1 << 5),
384 ATA_TIMING_CYCLE = (1 << 6),
385 ATA_TIMING_UDMA = (1 << 7),
386 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
387 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
388 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
389 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
393 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
395 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
397 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
401 enum hsm_task_states {
402 HSM_ST_IDLE, /* no command on going */
403 HSM_ST_FIRST, /* (waiting the device to)
404 write CDB or first data block */
405 HSM_ST, /* (waiting the device to) transfer data */
406 HSM_ST_LAST, /* (waiting the device to) complete command */
407 HSM_ST_ERR, /* error */
410 enum ata_completion_errors {
411 AC_ERR_DEV = (1 << 0), /* device reported error */
412 AC_ERR_HSM = (1 << 1), /* host state machine violation */
413 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
414 AC_ERR_MEDIA = (1 << 3), /* media error */
415 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
416 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
417 AC_ERR_SYSTEM = (1 << 6), /* system error */
418 AC_ERR_INVALID = (1 << 7), /* invalid argument */
419 AC_ERR_OTHER = (1 << 8), /* unknown */
420 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
421 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
424 /* forward declarations */
426 struct ata_port_operations;
429 struct ata_queued_cmd;
432 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
433 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
434 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
435 unsigned long deadline);
436 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
439 * host pm policy: If you alter this, you also need to alter libata-scsi.c
440 * (for the ascii descriptions)
448 extern struct device_attribute dev_attr_link_power_management_policy;
450 #ifdef CONFIG_ATA_SFF
452 void __iomem *cmd_addr;
453 void __iomem *data_addr;
454 void __iomem *error_addr;
455 void __iomem *feature_addr;
456 void __iomem *nsect_addr;
457 void __iomem *lbal_addr;
458 void __iomem *lbam_addr;
459 void __iomem *lbah_addr;
460 void __iomem *device_addr;
461 void __iomem *status_addr;
462 void __iomem *command_addr;
463 void __iomem *altstatus_addr;
464 void __iomem *ctl_addr;
465 void __iomem *bmdma_addr;
466 void __iomem *scr_addr;
468 #endif /* CONFIG_ATA_SFF */
473 void __iomem * const *iomap;
474 unsigned int n_ports;
476 struct ata_port_operations *ops;
478 #ifdef CONFIG_ATA_ACPI
479 acpi_handle acpi_handle;
481 struct ata_port *simplex_claimed; /* channel owning the DMA */
482 struct ata_port *ports[0];
485 struct ata_queued_cmd {
487 struct ata_device *dev;
489 struct scsi_cmnd *scsicmd;
490 void (*scsidone)(struct scsi_cmnd *);
492 struct ata_taskfile tf;
493 u8 cdb[ATAPI_CDB_LEN];
495 unsigned long flags; /* ATA_QCFLAG_xxx */
501 unsigned int sect_size;
504 unsigned int extrabytes;
505 unsigned int curbytes;
507 struct scatterlist *cursg;
508 unsigned int cursg_ofs;
510 struct scatterlist sgent;
512 struct scatterlist *sg;
514 unsigned int err_mask;
515 struct ata_taskfile result_tf;
516 ata_qc_cb_t complete_fn;
522 struct ata_port_stats {
523 unsigned long unhandled_irq;
524 unsigned long idle_irq;
525 unsigned long rw_reqbuf;
528 struct ata_ering_entry {
530 unsigned int err_mask;
536 struct ata_ering_entry ring[ATA_ERING_SIZE];
540 struct ata_link *link;
541 unsigned int devno; /* 0 or 1 */
542 unsigned long flags; /* ATA_DFLAG_xxx */
543 unsigned int horkage; /* List of broken features */
544 struct scsi_device *sdev; /* attached SCSI device */
545 #ifdef CONFIG_ATA_ACPI
546 acpi_handle acpi_handle;
547 union acpi_object *gtf_cache;
549 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
550 u64 n_sectors; /* size of device, if ATA */
551 unsigned int class; /* ATA_DEV_xxx */
556 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
558 unsigned int multi_count; /* sectors count for
559 READ/WRITE MULTIPLE */
560 unsigned int max_sectors; /* per-device max sectors */
561 unsigned int cdb_len;
563 /* per-dev xfer mask */
564 unsigned long pio_mask;
565 unsigned long mwdma_mask;
566 unsigned long udma_mask;
568 /* for CHS addressing */
569 u16 cylinders; /* Number of cylinders */
570 u16 heads; /* Number of heads */
571 u16 sectors; /* Number of sectors per track */
575 struct ata_ering ering;
578 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
579 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
583 /* Offset into struct ata_device. Fields above it are maintained
584 * acress device init. Fields below are zeroed.
586 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
589 struct ata_device *dev; /* offending device */
590 u32 serror; /* SError from LLDD */
591 unsigned int err_mask; /* port-wide err_mask */
592 unsigned int action; /* ATA_EH_* action mask */
593 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
594 unsigned int flags; /* ATA_EHI_* flags */
596 unsigned int probe_mask;
598 char desc[ATA_EH_DESC_LEN];
602 struct ata_eh_context {
603 struct ata_eh_info i;
604 int tries[ATA_MAX_DEVICES];
605 int cmd_timeout_idx[ATA_MAX_DEVICES]
606 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
607 unsigned int classes[ATA_MAX_DEVICES];
608 unsigned int did_probe_mask;
609 unsigned int saved_ncq_enabled;
610 u8 saved_xfer_mode[ATA_MAX_DEVICES];
611 /* timestamp for the last reset attempt or success */
612 unsigned long last_reset;
615 struct ata_acpi_drive
621 struct ata_acpi_gtm {
622 struct ata_acpi_drive drive[2];
628 int pmp; /* port multiplier port # */
630 unsigned int active_tag; /* active tag on this link */
631 u32 sactive; /* active NCQ commands */
633 unsigned int flags; /* ATA_LFLAG_xxx */
635 unsigned int hw_sata_spd_limit;
636 unsigned int sata_spd_limit;
637 unsigned int sata_spd; /* current SATA PHY speed */
639 /* record runtime error info, protected by host_set lock */
640 struct ata_eh_info eh_info;
642 struct ata_eh_context eh_context;
644 struct ata_device device[ATA_MAX_DEVICES];
648 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
649 struct ata_port_operations *ops;
651 unsigned long flags; /* ATA_FLAG_xxx */
652 unsigned int pflags; /* ATA_PFLAG_xxx */
653 unsigned int print_id; /* user visible unique port ID */
654 unsigned int port_no; /* 0 based port no. inside the host */
656 struct ata_prd *prd; /* our SG list */
657 dma_addr_t prd_dma; /* and its DMA mapping */
659 #ifdef CONFIG_ATA_SFF
660 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
661 #endif /* CONFIG_ATA_SFF */
663 u8 ctl; /* cache of ATA control register */
664 u8 last_ctl; /* Cache last written value */
665 unsigned int pio_mask;
666 unsigned int mwdma_mask;
667 unsigned int udma_mask;
668 unsigned int cbl; /* cable type; ATA_CBL_xxx */
670 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
671 unsigned long qc_allocated;
672 unsigned int qc_active;
673 int nr_active_links; /* #links with active qcs */
675 struct ata_link link; /* host default link */
677 int nr_pmp_links; /* nr of available PMP links */
678 struct ata_link *pmp_link; /* array of PMP links */
679 struct ata_link *excl_link; /* for PMP qc exclusion */
681 struct ata_port_stats stats;
682 struct ata_host *host;
685 void *port_task_data;
686 struct delayed_work port_task;
687 struct delayed_work hotplug_task;
688 struct work_struct scsi_rescan_task;
690 unsigned int hsm_task_state;
693 struct list_head eh_done_q;
694 wait_queue_head_t eh_wait_q;
697 pm_message_t pm_mesg;
699 enum link_pm pm_policy;
701 struct timer_list fastdrain_timer;
702 unsigned long fastdrain_cnt;
706 #ifdef CONFIG_ATA_ACPI
707 acpi_handle acpi_handle;
708 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
710 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
713 /* The following initializer overrides a method to NULL whether one of
714 * its parent has the method defined or not. This is equivalent to
715 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
716 * expression and thus can't be used as an initializer.
718 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
720 struct ata_port_operations {
724 int (*qc_defer)(struct ata_queued_cmd *qc);
725 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
726 void (*qc_prep)(struct ata_queued_cmd *qc);
727 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
728 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
731 * Configuration and exception handling
733 int (*cable_detect)(struct ata_port *ap);
734 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
735 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
736 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
737 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
739 void (*dev_config)(struct ata_device *dev);
741 void (*freeze)(struct ata_port *ap);
742 void (*thaw)(struct ata_port *ap);
743 ata_prereset_fn_t prereset;
744 ata_reset_fn_t softreset;
745 ata_reset_fn_t hardreset;
746 ata_postreset_fn_t postreset;
747 ata_prereset_fn_t pmp_prereset;
748 ata_reset_fn_t pmp_softreset;
749 ata_reset_fn_t pmp_hardreset;
750 ata_postreset_fn_t pmp_postreset;
751 void (*error_handler)(struct ata_port *ap);
752 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
757 int (*scr_read)(struct ata_port *ap, unsigned int sc_reg, u32 *val);
758 int (*scr_write)(struct ata_port *ap, unsigned int sc_reg, u32 val);
759 void (*pmp_attach)(struct ata_port *ap);
760 void (*pmp_detach)(struct ata_port *ap);
761 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
762 void (*disable_pm)(struct ata_port *ap);
765 * Start, stop, suspend and resume
767 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
768 int (*port_resume)(struct ata_port *ap);
769 int (*port_start)(struct ata_port *ap);
770 void (*port_stop)(struct ata_port *ap);
771 void (*host_stop)(struct ata_host *host);
773 #ifdef CONFIG_ATA_SFF
775 * SFF / taskfile oriented ops
777 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
778 u8 (*sff_check_status)(struct ata_port *ap);
779 u8 (*sff_check_altstatus)(struct ata_port *ap);
780 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
781 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
782 void (*sff_exec_command)(struct ata_port *ap,
783 const struct ata_taskfile *tf);
784 unsigned int (*sff_data_xfer)(struct ata_device *dev,
785 unsigned char *buf, unsigned int buflen, int rw);
786 u8 (*sff_irq_on)(struct ata_port *);
787 void (*sff_irq_clear)(struct ata_port *);
789 void (*bmdma_setup)(struct ata_queued_cmd *qc);
790 void (*bmdma_start)(struct ata_queued_cmd *qc);
791 void (*bmdma_stop)(struct ata_queued_cmd *qc);
792 u8 (*bmdma_status)(struct ata_port *ap);
793 #endif /* CONFIG_ATA_SFF */
798 void (*phy_reset)(struct ata_port *ap);
799 void (*eng_timeout)(struct ata_port *ap);
802 * ->inherits must be the last field and all the preceding
803 * fields must be pointers.
805 const struct ata_port_operations *inherits;
808 struct ata_port_info {
810 unsigned long link_flags;
811 unsigned long pio_mask;
812 unsigned long mwdma_mask;
813 unsigned long udma_mask;
814 struct ata_port_operations *port_ops;
819 unsigned short mode; /* ATA mode */
820 unsigned short setup; /* t1 */
821 unsigned short act8b; /* t2 for 8-bit I/O */
822 unsigned short rec8b; /* t2i for 8-bit I/O */
823 unsigned short cyc8b; /* t0 for 8-bit I/O */
824 unsigned short active; /* t2 or tD */
825 unsigned short recover; /* t2i or tK */
826 unsigned short cycle; /* t0 */
827 unsigned short udma; /* t2CYCTYP/2 */
831 * Core layer - drivers/ata/libata-core.c
833 extern const unsigned long sata_deb_timing_normal[];
834 extern const unsigned long sata_deb_timing_hotplug[];
835 extern const unsigned long sata_deb_timing_long[];
837 extern struct ata_port_operations ata_dummy_port_ops;
838 extern const struct ata_port_info ata_dummy_port_info;
840 static inline const unsigned long *
841 sata_ehc_deb_timing(struct ata_eh_context *ehc)
843 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
844 return sata_deb_timing_hotplug;
846 return sata_deb_timing_normal;
849 static inline int ata_port_is_dummy(struct ata_port *ap)
851 return ap->ops == &ata_dummy_port_ops;
854 extern void ata_port_probe(struct ata_port *);
855 extern int sata_set_spd(struct ata_link *link);
856 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
857 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
858 int (*check_ready)(struct ata_link *link));
859 extern int sata_link_debounce(struct ata_link *link,
860 const unsigned long *params, unsigned long deadline);
861 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
862 unsigned long deadline);
863 extern int sata_link_hardreset(struct ata_link *link,
864 const unsigned long *timing, unsigned long deadline,
865 bool *online, int (*check_ready)(struct ata_link *));
866 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
867 unsigned long deadline);
868 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
869 extern void ata_port_disable(struct ata_port *);
871 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
872 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
873 const struct ata_port_info * const * ppi, int n_ports);
874 extern int ata_host_start(struct ata_host *host);
875 extern int ata_host_register(struct ata_host *host,
876 struct scsi_host_template *sht);
877 extern int ata_host_activate(struct ata_host *host, int irq,
878 irq_handler_t irq_handler, unsigned long irq_flags,
879 struct scsi_host_template *sht);
880 extern void ata_host_detach(struct ata_host *host);
881 extern void ata_host_init(struct ata_host *, struct device *,
882 unsigned long, struct ata_port_operations *);
883 extern int ata_scsi_detect(struct scsi_host_template *sht);
884 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
885 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
886 extern void ata_sas_port_destroy(struct ata_port *);
887 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
888 struct ata_port_info *, struct Scsi_Host *);
889 extern int ata_sas_port_init(struct ata_port *);
890 extern int ata_sas_port_start(struct ata_port *ap);
891 extern void ata_sas_port_stop(struct ata_port *ap);
892 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
893 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
894 struct ata_port *ap);
895 extern int sata_scr_valid(struct ata_link *link);
896 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
897 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
898 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
899 extern int ata_link_online(struct ata_link *link);
900 extern int ata_link_offline(struct ata_link *link);
902 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
903 extern void ata_host_resume(struct ata_host *host);
905 extern int ata_ratelimit(void);
906 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
907 unsigned long interval, unsigned long timeout);
908 extern int atapi_cmd_type(u8 opcode);
909 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
910 u8 pmp, int is_cmd, u8 *fis);
911 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
912 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
913 unsigned long mwdma_mask, unsigned long udma_mask);
914 extern void ata_unpack_xfermask(unsigned long xfer_mask,
915 unsigned long *pio_mask, unsigned long *mwdma_mask,
916 unsigned long *udma_mask);
917 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
918 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
919 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
920 extern const char *ata_mode_string(unsigned long xfer_mask);
921 extern unsigned long ata_id_xfermask(const u16 *id);
922 extern int ata_port_start(struct ata_port *ap);
923 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
924 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
925 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
926 unsigned int n_elem);
927 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
928 extern void ata_dev_disable(struct ata_device *adev);
929 extern void ata_id_string(const u16 *id, unsigned char *s,
930 unsigned int ofs, unsigned int len);
931 extern void ata_id_c_string(const u16 *id, unsigned char *s,
932 unsigned int ofs, unsigned int len);
933 extern void ata_qc_complete(struct ata_queued_cmd *qc);
934 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
935 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
936 void (*done)(struct scsi_cmnd *));
937 extern int ata_std_bios_param(struct scsi_device *sdev,
938 struct block_device *bdev,
939 sector_t capacity, int geom[]);
940 extern int ata_scsi_slave_config(struct scsi_device *sdev);
941 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
942 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
944 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
945 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
947 extern int ata_cable_40wire(struct ata_port *ap);
948 extern int ata_cable_80wire(struct ata_port *ap);
949 extern int ata_cable_sata(struct ata_port *ap);
950 extern int ata_cable_ignore(struct ata_port *ap);
951 extern int ata_cable_unknown(struct ata_port *ap);
954 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
955 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
956 extern int ata_timing_compute(struct ata_device *, unsigned short,
957 struct ata_timing *, int, int);
958 extern void ata_timing_merge(const struct ata_timing *,
959 const struct ata_timing *, struct ata_timing *,
961 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
968 unsigned int reg; /* PCI config register to read */
969 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
974 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
975 extern void ata_pci_remove_one(struct pci_dev *pdev);
978 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
979 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
980 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
981 extern int ata_pci_device_resume(struct pci_dev *pdev);
982 #endif /* CONFIG_PM */
983 #endif /* CONFIG_PCI */
986 * ACPI - drivers/ata/libata-acpi.c
988 #ifdef CONFIG_ATA_ACPI
989 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
991 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
992 return &ap->__acpi_init_gtm;
995 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
996 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
997 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
998 const struct ata_acpi_gtm *gtm);
999 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1001 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1006 static inline int ata_acpi_stm(const struct ata_port *ap,
1007 struct ata_acpi_gtm *stm)
1012 static inline int ata_acpi_gtm(const struct ata_port *ap,
1013 struct ata_acpi_gtm *stm)
1018 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1019 const struct ata_acpi_gtm *gtm)
1024 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1025 const struct ata_acpi_gtm *gtm)
1032 * EH - drivers/ata/libata-eh.c
1034 extern void ata_port_schedule_eh(struct ata_port *ap);
1035 extern int ata_link_abort(struct ata_link *link);
1036 extern int ata_port_abort(struct ata_port *ap);
1037 extern int ata_port_freeze(struct ata_port *ap);
1038 extern int sata_async_notification(struct ata_port *ap);
1040 extern void ata_eh_freeze_port(struct ata_port *ap);
1041 extern void ata_eh_thaw_port(struct ata_port *ap);
1043 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1044 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1045 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1047 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1048 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1049 ata_postreset_fn_t postreset);
1050 extern void ata_std_error_handler(struct ata_port *ap);
1053 * Base operations to inherit from and initializers for sht
1057 * base : Common to all libata drivers.
1058 * sata : SATA controllers w/ native interface.
1059 * pmp : SATA controllers w/ PMP support.
1060 * sff : SFF ATA controllers w/o BMDMA support.
1061 * bmdma : SFF ATA controllers w/ BMDMA support.
1065 * BASE : Common to all libata drivers. The user must set
1066 * sg_tablesize and dma_boundary.
1067 * PIO : SFF ATA controllers w/ only PIO support.
1068 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1069 * dma_boundary are set to BMDMA limits.
1070 * NCQ : SATA controllers supporting NCQ. The user must set
1071 * sg_tablesize, dma_boundary and can_queue.
1073 extern const struct ata_port_operations ata_base_port_ops;
1074 extern const struct ata_port_operations sata_port_ops;
1076 #define ATA_BASE_SHT(drv_name) \
1077 .module = THIS_MODULE, \
1079 .ioctl = ata_scsi_ioctl, \
1080 .queuecommand = ata_scsi_queuecmd, \
1081 .can_queue = ATA_DEF_QUEUE, \
1082 .this_id = ATA_SHT_THIS_ID, \
1083 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1084 .emulated = ATA_SHT_EMULATED, \
1085 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1086 .proc_name = drv_name, \
1087 .slave_configure = ata_scsi_slave_config, \
1088 .slave_destroy = ata_scsi_slave_destroy, \
1089 .bios_param = ata_std_bios_param
1091 #define ATA_NCQ_SHT(drv_name) \
1092 ATA_BASE_SHT(drv_name), \
1093 .change_queue_depth = ata_scsi_change_queue_depth
1098 #ifdef CONFIG_SATA_PMP
1099 static inline bool sata_pmp_supported(struct ata_port *ap)
1101 return ap->flags & ATA_FLAG_PMP;
1104 static inline bool sata_pmp_attached(struct ata_port *ap)
1106 return ap->nr_pmp_links != 0;
1109 static inline int ata_is_host_link(const struct ata_link *link)
1111 return link == &link->ap->link;
1113 #else /* CONFIG_SATA_PMP */
1114 static inline bool sata_pmp_supported(struct ata_port *ap)
1119 static inline bool sata_pmp_attached(struct ata_port *ap)
1124 static inline int ata_is_host_link(const struct ata_link *link)
1128 #endif /* CONFIG_SATA_PMP */
1130 static inline int sata_srst_pmp(struct ata_link *link)
1132 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1133 return SATA_PMP_CTRL_PORT;
1140 #define ata_port_printk(ap, lv, fmt, args...) \
1141 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1143 #define ata_link_printk(link, lv, fmt, args...) do { \
1144 if (sata_pmp_attached((link)->ap)) \
1145 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
1146 (link)->pmp , ##args); \
1148 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1151 #define ata_dev_printk(dev, lv, fmt, args...) \
1152 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
1153 (dev)->link->pmp + (dev)->devno , ##args)
1156 * ata_eh_info helpers
1158 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1159 __attribute__ ((format (printf, 2, 3)));
1160 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1161 __attribute__ ((format (printf, 2, 3)));
1162 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1164 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1166 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1167 ehi->flags |= ATA_EHI_HOTPLUGGED;
1168 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1169 ehi->err_mask |= AC_ERR_ATA_BUS;
1173 * port description helpers
1175 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1176 __attribute__ ((format (printf, 2, 3)));
1178 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1182 static inline unsigned int ata_tag_valid(unsigned int tag)
1184 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1187 static inline unsigned int ata_tag_internal(unsigned int tag)
1189 return tag == ATA_TAG_INTERNAL;
1195 static inline unsigned int ata_class_enabled(unsigned int class)
1197 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1198 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1201 static inline unsigned int ata_class_disabled(unsigned int class)
1203 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1204 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1207 static inline unsigned int ata_class_absent(unsigned int class)
1209 return !ata_class_enabled(class) && !ata_class_disabled(class);
1212 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1214 return ata_class_enabled(dev->class);
1217 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1219 return ata_class_disabled(dev->class);
1222 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1224 return ata_class_absent(dev->class);
1230 static inline int ata_link_max_devices(const struct ata_link *link)
1232 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1237 static inline int ata_link_active(struct ata_link *link)
1239 return ata_tag_valid(link->active_tag) || link->sactive;
1242 static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1244 if (sata_pmp_attached(ap))
1245 return ap->pmp_link;
1249 static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1251 struct ata_port *ap = link->ap;
1253 if (ata_is_host_link(link)) {
1254 if (!sata_pmp_attached(ap))
1256 return ap->pmp_link;
1259 if (++link < ap->nr_pmp_links + ap->pmp_link)
1264 #define __ata_port_for_each_link(lk, ap) \
1265 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1267 #define ata_port_for_each_link(link, ap) \
1268 for ((link) = ata_port_first_link(ap); (link); \
1269 (link) = ata_port_next_link(link))
1271 #define ata_link_for_each_dev(dev, link) \
1272 for ((dev) = (link)->device; \
1273 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1276 #define ata_link_for_each_dev_reverse(dev, link) \
1277 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1278 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1281 * ata_ncq_enabled - Test whether NCQ is enabled
1282 * @dev: ATA device to test for
1285 * spin_lock_irqsave(host lock)
1288 * 1 if NCQ is enabled for @dev, 0 otherwise.
1290 static inline int ata_ncq_enabled(struct ata_device *dev)
1292 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1293 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1296 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1298 qc->tf.ctl |= ATA_NIEN;
1301 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1304 if (likely(ata_tag_valid(tag)))
1305 return &ap->qcmd[tag];
1309 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1312 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1314 if (unlikely(!qc) || !ap->ops->error_handler)
1317 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1318 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1324 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1326 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1329 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1331 memset(tf, 0, sizeof(*tf));
1333 tf->ctl = dev->link->ap->ctl;
1334 if (dev->devno == 0)
1335 tf->device = ATA_DEVICE_OBS;
1337 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1340 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1342 qc->dma_dir = DMA_NONE;
1347 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1350 qc->sect_size = ATA_SECT_SIZE;
1352 ata_tf_init(qc->dev, &qc->tf);
1354 /* init result_tf such that it indicates normal completion */
1355 qc->result_tf.command = ATA_DRDY;
1356 qc->result_tf.feature = 0;
1359 static inline int ata_try_flush_cache(const struct ata_device *dev)
1361 return ata_id_wcache_enabled(dev->id) ||
1362 ata_id_has_flush(dev->id) ||
1363 ata_id_has_flush_ext(dev->id);
1366 static inline unsigned int ac_err_mask(u8 status)
1368 if (status & (ATA_BUSY | ATA_DRQ))
1370 if (status & (ATA_ERR | ATA_DF))
1375 static inline unsigned int __ac_err_mask(u8 status)
1377 unsigned int mask = ac_err_mask(status);
1379 return AC_ERR_OTHER;
1383 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1385 return *(struct ata_port **)&host->hostdata[0];
1388 static inline int ata_check_ready(u8 status)
1390 if (!(status & ATA_BUSY))
1393 /* 0xff indicates either no device or device not ready */
1400 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1401 unsigned long timeout_msecs)
1403 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1407 /**************************************************************************
1408 * PMP - drivers/ata/libata-pmp.c
1410 #ifdef CONFIG_SATA_PMP
1412 extern const struct ata_port_operations sata_pmp_port_ops;
1414 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1415 extern void sata_pmp_error_handler(struct ata_port *ap);
1417 #else /* CONFIG_SATA_PMP */
1419 #define sata_pmp_port_ops sata_port_ops
1420 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1421 #define sata_pmp_error_handler ata_std_error_handler
1423 #endif /* CONFIG_SATA_PMP */
1426 /**************************************************************************
1427 * SFF - drivers/ata/libata-sff.c
1429 #ifdef CONFIG_ATA_SFF
1431 extern const struct ata_port_operations ata_sff_port_ops;
1432 extern const struct ata_port_operations ata_bmdma_port_ops;
1434 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1435 #define ATA_PIO_SHT(drv_name) \
1436 ATA_BASE_SHT(drv_name), \
1437 .sg_tablesize = LIBATA_MAX_PRD, \
1438 .dma_boundary = ATA_DMA_BOUNDARY
1440 #define ATA_BMDMA_SHT(drv_name) \
1441 ATA_BASE_SHT(drv_name), \
1442 .sg_tablesize = LIBATA_MAX_PRD, \
1443 .dma_boundary = ATA_DMA_BOUNDARY
1445 extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1446 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1447 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1448 extern u8 ata_sff_check_status(struct ata_port *ap);
1449 extern void ata_sff_pause(struct ata_port *ap);
1450 extern void ata_sff_dma_pause(struct ata_port *ap);
1451 extern int ata_sff_busy_sleep(struct ata_port *ap,
1452 unsigned long timeout_pat, unsigned long timeout);
1453 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1454 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1455 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1456 extern void ata_sff_exec_command(struct ata_port *ap,
1457 const struct ata_taskfile *tf);
1458 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1459 unsigned char *buf, unsigned int buflen, int rw);
1460 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1461 unsigned char *buf, unsigned int buflen, int rw);
1462 extern u8 ata_sff_irq_on(struct ata_port *ap);
1463 extern void ata_sff_irq_clear(struct ata_port *ap);
1464 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1465 u8 status, int in_wq);
1466 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1467 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1468 extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1469 struct ata_queued_cmd *qc);
1470 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1471 extern void ata_sff_freeze(struct ata_port *ap);
1472 extern void ata_sff_thaw(struct ata_port *ap);
1473 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1474 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1476 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1477 unsigned long deadline);
1478 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1479 unsigned long deadline);
1480 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1481 unsigned long deadline);
1482 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1483 extern void ata_sff_error_handler(struct ata_port *ap);
1484 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1485 extern int ata_sff_port_start(struct ata_port *ap);
1486 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1487 extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1488 unsigned long xfer_mask);
1489 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1490 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1491 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1492 extern u8 ata_bmdma_status(struct ata_port *ap);
1493 extern void ata_bus_reset(struct ata_port *ap);
1496 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1497 extern int ata_pci_bmdma_init(struct ata_host *host);
1498 extern int ata_pci_sff_init_host(struct ata_host *host);
1499 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1500 const struct ata_port_info * const * ppi,
1501 struct ata_host **r_host);
1502 extern int ata_pci_sff_activate_host(struct ata_host *host,
1503 irq_handler_t irq_handler,
1504 struct scsi_host_template *sht);
1505 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1506 const struct ata_port_info * const * ppi,
1507 struct scsi_host_template *sht, void *host_priv);
1508 #endif /* CONFIG_PCI */
1511 * ata_sff_busy_wait - Wait for a port status register
1512 * @ap: Port to wait for.
1513 * @bits: bits that must be clear
1514 * @max: number of 10uS waits to perform
1516 * Waits up to max*10 microseconds for the selected bits in the port's
1517 * status register to be cleared.
1518 * Returns final value of status register.
1521 * Inherited from caller.
1523 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1530 status = ap->ops->sff_check_status(ap);
1532 } while (status != 0xff && (status & bits) && (max > 0));
1538 * ata_wait_idle - Wait for a port to be idle.
1539 * @ap: Port to wait for.
1541 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1542 * Returns final value of status register.
1545 * Inherited from caller.
1547 static inline u8 ata_wait_idle(struct ata_port *ap)
1549 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1552 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1553 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1559 #endif /* CONFIG_ATA_SFF */
1561 #endif /* __LINUX_LIBATA_H__ */