blob: dab4dc505ce751196b071c94e6f6e574f606d1a8 [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? */
112static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
113{
114 return &pdev->dev;
115}
116
117enum {
118 /* various global constants */
119 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
120 ATA_MAX_PORTS = 8,
121 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900122 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900123 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900124 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 ATA_MAX_BUS = 2,
126 ATA_DEF_BUSY_WAIT = 10000,
127 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
128
129 ATA_SHT_EMULATED = 1,
130 ATA_SHT_CMD_PER_LUN = 1,
131 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400132 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900135 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
136 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400137 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900138 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900139 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heoea1dd4e2006-04-02 18:51:53 +0900140 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900141
Tejun Heoe5c9e082006-09-30 19:44:39 +0900142 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
Tejun Heo33435712006-10-19 14:44:53 +0900143 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
Tejun Heoe5c9e082006-09-30 19:44:39 +0900144 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900145 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Tejun Heoabdda732006-05-31 18:27:29 +0900147 ATA_DFLAG_DETACH = (1 << 16),
148 ATA_DFLAG_DETACHED = (1 << 17),
149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 ATA_DEV_UNKNOWN = 0, /* unknown device */
151 ATA_DEV_ATA = 1, /* ATA device */
152 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
153 ATA_DEV_ATAPI = 3, /* ATAPI device */
154 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
155 ATA_DEV_NONE = 5, /* no device */
156
157 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900158 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900160 ATA_FLAG_SATA = (1 << 1),
161 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
162 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
163 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
164 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
165 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
166 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
167 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900168 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
169 * doesn't handle PIO interrupts */
170 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Tejun Heoabdda732006-05-31 18:27:29 +0900171 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
172 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
173 * Register FIS clearing BSY */
Tejun Heo7395acb2006-05-31 18:27:25 +0900174 ATA_FLAG_DEBUGMSG = (1 << 13),
Tejun Heo800b3992006-12-03 21:34:13 +0900175 ATA_FLAG_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900176 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Jens Axboe9b847542006-01-06 09:28:07 +0100177
Tejun Heob51e9e52006-06-29 01:29:30 +0900178 /* The following flag belongs to ap->pflags but is kept in
179 * ap->flags because it's referenced in many LLDs and will be
180 * removed in not-too-distant future.
181 */
182 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900183
Tejun Heob51e9e52006-06-29 01:29:30 +0900184 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000185
Tejun Heob51e9e52006-06-29 01:29:30 +0900186 /* struct ata_port pflags */
187 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
188 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
189 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
190 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
191 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
192 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
193 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
194
195 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
196 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900197 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heodde44582006-02-02 00:56:10 +0900198
Tejun Heo949b38a2006-04-02 18:51:52 +0900199 /* struct ata_queued_cmd flags */
200 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
201 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
202 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900204 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900205 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
206
Tejun Heo9ec957f2006-05-15 20:57:58 +0900207 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
208 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
209 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100211 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400212 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000215 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
216 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900217 ATA_TMOUT_INTERNAL = 30 * HZ,
218 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220 /* ATA bus states */
221 BUS_UNKNOWN = 0,
222 BUS_DMA = 1,
223 BUS_IDLE = 2,
224 BUS_NOINTR = 3,
225 BUS_NODATA = 4,
226 BUS_TIMER = 5,
227 BUS_PIO = 6,
228 BUS_EDD = 7,
229 BUS_IDENTIFY = 8,
230 BUS_PACKET = 9,
231
232 /* SATA port states */
233 PORT_UNKNOWN = 0,
234 PORT_ENABLED = 1,
235 PORT_DISABLED = 2,
236
237 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900238 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 */
Alan Coxb352e572006-08-10 18:52:12 +0100240 ATA_BITS_PIO = 7,
241 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900242 ATA_BITS_UDMA = 8,
243
244 ATA_SHIFT_PIO = 0,
245 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
246 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
247
248 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
249 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
250 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400251
252 /* size of buffer to pad xfers ending on unaligned boundaries */
253 ATA_DMA_PAD_SZ = 4,
254 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900255
256 /* masks for port functions */
Alan Cox47a86592005-10-04 08:09:19 -0400257 ATA_PORT_PRIMARY = (1 << 0),
258 ATA_PORT_SECONDARY = (1 << 1),
Tejun Heo14d2bac2006-04-02 17:54:46 +0900259
Tejun Heo0c247c52006-05-15 20:58:19 +0900260 /* ering size */
261 ATA_ERING_SIZE = 32,
262
Tejun Heof3e81b12006-05-15 20:58:21 +0900263 /* desc_len for ata_eh_info and context */
264 ATA_EH_DESC_LEN = 80,
265
Tejun Heo9be1e972006-05-15 20:58:17 +0900266 /* reset / recovery action types */
267 ATA_EH_REVALIDATE = (1 << 0),
268 ATA_EH_SOFTRESET = (1 << 1),
269 ATA_EH_HARDRESET = (1 << 2),
Tejun Heo02670bf2006-07-03 16:07:26 +0900270 ATA_EH_SUSPEND = (1 << 3),
271 ATA_EH_RESUME = (1 << 4),
272 ATA_EH_PM_FREEZE = (1 << 5),
Tejun Heo9be1e972006-05-15 20:58:17 +0900273
274 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heo02670bf2006-07-03 16:07:26 +0900275 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
276 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900277
Tejun Heof3e81b12006-05-15 20:58:21 +0900278 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900279 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900280 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900281 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
282 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900283
284 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
Tejun Heoefdaedc2006-11-01 18:38:52 +0900285 ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */
Tejun Heobaa1e782006-11-01 18:39:27 +0900286 ATA_EHI_SETMODE = (1 << 18), /* configure transfer mode */
287 ATA_EHI_POST_SETMODE = (1 << 19), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900288
Tejun Heo13abf502006-07-10 23:18:46 +0900289 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
290
Tejun Heoad9e2762006-05-15 20:58:12 +0900291 /* max repeat if error condition is still set after ->error_handler */
292 ATA_EH_MAX_REPEAT = 5,
293
Tejun Heo14d2bac2006-04-02 17:54:46 +0900294 /* how hard are we gonna try to probe/recover devices */
295 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900296 ATA_EH_RESET_TRIES = 3,
297 ATA_EH_DEV_TRIES = 3,
Tejun Heof5914a42006-05-31 18:27:48 +0900298
299 /* Drive spinup time (time from power-on to the first D2H FIS)
300 * in msecs - 8s currently. Failing to get ready in this time
301 * isn't critical. It will result in reset failure for
302 * controllers which can't wait for the first D2H FIS. libata
303 * will retry, so it just has to be long enough to spin up
304 * most devices.
305 */
306 ATA_SPINUP_WAIT = 8000,
Jeff Garzikf20b16f2006-12-11 11:14:06 -0500307
Alan Cox93590852006-09-12 16:55:12 +0100308 /* Horkage types. May be set by libata or controller on drives
309 (some horkage may be drive/controller pair dependant */
310
311 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700312 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
313 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314};
315
Albert Lee14be71f2005-09-27 17:36:35 +0800316enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800317 HSM_ST_IDLE, /* no command on going */
Albert Leec56b14d22005-09-30 19:07:39 +0800318 HSM_ST, /* (waiting the device to) transfer data */
319 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800320 HSM_ST_ERR, /* error */
321 HSM_ST_FIRST, /* (waiting the device to)
322 write CDB or first data block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323};
324
Jeff Garzika7dac442005-10-30 04:44:42 -0500325enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900326 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 */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900335 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Jeff Garzika7dac442005-10-30 04:44:42 -0500336};
337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338/* forward declarations */
339struct scsi_device;
340struct ata_port_operations;
341struct ata_port;
342struct ata_queued_cmd;
343
344/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900345typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heof5914a42006-05-31 18:27:48 +0900346typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
347typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
348typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350struct ata_ioports {
351 unsigned long cmd_addr;
352 unsigned long data_addr;
353 unsigned long error_addr;
354 unsigned long feature_addr;
355 unsigned long nsect_addr;
356 unsigned long lbal_addr;
357 unsigned long lbam_addr;
358 unsigned long lbah_addr;
359 unsigned long device_addr;
360 unsigned long status_addr;
361 unsigned long command_addr;
362 unsigned long altstatus_addr;
363 unsigned long ctl_addr;
364 unsigned long bmdma_addr;
365 unsigned long scr_addr;
366};
367
368struct ata_probe_ent {
369 struct list_head node;
370 struct device *dev;
Jeff Garzik057ace52005-10-22 14:27:05 -0400371 const struct ata_port_operations *port_ops;
Jeff Garzik193515d2005-11-07 00:59:37 -0500372 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 struct ata_ioports port[ATA_MAX_PORTS];
374 unsigned int n_ports;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900375 unsigned int dummy_port_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 unsigned int pio_mask;
377 unsigned int mwdma_mask;
378 unsigned int udma_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900380 unsigned long irq2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 unsigned int irq_flags;
Jeff Garzikcca39742006-08-24 03:19:22 -0400382 unsigned long port_flags;
383 unsigned long _host_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 void __iomem *mmio_base;
385 void *private_data;
Tejun Heofea63e32006-09-16 03:04:15 +0900386
387 /* port_info for the secondary port. Together with irq2, it's
388 * used to implement non-uniform secondary port. Currently,
389 * the only user is ata_piix combined mode. This workaround
390 * will be removed together with ata_probe_ent when init model
391 * is updated.
392 */
393 const struct ata_port_info *pinfo2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394};
395
Jeff Garzikcca39742006-08-24 03:19:22 -0400396struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 spinlock_t lock;
398 struct device *dev;
399 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900400 unsigned long irq2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 void __iomem *mmio_base;
402 unsigned int n_ports;
403 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400404 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100405 unsigned long flags;
406 int simplex_claimed; /* Keep seperate in case we
407 ever need to do this locked */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900408 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409};
410
411struct ata_queued_cmd {
412 struct ata_port *ap;
413 struct ata_device *dev;
414
415 struct scsi_cmnd *scsicmd;
416 void (*scsidone)(struct scsi_cmnd *);
417
418 struct ata_taskfile tf;
419 u8 cdb[ATAPI_CDB_LEN];
420
421 unsigned long flags; /* ATA_QCFLAG_xxx */
422 unsigned int tag;
423 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400424 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426 int dma_dir;
427
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400428 unsigned int pad_len;
429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 unsigned int nsect;
431 unsigned int cursect;
432
433 unsigned int nbytes;
434 unsigned int curbytes;
435
436 unsigned int cursg;
437 unsigned int cursg_ofs;
438
439 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400440 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 void *buf_virt;
442
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400443 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
444 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Albert Leea22e2eb2005-12-05 15:38:02 +0800446 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900447 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 ata_qc_cb_t complete_fn;
449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 void *private_data;
451};
452
Jeff Garzikcca39742006-08-24 03:19:22 -0400453struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 unsigned long unhandled_irq;
455 unsigned long idle_irq;
456 unsigned long rw_reqbuf;
457};
458
Tejun Heo0c247c52006-05-15 20:58:19 +0900459struct ata_ering_entry {
460 int is_io;
461 unsigned int err_mask;
462 u64 timestamp;
463};
464
465struct ata_ering {
466 int cursor;
467 struct ata_ering_entry ring[ATA_ERING_SIZE];
468};
469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470struct ata_device {
Tejun Heo38d87232006-05-15 20:57:51 +0900471 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900473 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900474 struct scsi_device *sdev; /* attached SCSI device */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900475 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
476 u64 n_sectors; /* size of device, if ATA */
477 unsigned int class; /* ATA_DEV_xxx */
Tejun Heofe635c72006-05-15 20:57:35 +0900478 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 u8 pio_mode;
480 u8 dma_mode;
481 u8 xfer_mode;
482 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
483
Albert Lee8cbd6df2005-10-12 15:06:27 +0800484 unsigned int multi_count; /* sectors count for
485 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900486 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900487 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400488
Tejun Heoacf356b2006-03-24 14:07:50 +0900489 /* per-dev xfer mask */
490 unsigned int pio_mask;
491 unsigned int mwdma_mask;
492 unsigned int udma_mask;
493
Albert Lee8bf62ece2005-05-12 15:29:42 -0400494 /* for CHS addressing */
495 u16 cylinders; /* Number of cylinders */
496 u16 heads; /* Number of heads */
497 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900498
499 /* error history */
500 struct ata_ering ering;
Alan Cox93590852006-09-12 16:55:12 +0100501 unsigned int horkage; /* List of broken features */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502};
503
Tejun Heo72fa4b72006-05-31 18:27:32 +0900504/* Offset into struct ata_device. Fields above it are maintained
505 * acress device init. Fields below are zeroed.
506 */
507#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
508
Tejun Heof3e81b12006-05-15 20:58:21 +0900509struct ata_eh_info {
510 struct ata_device *dev; /* offending device */
511 u32 serror; /* SError from LLDD */
512 unsigned int err_mask; /* port-wide err_mask */
513 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900514 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900515 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900516
517 unsigned long hotplug_timestamp;
518 unsigned int probe_mask;
519
Tejun Heof3e81b12006-05-15 20:58:21 +0900520 char desc[ATA_EH_DESC_LEN];
521 int desc_len;
522};
523
524struct ata_eh_context {
525 struct ata_eh_info i;
526 int tries[ATA_MAX_DEVICES];
Tejun Heoabdda732006-05-31 18:27:29 +0900527 unsigned int classes[ATA_MAX_DEVICES];
528 unsigned int did_probe_mask;
Tejun Heof3e81b12006-05-15 20:58:21 +0900529};
530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400532 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400533 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400534 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900536 unsigned int pflags; /* ATA_PFLAG_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 unsigned int id; /* unique id req'd by scsi midlyr */
538 unsigned int port_no; /* unique port #; from zero */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540 struct ata_prd *prd; /* our SG list */
541 dma_addr_t prd_dma; /* and its DMA mapping */
542
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400543 void *pad; /* array of DMA pad buffers */
544 dma_addr_t pad_dma;
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
547
548 u8 ctl; /* cache of ATA control register */
549 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 unsigned int pio_mask;
551 unsigned int mwdma_mask;
552 unsigned int udma_mask;
553 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Tejun Heo5a04bf42006-05-31 18:27:38 +0900554 unsigned int hw_sata_spd_limit;
Tejun Heo1c3fae42006-04-02 20:53:28 +0900555 unsigned int sata_spd_limit; /* SATA PHY speed limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Jeff Garzikcca39742006-08-24 03:19:22 -0400557 /* record runtime error info, protected by host lock */
Tejun Heof3e81b12006-05-15 20:58:21 +0900558 struct ata_eh_info eh_info;
559 /* EH context owned by EH */
560 struct ata_eh_context eh_context;
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 struct ata_device device[ATA_MAX_DEVICES];
563
564 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900565 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900566 unsigned int qc_active;
567
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 unsigned int active_tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900569 u32 sactive;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Jeff Garzikcca39742006-08-24 03:19:22 -0400571 struct ata_port_stats stats;
572 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600573 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
David Howells65f27f32006-11-22 14:55:48 +0000575 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000576 struct delayed_work port_task;
577 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400578 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900579
Albert Lee14be71f2005-09-27 17:36:35 +0800580 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
Randy Dunlapbfd60572006-01-17 19:34:42 -0500582 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900583 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900584 wait_queue_head_t eh_wait_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500585
Tejun Heo500530f2006-07-03 16:07:27 +0900586 pm_message_t pm_mesg;
587 int *pm_result;
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900590
591 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592};
593
594struct ata_port_operations {
595 void (*port_disable) (struct ata_port *);
596
597 void (*dev_config) (struct ata_port *, struct ata_device *);
598
599 void (*set_piomode) (struct ata_port *, struct ata_device *);
600 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Cox5444a6f2006-03-27 18:58:20 +0100601 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Jeff Garzik057ace52005-10-22 14:27:05 -0400603 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
605
Jeff Garzik057ace52005-10-22 14:27:05 -0400606 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 u8 (*check_status)(struct ata_port *ap);
608 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 void (*dev_select)(struct ata_port *ap, unsigned int device);
610
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900611 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alanb229a7b2007-01-24 11:47:07 +0000612 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 void (*post_set_mode) (struct ata_port *ap);
615
Alanb229a7b2007-01-24 11:47:07 +0000616 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
618 void (*bmdma_setup) (struct ata_queued_cmd *qc);
619 void (*bmdma_start) (struct ata_queued_cmd *qc);
620
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100621 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900624 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
Tejun Heo9ec957f2006-05-15 20:57:58 +0900626 /* Error handlers. ->error_handler overrides ->eng_timeout and
627 * indicates that new-style EH is in place.
628 */
629 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
630
631 void (*freeze) (struct ata_port *ap);
632 void (*thaw) (struct ata_port *ap);
633 void (*error_handler) (struct ata_port *ap);
634 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
David Howells7d12e782006-10-05 14:55:46 +0100636 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 void (*irq_clear) (struct ata_port *);
638
639 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
640 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
641 u32 val);
642
Tejun Heo500530f2006-07-03 16:07:27 +0900643 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
644 int (*port_resume) (struct ata_port *ap);
645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 int (*port_start) (struct ata_port *ap);
647 void (*port_stop) (struct ata_port *ap);
648
Jeff Garzikcca39742006-08-24 03:19:22 -0400649 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Alan Coxb73fc892005-08-26 16:03:19 +0100651 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 u8 (*bmdma_status) (struct ata_port *ap);
653};
654
655struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100656 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400657 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 unsigned long pio_mask;
659 unsigned long mwdma_mask;
660 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400661 const struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000662 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663};
664
Alan Cox452503f2005-10-21 19:01:32 -0400665struct ata_timing {
666 unsigned short mode; /* ATA mode */
667 unsigned short setup; /* t1 */
668 unsigned short act8b; /* t2 for 8-bit I/O */
669 unsigned short rec8b; /* t2i for 8-bit I/O */
670 unsigned short cyc8b; /* t0 for 8-bit I/O */
671 unsigned short active; /* t2 or tD */
672 unsigned short recover; /* t2i or tK */
673 unsigned short cycle; /* t0 */
674 unsigned short udma; /* t2CYCTYP/2 */
675};
676
677#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Tejun Heoe9c83912006-07-03 16:07:26 +0900679extern const unsigned long sata_deb_timing_normal[];
680extern const unsigned long sata_deb_timing_hotplug[];
681extern const unsigned long sata_deb_timing_long[];
682
Tejun Heodd5b06c2006-08-10 16:59:12 +0900683extern const struct ata_port_operations ata_dummy_port_ops;
684
Tejun Heoe9c83912006-07-03 16:07:26 +0900685static inline const unsigned long *
686sata_ehc_deb_timing(struct ata_eh_context *ehc)
687{
688 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
689 return sata_deb_timing_hotplug;
690 else
691 return sata_deb_timing_normal;
692}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900693
Tejun Heodd5b06c2006-08-10 16:59:12 +0900694static inline int ata_port_is_dummy(struct ata_port *ap)
695{
696 return ap->ops == &ata_dummy_port_ops;
697}
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699extern void ata_port_probe(struct ata_port *);
700extern void __sata_phy_reset(struct ata_port *ap);
701extern void sata_phy_reset(struct ata_port *ap);
702extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo3c567b72006-05-15 20:57:23 +0900703extern int sata_set_spd(struct ata_port *ap);
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900704extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
705extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
Tejun Heof5914a42006-05-31 18:27:48 +0900706extern int ata_std_prereset(struct ata_port *ap);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900707extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
Tejun Heob6103f62006-11-01 17:59:53 +0900708extern int sata_port_hardreset(struct ata_port *ap,
709 const unsigned long *timing);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900710extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900711extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712extern void ata_port_disable(struct ata_port *);
713extern void ata_std_ports(struct ata_ioports *ioaddr);
714#ifdef CONFIG_PCI
715extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
716 unsigned int n_ports);
717extern void ata_pci_remove_one (struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900718extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
Tejun Heo500530f2006-07-03 16:07:27 +0900719extern void ata_pci_device_do_resume(struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900720extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
Jens Axboe9b847542006-01-06 09:28:07 +0100721extern int ata_pci_device_resume(struct pci_dev *pdev);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500722extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723#endif /* CONFIG_PCI */
Jeff Garzik057ace52005-10-22 14:27:05 -0400724extern int ata_device_add(const struct ata_probe_ent *ent);
Tejun Heo720ba122006-05-31 18:28:13 +0900725extern void ata_port_detach(struct ata_port *ap);
Jeff Garzikcca39742006-08-24 03:19:22 -0400726extern void ata_host_init(struct ata_host *, struct device *,
727 unsigned long, const struct ata_port_operations *);
728extern void ata_host_remove(struct ata_host *host);
Jeff Garzik193515d2005-11-07 00:59:37 -0500729extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
731extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732extern int ata_scsi_release(struct Scsi_Host *host);
Brian King80289162006-08-07 14:27:31 -0500733extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400734extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500735 struct ata_port_info *, struct Scsi_Host *);
736extern int ata_sas_port_init(struct ata_port *);
737extern int ata_sas_port_start(struct ata_port *ap);
738extern void ata_sas_port_stop(struct ata_port *ap);
739extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
740extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
741 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo34bf2172006-05-15 20:57:46 +0900743extern int sata_scr_valid(struct ata_port *ap);
744extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
745extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
746extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
747extern int ata_port_online(struct ata_port *ap);
748extern int ata_port_offline(struct ata_port *ap);
Jens Axboe9b847542006-01-06 09:28:07 +0100749extern int ata_scsi_device_resume(struct scsi_device *);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900750extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
Jeff Garzikcca39742006-08-24 03:19:22 -0400751extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
752extern void ata_host_resume(struct ata_host *host);
Jeff Garzik67846b32005-10-05 02:58:32 -0400753extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900754extern int ata_busy_sleep(struct ata_port *ap,
755 unsigned long timeout_pat, unsigned long timeout);
David Howells65f27f32006-11-22 14:55:48 +0000756extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
Tejun Heo86e45b62006-03-05 15:29:09 +0900757 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900758extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
759 unsigned long interval_msec,
760 unsigned long timeout_msec);
Jeff Garzik67846b32005-10-05 02:58:32 -0400761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/*
763 * Default driver ops implementations
764 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400765extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400767extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
768extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
770extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
771extern u8 ata_check_status(struct ata_port *ap);
772extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400773extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774extern int ata_port_start (struct ata_port *ap);
775extern void ata_port_stop (struct ata_port *ap);
Jeff Garzikcca39742006-08-24 03:19:22 -0400776extern void ata_host_stop (struct ata_host *host);
David Howells7d12e782006-10-05 14:55:46 +0100777extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100778extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
779 unsigned int buflen, int write_data);
780extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
781 unsigned int buflen, int write_data);
Alan Cox75e99582006-05-24 14:14:41 +0100782extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
783 unsigned int buflen, int write_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600785extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900786extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
788 unsigned int buflen);
789extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
790 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400791extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Tejun Heo6a62a042006-02-13 10:02:46 +0900792extern void ata_id_string(const u16 *id, unsigned char *s,
793 unsigned int ofs, unsigned int len);
794extern void ata_id_c_string(const u16 *id, unsigned char *s,
795 unsigned int ofs, unsigned int len);
Alan Cox6919a0a2006-10-27 19:08:46 -0700796extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
798extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100799extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800extern u8 ata_bmdma_status(struct ata_port *ap);
801extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900802extern void ata_bmdma_freeze(struct ata_port *ap);
803extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900804extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900805 ata_reset_fn_t softreset,
806 ata_reset_fn_t hardreset,
807 ata_postreset_fn_t postreset);
808extern void ata_bmdma_error_handler(struct ata_port *ap);
809extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900810extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
811 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900812extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900813extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
814 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900815extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 void (*done)(struct scsi_cmnd *));
817extern int ata_std_bios_param(struct scsi_device *sdev,
818 struct block_device *bdev,
819 sector_t capacity, int geom[]);
820extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900821extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900822extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
823 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900824extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Alan Cox452503f2005-10-21 19:01:32 -0400826/*
827 * Timing helpers
828 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000829
830extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400831extern int ata_timing_compute(struct ata_device *, unsigned short,
832 struct ata_timing *, int, int);
833extern void ata_timing_merge(const struct ata_timing *,
834 const struct ata_timing *, struct ata_timing *,
835 unsigned int);
836
837enum {
838 ATA_TIMING_SETUP = (1 << 0),
839 ATA_TIMING_ACT8B = (1 << 1),
840 ATA_TIMING_REC8B = (1 << 2),
841 ATA_TIMING_CYC8B = (1 << 3),
842 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
843 ATA_TIMING_CYC8B,
844 ATA_TIMING_ACTIVE = (1 << 4),
845 ATA_TIMING_RECOVER = (1 << 5),
846 ATA_TIMING_CYCLE = (1 << 6),
847 ATA_TIMING_UDMA = (1 << 7),
848 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
849 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
850 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
851 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
852};
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
855#ifdef CONFIG_PCI
856struct pci_bits {
857 unsigned int reg; /* PCI config register to read */
858 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
859 unsigned long mask;
860 unsigned long val;
861};
862
Jeff Garzikcca39742006-08-24 03:19:22 -0400863extern void ata_pci_host_stop (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400865ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Jeff Garzik057ace52005-10-22 14:27:05 -0400866extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500867extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868#endif /* CONFIG_PCI */
869
Tejun Heoece1d632006-04-02 18:51:53 +0900870/*
871 * EH
872 */
Tejun Heoece1d632006-04-02 18:51:53 +0900873extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900874
875extern void ata_port_schedule_eh(struct ata_port *ap);
876extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900877extern int ata_port_freeze(struct ata_port *ap);
878
879extern void ata_eh_freeze_port(struct ata_port *ap);
880extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900881
Tejun Heoece1d632006-04-02 18:51:53 +0900882extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
883extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
884
Tejun Heof5914a42006-05-31 18:27:48 +0900885extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
886 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
887 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900888
Tejun Heo61440db2006-05-15 20:57:55 +0900889/*
890 * printk helpers
891 */
892#define ata_port_printk(ap, lv, fmt, args...) \
893 printk(lv"ata%u: "fmt, (ap)->id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894
Tejun Heo61440db2006-05-15 20:57:55 +0900895#define ata_dev_printk(dev, lv, fmt, args...) \
896 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
897
898/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900899 * ata_eh_info helpers
900 */
901#define ata_ehi_push_desc(ehi, fmt, args...) do { \
902 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
903 ATA_EH_DESC_LEN - (ehi)->desc_len, \
904 fmt , ##args); \
905} while (0)
906
907#define ata_ehi_clear_desc(ehi) do { \
908 (ehi)->desc[0] = '\0'; \
909 (ehi)->desc_len = 0; \
910} while (0)
911
Tejun Heoc0b6c032006-07-03 16:07:26 +0900912static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +0900913{
914 if (ehi->flags & ATA_EHI_HOTPLUGGED)
915 return;
916
Tejun Heo28324302006-07-03 16:07:26 +0900917 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +0900918 ehi->hotplug_timestamp = jiffies;
919
Tejun Heo084fe632006-05-31 18:28:03 +0900920 ehi->action |= ATA_EH_SOFTRESET;
921 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
922}
923
Tejun Heoc0b6c032006-07-03 16:07:26 +0900924static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
925{
926 __ata_ehi_hotplugged(ehi);
927 ehi->err_mask |= AC_ERR_ATA_BUS;
928}
929
Tejun Heof3e81b12006-05-15 20:58:21 +0900930/*
Tejun Heo61440db2006-05-15 20:57:55 +0900931 * qc helpers
932 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400933static inline int
934ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
935{
936 if (sg == &qc->pad_sgent)
937 return 1;
938 if (qc->pad_len)
939 return 0;
940 if (((sg - qc->__sg) + 1) == qc->n_elem)
941 return 1;
942 return 0;
943}
944
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400945static inline struct scatterlist *
Tejun Heocc1887f32006-02-20 23:48:38 +0900946ata_qc_first_sg(struct ata_queued_cmd *qc)
947{
948 if (qc->n_elem)
949 return qc->__sg;
950 if (qc->pad_len)
951 return &qc->pad_sgent;
952 return NULL;
953}
954
955static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400956ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
957{
958 if (sg == &qc->pad_sgent)
959 return NULL;
960 if (++sg - qc->__sg < qc->n_elem)
961 return sg;
Tejun Heocc1887f32006-02-20 23:48:38 +0900962 if (qc->pad_len)
963 return &qc->pad_sgent;
964 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400965}
966
967#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f32006-02-20 23:48:38 +0900968 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400969
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970static inline unsigned int ata_tag_valid(unsigned int tag)
971{
972 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
973}
974
Tejun Heo2ab7db12006-05-15 20:58:02 +0900975static inline unsigned int ata_tag_internal(unsigned int tag)
976{
977 return tag == ATA_MAX_QUEUE - 1;
978}
979
Tejun Heo5806db22006-06-24 20:30:19 +0900980/*
981 * device helpers
982 */
Tejun Heoe1211e32006-04-01 01:38:18 +0900983static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +0900984{
985 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
986}
987
Tejun Heoe1211e32006-04-01 01:38:18 +0900988static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989{
Tejun Heoe1211e32006-04-01 01:38:18 +0900990 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
991}
992
Tejun Heo002c8052006-04-02 17:54:46 +0900993static inline unsigned int ata_class_absent(unsigned int class)
994{
995 return !ata_class_enabled(class) && !ata_class_disabled(class);
996}
997
Tejun Heoe1211e32006-04-01 01:38:18 +0900998static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
999{
1000 return ata_class_enabled(dev->class);
1001}
1002
1003static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1004{
1005 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006}
1007
Tejun Heo002c8052006-04-02 17:54:46 +09001008static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1009{
1010 return ata_class_absent(dev->class);
1011}
1012
Tejun Heo02670bf2006-07-03 16:07:26 +09001013static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1014{
1015 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1016}
1017
Tejun Heo5806db22006-06-24 20:30:19 +09001018/*
1019 * port helpers
1020 */
1021static inline int ata_port_max_devices(const struct ata_port *ap)
1022{
1023 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1024 return 2;
1025 return 1;
1026}
1027
1028
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029static inline u8 ata_chk_status(struct ata_port *ap)
1030{
1031 return ap->ops->check_status(ap);
1032}
1033
Edward Falk0baab862005-06-02 18:17:13 -04001034
1035/**
1036 * ata_pause - Flush writes and pause 400 nanoseconds.
1037 * @ap: Port to wait for.
1038 *
1039 * LOCKING:
1040 * Inherited from caller.
1041 */
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043static inline void ata_pause(struct ata_port *ap)
1044{
1045 ata_altstatus(ap);
1046 ndelay(400);
1047}
1048
Edward Falk0baab862005-06-02 18:17:13 -04001049
1050/**
1051 * ata_busy_wait - Wait for a port status register
1052 * @ap: Port to wait for.
Alan07777212007-01-31 17:47:24 +00001053 * @bits: bits that must be clear
1054 * @max: number of 10uS waits to perform
Edward Falk0baab862005-06-02 18:17:13 -04001055 *
1056 * Waits up to max*10 microseconds for the selected bits in the port's
1057 * status register to be cleared.
1058 * Returns final value of status register.
1059 *
1060 * LOCKING:
1061 * Inherited from caller.
1062 */
1063
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1065 unsigned int max)
1066{
1067 u8 status;
1068
1069 do {
1070 udelay(10);
1071 status = ata_chk_status(ap);
1072 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001073 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
1075 return status;
1076}
1077
Edward Falk0baab862005-06-02 18:17:13 -04001078
1079/**
1080 * ata_wait_idle - Wait for a port to be idle.
1081 * @ap: Port to wait for.
1082 *
1083 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1084 * Returns final value of status register.
1085 *
1086 * LOCKING:
1087 * Inherited from caller.
1088 */
1089
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090static inline u8 ata_wait_idle(struct ata_port *ap)
1091{
1092 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1093
Tejun Heod1adc1b2006-10-09 18:32:15 +09001094 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 unsigned long l = ap->ioaddr.status_addr;
Randy Dunlapbfd60572006-01-17 19:34:42 -05001096 if (ata_msg_warn(ap))
1097 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1098 status, l);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 }
1100
1101 return status;
1102}
1103
1104static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1105{
1106 qc->tf.ctl |= ATA_NIEN;
1107}
1108
Tejun Heof69499f2006-05-15 20:58:03 +09001109static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1110 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111{
1112 if (likely(ata_tag_valid(tag)))
1113 return &ap->qcmd[tag];
1114 return NULL;
1115}
1116
Tejun Heof69499f2006-05-15 20:58:03 +09001117static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1118 unsigned int tag)
1119{
1120 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1121
1122 if (unlikely(!qc) || !ap->ops->error_handler)
1123 return qc;
1124
1125 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1126 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1127 return qc;
1128
1129 return NULL;
1130}
1131
Tejun Heo3373efd2006-05-15 20:57:53 +09001132static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133{
1134 memset(tf, 0, sizeof(*tf));
1135
Tejun Heo3373efd2006-05-15 20:57:53 +09001136 tf->ctl = dev->ap->ctl;
1137 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 tf->device = ATA_DEVICE_OBS;
1139 else
1140 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1141}
1142
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001143static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1144{
Tejun Heo501e0c502007-01-17 11:34:02 +09001145 qc->dma_dir = DMA_NONE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001146 qc->__sg = NULL;
1147 qc->flags = 0;
1148 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1149 qc->nsect = 0;
1150 qc->nbytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001151 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001152 qc->err_mask = 0;
Brian Kingd0f29482007-01-17 12:32:28 -06001153 qc->pad_len = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001154
Tejun Heo3373efd2006-05-15 20:57:53 +09001155 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001156
1157 /* init result_tf such that it indicates normal completion */
1158 qc->result_tf.command = ATA_DRDY;
1159 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001160}
1161
Tejun Heo76014422006-02-11 15:13:49 +09001162/**
Edward Falk0baab862005-06-02 18:17:13 -04001163 * ata_irq_ack - Acknowledge a device interrupt.
1164 * @ap: Port on which interrupts are enabled.
1165 *
1166 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1167 * or BUSY+DRQ clear). Obtain dma status and port status from
1168 * device. Clear the interrupt. Return port status.
1169 *
1170 * LOCKING:
1171 */
1172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1174{
1175 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1176 u8 host_stat, post_stat, status;
1177
1178 status = ata_busy_wait(ap, bits, 1000);
1179 if (status & bits)
Randy Dunlapbfd60572006-01-17 19:34:42 -05001180 if (ata_msg_err(ap))
1181 printk(KERN_ERR "abnormal status 0x%X\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182
1183 /* get controller status; clear intr, err bits */
1184 if (ap->flags & ATA_FLAG_MMIO) {
1185 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1186 host_stat = readb(mmio + ATA_DMA_STATUS);
1187 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1188 mmio + ATA_DMA_STATUS);
1189
1190 post_stat = readb(mmio + ATA_DMA_STATUS);
1191 } else {
1192 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1193 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1194 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1195
1196 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1197 }
1198
Randy Dunlapbfd60572006-01-17 19:34:42 -05001199 if (ata_msg_intr(ap))
1200 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1201 __FUNCTION__,
1202 host_stat, post_stat, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203
1204 return status;
1205}
1206
Jeff Garzik057ace52005-10-22 14:27:05 -04001207static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208{
1209 return ata_id_wcache_enabled(dev->id) ||
1210 ata_id_has_flush(dev->id) ||
1211 ata_id_has_flush_ext(dev->id);
1212}
1213
Jeff Garzika7dac442005-10-30 04:44:42 -05001214static inline unsigned int ac_err_mask(u8 status)
1215{
Albert Lee3655d1d2006-05-19 11:43:04 +08001216 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001217 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001218 if (status & (ATA_ERR | ATA_DF))
1219 return AC_ERR_DEV;
1220 return 0;
1221}
1222
1223static inline unsigned int __ac_err_mask(u8 status)
1224{
1225 unsigned int mask = ac_err_mask(status);
1226 if (mask == 0)
1227 return AC_ERR_OTHER;
1228 return mask;
1229}
1230
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001231static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1232{
1233 ap->pad_dma = 0;
1234 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1235 &ap->pad_dma, GFP_KERNEL);
1236 return (ap->pad == NULL) ? -ENOMEM : 0;
1237}
1238
1239static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1240{
1241 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1242}
1243
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001244static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1245{
1246 return (struct ata_port *) &host->hostdata[0];
1247}
1248
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249#endif /* __LINUX_LIBATA_H__ */