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