blob: fcdd798bb08621f890b98d518f8b65d3db8adb08 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <asm/io.h>
34#include <linux/ata.h>
35#include <linux/workqueue.h>
Jeff Garzik35bb94b2006-04-11 13:12:34 -040036#include <scsi/scsi_host.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050039 * compile-time options: to be removed as soon as all the drivers are
40 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 */
42#undef ATA_DEBUG /* debugging output */
43#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
44#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
45#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#undef ATA_ENABLE_PATA /* define to enable PATA support in some
47 * low-level drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49
50/* note: prints function name for you */
51#ifdef ATA_DEBUG
52#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
53#ifdef ATA_VERBOSE_DEBUG
54#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
55#else
56#define VPRINTK(fmt, args...)
57#endif /* ATA_VERBOSE_DEBUG */
58#else
59#define DPRINTK(fmt, args...)
60#define VPRINTK(fmt, args...)
61#endif /* ATA_DEBUG */
62
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050063#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64
Randy Dunlapbfd60572006-01-17 19:34:42 -050065/* NEW: debug levels */
66#define HAVE_LIBATA_MSG 1
67
68enum {
69 ATA_MSG_DRV = 0x0001,
70 ATA_MSG_INFO = 0x0002,
71 ATA_MSG_PROBE = 0x0004,
72 ATA_MSG_WARN = 0x0008,
73 ATA_MSG_MALLOC = 0x0010,
74 ATA_MSG_CTL = 0x0020,
75 ATA_MSG_INTR = 0x0040,
76 ATA_MSG_ERR = 0x0080,
77};
78
79#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
80#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
81#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
82#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
83#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
84#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
85#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
86#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
87
88static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
89{
90 if (dval < 0 || dval >= (sizeof(u32) * 8))
91 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
92 if (!dval)
93 return 0;
94 return (1 << dval) - 1;
95}
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097/* defines only for the constants which don't work well as enums */
98#define ATA_TAG_POISON 0xfafbfcfdU
99
100/* move to PCI layer? */
101static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
102{
103 return &pdev->dev;
104}
105
106enum {
107 /* various global constants */
108 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
109 ATA_MAX_PORTS = 8,
110 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900111 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900112 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900113 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 ATA_MAX_SECTORS = 200, /* FIXME */
115 ATA_MAX_BUS = 2,
116 ATA_DEF_BUSY_WAIT = 10000,
117 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
118
119 ATA_SHT_EMULATED = 1,
120 ATA_SHT_CMD_PER_LUN = 1,
121 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400122 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900125 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
126 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400127 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900128 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heoea1dd4e2006-04-02 18:51:53 +0900129 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900130
131 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133 ATA_DEV_UNKNOWN = 0, /* unknown device */
134 ATA_DEV_ATA = 1, /* ATA device */
135 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
136 ATA_DEV_ATAPI = 3, /* ATAPI device */
137 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
138 ATA_DEV_NONE = 5, /* no device */
139
140 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900141 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900143 ATA_FLAG_SATA = (1 << 1),
144 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
145 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
146 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
147 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
148 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
149 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
150 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
151 ATA_FLAG_IRQ_MASK = (1 << 9), /* Mask IRQ in PIO xfers */
Jeff Garzik029f5462006-04-02 10:30:40 -0400152 ATA_FLAG_PIO_POLLING = (1 << 10), /* use polling PIO if LLD
153 * doesn't handle PIO interrupts */
Tejun Heo88e49032006-05-15 21:03:38 +0900154 ATA_FLAG_NCQ = (1 << 11), /* host supports NCQ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Tejun Heo9ec957f2006-05-15 20:57:58 +0900156 ATA_FLAG_DEBUGMSG = (1 << 14),
157 ATA_FLAG_FLUSH_PORT_TASK = (1 << 15), /* flush port task */
Jens Axboe9b847542006-01-06 09:28:07 +0100158
Tejun Heo9ec957f2006-05-15 20:57:58 +0900159 ATA_FLAG_EH_PENDING = (1 << 16), /* EH pending */
160 ATA_FLAG_FROZEN = (1 << 17), /* port is frozen */
Tejun Heo9be1e972006-05-15 20:58:17 +0900161 ATA_FLAG_RECOVERED = (1 << 18), /* recovery action performed */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900162
163 ATA_FLAG_DISABLED = (1 << 22), /* port is disabled, ignore it */
164 ATA_FLAG_SUSPENDED = (1 << 23), /* port is suspended (power) */
Alan Cox8d238e02006-01-17 20:50:31 +0000165
Tejun Heo949b38a2006-04-02 18:51:52 +0900166 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
Tejun Heodde44582006-02-02 00:56:10 +0900167
Tejun Heo949b38a2006-04-02 18:51:52 +0900168 /* struct ata_queued_cmd flags */
169 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
170 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
171 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900173 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900174 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
175
Tejun Heo9ec957f2006-05-15 20:57:58 +0900176 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
177 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
178 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100180 /* host set flags */
181 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000184 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
185 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900186 ATA_TMOUT_INTERNAL = 30 * HZ,
187 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189 /* ATA bus states */
190 BUS_UNKNOWN = 0,
191 BUS_DMA = 1,
192 BUS_IDLE = 2,
193 BUS_NOINTR = 3,
194 BUS_NODATA = 4,
195 BUS_TIMER = 5,
196 BUS_PIO = 6,
197 BUS_EDD = 7,
198 BUS_IDENTIFY = 8,
199 BUS_PACKET = 9,
200
201 /* SATA port states */
202 PORT_UNKNOWN = 0,
203 PORT_ENABLED = 1,
204 PORT_DISABLED = 2,
205
206 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900207 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 */
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900209 ATA_BITS_PIO = 5,
210 ATA_BITS_MWDMA = 3,
211 ATA_BITS_UDMA = 8,
212
213 ATA_SHIFT_PIO = 0,
214 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
215 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
216
217 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
218 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
219 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400220
221 /* size of buffer to pad xfers ending on unaligned boundaries */
222 ATA_DMA_PAD_SZ = 4,
223 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900224
225 /* masks for port functions */
Alan Cox47a86592005-10-04 08:09:19 -0400226 ATA_PORT_PRIMARY = (1 << 0),
227 ATA_PORT_SECONDARY = (1 << 1),
Tejun Heo14d2bac2006-04-02 17:54:46 +0900228
Tejun Heo0c247c52006-05-15 20:58:19 +0900229 /* ering size */
230 ATA_ERING_SIZE = 32,
231
Tejun Heof3e81b12006-05-15 20:58:21 +0900232 /* desc_len for ata_eh_info and context */
233 ATA_EH_DESC_LEN = 80,
234
Tejun Heo9be1e972006-05-15 20:58:17 +0900235 /* reset / recovery action types */
236 ATA_EH_REVALIDATE = (1 << 0),
237 ATA_EH_SOFTRESET = (1 << 1),
238 ATA_EH_HARDRESET = (1 << 2),
239
240 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
241
Tejun Heof3e81b12006-05-15 20:58:21 +0900242 /* ata_eh_info->flags */
243 ATA_EHI_DID_RESET = (1 << 0), /* already reset this port */
244
Tejun Heoad9e2762006-05-15 20:58:12 +0900245 /* max repeat if error condition is still set after ->error_handler */
246 ATA_EH_MAX_REPEAT = 5,
247
Tejun Heo14d2bac2006-04-02 17:54:46 +0900248 /* how hard are we gonna try to probe/recover devices */
249 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900250 ATA_EH_RESET_TRIES = 3,
251 ATA_EH_DEV_TRIES = 3,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252};
253
Albert Lee14be71f2005-09-27 17:36:35 +0800254enum hsm_task_states {
Albert Leec56b14d2005-09-30 19:07:39 +0800255 HSM_ST_UNKNOWN, /* state unknown */
256 HSM_ST_IDLE, /* no command on going */
Albert Leec56b14d2005-09-30 19:07:39 +0800257 HSM_ST, /* (waiting the device to) transfer data */
258 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d2005-09-30 19:07:39 +0800259 HSM_ST_ERR, /* error */
260 HSM_ST_FIRST, /* (waiting the device to)
261 write CDB or first data block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262};
263
Jeff Garzika7dac442005-10-30 04:44:42 -0500264enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900265 AC_ERR_DEV = (1 << 0), /* device reported error */
266 AC_ERR_HSM = (1 << 1), /* host state machine violation */
267 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
268 AC_ERR_MEDIA = (1 << 3), /* media error */
269 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
270 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
271 AC_ERR_SYSTEM = (1 << 6), /* system error */
272 AC_ERR_INVALID = (1 << 7), /* invalid argument */
273 AC_ERR_OTHER = (1 << 8), /* unknown */
Jeff Garzika7dac442005-10-30 04:44:42 -0500274};
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276/* forward declarations */
277struct scsi_device;
278struct ata_port_operations;
279struct ata_port;
280struct ata_queued_cmd;
281
282/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900283typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heo7944ea92006-02-02 18:20:00 +0900284typedef void (*ata_probeinit_fn_t)(struct ata_port *);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900285typedef int (*ata_reset_fn_t)(struct ata_port *, unsigned int *);
Tejun Heoa62c0fc2006-01-24 17:05:22 +0900286typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
288struct ata_ioports {
289 unsigned long cmd_addr;
290 unsigned long data_addr;
291 unsigned long error_addr;
292 unsigned long feature_addr;
293 unsigned long nsect_addr;
294 unsigned long lbal_addr;
295 unsigned long lbam_addr;
296 unsigned long lbah_addr;
297 unsigned long device_addr;
298 unsigned long status_addr;
299 unsigned long command_addr;
300 unsigned long altstatus_addr;
301 unsigned long ctl_addr;
302 unsigned long bmdma_addr;
303 unsigned long scr_addr;
304};
305
306struct ata_probe_ent {
307 struct list_head node;
308 struct device *dev;
Jeff Garzik057ace52005-10-22 14:27:05 -0400309 const struct ata_port_operations *port_ops;
Jeff Garzik193515d2005-11-07 00:59:37 -0500310 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 struct ata_ioports port[ATA_MAX_PORTS];
312 unsigned int n_ports;
313 unsigned int hard_port_no;
314 unsigned int pio_mask;
315 unsigned int mwdma_mask;
316 unsigned int udma_mask;
317 unsigned int legacy_mode;
318 unsigned long irq;
319 unsigned int irq_flags;
320 unsigned long host_flags;
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100321 unsigned long host_set_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 void __iomem *mmio_base;
323 void *private_data;
324};
325
326struct ata_host_set {
327 spinlock_t lock;
328 struct device *dev;
329 unsigned long irq;
330 void __iomem *mmio_base;
331 unsigned int n_ports;
332 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400333 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100334 unsigned long flags;
335 int simplex_claimed; /* Keep seperate in case we
336 ever need to do this locked */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 struct ata_port * ports[0];
338};
339
340struct ata_queued_cmd {
341 struct ata_port *ap;
342 struct ata_device *dev;
343
344 struct scsi_cmnd *scsicmd;
345 void (*scsidone)(struct scsi_cmnd *);
346
347 struct ata_taskfile tf;
348 u8 cdb[ATAPI_CDB_LEN];
349
350 unsigned long flags; /* ATA_QCFLAG_xxx */
351 unsigned int tag;
352 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400353 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355 int dma_dir;
356
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400357 unsigned int pad_len;
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 unsigned int nsect;
360 unsigned int cursect;
361
362 unsigned int nbytes;
363 unsigned int curbytes;
364
365 unsigned int cursg;
366 unsigned int cursg_ofs;
367
368 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400369 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 void *buf_virt;
371
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400372 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
373 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Albert Leea22e2eb2005-12-05 15:38:02 +0800375 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900376 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 ata_qc_cb_t complete_fn;
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 void *private_data;
380};
381
382struct ata_host_stats {
383 unsigned long unhandled_irq;
384 unsigned long idle_irq;
385 unsigned long rw_reqbuf;
386};
387
Tejun Heo0c247c52006-05-15 20:58:19 +0900388struct ata_ering_entry {
389 int is_io;
390 unsigned int err_mask;
391 u64 timestamp;
392};
393
394struct ata_ering {
395 int cursor;
396 struct ata_ering_entry ring[ATA_ERING_SIZE];
397};
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399struct ata_device {
Tejun Heo38d87232006-05-15 20:57:51 +0900400 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 u64 n_sectors; /* size of device, if ATA */
402 unsigned long flags; /* ATA_DFLAG_xxx */
403 unsigned int class; /* ATA_DEV_xxx */
404 unsigned int devno; /* 0 or 1 */
Tejun Heofe635c72006-05-15 20:57:35 +0900405 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 u8 pio_mode;
407 u8 dma_mode;
408 u8 xfer_mode;
409 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
410
Albert Lee8cbd6df2005-10-12 15:06:27 +0800411 unsigned int multi_count; /* sectors count for
412 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900413 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900414 unsigned int cdb_len;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400415
Tejun Heoacf356b2006-03-24 14:07:50 +0900416 /* per-dev xfer mask */
417 unsigned int pio_mask;
418 unsigned int mwdma_mask;
419 unsigned int udma_mask;
420
Albert Lee8bf62ec2005-05-12 15:29:42 -0400421 /* for CHS addressing */
422 u16 cylinders; /* Number of cylinders */
423 u16 heads; /* Number of heads */
424 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900425
426 /* error history */
427 struct ata_ering ering;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428};
429
Tejun Heof3e81b12006-05-15 20:58:21 +0900430struct ata_eh_info {
431 struct ata_device *dev; /* offending device */
432 u32 serror; /* SError from LLDD */
433 unsigned int err_mask; /* port-wide err_mask */
434 unsigned int action; /* ATA_EH_* action mask */
435 unsigned int flags; /* ATA_EHI_* flags */
436 char desc[ATA_EH_DESC_LEN];
437 int desc_len;
438};
439
440struct ata_eh_context {
441 struct ata_eh_info i;
442 int tries[ATA_MAX_DEVICES];
443};
444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445struct ata_port {
446 struct Scsi_Host *host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400447 const struct ata_port_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 unsigned long flags; /* ATA_FLAG_xxx */
449 unsigned int id; /* unique id req'd by scsi midlyr */
450 unsigned int port_no; /* unique port #; from zero */
451 unsigned int hard_port_no; /* hardware port #; from zero */
452
453 struct ata_prd *prd; /* our SG list */
454 dma_addr_t prd_dma; /* and its DMA mapping */
455
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400456 void *pad; /* array of DMA pad buffers */
457 dma_addr_t pad_dma;
458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
460
461 u8 ctl; /* cache of ATA control register */
462 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 unsigned int pio_mask;
464 unsigned int mwdma_mask;
465 unsigned int udma_mask;
466 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Tejun Heo1c3fae42006-04-02 20:53:28 +0900467 unsigned int sata_spd_limit; /* SATA PHY speed limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
Tejun Heof3e81b12006-05-15 20:58:21 +0900469 /* record runtime error info, protected by host_set lock */
470 struct ata_eh_info eh_info;
471 /* EH context owned by EH */
472 struct ata_eh_context eh_context;
473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 struct ata_device device[ATA_MAX_DEVICES];
475
476 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900477 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900478 unsigned int qc_active;
479
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 unsigned int active_tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900481 u32 sactive;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483 struct ata_host_stats stats;
484 struct ata_host_set *host_set;
Brian King2f1f6102006-03-23 17:30:15 -0600485 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Tejun Heo86e45b62006-03-05 15:29:09 +0900487 struct work_struct port_task;
488
Albert Lee14be71f2005-09-27 17:36:35 +0800489 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
Randy Dunlapbfd60572006-01-17 19:34:42 -0500491 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900492 struct list_head eh_done_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900495
496 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497};
498
499struct ata_port_operations {
500 void (*port_disable) (struct ata_port *);
501
502 void (*dev_config) (struct ata_port *, struct ata_device *);
503
504 void (*set_piomode) (struct ata_port *, struct ata_device *);
505 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Cox5444a6f2006-03-27 18:58:20 +0100506 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
Jeff Garzik057ace52005-10-22 14:27:05 -0400508 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
510
Jeff Garzik057ace52005-10-22 14:27:05 -0400511 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 u8 (*check_status)(struct ata_port *ap);
513 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 void (*dev_select)(struct ata_port *ap, unsigned int device);
515
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900516 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alan Coxe35a9e02006-03-27 18:46:37 +0100517 void (*set_mode) (struct ata_port *ap);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900518 int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 void (*post_set_mode) (struct ata_port *ap);
521
522 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
523
524 void (*bmdma_setup) (struct ata_queued_cmd *qc);
525 void (*bmdma_start) (struct ata_queued_cmd *qc);
526
527 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900528 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Tejun Heo9ec957f2006-05-15 20:57:58 +0900530 /* Error handlers. ->error_handler overrides ->eng_timeout and
531 * indicates that new-style EH is in place.
532 */
533 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
534
535 void (*freeze) (struct ata_port *ap);
536 void (*thaw) (struct ata_port *ap);
537 void (*error_handler) (struct ata_port *ap);
538 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
541 void (*irq_clear) (struct ata_port *);
542
543 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
544 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
545 u32 val);
546
547 int (*port_start) (struct ata_port *ap);
548 void (*port_stop) (struct ata_port *ap);
549
550 void (*host_stop) (struct ata_host_set *host_set);
551
Alan Coxb73fc892005-08-26 16:03:19 +0100552 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 u8 (*bmdma_status) (struct ata_port *ap);
554};
555
556struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100557 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 unsigned long host_flags;
559 unsigned long pio_mask;
560 unsigned long mwdma_mask;
561 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400562 const struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000563 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564};
565
Alan Cox452503f2005-10-21 19:01:32 -0400566struct ata_timing {
567 unsigned short mode; /* ATA mode */
568 unsigned short setup; /* t1 */
569 unsigned short act8b; /* t2 for 8-bit I/O */
570 unsigned short rec8b; /* t2i for 8-bit I/O */
571 unsigned short cyc8b; /* t0 for 8-bit I/O */
572 unsigned short active; /* t2 or tD */
573 unsigned short recover; /* t2i or tK */
574 unsigned short cycle; /* t0 */
575 unsigned short udma; /* t2CYCTYP/2 */
576};
577
578#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580extern void ata_port_probe(struct ata_port *);
581extern void __sata_phy_reset(struct ata_port *ap);
582extern void sata_phy_reset(struct ata_port *ap);
583extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo3c567b72006-05-15 20:57:23 +0900584extern int sata_set_spd(struct ata_port *ap);
Tejun Heoa62c0fc2006-01-24 17:05:22 +0900585extern int ata_drive_probe_reset(struct ata_port *ap,
Tejun Heo7944ea92006-02-02 18:20:00 +0900586 ata_probeinit_fn_t probeinit,
Tejun Heoa62c0fc2006-01-24 17:05:22 +0900587 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
588 ata_postreset_fn_t postreset, unsigned int *classes);
Tejun Heo8a19ac82006-02-02 18:20:00 +0900589extern void ata_std_probeinit(struct ata_port *ap);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900590extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
591extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900592extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Tejun Heo3373efd2006-05-15 20:57:53 +0900593extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594extern void ata_port_disable(struct ata_port *);
595extern void ata_std_ports(struct ata_ioports *ioaddr);
596#ifdef CONFIG_PCI
597extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
598 unsigned int n_ports);
599extern void ata_pci_remove_one (struct pci_dev *pdev);
Jens Axboe9b847542006-01-06 09:28:07 +0100600extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
601extern int ata_pci_device_resume(struct pci_dev *pdev);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500602extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603#endif /* CONFIG_PCI */
Jeff Garzik057ace52005-10-22 14:27:05 -0400604extern int ata_device_add(const struct ata_probe_ent *ent);
Alan Cox17b14452005-09-15 15:44:00 +0100605extern void ata_host_set_remove(struct ata_host_set *host_set);
Jeff Garzik193515d2005-11-07 00:59:37 -0500606extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
608extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609extern int ata_scsi_release(struct Scsi_Host *host);
610extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo34bf2172006-05-15 20:57:46 +0900611extern int sata_scr_valid(struct ata_port *ap);
612extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
613extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
614extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
615extern int ata_port_online(struct ata_port *ap);
616extern int ata_port_offline(struct ata_port *ap);
Jens Axboe9b847542006-01-06 09:28:07 +0100617extern int ata_scsi_device_resume(struct scsi_device *);
Nigel Cunningham082776e2006-03-23 23:22:16 +1000618extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
Tejun Heo3373efd2006-05-15 20:57:53 +0900619extern int ata_device_resume(struct ata_device *);
620extern int ata_device_suspend(struct ata_device *, pm_message_t state);
Jeff Garzik67846b32005-10-05 02:58:32 -0400621extern int ata_ratelimit(void);
Tejun Heo6f8b9952006-01-24 17:05:21 +0900622extern unsigned int ata_busy_sleep(struct ata_port *ap,
623 unsigned long timeout_pat,
624 unsigned long timeout);
Tejun Heo86e45b62006-03-05 15:29:09 +0900625extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
626 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900627extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
628 unsigned long interval_msec,
629 unsigned long timeout_msec);
Jeff Garzik67846b32005-10-05 02:58:32 -0400630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631/*
632 * Default driver ops implementations
633 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400634extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400636extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
637extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
639extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
640extern u8 ata_check_status(struct ata_port *ap);
641extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400642extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900643extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644extern int ata_port_start (struct ata_port *ap);
645extern void ata_port_stop (struct ata_port *ap);
Jeff Garzikaa8f0dc2005-05-26 21:54:27 -0400646extern void ata_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
648extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600649extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900650extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
652 unsigned int buflen);
653extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
654 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400655extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Tejun Heo6a62a042006-02-13 10:02:46 +0900656extern void ata_id_string(const u16 *id, unsigned char *s,
657 unsigned int ofs, unsigned int len);
658extern void ata_id_c_string(const u16 *id, unsigned char *s,
659 unsigned int ofs, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
661extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100662extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663extern u8 ata_bmdma_status(struct ata_port *ap);
664extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900665extern void ata_bmdma_freeze(struct ata_port *ap);
666extern void ata_bmdma_thaw(struct ata_port *ap);
667extern void ata_bmdma_drive_eh(struct ata_port *ap,
668 ata_reset_fn_t softreset,
669 ata_reset_fn_t hardreset,
670 ata_postreset_fn_t postreset);
671extern void ata_bmdma_error_handler(struct ata_port *ap);
672extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heof686bcb2006-05-15 20:58:05 +0900673extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900674extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
675 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900676extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 void (*done)(struct scsi_cmnd *));
678extern int ata_std_bios_param(struct scsi_device *sdev,
679 struct block_device *bdev,
680 sector_t capacity, int geom[]);
681extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900682extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
683 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900684extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Alan Cox452503f2005-10-21 19:01:32 -0400686/*
687 * Timing helpers
688 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000689
690extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400691extern int ata_timing_compute(struct ata_device *, unsigned short,
692 struct ata_timing *, int, int);
693extern void ata_timing_merge(const struct ata_timing *,
694 const struct ata_timing *, struct ata_timing *,
695 unsigned int);
696
697enum {
698 ATA_TIMING_SETUP = (1 << 0),
699 ATA_TIMING_ACT8B = (1 << 1),
700 ATA_TIMING_REC8B = (1 << 2),
701 ATA_TIMING_CYC8B = (1 << 3),
702 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
703 ATA_TIMING_CYC8B,
704 ATA_TIMING_ACTIVE = (1 << 4),
705 ATA_TIMING_RECOVER = (1 << 5),
706 ATA_TIMING_CYCLE = (1 << 6),
707 ATA_TIMING_UDMA = (1 << 7),
708 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
709 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
710 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
711 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
712};
713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715#ifdef CONFIG_PCI
716struct pci_bits {
717 unsigned int reg; /* PCI config register to read */
718 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
719 unsigned long mask;
720 unsigned long val;
721};
722
Jeff Garzik374b1872005-08-30 05:42:52 -0400723extern void ata_pci_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400725ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Jeff Garzik057ace52005-10-22 14:27:05 -0400726extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500727extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728#endif /* CONFIG_PCI */
729
Tejun Heoece1d632006-04-02 18:51:53 +0900730/*
731 * EH
732 */
Tejun Heoece1d632006-04-02 18:51:53 +0900733extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900734
735extern void ata_port_schedule_eh(struct ata_port *ap);
736extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900737extern int ata_port_freeze(struct ata_port *ap);
738
739extern void ata_eh_freeze_port(struct ata_port *ap);
740extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900741
Tejun Heoece1d632006-04-02 18:51:53 +0900742extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
743extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
744
Tejun Heo022bdb02006-05-15 20:58:22 +0900745extern void ata_do_eh(struct ata_port *ap, ata_reset_fn_t softreset,
746 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset);
747
Tejun Heo61440db2006-05-15 20:57:55 +0900748/*
749 * printk helpers
750 */
751#define ata_port_printk(ap, lv, fmt, args...) \
752 printk(lv"ata%u: "fmt, (ap)->id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Tejun Heo61440db2006-05-15 20:57:55 +0900754#define ata_dev_printk(dev, lv, fmt, args...) \
755 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
756
757/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900758 * ata_eh_info helpers
759 */
760#define ata_ehi_push_desc(ehi, fmt, args...) do { \
761 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
762 ATA_EH_DESC_LEN - (ehi)->desc_len, \
763 fmt , ##args); \
764} while (0)
765
766#define ata_ehi_clear_desc(ehi) do { \
767 (ehi)->desc[0] = '\0'; \
768 (ehi)->desc_len = 0; \
769} while (0)
770
771/*
Tejun Heo61440db2006-05-15 20:57:55 +0900772 * qc helpers
773 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400774static inline int
775ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
776{
777 if (sg == &qc->pad_sgent)
778 return 1;
779 if (qc->pad_len)
780 return 0;
781 if (((sg - qc->__sg) + 1) == qc->n_elem)
782 return 1;
783 return 0;
784}
785
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400786static inline struct scatterlist *
Tejun Heocc1887f2006-02-20 23:48:38 +0900787ata_qc_first_sg(struct ata_queued_cmd *qc)
788{
789 if (qc->n_elem)
790 return qc->__sg;
791 if (qc->pad_len)
792 return &qc->pad_sgent;
793 return NULL;
794}
795
796static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400797ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
798{
799 if (sg == &qc->pad_sgent)
800 return NULL;
801 if (++sg - qc->__sg < qc->n_elem)
802 return sg;
Tejun Heocc1887f2006-02-20 23:48:38 +0900803 if (qc->pad_len)
804 return &qc->pad_sgent;
805 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400806}
807
808#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f2006-02-20 23:48:38 +0900809 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811static inline unsigned int ata_tag_valid(unsigned int tag)
812{
813 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
814}
815
Tejun Heo2ab7db12006-05-15 20:58:02 +0900816static inline unsigned int ata_tag_internal(unsigned int tag)
817{
818 return tag == ATA_MAX_QUEUE - 1;
819}
820
Tejun Heoe1211e32006-04-01 01:38:18 +0900821static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +0900822{
823 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
824}
825
Tejun Heoe1211e32006-04-01 01:38:18 +0900826static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827{
Tejun Heoe1211e32006-04-01 01:38:18 +0900828 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
829}
830
Tejun Heo002c8052006-04-02 17:54:46 +0900831static inline unsigned int ata_class_absent(unsigned int class)
832{
833 return !ata_class_enabled(class) && !ata_class_disabled(class);
834}
835
Tejun Heoe1211e32006-04-01 01:38:18 +0900836static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
837{
838 return ata_class_enabled(dev->class);
839}
840
841static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
842{
843 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844}
845
Tejun Heo002c8052006-04-02 17:54:46 +0900846static inline unsigned int ata_dev_absent(const struct ata_device *dev)
847{
848 return ata_class_absent(dev->class);
849}
850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851static inline u8 ata_chk_status(struct ata_port *ap)
852{
853 return ap->ops->check_status(ap);
854}
855
Edward Falk0baab862005-06-02 18:17:13 -0400856
857/**
858 * ata_pause - Flush writes and pause 400 nanoseconds.
859 * @ap: Port to wait for.
860 *
861 * LOCKING:
862 * Inherited from caller.
863 */
864
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865static inline void ata_pause(struct ata_port *ap)
866{
867 ata_altstatus(ap);
868 ndelay(400);
869}
870
Edward Falk0baab862005-06-02 18:17:13 -0400871
872/**
873 * ata_busy_wait - Wait for a port status register
874 * @ap: Port to wait for.
875 *
876 * Waits up to max*10 microseconds for the selected bits in the port's
877 * status register to be cleared.
878 * Returns final value of status register.
879 *
880 * LOCKING:
881 * Inherited from caller.
882 */
883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
885 unsigned int max)
886{
887 u8 status;
888
889 do {
890 udelay(10);
891 status = ata_chk_status(ap);
892 max--;
893 } while ((status & bits) && (max > 0));
894
895 return status;
896}
897
Edward Falk0baab862005-06-02 18:17:13 -0400898
899/**
900 * ata_wait_idle - Wait for a port to be idle.
901 * @ap: Port to wait for.
902 *
903 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
904 * Returns final value of status register.
905 *
906 * LOCKING:
907 * Inherited from caller.
908 */
909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910static inline u8 ata_wait_idle(struct ata_port *ap)
911{
912 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
913
914 if (status & (ATA_BUSY | ATA_DRQ)) {
915 unsigned long l = ap->ioaddr.status_addr;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500916 if (ata_msg_warn(ap))
917 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
918 status, l);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 }
920
921 return status;
922}
923
924static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
925{
926 qc->tf.ctl |= ATA_NIEN;
927}
928
Tejun Heof69499f2006-05-15 20:58:03 +0900929static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
930 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931{
932 if (likely(ata_tag_valid(tag)))
933 return &ap->qcmd[tag];
934 return NULL;
935}
936
Tejun Heof69499f2006-05-15 20:58:03 +0900937static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
938 unsigned int tag)
939{
940 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
941
942 if (unlikely(!qc) || !ap->ops->error_handler)
943 return qc;
944
945 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
946 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
947 return qc;
948
949 return NULL;
950}
951
Tejun Heo3373efd2006-05-15 20:57:53 +0900952static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953{
954 memset(tf, 0, sizeof(*tf));
955
Tejun Heo3373efd2006-05-15 20:57:53 +0900956 tf->ctl = dev->ap->ctl;
957 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 tf->device = ATA_DEVICE_OBS;
959 else
960 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
961}
962
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500963static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
964{
965 qc->__sg = NULL;
966 qc->flags = 0;
967 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
968 qc->nsect = 0;
969 qc->nbytes = qc->curbytes = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +0800970 qc->err_mask = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500971
Tejun Heo3373efd2006-05-15 20:57:53 +0900972 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +0900973
974 /* init result_tf such that it indicates normal completion */
975 qc->result_tf.command = ATA_DRDY;
976 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500977}
978
Tejun Heo76014422006-02-11 15:13:49 +0900979/**
Edward Falk0baab862005-06-02 18:17:13 -0400980 * ata_irq_on - Enable interrupts on a port.
981 * @ap: Port on which interrupts are enabled.
982 *
983 * Enable interrupts on a legacy IDE device using MMIO or PIO,
984 * wait for idle, clear any pending interrupts.
985 *
986 * LOCKING:
987 * Inherited from caller.
988 */
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990static inline u8 ata_irq_on(struct ata_port *ap)
991{
992 struct ata_ioports *ioaddr = &ap->ioaddr;
993 u8 tmp;
994
995 ap->ctl &= ~ATA_NIEN;
996 ap->last_ctl = ap->ctl;
997
998 if (ap->flags & ATA_FLAG_MMIO)
999 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1000 else
1001 outb(ap->ctl, ioaddr->ctl_addr);
1002 tmp = ata_wait_idle(ap);
1003
1004 ap->ops->irq_clear(ap);
1005
1006 return tmp;
1007}
1008
Edward Falk0baab862005-06-02 18:17:13 -04001009
1010/**
1011 * ata_irq_ack - Acknowledge a device interrupt.
1012 * @ap: Port on which interrupts are enabled.
1013 *
1014 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1015 * or BUSY+DRQ clear). Obtain dma status and port status from
1016 * device. Clear the interrupt. Return port status.
1017 *
1018 * LOCKING:
1019 */
1020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1022{
1023 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1024 u8 host_stat, post_stat, status;
1025
1026 status = ata_busy_wait(ap, bits, 1000);
1027 if (status & bits)
Randy Dunlapbfd60572006-01-17 19:34:42 -05001028 if (ata_msg_err(ap))
1029 printk(KERN_ERR "abnormal status 0x%X\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
1031 /* get controller status; clear intr, err bits */
1032 if (ap->flags & ATA_FLAG_MMIO) {
1033 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1034 host_stat = readb(mmio + ATA_DMA_STATUS);
1035 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1036 mmio + ATA_DMA_STATUS);
1037
1038 post_stat = readb(mmio + ATA_DMA_STATUS);
1039 } else {
1040 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1041 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1042 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1043
1044 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1045 }
1046
Randy Dunlapbfd60572006-01-17 19:34:42 -05001047 if (ata_msg_intr(ap))
1048 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1049 __FUNCTION__,
1050 host_stat, post_stat, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
1052 return status;
1053}
1054
Jeff Garzik057ace52005-10-22 14:27:05 -04001055static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056{
1057 return ata_id_wcache_enabled(dev->id) ||
1058 ata_id_has_flush(dev->id) ||
1059 ata_id_has_flush_ext(dev->id);
1060}
1061
Jeff Garzika7dac442005-10-30 04:44:42 -05001062static inline unsigned int ac_err_mask(u8 status)
1063{
1064 if (status & ATA_BUSY)
Tejun Heo11a56d22006-01-23 13:09:36 +09001065 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001066 if (status & (ATA_ERR | ATA_DF))
1067 return AC_ERR_DEV;
1068 return 0;
1069}
1070
1071static inline unsigned int __ac_err_mask(u8 status)
1072{
1073 unsigned int mask = ac_err_mask(status);
1074 if (mask == 0)
1075 return AC_ERR_OTHER;
1076 return mask;
1077}
1078
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001079static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1080{
1081 ap->pad_dma = 0;
1082 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1083 &ap->pad_dma, GFP_KERNEL);
1084 return (ap->pad == NULL) ? -ENOMEM : 0;
1085}
1086
1087static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1088{
1089 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1090}
1091
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001092static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1093{
1094 return (struct ata_port *) &host->hostdata[0];
1095}
1096
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097#endif /* __LINUX_LIBATA_H__ */