blob: 298f9918e37528fab69b8cdce8eb65e0974c8835 [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 */
112 ATA_MAX_QUEUE = 2,
113 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 */
Tejun Heoea1dd4e2006-04-02 18:51:53 +0900127 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900128
129 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131 ATA_DEV_UNKNOWN = 0, /* unknown device */
132 ATA_DEV_ATA = 1, /* ATA device */
133 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
134 ATA_DEV_ATAPI = 3, /* ATAPI device */
135 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
136 ATA_DEV_NONE = 5, /* no device */
137
138 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900139 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900141 ATA_FLAG_SATA = (1 << 1),
142 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
143 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
144 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
145 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
146 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
147 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
148 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
149 ATA_FLAG_IRQ_MASK = (1 << 9), /* Mask IRQ in PIO xfers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Tejun Heo9ec957f2006-05-15 20:57:58 +0900151 ATA_FLAG_NOINTR = (1 << 13), /* FIXME: Remove this once
Tejun Heo949b38a2006-04-02 18:51:52 +0900152 * proper HSM is in place. */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900153 ATA_FLAG_DEBUGMSG = (1 << 14),
154 ATA_FLAG_FLUSH_PORT_TASK = (1 << 15), /* flush port task */
Jens Axboe9b847542006-01-06 09:28:07 +0100155
Tejun Heo9ec957f2006-05-15 20:57:58 +0900156 ATA_FLAG_EH_PENDING = (1 << 16), /* EH pending */
157 ATA_FLAG_FROZEN = (1 << 17), /* port is frozen */
Tejun Heo9be1e972006-05-15 20:58:17 +0900158 ATA_FLAG_RECOVERED = (1 << 18), /* recovery action performed */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900159
160 ATA_FLAG_DISABLED = (1 << 22), /* port is disabled, ignore it */
161 ATA_FLAG_SUSPENDED = (1 << 23), /* port is suspended (power) */
Alan Cox8d238e02006-01-17 20:50:31 +0000162
Tejun Heo949b38a2006-04-02 18:51:52 +0900163 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
Tejun Heodde44582006-02-02 00:56:10 +0900164
Tejun Heo949b38a2006-04-02 18:51:52 +0900165 /* struct ata_queued_cmd flags */
166 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
167 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
168 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900170 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900171 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
172
Tejun Heo9ec957f2006-05-15 20:57:58 +0900173 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
174 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
175 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100177 /* host set flags */
178 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 /* various lengths of time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 ATA_TMOUT_PIO = 30 * HZ,
Alan Cox8d238e02006-01-17 20:50:31 +0000182 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
183 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 ATA_TMOUT_CDB = 30 * HZ,
185 ATA_TMOUT_CDB_QUICK = 5 * HZ,
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,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250};
251
Albert Lee14be71f2005-09-27 17:36:35 +0800252enum hsm_task_states {
253 HSM_ST_UNKNOWN,
254 HSM_ST_IDLE,
255 HSM_ST_POLL,
256 HSM_ST_TMOUT,
257 HSM_ST,
258 HSM_ST_LAST,
259 HSM_ST_LAST_POLL,
260 HSM_ST_ERR,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261};
262
Jeff Garzika7dac442005-10-30 04:44:42 -0500263enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900264 AC_ERR_DEV = (1 << 0), /* device reported error */
265 AC_ERR_HSM = (1 << 1), /* host state machine violation */
266 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
267 AC_ERR_MEDIA = (1 << 3), /* media error */
268 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
269 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
270 AC_ERR_SYSTEM = (1 << 6), /* system error */
271 AC_ERR_INVALID = (1 << 7), /* invalid argument */
272 AC_ERR_OTHER = (1 << 8), /* unknown */
Jeff Garzika7dac442005-10-30 04:44:42 -0500273};
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275/* forward declarations */
276struct scsi_device;
277struct ata_port_operations;
278struct ata_port;
279struct ata_queued_cmd;
280
281/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900282typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heo7944ea92006-02-02 18:20:00 +0900283typedef void (*ata_probeinit_fn_t)(struct ata_port *);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900284typedef int (*ata_reset_fn_t)(struct ata_port *, unsigned int *);
Tejun Heoa62c0fc2006-01-24 17:05:22 +0900285typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287struct ata_ioports {
288 unsigned long cmd_addr;
289 unsigned long data_addr;
290 unsigned long error_addr;
291 unsigned long feature_addr;
292 unsigned long nsect_addr;
293 unsigned long lbal_addr;
294 unsigned long lbam_addr;
295 unsigned long lbah_addr;
296 unsigned long device_addr;
297 unsigned long status_addr;
298 unsigned long command_addr;
299 unsigned long altstatus_addr;
300 unsigned long ctl_addr;
301 unsigned long bmdma_addr;
302 unsigned long scr_addr;
303};
304
305struct ata_probe_ent {
306 struct list_head node;
307 struct device *dev;
Jeff Garzik057ace52005-10-22 14:27:05 -0400308 const struct ata_port_operations *port_ops;
Jeff Garzik193515d2005-11-07 00:59:37 -0500309 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 struct ata_ioports port[ATA_MAX_PORTS];
311 unsigned int n_ports;
312 unsigned int hard_port_no;
313 unsigned int pio_mask;
314 unsigned int mwdma_mask;
315 unsigned int udma_mask;
316 unsigned int legacy_mode;
317 unsigned long irq;
318 unsigned int irq_flags;
319 unsigned long host_flags;
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100320 unsigned long host_set_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 void __iomem *mmio_base;
322 void *private_data;
323};
324
325struct ata_host_set {
326 spinlock_t lock;
327 struct device *dev;
328 unsigned long irq;
329 void __iomem *mmio_base;
330 unsigned int n_ports;
331 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400332 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100333 unsigned long flags;
334 int simplex_claimed; /* Keep seperate in case we
335 ever need to do this locked */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 struct ata_port * ports[0];
337};
338
339struct ata_queued_cmd {
340 struct ata_port *ap;
341 struct ata_device *dev;
342
343 struct scsi_cmnd *scsicmd;
344 void (*scsidone)(struct scsi_cmnd *);
345
346 struct ata_taskfile tf;
347 u8 cdb[ATAPI_CDB_LEN];
348
349 unsigned long flags; /* ATA_QCFLAG_xxx */
350 unsigned int tag;
351 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400352 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
354 int dma_dir;
355
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400356 unsigned int pad_len;
357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 unsigned int nsect;
359 unsigned int cursect;
360
361 unsigned int nbytes;
362 unsigned int curbytes;
363
364 unsigned int cursg;
365 unsigned int cursg_ofs;
366
367 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400368 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 void *buf_virt;
370
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400371 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
372 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Albert Leea22e2eb2005-12-05 15:38:02 +0800374 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900375 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 ata_qc_cb_t complete_fn;
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 void *private_data;
379};
380
381struct ata_host_stats {
382 unsigned long unhandled_irq;
383 unsigned long idle_irq;
384 unsigned long rw_reqbuf;
385};
386
Tejun Heo0c247c52006-05-15 20:58:19 +0900387struct ata_ering_entry {
388 int is_io;
389 unsigned int err_mask;
390 u64 timestamp;
391};
392
393struct ata_ering {
394 int cursor;
395 struct ata_ering_entry ring[ATA_ERING_SIZE];
396};
397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398struct ata_device {
Tejun Heo38d87232006-05-15 20:57:51 +0900399 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 u64 n_sectors; /* size of device, if ATA */
401 unsigned long flags; /* ATA_DFLAG_xxx */
402 unsigned int class; /* ATA_DEV_xxx */
403 unsigned int devno; /* 0 or 1 */
Tejun Heofe635c72006-05-15 20:57:35 +0900404 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 u8 pio_mode;
406 u8 dma_mode;
407 u8 xfer_mode;
408 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
409
Albert Lee8cbd6df2005-10-12 15:06:27 +0800410 unsigned int multi_count; /* sectors count for
411 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900412 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900413 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400414
Tejun Heoacf356b2006-03-24 14:07:50 +0900415 /* per-dev xfer mask */
416 unsigned int pio_mask;
417 unsigned int mwdma_mask;
418 unsigned int udma_mask;
419
Albert Lee8bf62ece2005-05-12 15:29:42 -0400420 /* for CHS addressing */
421 u16 cylinders; /* Number of cylinders */
422 u16 heads; /* Number of heads */
423 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900424
425 /* error history */
426 struct ata_ering ering;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427};
428
Tejun Heof3e81b12006-05-15 20:58:21 +0900429struct ata_eh_info {
430 struct ata_device *dev; /* offending device */
431 u32 serror; /* SError from LLDD */
432 unsigned int err_mask; /* port-wide err_mask */
433 unsigned int action; /* ATA_EH_* action mask */
434 unsigned int flags; /* ATA_EHI_* flags */
435 char desc[ATA_EH_DESC_LEN];
436 int desc_len;
437};
438
439struct ata_eh_context {
440 struct ata_eh_info i;
441 int tries[ATA_MAX_DEVICES];
442};
443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444struct ata_port {
445 struct Scsi_Host *host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400446 const struct ata_port_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 unsigned long flags; /* ATA_FLAG_xxx */
448 unsigned int id; /* unique id req'd by scsi midlyr */
449 unsigned int port_no; /* unique port #; from zero */
450 unsigned int hard_port_no; /* hardware port #; from zero */
451
452 struct ata_prd *prd; /* our SG list */
453 dma_addr_t prd_dma; /* and its DMA mapping */
454
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400455 void *pad; /* array of DMA pad buffers */
456 dma_addr_t pad_dma;
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
459
460 u8 ctl; /* cache of ATA control register */
461 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 unsigned int pio_mask;
463 unsigned int mwdma_mask;
464 unsigned int udma_mask;
465 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Tejun Heo1c3fae42006-04-02 20:53:28 +0900466 unsigned int sata_spd_limit; /* SATA PHY speed limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Tejun Heof3e81b12006-05-15 20:58:21 +0900468 /* record runtime error info, protected by host_set lock */
469 struct ata_eh_info eh_info;
470 /* EH context owned by EH */
471 struct ata_eh_context eh_context;
472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 struct ata_device device[ATA_MAX_DEVICES];
474
475 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
476 unsigned long qactive;
477 unsigned int active_tag;
478
479 struct ata_host_stats stats;
480 struct ata_host_set *host_set;
Brian King2f1f6102006-03-23 17:30:15 -0600481 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Tejun Heo86e45b62006-03-05 15:29:09 +0900483 struct work_struct port_task;
484
Albert Lee14be71f2005-09-27 17:36:35 +0800485 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 unsigned long pio_task_timeout;
487
Randy Dunlapbfd60572006-01-17 19:34:42 -0500488 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900489 struct list_head eh_done_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500490
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900492
493 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494};
495
496struct ata_port_operations {
497 void (*port_disable) (struct ata_port *);
498
499 void (*dev_config) (struct ata_port *, struct ata_device *);
500
501 void (*set_piomode) (struct ata_port *, struct ata_device *);
502 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Cox5444a6f2006-03-27 18:58:20 +0100503 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Jeff Garzik057ace52005-10-22 14:27:05 -0400505 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
507
Jeff Garzik057ace52005-10-22 14:27:05 -0400508 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 u8 (*check_status)(struct ata_port *ap);
510 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 void (*dev_select)(struct ata_port *ap, unsigned int device);
512
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900513 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alan Coxe35a9e02006-03-27 18:46:37 +0100514 void (*set_mode) (struct ata_port *ap);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900515 int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 void (*post_set_mode) (struct ata_port *ap);
518
519 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
520
521 void (*bmdma_setup) (struct ata_queued_cmd *qc);
522 void (*bmdma_start) (struct ata_queued_cmd *qc);
523
524 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900525 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Tejun Heo9ec957f2006-05-15 20:57:58 +0900527 /* Error handlers. ->error_handler overrides ->eng_timeout and
528 * indicates that new-style EH is in place.
529 */
530 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
531
532 void (*freeze) (struct ata_port *ap);
533 void (*thaw) (struct ata_port *ap);
534 void (*error_handler) (struct ata_port *ap);
535 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
537 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
538 void (*irq_clear) (struct ata_port *);
539
540 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
541 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
542 u32 val);
543
544 int (*port_start) (struct ata_port *ap);
545 void (*port_stop) (struct ata_port *ap);
546
547 void (*host_stop) (struct ata_host_set *host_set);
548
Alan Coxb73fc892005-08-26 16:03:19 +0100549 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 u8 (*bmdma_status) (struct ata_port *ap);
551};
552
553struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100554 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 unsigned long host_flags;
556 unsigned long pio_mask;
557 unsigned long mwdma_mask;
558 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400559 const struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000560 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561};
562
Alan Cox452503f2005-10-21 19:01:32 -0400563struct ata_timing {
564 unsigned short mode; /* ATA mode */
565 unsigned short setup; /* t1 */
566 unsigned short act8b; /* t2 for 8-bit I/O */
567 unsigned short rec8b; /* t2i for 8-bit I/O */
568 unsigned short cyc8b; /* t0 for 8-bit I/O */
569 unsigned short active; /* t2 or tD */
570 unsigned short recover; /* t2i or tK */
571 unsigned short cycle; /* t0 */
572 unsigned short udma; /* t2CYCTYP/2 */
573};
574
575#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577extern void ata_port_probe(struct ata_port *);
578extern void __sata_phy_reset(struct ata_port *ap);
579extern void sata_phy_reset(struct ata_port *ap);
580extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo3c567b72006-05-15 20:57:23 +0900581extern int sata_set_spd(struct ata_port *ap);
Tejun Heoa62c0fc2006-01-24 17:05:22 +0900582extern int ata_drive_probe_reset(struct ata_port *ap,
Tejun Heo7944ea92006-02-02 18:20:00 +0900583 ata_probeinit_fn_t probeinit,
Tejun Heoa62c0fc2006-01-24 17:05:22 +0900584 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
585 ata_postreset_fn_t postreset, unsigned int *classes);
Tejun Heo8a19ac82006-02-02 18:20:00 +0900586extern void ata_std_probeinit(struct ata_port *ap);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900587extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
588extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900589extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Tejun Heo3373efd2006-05-15 20:57:53 +0900590extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591extern void ata_port_disable(struct ata_port *);
592extern void ata_std_ports(struct ata_ioports *ioaddr);
593#ifdef CONFIG_PCI
594extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
595 unsigned int n_ports);
596extern void ata_pci_remove_one (struct pci_dev *pdev);
Jens Axboe9b847542006-01-06 09:28:07 +0100597extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
598extern int ata_pci_device_resume(struct pci_dev *pdev);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500599extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600#endif /* CONFIG_PCI */
Jeff Garzik057ace52005-10-22 14:27:05 -0400601extern int ata_device_add(const struct ata_probe_ent *ent);
Alan Cox17b14452005-09-15 15:44:00 +0100602extern void ata_host_set_remove(struct ata_host_set *host_set);
Jeff Garzik193515d2005-11-07 00:59:37 -0500603extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
605extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606extern int ata_scsi_release(struct Scsi_Host *host);
607extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo34bf2172006-05-15 20:57:46 +0900608extern int sata_scr_valid(struct ata_port *ap);
609extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
610extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
611extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
612extern int ata_port_online(struct ata_port *ap);
613extern int ata_port_offline(struct ata_port *ap);
Jens Axboe9b847542006-01-06 09:28:07 +0100614extern int ata_scsi_device_resume(struct scsi_device *);
Nigel Cunningham082776e2006-03-23 23:22:16 +1000615extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
Tejun Heo3373efd2006-05-15 20:57:53 +0900616extern int ata_device_resume(struct ata_device *);
617extern int ata_device_suspend(struct ata_device *, pm_message_t state);
Jeff Garzik67846b32005-10-05 02:58:32 -0400618extern int ata_ratelimit(void);
Tejun Heo6f8b9952006-01-24 17:05:21 +0900619extern unsigned int ata_busy_sleep(struct ata_port *ap,
620 unsigned long timeout_pat,
621 unsigned long timeout);
Tejun Heo86e45b62006-03-05 15:29:09 +0900622extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
623 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900624extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
625 unsigned long interval_msec,
626 unsigned long timeout_msec);
Jeff Garzik67846b32005-10-05 02:58:32 -0400627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628/*
629 * Default driver ops implementations
630 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400631extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400633extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
634extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
636extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
637extern u8 ata_check_status(struct ata_port *ap);
638extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400639extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900640extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641extern int ata_port_start (struct ata_port *ap);
642extern void ata_port_stop (struct ata_port *ap);
Jeff Garzikaa8f0dc2005-05-26 21:54:27 -0400643extern void ata_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
645extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600646extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900647extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
649 unsigned int buflen);
650extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
651 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400652extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Tejun Heo6a62a042006-02-13 10:02:46 +0900653extern void ata_id_string(const u16 *id, unsigned char *s,
654 unsigned int ofs, unsigned int len);
655extern void ata_id_c_string(const u16 *id, unsigned char *s,
656 unsigned int ofs, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
658extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100659extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660extern u8 ata_bmdma_status(struct ata_port *ap);
661extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heof686bcb2006-05-15 20:58:05 +0900662extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heo3373efd2006-05-15 20:57:53 +0900663extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 void (*done)(struct scsi_cmnd *));
665extern int ata_std_bios_param(struct scsi_device *sdev,
666 struct block_device *bdev,
667 sector_t capacity, int geom[]);
668extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo3373efd2006-05-15 20:57:53 +0900669extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
Alan Cox452503f2005-10-21 19:01:32 -0400671/*
672 * Timing helpers
673 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000674
675extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400676extern int ata_timing_compute(struct ata_device *, unsigned short,
677 struct ata_timing *, int, int);
678extern void ata_timing_merge(const struct ata_timing *,
679 const struct ata_timing *, struct ata_timing *,
680 unsigned int);
681
682enum {
683 ATA_TIMING_SETUP = (1 << 0),
684 ATA_TIMING_ACT8B = (1 << 1),
685 ATA_TIMING_REC8B = (1 << 2),
686 ATA_TIMING_CYC8B = (1 << 3),
687 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
688 ATA_TIMING_CYC8B,
689 ATA_TIMING_ACTIVE = (1 << 4),
690 ATA_TIMING_RECOVER = (1 << 5),
691 ATA_TIMING_CYCLE = (1 << 6),
692 ATA_TIMING_UDMA = (1 << 7),
693 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
694 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
695 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
696 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
697};
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700#ifdef CONFIG_PCI
701struct pci_bits {
702 unsigned int reg; /* PCI config register to read */
703 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
704 unsigned long mask;
705 unsigned long val;
706};
707
Jeff Garzik374b1872005-08-30 05:42:52 -0400708extern void ata_pci_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400710ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Jeff Garzik057ace52005-10-22 14:27:05 -0400711extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500712extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713#endif /* CONFIG_PCI */
714
Tejun Heoece1d632006-04-02 18:51:53 +0900715/*
716 * EH
717 */
Tejun Heoece1d632006-04-02 18:51:53 +0900718extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900719
720extern void ata_port_schedule_eh(struct ata_port *ap);
721extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900722extern int ata_port_freeze(struct ata_port *ap);
723
724extern void ata_eh_freeze_port(struct ata_port *ap);
725extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900726
Tejun Heoece1d632006-04-02 18:51:53 +0900727extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
728extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
729
Tejun Heo61440db2006-05-15 20:57:55 +0900730/*
731 * printk helpers
732 */
733#define ata_port_printk(ap, lv, fmt, args...) \
734 printk(lv"ata%u: "fmt, (ap)->id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Tejun Heo61440db2006-05-15 20:57:55 +0900736#define ata_dev_printk(dev, lv, fmt, args...) \
737 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
738
739/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900740 * ata_eh_info helpers
741 */
742#define ata_ehi_push_desc(ehi, fmt, args...) do { \
743 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
744 ATA_EH_DESC_LEN - (ehi)->desc_len, \
745 fmt , ##args); \
746} while (0)
747
748#define ata_ehi_clear_desc(ehi) do { \
749 (ehi)->desc[0] = '\0'; \
750 (ehi)->desc_len = 0; \
751} while (0)
752
753/*
Tejun Heo61440db2006-05-15 20:57:55 +0900754 * qc helpers
755 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400756static inline int
757ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
758{
759 if (sg == &qc->pad_sgent)
760 return 1;
761 if (qc->pad_len)
762 return 0;
763 if (((sg - qc->__sg) + 1) == qc->n_elem)
764 return 1;
765 return 0;
766}
767
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400768static inline struct scatterlist *
Tejun Heocc1887f32006-02-20 23:48:38 +0900769ata_qc_first_sg(struct ata_queued_cmd *qc)
770{
771 if (qc->n_elem)
772 return qc->__sg;
773 if (qc->pad_len)
774 return &qc->pad_sgent;
775 return NULL;
776}
777
778static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400779ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
780{
781 if (sg == &qc->pad_sgent)
782 return NULL;
783 if (++sg - qc->__sg < qc->n_elem)
784 return sg;
Tejun Heocc1887f32006-02-20 23:48:38 +0900785 if (qc->pad_len)
786 return &qc->pad_sgent;
787 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400788}
789
790#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f32006-02-20 23:48:38 +0900791 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400792
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793static inline unsigned int ata_tag_valid(unsigned int tag)
794{
795 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
796}
797
Tejun Heo2ab7db12006-05-15 20:58:02 +0900798static inline unsigned int ata_tag_internal(unsigned int tag)
799{
800 return tag == ATA_MAX_QUEUE - 1;
801}
802
Tejun Heoe1211e32006-04-01 01:38:18 +0900803static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +0900804{
805 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
806}
807
Tejun Heoe1211e32006-04-01 01:38:18 +0900808static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
Tejun Heoe1211e32006-04-01 01:38:18 +0900810 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
811}
812
Tejun Heo002c8052006-04-02 17:54:46 +0900813static inline unsigned int ata_class_absent(unsigned int class)
814{
815 return !ata_class_enabled(class) && !ata_class_disabled(class);
816}
817
Tejun Heoe1211e32006-04-01 01:38:18 +0900818static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
819{
820 return ata_class_enabled(dev->class);
821}
822
823static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
824{
825 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826}
827
Tejun Heo002c8052006-04-02 17:54:46 +0900828static inline unsigned int ata_dev_absent(const struct ata_device *dev)
829{
830 return ata_class_absent(dev->class);
831}
832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833static inline u8 ata_chk_status(struct ata_port *ap)
834{
835 return ap->ops->check_status(ap);
836}
837
Edward Falk0baab862005-06-02 18:17:13 -0400838
839/**
840 * ata_pause - Flush writes and pause 400 nanoseconds.
841 * @ap: Port to wait for.
842 *
843 * LOCKING:
844 * Inherited from caller.
845 */
846
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847static inline void ata_pause(struct ata_port *ap)
848{
849 ata_altstatus(ap);
850 ndelay(400);
851}
852
Edward Falk0baab862005-06-02 18:17:13 -0400853
854/**
855 * ata_busy_wait - Wait for a port status register
856 * @ap: Port to wait for.
857 *
858 * Waits up to max*10 microseconds for the selected bits in the port's
859 * status register to be cleared.
860 * Returns final value of status register.
861 *
862 * LOCKING:
863 * Inherited from caller.
864 */
865
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
867 unsigned int max)
868{
869 u8 status;
870
871 do {
872 udelay(10);
873 status = ata_chk_status(ap);
874 max--;
875 } while ((status & bits) && (max > 0));
876
877 return status;
878}
879
Edward Falk0baab862005-06-02 18:17:13 -0400880
881/**
882 * ata_wait_idle - Wait for a port to be idle.
883 * @ap: Port to wait for.
884 *
885 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
886 * Returns final value of status register.
887 *
888 * LOCKING:
889 * Inherited from caller.
890 */
891
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892static inline u8 ata_wait_idle(struct ata_port *ap)
893{
894 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
895
896 if (status & (ATA_BUSY | ATA_DRQ)) {
897 unsigned long l = ap->ioaddr.status_addr;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500898 if (ata_msg_warn(ap))
899 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
900 status, l);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 }
902
903 return status;
904}
905
906static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
907{
908 qc->tf.ctl |= ATA_NIEN;
909}
910
Tejun Heof69499f2006-05-15 20:58:03 +0900911static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
912 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
914 if (likely(ata_tag_valid(tag)))
915 return &ap->qcmd[tag];
916 return NULL;
917}
918
Tejun Heof69499f2006-05-15 20:58:03 +0900919static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
920 unsigned int tag)
921{
922 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
923
924 if (unlikely(!qc) || !ap->ops->error_handler)
925 return qc;
926
927 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
928 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
929 return qc;
930
931 return NULL;
932}
933
Tejun Heo3373efd2006-05-15 20:57:53 +0900934static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935{
936 memset(tf, 0, sizeof(*tf));
937
Tejun Heo3373efd2006-05-15 20:57:53 +0900938 tf->ctl = dev->ap->ctl;
939 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 tf->device = ATA_DEVICE_OBS;
941 else
942 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
943}
944
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500945static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
946{
947 qc->__sg = NULL;
948 qc->flags = 0;
949 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
950 qc->nsect = 0;
951 qc->nbytes = qc->curbytes = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +0800952 qc->err_mask = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500953
Tejun Heo3373efd2006-05-15 20:57:53 +0900954 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +0900955
956 /* init result_tf such that it indicates normal completion */
957 qc->result_tf.command = ATA_DRDY;
958 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500959}
960
Tejun Heo76014422006-02-11 15:13:49 +0900961/**
Edward Falk0baab862005-06-02 18:17:13 -0400962 * ata_irq_on - Enable interrupts on a port.
963 * @ap: Port on which interrupts are enabled.
964 *
965 * Enable interrupts on a legacy IDE device using MMIO or PIO,
966 * wait for idle, clear any pending interrupts.
967 *
968 * LOCKING:
969 * Inherited from caller.
970 */
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972static inline u8 ata_irq_on(struct ata_port *ap)
973{
974 struct ata_ioports *ioaddr = &ap->ioaddr;
975 u8 tmp;
976
977 ap->ctl &= ~ATA_NIEN;
978 ap->last_ctl = ap->ctl;
979
980 if (ap->flags & ATA_FLAG_MMIO)
981 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
982 else
983 outb(ap->ctl, ioaddr->ctl_addr);
984 tmp = ata_wait_idle(ap);
985
986 ap->ops->irq_clear(ap);
987
988 return tmp;
989}
990
Edward Falk0baab862005-06-02 18:17:13 -0400991
992/**
993 * ata_irq_ack - Acknowledge a device interrupt.
994 * @ap: Port on which interrupts are enabled.
995 *
996 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
997 * or BUSY+DRQ clear). Obtain dma status and port status from
998 * device. Clear the interrupt. Return port status.
999 *
1000 * LOCKING:
1001 */
1002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1004{
1005 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1006 u8 host_stat, post_stat, status;
1007
1008 status = ata_busy_wait(ap, bits, 1000);
1009 if (status & bits)
Randy Dunlapbfd60572006-01-17 19:34:42 -05001010 if (ata_msg_err(ap))
1011 printk(KERN_ERR "abnormal status 0x%X\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013 /* get controller status; clear intr, err bits */
1014 if (ap->flags & ATA_FLAG_MMIO) {
1015 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1016 host_stat = readb(mmio + ATA_DMA_STATUS);
1017 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1018 mmio + ATA_DMA_STATUS);
1019
1020 post_stat = readb(mmio + ATA_DMA_STATUS);
1021 } else {
1022 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1023 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1024 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1025
1026 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1027 }
1028
Randy Dunlapbfd60572006-01-17 19:34:42 -05001029 if (ata_msg_intr(ap))
1030 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1031 __FUNCTION__,
1032 host_stat, post_stat, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
1034 return status;
1035}
1036
Jeff Garzik057ace52005-10-22 14:27:05 -04001037static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038{
1039 return ata_id_wcache_enabled(dev->id) ||
1040 ata_id_has_flush(dev->id) ||
1041 ata_id_has_flush_ext(dev->id);
1042}
1043
Jeff Garzika7dac442005-10-30 04:44:42 -05001044static inline unsigned int ac_err_mask(u8 status)
1045{
1046 if (status & ATA_BUSY)
Tejun Heo11a56d22006-01-23 13:09:36 +09001047 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001048 if (status & (ATA_ERR | ATA_DF))
1049 return AC_ERR_DEV;
1050 return 0;
1051}
1052
1053static inline unsigned int __ac_err_mask(u8 status)
1054{
1055 unsigned int mask = ac_err_mask(status);
1056 if (mask == 0)
1057 return AC_ERR_OTHER;
1058 return mask;
1059}
1060
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001061static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1062{
1063 ap->pad_dma = 0;
1064 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1065 &ap->pad_dma, GFP_KERNEL);
1066 return (ap->pad == NULL) ? -ENOMEM : 0;
1067}
1068
1069static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1070{
1071 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1072}
1073
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001074static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1075{
1076 return (struct ata_port *) &host->hostdata[0];
1077}
1078
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079#endif /* __LINUX_LIBATA_H__ */