MERGE-master-patchset-edits
[linux-2.6/openmoko-kernel.git] / include / linux / libata.h
blob2c6bd66209ff6a076464b206662d7a6cf7730adb
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_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
217 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
218 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
219 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
220 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
222 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
223 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
224 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
226 /* struct ata_queued_cmd flags */
227 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
228 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
229 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
230 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
231 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
232 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
233 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
235 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
236 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
237 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
239 /* host set flags */
240 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
241 ATA_HOST_STARTED = (1 << 1), /* Host started */
242 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
244 /* bits 24:31 of host->flags are reserved for LLD specific flags */
246 /* various lengths of time */
247 ATA_TMOUT_BOOT = 30000, /* heuristic */
248 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
249 ATA_TMOUT_INTERNAL_QUICK = 5000,
250 ATA_TMOUT_MAX_PARK = 30000,
252 /* FIXME: GoVault needs 2s but we can't afford that without
253 * parallel probing. 800ms is enough for iVDR disk
254 * HHD424020F7SV00. Increase to 2secs when parallel probing
255 * is in place.
257 ATA_TMOUT_FF_WAIT = 800,
259 /* Spec mandates to wait for ">= 2ms" before checking status
260 * after reset. We wait 150ms, because that was the magic
261 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
262 * the period of time between when the ATA command register is
263 * written, and then status is checked. Because waiting for
264 * "a while" before checking status is fine, post SRST, we
265 * perform this magic delay here as well.
267 * Old drivers/ide uses the 2mS rule and then waits for ready.
269 ATA_WAIT_AFTER_RESET = 150,
271 /* If PMP is supported, we have to do follow-up SRST. As some
272 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
273 * advised to wait only for the following duration before
274 * doing SRST.
276 ATA_TMOUT_PMP_SRST_WAIT = 1000,
278 /* ATA bus states */
279 BUS_UNKNOWN = 0,
280 BUS_DMA = 1,
281 BUS_IDLE = 2,
282 BUS_NOINTR = 3,
283 BUS_NODATA = 4,
284 BUS_TIMER = 5,
285 BUS_PIO = 6,
286 BUS_EDD = 7,
287 BUS_IDENTIFY = 8,
288 BUS_PACKET = 9,
290 /* SATA port states */
291 PORT_UNKNOWN = 0,
292 PORT_ENABLED = 1,
293 PORT_DISABLED = 2,
295 /* encoding various smaller bitmaps into a single
296 * unsigned long bitmap
298 ATA_NR_PIO_MODES = 7,
299 ATA_NR_MWDMA_MODES = 5,
300 ATA_NR_UDMA_MODES = 8,
302 ATA_SHIFT_PIO = 0,
303 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
304 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
306 /* size of buffer to pad xfers ending on unaligned boundaries */
307 ATA_DMA_PAD_SZ = 4,
309 /* ering size */
310 ATA_ERING_SIZE = 32,
312 /* return values for ->qc_defer */
313 ATA_DEFER_LINK = 1,
314 ATA_DEFER_PORT = 2,
316 /* desc_len for ata_eh_info and context */
317 ATA_EH_DESC_LEN = 80,
319 /* reset / recovery action types */
320 ATA_EH_REVALIDATE = (1 << 0),
321 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
322 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
323 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
324 ATA_EH_ENABLE_LINK = (1 << 3),
325 ATA_EH_LPM = (1 << 4), /* link power management action */
326 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
328 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
329 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
330 ATA_EH_ENABLE_LINK | ATA_EH_LPM,
332 /* ata_eh_info->flags */
333 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
334 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
335 ATA_EHI_QUIET = (1 << 3), /* be quiet */
337 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
338 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
339 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
340 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
341 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
343 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
345 /* mask of flags to transfer *to* the slave link */
346 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
348 /* max tries if error condition is still set after ->error_handler */
349 ATA_EH_MAX_TRIES = 5,
351 /* how hard are we gonna try to probe/recover devices */
352 ATA_PROBE_MAX_TRIES = 3,
353 ATA_EH_DEV_TRIES = 3,
354 ATA_EH_PMP_TRIES = 5,
355 ATA_EH_PMP_LINK_TRIES = 3,
357 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
359 /* This should match the actual table size of
360 * ata_eh_cmd_timeout_table in libata-eh.c.
362 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5,
364 /* Horkage types. May be set by libata or controller on drives
365 (some horkage may be drive/controller pair dependant */
367 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
368 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
369 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
370 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
371 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
372 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
373 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
374 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
375 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
376 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
377 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
378 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
379 not multiple of 16 bytes */
380 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firwmare update warning */
382 /* DMA mask for user DMA control: User visible values; DO NOT
383 renumber */
384 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
385 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
386 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
388 /* ATAPI command types */
389 ATAPI_READ = 0, /* READs */
390 ATAPI_WRITE = 1, /* WRITEs */
391 ATAPI_READ_CD = 2, /* READ CD [MSF] */
392 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
393 ATAPI_MISC = 4, /* the rest */
395 /* Timing constants */
396 ATA_TIMING_SETUP = (1 << 0),
397 ATA_TIMING_ACT8B = (1 << 1),
398 ATA_TIMING_REC8B = (1 << 2),
399 ATA_TIMING_CYC8B = (1 << 3),
400 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
401 ATA_TIMING_CYC8B,
402 ATA_TIMING_ACTIVE = (1 << 4),
403 ATA_TIMING_RECOVER = (1 << 5),
404 ATA_TIMING_DMACK_HOLD = (1 << 6),
405 ATA_TIMING_CYCLE = (1 << 7),
406 ATA_TIMING_UDMA = (1 << 8),
407 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
408 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
409 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
410 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
411 ATA_TIMING_UDMA,
414 enum ata_xfer_mask {
415 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
416 << ATA_SHIFT_PIO,
417 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
418 << ATA_SHIFT_MWDMA,
419 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
420 << ATA_SHIFT_UDMA,
423 enum hsm_task_states {
424 HSM_ST_IDLE, /* no command on going */
425 HSM_ST_FIRST, /* (waiting the device to)
426 write CDB or first data block */
427 HSM_ST, /* (waiting the device to) transfer data */
428 HSM_ST_LAST, /* (waiting the device to) complete command */
429 HSM_ST_ERR, /* error */
432 enum ata_completion_errors {
433 AC_ERR_DEV = (1 << 0), /* device reported error */
434 AC_ERR_HSM = (1 << 1), /* host state machine violation */
435 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
436 AC_ERR_MEDIA = (1 << 3), /* media error */
437 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
438 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
439 AC_ERR_SYSTEM = (1 << 6), /* system error */
440 AC_ERR_INVALID = (1 << 7), /* invalid argument */
441 AC_ERR_OTHER = (1 << 8), /* unknown */
442 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
443 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
446 /* forward declarations */
447 struct scsi_device;
448 struct ata_port_operations;
449 struct ata_port;
450 struct ata_link;
451 struct ata_queued_cmd;
453 /* typedefs */
454 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
455 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
456 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
457 unsigned long deadline);
458 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
461 * host pm policy: If you alter this, you also need to alter libata-scsi.c
462 * (for the ascii descriptions)
464 enum link_pm {
465 NOT_AVAILABLE,
466 MIN_POWER,
467 MAX_PERFORMANCE,
468 MEDIUM_POWER,
470 extern struct device_attribute dev_attr_link_power_management_policy;
471 extern struct device_attribute dev_attr_unload_heads;
472 extern struct device_attribute dev_attr_em_message_type;
473 extern struct device_attribute dev_attr_em_message;
474 extern struct device_attribute dev_attr_sw_activity;
476 enum sw_activity {
477 OFF,
478 BLINK_ON,
479 BLINK_OFF,
482 #ifdef CONFIG_ATA_SFF
483 struct ata_ioports {
484 void __iomem *cmd_addr;
485 void __iomem *data_addr;
486 void __iomem *error_addr;
487 void __iomem *feature_addr;
488 void __iomem *nsect_addr;
489 void __iomem *lbal_addr;
490 void __iomem *lbam_addr;
491 void __iomem *lbah_addr;
492 void __iomem *device_addr;
493 void __iomem *status_addr;
494 void __iomem *command_addr;
495 void __iomem *altstatus_addr;
496 void __iomem *ctl_addr;
497 void __iomem *bmdma_addr;
498 void __iomem *scr_addr;
500 #endif /* CONFIG_ATA_SFF */
502 struct ata_host {
503 spinlock_t lock;
504 struct device *dev;
505 void __iomem * const *iomap;
506 unsigned int n_ports;
507 void *private_data;
508 struct ata_port_operations *ops;
509 unsigned long flags;
510 #ifdef CONFIG_ATA_ACPI
511 acpi_handle acpi_handle;
512 #endif
513 struct ata_port *simplex_claimed; /* channel owning the DMA */
514 struct ata_port *ports[0];
517 struct ata_queued_cmd {
518 struct ata_port *ap;
519 struct ata_device *dev;
521 struct scsi_cmnd *scsicmd;
522 void (*scsidone)(struct scsi_cmnd *);
524 struct ata_taskfile tf;
525 u8 cdb[ATAPI_CDB_LEN];
527 unsigned long flags; /* ATA_QCFLAG_xxx */
528 unsigned int tag;
529 unsigned int n_elem;
531 int dma_dir;
533 unsigned int sect_size;
535 unsigned int nbytes;
536 unsigned int extrabytes;
537 unsigned int curbytes;
539 struct scatterlist *cursg;
540 unsigned int cursg_ofs;
542 struct scatterlist sgent;
544 struct scatterlist *sg;
546 unsigned int err_mask;
547 struct ata_taskfile result_tf;
548 ata_qc_cb_t complete_fn;
550 void *private_data;
551 void *lldd_task;
554 struct ata_port_stats {
555 unsigned long unhandled_irq;
556 unsigned long idle_irq;
557 unsigned long rw_reqbuf;
560 struct ata_ering_entry {
561 unsigned int eflags;
562 unsigned int err_mask;
563 u64 timestamp;
566 struct ata_ering {
567 int cursor;
568 struct ata_ering_entry ring[ATA_ERING_SIZE];
571 struct ata_device {
572 struct ata_link *link;
573 unsigned int devno; /* 0 or 1 */
574 unsigned int horkage; /* List of broken features */
575 unsigned long flags; /* ATA_DFLAG_xxx */
576 struct scsi_device *sdev; /* attached SCSI device */
577 #ifdef CONFIG_ATA_ACPI
578 acpi_handle acpi_handle;
579 union acpi_object *gtf_cache;
580 #endif
581 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
582 u64 n_sectors; /* size of device, if ATA */
583 unsigned int class; /* ATA_DEV_xxx */
584 unsigned long unpark_deadline;
586 u8 pio_mode;
587 u8 dma_mode;
588 u8 xfer_mode;
589 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
591 unsigned int multi_count; /* sectors count for
592 READ/WRITE MULTIPLE */
593 unsigned int max_sectors; /* per-device max sectors */
594 unsigned int cdb_len;
596 /* per-dev xfer mask */
597 unsigned long pio_mask;
598 unsigned long mwdma_mask;
599 unsigned long udma_mask;
601 /* for CHS addressing */
602 u16 cylinders; /* Number of cylinders */
603 u16 heads; /* Number of heads */
604 u16 sectors; /* Number of sectors per track */
606 /* error history */
607 int spdn_cnt;
608 struct ata_ering ering;
610 union {
611 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
612 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
616 /* Offset into struct ata_device. Fields above it are maintained
617 * acress device init. Fields below are zeroed.
619 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
621 struct ata_eh_info {
622 struct ata_device *dev; /* offending device */
623 u32 serror; /* SError from LLDD */
624 unsigned int err_mask; /* port-wide err_mask */
625 unsigned int action; /* ATA_EH_* action mask */
626 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
627 unsigned int flags; /* ATA_EHI_* flags */
629 unsigned int probe_mask;
631 char desc[ATA_EH_DESC_LEN];
632 int desc_len;
635 struct ata_eh_context {
636 struct ata_eh_info i;
637 int tries[ATA_MAX_DEVICES];
638 int cmd_timeout_idx[ATA_MAX_DEVICES]
639 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
640 unsigned int classes[ATA_MAX_DEVICES];
641 unsigned int did_probe_mask;
642 unsigned int unloaded_mask;
643 unsigned int saved_ncq_enabled;
644 u8 saved_xfer_mode[ATA_MAX_DEVICES];
645 /* timestamp for the last reset attempt or success */
646 unsigned long last_reset;
649 struct ata_acpi_drive
651 u32 pio;
652 u32 dma;
653 } __packed;
655 struct ata_acpi_gtm {
656 struct ata_acpi_drive drive[2];
657 u32 flags;
658 } __packed;
660 struct ata_link {
661 struct ata_port *ap;
662 int pmp; /* port multiplier port # */
664 unsigned int active_tag; /* active tag on this link */
665 u32 sactive; /* active NCQ commands */
667 unsigned int flags; /* ATA_LFLAG_xxx */
669 u32 saved_scontrol; /* SControl on probe */
670 unsigned int hw_sata_spd_limit;
671 unsigned int sata_spd_limit;
672 unsigned int sata_spd; /* current SATA PHY speed */
674 /* record runtime error info, protected by host_set lock */
675 struct ata_eh_info eh_info;
676 /* EH context */
677 struct ata_eh_context eh_context;
679 struct ata_device device[ATA_MAX_DEVICES];
682 struct ata_port {
683 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
684 struct ata_port_operations *ops;
685 spinlock_t *lock;
686 unsigned long flags; /* ATA_FLAG_xxx */
687 unsigned int pflags; /* ATA_PFLAG_xxx */
688 unsigned int print_id; /* user visible unique port ID */
689 unsigned int port_no; /* 0 based port no. inside the host */
691 struct ata_prd *prd; /* our SG list */
692 dma_addr_t prd_dma; /* and its DMA mapping */
694 #ifdef CONFIG_ATA_SFF
695 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
696 #endif /* CONFIG_ATA_SFF */
698 u8 ctl; /* cache of ATA control register */
699 u8 last_ctl; /* Cache last written value */
700 unsigned int pio_mask;
701 unsigned int mwdma_mask;
702 unsigned int udma_mask;
703 unsigned int cbl; /* cable type; ATA_CBL_xxx */
705 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
706 unsigned long qc_allocated;
707 unsigned int qc_active;
708 int nr_active_links; /* #links with active qcs */
710 struct ata_link link; /* host default link */
711 struct ata_link *slave_link; /* see ata_slave_link_init() */
713 int nr_pmp_links; /* nr of available PMP links */
714 struct ata_link *pmp_link; /* array of PMP links */
715 struct ata_link *excl_link; /* for PMP qc exclusion */
717 struct ata_port_stats stats;
718 struct ata_host *host;
719 struct device *dev;
721 void *port_task_data;
722 struct delayed_work port_task;
723 struct delayed_work hotplug_task;
724 struct work_struct scsi_rescan_task;
726 unsigned int hsm_task_state;
728 u32 msg_enable;
729 struct list_head eh_done_q;
730 wait_queue_head_t eh_wait_q;
731 int eh_tries;
732 struct completion park_req_pending;
734 pm_message_t pm_mesg;
735 int *pm_result;
736 enum link_pm pm_policy;
738 struct timer_list fastdrain_timer;
739 unsigned long fastdrain_cnt;
741 int em_message_type;
742 void *private_data;
744 #ifdef CONFIG_ATA_ACPI
745 acpi_handle acpi_handle;
746 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
747 #endif
748 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
751 /* The following initializer overrides a method to NULL whether one of
752 * its parent has the method defined or not. This is equivalent to
753 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
754 * expression and thus can't be used as an initializer.
756 #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
758 struct ata_port_operations {
760 * Command execution
762 int (*qc_defer)(struct ata_queued_cmd *qc);
763 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
764 void (*qc_prep)(struct ata_queued_cmd *qc);
765 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
766 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
769 * Configuration and exception handling
771 int (*cable_detect)(struct ata_port *ap);
772 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
773 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
774 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
775 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
776 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
778 void (*dev_config)(struct ata_device *dev);
780 void (*freeze)(struct ata_port *ap);
781 void (*thaw)(struct ata_port *ap);
782 ata_prereset_fn_t prereset;
783 ata_reset_fn_t softreset;
784 ata_reset_fn_t hardreset;
785 ata_postreset_fn_t postreset;
786 ata_prereset_fn_t pmp_prereset;
787 ata_reset_fn_t pmp_softreset;
788 ata_reset_fn_t pmp_hardreset;
789 ata_postreset_fn_t pmp_postreset;
790 void (*error_handler)(struct ata_port *ap);
791 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
794 * Optional features
796 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
797 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
798 void (*pmp_attach)(struct ata_port *ap);
799 void (*pmp_detach)(struct ata_port *ap);
800 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
801 void (*disable_pm)(struct ata_port *ap);
804 * Start, stop, suspend and resume
806 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
807 int (*port_resume)(struct ata_port *ap);
808 int (*port_start)(struct ata_port *ap);
809 void (*port_stop)(struct ata_port *ap);
810 void (*host_stop)(struct ata_host *host);
812 #ifdef CONFIG_ATA_SFF
814 * SFF / taskfile oriented ops
816 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
817 u8 (*sff_check_status)(struct ata_port *ap);
818 u8 (*sff_check_altstatus)(struct ata_port *ap);
819 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
820 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
821 void (*sff_exec_command)(struct ata_port *ap,
822 const struct ata_taskfile *tf);
823 unsigned int (*sff_data_xfer)(struct ata_device *dev,
824 unsigned char *buf, unsigned int buflen, int rw);
825 u8 (*sff_irq_on)(struct ata_port *);
826 void (*sff_irq_clear)(struct ata_port *);
828 void (*bmdma_setup)(struct ata_queued_cmd *qc);
829 void (*bmdma_start)(struct ata_queued_cmd *qc);
830 void (*bmdma_stop)(struct ata_queued_cmd *qc);
831 u8 (*bmdma_status)(struct ata_port *ap);
832 #endif /* CONFIG_ATA_SFF */
834 ssize_t (*em_show)(struct ata_port *ap, char *buf);
835 ssize_t (*em_store)(struct ata_port *ap, const char *message,
836 size_t size);
837 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
838 ssize_t (*sw_activity_store)(struct ata_device *dev,
839 enum sw_activity val);
841 * Obsolete
843 void (*phy_reset)(struct ata_port *ap);
844 void (*eng_timeout)(struct ata_port *ap);
847 * ->inherits must be the last field and all the preceding
848 * fields must be pointers.
850 const struct ata_port_operations *inherits;
853 struct ata_port_info {
854 unsigned long flags;
855 unsigned long link_flags;
856 unsigned long pio_mask;
857 unsigned long mwdma_mask;
858 unsigned long udma_mask;
859 struct ata_port_operations *port_ops;
860 void *private_data;
863 struct ata_timing {
864 unsigned short mode; /* ATA mode */
865 unsigned short setup; /* t1 */
866 unsigned short act8b; /* t2 for 8-bit I/O */
867 unsigned short rec8b; /* t2i for 8-bit I/O */
868 unsigned short cyc8b; /* t0 for 8-bit I/O */
869 unsigned short active; /* t2 or tD */
870 unsigned short recover; /* t2i or tK */
871 unsigned short dmack_hold; /* tj */
872 unsigned short cycle; /* t0 */
873 unsigned short udma; /* t2CYCTYP/2 */
877 * Core layer - drivers/ata/libata-core.c
879 extern const unsigned long sata_deb_timing_normal[];
880 extern const unsigned long sata_deb_timing_hotplug[];
881 extern const unsigned long sata_deb_timing_long[];
883 extern struct ata_port_operations ata_dummy_port_ops;
884 extern const struct ata_port_info ata_dummy_port_info;
886 static inline const unsigned long *
887 sata_ehc_deb_timing(struct ata_eh_context *ehc)
889 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
890 return sata_deb_timing_hotplug;
891 else
892 return sata_deb_timing_normal;
895 static inline int ata_port_is_dummy(struct ata_port *ap)
897 return ap->ops == &ata_dummy_port_ops;
900 extern void ata_port_probe(struct ata_port *);
901 extern int sata_set_spd(struct ata_link *link);
902 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
903 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
904 int (*check_ready)(struct ata_link *link));
905 extern int sata_link_debounce(struct ata_link *link,
906 const unsigned long *params, unsigned long deadline);
907 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
908 unsigned long deadline);
909 extern int sata_link_hardreset(struct ata_link *link,
910 const unsigned long *timing, unsigned long deadline,
911 bool *online, int (*check_ready)(struct ata_link *));
912 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
913 unsigned long deadline);
914 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
915 extern void ata_port_disable(struct ata_port *);
917 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
918 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
919 const struct ata_port_info * const * ppi, int n_ports);
920 extern int ata_slave_link_init(struct ata_port *ap);
921 extern int ata_host_start(struct ata_host *host);
922 extern int ata_host_register(struct ata_host *host,
923 struct scsi_host_template *sht);
924 extern int ata_host_activate(struct ata_host *host, int irq,
925 irq_handler_t irq_handler, unsigned long irq_flags,
926 struct scsi_host_template *sht);
927 extern void ata_host_detach(struct ata_host *host);
928 extern void ata_host_init(struct ata_host *, struct device *,
929 unsigned long, struct ata_port_operations *);
930 extern int ata_scsi_detect(struct scsi_host_template *sht);
931 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
932 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
933 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
934 int cmd, void __user *arg);
935 extern void ata_sas_port_destroy(struct ata_port *);
936 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
937 struct ata_port_info *, struct Scsi_Host *);
938 extern int ata_sas_port_init(struct ata_port *);
939 extern int ata_sas_port_start(struct ata_port *ap);
940 extern void ata_sas_port_stop(struct ata_port *ap);
941 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
942 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
943 struct ata_port *ap);
944 extern int sata_scr_valid(struct ata_link *link);
945 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
946 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
947 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
948 extern bool ata_link_online(struct ata_link *link);
949 extern bool ata_link_offline(struct ata_link *link);
950 #ifdef CONFIG_PM
951 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
952 extern void ata_host_resume(struct ata_host *host);
953 #endif
954 extern int ata_ratelimit(void);
955 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
956 unsigned long interval, unsigned long timeout);
957 extern int atapi_cmd_type(u8 opcode);
958 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
959 u8 pmp, int is_cmd, u8 *fis);
960 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
961 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
962 unsigned long mwdma_mask, unsigned long udma_mask);
963 extern void ata_unpack_xfermask(unsigned long xfer_mask,
964 unsigned long *pio_mask, unsigned long *mwdma_mask,
965 unsigned long *udma_mask);
966 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
967 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
968 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
969 extern const char *ata_mode_string(unsigned long xfer_mask);
970 extern unsigned long ata_id_xfermask(const u16 *id);
971 extern int ata_port_start(struct ata_port *ap);
972 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
973 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
974 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
975 unsigned int n_elem);
976 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
977 extern void ata_dev_disable(struct ata_device *adev);
978 extern void ata_id_string(const u16 *id, unsigned char *s,
979 unsigned int ofs, unsigned int len);
980 extern void ata_id_c_string(const u16 *id, unsigned char *s,
981 unsigned int ofs, unsigned int len);
982 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
983 struct ata_taskfile *tf, u16 *id);
984 extern void ata_qc_complete(struct ata_queued_cmd *qc);
985 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
986 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
987 void (*done)(struct scsi_cmnd *));
988 extern int ata_std_bios_param(struct scsi_device *sdev,
989 struct block_device *bdev,
990 sector_t capacity, int geom[]);
991 extern int ata_scsi_slave_config(struct scsi_device *sdev);
992 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
993 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
994 int queue_depth);
995 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
996 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
998 extern int ata_cable_40wire(struct ata_port *ap);
999 extern int ata_cable_80wire(struct ata_port *ap);
1000 extern int ata_cable_sata(struct ata_port *ap);
1001 extern int ata_cable_ignore(struct ata_port *ap);
1002 extern int ata_cable_unknown(struct ata_port *ap);
1004 /* Timing helpers */
1005 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1006 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1007 extern int ata_timing_compute(struct ata_device *, unsigned short,
1008 struct ata_timing *, int, int);
1009 extern void ata_timing_merge(const struct ata_timing *,
1010 const struct ata_timing *, struct ata_timing *,
1011 unsigned int);
1012 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1014 /* PCI */
1015 #ifdef CONFIG_PCI
1016 struct pci_dev;
1018 struct pci_bits {
1019 unsigned int reg; /* PCI config register to read */
1020 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1021 unsigned long mask;
1022 unsigned long val;
1025 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1026 extern void ata_pci_remove_one(struct pci_dev *pdev);
1028 #ifdef CONFIG_PM
1029 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1030 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1031 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1032 extern int ata_pci_device_resume(struct pci_dev *pdev);
1033 #endif /* CONFIG_PM */
1034 #endif /* CONFIG_PCI */
1037 * ACPI - drivers/ata/libata-acpi.c
1039 #ifdef CONFIG_ATA_ACPI
1040 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1042 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1043 return &ap->__acpi_init_gtm;
1044 return NULL;
1046 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1047 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1048 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1049 const struct ata_acpi_gtm *gtm);
1050 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1051 #else
1052 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1054 return NULL;
1057 static inline int ata_acpi_stm(const struct ata_port *ap,
1058 struct ata_acpi_gtm *stm)
1060 return -ENOSYS;
1063 static inline int ata_acpi_gtm(const struct ata_port *ap,
1064 struct ata_acpi_gtm *stm)
1066 return -ENOSYS;
1069 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1070 const struct ata_acpi_gtm *gtm)
1072 return 0;
1075 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1076 const struct ata_acpi_gtm *gtm)
1078 return 0;
1080 #endif
1083 * EH - drivers/ata/libata-eh.c
1085 extern void ata_port_schedule_eh(struct ata_port *ap);
1086 extern int ata_link_abort(struct ata_link *link);
1087 extern int ata_port_abort(struct ata_port *ap);
1088 extern int ata_port_freeze(struct ata_port *ap);
1089 extern int sata_async_notification(struct ata_port *ap);
1091 extern void ata_eh_freeze_port(struct ata_port *ap);
1092 extern void ata_eh_thaw_port(struct ata_port *ap);
1094 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1095 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1096 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1098 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1099 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1100 ata_postreset_fn_t postreset);
1101 extern void ata_std_error_handler(struct ata_port *ap);
1104 * Base operations to inherit from and initializers for sht
1106 * Operations
1108 * base : Common to all libata drivers.
1109 * sata : SATA controllers w/ native interface.
1110 * pmp : SATA controllers w/ PMP support.
1111 * sff : SFF ATA controllers w/o BMDMA support.
1112 * bmdma : SFF ATA controllers w/ BMDMA support.
1114 * sht initializers
1116 * BASE : Common to all libata drivers. The user must set
1117 * sg_tablesize and dma_boundary.
1118 * PIO : SFF ATA controllers w/ only PIO support.
1119 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1120 * dma_boundary are set to BMDMA limits.
1121 * NCQ : SATA controllers supporting NCQ. The user must set
1122 * sg_tablesize, dma_boundary and can_queue.
1124 extern const struct ata_port_operations ata_base_port_ops;
1125 extern const struct ata_port_operations sata_port_ops;
1126 extern struct device_attribute *ata_common_sdev_attrs[];
1128 #define ATA_BASE_SHT(drv_name) \
1129 .module = THIS_MODULE, \
1130 .name = drv_name, \
1131 .ioctl = ata_scsi_ioctl, \
1132 .queuecommand = ata_scsi_queuecmd, \
1133 .can_queue = ATA_DEF_QUEUE, \
1134 .this_id = ATA_SHT_THIS_ID, \
1135 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1136 .emulated = ATA_SHT_EMULATED, \
1137 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1138 .proc_name = drv_name, \
1139 .slave_configure = ata_scsi_slave_config, \
1140 .slave_destroy = ata_scsi_slave_destroy, \
1141 .bios_param = ata_std_bios_param, \
1142 .sdev_attrs = ata_common_sdev_attrs
1144 #define ATA_NCQ_SHT(drv_name) \
1145 ATA_BASE_SHT(drv_name), \
1146 .change_queue_depth = ata_scsi_change_queue_depth
1149 * PMP helpers
1151 #ifdef CONFIG_SATA_PMP
1152 static inline bool sata_pmp_supported(struct ata_port *ap)
1154 return ap->flags & ATA_FLAG_PMP;
1157 static inline bool sata_pmp_attached(struct ata_port *ap)
1159 return ap->nr_pmp_links != 0;
1162 static inline int ata_is_host_link(const struct ata_link *link)
1164 return link == &link->ap->link || link == link->ap->slave_link;
1166 #else /* CONFIG_SATA_PMP */
1167 static inline bool sata_pmp_supported(struct ata_port *ap)
1169 return false;
1172 static inline bool sata_pmp_attached(struct ata_port *ap)
1174 return false;
1177 static inline int ata_is_host_link(const struct ata_link *link)
1179 return 1;
1181 #endif /* CONFIG_SATA_PMP */
1183 static inline int sata_srst_pmp(struct ata_link *link)
1185 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1186 return SATA_PMP_CTRL_PORT;
1187 return link->pmp;
1191 * printk helpers
1193 #define ata_port_printk(ap, lv, fmt, args...) \
1194 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1196 #define ata_link_printk(link, lv, fmt, args...) do { \
1197 if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link) \
1198 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
1199 (link)->pmp , ##args); \
1200 else \
1201 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1202 } while(0)
1204 #define ata_dev_printk(dev, lv, fmt, args...) \
1205 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
1206 (dev)->link->pmp + (dev)->devno , ##args)
1209 * ata_eh_info helpers
1211 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1212 __attribute__ ((format (printf, 2, 3)));
1213 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1214 __attribute__ ((format (printf, 2, 3)));
1215 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1217 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1219 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1220 ehi->flags |= ATA_EHI_HOTPLUGGED;
1221 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1222 ehi->err_mask |= AC_ERR_ATA_BUS;
1226 * port description helpers
1228 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1229 __attribute__ ((format (printf, 2, 3)));
1230 #ifdef CONFIG_PCI
1231 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1232 const char *name);
1233 #endif
1235 static inline unsigned int ata_tag_valid(unsigned int tag)
1237 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1240 static inline unsigned int ata_tag_internal(unsigned int tag)
1242 return tag == ATA_TAG_INTERNAL;
1246 * device helpers
1248 static inline unsigned int ata_class_enabled(unsigned int class)
1250 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1251 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1254 static inline unsigned int ata_class_disabled(unsigned int class)
1256 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1257 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1260 static inline unsigned int ata_class_absent(unsigned int class)
1262 return !ata_class_enabled(class) && !ata_class_disabled(class);
1265 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1267 return ata_class_enabled(dev->class);
1270 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1272 return ata_class_disabled(dev->class);
1275 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1277 return ata_class_absent(dev->class);
1281 * link helpers
1283 static inline int ata_link_max_devices(const struct ata_link *link)
1285 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1286 return 2;
1287 return 1;
1290 static inline int ata_link_active(struct ata_link *link)
1292 return ata_tag_valid(link->active_tag) || link->sactive;
1296 * Iterators
1298 * ATA_LITER_* constants are used to select link iteration mode and
1299 * ATA_DITER_* device iteration mode.
1301 * For a custom iteration directly using ata_{link|dev}_next(), if
1302 * @link or @dev, respectively, is NULL, the first element is
1303 * returned. @dev and @link can be any valid device or link and the
1304 * next element according to the iteration mode will be returned.
1305 * After the last element, NULL is returned.
1307 enum ata_link_iter_mode {
1308 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1309 * host link. no slave link */
1310 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1311 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1312 * slave link still comes after host link */
1315 enum ata_dev_iter_mode {
1316 ATA_DITER_ENABLED,
1317 ATA_DITER_ENABLED_REVERSE,
1318 ATA_DITER_ALL,
1319 ATA_DITER_ALL_REVERSE,
1322 extern struct ata_link *ata_link_next(struct ata_link *link,
1323 struct ata_port *ap,
1324 enum ata_link_iter_mode mode);
1326 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1327 struct ata_link *link,
1328 enum ata_dev_iter_mode mode);
1331 * Shortcut notation for iterations
1333 * ata_for_each_link() iterates over each link of @ap according to
1334 * @mode. @link points to the current link in the loop. @link is
1335 * NULL after loop termination. ata_for_each_dev() works the same way
1336 * except that it iterates over each device of @link.
1338 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1339 * specified when using the following shorthand notations. Only the
1340 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1341 * specified. This not only increases brevity but also makes it
1342 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1344 #define ata_for_each_link(link, ap, mode) \
1345 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1346 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1348 #define ata_for_each_dev(dev, link, mode) \
1349 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1350 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1353 * ata_ncq_enabled - Test whether NCQ is enabled
1354 * @dev: ATA device to test for
1356 * LOCKING:
1357 * spin_lock_irqsave(host lock)
1359 * RETURNS:
1360 * 1 if NCQ is enabled for @dev, 0 otherwise.
1362 static inline int ata_ncq_enabled(struct ata_device *dev)
1364 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1365 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1368 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1370 qc->tf.ctl |= ATA_NIEN;
1373 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1374 unsigned int tag)
1376 if (likely(ata_tag_valid(tag)))
1377 return &ap->qcmd[tag];
1378 return NULL;
1381 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1382 unsigned int tag)
1384 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1386 if (unlikely(!qc) || !ap->ops->error_handler)
1387 return qc;
1389 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1390 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1391 return qc;
1393 return NULL;
1396 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1398 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1401 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1403 memset(tf, 0, sizeof(*tf));
1405 tf->ctl = dev->link->ap->ctl;
1406 if (dev->devno == 0)
1407 tf->device = ATA_DEVICE_OBS;
1408 else
1409 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1412 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1414 qc->dma_dir = DMA_NONE;
1415 qc->sg = NULL;
1416 qc->flags = 0;
1417 qc->cursg = NULL;
1418 qc->cursg_ofs = 0;
1419 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1420 qc->n_elem = 0;
1421 qc->err_mask = 0;
1422 qc->sect_size = ATA_SECT_SIZE;
1424 ata_tf_init(qc->dev, &qc->tf);
1426 /* init result_tf such that it indicates normal completion */
1427 qc->result_tf.command = ATA_DRDY;
1428 qc->result_tf.feature = 0;
1431 static inline int ata_try_flush_cache(const struct ata_device *dev)
1433 return ata_id_wcache_enabled(dev->id) ||
1434 ata_id_has_flush(dev->id) ||
1435 ata_id_has_flush_ext(dev->id);
1438 static inline unsigned int ac_err_mask(u8 status)
1440 if (status & (ATA_BUSY | ATA_DRQ))
1441 return AC_ERR_HSM;
1442 if (status & (ATA_ERR | ATA_DF))
1443 return AC_ERR_DEV;
1444 return 0;
1447 static inline unsigned int __ac_err_mask(u8 status)
1449 unsigned int mask = ac_err_mask(status);
1450 if (mask == 0)
1451 return AC_ERR_OTHER;
1452 return mask;
1455 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1457 return *(struct ata_port **)&host->hostdata[0];
1460 static inline int ata_check_ready(u8 status)
1462 if (!(status & ATA_BUSY))
1463 return 1;
1465 /* 0xff indicates either no device or device not ready */
1466 if (status == 0xff)
1467 return -ENODEV;
1469 return 0;
1472 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1473 unsigned long timeout_msecs)
1475 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1478 /* Don't open code these in drivers as there are traps. Firstly the range may
1479 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1480 > UDMA_0. Dyma ddreigiau */
1482 static inline int ata_using_mwdma(struct ata_device *adev)
1484 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1485 return 1;
1486 return 0;
1489 static inline int ata_using_udma(struct ata_device *adev)
1491 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1492 return 1;
1493 return 0;
1496 static inline int ata_dma_enabled(struct ata_device *adev)
1498 return (adev->dma_mode == 0xFF ? 0 : 1);
1501 /**************************************************************************
1502 * PMP - drivers/ata/libata-pmp.c
1504 #ifdef CONFIG_SATA_PMP
1506 extern const struct ata_port_operations sata_pmp_port_ops;
1508 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1509 extern void sata_pmp_error_handler(struct ata_port *ap);
1511 #else /* CONFIG_SATA_PMP */
1513 #define sata_pmp_port_ops sata_port_ops
1514 #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1515 #define sata_pmp_error_handler ata_std_error_handler
1517 #endif /* CONFIG_SATA_PMP */
1520 /**************************************************************************
1521 * SFF - drivers/ata/libata-sff.c
1523 #ifdef CONFIG_ATA_SFF
1525 extern const struct ata_port_operations ata_sff_port_ops;
1526 extern const struct ata_port_operations ata_bmdma_port_ops;
1527 extern const struct ata_port_operations ata_bmdma32_port_ops;
1529 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1530 #define ATA_PIO_SHT(drv_name) \
1531 ATA_BASE_SHT(drv_name), \
1532 .sg_tablesize = LIBATA_MAX_PRD, \
1533 .dma_boundary = ATA_DMA_BOUNDARY
1535 #define ATA_BMDMA_SHT(drv_name) \
1536 ATA_BASE_SHT(drv_name), \
1537 .sg_tablesize = LIBATA_MAX_PRD, \
1538 .dma_boundary = ATA_DMA_BOUNDARY
1540 extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1541 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1542 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1543 extern u8 ata_sff_check_status(struct ata_port *ap);
1544 extern void ata_sff_pause(struct ata_port *ap);
1545 extern void ata_sff_dma_pause(struct ata_port *ap);
1546 extern int ata_sff_busy_sleep(struct ata_port *ap,
1547 unsigned long timeout_pat, unsigned long timeout);
1548 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1549 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1550 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1551 extern void ata_sff_exec_command(struct ata_port *ap,
1552 const struct ata_taskfile *tf);
1553 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1554 unsigned char *buf, unsigned int buflen, int rw);
1555 extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1556 unsigned char *buf, unsigned int buflen, int rw);
1557 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1558 unsigned char *buf, unsigned int buflen, int rw);
1559 extern u8 ata_sff_irq_on(struct ata_port *ap);
1560 extern void ata_sff_irq_clear(struct ata_port *ap);
1561 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1562 u8 status, int in_wq);
1563 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1564 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1565 extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1566 struct ata_queued_cmd *qc);
1567 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1568 extern void ata_sff_freeze(struct ata_port *ap);
1569 extern void ata_sff_thaw(struct ata_port *ap);
1570 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1571 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1572 u8 *r_err);
1573 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1574 unsigned long deadline);
1575 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1576 unsigned long deadline);
1577 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1578 unsigned long deadline);
1579 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1580 extern void ata_sff_error_handler(struct ata_port *ap);
1581 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1582 extern int ata_sff_port_start(struct ata_port *ap);
1583 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1584 extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1585 unsigned long xfer_mask);
1586 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1587 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1588 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1589 extern u8 ata_bmdma_status(struct ata_port *ap);
1590 extern void ata_bus_reset(struct ata_port *ap);
1592 #ifdef CONFIG_PCI
1593 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1594 extern int ata_pci_bmdma_init(struct ata_host *host);
1595 extern int ata_pci_sff_init_host(struct ata_host *host);
1596 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1597 const struct ata_port_info * const * ppi,
1598 struct ata_host **r_host);
1599 extern int ata_pci_sff_activate_host(struct ata_host *host,
1600 irq_handler_t irq_handler,
1601 struct scsi_host_template *sht);
1602 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1603 const struct ata_port_info * const * ppi,
1604 struct scsi_host_template *sht, void *host_priv);
1605 #endif /* CONFIG_PCI */
1608 * ata_sff_busy_wait - Wait for a port status register
1609 * @ap: Port to wait for.
1610 * @bits: bits that must be clear
1611 * @max: number of 10uS waits to perform
1613 * Waits up to max*10 microseconds for the selected bits in the port's
1614 * status register to be cleared.
1615 * Returns final value of status register.
1617 * LOCKING:
1618 * Inherited from caller.
1620 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1621 unsigned int max)
1623 u8 status;
1625 do {
1626 udelay(10);
1627 status = ap->ops->sff_check_status(ap);
1628 max--;
1629 } while (status != 0xff && (status & bits) && (max > 0));
1631 return status;
1635 * ata_wait_idle - Wait for a port to be idle.
1636 * @ap: Port to wait for.
1638 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1639 * Returns final value of status register.
1641 * LOCKING:
1642 * Inherited from caller.
1644 static inline u8 ata_wait_idle(struct ata_port *ap)
1646 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1648 #ifdef ATA_DEBUG
1649 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1650 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1651 status);
1652 #endif
1654 return status;
1656 #endif /* CONFIG_ATA_SFF */
1658 #endif /* __LINUX_LIBATA_H__ */