blob: 36e233cc3886ddf242abc02eb89c79b7e7b86444 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
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>
Andrew Morton1c72d8d2005-11-10 16:21:38 -080032#include <linux/dma-mapping.h>
Andrew Morton41542db2006-06-23 04:18:31 -070033#include <asm/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <asm/io.h>
35#include <linux/ata.h>
36#include <linux/workqueue.h>
Jeff Garzik35bb94b2006-04-11 13:12:34 -040037#include <scsi/scsi_host.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Jeff Garzika6d967a2006-09-25 15:33:09 -040039/*
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
Alan Cox2ec7df02006-08-10 16:59:10 +090044#include <asm/libata-portmap.h>
Jeff Garzika6d967a2006-09-25 15:33:09 -040045#else
46#include <asm-generic/libata-portmap.h>
47#endif
Alan Cox2ec7df02006-08-10 16:59:10 +090048
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050050 * compile-time options: to be removed as soon as all the drivers are
51 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 */
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 */
Jeff Garzik669a5db2006-08-29 18:12:40 -040057#define ATA_ENABLE_PATA /* define to enable PATA support in some
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 * low-level drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
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
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050074#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75
Randy Dunlapbfd60572006-01-17 19:34:42 -050076/* NEW: debug levels */
77#define HAVE_LIBATA_MSG 1
78
79enum {
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
99static 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108/* defines only for the constants which don't work well as enums */
109#define ATA_TAG_POISON 0xfafbfcfdU
110
111/* move to PCI layer? */
Jeff Garzik54bb3a942006-09-27 22:20:11 -0400112#define PCI_VDEVICE(vendor, device) \
113 PCI_VENDOR_ID_##vendor, (device), \
114 PCI_ANY_ID, PCI_ANY_ID, 0, 0
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
117{
118 return &pdev->dev;
119}
120
121enum {
122 /* various global constants */
123 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
124 ATA_MAX_PORTS = 8,
125 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900126 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900127 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900128 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 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,
Jeff Garzikcf482932005-10-22 00:19:33 -0400136 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900139 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
140 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400141 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900142 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900143 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heoea1dd4e2006-04-02 18:51:53 +0900144 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900145
Tejun Heoe5c9e082006-09-30 19:44:39 +0900146 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
Tejun Heo33435712006-10-19 14:44:53 +0900147 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
Tejun Heoe5c9e082006-09-30 19:44:39 +0900148 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900149 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Tejun Heoabdda732006-05-31 18:27:29 +0900151 ATA_DFLAG_DETACH = (1 << 16),
152 ATA_DFLAG_DETACHED = (1 << 17),
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 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) */
159 ATA_DEV_NONE = 5, /* no device */
160
161 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900162 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900164 ATA_FLAG_SATA = (1 << 1),
165 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
166 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
167 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
168 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
169 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
170 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
171 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900172 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
173 * doesn't handle PIO interrupts */
174 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Tejun Heoabdda732006-05-31 18:27:29 +0900175 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
176 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
177 * Register FIS clearing BSY */
Tejun Heo7395acb2006-05-31 18:27:25 +0900178 ATA_FLAG_DEBUGMSG = (1 << 13),
Jens Axboe9b847542006-01-06 09:28:07 +0100179
Tejun Heob51e9e52006-06-29 01:29:30 +0900180 /* The following flag belongs to ap->pflags but is kept in
181 * ap->flags because it's referenced in many LLDs and will be
182 * removed in not-too-distant future.
183 */
184 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900185
Tejun Heob51e9e52006-06-29 01:29:30 +0900186 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000187
Tejun Heob51e9e52006-06-29 01:29:30 +0900188 /* struct ata_port pflags */
189 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
190 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
191 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
192 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
193 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
194 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
195 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
196
197 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
198 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900199 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heodde44582006-02-02 00:56:10 +0900200
Tejun Heo949b38a2006-04-02 18:51:52 +0900201 /* struct ata_queued_cmd flags */
202 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
203 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
204 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900206 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900207 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
208
Tejun Heo9ec957f2006-05-15 20:57:58 +0900209 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
210 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
211 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100213 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400214 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000217 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
218 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900219 ATA_TMOUT_INTERNAL = 30 * HZ,
220 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222 /* ATA bus states */
223 BUS_UNKNOWN = 0,
224 BUS_DMA = 1,
225 BUS_IDLE = 2,
226 BUS_NOINTR = 3,
227 BUS_NODATA = 4,
228 BUS_TIMER = 5,
229 BUS_PIO = 6,
230 BUS_EDD = 7,
231 BUS_IDENTIFY = 8,
232 BUS_PACKET = 9,
233
234 /* SATA port states */
235 PORT_UNKNOWN = 0,
236 PORT_ENABLED = 1,
237 PORT_DISABLED = 2,
238
239 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900240 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 */
Alan Coxb352e572006-08-10 18:52:12 +0100242 ATA_BITS_PIO = 7,
243 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900244 ATA_BITS_UDMA = 8,
245
246 ATA_SHIFT_PIO = 0,
247 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
248 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
249
250 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
251 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
252 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400253
254 /* size of buffer to pad xfers ending on unaligned boundaries */
255 ATA_DMA_PAD_SZ = 4,
256 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900257
258 /* masks for port functions */
Alan Cox47a86592005-10-04 08:09:19 -0400259 ATA_PORT_PRIMARY = (1 << 0),
260 ATA_PORT_SECONDARY = (1 << 1),
Tejun Heo14d2bac2006-04-02 17:54:46 +0900261
Tejun Heo0c247c52006-05-15 20:58:19 +0900262 /* ering size */
263 ATA_ERING_SIZE = 32,
264
Tejun Heof3e81b12006-05-15 20:58:21 +0900265 /* desc_len for ata_eh_info and context */
266 ATA_EH_DESC_LEN = 80,
267
Tejun Heo9be1e972006-05-15 20:58:17 +0900268 /* reset / recovery action types */
269 ATA_EH_REVALIDATE = (1 << 0),
270 ATA_EH_SOFTRESET = (1 << 1),
271 ATA_EH_HARDRESET = (1 << 2),
Tejun Heo02670bf2006-07-03 16:07:26 +0900272 ATA_EH_SUSPEND = (1 << 3),
273 ATA_EH_RESUME = (1 << 4),
274 ATA_EH_PM_FREEZE = (1 << 5),
Tejun Heo9be1e972006-05-15 20:58:17 +0900275
276 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heo02670bf2006-07-03 16:07:26 +0900277 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
278 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900279
Tejun Heof3e81b12006-05-15 20:58:21 +0900280 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900281 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900282 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900283 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
284 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900285
286 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
Tejun Heoefdaedc2006-11-01 18:38:52 +0900287 ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */
Tejun Heobaa1e782006-11-01 18:39:27 +0900288 ATA_EHI_SETMODE = (1 << 18), /* configure transfer mode */
289 ATA_EHI_POST_SETMODE = (1 << 19), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900290
Tejun Heo13abf502006-07-10 23:18:46 +0900291 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
292
Tejun Heoad9e2762006-05-15 20:58:12 +0900293 /* max repeat if error condition is still set after ->error_handler */
294 ATA_EH_MAX_REPEAT = 5,
295
Tejun Heo14d2bac2006-04-02 17:54:46 +0900296 /* how hard are we gonna try to probe/recover devices */
297 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900298 ATA_EH_RESET_TRIES = 3,
299 ATA_EH_DEV_TRIES = 3,
Tejun Heof5914a42006-05-31 18:27:48 +0900300
301 /* Drive spinup time (time from power-on to the first D2H FIS)
302 * in msecs - 8s currently. Failing to get ready in this time
303 * isn't critical. It will result in reset failure for
304 * controllers which can't wait for the first D2H FIS. libata
305 * will retry, so it just has to be long enough to spin up
306 * most devices.
307 */
308 ATA_SPINUP_WAIT = 8000,
Alan Cox93590852006-09-12 16:55:12 +0100309
310 /* Horkage types. May be set by libata or controller on drives
311 (some horkage may be drive/controller pair dependant */
312
313 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700314 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
315 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316};
317
Albert Lee14be71f2005-09-27 17:36:35 +0800318enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800319 HSM_ST_UNKNOWN, /* state unknown */
320 HSM_ST_IDLE, /* no command on going */
Albert Leec56b14d22005-09-30 19:07:39 +0800321 HSM_ST, /* (waiting the device to) transfer data */
322 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800323 HSM_ST_ERR, /* error */
324 HSM_ST_FIRST, /* (waiting the device to)
325 write CDB or first data block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326};
327
Jeff Garzika7dac442005-10-30 04:44:42 -0500328enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900329 AC_ERR_DEV = (1 << 0), /* device reported error */
330 AC_ERR_HSM = (1 << 1), /* host state machine violation */
331 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
332 AC_ERR_MEDIA = (1 << 3), /* media error */
333 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
334 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
335 AC_ERR_SYSTEM = (1 << 6), /* system error */
336 AC_ERR_INVALID = (1 << 7), /* invalid argument */
337 AC_ERR_OTHER = (1 << 8), /* unknown */
Jeff Garzika7dac442005-10-30 04:44:42 -0500338};
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340/* forward declarations */
341struct scsi_device;
342struct ata_port_operations;
343struct ata_port;
344struct ata_queued_cmd;
345
346/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900347typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heof5914a42006-05-31 18:27:48 +0900348typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
349typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
350typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352struct ata_ioports {
353 unsigned long cmd_addr;
354 unsigned long data_addr;
355 unsigned long error_addr;
356 unsigned long feature_addr;
357 unsigned long nsect_addr;
358 unsigned long lbal_addr;
359 unsigned long lbam_addr;
360 unsigned long lbah_addr;
361 unsigned long device_addr;
362 unsigned long status_addr;
363 unsigned long command_addr;
364 unsigned long altstatus_addr;
365 unsigned long ctl_addr;
366 unsigned long bmdma_addr;
367 unsigned long scr_addr;
368};
369
370struct ata_probe_ent {
371 struct list_head node;
372 struct device *dev;
Jeff Garzik057ace52005-10-22 14:27:05 -0400373 const struct ata_port_operations *port_ops;
Jeff Garzik193515d2005-11-07 00:59:37 -0500374 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 struct ata_ioports port[ATA_MAX_PORTS];
376 unsigned int n_ports;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900377 unsigned int dummy_port_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 unsigned int pio_mask;
379 unsigned int mwdma_mask;
380 unsigned int udma_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900382 unsigned long irq2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 unsigned int irq_flags;
Jeff Garzikcca39742006-08-24 03:19:22 -0400384 unsigned long port_flags;
385 unsigned long _host_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 void __iomem *mmio_base;
387 void *private_data;
Tejun Heofea63e32006-09-16 03:04:15 +0900388
389 /* port_info for the secondary port. Together with irq2, it's
390 * used to implement non-uniform secondary port. Currently,
391 * the only user is ata_piix combined mode. This workaround
392 * will be removed together with ata_probe_ent when init model
393 * is updated.
394 */
395 const struct ata_port_info *pinfo2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396};
397
Jeff Garzikcca39742006-08-24 03:19:22 -0400398struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 spinlock_t lock;
400 struct device *dev;
401 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900402 unsigned long irq2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 void __iomem *mmio_base;
404 unsigned int n_ports;
405 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400406 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100407 unsigned long flags;
408 int simplex_claimed; /* Keep seperate in case we
409 ever need to do this locked */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900410 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411};
412
413struct ata_queued_cmd {
414 struct ata_port *ap;
415 struct ata_device *dev;
416
417 struct scsi_cmnd *scsicmd;
418 void (*scsidone)(struct scsi_cmnd *);
419
420 struct ata_taskfile tf;
421 u8 cdb[ATAPI_CDB_LEN];
422
423 unsigned long flags; /* ATA_QCFLAG_xxx */
424 unsigned int tag;
425 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400426 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
428 int dma_dir;
429
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400430 unsigned int pad_len;
431
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 unsigned int nsect;
433 unsigned int cursect;
434
435 unsigned int nbytes;
436 unsigned int curbytes;
437
438 unsigned int cursg;
439 unsigned int cursg_ofs;
440
441 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400442 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 void *buf_virt;
444
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400445 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
446 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Albert Leea22e2eb2005-12-05 15:38:02 +0800448 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900449 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 ata_qc_cb_t complete_fn;
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 void *private_data;
453};
454
Jeff Garzikcca39742006-08-24 03:19:22 -0400455struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 unsigned long unhandled_irq;
457 unsigned long idle_irq;
458 unsigned long rw_reqbuf;
459};
460
Tejun Heo0c247c52006-05-15 20:58:19 +0900461struct ata_ering_entry {
462 int is_io;
463 unsigned int err_mask;
464 u64 timestamp;
465};
466
467struct ata_ering {
468 int cursor;
469 struct ata_ering_entry ring[ATA_ERING_SIZE];
470};
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472struct ata_device {
Tejun Heo38d87232006-05-15 20:57:51 +0900473 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900475 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900476 struct scsi_device *sdev; /* attached SCSI device */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900477 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
478 u64 n_sectors; /* size of device, if ATA */
479 unsigned int class; /* ATA_DEV_xxx */
Tejun Heofe635c72006-05-15 20:57:35 +0900480 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 u8 pio_mode;
482 u8 dma_mode;
483 u8 xfer_mode;
484 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
485
Albert Lee8cbd6df2005-10-12 15:06:27 +0800486 unsigned int multi_count; /* sectors count for
487 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900488 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900489 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400490
Tejun Heoacf356b2006-03-24 14:07:50 +0900491 /* per-dev xfer mask */
492 unsigned int pio_mask;
493 unsigned int mwdma_mask;
494 unsigned int udma_mask;
495
Albert Lee8bf62ece2005-05-12 15:29:42 -0400496 /* for CHS addressing */
497 u16 cylinders; /* Number of cylinders */
498 u16 heads; /* Number of heads */
499 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900500
501 /* error history */
502 struct ata_ering ering;
Alan Cox93590852006-09-12 16:55:12 +0100503 unsigned int horkage; /* List of broken features */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504};
505
Tejun Heo72fa4b72006-05-31 18:27:32 +0900506/* Offset into struct ata_device. Fields above it are maintained
507 * acress device init. Fields below are zeroed.
508 */
509#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
510
Tejun Heof3e81b12006-05-15 20:58:21 +0900511struct ata_eh_info {
512 struct ata_device *dev; /* offending device */
513 u32 serror; /* SError from LLDD */
514 unsigned int err_mask; /* port-wide err_mask */
515 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900516 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900517 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900518
519 unsigned long hotplug_timestamp;
520 unsigned int probe_mask;
521
Tejun Heof3e81b12006-05-15 20:58:21 +0900522 char desc[ATA_EH_DESC_LEN];
523 int desc_len;
524};
525
526struct ata_eh_context {
527 struct ata_eh_info i;
528 int tries[ATA_MAX_DEVICES];
Tejun Heoabdda732006-05-31 18:27:29 +0900529 unsigned int classes[ATA_MAX_DEVICES];
530 unsigned int did_probe_mask;
Tejun Heof3e81b12006-05-15 20:58:21 +0900531};
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400534 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400535 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400536 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900538 unsigned int pflags; /* ATA_PFLAG_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 unsigned int id; /* unique id req'd by scsi midlyr */
540 unsigned int port_no; /* unique port #; from zero */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542 struct ata_prd *prd; /* our SG list */
543 dma_addr_t prd_dma; /* and its DMA mapping */
544
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400545 void *pad; /* array of DMA pad buffers */
546 dma_addr_t pad_dma;
547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
549
550 u8 ctl; /* cache of ATA control register */
551 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 unsigned int pio_mask;
553 unsigned int mwdma_mask;
554 unsigned int udma_mask;
555 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Tejun Heo5a04bf42006-05-31 18:27:38 +0900556 unsigned int hw_sata_spd_limit;
Tejun Heo1c3fae42006-04-02 20:53:28 +0900557 unsigned int sata_spd_limit; /* SATA PHY speed limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Jeff Garzikcca39742006-08-24 03:19:22 -0400559 /* record runtime error info, protected by host lock */
Tejun Heof3e81b12006-05-15 20:58:21 +0900560 struct ata_eh_info eh_info;
561 /* EH context owned by EH */
562 struct ata_eh_context eh_context;
563
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 struct ata_device device[ATA_MAX_DEVICES];
565
566 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900567 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900568 unsigned int qc_active;
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 unsigned int active_tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900571 u32 sactive;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Jeff Garzikcca39742006-08-24 03:19:22 -0400573 struct ata_port_stats stats;
574 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600575 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Tejun Heo9a9c77dc2006-06-11 11:19:00 +0900577 struct work_struct port_task;
578 struct work_struct hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400579 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900580
Albert Lee14be71f2005-09-27 17:36:35 +0800581 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Randy Dunlapbfd60572006-01-17 19:34:42 -0500583 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900584 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900585 wait_queue_head_t eh_wait_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500586
Tejun Heo500530f2006-07-03 16:07:27 +0900587 pm_message_t pm_mesg;
588 int *pm_result;
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900591
592 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593};
594
595struct ata_port_operations {
596 void (*port_disable) (struct ata_port *);
597
598 void (*dev_config) (struct ata_port *, struct ata_device *);
599
600 void (*set_piomode) (struct ata_port *, struct ata_device *);
601 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Cox5444a6f2006-03-27 18:58:20 +0100602 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Jeff Garzik057ace52005-10-22 14:27:05 -0400604 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
606
Jeff Garzik057ace52005-10-22 14:27:05 -0400607 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 u8 (*check_status)(struct ata_port *ap);
609 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 void (*dev_select)(struct ata_port *ap, unsigned int device);
611
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900612 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alan Coxe35a9e02006-03-27 18:46:37 +0100613 void (*set_mode) (struct ata_port *ap);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900614
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 void (*post_set_mode) (struct ata_port *ap);
616
617 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
618
619 void (*bmdma_setup) (struct ata_queued_cmd *qc);
620 void (*bmdma_start) (struct ata_queued_cmd *qc);
621
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100622 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900625 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Tejun Heo9ec957f2006-05-15 20:57:58 +0900627 /* Error handlers. ->error_handler overrides ->eng_timeout and
628 * indicates that new-style EH is in place.
629 */
630 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
631
632 void (*freeze) (struct ata_port *ap);
633 void (*thaw) (struct ata_port *ap);
634 void (*error_handler) (struct ata_port *ap);
635 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
David Howells7d12e782006-10-05 14:55:46 +0100637 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 void (*irq_clear) (struct ata_port *);
639
640 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
641 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
642 u32 val);
643
Tejun Heo500530f2006-07-03 16:07:27 +0900644 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
645 int (*port_resume) (struct ata_port *ap);
646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 int (*port_start) (struct ata_port *ap);
648 void (*port_stop) (struct ata_port *ap);
649
Jeff Garzikcca39742006-08-24 03:19:22 -0400650 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Alan Coxb73fc892005-08-26 16:03:19 +0100652 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 u8 (*bmdma_status) (struct ata_port *ap);
654};
655
656struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100657 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400658 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 unsigned long pio_mask;
660 unsigned long mwdma_mask;
661 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400662 const struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000663 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664};
665
Alan Cox452503f2005-10-21 19:01:32 -0400666struct ata_timing {
667 unsigned short mode; /* ATA mode */
668 unsigned short setup; /* t1 */
669 unsigned short act8b; /* t2 for 8-bit I/O */
670 unsigned short rec8b; /* t2i for 8-bit I/O */
671 unsigned short cyc8b; /* t0 for 8-bit I/O */
672 unsigned short active; /* t2 or tD */
673 unsigned short recover; /* t2i or tK */
674 unsigned short cycle; /* t0 */
675 unsigned short udma; /* t2CYCTYP/2 */
676};
677
678#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Tejun Heoe9c83912006-07-03 16:07:26 +0900680extern const unsigned long sata_deb_timing_normal[];
681extern const unsigned long sata_deb_timing_hotplug[];
682extern const unsigned long sata_deb_timing_long[];
683
Tejun Heodd5b06c2006-08-10 16:59:12 +0900684extern const struct ata_port_operations ata_dummy_port_ops;
685
Tejun Heoe9c83912006-07-03 16:07:26 +0900686static inline const unsigned long *
687sata_ehc_deb_timing(struct ata_eh_context *ehc)
688{
689 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
690 return sata_deb_timing_hotplug;
691 else
692 return sata_deb_timing_normal;
693}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900694
Tejun Heodd5b06c2006-08-10 16:59:12 +0900695static inline int ata_port_is_dummy(struct ata_port *ap)
696{
697 return ap->ops == &ata_dummy_port_ops;
698}
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700extern void ata_port_probe(struct ata_port *);
701extern void __sata_phy_reset(struct ata_port *ap);
702extern void sata_phy_reset(struct ata_port *ap);
703extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo3c567b72006-05-15 20:57:23 +0900704extern int sata_set_spd(struct ata_port *ap);
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900705extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
706extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
Tejun Heof5914a42006-05-31 18:27:48 +0900707extern int ata_std_prereset(struct ata_port *ap);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900708extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
Tejun Heob6103f62006-11-01 17:59:53 +0900709extern int sata_port_hardreset(struct ata_port *ap,
710 const unsigned long *timing);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900711extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900712extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713extern void ata_port_disable(struct ata_port *);
714extern void ata_std_ports(struct ata_ioports *ioaddr);
715#ifdef CONFIG_PCI
716extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
717 unsigned int n_ports);
718extern void ata_pci_remove_one (struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900719extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
Tejun Heo500530f2006-07-03 16:07:27 +0900720extern void ata_pci_device_do_resume(struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900721extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
Jens Axboe9b847542006-01-06 09:28:07 +0100722extern int ata_pci_device_resume(struct pci_dev *pdev);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500723extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724#endif /* CONFIG_PCI */
Jeff Garzik057ace52005-10-22 14:27:05 -0400725extern int ata_device_add(const struct ata_probe_ent *ent);
Tejun Heo720ba122006-05-31 18:28:13 +0900726extern void ata_port_detach(struct ata_port *ap);
Jeff Garzikcca39742006-08-24 03:19:22 -0400727extern void ata_host_init(struct ata_host *, struct device *,
728 unsigned long, const struct ata_port_operations *);
729extern void ata_host_remove(struct ata_host *host);
Jeff Garzik193515d2005-11-07 00:59:37 -0500730extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
732extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733extern int ata_scsi_release(struct Scsi_Host *host);
Brian King80289162006-08-07 14:27:31 -0500734extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400735extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500736 struct ata_port_info *, struct Scsi_Host *);
737extern int ata_sas_port_init(struct ata_port *);
738extern int ata_sas_port_start(struct ata_port *ap);
739extern void ata_sas_port_stop(struct ata_port *ap);
740extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
741extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
742 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo34bf2172006-05-15 20:57:46 +0900744extern int sata_scr_valid(struct ata_port *ap);
745extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
746extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
747extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
748extern int ata_port_online(struct ata_port *ap);
749extern int ata_port_offline(struct ata_port *ap);
Jens Axboe9b847542006-01-06 09:28:07 +0100750extern int ata_scsi_device_resume(struct scsi_device *);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900751extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
Jeff Garzikcca39742006-08-24 03:19:22 -0400752extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
753extern void ata_host_resume(struct ata_host *host);
Jeff Garzik67846b32005-10-05 02:58:32 -0400754extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900755extern int ata_busy_sleep(struct ata_port *ap,
756 unsigned long timeout_pat, unsigned long timeout);
Tejun Heo86e45b62006-03-05 15:29:09 +0900757extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
758 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900759extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
760 unsigned long interval_msec,
761 unsigned long timeout_msec);
Jeff Garzik67846b32005-10-05 02:58:32 -0400762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763/*
764 * Default driver ops implementations
765 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400766extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400768extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
769extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
771extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
772extern u8 ata_check_status(struct ata_port *ap);
773extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400774extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775extern int ata_port_start (struct ata_port *ap);
776extern void ata_port_stop (struct ata_port *ap);
Jeff Garzikcca39742006-08-24 03:19:22 -0400777extern void ata_host_stop (struct ata_host *host);
David Howells7d12e782006-10-05 14:55:46 +0100778extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100779extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
780 unsigned int buflen, int write_data);
781extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
782 unsigned int buflen, int write_data);
Alan Cox75e99582006-05-24 14:14:41 +0100783extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
784 unsigned int buflen, int write_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600786extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900787extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
789 unsigned int buflen);
790extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
791 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400792extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Tejun Heo6a62a042006-02-13 10:02:46 +0900793extern void ata_id_string(const u16 *id, unsigned char *s,
794 unsigned int ofs, unsigned int len);
795extern void ata_id_c_string(const u16 *id, unsigned char *s,
796 unsigned int ofs, unsigned int len);
Alan Cox6919a0a2006-10-27 19:08:46 -0700797extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
799extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100800extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801extern u8 ata_bmdma_status(struct ata_port *ap);
802extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900803extern void ata_bmdma_freeze(struct ata_port *ap);
804extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900805extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900806 ata_reset_fn_t softreset,
807 ata_reset_fn_t hardreset,
808 ata_postreset_fn_t postreset);
809extern void ata_bmdma_error_handler(struct ata_port *ap);
810extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900811extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
812 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900813extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900814extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
815 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900816extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 void (*done)(struct scsi_cmnd *));
818extern int ata_std_bios_param(struct scsi_device *sdev,
819 struct block_device *bdev,
820 sector_t capacity, int geom[]);
821extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900822extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900823extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
824 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900825extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Alan Cox452503f2005-10-21 19:01:32 -0400827/*
828 * Timing helpers
829 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000830
831extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400832extern int ata_timing_compute(struct ata_device *, unsigned short,
833 struct ata_timing *, int, int);
834extern void ata_timing_merge(const struct ata_timing *,
835 const struct ata_timing *, struct ata_timing *,
836 unsigned int);
837
838enum {
839 ATA_TIMING_SETUP = (1 << 0),
840 ATA_TIMING_ACT8B = (1 << 1),
841 ATA_TIMING_REC8B = (1 << 2),
842 ATA_TIMING_CYC8B = (1 << 3),
843 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
844 ATA_TIMING_CYC8B,
845 ATA_TIMING_ACTIVE = (1 << 4),
846 ATA_TIMING_RECOVER = (1 << 5),
847 ATA_TIMING_CYCLE = (1 << 6),
848 ATA_TIMING_UDMA = (1 << 7),
849 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
850 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
851 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
852 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
853};
854
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
856#ifdef CONFIG_PCI
857struct pci_bits {
858 unsigned int reg; /* PCI config register to read */
859 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
860 unsigned long mask;
861 unsigned long val;
862};
863
Jeff Garzikcca39742006-08-24 03:19:22 -0400864extern void ata_pci_host_stop (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400866ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Jeff Garzik057ace52005-10-22 14:27:05 -0400867extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500868extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869#endif /* CONFIG_PCI */
870
Tejun Heoece1d632006-04-02 18:51:53 +0900871/*
872 * EH
873 */
Tejun Heoece1d632006-04-02 18:51:53 +0900874extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900875
876extern void ata_port_schedule_eh(struct ata_port *ap);
877extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900878extern int ata_port_freeze(struct ata_port *ap);
879
880extern void ata_eh_freeze_port(struct ata_port *ap);
881extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900882
Tejun Heoece1d632006-04-02 18:51:53 +0900883extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
884extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
885
Tejun Heof5914a42006-05-31 18:27:48 +0900886extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
887 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
888 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900889
Tejun Heo61440db2006-05-15 20:57:55 +0900890/*
891 * printk helpers
892 */
893#define ata_port_printk(ap, lv, fmt, args...) \
894 printk(lv"ata%u: "fmt, (ap)->id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Tejun Heo61440db2006-05-15 20:57:55 +0900896#define ata_dev_printk(dev, lv, fmt, args...) \
897 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
898
899/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900900 * ata_eh_info helpers
901 */
902#define ata_ehi_push_desc(ehi, fmt, args...) do { \
903 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
904 ATA_EH_DESC_LEN - (ehi)->desc_len, \
905 fmt , ##args); \
906} while (0)
907
908#define ata_ehi_clear_desc(ehi) do { \
909 (ehi)->desc[0] = '\0'; \
910 (ehi)->desc_len = 0; \
911} while (0)
912
Tejun Heoc0b6c032006-07-03 16:07:26 +0900913static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +0900914{
915 if (ehi->flags & ATA_EHI_HOTPLUGGED)
916 return;
917
Tejun Heo28324302006-07-03 16:07:26 +0900918 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +0900919 ehi->hotplug_timestamp = jiffies;
920
Tejun Heo084fe632006-05-31 18:28:03 +0900921 ehi->action |= ATA_EH_SOFTRESET;
922 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
923}
924
Tejun Heoc0b6c032006-07-03 16:07:26 +0900925static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
926{
927 __ata_ehi_hotplugged(ehi);
928 ehi->err_mask |= AC_ERR_ATA_BUS;
929}
930
Tejun Heof3e81b12006-05-15 20:58:21 +0900931/*
Tejun Heo61440db2006-05-15 20:57:55 +0900932 * qc helpers
933 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400934static inline int
935ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
936{
937 if (sg == &qc->pad_sgent)
938 return 1;
939 if (qc->pad_len)
940 return 0;
941 if (((sg - qc->__sg) + 1) == qc->n_elem)
942 return 1;
943 return 0;
944}
945
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400946static inline struct scatterlist *
Tejun Heocc1887f32006-02-20 23:48:38 +0900947ata_qc_first_sg(struct ata_queued_cmd *qc)
948{
949 if (qc->n_elem)
950 return qc->__sg;
951 if (qc->pad_len)
952 return &qc->pad_sgent;
953 return NULL;
954}
955
956static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400957ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
958{
959 if (sg == &qc->pad_sgent)
960 return NULL;
961 if (++sg - qc->__sg < qc->n_elem)
962 return sg;
Tejun Heocc1887f32006-02-20 23:48:38 +0900963 if (qc->pad_len)
964 return &qc->pad_sgent;
965 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400966}
967
968#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f32006-02-20 23:48:38 +0900969 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400970
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971static inline unsigned int ata_tag_valid(unsigned int tag)
972{
973 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
974}
975
Tejun Heo2ab7db12006-05-15 20:58:02 +0900976static inline unsigned int ata_tag_internal(unsigned int tag)
977{
978 return tag == ATA_MAX_QUEUE - 1;
979}
980
Tejun Heo5806db22006-06-24 20:30:19 +0900981/*
982 * device helpers
983 */
Tejun Heoe1211e32006-04-01 01:38:18 +0900984static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +0900985{
986 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
987}
988
Tejun Heoe1211e32006-04-01 01:38:18 +0900989static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990{
Tejun Heoe1211e32006-04-01 01:38:18 +0900991 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
992}
993
Tejun Heo002c8052006-04-02 17:54:46 +0900994static inline unsigned int ata_class_absent(unsigned int class)
995{
996 return !ata_class_enabled(class) && !ata_class_disabled(class);
997}
998
Tejun Heoe1211e32006-04-01 01:38:18 +0900999static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1000{
1001 return ata_class_enabled(dev->class);
1002}
1003
1004static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1005{
1006 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007}
1008
Tejun Heo002c8052006-04-02 17:54:46 +09001009static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1010{
1011 return ata_class_absent(dev->class);
1012}
1013
Tejun Heo02670bf2006-07-03 16:07:26 +09001014static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1015{
1016 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1017}
1018
Tejun Heo5806db22006-06-24 20:30:19 +09001019/*
1020 * port helpers
1021 */
1022static inline int ata_port_max_devices(const struct ata_port *ap)
1023{
1024 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1025 return 2;
1026 return 1;
1027}
1028
1029
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030static inline u8 ata_chk_status(struct ata_port *ap)
1031{
1032 return ap->ops->check_status(ap);
1033}
1034
Edward Falk0baab862005-06-02 18:17:13 -04001035
1036/**
1037 * ata_pause - Flush writes and pause 400 nanoseconds.
1038 * @ap: Port to wait for.
1039 *
1040 * LOCKING:
1041 * Inherited from caller.
1042 */
1043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044static inline void ata_pause(struct ata_port *ap)
1045{
1046 ata_altstatus(ap);
1047 ndelay(400);
1048}
1049
Edward Falk0baab862005-06-02 18:17:13 -04001050
1051/**
1052 * ata_busy_wait - Wait for a port status register
1053 * @ap: Port to wait for.
1054 *
1055 * Waits up to max*10 microseconds for the selected bits in the port's
1056 * status register to be cleared.
1057 * Returns final value of status register.
1058 *
1059 * LOCKING:
1060 * Inherited from caller.
1061 */
1062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1064 unsigned int max)
1065{
1066 u8 status;
1067
1068 do {
1069 udelay(10);
1070 status = ata_chk_status(ap);
1071 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001072 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
1074 return status;
1075}
1076
Edward Falk0baab862005-06-02 18:17:13 -04001077
1078/**
1079 * ata_wait_idle - Wait for a port to be idle.
1080 * @ap: Port to wait for.
1081 *
1082 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1083 * Returns final value of status register.
1084 *
1085 * LOCKING:
1086 * Inherited from caller.
1087 */
1088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089static inline u8 ata_wait_idle(struct ata_port *ap)
1090{
1091 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1092
Tejun Heod1adc1b2006-10-09 18:32:15 +09001093 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 unsigned long l = ap->ioaddr.status_addr;
Randy Dunlapbfd60572006-01-17 19:34:42 -05001095 if (ata_msg_warn(ap))
1096 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1097 status, l);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 }
1099
1100 return status;
1101}
1102
1103static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1104{
1105 qc->tf.ctl |= ATA_NIEN;
1106}
1107
Tejun Heof69499f2006-05-15 20:58:03 +09001108static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1109 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110{
1111 if (likely(ata_tag_valid(tag)))
1112 return &ap->qcmd[tag];
1113 return NULL;
1114}
1115
Tejun Heof69499f2006-05-15 20:58:03 +09001116static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1117 unsigned int tag)
1118{
1119 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1120
1121 if (unlikely(!qc) || !ap->ops->error_handler)
1122 return qc;
1123
1124 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1125 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1126 return qc;
1127
1128 return NULL;
1129}
1130
Tejun Heo3373efd2006-05-15 20:57:53 +09001131static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132{
1133 memset(tf, 0, sizeof(*tf));
1134
Tejun Heo3373efd2006-05-15 20:57:53 +09001135 tf->ctl = dev->ap->ctl;
1136 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 tf->device = ATA_DEVICE_OBS;
1138 else
1139 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1140}
1141
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001142static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1143{
1144 qc->__sg = NULL;
1145 qc->flags = 0;
1146 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1147 qc->nsect = 0;
1148 qc->nbytes = qc->curbytes = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001149 qc->err_mask = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001150
Tejun Heo3373efd2006-05-15 20:57:53 +09001151 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001152
1153 /* init result_tf such that it indicates normal completion */
1154 qc->result_tf.command = ATA_DRDY;
1155 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001156}
1157
Tejun Heo76014422006-02-11 15:13:49 +09001158/**
Edward Falk0baab862005-06-02 18:17:13 -04001159 * ata_irq_ack - Acknowledge a device interrupt.
1160 * @ap: Port on which interrupts are enabled.
1161 *
1162 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1163 * or BUSY+DRQ clear). Obtain dma status and port status from
1164 * device. Clear the interrupt. Return port status.
1165 *
1166 * LOCKING:
1167 */
1168
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1170{
1171 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1172 u8 host_stat, post_stat, status;
1173
1174 status = ata_busy_wait(ap, bits, 1000);
1175 if (status & bits)
Randy Dunlapbfd60572006-01-17 19:34:42 -05001176 if (ata_msg_err(ap))
1177 printk(KERN_ERR "abnormal status 0x%X\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
1179 /* get controller status; clear intr, err bits */
1180 if (ap->flags & ATA_FLAG_MMIO) {
1181 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1182 host_stat = readb(mmio + ATA_DMA_STATUS);
1183 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1184 mmio + ATA_DMA_STATUS);
1185
1186 post_stat = readb(mmio + ATA_DMA_STATUS);
1187 } else {
1188 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1189 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1190 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1191
1192 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1193 }
1194
Randy Dunlapbfd60572006-01-17 19:34:42 -05001195 if (ata_msg_intr(ap))
1196 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1197 __FUNCTION__,
1198 host_stat, post_stat, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
1200 return status;
1201}
1202
Jeff Garzik057ace52005-10-22 14:27:05 -04001203static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204{
1205 return ata_id_wcache_enabled(dev->id) ||
1206 ata_id_has_flush(dev->id) ||
1207 ata_id_has_flush_ext(dev->id);
1208}
1209
Jeff Garzika7dac442005-10-30 04:44:42 -05001210static inline unsigned int ac_err_mask(u8 status)
1211{
Albert Lee3655d1d2006-05-19 11:43:04 +08001212 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001213 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001214 if (status & (ATA_ERR | ATA_DF))
1215 return AC_ERR_DEV;
1216 return 0;
1217}
1218
1219static inline unsigned int __ac_err_mask(u8 status)
1220{
1221 unsigned int mask = ac_err_mask(status);
1222 if (mask == 0)
1223 return AC_ERR_OTHER;
1224 return mask;
1225}
1226
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001227static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1228{
1229 ap->pad_dma = 0;
1230 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1231 &ap->pad_dma, GFP_KERNEL);
1232 return (ap->pad == NULL) ? -ENOMEM : 0;
1233}
1234
1235static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1236{
1237 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1238}
1239
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001240static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1241{
1242 return (struct ata_port *) &host->hostdata[0];
1243}
1244
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245#endif /* __LINUX_LIBATA_H__ */