Merge branch 'for-linus' of git://git.kernel.dk/linux-2.6-block
[linux-2.6/zen-sources.git] / include / linux / libata.h
blob59b0f1c807b5bd97580373781fb6028970431657
1 /*
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)
9 * any later version.
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>
34 #include <linux/io.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>
47 #else
48 #include <asm-generic/libata-portmap.h>
49 #endif
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 */
62 #ifdef ATA_DEBUG
63 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
64 #ifdef ATA_VERBOSE_DEBUG
65 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
66 #else
67 #define VPRINTK(fmt, args...)
68 #endif /* ATA_VERBOSE_DEBUG */
69 #else
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, __func__, ## args)
76 /* NEW: debug levels */
77 #define HAVE_LIBATA_MSG 1
79 enum {
80 ATA_MSG_DRV = 0x0001,
81 ATA_MSG_INFO = 0x0002,
82 ATA_MSG_PROBE = 0x0004,
83 ATA_MSG_WARN = 0x0008,
84 ATA_MSG_MALLOC = 0x0010,
85 ATA_MSG_CTL = 0x0020,
86 ATA_MSG_INTR = 0x0040,
87 ATA_MSG_ERR = 0x0080,
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 */
103 if (!dval)
104 return 0;
105 return (1 << dval) - 1;
108 /* defines only for the constants which don't work well as enums */
109 #define ATA_TAG_POISON 0xfafbfcfdU
111 enum {
112 /* various global constants */
113 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
114 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
115 ATA_DEF_QUEUE = 1,
116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
117 ATA_MAX_QUEUE = 32,
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_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
150 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
152 ATA_DFLAG_DETACH = (1 << 24),
153 ATA_DFLAG_DETACHED = (1 << 25),
155 ATA_DEV_UNKNOWN = 0, /* unknown device */
156 ATA_DEV_ATA = 1, /* ATA device */
157 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
158 ATA_DEV_ATAPI = 3, /* ATAPI device */
159 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
160 ATA_DEV_PMP = 5, /* SATA port multiplier */
161 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
162 ATA_DEV_SEMB = 7, /* SEMB */
163 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
164 ATA_DEV_NONE = 9, /* no device */
166 /* struct ata_link flags */
167 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
168 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
169 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
170 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
171 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
172 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
173 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
174 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
176 /* struct ata_port flags */
177 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
178 /* (doesn't imply presence) */
179 ATA_FLAG_SATA = (1 << 1),
180 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
181 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
182 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
183 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
184 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
185 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
186 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
187 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
188 * doesn't handle PIO interrupts */
189 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
190 ATA_FLAG_DEBUGMSG = (1 << 13),
191 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
192 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
193 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
194 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
195 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
196 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
197 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
198 * management */
199 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
200 * led */
202 /* The following flag belongs to ap->pflags but is kept in
203 * ap->flags because it's referenced in many LLDs and will be
204 * removed in not-too-distant future.
206 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
208 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
210 /* struct ata_port pflags */
211 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
212 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
213 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
214 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
215 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
216 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
217 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
218 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
219 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
221 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
222 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
223 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
225 /* struct ata_queued_cmd flags */
226 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
227 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
228 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
229 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
230 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
231 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
232 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
234 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
235 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
236 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
238 /* host set flags */
239 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
240 ATA_HOST_STARTED = (1 << 1), /* Host started */
242 /* bits 24:31 of host->flags are reserved for LLD specific flags */
244 /* various lengths of time */
245 ATA_TMOUT_BOOT = 30000, /* heuristic */
246 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
247 ATA_TMOUT_INTERNAL_QUICK = 5000,
248 ATA_TMOUT_MAX_PARK = 30000,
250 /* FIXME: GoVault needs 2s but we can't afford that without
251 * parallel probing. 800ms is enough for iVDR disk
252 * HHD424020F7SV00. Increase to 2secs when parallel probing
253 * is in place.
255 ATA_TMOUT_FF_WAIT = 800,
257 /* Spec mandates to wait for ">= 2ms" before checking status
258 * after reset. We wait 150ms, because that was the magic
259 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
260 * the period of time between when the ATA command register is
261 * written, and then status is checked. Because waiting for
262 * "a while" before checking status is fine, post SRST, we
263 * perform this magic delay here as well.
265 * Old drivers/ide uses the 2mS rule and then waits for ready.
267 ATA_WAIT_AFTER_RESET = 150,
269 /* If PMP is supported, we have to do follow-up SRST. As some
270 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
271 * advised to wait only for the following duration before
272 * doing SRST.
274 ATA_TMOUT_PMP_SRST_WAIT = 1000,
276 /* ATA bus states */
277 BUS_UNKNOWN = 0,
278 BUS_DMA = 1,
279 BUS_IDLE = 2,
280 BUS_NOINTR = 3,
281 BUS_NODATA = 4,
282 BUS_TIMER = 5,
283 BUS_PIO = 6,
284 BUS_EDD = 7,
285 BUS_IDENTIFY = 8,
286 BUS_PACKET = 9,
288 /* SATA port states */
289 PORT_UNKNOWN = 0,
290 PORT_ENABLED = 1,
291 PORT_DISABLED = 2,
293 /* encoding various smaller bitmaps into a single
294 * unsigned long bitmap
296 ATA_NR_PIO_MODES = 7,
297 ATA_NR_MWDMA_MODES = 5,
298 ATA_NR_UDMA_MODES = 8,
300 ATA_SHIFT_PIO = 0,
301 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
302 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
304 /* size of buffer to pad xfers ending on unaligned boundaries */
305 ATA_DMA_PAD_SZ = 4,
307 /* ering size */
308 ATA_ERING_SIZE = 32,
310 /* return values for ->qc_defer */
311 ATA_DEFER_LINK = 1,
312 ATA_DEFER_PORT = 2,
314 /* desc_len for ata_eh_info and context */
315 ATA_EH_DESC_LEN = 80,
317 /* reset / recovery action types */
318 ATA_EH_REVALIDATE = (1 << 0),
319 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
320 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
321 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
322 ATA_EH_ENABLE_LINK = (1 << 3),
323 ATA_EH_LPM = (1 << 4), /* link power management action */
324 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
326 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
327 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
328 ATA_EH_ENABLE_LINK | ATA_EH_LPM,
330 /* ata_eh_info->flags */
331 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
332 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
333 ATA_EHI_QUIET = (1 << 3), /* be quiet */
335 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
336 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
337 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
338 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
339 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
341 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
343 /* mask of flags to transfer *to* the slave link */
344 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
346 /* max tries if error condition is still set after ->error_handler */
347 ATA_EH_MAX_TRIES = 5,
349 /* how hard are we gonna try to probe/recover devices */
350 ATA_PROBE_MAX_TRIES = 3,
351 ATA_EH_DEV_TRIES = 3,
352 ATA_EH_PMP_TRIES = 5,
353 ATA_EH_PMP_LINK_TRIES = 3,
355 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
357 /* This should match the actual table size of
358 * ata_eh_cmd_timeout_table in libata-eh.c.
360 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5,
362 /* Horkage types. May be set by libata or controller on drives
363 (some horkage may be drive/controller pair dependant */
365 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
366 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
367 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
368 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
369 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
370 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
371 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
372 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
373 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
374 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
375 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
376 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
377 not multiple of 16 bytes */
379 /* DMA mask for user DMA control: User visible values; DO NOT
380 renumber */
381 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
382 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
383 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
385 /* ATAPI command types */
386 ATAPI_READ = 0, /* READs */
387 ATAPI_WRITE = 1, /* WRITEs */
388 ATAPI_READ_CD = 2, /* READ CD [MSF] */
389 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
390 ATAPI_MISC = 4, /* the rest */
392 /* Timing constants */
393 ATA_TIMING_SETUP = (1 << 0),
394 ATA_TIMING_ACT8B = (1 << 1),
395 ATA_TIMING_REC8B = (1 << 2),
396 ATA_TIMING_CYC8B = (1 << 3),
397 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
398 ATA_TIMING_CYC8B,
399 ATA_TIMING_ACTIVE = (1 << 4),
400 ATA_TIMING_RECOVER = (1 << 5),
401 ATA_TIMING_CYCLE = (1 << 6),
402 ATA_TIMING_UDMA = (1 << 7),
403 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
404 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
405 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
406 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
409 enum ata_xfer_mask {
410 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
411 << ATA_SHIFT_PIO,
412 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
413 << ATA_SHIFT_MWDMA,
414 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
415 << ATA_SHIFT_UDMA,
418 enum hsm_task_states {
419 HSM_ST_IDLE, /* no command on going */
420 HSM_ST_FIRST, /* (waiting the device to)
421 write CDB or first data block */
422 HSM_ST, /* (waiting the device to) transfer data */
423 HSM_ST_LAST, /* (waiting the device to) complete command */
424 HSM_ST_ERR, /* error */
427 enum ata_completion_errors {
428 AC_ERR_DEV = (1 << 0), /* device reported error */
429 AC_ERR_HSM = (1 << 1), /* host state machine violation */
430 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
431 AC_ERR_MEDIA = (1 << 3), /* media error */
432 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
433 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
434 AC_ERR_SYSTEM = (1 << 6), /* system error */
435 AC_ERR_INVALID = (1 << 7), /* invalid argument */
436 AC_ERR_OTHER = (1 << 8), /* unknown */
437 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
438 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
441 /* forward declarations */
442 struct scsi_device;
443 struct ata_port_operations;
444 struct ata_port;
445 struct ata_link;
446 struct ata_queued_cmd;
448 /* typedefs */
449 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
450 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
451 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
452 unsigned long deadline);
453 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
456 * host pm policy: If you alter this, you also need to alter libata-scsi.c
457 * (for the ascii descriptions)
459 enum link_pm {
460 NOT_AVAILABLE,
461 MIN_POWER,
462 MAX_PERFORMANCE,
463 MEDIUM_POWER,
465 extern struct device_attribute dev_attr_link_power_management_policy;
466 extern struct device_attribute dev_attr_unload_heads;
467 extern struct device_attribute dev_attr_em_message_type;
468 extern struct device_attribute dev_attr_em_message;
469 extern struct device_attribute dev_attr_sw_activity;
471 enum sw_activity {
472 OFF,
473 BLINK_ON,
474 BLINK_OFF,
477 #ifdef CONFIG_ATA_SFF
478 struct ata_ioports {
479 void __iomem *cmd_addr;
480 void __iomem *data_addr;
481 void __iomem *error_addr;
482 void __iomem *feature_addr;
483 void __iomem *nsect_addr;
484 void __iomem *lbal_addr;
485 void __iomem *lbam_addr;
486 void __iomem *lbah_addr;
487 void __iomem *device_addr;
488 void __iomem *status_addr;
489 void __iomem *command_addr;
490 void __iomem *altstatus_addr;
491 void __iomem *ctl_addr;
492 void __iomem *bmdma_addr;
493 void __iomem *scr_addr;
495 #endif /* CONFIG_ATA_SFF */
497 struct ata_host {
498 spinlock_t lock;
499 struct device *dev;
500 void __iomem * const *iomap;
501 unsigned int n_ports;
502 void *private_data;
503 struct ata_port_operations *ops;
504 unsigned long flags;
505 #ifdef CONFIG_ATA_ACPI
506 acpi_handle acpi_handle;
507 #endif
508 struct ata_port *simplex_claimed; /* channel owning the DMA */
509 struct ata_port *ports[0];
512 struct ata_queued_cmd {
513 struct ata_port *ap;
514 struct ata_device *dev;
516 struct scsi_cmnd *scsicmd;
517 void (*scsidone)(struct scsi_cmnd *);
519 struct ata_taskfile tf;
520 u8 cdb[ATAPI_CDB_LEN];
522 unsigned long flags; /* ATA_QCFLAG_xxx */
523 unsigned int tag;
524 unsigned int n_elem;
526 int dma_dir;
528 unsigned int sect_size;
530 unsigned int nbytes;
531 unsigned int extrabytes;
532 unsigned int curbytes;
534 struct scatterlist *cursg;
535 unsigned int cursg_ofs;
537 struct scatterlist sgent;
539 struct scatterlist *sg;
541 unsigned int err_mask;
542 struct ata_taskfile result_tf;
543 ata_qc_cb_t complete_fn;
545 void *private_data;
546 void *lldd_task;
549 struct ata_port_stats {
550 unsigned long unhandled_irq;
551 unsigned long idle_irq;
552 unsigned long rw_reqbuf;
555 struct ata_ering_entry {
556 unsigned int eflags;
557 unsigned int err_mask;
558 u64 timestamp;
561 struct ata_ering {
562 int cursor;
563 struct ata_ering_entry ring[ATA_ERING_SIZE];
566 struct ata_device {
567 struct ata_link *link;
568 unsigned int devno; /* 0 or 1 */
569 unsigned int horkage; /* List of broken features */
570 unsigned long flags; /* ATA_DFLAG_xxx */
571 struct scsi_device *sdev; /* attached SCSI device */
572 #ifdef CONFIG_ATA_ACPI
573 acpi_handle acpi_handle;
574 union acpi_object *gtf_cache;
575 #endif
576 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
577 u64 n_sectors; /* size of device, if ATA */
578 unsigned int class; /* ATA_DEV_xxx */
579 unsigned long unpark_deadline;
581 u8 pio_mode;
582 u8 dma_mode;
583 u8 xfer_mode;
584 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
586 unsigned int multi_count; /* sectors count for
587 READ/WRITE MULTIPLE */
588 unsigned int max_sectors; /* per-device max sectors */
589 unsigned int cdb_len;
591 /* per-dev xfer mask */
592 unsigned long pio_mask;
593 unsigned long mwdma_mask;
594 unsigned long udma_mask;
596 /* for CHS addressing */
597 u16 cylinders; /* Number of cylinders */
598 u16 heads; /* Number of heads */
599 u16 sectors; /* Number of sectors per track */
601 /* error history */
602 int spdn_cnt;
603 struct ata_ering ering;
605 union {
606 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
607 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
611 /* Offset into struct ata_device. Fields above it are maintained
612 * acress device init. Fields below are zeroed.
614 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
616 struct ata_eh_info {
617 struct ata_device *dev; /* offending device */
618 u32 serror; /* SError from LLDD */
619 unsigned int err_mask; /* port-wide err_mask */
620 unsigned int action; /* ATA_EH_* action mask */
621 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
622 unsigned int flags; /* ATA_EHI_* flags */
624 unsigned int probe_mask;
626 char desc[ATA_EH_DESC_LEN];
627 int desc_len;
630 struct ata_eh_context {
631 struct ata_eh_info i;
632 int tries[ATA_MAX_DEVICES];
633 int cmd_timeout_idx[ATA_MAX_DEVICES]
634 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
635 unsigned int classes[ATA_MAX_DEVICES];
636 unsigned int did_probe_mask;
637 unsigned int unloaded_mask;
638 unsigned int saved_ncq_enabled;
639 u8 saved_xfer_mode[ATA_MAX_DEVICES];
640 /* timestamp for the last reset attempt or success */
641 unsigned long last_reset;
644 struct ata_acpi_drive
646 u32 pio;
647 u32 dma;
648 } __packed;
650 struct ata_acpi_gtm {
651 struct ata_acpi_drive drive[2];
652 u32 flags;
653 } __packed;
655 struct ata_link {
656 struct ata_port *ap;
657 int pmp; /* port multiplier port # */
659 unsigned int active_tag; /* active tag on this link */
660 u32 sactive; /* active NCQ commands */
662 unsigned int flags; /* ATA_LFLAG_xxx */
664 u32 saved_scontrol; /* SControl on probe */
665 unsigned int hw_sata_spd_limit;
666 unsigned int sata_spd_limit;
667 unsigned int sata_spd; /* current SATA PHY speed */
669 /* record runtime error info, protected by host_set lock */
670 struct ata_eh_info eh_info;
671 /* EH context */
672 struct ata_eh_context eh_context;
674 struct ata_device device[ATA_MAX_DEVICES];
677 struct ata_port {
678 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
679 struct ata_port_operations *ops;
680 spinlock_t *lock;
681 unsigned long flags; /* ATA_FLAG_xxx */
682 unsigned int pflags; /* ATA_PFLAG_xxx */
683 unsigned int print_id; /* user visible unique port ID */
684 unsigned int port_no; /* 0 based port no. inside the host */
686 struct ata_prd *prd; /* our SG list */
687 dma_addr_t prd_dma; /* and its DMA mapping */
689 #ifdef CONFIG_ATA_SFF
690 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
691 #endif /* CONFIG_ATA_SFF */
693 u8 ctl; /* cache of ATA control register */
694 u8 last_ctl; /* Cache last written value */
695 unsigned int pio_mask;
696 unsigned int mwdma_mask;
697 unsigned int udma_mask;
698 unsigned int cbl; /* cable type; ATA_CBL_xxx */
700 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
701 unsigned long qc_allocated;
702 unsigned int qc_active;
703 int nr_active_links; /* #links with active qcs */
705 struct ata_link link; /* host default link */
706 struct ata_link *slave_link; /* see ata_slave_link_init() */
708 int nr_pmp_links; /* nr of available PMP links */
709 struct ata_link *pmp_link; /* array of PMP links */
710 struct ata_link *excl_link; /* for PMP qc exclusion */
712 struct ata_port_stats stats;
713 struct ata_host *host;
714 struct device *dev;
716 void *port_task_data;
717 struct delayed_work port_task;
718 struct delayed_work hotplug_task;
719 struct work_struct scsi_rescan_task;
721 unsigned int hsm_task_state;
723 u32 msg_enable;
724 struct list_head eh_done_q;
725 wait_queue_head_t eh_wait_q;
726 int eh_tries;
727 struct completion park_req_pending;
729 pm_message_t pm_mesg;
730 int *pm_result;
731 enum link_pm pm_policy;
733 struct timer_list fastdrain_timer;
734 unsigned long fastdrain_cnt;
736 int em_message_type;
737 void *private_data;
739 #ifdef CONFIG_ATA_ACPI
740 acpi_handle acpi_handle;
741 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
742 #endif
743 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
746 /* The following initializer overrides a method to NULL whether one of
747 * its parent has the method defined or not. This is equivalent to
748 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
749 * expression and thus can't be used as an initializer.
751 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
753 struct ata_port_operations {
755 * Command execution
757 int (*qc_defer)(struct ata_queued_cmd *qc);
758 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
759 void (*qc_prep)(struct ata_queued_cmd *qc);
760 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
761 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
764 * Configuration and exception handling
766 int (*cable_detect)(struct ata_port *ap);
767 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
768 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
769 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
770 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
771 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
773 void (*dev_config)(struct ata_device *dev);
775 void (*freeze)(struct ata_port *ap);
776 void (*thaw)(struct ata_port *ap);
777 ata_prereset_fn_t prereset;
778 ata_reset_fn_t softreset;
779 ata_reset_fn_t hardreset;
780 ata_postreset_fn_t postreset;
781 ata_prereset_fn_t pmp_prereset;
782 ata_reset_fn_t pmp_softreset;
783 ata_reset_fn_t pmp_hardreset;
784 ata_postreset_fn_t pmp_postreset;
785 void (*error_handler)(struct ata_port *ap);
786 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
789 * Optional features
791 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
792 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
793 void (*pmp_attach)(struct ata_port *ap);
794 void (*pmp_detach)(struct ata_port *ap);
795 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
796 void (*disable_pm)(struct ata_port *ap);
799 * Start, stop, suspend and resume
801 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
802 int (*port_resume)(struct ata_port *ap);
803 int (*port_start)(struct ata_port *ap);
804 void (*port_stop)(struct ata_port *ap);
805 void (*host_stop)(struct ata_host *host);
807 #ifdef CONFIG_ATA_SFF
809 * SFF / taskfile oriented ops
811 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
812 u8 (*sff_check_status)(struct ata_port *ap);
813 u8 (*sff_check_altstatus)(struct ata_port *ap);
814 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
815 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
816 void (*sff_exec_command)(struct ata_port *ap,
817 const struct ata_taskfile *tf);
818 unsigned int (*sff_data_xfer)(struct ata_device *dev,
819 unsigned char *buf, unsigned int buflen, int rw);
820 u8 (*sff_irq_on)(struct ata_port *);
821 void (*sff_irq_clear)(struct ata_port *);
823 void (*bmdma_setup)(struct ata_queued_cmd *qc);
824 void (*bmdma_start)(struct ata_queued_cmd *qc);
825 void (*bmdma_stop)(struct ata_queued_cmd *qc);
826 u8 (*bmdma_status)(struct ata_port *ap);
827 #endif /* CONFIG_ATA_SFF */
829 ssize_t (*em_show)(struct ata_port *ap, char *buf);
830 ssize_t (*em_store)(struct ata_port *ap, const char *message,
831 size_t size);
832 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
833 ssize_t (*sw_activity_store)(struct ata_device *dev,
834 enum sw_activity val);
836 * Obsolete
838 void (*phy_reset)(struct ata_port *ap);
839 void (*eng_timeout)(struct ata_port *ap);
842 * ->inherits must be the last field and all the preceding
843 * fields must be pointers.
845 const struct ata_port_operations *inherits;
848 struct ata_port_info {
849 unsigned long flags;
850 unsigned long link_flags;
851 unsigned long pio_mask;
852 unsigned long mwdma_mask;
853 unsigned long udma_mask;
854 struct ata_port_operations *port_ops;
855 void *private_data;
858 struct ata_timing {
859 unsigned short mode; /* ATA mode */
860 unsigned short setup; /* t1 */
861 unsigned short act8b; /* t2 for 8-bit I/O */
862 unsigned short rec8b; /* t2i for 8-bit I/O */
863 unsigned short cyc8b; /* t0 for 8-bit I/O */
864 unsigned short active; /* t2 or tD */
865 unsigned short recover; /* t2i or tK */
866 unsigned short cycle; /* t0 */
867 unsigned short udma; /* t2CYCTYP/2 */
871 * Core layer - drivers/ata/libata-core.c
873 extern const unsigned long sata_deb_timing_normal[];
874 extern const unsigned long sata_deb_timing_hotplug[];
875 extern const unsigned long sata_deb_timing_long[];
877 extern struct ata_port_operations ata_dummy_port_ops;
878 extern const struct ata_port_info ata_dummy_port_info;
880 static inline const unsigned long *
881 sata_ehc_deb_timing(struct ata_eh_context *ehc)
883 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
884 return sata_deb_timing_hotplug;
885 else
886 return sata_deb_timing_normal;
889 static inline int ata_port_is_dummy(struct ata_port *ap)
891 return ap->ops == &ata_dummy_port_ops;
894 extern void ata_port_probe(struct ata_port *);
895 extern int sata_set_spd(struct ata_link *link);
896 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
897 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
898 int (*check_ready)(struct ata_link *link));
899 extern int sata_link_debounce(struct ata_link *link,
900 const unsigned long *params, unsigned long deadline);
901 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
902 unsigned long deadline);
903 extern int sata_link_hardreset(struct ata_link *link,
904 const unsigned long *timing, unsigned long deadline,
905 bool *online, int (*check_ready)(struct ata_link *));
906 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
907 unsigned long deadline);
908 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
909 extern void ata_port_disable(struct ata_port *);
911 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
912 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
913 const struct ata_port_info * const * ppi, int n_ports);
914 extern int ata_slave_link_init(struct ata_port *ap);
915 extern int ata_host_start(struct ata_host *host);
916 extern int ata_host_register(struct ata_host *host,
917 struct scsi_host_template *sht);
918 extern int ata_host_activate(struct ata_host *host, int irq,
919 irq_handler_t irq_handler, unsigned long irq_flags,
920 struct scsi_host_template *sht);
921 extern void ata_host_detach(struct ata_host *host);
922 extern void ata_host_init(struct ata_host *, struct device *,
923 unsigned long, struct ata_port_operations *);
924 extern int ata_scsi_detect(struct scsi_host_template *sht);
925 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
926 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
927 extern void ata_sas_port_destroy(struct ata_port *);
928 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
929 struct ata_port_info *, struct Scsi_Host *);
930 extern int ata_sas_port_init(struct ata_port *);
931 extern int ata_sas_port_start(struct ata_port *ap);
932 extern void ata_sas_port_stop(struct ata_port *ap);
933 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
934 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
935 struct ata_port *ap);
936 extern int sata_scr_valid(struct ata_link *link);
937 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
938 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
939 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
940 extern bool ata_link_online(struct ata_link *link);
941 extern bool ata_link_offline(struct ata_link *link);
942 #ifdef CONFIG_PM
943 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
944 extern void ata_host_resume(struct ata_host *host);
945 #endif
946 extern int ata_ratelimit(void);
947 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
948 unsigned long interval, unsigned long timeout);
949 extern int atapi_cmd_type(u8 opcode);
950 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
951 u8 pmp, int is_cmd, u8 *fis);
952 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
953 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
954 unsigned long mwdma_mask, unsigned long udma_mask);
955 extern void ata_unpack_xfermask(unsigned long xfer_mask,
956 unsigned long *pio_mask, unsigned long *mwdma_mask,
957 unsigned long *udma_mask);
958 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
959 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
960 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
961 extern const char *ata_mode_string(unsigned long xfer_mask);
962 extern unsigned long ata_id_xfermask(const u16 *id);
963 extern int ata_port_start(struct ata_port *ap);
964 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
965 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
966 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
967 unsigned int n_elem);
968 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
969 extern void ata_dev_disable(struct ata_device *adev);
970 extern void ata_id_string(const u16 *id, unsigned char *s,
971 unsigned int ofs, unsigned int len);
972 extern void ata_id_c_string(const u16 *id, unsigned char *s,
973 unsigned int ofs, unsigned int len);
974 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
975 struct ata_taskfile *tf, u16 *id);
976 extern void ata_qc_complete(struct ata_queued_cmd *qc);
977 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
978 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
979 void (*done)(struct scsi_cmnd *));
980 extern int ata_std_bios_param(struct scsi_device *sdev,
981 struct block_device *bdev,
982 sector_t capacity, int geom[]);
983 extern int ata_scsi_slave_config(struct scsi_device *sdev);
984 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
985 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
986 int queue_depth);
987 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
988 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
990 extern int ata_cable_40wire(struct ata_port *ap);
991 extern int ata_cable_80wire(struct ata_port *ap);
992 extern int ata_cable_sata(struct ata_port *ap);
993 extern int ata_cable_ignore(struct ata_port *ap);
994 extern int ata_cable_unknown(struct ata_port *ap);
996 /* Timing helpers */
997 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
998 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
999 extern int ata_timing_compute(struct ata_device *, unsigned short,
1000 struct ata_timing *, int, int);
1001 extern void ata_timing_merge(const struct ata_timing *,
1002 const struct ata_timing *, struct ata_timing *,
1003 unsigned int);
1004 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1006 /* PCI */
1007 #ifdef CONFIG_PCI
1008 struct pci_dev;
1010 struct pci_bits {
1011 unsigned int reg; /* PCI config register to read */
1012 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1013 unsigned long mask;
1014 unsigned long val;
1017 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1018 extern void ata_pci_remove_one(struct pci_dev *pdev);
1020 #ifdef CONFIG_PM
1021 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1022 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1023 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1024 extern int ata_pci_device_resume(struct pci_dev *pdev);
1025 #endif /* CONFIG_PM */
1026 #endif /* CONFIG_PCI */
1029 * ACPI - drivers/ata/libata-acpi.c
1031 #ifdef CONFIG_ATA_ACPI
1032 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1034 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1035 return &ap->__acpi_init_gtm;
1036 return NULL;
1038 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1039 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1040 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1041 const struct ata_acpi_gtm *gtm);
1042 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1043 #else
1044 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1046 return NULL;
1049 static inline int ata_acpi_stm(const struct ata_port *ap,
1050 struct ata_acpi_gtm *stm)
1052 return -ENOSYS;
1055 static inline int ata_acpi_gtm(const struct ata_port *ap,
1056 struct ata_acpi_gtm *stm)
1058 return -ENOSYS;
1061 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1062 const struct ata_acpi_gtm *gtm)
1064 return 0;
1067 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1068 const struct ata_acpi_gtm *gtm)
1070 return 0;
1072 #endif
1075 * EH - drivers/ata/libata-eh.c
1077 extern void ata_port_schedule_eh(struct ata_port *ap);
1078 extern int ata_link_abort(struct ata_link *link);
1079 extern int ata_port_abort(struct ata_port *ap);
1080 extern int ata_port_freeze(struct ata_port *ap);
1081 extern int sata_async_notification(struct ata_port *ap);
1083 extern void ata_eh_freeze_port(struct ata_port *ap);
1084 extern void ata_eh_thaw_port(struct ata_port *ap);
1086 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1087 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1088 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1090 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1091 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1092 ata_postreset_fn_t postreset);
1093 extern void ata_std_error_handler(struct ata_port *ap);
1096 * Base operations to inherit from and initializers for sht
1098 * Operations
1100 * base : Common to all libata drivers.
1101 * sata : SATA controllers w/ native interface.
1102 * pmp : SATA controllers w/ PMP support.
1103 * sff : SFF ATA controllers w/o BMDMA support.
1104 * bmdma : SFF ATA controllers w/ BMDMA support.
1106 * sht initializers
1108 * BASE : Common to all libata drivers. The user must set
1109 * sg_tablesize and dma_boundary.
1110 * PIO : SFF ATA controllers w/ only PIO support.
1111 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1112 * dma_boundary are set to BMDMA limits.
1113 * NCQ : SATA controllers supporting NCQ. The user must set
1114 * sg_tablesize, dma_boundary and can_queue.
1116 extern const struct ata_port_operations ata_base_port_ops;
1117 extern const struct ata_port_operations sata_port_ops;
1118 extern struct device_attribute *ata_common_sdev_attrs[];
1120 #define ATA_BASE_SHT(drv_name) \
1121 .module = THIS_MODULE, \
1122 .name = drv_name, \
1123 .ioctl = ata_scsi_ioctl, \
1124 .queuecommand = ata_scsi_queuecmd, \
1125 .can_queue = ATA_DEF_QUEUE, \
1126 .this_id = ATA_SHT_THIS_ID, \
1127 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1128 .emulated = ATA_SHT_EMULATED, \
1129 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1130 .proc_name = drv_name, \
1131 .slave_configure = ata_scsi_slave_config, \
1132 .slave_destroy = ata_scsi_slave_destroy, \
1133 .bios_param = ata_std_bios_param, \
1134 .sdev_attrs = ata_common_sdev_attrs
1136 #define ATA_NCQ_SHT(drv_name) \
1137 ATA_BASE_SHT(drv_name), \
1138 .change_queue_depth = ata_scsi_change_queue_depth
1141 * PMP helpers
1143 #ifdef CONFIG_SATA_PMP
1144 static inline bool sata_pmp_supported(struct ata_port *ap)
1146 return ap->flags & ATA_FLAG_PMP;
1149 static inline bool sata_pmp_attached(struct ata_port *ap)
1151 return ap->nr_pmp_links != 0;
1154 static inline int ata_is_host_link(const struct ata_link *link)
1156 return link == &link->ap->link || link == link->ap->slave_link;
1158 #else /* CONFIG_SATA_PMP */
1159 static inline bool sata_pmp_supported(struct ata_port *ap)
1161 return false;
1164 static inline bool sata_pmp_attached(struct ata_port *ap)
1166 return false;
1169 static inline int ata_is_host_link(const struct ata_link *link)
1171 return 1;
1173 #endif /* CONFIG_SATA_PMP */
1175 static inline int sata_srst_pmp(struct ata_link *link)
1177 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1178 return SATA_PMP_CTRL_PORT;
1179 return link->pmp;
1183 * printk helpers
1185 #define ata_port_printk(ap, lv, fmt, args...) \
1186 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1188 #define ata_link_printk(link, lv, fmt, args...) do { \
1189 if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link) \
1190 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
1191 (link)->pmp , ##args); \
1192 else \
1193 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1194 } while(0)
1196 #define ata_dev_printk(dev, lv, fmt, args...) \
1197 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
1198 (dev)->link->pmp + (dev)->devno , ##args)
1201 * ata_eh_info helpers
1203 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1204 __attribute__ ((format (printf, 2, 3)));
1205 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1206 __attribute__ ((format (printf, 2, 3)));
1207 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1209 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1211 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1212 ehi->flags |= ATA_EHI_HOTPLUGGED;
1213 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1214 ehi->err_mask |= AC_ERR_ATA_BUS;
1218 * port description helpers
1220 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1221 __attribute__ ((format (printf, 2, 3)));
1222 #ifdef CONFIG_PCI
1223 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1224 const char *name);
1225 #endif
1227 static inline unsigned int ata_tag_valid(unsigned int tag)
1229 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1232 static inline unsigned int ata_tag_internal(unsigned int tag)
1234 return tag == ATA_TAG_INTERNAL;
1238 * device helpers
1240 static inline unsigned int ata_class_enabled(unsigned int class)
1242 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1243 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1246 static inline unsigned int ata_class_disabled(unsigned int class)
1248 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1249 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1252 static inline unsigned int ata_class_absent(unsigned int class)
1254 return !ata_class_enabled(class) && !ata_class_disabled(class);
1257 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1259 return ata_class_enabled(dev->class);
1262 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1264 return ata_class_disabled(dev->class);
1267 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1269 return ata_class_absent(dev->class);
1273 * link helpers
1275 static inline int ata_link_max_devices(const struct ata_link *link)
1277 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1278 return 2;
1279 return 1;
1282 static inline int ata_link_active(struct ata_link *link)
1284 return ata_tag_valid(link->active_tag) || link->sactive;
1287 extern struct ata_link *__ata_port_next_link(struct ata_port *ap,
1288 struct ata_link *link,
1289 bool dev_only);
1291 #define __ata_port_for_each_link(link, ap) \
1292 for ((link) = __ata_port_next_link((ap), NULL, false); (link); \
1293 (link) = __ata_port_next_link((ap), (link), false))
1295 #define ata_port_for_each_link(link, ap) \
1296 for ((link) = __ata_port_next_link((ap), NULL, true); (link); \
1297 (link) = __ata_port_next_link((ap), (link), true))
1299 #define ata_link_for_each_dev(dev, link) \
1300 for ((dev) = (link)->device; \
1301 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1302 (dev)++)
1304 #define ata_link_for_each_dev_reverse(dev, link) \
1305 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1306 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1309 * ata_ncq_enabled - Test whether NCQ is enabled
1310 * @dev: ATA device to test for
1312 * LOCKING:
1313 * spin_lock_irqsave(host lock)
1315 * RETURNS:
1316 * 1 if NCQ is enabled for @dev, 0 otherwise.
1318 static inline int ata_ncq_enabled(struct ata_device *dev)
1320 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1321 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1324 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1326 qc->tf.ctl |= ATA_NIEN;
1329 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1330 unsigned int tag)
1332 if (likely(ata_tag_valid(tag)))
1333 return &ap->qcmd[tag];
1334 return NULL;
1337 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1338 unsigned int tag)
1340 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1342 if (unlikely(!qc) || !ap->ops->error_handler)
1343 return qc;
1345 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1346 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1347 return qc;
1349 return NULL;
1352 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1354 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1357 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1359 memset(tf, 0, sizeof(*tf));
1361 tf->ctl = dev->link->ap->ctl;
1362 if (dev->devno == 0)
1363 tf->device = ATA_DEVICE_OBS;
1364 else
1365 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1368 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1370 qc->dma_dir = DMA_NONE;
1371 qc->sg = NULL;
1372 qc->flags = 0;
1373 qc->cursg = NULL;
1374 qc->cursg_ofs = 0;
1375 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1376 qc->n_elem = 0;
1377 qc->err_mask = 0;
1378 qc->sect_size = ATA_SECT_SIZE;
1380 ata_tf_init(qc->dev, &qc->tf);
1382 /* init result_tf such that it indicates normal completion */
1383 qc->result_tf.command = ATA_DRDY;
1384 qc->result_tf.feature = 0;
1387 static inline int ata_try_flush_cache(const struct ata_device *dev)
1389 return ata_id_wcache_enabled(dev->id) ||
1390 ata_id_has_flush(dev->id) ||
1391 ata_id_has_flush_ext(dev->id);
1394 static inline unsigned int ac_err_mask(u8 status)
1396 if (status & (ATA_BUSY | ATA_DRQ))
1397 return AC_ERR_HSM;
1398 if (status & (ATA_ERR | ATA_DF))
1399 return AC_ERR_DEV;
1400 return 0;
1403 static inline unsigned int __ac_err_mask(u8 status)
1405 unsigned int mask = ac_err_mask(status);
1406 if (mask == 0)
1407 return AC_ERR_OTHER;
1408 return mask;
1411 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1413 return *(struct ata_port **)&host->hostdata[0];
1416 static inline int ata_check_ready(u8 status)
1418 if (!(status & ATA_BUSY))
1419 return 1;
1421 /* 0xff indicates either no device or device not ready */
1422 if (status == 0xff)
1423 return -ENODEV;
1425 return 0;
1428 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1429 unsigned long timeout_msecs)
1431 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1434 /* Don't open code these in drivers as there are traps. Firstly the range may
1435 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1436 > UDMA_0. Dyma ddreigiau */
1438 static inline int ata_using_mwdma(struct ata_device *adev)
1440 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1441 return 1;
1442 return 0;
1445 static inline int ata_using_udma(struct ata_device *adev)
1447 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1448 return 1;
1449 return 0;
1452 static inline int ata_dma_enabled(struct ata_device *adev)
1454 return (adev->dma_mode == 0xFF ? 0 : 1);
1457 /**************************************************************************
1458 * PMP - drivers/ata/libata-pmp.c
1460 #ifdef CONFIG_SATA_PMP
1462 extern const struct ata_port_operations sata_pmp_port_ops;
1464 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1465 extern void sata_pmp_error_handler(struct ata_port *ap);
1467 #else /* CONFIG_SATA_PMP */
1469 #define sata_pmp_port_ops sata_port_ops
1470 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1471 #define sata_pmp_error_handler ata_std_error_handler
1473 #endif /* CONFIG_SATA_PMP */
1476 /**************************************************************************
1477 * SFF - drivers/ata/libata-sff.c
1479 #ifdef CONFIG_ATA_SFF
1481 extern const struct ata_port_operations ata_sff_port_ops;
1482 extern const struct ata_port_operations ata_bmdma_port_ops;
1484 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1485 #define ATA_PIO_SHT(drv_name) \
1486 ATA_BASE_SHT(drv_name), \
1487 .sg_tablesize = LIBATA_MAX_PRD, \
1488 .dma_boundary = ATA_DMA_BOUNDARY
1490 #define ATA_BMDMA_SHT(drv_name) \
1491 ATA_BASE_SHT(drv_name), \
1492 .sg_tablesize = LIBATA_MAX_PRD, \
1493 .dma_boundary = ATA_DMA_BOUNDARY
1495 extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1496 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1497 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1498 extern u8 ata_sff_check_status(struct ata_port *ap);
1499 extern void ata_sff_pause(struct ata_port *ap);
1500 extern void ata_sff_dma_pause(struct ata_port *ap);
1501 extern int ata_sff_busy_sleep(struct ata_port *ap,
1502 unsigned long timeout_pat, unsigned long timeout);
1503 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1504 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1505 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1506 extern void ata_sff_exec_command(struct ata_port *ap,
1507 const struct ata_taskfile *tf);
1508 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1509 unsigned char *buf, unsigned int buflen, int rw);
1510 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1511 unsigned char *buf, unsigned int buflen, int rw);
1512 extern u8 ata_sff_irq_on(struct ata_port *ap);
1513 extern void ata_sff_irq_clear(struct ata_port *ap);
1514 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1515 u8 status, int in_wq);
1516 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1517 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1518 extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1519 struct ata_queued_cmd *qc);
1520 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1521 extern void ata_sff_freeze(struct ata_port *ap);
1522 extern void ata_sff_thaw(struct ata_port *ap);
1523 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1524 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1525 u8 *r_err);
1526 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1527 unsigned long deadline);
1528 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1529 unsigned long deadline);
1530 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1531 unsigned long deadline);
1532 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1533 extern void ata_sff_error_handler(struct ata_port *ap);
1534 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1535 extern int ata_sff_port_start(struct ata_port *ap);
1536 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1537 extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1538 unsigned long xfer_mask);
1539 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1540 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1541 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1542 extern u8 ata_bmdma_status(struct ata_port *ap);
1543 extern void ata_bus_reset(struct ata_port *ap);
1545 #ifdef CONFIG_PCI
1546 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1547 extern int ata_pci_bmdma_init(struct ata_host *host);
1548 extern int ata_pci_sff_init_host(struct ata_host *host);
1549 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1550 const struct ata_port_info * const * ppi,
1551 struct ata_host **r_host);
1552 extern int ata_pci_sff_activate_host(struct ata_host *host,
1553 irq_handler_t irq_handler,
1554 struct scsi_host_template *sht);
1555 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1556 const struct ata_port_info * const * ppi,
1557 struct scsi_host_template *sht, void *host_priv);
1558 #endif /* CONFIG_PCI */
1561 * ata_sff_busy_wait - Wait for a port status register
1562 * @ap: Port to wait for.
1563 * @bits: bits that must be clear
1564 * @max: number of 10uS waits to perform
1566 * Waits up to max*10 microseconds for the selected bits in the port's
1567 * status register to be cleared.
1568 * Returns final value of status register.
1570 * LOCKING:
1571 * Inherited from caller.
1573 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1574 unsigned int max)
1576 u8 status;
1578 do {
1579 udelay(10);
1580 status = ap->ops->sff_check_status(ap);
1581 max--;
1582 } while (status != 0xff && (status & bits) && (max > 0));
1584 return status;
1588 * ata_wait_idle - Wait for a port to be idle.
1589 * @ap: Port to wait for.
1591 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1592 * Returns final value of status register.
1594 * LOCKING:
1595 * Inherited from caller.
1597 static inline u8 ata_wait_idle(struct ata_port *ap)
1599 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1601 #ifdef ATA_DEBUG
1602 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1603 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1604 status);
1605 #endif
1607 return status;
1609 #endif /* CONFIG_ATA_SFF */
1611 #endif /* __LINUX_LIBATA_H__ */