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> | |
31 | #include <linux/pci.h> | |
1c72d8d9 | 32 | #include <linux/dma-mapping.h> |
41542dbe | 33 | #include <asm/scatterlist.h> |
1da177e4 LT |
34 | #include <asm/io.h> |
35 | #include <linux/ata.h> | |
36 | #include <linux/workqueue.h> | |
35bb94b1 | 37 | #include <scsi/scsi_host.h> |
1da177e4 | 38 | |
a6d967a4 JG |
39 | /* |
40 | * Define if arch has non-standard setup. This is a _PCI_ standard | |
41 | * not a legacy or ISA standard. | |
42 | */ | |
43 | #ifdef CONFIG_ATA_NONSTANDARD | |
2ec7df04 | 44 | #include <asm/libata-portmap.h> |
a6d967a4 JG |
45 | #else |
46 | #include <asm-generic/libata-portmap.h> | |
47 | #endif | |
2ec7df04 | 48 | |
1da177e4 | 49 | /* |
bfd60579 RD |
50 | * compile-time options: to be removed as soon as all the drivers are |
51 | * converted to the new debugging mechanism | |
1da177e4 LT |
52 | */ |
53 | #undef ATA_DEBUG /* debugging output */ | |
54 | #undef ATA_VERBOSE_DEBUG /* yet more debugging output */ | |
55 | #undef ATA_IRQ_TRAP /* define to ack screaming irqs */ | |
56 | #undef ATA_NDEBUG /* define to disable quick runtime checks */ | |
669a5db4 | 57 | #define ATA_ENABLE_PATA /* define to enable PATA support in some |
1da177e4 | 58 | * low-level drivers */ |
1da177e4 LT |
59 | |
60 | ||
61 | /* note: prints function name for you */ | |
62 | #ifdef ATA_DEBUG | |
63 | #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) | |
64 | #ifdef ATA_VERBOSE_DEBUG | |
65 | #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) | |
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 | ||
2c13b7ce JG |
74 | #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) |
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 | ||
111 | /* move to PCI layer? */ | |
54bb3a94 JG |
112 | #define PCI_VDEVICE(vendor, device) \ |
113 | PCI_VENDOR_ID_##vendor, (device), \ | |
114 | PCI_ANY_ID, PCI_ANY_ID, 0, 0 | |
115 | ||
1da177e4 LT |
116 | static inline struct device *pci_dev_to_dev(struct pci_dev *pdev) |
117 | { | |
118 | return &pdev->dev; | |
119 | } | |
120 | ||
121 | enum { | |
122 | /* various global constants */ | |
123 | LIBATA_MAX_PRD = ATA_MAX_PRD / 2, | |
124 | ATA_MAX_PORTS = 8, | |
125 | ATA_DEF_QUEUE = 1, | |
2ab7db1f | 126 | /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ |
a6e6ce8e | 127 | ATA_MAX_QUEUE = 32, |
2ab7db1f | 128 | ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, |
1da177e4 LT |
129 | ATA_MAX_BUS = 2, |
130 | ATA_DEF_BUSY_WAIT = 10000, | |
131 | ATA_SHORT_PAUSE = (HZ >> 6) + 1, | |
132 | ||
133 | ATA_SHT_EMULATED = 1, | |
134 | ATA_SHT_CMD_PER_LUN = 1, | |
135 | ATA_SHT_THIS_ID = -1, | |
cf482935 | 136 | ATA_SHT_USE_CLUSTERING = 1, |
1da177e4 LT |
137 | |
138 | /* struct ata_device stuff */ | |
949b38af TH |
139 | ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */ |
140 | ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */ | |
029f5468 | 141 | ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */ |
88e49034 | 142 | ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */ |
ea1dd4e1 | 143 | ATA_DFLAG_CFG_MASK = (1 << 8) - 1, |
949b38af | 144 | |
e5c9e081 | 145 | ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */ |
3343571d | 146 | ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */ |
e5c9e081 | 147 | ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */ |
72fa4b74 | 148 | ATA_DFLAG_INIT_MASK = (1 << 16) - 1, |
1da177e4 | 149 | |
abdda733 TH |
150 | ATA_DFLAG_DETACH = (1 << 16), |
151 | ATA_DFLAG_DETACHED = (1 << 17), | |
152 | ||
1da177e4 LT |
153 | ATA_DEV_UNKNOWN = 0, /* unknown device */ |
154 | ATA_DEV_ATA = 1, /* ATA device */ | |
155 | ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ | |
156 | ATA_DEV_ATAPI = 3, /* ATAPI device */ | |
157 | ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ | |
158 | ATA_DEV_NONE = 5, /* no device */ | |
159 | ||
160 | /* struct ata_port flags */ | |
949b38af | 161 | ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ |
1da177e4 | 162 | /* (doesn't imply presence) */ |
949b38af TH |
163 | ATA_FLAG_SATA = (1 << 1), |
164 | ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */ | |
165 | ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */ | |
166 | ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */ | |
167 | ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */ | |
168 | ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ | |
169 | ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ | |
170 | ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ | |
7395acb2 TH |
171 | ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD |
172 | * doesn't handle PIO interrupts */ | |
173 | ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */ | |
abdda733 TH |
174 | ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */ |
175 | ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H | |
176 | * Register FIS clearing BSY */ | |
7395acb2 | 177 | ATA_FLAG_DEBUGMSG = (1 << 13), |
949b38af | 178 | |
b51e9e5d TH |
179 | /* The following flag belongs to ap->pflags but is kept in |
180 | * ap->flags because it's referenced in many LLDs and will be | |
181 | * removed in not-too-distant future. | |
182 | */ | |
183 | ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */ | |
184 | ||
185 | /* bits 24:31 of ap->flags are reserved for LLD specific flags */ | |
9ec957f2 | 186 | |
b51e9e5d TH |
187 | /* struct ata_port pflags */ |
188 | ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */ | |
189 | ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */ | |
190 | ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */ | |
191 | ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */ | |
192 | ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */ | |
193 | ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */ | |
194 | ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */ | |
949b38af | 195 | |
b51e9e5d TH |
196 | ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */ |
197 | ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */ | |
500530f6 | 198 | ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */ |
949b38af TH |
199 | |
200 | /* struct ata_queued_cmd flags */ | |
201 | ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ | |
202 | ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */ | |
203 | ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */ | |
1da177e4 | 204 | ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE, |
27197367 | 205 | ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ |
e61e0672 TH |
206 | ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ |
207 | ||
9ec957f2 TH |
208 | ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ |
209 | ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ | |
210 | ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ | |
1da177e4 | 211 | |
4e5ec5db | 212 | /* host set flags */ |
cca3974e | 213 | ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */ |
9bec2e38 | 214 | |
1da177e4 | 215 | /* various lengths of time */ |
8d238e01 AC |
216 | ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */ |
217 | ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */ | |
a2a7a662 TH |
218 | ATA_TMOUT_INTERNAL = 30 * HZ, |
219 | ATA_TMOUT_INTERNAL_QUICK = 5 * HZ, | |
1da177e4 LT |
220 | |
221 | /* ATA bus states */ | |
222 | BUS_UNKNOWN = 0, | |
223 | BUS_DMA = 1, | |
224 | BUS_IDLE = 2, | |
225 | BUS_NOINTR = 3, | |
226 | BUS_NODATA = 4, | |
227 | BUS_TIMER = 5, | |
228 | BUS_PIO = 6, | |
229 | BUS_EDD = 7, | |
230 | BUS_IDENTIFY = 8, | |
231 | BUS_PACKET = 9, | |
232 | ||
233 | /* SATA port states */ | |
234 | PORT_UNKNOWN = 0, | |
235 | PORT_ENABLED = 1, | |
236 | PORT_DISABLED = 2, | |
237 | ||
238 | /* encoding various smaller bitmaps into a single | |
1da7b0d0 | 239 | * unsigned int bitmap |
1da177e4 | 240 | */ |
b352e57d AC |
241 | ATA_BITS_PIO = 7, |
242 | ATA_BITS_MWDMA = 5, | |
1da7b0d0 TH |
243 | ATA_BITS_UDMA = 8, |
244 | ||
245 | ATA_SHIFT_PIO = 0, | |
246 | ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO, | |
247 | ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA, | |
248 | ||
249 | ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO, | |
250 | ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA, | |
251 | ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA, | |
cedc9a47 JG |
252 | |
253 | /* size of buffer to pad xfers ending on unaligned boundaries */ | |
254 | ATA_DMA_PAD_SZ = 4, | |
255 | ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE, | |
949b38af TH |
256 | |
257 | /* masks for port functions */ | |
47a86593 AC |
258 | ATA_PORT_PRIMARY = (1 << 0), |
259 | ATA_PORT_SECONDARY = (1 << 1), | |
14d2bac1 | 260 | |
0c247c55 TH |
261 | /* ering size */ |
262 | ATA_ERING_SIZE = 32, | |
263 | ||
f3e81b19 TH |
264 | /* desc_len for ata_eh_info and context */ |
265 | ATA_EH_DESC_LEN = 80, | |
266 | ||
9be1e979 TH |
267 | /* reset / recovery action types */ |
268 | ATA_EH_REVALIDATE = (1 << 0), | |
269 | ATA_EH_SOFTRESET = (1 << 1), | |
270 | ATA_EH_HARDRESET = (1 << 2), | |
02670bf3 TH |
271 | ATA_EH_SUSPEND = (1 << 3), |
272 | ATA_EH_RESUME = (1 << 4), | |
273 | ATA_EH_PM_FREEZE = (1 << 5), | |
9be1e979 TH |
274 | |
275 | ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, | |
02670bf3 TH |
276 | ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND | |
277 | ATA_EH_RESUME | ATA_EH_PM_FREEZE, | |
9be1e979 | 278 | |
f3e81b19 | 279 | /* ata_eh_info->flags */ |
abdda733 | 280 | ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */ |
13abf50d | 281 | ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */ |
1cdaf534 TH |
282 | ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */ |
283 | ATA_EHI_QUIET = (1 << 3), /* be quiet */ | |
abdda733 TH |
284 | |
285 | ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */ | |
efdaedc4 | 286 | ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */ |
f3e81b19 | 287 | |
13abf50d TH |
288 | ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK, |
289 | ||
ad9e2762 TH |
290 | /* max repeat if error condition is still set after ->error_handler */ |
291 | ATA_EH_MAX_REPEAT = 5, | |
292 | ||
14d2bac1 TH |
293 | /* how hard are we gonna try to probe/recover devices */ |
294 | ATA_PROBE_MAX_TRIES = 3, | |
022bdb07 TH |
295 | ATA_EH_RESET_TRIES = 3, |
296 | ATA_EH_DEV_TRIES = 3, | |
f5914a46 TH |
297 | |
298 | /* Drive spinup time (time from power-on to the first D2H FIS) | |
299 | * in msecs - 8s currently. Failing to get ready in this time | |
300 | * isn't critical. It will result in reset failure for | |
301 | * controllers which can't wait for the first D2H FIS. libata | |
302 | * will retry, so it just has to be long enough to spin up | |
303 | * most devices. | |
304 | */ | |
305 | ATA_SPINUP_WAIT = 8000, | |
93590859 AC |
306 | |
307 | /* Horkage types. May be set by libata or controller on drives | |
308 | (some horkage may be drive/controller pair dependant */ | |
309 | ||
310 | ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */ | |
6919a0a6 AC |
311 | ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */ |
312 | ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */ | |
1da177e4 LT |
313 | }; |
314 | ||
14be71f4 | 315 | enum hsm_task_states { |
c56b14d2 AL |
316 | HSM_ST_UNKNOWN, /* state unknown */ |
317 | HSM_ST_IDLE, /* no command on going */ | |
c56b14d2 AL |
318 | HSM_ST, /* (waiting the device to) transfer data */ |
319 | HSM_ST_LAST, /* (waiting the device to) complete command */ | |
c56b14d2 AL |
320 | HSM_ST_ERR, /* error */ |
321 | HSM_ST_FIRST, /* (waiting the device to) | |
322 | write CDB or first data block */ | |
1da177e4 LT |
323 | }; |
324 | ||
a7dac447 | 325 | enum ata_completion_errors { |
11a56d24 TH |
326 | AC_ERR_DEV = (1 << 0), /* device reported error */ |
327 | AC_ERR_HSM = (1 << 1), /* host state machine violation */ | |
328 | AC_ERR_TIMEOUT = (1 << 2), /* timeout */ | |
329 | AC_ERR_MEDIA = (1 << 3), /* media error */ | |
330 | AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ | |
331 | AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ | |
332 | AC_ERR_SYSTEM = (1 << 6), /* system error */ | |
333 | AC_ERR_INVALID = (1 << 7), /* invalid argument */ | |
334 | AC_ERR_OTHER = (1 << 8), /* unknown */ | |
a7dac447 JG |
335 | }; |
336 | ||
1da177e4 LT |
337 | /* forward declarations */ |
338 | struct scsi_device; | |
339 | struct ata_port_operations; | |
340 | struct ata_port; | |
341 | struct ata_queued_cmd; | |
342 | ||
343 | /* typedefs */ | |
77853bf2 | 344 | typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); |
f5914a46 TH |
345 | typedef int (*ata_prereset_fn_t)(struct ata_port *ap); |
346 | typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes); | |
347 | typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes); | |
1da177e4 LT |
348 | |
349 | struct ata_ioports { | |
350 | unsigned long cmd_addr; | |
351 | unsigned long data_addr; | |
352 | unsigned long error_addr; | |
353 | unsigned long feature_addr; | |
354 | unsigned long nsect_addr; | |
355 | unsigned long lbal_addr; | |
356 | unsigned long lbam_addr; | |
357 | unsigned long lbah_addr; | |
358 | unsigned long device_addr; | |
359 | unsigned long status_addr; | |
360 | unsigned long command_addr; | |
361 | unsigned long altstatus_addr; | |
362 | unsigned long ctl_addr; | |
363 | unsigned long bmdma_addr; | |
364 | unsigned long scr_addr; | |
365 | }; | |
366 | ||
367 | struct ata_probe_ent { | |
368 | struct list_head node; | |
369 | struct device *dev; | |
057ace5e | 370 | const struct ata_port_operations *port_ops; |
193515d5 | 371 | struct scsi_host_template *sht; |
1da177e4 LT |
372 | struct ata_ioports port[ATA_MAX_PORTS]; |
373 | unsigned int n_ports; | |
dd5b06c4 | 374 | unsigned int dummy_port_mask; |
1da177e4 LT |
375 | unsigned int pio_mask; |
376 | unsigned int mwdma_mask; | |
377 | unsigned int udma_mask; | |
1da177e4 | 378 | unsigned long irq; |
2ec7df04 | 379 | unsigned long irq2; |
1da177e4 | 380 | unsigned int irq_flags; |
cca3974e JG |
381 | unsigned long port_flags; |
382 | unsigned long _host_flags; | |
1da177e4 LT |
383 | void __iomem *mmio_base; |
384 | void *private_data; | |
fea63e38 TH |
385 | |
386 | /* port_info for the secondary port. Together with irq2, it's | |
387 | * used to implement non-uniform secondary port. Currently, | |
388 | * the only user is ata_piix combined mode. This workaround | |
389 | * will be removed together with ata_probe_ent when init model | |
390 | * is updated. | |
391 | */ | |
392 | const struct ata_port_info *pinfo2; | |
1da177e4 LT |
393 | }; |
394 | ||
cca3974e | 395 | struct ata_host { |
1da177e4 LT |
396 | spinlock_t lock; |
397 | struct device *dev; | |
398 | unsigned long irq; | |
2ec7df04 | 399 | unsigned long irq2; |
1da177e4 LT |
400 | void __iomem *mmio_base; |
401 | unsigned int n_ports; | |
402 | void *private_data; | |
057ace5e | 403 | const struct ata_port_operations *ops; |
5444a6f4 AC |
404 | unsigned long flags; |
405 | int simplex_claimed; /* Keep seperate in case we | |
406 | ever need to do this locked */ | |
f0eb62b8 | 407 | struct ata_port *ports[0]; |
1da177e4 LT |
408 | }; |
409 | ||
410 | struct ata_queued_cmd { | |
411 | struct ata_port *ap; | |
412 | struct ata_device *dev; | |
413 | ||
414 | struct scsi_cmnd *scsicmd; | |
415 | void (*scsidone)(struct scsi_cmnd *); | |
416 | ||
417 | struct ata_taskfile tf; | |
418 | u8 cdb[ATAPI_CDB_LEN]; | |
419 | ||
420 | unsigned long flags; /* ATA_QCFLAG_xxx */ | |
421 | unsigned int tag; | |
422 | unsigned int n_elem; | |
cedc9a47 | 423 | unsigned int orig_n_elem; |
1da177e4 LT |
424 | |
425 | int dma_dir; | |
426 | ||
cedc9a47 JG |
427 | unsigned int pad_len; |
428 | ||
1da177e4 LT |
429 | unsigned int nsect; |
430 | unsigned int cursect; | |
431 | ||
432 | unsigned int nbytes; | |
433 | unsigned int curbytes; | |
434 | ||
435 | unsigned int cursg; | |
436 | unsigned int cursg_ofs; | |
437 | ||
438 | struct scatterlist sgent; | |
cedc9a47 | 439 | struct scatterlist pad_sgent; |
1da177e4 LT |
440 | void *buf_virt; |
441 | ||
cedc9a47 JG |
442 | /* DO NOT iterate over __sg manually, use ata_for_each_sg() */ |
443 | struct scatterlist *__sg; | |
1da177e4 | 444 | |
a22e2eb0 | 445 | unsigned int err_mask; |
e61e0672 | 446 | struct ata_taskfile result_tf; |
1da177e4 LT |
447 | ata_qc_cb_t complete_fn; |
448 | ||
1da177e4 LT |
449 | void *private_data; |
450 | }; | |
451 | ||
cca3974e | 452 | struct ata_port_stats { |
1da177e4 LT |
453 | unsigned long unhandled_irq; |
454 | unsigned long idle_irq; | |
455 | unsigned long rw_reqbuf; | |
456 | }; | |
457 | ||
0c247c55 TH |
458 | struct ata_ering_entry { |
459 | int is_io; | |
460 | unsigned int err_mask; | |
461 | u64 timestamp; | |
462 | }; | |
463 | ||
464 | struct ata_ering { | |
465 | int cursor; | |
466 | struct ata_ering_entry ring[ATA_ERING_SIZE]; | |
467 | }; | |
468 | ||
1da177e4 | 469 | struct ata_device { |
38d87234 | 470 | struct ata_port *ap; |
72fa4b74 | 471 | unsigned int devno; /* 0 or 1 */ |
1da177e4 | 472 | unsigned long flags; /* ATA_DFLAG_xxx */ |
3edebac4 | 473 | struct scsi_device *sdev; /* attached SCSI device */ |
72fa4b74 TH |
474 | /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */ |
475 | u64 n_sectors; /* size of device, if ATA */ | |
1da177e4 | 476 | unsigned int class; /* ATA_DEV_xxx */ |
fe635c7e | 477 | u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ |
1da177e4 LT |
478 | u8 pio_mode; |
479 | u8 dma_mode; | |
480 | u8 xfer_mode; | |
481 | unsigned int xfer_shift; /* ATA_SHIFT_xxx */ | |
482 | ||
8cbd6df1 AL |
483 | unsigned int multi_count; /* sectors count for |
484 | READ/WRITE MULTIPLE */ | |
b00eec1d | 485 | unsigned int max_sectors; /* per-device max sectors */ |
6e7846e9 | 486 | unsigned int cdb_len; |
8bf62ece | 487 | |
acf356b1 TH |
488 | /* per-dev xfer mask */ |
489 | unsigned int pio_mask; | |
490 | unsigned int mwdma_mask; | |
491 | unsigned int udma_mask; | |
492 | ||
8bf62ece AL |
493 | /* for CHS addressing */ |
494 | u16 cylinders; /* Number of cylinders */ | |
495 | u16 heads; /* Number of heads */ | |
496 | u16 sectors; /* Number of sectors per track */ | |
0c247c55 TH |
497 | |
498 | /* error history */ | |
499 | struct ata_ering ering; | |
93590859 | 500 | unsigned int horkage; /* List of broken features */ |
1da177e4 LT |
501 | }; |
502 | ||
72fa4b74 TH |
503 | /* Offset into struct ata_device. Fields above it are maintained |
504 | * acress device init. Fields below are zeroed. | |
505 | */ | |
506 | #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors) | |
507 | ||
f3e81b19 TH |
508 | struct ata_eh_info { |
509 | struct ata_device *dev; /* offending device */ | |
510 | u32 serror; /* SError from LLDD */ | |
511 | unsigned int err_mask; /* port-wide err_mask */ | |
512 | unsigned int action; /* ATA_EH_* action mask */ | |
47005f25 | 513 | unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */ |
f3e81b19 | 514 | unsigned int flags; /* ATA_EHI_* flags */ |
abdda733 TH |
515 | |
516 | unsigned long hotplug_timestamp; | |
517 | unsigned int probe_mask; | |
518 | ||
f3e81b19 TH |
519 | char desc[ATA_EH_DESC_LEN]; |
520 | int desc_len; | |
521 | }; | |
522 | ||
523 | struct ata_eh_context { | |
524 | struct ata_eh_info i; | |
525 | int tries[ATA_MAX_DEVICES]; | |
abdda733 TH |
526 | unsigned int classes[ATA_MAX_DEVICES]; |
527 | unsigned int did_probe_mask; | |
f3e81b19 TH |
528 | }; |
529 | ||
1da177e4 | 530 | struct ata_port { |
cca3974e | 531 | struct Scsi_Host *scsi_host; /* our co-allocated scsi host */ |
057ace5e | 532 | const struct ata_port_operations *ops; |
ba6a1308 | 533 | spinlock_t *lock; |
1da177e4 | 534 | unsigned long flags; /* ATA_FLAG_xxx */ |
b51e9e5d | 535 | unsigned int pflags; /* ATA_PFLAG_xxx */ |
1da177e4 LT |
536 | unsigned int id; /* unique id req'd by scsi midlyr */ |
537 | unsigned int port_no; /* unique port #; from zero */ | |
1da177e4 LT |
538 | |
539 | struct ata_prd *prd; /* our SG list */ | |
540 | dma_addr_t prd_dma; /* and its DMA mapping */ | |
541 | ||
cedc9a47 JG |
542 | void *pad; /* array of DMA pad buffers */ |
543 | dma_addr_t pad_dma; | |
544 | ||
1da177e4 LT |
545 | struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ |
546 | ||
547 | u8 ctl; /* cache of ATA control register */ | |
548 | u8 last_ctl; /* Cache last written value */ | |
1da177e4 LT |
549 | unsigned int pio_mask; |
550 | unsigned int mwdma_mask; | |
551 | unsigned int udma_mask; | |
552 | unsigned int cbl; /* cable type; ATA_CBL_xxx */ | |
5a04bf4b | 553 | unsigned int hw_sata_spd_limit; |
1c3fae4d | 554 | unsigned int sata_spd_limit; /* SATA PHY speed limit */ |
1da177e4 | 555 | |
cca3974e | 556 | /* record runtime error info, protected by host lock */ |
f3e81b19 TH |
557 | struct ata_eh_info eh_info; |
558 | /* EH context owned by EH */ | |
559 | struct ata_eh_context eh_context; | |
560 | ||
1da177e4 LT |
561 | struct ata_device device[ATA_MAX_DEVICES]; |
562 | ||
563 | struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; | |
6cec4a39 | 564 | unsigned long qc_allocated; |
dedaf2b0 TH |
565 | unsigned int qc_active; |
566 | ||
1da177e4 | 567 | unsigned int active_tag; |
dedaf2b0 | 568 | u32 sactive; |
1da177e4 | 569 | |
cca3974e JG |
570 | struct ata_port_stats stats; |
571 | struct ata_host *host; | |
2f1f610b | 572 | struct device *dev; |
1da177e4 | 573 | |
9a9c77dc TH |
574 | struct work_struct port_task; |
575 | struct work_struct hotplug_task; | |
3b01b8af | 576 | struct work_struct scsi_rescan_task; |
86e45b6b | 577 | |
14be71f4 | 578 | unsigned int hsm_task_state; |
1da177e4 | 579 | |
bfd60579 | 580 | u32 msg_enable; |
a72ec4ce | 581 | struct list_head eh_done_q; |
c6cf9e99 | 582 | wait_queue_head_t eh_wait_q; |
bfd60579 | 583 | |
500530f6 TH |
584 | pm_message_t pm_mesg; |
585 | int *pm_result; | |
586 | ||
1da177e4 | 587 | void *private_data; |
fe635c7e TH |
588 | |
589 | u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */ | |
1da177e4 LT |
590 | }; |
591 | ||
592 | struct ata_port_operations { | |
593 | void (*port_disable) (struct ata_port *); | |
594 | ||
595 | void (*dev_config) (struct ata_port *, struct ata_device *); | |
596 | ||
597 | void (*set_piomode) (struct ata_port *, struct ata_device *); | |
598 | void (*set_dmamode) (struct ata_port *, struct ata_device *); | |
5444a6f4 | 599 | unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long); |
1da177e4 | 600 | |
057ace5e | 601 | void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf); |
1da177e4 LT |
602 | void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf); |
603 | ||
057ace5e | 604 | void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); |
1da177e4 LT |
605 | u8 (*check_status)(struct ata_port *ap); |
606 | u8 (*check_altstatus)(struct ata_port *ap); | |
1da177e4 LT |
607 | void (*dev_select)(struct ata_port *ap, unsigned int device); |
608 | ||
c19ba8af | 609 | void (*phy_reset) (struct ata_port *ap); /* obsolete */ |
e35a9e01 | 610 | void (*set_mode) (struct ata_port *ap); |
c19ba8af | 611 | |
1da177e4 LT |
612 | void (*post_set_mode) (struct ata_port *ap); |
613 | ||
614 | int (*check_atapi_dma) (struct ata_queued_cmd *qc); | |
615 | ||
616 | void (*bmdma_setup) (struct ata_queued_cmd *qc); | |
617 | void (*bmdma_start) (struct ata_queued_cmd *qc); | |
618 | ||
a6b2c5d4 AC |
619 | void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int); |
620 | ||
1da177e4 | 621 | void (*qc_prep) (struct ata_queued_cmd *qc); |
9a3d9eb0 | 622 | unsigned int (*qc_issue) (struct ata_queued_cmd *qc); |
1da177e4 | 623 | |
9ec957f2 TH |
624 | /* Error handlers. ->error_handler overrides ->eng_timeout and |
625 | * indicates that new-style EH is in place. | |
626 | */ | |
627 | void (*eng_timeout) (struct ata_port *ap); /* obsolete */ | |
628 | ||
629 | void (*freeze) (struct ata_port *ap); | |
630 | void (*thaw) (struct ata_port *ap); | |
631 | void (*error_handler) (struct ata_port *ap); | |
632 | void (*post_internal_cmd) (struct ata_queued_cmd *qc); | |
1da177e4 | 633 | |
7d12e780 | 634 | irq_handler_t irq_handler; |
1da177e4 LT |
635 | void (*irq_clear) (struct ata_port *); |
636 | ||
637 | u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg); | |
638 | void (*scr_write) (struct ata_port *ap, unsigned int sc_reg, | |
639 | u32 val); | |
640 | ||
500530f6 TH |
641 | int (*port_suspend) (struct ata_port *ap, pm_message_t mesg); |
642 | int (*port_resume) (struct ata_port *ap); | |
643 | ||
1da177e4 LT |
644 | int (*port_start) (struct ata_port *ap); |
645 | void (*port_stop) (struct ata_port *ap); | |
646 | ||
cca3974e | 647 | void (*host_stop) (struct ata_host *host); |
1da177e4 | 648 | |
b73fc89f | 649 | void (*bmdma_stop) (struct ata_queued_cmd *qc); |
1da177e4 LT |
650 | u8 (*bmdma_status) (struct ata_port *ap); |
651 | }; | |
652 | ||
653 | struct ata_port_info { | |
d0be4a7d | 654 | struct scsi_host_template *sht; |
cca3974e | 655 | unsigned long flags; |
1da177e4 LT |
656 | unsigned long pio_mask; |
657 | unsigned long mwdma_mask; | |
658 | unsigned long udma_mask; | |
057ace5e | 659 | const struct ata_port_operations *port_ops; |
e99f8b5e | 660 | void *private_data; |
1da177e4 LT |
661 | }; |
662 | ||
452503f9 AC |
663 | struct ata_timing { |
664 | unsigned short mode; /* ATA mode */ | |
665 | unsigned short setup; /* t1 */ | |
666 | unsigned short act8b; /* t2 for 8-bit I/O */ | |
667 | unsigned short rec8b; /* t2i for 8-bit I/O */ | |
668 | unsigned short cyc8b; /* t0 for 8-bit I/O */ | |
669 | unsigned short active; /* t2 or tD */ | |
670 | unsigned short recover; /* t2i or tK */ | |
671 | unsigned short cycle; /* t0 */ | |
672 | unsigned short udma; /* t2CYCTYP/2 */ | |
673 | }; | |
674 | ||
675 | #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin) | |
1da177e4 | 676 | |
e9c83914 TH |
677 | extern const unsigned long sata_deb_timing_normal[]; |
678 | extern const unsigned long sata_deb_timing_hotplug[]; | |
679 | extern const unsigned long sata_deb_timing_long[]; | |
680 | ||
dd5b06c4 TH |
681 | extern const struct ata_port_operations ata_dummy_port_ops; |
682 | ||
e9c83914 TH |
683 | static inline const unsigned long * |
684 | sata_ehc_deb_timing(struct ata_eh_context *ehc) | |
685 | { | |
686 | if (ehc->i.flags & ATA_EHI_HOTPLUGGED) | |
687 | return sata_deb_timing_hotplug; | |
688 | else | |
689 | return sata_deb_timing_normal; | |
690 | } | |
d7bb4cc7 | 691 | |
dd5b06c4 TH |
692 | static inline int ata_port_is_dummy(struct ata_port *ap) |
693 | { | |
694 | return ap->ops == &ata_dummy_port_ops; | |
695 | } | |
696 | ||
1da177e4 LT |
697 | extern void ata_port_probe(struct ata_port *); |
698 | extern void __sata_phy_reset(struct ata_port *ap); | |
699 | extern void sata_phy_reset(struct ata_port *ap); | |
700 | extern void ata_bus_reset(struct ata_port *ap); | |
3c567b7d | 701 | extern int sata_set_spd(struct ata_port *ap); |
d7bb4cc7 TH |
702 | extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param); |
703 | extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param); | |
f5914a46 | 704 | extern int ata_std_prereset(struct ata_port *ap); |
2bf2cb26 | 705 | extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes); |
b6103f6d TH |
706 | extern int sata_port_hardreset(struct ata_port *ap, |
707 | const unsigned long *timing); | |
2bf2cb26 | 708 | extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class); |
c2bd5804 | 709 | extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes); |
1da177e4 LT |
710 | extern void ata_port_disable(struct ata_port *); |
711 | extern void ata_std_ports(struct ata_ioports *ioaddr); | |
712 | #ifdef CONFIG_PCI | |
713 | extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info, | |
714 | unsigned int n_ports); | |
715 | extern void ata_pci_remove_one (struct pci_dev *pdev); | |
3c5100c1 | 716 | extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg); |
500530f6 | 717 | extern void ata_pci_device_do_resume(struct pci_dev *pdev); |
3c5100c1 | 718 | extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg); |
9b847548 | 719 | extern int ata_pci_device_resume(struct pci_dev *pdev); |
17bb34a3 | 720 | extern int ata_pci_clear_simplex(struct pci_dev *pdev); |
1da177e4 | 721 | #endif /* CONFIG_PCI */ |
057ace5e | 722 | extern int ata_device_add(const struct ata_probe_ent *ent); |
720ba126 | 723 | extern void ata_port_detach(struct ata_port *ap); |
cca3974e JG |
724 | extern void ata_host_init(struct ata_host *, struct device *, |
725 | unsigned long, const struct ata_port_operations *); | |
726 | extern void ata_host_remove(struct ata_host *host); | |
193515d5 | 727 | extern int ata_scsi_detect(struct scsi_host_template *sht); |
1da177e4 LT |
728 | extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); |
729 | extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); | |
1da177e4 | 730 | extern int ata_scsi_release(struct Scsi_Host *host); |
80289167 | 731 | extern void ata_sas_port_destroy(struct ata_port *); |
cca3974e | 732 | extern struct ata_port *ata_sas_port_alloc(struct ata_host *, |
80289167 BK |
733 | struct ata_port_info *, struct Scsi_Host *); |
734 | extern int ata_sas_port_init(struct ata_port *); | |
735 | extern int ata_sas_port_start(struct ata_port *ap); | |
736 | extern void ata_sas_port_stop(struct ata_port *ap); | |
737 | extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *); | |
738 | extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), | |
739 | struct ata_port *ap); | |
1da177e4 | 740 | extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); |
34bf2170 TH |
741 | extern int sata_scr_valid(struct ata_port *ap); |
742 | extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val); | |
743 | extern int sata_scr_write(struct ata_port *ap, int reg, u32 val); | |
744 | extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val); | |
745 | extern int ata_port_online(struct ata_port *ap); | |
746 | extern int ata_port_offline(struct ata_port *ap); | |
9b847548 | 747 | extern int ata_scsi_device_resume(struct scsi_device *); |
3c5100c1 | 748 | extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg); |
cca3974e JG |
749 | extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg); |
750 | extern void ata_host_resume(struct ata_host *host); | |
67846b30 | 751 | extern int ata_ratelimit(void); |
d1adc1bb TH |
752 | extern int ata_busy_sleep(struct ata_port *ap, |
753 | unsigned long timeout_pat, unsigned long timeout); | |
86e45b6b TH |
754 | extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *), |
755 | void *data, unsigned long delay); | |
c22daff4 TH |
756 | extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val, |
757 | unsigned long interval_msec, | |
758 | unsigned long timeout_msec); | |
67846b30 | 759 | |
1da177e4 LT |
760 | /* |
761 | * Default driver ops implementations | |
762 | */ | |
057ace5e | 763 | extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); |
1da177e4 | 764 | extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf); |
057ace5e JG |
765 | extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp); |
766 | extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); | |
1da177e4 LT |
767 | extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device); |
768 | extern void ata_std_dev_select (struct ata_port *ap, unsigned int device); | |
769 | extern u8 ata_check_status(struct ata_port *ap); | |
770 | extern u8 ata_altstatus(struct ata_port *ap); | |
057ace5e | 771 | extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); |
1da177e4 LT |
772 | extern int ata_port_start (struct ata_port *ap); |
773 | extern void ata_port_stop (struct ata_port *ap); | |
cca3974e | 774 | extern void ata_host_stop (struct ata_host *host); |
7d12e780 | 775 | extern irqreturn_t ata_interrupt (int irq, void *dev_instance); |
a6b2c5d4 AC |
776 | extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf, |
777 | unsigned int buflen, int write_data); | |
778 | extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf, | |
779 | unsigned int buflen, int write_data); | |
75e99585 AC |
780 | extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf, |
781 | unsigned int buflen, int write_data); | |
1da177e4 | 782 | extern void ata_qc_prep(struct ata_queued_cmd *qc); |
e46834cd | 783 | extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); |
9a3d9eb0 | 784 | extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc); |
1da177e4 LT |
785 | extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, |
786 | unsigned int buflen); | |
787 | extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, | |
788 | unsigned int n_elem); | |
057ace5e | 789 | extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); |
6a62a04d TH |
790 | extern void ata_id_string(const u16 *id, unsigned char *s, |
791 | unsigned int ofs, unsigned int len); | |
792 | extern void ata_id_c_string(const u16 *id, unsigned char *s, | |
793 | unsigned int ofs, unsigned int len); | |
6919a0a6 | 794 | extern unsigned long ata_device_blacklisted(const struct ata_device *dev); |
1da177e4 LT |
795 | extern void ata_bmdma_setup (struct ata_queued_cmd *qc); |
796 | extern void ata_bmdma_start (struct ata_queued_cmd *qc); | |
b73fc89f | 797 | extern void ata_bmdma_stop(struct ata_queued_cmd *qc); |
1da177e4 LT |
798 | extern u8 ata_bmdma_status(struct ata_port *ap); |
799 | extern void ata_bmdma_irq_clear(struct ata_port *ap); | |
6d97dbd7 TH |
800 | extern void ata_bmdma_freeze(struct ata_port *ap); |
801 | extern void ata_bmdma_thaw(struct ata_port *ap); | |
f5914a46 | 802 | extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset, |
6d97dbd7 TH |
803 | ata_reset_fn_t softreset, |
804 | ata_reset_fn_t hardreset, | |
805 | ata_postreset_fn_t postreset); | |
806 | extern void ata_bmdma_error_handler(struct ata_port *ap); | |
807 | extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc); | |
9a1004d0 TH |
808 | extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc, |
809 | u8 status, int in_wq); | |
f686bcb8 | 810 | extern void ata_qc_complete(struct ata_queued_cmd *qc); |
dedaf2b0 TH |
811 | extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active, |
812 | void (*finish_qc)(struct ata_queued_cmd *)); | |
3373efd8 | 813 | extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd, |
1da177e4 LT |
814 | void (*done)(struct scsi_cmnd *)); |
815 | extern int ata_std_bios_param(struct scsi_device *sdev, | |
816 | struct block_device *bdev, | |
817 | sector_t capacity, int geom[]); | |
818 | extern int ata_scsi_slave_config(struct scsi_device *sdev); | |
83c47bcb | 819 | extern void ata_scsi_slave_destroy(struct scsi_device *sdev); |
a6e6ce8e TH |
820 | extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, |
821 | int queue_depth); | |
3373efd8 | 822 | extern struct ata_device *ata_dev_pair(struct ata_device *adev); |
1da177e4 | 823 | |
452503f9 AC |
824 | /* |
825 | * Timing helpers | |
826 | */ | |
1bc4ccff AC |
827 | |
828 | extern unsigned int ata_pio_need_iordy(const struct ata_device *); | |
452503f9 AC |
829 | extern int ata_timing_compute(struct ata_device *, unsigned short, |
830 | struct ata_timing *, int, int); | |
831 | extern void ata_timing_merge(const struct ata_timing *, | |
832 | const struct ata_timing *, struct ata_timing *, | |
833 | unsigned int); | |
834 | ||
835 | enum { | |
836 | ATA_TIMING_SETUP = (1 << 0), | |
837 | ATA_TIMING_ACT8B = (1 << 1), | |
838 | ATA_TIMING_REC8B = (1 << 2), | |
839 | ATA_TIMING_CYC8B = (1 << 3), | |
840 | ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | | |
841 | ATA_TIMING_CYC8B, | |
842 | ATA_TIMING_ACTIVE = (1 << 4), | |
843 | ATA_TIMING_RECOVER = (1 << 5), | |
844 | ATA_TIMING_CYCLE = (1 << 6), | |
845 | ATA_TIMING_UDMA = (1 << 7), | |
846 | ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | | |
847 | ATA_TIMING_REC8B | ATA_TIMING_CYC8B | | |
848 | ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | | |
849 | ATA_TIMING_CYCLE | ATA_TIMING_UDMA, | |
850 | }; | |
851 | ||
1da177e4 LT |
852 | |
853 | #ifdef CONFIG_PCI | |
854 | struct pci_bits { | |
855 | unsigned int reg; /* PCI config register to read */ | |
856 | unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ | |
857 | unsigned long mask; | |
858 | unsigned long val; | |
859 | }; | |
860 | ||
cca3974e | 861 | extern void ata_pci_host_stop (struct ata_host *host); |
1da177e4 | 862 | extern struct ata_probe_ent * |
47a86593 | 863 | ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask); |
057ace5e | 864 | extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); |
17bb34a3 | 865 | extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long); |
1da177e4 LT |
866 | #endif /* CONFIG_PCI */ |
867 | ||
ece1d636 TH |
868 | /* |
869 | * EH | |
870 | */ | |
ece1d636 | 871 | extern void ata_eng_timeout(struct ata_port *ap); |
7b70fc03 TH |
872 | |
873 | extern void ata_port_schedule_eh(struct ata_port *ap); | |
874 | extern int ata_port_abort(struct ata_port *ap); | |
e3180499 TH |
875 | extern int ata_port_freeze(struct ata_port *ap); |
876 | ||
877 | extern void ata_eh_freeze_port(struct ata_port *ap); | |
878 | extern void ata_eh_thaw_port(struct ata_port *ap); | |
7b70fc03 | 879 | |
ece1d636 TH |
880 | extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); |
881 | extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); | |
882 | ||
f5914a46 TH |
883 | extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset, |
884 | ata_reset_fn_t softreset, ata_reset_fn_t hardreset, | |
885 | ata_postreset_fn_t postreset); | |
022bdb07 | 886 | |
61440db6 TH |
887 | /* |
888 | * printk helpers | |
889 | */ | |
890 | #define ata_port_printk(ap, lv, fmt, args...) \ | |
891 | printk(lv"ata%u: "fmt, (ap)->id , ##args) | |
892 | ||
893 | #define ata_dev_printk(dev, lv, fmt, args...) \ | |
894 | printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args) | |
1da177e4 | 895 | |
f3e81b19 TH |
896 | /* |
897 | * ata_eh_info helpers | |
898 | */ | |
899 | #define ata_ehi_push_desc(ehi, fmt, args...) do { \ | |
900 | (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \ | |
901 | ATA_EH_DESC_LEN - (ehi)->desc_len, \ | |
902 | fmt , ##args); \ | |
903 | } while (0) | |
904 | ||
905 | #define ata_ehi_clear_desc(ehi) do { \ | |
906 | (ehi)->desc[0] = '\0'; \ | |
907 | (ehi)->desc_len = 0; \ | |
908 | } while (0) | |
909 | ||
c0b6c037 | 910 | static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi) |
084fe639 TH |
911 | { |
912 | if (ehi->flags & ATA_EHI_HOTPLUGGED) | |
913 | return; | |
914 | ||
28324304 | 915 | ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK; |
084fe639 TH |
916 | ehi->hotplug_timestamp = jiffies; |
917 | ||
084fe639 TH |
918 | ehi->action |= ATA_EH_SOFTRESET; |
919 | ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1; | |
920 | } | |
921 | ||
c0b6c037 TH |
922 | static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi) |
923 | { | |
924 | __ata_ehi_hotplugged(ehi); | |
925 | ehi->err_mask |= AC_ERR_ATA_BUS; | |
926 | } | |
927 | ||
61440db6 TH |
928 | /* |
929 | * qc helpers | |
930 | */ | |
972c26bd JG |
931 | static inline int |
932 | ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc) | |
933 | { | |
934 | if (sg == &qc->pad_sgent) | |
935 | return 1; | |
936 | if (qc->pad_len) | |
937 | return 0; | |
938 | if (((sg - qc->__sg) + 1) == qc->n_elem) | |
939 | return 1; | |
940 | return 0; | |
941 | } | |
942 | ||
cc1887f3 TH |
943 | static inline struct scatterlist * |
944 | ata_qc_first_sg(struct ata_queued_cmd *qc) | |
945 | { | |
946 | if (qc->n_elem) | |
947 | return qc->__sg; | |
948 | if (qc->pad_len) | |
949 | return &qc->pad_sgent; | |
950 | return NULL; | |
951 | } | |
952 | ||
cedc9a47 JG |
953 | static inline struct scatterlist * |
954 | ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc) | |
955 | { | |
956 | if (sg == &qc->pad_sgent) | |
957 | return NULL; | |
958 | if (++sg - qc->__sg < qc->n_elem) | |
959 | return sg; | |
cc1887f3 TH |
960 | if (qc->pad_len) |
961 | return &qc->pad_sgent; | |
962 | return NULL; | |
cedc9a47 JG |
963 | } |
964 | ||
965 | #define ata_for_each_sg(sg, qc) \ | |
cc1887f3 | 966 | for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc)) |
cedc9a47 | 967 | |
1da177e4 LT |
968 | static inline unsigned int ata_tag_valid(unsigned int tag) |
969 | { | |
970 | return (tag < ATA_MAX_QUEUE) ? 1 : 0; | |
971 | } | |
972 | ||
2ab7db1f TH |
973 | static inline unsigned int ata_tag_internal(unsigned int tag) |
974 | { | |
975 | return tag == ATA_MAX_QUEUE - 1; | |
976 | } | |
977 | ||
5806db22 TH |
978 | /* |
979 | * device helpers | |
980 | */ | |
e1211e3f | 981 | static inline unsigned int ata_class_enabled(unsigned int class) |
597afd21 TH |
982 | { |
983 | return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI; | |
984 | } | |
985 | ||
e1211e3f | 986 | static inline unsigned int ata_class_disabled(unsigned int class) |
1da177e4 | 987 | { |
e1211e3f TH |
988 | return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP; |
989 | } | |
990 | ||
002c8054 TH |
991 | static inline unsigned int ata_class_absent(unsigned int class) |
992 | { | |
993 | return !ata_class_enabled(class) && !ata_class_disabled(class); | |
994 | } | |
995 | ||
e1211e3f TH |
996 | static inline unsigned int ata_dev_enabled(const struct ata_device *dev) |
997 | { | |
998 | return ata_class_enabled(dev->class); | |
999 | } | |
1000 | ||
1001 | static inline unsigned int ata_dev_disabled(const struct ata_device *dev) | |
1002 | { | |
1003 | return ata_class_disabled(dev->class); | |
1da177e4 LT |
1004 | } |
1005 | ||
002c8054 TH |
1006 | static inline unsigned int ata_dev_absent(const struct ata_device *dev) |
1007 | { | |
1008 | return ata_class_absent(dev->class); | |
1009 | } | |
1010 | ||
02670bf3 TH |
1011 | static inline unsigned int ata_dev_ready(const struct ata_device *dev) |
1012 | { | |
1013 | return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED); | |
1014 | } | |
1015 | ||
5806db22 TH |
1016 | /* |
1017 | * port helpers | |
1018 | */ | |
1019 | static inline int ata_port_max_devices(const struct ata_port *ap) | |
1020 | { | |
1021 | if (ap->flags & ATA_FLAG_SLAVE_POSS) | |
1022 | return 2; | |
1023 | return 1; | |
1024 | } | |
1025 | ||
1026 | ||
1da177e4 LT |
1027 | static inline u8 ata_chk_status(struct ata_port *ap) |
1028 | { | |
1029 | return ap->ops->check_status(ap); | |
1030 | } | |
1031 | ||
0baab86b EF |
1032 | |
1033 | /** | |
1034 | * ata_pause - Flush writes and pause 400 nanoseconds. | |
1035 | * @ap: Port to wait for. | |
1036 | * | |
1037 | * LOCKING: | |
1038 | * Inherited from caller. | |
1039 | */ | |
1040 | ||
1da177e4 LT |
1041 | static inline void ata_pause(struct ata_port *ap) |
1042 | { | |
1043 | ata_altstatus(ap); | |
1044 | ndelay(400); | |
1045 | } | |
1046 | ||
0baab86b EF |
1047 | |
1048 | /** | |
1049 | * ata_busy_wait - Wait for a port status register | |
1050 | * @ap: Port to wait for. | |
1051 | * | |
1052 | * Waits up to max*10 microseconds for the selected bits in the port's | |
1053 | * status register to be cleared. | |
1054 | * Returns final value of status register. | |
1055 | * | |
1056 | * LOCKING: | |
1057 | * Inherited from caller. | |
1058 | */ | |
1059 | ||
1da177e4 LT |
1060 | static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, |
1061 | unsigned int max) | |
1062 | { | |
1063 | u8 status; | |
1064 | ||
1065 | do { | |
1066 | udelay(10); | |
1067 | status = ata_chk_status(ap); | |
1068 | max--; | |
d1adc1bb | 1069 | } while (status != 0xff && (status & bits) && (max > 0)); |
1da177e4 LT |
1070 | |
1071 | return status; | |
1072 | } | |
1073 | ||
0baab86b EF |
1074 | |
1075 | /** | |
1076 | * ata_wait_idle - Wait for a port to be idle. | |
1077 | * @ap: Port to wait for. | |
1078 | * | |
1079 | * Waits up to 10ms for port's BUSY and DRQ signals to clear. | |
1080 | * Returns final value of status register. | |
1081 | * | |
1082 | * LOCKING: | |
1083 | * Inherited from caller. | |
1084 | */ | |
1085 | ||
1da177e4 LT |
1086 | static inline u8 ata_wait_idle(struct ata_port *ap) |
1087 | { | |
1088 | u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); | |
1089 | ||
d1adc1bb | 1090 | if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) { |
1da177e4 | 1091 | unsigned long l = ap->ioaddr.status_addr; |
bfd60579 RD |
1092 | if (ata_msg_warn(ap)) |
1093 | printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n", | |
1094 | status, l); | |
1da177e4 LT |
1095 | } |
1096 | ||
1097 | return status; | |
1098 | } | |
1099 | ||
1100 | static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) | |
1101 | { | |
1102 | qc->tf.ctl |= ATA_NIEN; | |
1103 | } | |
1104 | ||
f69499f4 TH |
1105 | static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, |
1106 | unsigned int tag) | |
1da177e4 LT |
1107 | { |
1108 | if (likely(ata_tag_valid(tag))) | |
1109 | return &ap->qcmd[tag]; | |
1110 | return NULL; | |
1111 | } | |
1112 | ||
f69499f4 TH |
1113 | static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, |
1114 | unsigned int tag) | |
1115 | { | |
1116 | struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); | |
1117 | ||
1118 | if (unlikely(!qc) || !ap->ops->error_handler) | |
1119 | return qc; | |
1120 | ||
1121 | if ((qc->flags & (ATA_QCFLAG_ACTIVE | | |
1122 | ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) | |
1123 | return qc; | |
1124 | ||
1125 | return NULL; | |
1126 | } | |
1127 | ||
3373efd8 | 1128 | static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) |
1da177e4 LT |
1129 | { |
1130 | memset(tf, 0, sizeof(*tf)); | |
1131 | ||
3373efd8 TH |
1132 | tf->ctl = dev->ap->ctl; |
1133 | if (dev->devno == 0) | |
1da177e4 LT |
1134 | tf->device = ATA_DEVICE_OBS; |
1135 | else | |
1136 | tf->device = ATA_DEVICE_OBS | ATA_DEV1; | |
1137 | } | |
1138 | ||
2c13b7ce JG |
1139 | static inline void ata_qc_reinit(struct ata_queued_cmd *qc) |
1140 | { | |
1141 | qc->__sg = NULL; | |
1142 | qc->flags = 0; | |
1143 | qc->cursect = qc->cursg = qc->cursg_ofs = 0; | |
1144 | qc->nsect = 0; | |
1145 | qc->nbytes = qc->curbytes = 0; | |
a22e2eb0 | 1146 | qc->err_mask = 0; |
2c13b7ce | 1147 | |
3373efd8 | 1148 | ata_tf_init(qc->dev, &qc->tf); |
e61e0672 TH |
1149 | |
1150 | /* init result_tf such that it indicates normal completion */ | |
1151 | qc->result_tf.command = ATA_DRDY; | |
1152 | qc->result_tf.feature = 0; | |
2c13b7ce JG |
1153 | } |
1154 | ||
0baab86b EF |
1155 | /** |
1156 | * ata_irq_ack - Acknowledge a device interrupt. | |
1157 | * @ap: Port on which interrupts are enabled. | |
1158 | * | |
1159 | * Wait up to 10 ms for legacy IDE device to become idle (BUSY | |
1160 | * or BUSY+DRQ clear). Obtain dma status and port status from | |
1161 | * device. Clear the interrupt. Return port status. | |
1162 | * | |
1163 | * LOCKING: | |
1164 | */ | |
1165 | ||
1da177e4 LT |
1166 | static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq) |
1167 | { | |
1168 | unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY; | |
1169 | u8 host_stat, post_stat, status; | |
1170 | ||
1171 | status = ata_busy_wait(ap, bits, 1000); | |
1172 | if (status & bits) | |
bfd60579 RD |
1173 | if (ata_msg_err(ap)) |
1174 | printk(KERN_ERR "abnormal status 0x%X\n", status); | |
1da177e4 LT |
1175 | |
1176 | /* get controller status; clear intr, err bits */ | |
1177 | if (ap->flags & ATA_FLAG_MMIO) { | |
1178 | void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr; | |
1179 | host_stat = readb(mmio + ATA_DMA_STATUS); | |
1180 | writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, | |
1181 | mmio + ATA_DMA_STATUS); | |
1182 | ||
1183 | post_stat = readb(mmio + ATA_DMA_STATUS); | |
1184 | } else { | |
1185 | host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); | |
1186 | outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, | |
1187 | ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); | |
1188 | ||
1189 | post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); | |
1190 | } | |
1191 | ||
bfd60579 RD |
1192 | if (ata_msg_intr(ap)) |
1193 | printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n", | |
1194 | __FUNCTION__, | |
1195 | host_stat, post_stat, status); | |
1da177e4 LT |
1196 | |
1197 | return status; | |
1198 | } | |
1199 | ||
057ace5e | 1200 | static inline int ata_try_flush_cache(const struct ata_device *dev) |
1da177e4 LT |
1201 | { |
1202 | return ata_id_wcache_enabled(dev->id) || | |
1203 | ata_id_has_flush(dev->id) || | |
1204 | ata_id_has_flush_ext(dev->id); | |
1205 | } | |
1206 | ||
a7dac447 JG |
1207 | static inline unsigned int ac_err_mask(u8 status) |
1208 | { | |
3655d1d3 | 1209 | if (status & (ATA_BUSY | ATA_DRQ)) |
11a56d24 | 1210 | return AC_ERR_HSM; |
a7dac447 JG |
1211 | if (status & (ATA_ERR | ATA_DF)) |
1212 | return AC_ERR_DEV; | |
1213 | return 0; | |
1214 | } | |
1215 | ||
1216 | static inline unsigned int __ac_err_mask(u8 status) | |
1217 | { | |
1218 | unsigned int mask = ac_err_mask(status); | |
1219 | if (mask == 0) | |
1220 | return AC_ERR_OTHER; | |
1221 | return mask; | |
1222 | } | |
1223 | ||
6037d6bb JG |
1224 | static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev) |
1225 | { | |
1226 | ap->pad_dma = 0; | |
1227 | ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ, | |
1228 | &ap->pad_dma, GFP_KERNEL); | |
1229 | return (ap->pad == NULL) ? -ENOMEM : 0; | |
1230 | } | |
1231 | ||
1232 | static inline void ata_pad_free(struct ata_port *ap, struct device *dev) | |
1233 | { | |
1234 | dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma); | |
1235 | } | |
1236 | ||
35bb94b1 JG |
1237 | static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host) |
1238 | { | |
1239 | return (struct ata_port *) &host->hostdata[0]; | |
1240 | } | |
1241 | ||
1da177e4 | 1242 | #endif /* __LINUX_LIBATA_H__ */ |