Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
af36d7f0 JG |
2 | * Copyright 2003-2005 Red Hat, Inc. All rights reserved. |
3 | * Copyright 2003-2005 Jeff Garzik | |
4 | * | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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. | |
19 | * | |
20 | * | |
21 | * libata documentation is available via 'make {ps|pdf}docs', | |
22 | * as Documentation/DocBook/libata.* | |
23 | * | |
1da177e4 LT |
24 | */ |
25 | ||
26 | #ifndef __LINUX_LIBATA_H__ | |
27 | #define __LINUX_LIBATA_H__ | |
28 | ||
29 | #include <linux/delay.h> | |
30 | #include <linux/interrupt.h> | |
1c72d8d9 | 31 | #include <linux/dma-mapping.h> |
87260216 | 32 | #include <linux/scatterlist.h> |
f0d36efd | 33 | #include <linux/io.h> |
1da177e4 LT |
34 | #include <linux/ata.h> |
35 | #include <linux/workqueue.h> | |
35bb94b1 | 36 | #include <scsi/scsi_host.h> |
11ef697b | 37 | #include <linux/acpi.h> |
ceb0c642 | 38 | #include <linux/cdrom.h> |
1da177e4 | 39 | |
a6d967a4 JG |
40 | /* |
41 | * Define if arch has non-standard setup. This is a _PCI_ standard | |
42 | * not a legacy or ISA standard. | |
43 | */ | |
44 | #ifdef CONFIG_ATA_NONSTANDARD | |
2ec7df04 | 45 | #include <asm/libata-portmap.h> |
a6d967a4 JG |
46 | #else |
47 | #include <asm-generic/libata-portmap.h> | |
48 | #endif | |
2ec7df04 | 49 | |
1da177e4 | 50 | /* |
bfd60579 RD |
51 | * compile-time options: to be removed as soon as all the drivers are |
52 | * converted to the new debugging mechanism | |
1da177e4 LT |
53 | */ |
54 | #undef ATA_DEBUG /* debugging output */ | |
55 | #undef ATA_VERBOSE_DEBUG /* yet more debugging output */ | |
56 | #undef ATA_IRQ_TRAP /* define to ack screaming irqs */ | |
57 | #undef ATA_NDEBUG /* define to disable quick runtime checks */ | |
1da177e4 LT |
58 | |
59 | ||
60 | /* note: prints function name for you */ | |
61 | #ifdef ATA_DEBUG | |
62 | #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) | |
63 | #ifdef ATA_VERBOSE_DEBUG | |
64 | #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) | |
65 | #else | |
66 | #define VPRINTK(fmt, args...) | |
67 | #endif /* ATA_VERBOSE_DEBUG */ | |
68 | #else | |
69 | #define DPRINTK(fmt, args...) | |
70 | #define VPRINTK(fmt, args...) | |
71 | #endif /* ATA_DEBUG */ | |
72 | ||
2c13b7ce JG |
73 | #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) |
74 | ||
bfd60579 RD |
75 | /* NEW: debug levels */ |
76 | #define HAVE_LIBATA_MSG 1 | |
77 | ||
78 | enum { | |
79 | ATA_MSG_DRV = 0x0001, | |
80 | ATA_MSG_INFO = 0x0002, | |
81 | ATA_MSG_PROBE = 0x0004, | |
82 | ATA_MSG_WARN = 0x0008, | |
83 | ATA_MSG_MALLOC = 0x0010, | |
84 | ATA_MSG_CTL = 0x0020, | |
85 | ATA_MSG_INTR = 0x0040, | |
86 | ATA_MSG_ERR = 0x0080, | |
87 | }; | |
88 | ||
89 | #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) | |
90 | #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) | |
91 | #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) | |
92 | #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) | |
93 | #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) | |
94 | #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) | |
95 | #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) | |
96 | #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) | |
97 | ||
98 | static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) | |
99 | { | |
100 | if (dval < 0 || dval >= (sizeof(u32) * 8)) | |
101 | return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ | |
102 | if (!dval) | |
103 | return 0; | |
104 | return (1 << dval) - 1; | |
105 | } | |
106 | ||
1da177e4 LT |
107 | /* defines only for the constants which don't work well as enums */ |
108 | #define ATA_TAG_POISON 0xfafbfcfdU | |
109 | ||
1da177e4 LT |
110 | enum { |
111 | /* various global constants */ | |
112 | LIBATA_MAX_PRD = ATA_MAX_PRD / 2, | |
d26fc955 | 113 | LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */ |
1da177e4 LT |
114 | ATA_MAX_PORTS = 8, |
115 | ATA_DEF_QUEUE = 1, | |
2ab7db1f | 116 | /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ |
a6e6ce8e | 117 | ATA_MAX_QUEUE = 32, |
2ab7db1f | 118 | ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, |
1da177e4 LT |
119 | ATA_MAX_BUS = 2, |
120 | ATA_DEF_BUSY_WAIT = 10000, | |
121 | ATA_SHORT_PAUSE = (HZ >> 6) + 1, | |
122 | ||
140b5e59 TH |
123 | ATAPI_MAX_DRAIN = 16 << 10, |
124 | ||
b558eddd TH |
125 | ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1, |
126 | ||
1da177e4 LT |
127 | ATA_SHT_EMULATED = 1, |
128 | ATA_SHT_CMD_PER_LUN = 1, | |
129 | ATA_SHT_THIS_ID = -1, | |
cf482935 | 130 | ATA_SHT_USE_CLUSTERING = 1, |
1da177e4 LT |
131 | |
132 | /* struct ata_device stuff */ | |
949b38af TH |
133 | ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */ |
134 | ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */ | |
029f5468 | 135 | ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */ |
88e49034 | 136 | ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */ |
6fc49adb | 137 | ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */ |
6746544c TH |
138 | ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */ |
139 | ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */ | |
7d77b247 | 140 | ATA_DFLAG_AN = (1 << 7), /* AN configured */ |
ca77329f KCA |
141 | ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */ |
142 | ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */ | |
91163006 | 143 | ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */ |
2557164e | 144 | ATA_DFLAG_CFG_MASK = (1 << 12) - 1, |
949b38af | 145 | |
2557164e KCA |
146 | ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */ |
147 | ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */ | |
148 | ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */ | |
054a5fba | 149 | ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */ |
00115e0f | 150 | ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */ |
f20ded38 | 151 | ATA_DFLAG_INIT_MASK = (1 << 24) - 1, |
1da177e4 | 152 | |
f20ded38 TH |
153 | ATA_DFLAG_DETACH = (1 << 24), |
154 | ATA_DFLAG_DETACHED = (1 << 25), | |
abdda733 | 155 | |
1da177e4 LT |
156 | ATA_DEV_UNKNOWN = 0, /* unknown device */ |
157 | ATA_DEV_ATA = 1, /* ATA device */ | |
158 | ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ | |
159 | ATA_DEV_ATAPI = 3, /* ATAPI device */ | |
160 | ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ | |
e0a71752 TH |
161 | ATA_DEV_PMP = 5, /* SATA port multiplier */ |
162 | ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */ | |
163 | ATA_DEV_SEMB = 7, /* SEMB */ | |
164 | ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */ | |
165 | ATA_DEV_NONE = 9, /* no device */ | |
1da177e4 | 166 | |
0c88758b | 167 | /* struct ata_link flags */ |
ae791c05 TH |
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, | |
fd995f70 | 172 | ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */ |
f9df58cb | 173 | ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */ |
0c88758b | 174 | |
1da177e4 | 175 | /* struct ata_port flags */ |
949b38af | 176 | ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ |
1da177e4 | 177 | /* (doesn't imply presence) */ |
949b38af TH |
178 | ATA_FLAG_SATA = (1 << 1), |
179 | ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */ | |
180 | ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */ | |
181 | ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */ | |
182 | ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */ | |
183 | ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ | |
184 | ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ | |
185 | ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ | |
7395acb2 TH |
186 | ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD |
187 | * doesn't handle PIO interrupts */ | |
188 | ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */ | |
7395acb2 | 189 | ATA_FLAG_DEBUGMSG = (1 << 13), |
b2a8bbe6 | 190 | ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */ |
f834e49f | 191 | ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */ |
3cadbcc0 | 192 | ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */ |
9f45cbd3 | 193 | ATA_FLAG_AN = (1 << 18), /* controller supports AN */ |
e0a71752 | 194 | ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */ |
ca77329f | 195 | ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */ |
949b38af | 196 | |
b51e9e5d TH |
197 | /* The following flag belongs to ap->pflags but is kept in |
198 | * ap->flags because it's referenced in many LLDs and will be | |
199 | * removed in not-too-distant future. | |
200 | */ | |
201 | ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */ | |
202 | ||
203 | /* bits 24:31 of ap->flags are reserved for LLD specific flags */ | |
9ec957f2 | 204 | |
b51e9e5d TH |
205 | /* struct ata_port pflags */ |
206 | ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */ | |
207 | ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */ | |
208 | ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */ | |
209 | ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */ | |
210 | ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */ | |
211 | ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */ | |
212 | ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */ | |
f4d6d004 | 213 | ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */ |
afaa5c37 | 214 | ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */ |
949b38af | 215 | |
b51e9e5d | 216 | ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */ |
500530f6 | 217 | ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */ |
c05e6ff0 | 218 | ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */ |
949b38af TH |
219 | |
220 | /* struct ata_queued_cmd flags */ | |
221 | ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ | |
001102d7 | 222 | ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */ |
27197367 | 223 | ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ |
e61e0672 | 224 | ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ |
da917d69 | 225 | ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */ |
e027bd36 | 226 | ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */ |
e61e0672 | 227 | |
9ec957f2 TH |
228 | ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ |
229 | ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ | |
230 | ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ | |
1da177e4 | 231 | |
4e5ec5db | 232 | /* host set flags */ |
cca3974e | 233 | ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */ |
ecef7253 | 234 | ATA_HOST_STARTED = (1 << 1), /* Host started */ |
9bec2e38 | 235 | |
b8b275ef TH |
236 | /* bits 24:31 of host->flags are reserved for LLD specific flags */ |
237 | ||
1da177e4 | 238 | /* various lengths of time */ |
8d238e01 AC |
239 | ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */ |
240 | ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */ | |
a2a7a662 TH |
241 | ATA_TMOUT_INTERNAL = 30 * HZ, |
242 | ATA_TMOUT_INTERNAL_QUICK = 5 * HZ, | |
1da177e4 | 243 | |
88ff6eaf TH |
244 | /* FIXME: GoVault needs 2s but we can't afford that without |
245 | * parallel probing. 800ms is enough for iVDR disk | |
246 | * HHD424020F7SV00. Increase to 2secs when parallel probing | |
247 | * is in place. | |
248 | */ | |
249 | ATA_TMOUT_FF_WAIT = 4 * HZ / 5, | |
250 | ||
1da177e4 LT |
251 | /* ATA bus states */ |
252 | BUS_UNKNOWN = 0, | |
253 | BUS_DMA = 1, | |
254 | BUS_IDLE = 2, | |
255 | BUS_NOINTR = 3, | |
256 | BUS_NODATA = 4, | |
257 | BUS_TIMER = 5, | |
258 | BUS_PIO = 6, | |
259 | BUS_EDD = 7, | |
260 | BUS_IDENTIFY = 8, | |
261 | BUS_PACKET = 9, | |
262 | ||
263 | /* SATA port states */ | |
264 | PORT_UNKNOWN = 0, | |
265 | PORT_ENABLED = 1, | |
266 | PORT_DISABLED = 2, | |
267 | ||
268 | /* encoding various smaller bitmaps into a single | |
7dc951ae | 269 | * unsigned long bitmap |
1da177e4 | 270 | */ |
70cd071e TH |
271 | ATA_NR_PIO_MODES = 7, |
272 | ATA_NR_MWDMA_MODES = 5, | |
273 | ATA_NR_UDMA_MODES = 8, | |
1da7b0d0 TH |
274 | |
275 | ATA_SHIFT_PIO = 0, | |
70cd071e TH |
276 | ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES, |
277 | ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES, | |
278 | ||
cedc9a47 JG |
279 | /* size of buffer to pad xfers ending on unaligned boundaries */ |
280 | ATA_DMA_PAD_SZ = 4, | |
949b38af | 281 | |
0c247c55 TH |
282 | /* ering size */ |
283 | ATA_ERING_SIZE = 32, | |
284 | ||
31cc23b3 TH |
285 | /* return values for ->qc_defer */ |
286 | ATA_DEFER_LINK = 1, | |
287 | ATA_DEFER_PORT = 2, | |
288 | ||
f3e81b19 TH |
289 | /* desc_len for ata_eh_info and context */ |
290 | ATA_EH_DESC_LEN = 80, | |
291 | ||
9be1e979 TH |
292 | /* reset / recovery action types */ |
293 | ATA_EH_REVALIDATE = (1 << 0), | |
cf480626 TH |
294 | ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */ |
295 | ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */ | |
296 | ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, | |
f9df58cb | 297 | ATA_EH_ENABLE_LINK = (1 << 3), |
3ec25ebd | 298 | ATA_EH_LPM = (1 << 4), /* link power management action */ |
9be1e979 | 299 | |
9666f400 | 300 | ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE, |
9be1e979 | 301 | |
f3e81b19 | 302 | /* ata_eh_info->flags */ |
abdda733 | 303 | ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */ |
1cdaf534 TH |
304 | ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */ |
305 | ATA_EHI_QUIET = (1 << 3), /* be quiet */ | |
abdda733 | 306 | |
0d64a233 TH |
307 | ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */ |
308 | ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */ | |
309 | ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */ | |
310 | ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */ | |
311 | ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */ | |
f3e81b19 | 312 | |
0d64a233 | 313 | ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET, |
13abf50d | 314 | |
a1e10f7e TH |
315 | /* max tries if error condition is still set after ->error_handler */ |
316 | ATA_EH_MAX_TRIES = 5, | |
ad9e2762 | 317 | |
14d2bac1 TH |
318 | /* how hard are we gonna try to probe/recover devices */ |
319 | ATA_PROBE_MAX_TRIES = 3, | |
022bdb07 | 320 | ATA_EH_DEV_TRIES = 3, |
e0a71752 TH |
321 | ATA_EH_PMP_TRIES = 5, |
322 | ATA_EH_PMP_LINK_TRIES = 3, | |
323 | ||
324 | SATA_PMP_SCR_TIMEOUT = 250, | |
f5914a46 | 325 | |
93590859 AC |
326 | /* Horkage types. May be set by libata or controller on drives |
327 | (some horkage may be drive/controller pair dependant */ | |
328 | ||
329 | ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */ | |
6919a0a6 AC |
330 | ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */ |
331 | ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */ | |
18d6e9d5 | 332 | ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */ |
16c55b03 | 333 | ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */ |
e31e8531 | 334 | ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */ |
93328e11 | 335 | ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */ |
ca77329f | 336 | ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */ |
6bbfd53d | 337 | ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */ |
2d3b8eea | 338 | ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */ |
b3a70601 | 339 | |
2dcb407e | 340 | /* DMA mask for user DMA control: User visible values; DO NOT |
b3a70601 AC |
341 | renumber */ |
342 | ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */ | |
343 | ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */ | |
344 | ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */ | |
ceb0c642 TH |
345 | |
346 | /* ATAPI command types */ | |
347 | ATAPI_READ = 0, /* READs */ | |
348 | ATAPI_WRITE = 1, /* WRITEs */ | |
349 | ATAPI_READ_CD = 2, /* READ CD [MSF] */ | |
e52dcc48 TH |
350 | ATAPI_PASS_THRU = 3, /* SAT pass-thru */ |
351 | ATAPI_MISC = 4, /* the rest */ | |
1da177e4 LT |
352 | }; |
353 | ||
7dc951ae TH |
354 | enum ata_xfer_mask { |
355 | ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1) | |
356 | << ATA_SHIFT_PIO, | |
357 | ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1) | |
358 | << ATA_SHIFT_MWDMA, | |
359 | ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1) | |
360 | << ATA_SHIFT_UDMA, | |
361 | }; | |
362 | ||
14be71f4 | 363 | enum hsm_task_states { |
c56b14d2 | 364 | HSM_ST_IDLE, /* no command on going */ |
71527647 AL |
365 | HSM_ST_FIRST, /* (waiting the device to) |
366 | write CDB or first data block */ | |
c56b14d2 AL |
367 | HSM_ST, /* (waiting the device to) transfer data */ |
368 | HSM_ST_LAST, /* (waiting the device to) complete command */ | |
c56b14d2 | 369 | HSM_ST_ERR, /* error */ |
1da177e4 LT |
370 | }; |
371 | ||
a7dac447 | 372 | enum ata_completion_errors { |
11a56d24 TH |
373 | AC_ERR_DEV = (1 << 0), /* device reported error */ |
374 | AC_ERR_HSM = (1 << 1), /* host state machine violation */ | |
375 | AC_ERR_TIMEOUT = (1 << 2), /* timeout */ | |
376 | AC_ERR_MEDIA = (1 << 3), /* media error */ | |
377 | AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ | |
378 | AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ | |
379 | AC_ERR_SYSTEM = (1 << 6), /* system error */ | |
380 | AC_ERR_INVALID = (1 << 7), /* invalid argument */ | |
381 | AC_ERR_OTHER = (1 << 8), /* unknown */ | |
55a8e2c8 | 382 | AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */ |
5335b729 | 383 | AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */ |
a7dac447 JG |
384 | }; |
385 | ||
1da177e4 LT |
386 | /* forward declarations */ |
387 | struct scsi_device; | |
388 | struct ata_port_operations; | |
389 | struct ata_port; | |
cc0680a5 | 390 | struct ata_link; |
1da177e4 LT |
391 | struct ata_queued_cmd; |
392 | ||
393 | /* typedefs */ | |
77853bf2 | 394 | typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); |
cc0680a5 TH |
395 | typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline); |
396 | typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes, | |
d4b2bab4 | 397 | unsigned long deadline); |
cc0680a5 | 398 | typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes); |
1da177e4 | 399 | |
ca77329f KCA |
400 | /* |
401 | * host pm policy: If you alter this, you also need to alter libata-scsi.c | |
402 | * (for the ascii descriptions) | |
403 | */ | |
404 | enum link_pm { | |
405 | NOT_AVAILABLE, | |
406 | MIN_POWER, | |
407 | MAX_PERFORMANCE, | |
408 | MEDIUM_POWER, | |
409 | }; | |
410 | extern struct class_device_attribute class_device_attr_link_power_management_policy; | |
411 | ||
1da177e4 | 412 | struct ata_ioports { |
0d5ff566 TH |
413 | void __iomem *cmd_addr; |
414 | void __iomem *data_addr; | |
415 | void __iomem *error_addr; | |
416 | void __iomem *feature_addr; | |
417 | void __iomem *nsect_addr; | |
418 | void __iomem *lbal_addr; | |
419 | void __iomem *lbam_addr; | |
420 | void __iomem *lbah_addr; | |
421 | void __iomem *device_addr; | |
422 | void __iomem *status_addr; | |
423 | void __iomem *command_addr; | |
424 | void __iomem *altstatus_addr; | |
425 | void __iomem *ctl_addr; | |
426 | void __iomem *bmdma_addr; | |
427 | void __iomem *scr_addr; | |
1da177e4 LT |
428 | }; |
429 | ||
cca3974e | 430 | struct ata_host { |
1da177e4 LT |
431 | spinlock_t lock; |
432 | struct device *dev; | |
0d5ff566 | 433 | void __iomem * const *iomap; |
1da177e4 LT |
434 | unsigned int n_ports; |
435 | void *private_data; | |
029cfd6b | 436 | struct ata_port_operations *ops; |
5444a6f4 | 437 | unsigned long flags; |
fafbae87 TH |
438 | #ifdef CONFIG_ATA_ACPI |
439 | acpi_handle acpi_handle; | |
440 | #endif | |
032af1ce | 441 | struct ata_port *simplex_claimed; /* channel owning the DMA */ |
f0eb62b8 | 442 | struct ata_port *ports[0]; |
1da177e4 LT |
443 | }; |
444 | ||
445 | struct ata_queued_cmd { | |
446 | struct ata_port *ap; | |
447 | struct ata_device *dev; | |
448 | ||
449 | struct scsi_cmnd *scsicmd; | |
450 | void (*scsidone)(struct scsi_cmnd *); | |
451 | ||
452 | struct ata_taskfile tf; | |
453 | u8 cdb[ATAPI_CDB_LEN]; | |
454 | ||
455 | unsigned long flags; /* ATA_QCFLAG_xxx */ | |
456 | unsigned int tag; | |
457 | unsigned int n_elem; | |
458 | ||
459 | int dma_dir; | |
460 | ||
5a5dbd18 | 461 | unsigned int sect_size; |
cedc9a47 | 462 | |
1da177e4 | 463 | unsigned int nbytes; |
aacda375 | 464 | unsigned int extrabytes; |
1da177e4 LT |
465 | unsigned int curbytes; |
466 | ||
87260216 | 467 | struct scatterlist *cursg; |
1da177e4 LT |
468 | unsigned int cursg_ofs; |
469 | ||
470 | struct scatterlist sgent; | |
1da177e4 | 471 | |
ff2aeb1e | 472 | struct scatterlist *sg; |
1da177e4 | 473 | |
a22e2eb0 | 474 | unsigned int err_mask; |
e61e0672 | 475 | struct ata_taskfile result_tf; |
1da177e4 LT |
476 | ata_qc_cb_t complete_fn; |
477 | ||
1da177e4 | 478 | void *private_data; |
1c50dc83 | 479 | void *lldd_task; |
1da177e4 LT |
480 | }; |
481 | ||
cca3974e | 482 | struct ata_port_stats { |
1da177e4 LT |
483 | unsigned long unhandled_irq; |
484 | unsigned long idle_irq; | |
485 | unsigned long rw_reqbuf; | |
486 | }; | |
487 | ||
0c247c55 | 488 | struct ata_ering_entry { |
3884f7b0 | 489 | unsigned int eflags; |
0c247c55 TH |
490 | unsigned int err_mask; |
491 | u64 timestamp; | |
492 | }; | |
493 | ||
494 | struct ata_ering { | |
495 | int cursor; | |
496 | struct ata_ering_entry ring[ATA_ERING_SIZE]; | |
497 | }; | |
498 | ||
1da177e4 | 499 | struct ata_device { |
9af5c9c9 | 500 | struct ata_link *link; |
72fa4b74 | 501 | unsigned int devno; /* 0 or 1 */ |
1da177e4 | 502 | unsigned long flags; /* ATA_DFLAG_xxx */ |
75683fe7 | 503 | unsigned int horkage; /* List of broken features */ |
3edebac4 | 504 | struct scsi_device *sdev; /* attached SCSI device */ |
fafbae87 TH |
505 | #ifdef CONFIG_ATA_ACPI |
506 | acpi_handle acpi_handle; | |
398e0782 | 507 | union acpi_object *gtf_cache; |
fafbae87 | 508 | #endif |
72fa4b74 TH |
509 | /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */ |
510 | u64 n_sectors; /* size of device, if ATA */ | |
1da177e4 | 511 | unsigned int class; /* ATA_DEV_xxx */ |
e0a71752 TH |
512 | |
513 | union { | |
514 | u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ | |
515 | u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */ | |
516 | }; | |
517 | ||
1da177e4 LT |
518 | u8 pio_mode; |
519 | u8 dma_mode; | |
520 | u8 xfer_mode; | |
521 | unsigned int xfer_shift; /* ATA_SHIFT_xxx */ | |
522 | ||
8cbd6df1 AL |
523 | unsigned int multi_count; /* sectors count for |
524 | READ/WRITE MULTIPLE */ | |
b00eec1d | 525 | unsigned int max_sectors; /* per-device max sectors */ |
6e7846e9 | 526 | unsigned int cdb_len; |
8bf62ece | 527 | |
acf356b1 | 528 | /* per-dev xfer mask */ |
7dc951ae TH |
529 | unsigned long pio_mask; |
530 | unsigned long mwdma_mask; | |
531 | unsigned long udma_mask; | |
acf356b1 | 532 | |
8bf62ece AL |
533 | /* for CHS addressing */ |
534 | u16 cylinders; /* Number of cylinders */ | |
535 | u16 heads; /* Number of heads */ | |
536 | u16 sectors; /* Number of sectors per track */ | |
0c247c55 TH |
537 | |
538 | /* error history */ | |
539 | struct ata_ering ering; | |
7d47e8d4 | 540 | int spdn_cnt; |
1da177e4 LT |
541 | }; |
542 | ||
72fa4b74 TH |
543 | /* Offset into struct ata_device. Fields above it are maintained |
544 | * acress device init. Fields below are zeroed. | |
545 | */ | |
546 | #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors) | |
547 | ||
f3e81b19 TH |
548 | struct ata_eh_info { |
549 | struct ata_device *dev; /* offending device */ | |
550 | u32 serror; /* SError from LLDD */ | |
551 | unsigned int err_mask; /* port-wide err_mask */ | |
552 | unsigned int action; /* ATA_EH_* action mask */ | |
47005f25 | 553 | unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */ |
f3e81b19 | 554 | unsigned int flags; /* ATA_EHI_* flags */ |
abdda733 | 555 | |
abdda733 TH |
556 | unsigned int probe_mask; |
557 | ||
f3e81b19 TH |
558 | char desc[ATA_EH_DESC_LEN]; |
559 | int desc_len; | |
560 | }; | |
561 | ||
562 | struct ata_eh_context { | |
563 | struct ata_eh_info i; | |
564 | int tries[ATA_MAX_DEVICES]; | |
abdda733 TH |
565 | unsigned int classes[ATA_MAX_DEVICES]; |
566 | unsigned int did_probe_mask; | |
00115e0f TH |
567 | unsigned int saved_ncq_enabled; |
568 | u8 saved_xfer_mode[ATA_MAX_DEVICES]; | |
f3e81b19 TH |
569 | }; |
570 | ||
64578a3d TH |
571 | struct ata_acpi_drive |
572 | { | |
573 | u32 pio; | |
574 | u32 dma; | |
575 | } __packed; | |
576 | ||
577 | struct ata_acpi_gtm { | |
578 | struct ata_acpi_drive drive[2]; | |
579 | u32 flags; | |
580 | } __packed; | |
581 | ||
9af5c9c9 TH |
582 | struct ata_link { |
583 | struct ata_port *ap; | |
8989805d | 584 | int pmp; /* port multiplier port # */ |
9af5c9c9 TH |
585 | |
586 | unsigned int active_tag; /* active tag on this link */ | |
587 | u32 sactive; /* active NCQ commands */ | |
588 | ||
0c88758b TH |
589 | unsigned int flags; /* ATA_LFLAG_xxx */ |
590 | ||
9af5c9c9 TH |
591 | unsigned int hw_sata_spd_limit; |
592 | unsigned int sata_spd_limit; | |
593 | unsigned int sata_spd; /* current SATA PHY speed */ | |
594 | ||
595 | /* record runtime error info, protected by host_set lock */ | |
596 | struct ata_eh_info eh_info; | |
597 | /* EH context */ | |
598 | struct ata_eh_context eh_context; | |
599 | ||
600 | struct ata_device device[ATA_MAX_DEVICES]; | |
601 | }; | |
602 | ||
1da177e4 | 603 | struct ata_port { |
cca3974e | 604 | struct Scsi_Host *scsi_host; /* our co-allocated scsi host */ |
029cfd6b | 605 | struct ata_port_operations *ops; |
ba6a1308 | 606 | spinlock_t *lock; |
1da177e4 | 607 | unsigned long flags; /* ATA_FLAG_xxx */ |
b51e9e5d | 608 | unsigned int pflags; /* ATA_PFLAG_xxx */ |
44877b4e TH |
609 | unsigned int print_id; /* user visible unique port ID */ |
610 | unsigned int port_no; /* 0 based port no. inside the host */ | |
1da177e4 LT |
611 | |
612 | struct ata_prd *prd; /* our SG list */ | |
613 | dma_addr_t prd_dma; /* and its DMA mapping */ | |
614 | ||
615 | struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ | |
616 | ||
617 | u8 ctl; /* cache of ATA control register */ | |
618 | u8 last_ctl; /* Cache last written value */ | |
1da177e4 LT |
619 | unsigned int pio_mask; |
620 | unsigned int mwdma_mask; | |
621 | unsigned int udma_mask; | |
622 | unsigned int cbl; /* cable type; ATA_CBL_xxx */ | |
1da177e4 LT |
623 | |
624 | struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; | |
6cec4a39 | 625 | unsigned long qc_allocated; |
dedaf2b0 | 626 | unsigned int qc_active; |
da917d69 | 627 | int nr_active_links; /* #links with active qcs */ |
dedaf2b0 | 628 | |
9af5c9c9 | 629 | struct ata_link link; /* host default link */ |
1da177e4 | 630 | |
8989805d TH |
631 | int nr_pmp_links; /* nr of available PMP links */ |
632 | struct ata_link *pmp_link; /* array of PMP links */ | |
da917d69 | 633 | struct ata_link *excl_link; /* for PMP qc exclusion */ |
8989805d | 634 | |
cca3974e JG |
635 | struct ata_port_stats stats; |
636 | struct ata_host *host; | |
2f1f610b | 637 | struct device *dev; |
1da177e4 | 638 | |
65f27f38 | 639 | void *port_task_data; |
52bad64d DH |
640 | struct delayed_work port_task; |
641 | struct delayed_work hotplug_task; | |
3b01b8af | 642 | struct work_struct scsi_rescan_task; |
86e45b6b | 643 | |
14be71f4 | 644 | unsigned int hsm_task_state; |
1da177e4 | 645 | |
bfd60579 | 646 | u32 msg_enable; |
a72ec4ce | 647 | struct list_head eh_done_q; |
c6cf9e99 | 648 | wait_queue_head_t eh_wait_q; |
a1e10f7e | 649 | int eh_tries; |
bfd60579 | 650 | |
500530f6 TH |
651 | pm_message_t pm_mesg; |
652 | int *pm_result; | |
ca77329f | 653 | enum link_pm pm_policy; |
500530f6 | 654 | |
5ddf24c5 TH |
655 | struct timer_list fastdrain_timer; |
656 | unsigned long fastdrain_cnt; | |
657 | ||
1da177e4 | 658 | void *private_data; |
fe635c7e | 659 | |
fafbae87 TH |
660 | #ifdef CONFIG_ATA_ACPI |
661 | acpi_handle acpi_handle; | |
c05e6ff0 | 662 | struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */ |
fafbae87 | 663 | #endif |
fe635c7e | 664 | u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */ |
1da177e4 LT |
665 | }; |
666 | ||
029cfd6b TH |
667 | /* The following initializer overrides a method to NULL whether one of |
668 | * its parent has the method defined or not. This is equivalent to | |
669 | * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant | |
670 | * expression and thus can't be used as an initializer. | |
671 | */ | |
672 | #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT) | |
673 | ||
1da177e4 | 674 | struct ata_port_operations { |
c1bc899f TH |
675 | /* |
676 | * Command execution | |
677 | */ | |
678 | int (*qc_defer)(struct ata_queued_cmd *qc); | |
679 | int (*check_atapi_dma)(struct ata_queued_cmd *qc); | |
680 | void (*qc_prep)(struct ata_queued_cmd *qc); | |
681 | unsigned int (*qc_issue)(struct ata_queued_cmd *qc); | |
1da177e4 | 682 | |
c1bc899f TH |
683 | /* |
684 | * Configuration and exception handling | |
685 | */ | |
686 | int (*cable_detect)(struct ata_port *ap); | |
687 | unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask); | |
688 | void (*set_piomode)(struct ata_port *ap, struct ata_device *dev); | |
689 | void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev); | |
690 | int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev); | |
1da177e4 | 691 | |
c1bc899f | 692 | void (*dev_config)(struct ata_device *dev); |
1da177e4 | 693 | |
c1bc899f TH |
694 | void (*freeze)(struct ata_port *ap); |
695 | void (*thaw)(struct ata_port *ap); | |
696 | void (*error_handler)(struct ata_port *ap); | |
697 | void (*post_internal_cmd)(struct ata_queued_cmd *qc); | |
698 | ||
699 | /* | |
700 | * Optional features | |
701 | */ | |
702 | int (*scr_read)(struct ata_port *ap, unsigned int sc_reg, u32 *val); | |
703 | int (*scr_write)(struct ata_port *ap, unsigned int sc_reg, u32 val); | |
704 | void (*pmp_attach)(struct ata_port *ap); | |
705 | void (*pmp_detach)(struct ata_port *ap); | |
706 | int (*enable_pm)(struct ata_port *ap, enum link_pm policy); | |
707 | void (*disable_pm)(struct ata_port *ap); | |
708 | ||
709 | /* | |
710 | * Start, stop, suspend and resume | |
711 | */ | |
712 | int (*port_suspend)(struct ata_port *ap, pm_message_t mesg); | |
713 | int (*port_resume)(struct ata_port *ap); | |
714 | int (*port_start)(struct ata_port *ap); | |
715 | void (*port_stop)(struct ata_port *ap); | |
716 | void (*host_stop)(struct ata_host *host); | |
717 | ||
718 | /* | |
719 | * SFF / taskfile oriented ops | |
720 | */ | |
721 | void (*dev_select)(struct ata_port *ap, unsigned int device); | |
1da177e4 LT |
722 | u8 (*check_status)(struct ata_port *ap); |
723 | u8 (*check_altstatus)(struct ata_port *ap); | |
c1bc899f TH |
724 | void (*tf_load)(struct ata_port *ap, const struct ata_taskfile *tf); |
725 | void (*tf_read)(struct ata_port *ap, struct ata_taskfile *tf); | |
726 | void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); | |
727 | unsigned int (*data_xfer)(struct ata_device *dev, unsigned char *buf, | |
728 | unsigned int buflen, int rw); | |
729 | u8 (*irq_on)(struct ata_port *); | |
730 | ||
731 | void (*irq_clear)(struct ata_port *); | |
732 | void (*bmdma_setup)(struct ata_queued_cmd *qc); | |
733 | void (*bmdma_start)(struct ata_queued_cmd *qc); | |
734 | void (*bmdma_stop)(struct ata_queued_cmd *qc); | |
735 | u8 (*bmdma_status)(struct ata_port *ap); | |
736 | ||
737 | /* | |
738 | * Obsolete | |
9ec957f2 | 739 | */ |
c1bc899f TH |
740 | void (*phy_reset)(struct ata_port *ap); |
741 | void (*eng_timeout)(struct ata_port *ap); | |
029cfd6b TH |
742 | |
743 | /* | |
744 | * ->inherits must be the last field and all the preceding | |
745 | * fields must be pointers. | |
746 | */ | |
747 | const struct ata_port_operations *inherits; | |
1da177e4 LT |
748 | }; |
749 | ||
750 | struct ata_port_info { | |
cca3974e | 751 | unsigned long flags; |
0c88758b | 752 | unsigned long link_flags; |
1da177e4 LT |
753 | unsigned long pio_mask; |
754 | unsigned long mwdma_mask; | |
755 | unsigned long udma_mask; | |
029cfd6b | 756 | struct ata_port_operations *port_ops; |
e99f8b5e | 757 | void *private_data; |
1da177e4 LT |
758 | }; |
759 | ||
452503f9 AC |
760 | struct ata_timing { |
761 | unsigned short mode; /* ATA mode */ | |
762 | unsigned short setup; /* t1 */ | |
763 | unsigned short act8b; /* t2 for 8-bit I/O */ | |
764 | unsigned short rec8b; /* t2i for 8-bit I/O */ | |
765 | unsigned short cyc8b; /* t0 for 8-bit I/O */ | |
766 | unsigned short active; /* t2 or tD */ | |
767 | unsigned short recover; /* t2i or tK */ | |
768 | unsigned short cycle; /* t0 */ | |
769 | unsigned short udma; /* t2CYCTYP/2 */ | |
770 | }; | |
771 | ||
2dcb407e | 772 | #define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin) |
1da177e4 | 773 | |
e9c83914 TH |
774 | extern const unsigned long sata_deb_timing_normal[]; |
775 | extern const unsigned long sata_deb_timing_hotplug[]; | |
776 | extern const unsigned long sata_deb_timing_long[]; | |
777 | ||
029cfd6b | 778 | extern struct ata_port_operations ata_dummy_port_ops; |
21b0ad4f | 779 | extern const struct ata_port_info ata_dummy_port_info; |
dd5b06c4 | 780 | |
e9c83914 TH |
781 | static inline const unsigned long * |
782 | sata_ehc_deb_timing(struct ata_eh_context *ehc) | |
783 | { | |
784 | if (ehc->i.flags & ATA_EHI_HOTPLUGGED) | |
785 | return sata_deb_timing_hotplug; | |
786 | else | |
787 | return sata_deb_timing_normal; | |
788 | } | |
d7bb4cc7 | 789 | |
dd5b06c4 TH |
790 | static inline int ata_port_is_dummy(struct ata_port *ap) |
791 | { | |
792 | return ap->ops == &ata_dummy_port_ops; | |
793 | } | |
794 | ||
936fd732 | 795 | extern void sata_print_link_status(struct ata_link *link); |
1da177e4 | 796 | extern void ata_port_probe(struct ata_port *); |
1da177e4 | 797 | extern void ata_bus_reset(struct ata_port *ap); |
936fd732 TH |
798 | extern int sata_set_spd(struct ata_link *link); |
799 | extern int sata_link_debounce(struct ata_link *link, | |
800 | const unsigned long *params, unsigned long deadline); | |
801 | extern int sata_link_resume(struct ata_link *link, const unsigned long *params, | |
802 | unsigned long deadline); | |
cc0680a5 TH |
803 | extern int ata_std_prereset(struct ata_link *link, unsigned long deadline); |
804 | extern int ata_std_softreset(struct ata_link *link, unsigned int *classes, | |
d4b2bab4 | 805 | unsigned long deadline); |
cc0680a5 TH |
806 | extern int sata_link_hardreset(struct ata_link *link, |
807 | const unsigned long *timing, unsigned long deadline); | |
808 | extern int sata_std_hardreset(struct ata_link *link, unsigned int *class, | |
d4b2bab4 | 809 | unsigned long deadline); |
cc0680a5 | 810 | extern void ata_std_postreset(struct ata_link *link, unsigned int *classes); |
1da177e4 LT |
811 | extern void ata_port_disable(struct ata_port *); |
812 | extern void ata_std_ports(struct ata_ioports *ioaddr); | |
2855568b | 813 | |
f3187195 | 814 | extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports); |
f5cda257 TH |
815 | extern struct ata_host *ata_host_alloc_pinfo(struct device *dev, |
816 | const struct ata_port_info * const * ppi, int n_ports); | |
ecef7253 | 817 | extern int ata_host_start(struct ata_host *host); |
f3187195 TH |
818 | extern int ata_host_register(struct ata_host *host, |
819 | struct scsi_host_template *sht); | |
f5cda257 TH |
820 | extern int ata_host_activate(struct ata_host *host, int irq, |
821 | irq_handler_t irq_handler, unsigned long irq_flags, | |
822 | struct scsi_host_template *sht); | |
0529c159 | 823 | extern void ata_host_detach(struct ata_host *host); |
cca3974e | 824 | extern void ata_host_init(struct ata_host *, struct device *, |
029cfd6b | 825 | unsigned long, struct ata_port_operations *); |
193515d5 | 826 | extern int ata_scsi_detect(struct scsi_host_template *sht); |
1da177e4 LT |
827 | extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); |
828 | extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); | |
80289167 | 829 | extern void ata_sas_port_destroy(struct ata_port *); |
cca3974e | 830 | extern struct ata_port *ata_sas_port_alloc(struct ata_host *, |
80289167 BK |
831 | struct ata_port_info *, struct Scsi_Host *); |
832 | extern int ata_sas_port_init(struct ata_port *); | |
833 | extern int ata_sas_port_start(struct ata_port *ap); | |
834 | extern void ata_sas_port_stop(struct ata_port *ap); | |
835 | extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *); | |
836 | extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), | |
837 | struct ata_port *ap); | |
1da177e4 | 838 | extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); |
936fd732 TH |
839 | extern int sata_scr_valid(struct ata_link *link); |
840 | extern int sata_scr_read(struct ata_link *link, int reg, u32 *val); | |
841 | extern int sata_scr_write(struct ata_link *link, int reg, u32 val); | |
842 | extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val); | |
843 | extern int ata_link_online(struct ata_link *link); | |
844 | extern int ata_link_offline(struct ata_link *link); | |
6ffa01d8 | 845 | #ifdef CONFIG_PM |
cca3974e JG |
846 | extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg); |
847 | extern void ata_host_resume(struct ata_host *host); | |
6ffa01d8 | 848 | #endif |
67846b30 | 849 | extern int ata_ratelimit(void); |
d1adc1bb TH |
850 | extern int ata_busy_sleep(struct ata_port *ap, |
851 | unsigned long timeout_pat, unsigned long timeout); | |
88ff6eaf | 852 | extern void ata_wait_after_reset(struct ata_port *ap, unsigned long deadline); |
d4b2bab4 | 853 | extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline); |
c22daff4 TH |
854 | extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val, |
855 | unsigned long interval_msec, | |
856 | unsigned long timeout_msec); | |
3f19859e TH |
857 | extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present, |
858 | u8 *r_err); | |
67846b30 | 859 | |
1da177e4 LT |
860 | /* |
861 | * Default driver ops implementations | |
862 | */ | |
057ace5e | 863 | extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); |
1da177e4 | 864 | extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf); |
436d34b3 | 865 | extern int atapi_cmd_type(u8 opcode); |
9977126c TH |
866 | extern void ata_tf_to_fis(const struct ata_taskfile *tf, |
867 | u8 pmp, int is_cmd, u8 *fis); | |
057ace5e | 868 | extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); |
7dc951ae TH |
869 | extern unsigned long ata_pack_xfermask(unsigned long pio_mask, |
870 | unsigned long mwdma_mask, unsigned long udma_mask); | |
871 | extern void ata_unpack_xfermask(unsigned long xfer_mask, | |
872 | unsigned long *pio_mask, unsigned long *mwdma_mask, | |
873 | unsigned long *udma_mask); | |
874 | extern u8 ata_xfer_mask2mode(unsigned long xfer_mask); | |
875 | extern unsigned long ata_xfer_mode2mask(u8 xfer_mode); | |
876 | extern int ata_xfer_mode2shift(unsigned long xfer_mode); | |
877 | extern const char *ata_mode_string(unsigned long xfer_mask); | |
878 | extern unsigned long ata_id_xfermask(const u16 *id); | |
2dcb407e JG |
879 | extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device); |
880 | extern void ata_std_dev_select(struct ata_port *ap, unsigned int device); | |
1da177e4 LT |
881 | extern u8 ata_check_status(struct ata_port *ap); |
882 | extern u8 ata_altstatus(struct ata_port *ap); | |
057ace5e | 883 | extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); |
2dcb407e JG |
884 | extern int ata_port_start(struct ata_port *ap); |
885 | extern int ata_sff_port_start(struct ata_port *ap); | |
886 | extern irqreturn_t ata_interrupt(int irq, void *dev_instance); | |
55dba312 TH |
887 | extern unsigned int ata_data_xfer(struct ata_device *dev, |
888 | unsigned char *buf, unsigned int buflen, int rw); | |
889 | extern unsigned int ata_data_xfer_noirq(struct ata_device *dev, | |
890 | unsigned char *buf, unsigned int buflen, int rw); | |
31cc23b3 | 891 | extern int ata_std_qc_defer(struct ata_queued_cmd *qc); |
d26fc955 | 892 | extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc); |
1da177e4 | 893 | extern void ata_qc_prep(struct ata_queued_cmd *qc); |
e46834cd | 894 | extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); |
9a3d9eb0 | 895 | extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc); |
1da177e4 LT |
896 | extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, |
897 | unsigned int n_elem); | |
057ace5e | 898 | extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); |
10305f0f | 899 | extern void ata_dev_disable(struct ata_device *adev); |
6a62a04d TH |
900 | extern void ata_id_string(const u16 *id, unsigned char *s, |
901 | unsigned int ofs, unsigned int len); | |
902 | extern void ata_id_c_string(const u16 *id, unsigned char *s, | |
903 | unsigned int ofs, unsigned int len); | |
2dcb407e JG |
904 | extern void ata_bmdma_setup(struct ata_queued_cmd *qc); |
905 | extern void ata_bmdma_start(struct ata_queued_cmd *qc); | |
b73fc89f | 906 | extern void ata_bmdma_stop(struct ata_queued_cmd *qc); |
1da177e4 LT |
907 | extern u8 ata_bmdma_status(struct ata_port *ap); |
908 | extern void ata_bmdma_irq_clear(struct ata_port *ap); | |
358f9a77 | 909 | extern void ata_noop_irq_clear(struct ata_port *ap); |
6d97dbd7 TH |
910 | extern void ata_bmdma_freeze(struct ata_port *ap); |
911 | extern void ata_bmdma_thaw(struct ata_port *ap); | |
f5914a46 | 912 | extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset, |
6d97dbd7 TH |
913 | ata_reset_fn_t softreset, |
914 | ata_reset_fn_t hardreset, | |
915 | ata_postreset_fn_t postreset); | |
916 | extern void ata_bmdma_error_handler(struct ata_port *ap); | |
917 | extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc); | |
9a1004d0 TH |
918 | extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc, |
919 | u8 status, int in_wq); | |
f686bcb8 | 920 | extern void ata_qc_complete(struct ata_queued_cmd *qc); |
dedaf2b0 TH |
921 | extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active, |
922 | void (*finish_qc)(struct ata_queued_cmd *)); | |
3373efd8 | 923 | extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd, |
1da177e4 LT |
924 | void (*done)(struct scsi_cmnd *)); |
925 | extern int ata_std_bios_param(struct scsi_device *sdev, | |
926 | struct block_device *bdev, | |
927 | sector_t capacity, int geom[]); | |
928 | extern int ata_scsi_slave_config(struct scsi_device *sdev); | |
83c47bcb | 929 | extern void ata_scsi_slave_destroy(struct scsi_device *sdev); |
a6e6ce8e TH |
930 | extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, |
931 | int queue_depth); | |
3373efd8 | 932 | extern struct ata_device *ata_dev_pair(struct ata_device *adev); |
0260731f | 933 | extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev); |
83625006 | 934 | extern u8 ata_irq_on(struct ata_port *ap); |
1da177e4 | 935 | |
be0d18df AC |
936 | extern int ata_cable_40wire(struct ata_port *ap); |
937 | extern int ata_cable_80wire(struct ata_port *ap); | |
938 | extern int ata_cable_sata(struct ata_port *ap); | |
c88f90c3 | 939 | extern int ata_cable_ignore(struct ata_port *ap); |
be0d18df AC |
940 | extern int ata_cable_unknown(struct ata_port *ap); |
941 | ||
452503f9 AC |
942 | /* |
943 | * Timing helpers | |
944 | */ | |
1bc4ccff AC |
945 | |
946 | extern unsigned int ata_pio_need_iordy(const struct ata_device *); | |
6357357c | 947 | extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode); |
452503f9 AC |
948 | extern int ata_timing_compute(struct ata_device *, unsigned short, |
949 | struct ata_timing *, int, int); | |
950 | extern void ata_timing_merge(const struct ata_timing *, | |
951 | const struct ata_timing *, struct ata_timing *, | |
952 | unsigned int); | |
a0f79b92 | 953 | extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle); |
452503f9 AC |
954 | |
955 | enum { | |
956 | ATA_TIMING_SETUP = (1 << 0), | |
957 | ATA_TIMING_ACT8B = (1 << 1), | |
958 | ATA_TIMING_REC8B = (1 << 2), | |
959 | ATA_TIMING_CYC8B = (1 << 3), | |
960 | ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | | |
961 | ATA_TIMING_CYC8B, | |
962 | ATA_TIMING_ACTIVE = (1 << 4), | |
963 | ATA_TIMING_RECOVER = (1 << 5), | |
964 | ATA_TIMING_CYCLE = (1 << 6), | |
965 | ATA_TIMING_UDMA = (1 << 7), | |
966 | ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | | |
967 | ATA_TIMING_REC8B | ATA_TIMING_CYC8B | | |
968 | ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | | |
969 | ATA_TIMING_CYCLE | ATA_TIMING_UDMA, | |
970 | }; | |
971 | ||
e1ddb4b6 AC |
972 | /* libata-acpi.c */ |
973 | #ifdef CONFIG_ATA_ACPI | |
c05e6ff0 TH |
974 | static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) |
975 | { | |
976 | if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID) | |
977 | return &ap->__acpi_init_gtm; | |
978 | return NULL; | |
979 | } | |
0d02f0b2 TH |
980 | int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm); |
981 | int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm); | |
7c77fa4d TH |
982 | unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev, |
983 | const struct ata_acpi_gtm *gtm); | |
021ee9a6 | 984 | int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm); |
e1ddb4b6 | 985 | #else |
c05e6ff0 TH |
986 | static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap) |
987 | { | |
988 | return NULL; | |
989 | } | |
7c77fa4d TH |
990 | |
991 | static inline int ata_acpi_stm(const struct ata_port *ap, | |
992 | struct ata_acpi_gtm *stm) | |
993 | { | |
994 | return -ENOSYS; | |
995 | } | |
996 | ||
997 | static inline int ata_acpi_gtm(const struct ata_port *ap, | |
998 | struct ata_acpi_gtm *stm) | |
999 | { | |
1000 | return -ENOSYS; | |
1001 | } | |
1002 | ||
1003 | static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev, | |
1004 | const struct ata_acpi_gtm *gtm) | |
1005 | { | |
1006 | return 0; | |
1007 | } | |
021ee9a6 TH |
1008 | |
1009 | static inline int ata_acpi_cbl_80wire(struct ata_port *ap, | |
1010 | const struct ata_acpi_gtm *gtm) | |
1011 | { | |
1012 | return 0; | |
1013 | } | |
e1ddb4b6 | 1014 | #endif |
1da177e4 LT |
1015 | |
1016 | #ifdef CONFIG_PCI | |
2855568b JG |
1017 | struct pci_dev; |
1018 | ||
2dcb407e | 1019 | extern int ata_pci_init_one(struct pci_dev *pdev, |
1bd5b715 | 1020 | const struct ata_port_info * const * ppi, |
887125e3 | 1021 | struct scsi_host_template *sht, void *host_priv); |
2dcb407e | 1022 | extern void ata_pci_remove_one(struct pci_dev *pdev); |
2855568b JG |
1023 | #ifdef CONFIG_PM |
1024 | extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg); | |
1025 | extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev); | |
1026 | extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg); | |
1027 | extern int ata_pci_device_resume(struct pci_dev *pdev); | |
1028 | #endif | |
1029 | extern int ata_pci_clear_simplex(struct pci_dev *pdev); | |
1030 | ||
1da177e4 LT |
1031 | struct pci_bits { |
1032 | unsigned int reg; /* PCI config register to read */ | |
1033 | unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ | |
1034 | unsigned long mask; | |
1035 | unsigned long val; | |
1036 | }; | |
1037 | ||
d583bc18 | 1038 | extern int ata_pci_init_sff_host(struct ata_host *host); |
1626aeb8 | 1039 | extern int ata_pci_init_bmdma(struct ata_host *host); |
d583bc18 TH |
1040 | extern int ata_pci_prepare_sff_host(struct pci_dev *pdev, |
1041 | const struct ata_port_info * const * ppi, | |
1042 | struct ata_host **r_host); | |
4e6b79fa TH |
1043 | extern int ata_pci_activate_sff_host(struct ata_host *host, |
1044 | irq_handler_t irq_handler, | |
1045 | struct scsi_host_template *sht); | |
057ace5e | 1046 | extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); |
7dc951ae TH |
1047 | extern unsigned long ata_pci_default_filter(struct ata_device *dev, |
1048 | unsigned long xfer_mask); | |
1da177e4 LT |
1049 | #endif /* CONFIG_PCI */ |
1050 | ||
3af9a77a TH |
1051 | /* |
1052 | * PMP | |
1053 | */ | |
31f88384 | 1054 | extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc); |
3af9a77a TH |
1055 | extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline); |
1056 | extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class, | |
1057 | unsigned long deadline); | |
1058 | extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class); | |
1059 | extern void sata_pmp_do_eh(struct ata_port *ap, | |
1060 | ata_prereset_fn_t prereset, ata_reset_fn_t softreset, | |
1061 | ata_reset_fn_t hardreset, ata_postreset_fn_t postreset, | |
1062 | ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset, | |
1063 | ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset); | |
1064 | ||
ece1d636 TH |
1065 | /* |
1066 | * EH | |
1067 | */ | |
7b70fc03 | 1068 | extern void ata_port_schedule_eh(struct ata_port *ap); |
dbd82616 | 1069 | extern int ata_link_abort(struct ata_link *link); |
7b70fc03 | 1070 | extern int ata_port_abort(struct ata_port *ap); |
e3180499 | 1071 | extern int ata_port_freeze(struct ata_port *ap); |
7d77b247 | 1072 | extern int sata_async_notification(struct ata_port *ap); |
e3180499 TH |
1073 | |
1074 | extern void ata_eh_freeze_port(struct ata_port *ap); | |
1075 | extern void ata_eh_thaw_port(struct ata_port *ap); | |
7b70fc03 | 1076 | |
ece1d636 TH |
1077 | extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); |
1078 | extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); | |
1079 | ||
f5914a46 TH |
1080 | extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset, |
1081 | ata_reset_fn_t softreset, ata_reset_fn_t hardreset, | |
1082 | ata_postreset_fn_t postreset); | |
022bdb07 | 1083 | |
68d1d07b TH |
1084 | /* |
1085 | * Base operations to inherit from and initializers for sht | |
1086 | * | |
1087 | * Operations | |
1088 | * | |
1089 | * base : Common to all libata drivers. | |
1090 | * sata : SATA controllers w/ native interface. | |
1091 | * pmp : SATA controllers w/ PMP support. | |
1092 | * sff : SFF ATA controllers w/o BMDMA support. | |
1093 | * bmdma : SFF ATA controllers w/ BMDMA support. | |
1094 | * | |
1095 | * sht initializers | |
1096 | * | |
1097 | * BASE : Common to all libata drivers. The user must set | |
1098 | * sg_tablesize and dma_boundary. | |
1099 | * PIO : SFF ATA controllers w/ only PIO support. | |
1100 | * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and | |
1101 | * dma_boundary are set to BMDMA limits. | |
1102 | * NCQ : SATA controllers supporting NCQ. The user must set | |
1103 | * sg_tablesize, dma_boundary and can_queue. | |
1104 | */ | |
1105 | extern const struct ata_port_operations ata_base_port_ops; | |
1106 | extern const struct ata_port_operations sata_port_ops; | |
1107 | extern const struct ata_port_operations sata_pmp_port_ops; | |
1108 | extern const struct ata_port_operations ata_sff_port_ops; | |
1109 | extern const struct ata_port_operations ata_bmdma_port_ops; | |
1110 | ||
1111 | #define ATA_BASE_SHT(drv_name) \ | |
1112 | .module = THIS_MODULE, \ | |
1113 | .name = drv_name, \ | |
1114 | .ioctl = ata_scsi_ioctl, \ | |
1115 | .queuecommand = ata_scsi_queuecmd, \ | |
1116 | .can_queue = ATA_DEF_QUEUE, \ | |
1117 | .this_id = ATA_SHT_THIS_ID, \ | |
1118 | .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \ | |
1119 | .emulated = ATA_SHT_EMULATED, \ | |
1120 | .use_clustering = ATA_SHT_USE_CLUSTERING, \ | |
1121 | .proc_name = drv_name, \ | |
1122 | .slave_configure = ata_scsi_slave_config, \ | |
1123 | .slave_destroy = ata_scsi_slave_destroy, \ | |
1124 | .bios_param = ata_std_bios_param | |
1125 | ||
1126 | /* PIO only, sg_tablesize and dma_boundary limits can be removed */ | |
1127 | #define ATA_PIO_SHT(drv_name) \ | |
1128 | ATA_BASE_SHT(drv_name), \ | |
1129 | .sg_tablesize = LIBATA_MAX_PRD, \ | |
1130 | .dma_boundary = ATA_DMA_BOUNDARY | |
1131 | ||
1132 | #define ATA_BMDMA_SHT(drv_name) \ | |
1133 | ATA_BASE_SHT(drv_name), \ | |
1134 | .sg_tablesize = LIBATA_MAX_PRD, \ | |
1135 | .dma_boundary = ATA_DMA_BOUNDARY | |
1136 | ||
1137 | #define ATA_NCQ_SHT(drv_name) \ | |
1138 | ATA_BASE_SHT(drv_name), \ | |
1139 | .change_queue_depth = ata_scsi_change_queue_depth | |
1140 | ||
61440db6 TH |
1141 | /* |
1142 | * printk helpers | |
1143 | */ | |
1144 | #define ata_port_printk(ap, lv, fmt, args...) \ | |
c2e366a1 | 1145 | printk("%sata%u: "fmt, lv, (ap)->print_id , ##args) |
61440db6 | 1146 | |
8989805d TH |
1147 | #define ata_link_printk(link, lv, fmt, args...) do { \ |
1148 | if ((link)->ap->nr_pmp_links) \ | |
c2e366a1 | 1149 | printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \ |
8989805d TH |
1150 | (link)->pmp , ##args); \ |
1151 | else \ | |
c2e366a1 | 1152 | printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \ |
8989805d | 1153 | } while(0) |
9af5c9c9 | 1154 | |
61440db6 | 1155 | #define ata_dev_printk(dev, lv, fmt, args...) \ |
c2e366a1 | 1156 | printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \ |
8989805d | 1157 | (dev)->link->pmp + (dev)->devno , ##args) |
1da177e4 | 1158 | |
f3e81b19 TH |
1159 | /* |
1160 | * ata_eh_info helpers | |
1161 | */ | |
cb94c1cf TH |
1162 | extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) |
1163 | __attribute__ ((format (printf, 2, 3))); | |
1164 | extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...) | |
1165 | __attribute__ ((format (printf, 2, 3))); | |
b64bbc39 | 1166 | extern void ata_ehi_clear_desc(struct ata_eh_info *ehi); |
f3e81b19 | 1167 | |
c0b6c037 TH |
1168 | static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi) |
1169 | { | |
b558eddd | 1170 | ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1; |
f8f1e1cc | 1171 | ehi->flags |= ATA_EHI_HOTPLUGGED; |
b558eddd | 1172 | ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK; |
c0b6c037 TH |
1173 | ehi->err_mask |= AC_ERR_ATA_BUS; |
1174 | } | |
1175 | ||
cbcdd875 TH |
1176 | /* |
1177 | * port description helpers | |
1178 | */ | |
1179 | extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...) | |
1180 | __attribute__ ((format (printf, 2, 3))); | |
1181 | #ifdef CONFIG_PCI | |
1182 | extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset, | |
1183 | const char *name); | |
1184 | #endif | |
1185 | ||
1da177e4 LT |
1186 | static inline unsigned int ata_tag_valid(unsigned int tag) |
1187 | { | |
1188 | return (tag < ATA_MAX_QUEUE) ? 1 : 0; | |
1189 | } | |
1190 | ||
2ab7db1f TH |
1191 | static inline unsigned int ata_tag_internal(unsigned int tag) |
1192 | { | |
1193 | return tag == ATA_MAX_QUEUE - 1; | |
1194 | } | |
1195 | ||
5806db22 TH |
1196 | /* |
1197 | * device helpers | |
1198 | */ | |
e1211e3f | 1199 | static inline unsigned int ata_class_enabled(unsigned int class) |
597afd21 | 1200 | { |
e0a71752 TH |
1201 | return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI || |
1202 | class == ATA_DEV_PMP || class == ATA_DEV_SEMB; | |
597afd21 TH |
1203 | } |
1204 | ||
e1211e3f | 1205 | static inline unsigned int ata_class_disabled(unsigned int class) |
1da177e4 | 1206 | { |
e0a71752 TH |
1207 | return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP || |
1208 | class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP; | |
e1211e3f TH |
1209 | } |
1210 | ||
002c8054 TH |
1211 | static inline unsigned int ata_class_absent(unsigned int class) |
1212 | { | |
1213 | return !ata_class_enabled(class) && !ata_class_disabled(class); | |
1214 | } | |
1215 | ||
e1211e3f TH |
1216 | static inline unsigned int ata_dev_enabled(const struct ata_device *dev) |
1217 | { | |
1218 | return ata_class_enabled(dev->class); | |
1219 | } | |
1220 | ||
1221 | static inline unsigned int ata_dev_disabled(const struct ata_device *dev) | |
1222 | { | |
1223 | return ata_class_disabled(dev->class); | |
1da177e4 LT |
1224 | } |
1225 | ||
002c8054 TH |
1226 | static inline unsigned int ata_dev_absent(const struct ata_device *dev) |
1227 | { | |
1228 | return ata_class_absent(dev->class); | |
1229 | } | |
1230 | ||
5806db22 | 1231 | /* |
f58229f8 | 1232 | * link helpers |
5806db22 | 1233 | */ |
8989805d TH |
1234 | static inline int ata_is_host_link(const struct ata_link *link) |
1235 | { | |
1236 | return link == &link->ap->link; | |
1237 | } | |
1238 | ||
f58229f8 | 1239 | static inline int ata_link_max_devices(const struct ata_link *link) |
5806db22 | 1240 | { |
8989805d | 1241 | if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS) |
5806db22 TH |
1242 | return 2; |
1243 | return 1; | |
1244 | } | |
1245 | ||
da917d69 TH |
1246 | static inline int ata_link_active(struct ata_link *link) |
1247 | { | |
1248 | return ata_tag_valid(link->active_tag) || link->sactive; | |
1249 | } | |
1250 | ||
8989805d TH |
1251 | static inline struct ata_link *ata_port_first_link(struct ata_port *ap) |
1252 | { | |
1253 | if (ap->nr_pmp_links) | |
1254 | return ap->pmp_link; | |
1255 | return &ap->link; | |
1256 | } | |
1257 | ||
1258 | static inline struct ata_link *ata_port_next_link(struct ata_link *link) | |
1259 | { | |
1260 | struct ata_port *ap = link->ap; | |
1261 | ||
1262 | if (link == &ap->link) { | |
1263 | if (!ap->nr_pmp_links) | |
1264 | return NULL; | |
1265 | return ap->pmp_link; | |
1266 | } | |
1267 | ||
5d44b414 | 1268 | if (++link < ap->nr_pmp_links + ap->pmp_link) |
8989805d TH |
1269 | return link; |
1270 | return NULL; | |
1271 | } | |
1272 | ||
1273 | #define __ata_port_for_each_link(lk, ap) \ | |
1274 | for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk)) | |
1275 | ||
1276 | #define ata_port_for_each_link(link, ap) \ | |
1277 | for ((link) = ata_port_first_link(ap); (link); \ | |
1278 | (link) = ata_port_next_link(link)) | |
f58229f8 TH |
1279 | |
1280 | #define ata_link_for_each_dev(dev, link) \ | |
1281 | for ((dev) = (link)->device; \ | |
1282 | (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \ | |
1283 | (dev)++) | |
1284 | ||
1285 | #define ata_link_for_each_dev_reverse(dev, link) \ | |
1286 | for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \ | |
1287 | (dev) >= (link)->device || ((dev) = NULL); (dev)--) | |
5806db22 | 1288 | |
1da177e4 LT |
1289 | static inline u8 ata_chk_status(struct ata_port *ap) |
1290 | { | |
1291 | return ap->ops->check_status(ap); | |
1292 | } | |
1293 | ||
6d1245bf TH |
1294 | /** |
1295 | * ata_ncq_enabled - Test whether NCQ is enabled | |
1296 | * @dev: ATA device to test for | |
1297 | * | |
1298 | * LOCKING: | |
1299 | * spin_lock_irqsave(host lock) | |
1300 | * | |
1301 | * RETURNS: | |
1302 | * 1 if NCQ is enabled for @dev, 0 otherwise. | |
1303 | */ | |
1304 | static inline int ata_ncq_enabled(struct ata_device *dev) | |
1305 | { | |
1306 | return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF | | |
1307 | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ; | |
1308 | } | |
0baab86b EF |
1309 | |
1310 | /** | |
1311 | * ata_pause - Flush writes and pause 400 nanoseconds. | |
1312 | * @ap: Port to wait for. | |
1313 | * | |
1314 | * LOCKING: | |
1315 | * Inherited from caller. | |
1316 | */ | |
1317 | ||
1da177e4 LT |
1318 | static inline void ata_pause(struct ata_port *ap) |
1319 | { | |
1320 | ata_altstatus(ap); | |
1321 | ndelay(400); | |
1322 | } | |
1323 | ||
0baab86b EF |
1324 | |
1325 | /** | |
1326 | * ata_busy_wait - Wait for a port status register | |
1327 | * @ap: Port to wait for. | |
0777721c A |
1328 | * @bits: bits that must be clear |
1329 | * @max: number of 10uS waits to perform | |
0baab86b EF |
1330 | * |
1331 | * Waits up to max*10 microseconds for the selected bits in the port's | |
1332 | * status register to be cleared. | |
1333 | * Returns final value of status register. | |
1334 | * | |
1335 | * LOCKING: | |
1336 | * Inherited from caller. | |
1337 | */ | |
1338 | ||
1da177e4 LT |
1339 | static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, |
1340 | unsigned int max) | |
1341 | { | |
1342 | u8 status; | |
1343 | ||
1344 | do { | |
1345 | udelay(10); | |
1346 | status = ata_chk_status(ap); | |
1347 | max--; | |
d1adc1bb | 1348 | } while (status != 0xff && (status & bits) && (max > 0)); |
1da177e4 LT |
1349 | |
1350 | return status; | |
1351 | } | |
1352 | ||
0baab86b EF |
1353 | |
1354 | /** | |
1355 | * ata_wait_idle - Wait for a port to be idle. | |
1356 | * @ap: Port to wait for. | |
1357 | * | |
1358 | * Waits up to 10ms for port's BUSY and DRQ signals to clear. | |
1359 | * Returns final value of status register. | |
1360 | * | |
1361 | * LOCKING: | |
1362 | * Inherited from caller. | |
1363 | */ | |
1364 | ||
1da177e4 LT |
1365 | static inline u8 ata_wait_idle(struct ata_port *ap) |
1366 | { | |
1367 | u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); | |
1368 | ||
15529456 | 1369 | #ifdef ATA_DEBUG |
55f3952d | 1370 | if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) |
15529456 TH |
1371 | ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n", |
1372 | status); | |
1373 | #endif | |
1da177e4 LT |
1374 | |
1375 | return status; | |
1376 | } | |
1377 | ||
1378 | static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) | |
1379 | { | |
1380 | qc->tf.ctl |= ATA_NIEN; | |
1381 | } | |
1382 | ||
f69499f4 TH |
1383 | static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, |
1384 | unsigned int tag) | |
1da177e4 LT |
1385 | { |
1386 | if (likely(ata_tag_valid(tag))) | |
1387 | return &ap->qcmd[tag]; | |
1388 | return NULL; | |
1389 | } | |
1390 | ||
f69499f4 TH |
1391 | static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, |
1392 | unsigned int tag) | |
1393 | { | |
1394 | struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); | |
1395 | ||
1396 | if (unlikely(!qc) || !ap->ops->error_handler) | |
1397 | return qc; | |
1398 | ||
1399 | if ((qc->flags & (ATA_QCFLAG_ACTIVE | | |
1400 | ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) | |
1401 | return qc; | |
1402 | ||
1403 | return NULL; | |
1404 | } | |
1405 | ||
aacda375 TH |
1406 | static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc) |
1407 | { | |
1408 | return qc->nbytes - min(qc->extrabytes, qc->nbytes); | |
1409 | } | |
1410 | ||
3373efd8 | 1411 | static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) |
1da177e4 LT |
1412 | { |
1413 | memset(tf, 0, sizeof(*tf)); | |
1414 | ||
9af5c9c9 | 1415 | tf->ctl = dev->link->ap->ctl; |
3373efd8 | 1416 | if (dev->devno == 0) |
1da177e4 LT |
1417 | tf->device = ATA_DEVICE_OBS; |
1418 | else | |
1419 | tf->device = ATA_DEVICE_OBS | ATA_DEV1; | |
1420 | } | |
1421 | ||
2c13b7ce JG |
1422 | static inline void ata_qc_reinit(struct ata_queued_cmd *qc) |
1423 | { | |
501e0c50 | 1424 | qc->dma_dir = DMA_NONE; |
ff2aeb1e | 1425 | qc->sg = NULL; |
2c13b7ce | 1426 | qc->flags = 0; |
87260216 JA |
1427 | qc->cursg = NULL; |
1428 | qc->cursg_ofs = 0; | |
aacda375 | 1429 | qc->nbytes = qc->extrabytes = qc->curbytes = 0; |
7a801184 | 1430 | qc->n_elem = 0; |
a22e2eb0 | 1431 | qc->err_mask = 0; |
5a5dbd18 | 1432 | qc->sect_size = ATA_SECT_SIZE; |
2c13b7ce | 1433 | |
3373efd8 | 1434 | ata_tf_init(qc->dev, &qc->tf); |
e61e0672 TH |
1435 | |
1436 | /* init result_tf such that it indicates normal completion */ | |
1437 | qc->result_tf.command = ATA_DRDY; | |
1438 | qc->result_tf.feature = 0; | |
2c13b7ce JG |
1439 | } |
1440 | ||
057ace5e | 1441 | static inline int ata_try_flush_cache(const struct ata_device *dev) |
1da177e4 LT |
1442 | { |
1443 | return ata_id_wcache_enabled(dev->id) || | |
1444 | ata_id_has_flush(dev->id) || | |
1445 | ata_id_has_flush_ext(dev->id); | |
1446 | } | |
1447 | ||
a7dac447 JG |
1448 | static inline unsigned int ac_err_mask(u8 status) |
1449 | { | |
3655d1d3 | 1450 | if (status & (ATA_BUSY | ATA_DRQ)) |
11a56d24 | 1451 | return AC_ERR_HSM; |
a7dac447 JG |
1452 | if (status & (ATA_ERR | ATA_DF)) |
1453 | return AC_ERR_DEV; | |
1454 | return 0; | |
1455 | } | |
1456 | ||
1457 | static inline unsigned int __ac_err_mask(u8 status) | |
1458 | { | |
1459 | unsigned int mask = ac_err_mask(status); | |
1460 | if (mask == 0) | |
1461 | return AC_ERR_OTHER; | |
1462 | return mask; | |
1463 | } | |
1464 | ||
35bb94b1 JG |
1465 | static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host) |
1466 | { | |
4911487a | 1467 | return *(struct ata_port **)&host->hostdata[0]; |
35bb94b1 JG |
1468 | } |
1469 | ||
1da177e4 | 1470 | #endif /* __LINUX_LIBATA_H__ */ |