blob: e18ce039cdfd53614c5663abb5be8bb5210a9705 [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>
36
37/*
38 * compile-time options
39 */
40#undef ATA_DEBUG /* debugging output */
41#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
42#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
43#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#undef ATA_ENABLE_PATA /* define to enable PATA support in some
45 * low-level drivers */
46#undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */
47
48
49/* note: prints function name for you */
50#ifdef ATA_DEBUG
51#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
52#ifdef ATA_VERBOSE_DEBUG
53#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
54#else
55#define VPRINTK(fmt, args...)
56#endif /* ATA_VERBOSE_DEBUG */
57#else
58#define DPRINTK(fmt, args...)
59#define VPRINTK(fmt, args...)
60#endif /* ATA_DEBUG */
61
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050062#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#ifdef ATA_NDEBUG
65#define assert(expr)
66#else
67#define assert(expr) \
68 if(unlikely(!(expr))) { \
69 printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \
70 #expr,__FILE__,__FUNCTION__,__LINE__); \
71 }
72#endif
73
74/* defines only for the constants which don't work well as enums */
75#define ATA_TAG_POISON 0xfafbfcfdU
76
77/* move to PCI layer? */
78static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
79{
80 return &pdev->dev;
81}
82
83enum {
84 /* various global constants */
85 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
86 ATA_MAX_PORTS = 8,
87 ATA_DEF_QUEUE = 1,
88 ATA_MAX_QUEUE = 1,
89 ATA_MAX_SECTORS = 200, /* FIXME */
90 ATA_MAX_BUS = 2,
91 ATA_DEF_BUSY_WAIT = 10000,
92 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
93
94 ATA_SHT_EMULATED = 1,
95 ATA_SHT_CMD_PER_LUN = 1,
96 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -040097 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99 /* struct ata_device stuff */
100 ATA_DFLAG_LBA48 = (1 << 0), /* device supports LBA48 */
101 ATA_DFLAG_PIO = (1 << 1), /* device currently in PIO mode */
102 ATA_DFLAG_LOCK_SECTORS = (1 << 2), /* don't adjust max_sectors */
Albert Lee8bf62ece2005-05-12 15:29:42 -0400103 ATA_DFLAG_LBA = (1 << 3), /* device supports LBA */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105 ATA_DEV_UNKNOWN = 0, /* unknown device */
106 ATA_DEV_ATA = 1, /* ATA device */
107 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
108 ATA_DEV_ATAPI = 3, /* ATAPI device */
109 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
110 ATA_DEV_NONE = 5, /* no device */
111
112 /* struct ata_port flags */
113 ATA_FLAG_SLAVE_POSS = (1 << 1), /* host supports slave dev */
114 /* (doesn't imply presence) */
115 ATA_FLAG_PORT_DISABLED = (1 << 2), /* port is disabled, ignore it */
116 ATA_FLAG_SATA = (1 << 3),
117 ATA_FLAG_NO_LEGACY = (1 << 4), /* no legacy mode check */
118 ATA_FLAG_SRST = (1 << 5), /* use ATA SRST, not E.D.D. */
119 ATA_FLAG_MMIO = (1 << 6), /* use MMIO, not PIO */
120 ATA_FLAG_SATA_RESET = (1 << 7), /* use COMRESET */
121 ATA_FLAG_PIO_DMA = (1 << 8), /* PIO cmds via DMA */
Tejun Heoc1389502005-08-22 14:59:24 +0900122 ATA_FLAG_NOINTR = (1 << 9), /* FIXME: Remove this once
123 * proper HSM is in place. */
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500124 ATA_FLAG_DEBUGMSG = (1 << 10),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126 ATA_QCFLAG_ACTIVE = (1 << 1), /* cmd not yet ack'd to scsi lyer */
127 ATA_QCFLAG_SG = (1 << 3), /* have s/g table? */
128 ATA_QCFLAG_SINGLE = (1 << 4), /* no s/g, just a single buffer */
129 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
130
131 /* various lengths of time */
132 ATA_TMOUT_EDD = 5 * HZ, /* hueristic */
133 ATA_TMOUT_PIO = 30 * HZ,
134 ATA_TMOUT_BOOT = 30 * HZ, /* hueristic */
135 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* hueristic */
136 ATA_TMOUT_CDB = 30 * HZ,
137 ATA_TMOUT_CDB_QUICK = 5 * HZ,
138
139 /* ATA bus states */
140 BUS_UNKNOWN = 0,
141 BUS_DMA = 1,
142 BUS_IDLE = 2,
143 BUS_NOINTR = 3,
144 BUS_NODATA = 4,
145 BUS_TIMER = 5,
146 BUS_PIO = 6,
147 BUS_EDD = 7,
148 BUS_IDENTIFY = 8,
149 BUS_PACKET = 9,
150
151 /* SATA port states */
152 PORT_UNKNOWN = 0,
153 PORT_ENABLED = 1,
154 PORT_DISABLED = 2,
155
156 /* encoding various smaller bitmaps into a single
157 * unsigned long bitmap
158 */
159 ATA_SHIFT_UDMA = 0,
160 ATA_SHIFT_MWDMA = 8,
161 ATA_SHIFT_PIO = 11,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400162
163 /* size of buffer to pad xfers ending on unaligned boundaries */
164 ATA_DMA_PAD_SZ = 4,
165 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Alan Cox47a86592005-10-04 08:09:19 -0400166
167 /* Masks for port functions */
168 ATA_PORT_PRIMARY = (1 << 0),
169 ATA_PORT_SECONDARY = (1 << 1),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170};
171
Albert Lee14be71f2005-09-27 17:36:35 +0800172enum hsm_task_states {
173 HSM_ST_UNKNOWN,
174 HSM_ST_IDLE,
175 HSM_ST_POLL,
176 HSM_ST_TMOUT,
177 HSM_ST,
178 HSM_ST_LAST,
179 HSM_ST_LAST_POLL,
180 HSM_ST_ERR,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181};
182
Jeff Garzika7dac442005-10-30 04:44:42 -0500183enum ata_completion_errors {
184 AC_ERR_OTHER = (1 << 0),
185 AC_ERR_DEV = (1 << 1),
186 AC_ERR_ATA_BUS = (1 << 2),
187 AC_ERR_HOST_BUS = (1 << 3),
188};
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190/* forward declarations */
191struct scsi_device;
192struct ata_port_operations;
193struct ata_port;
194struct ata_queued_cmd;
195
196/* typedefs */
Albert Leea22e2eb2005-12-05 15:38:02 +0800197typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199struct ata_ioports {
200 unsigned long cmd_addr;
201 unsigned long data_addr;
202 unsigned long error_addr;
203 unsigned long feature_addr;
204 unsigned long nsect_addr;
205 unsigned long lbal_addr;
206 unsigned long lbam_addr;
207 unsigned long lbah_addr;
208 unsigned long device_addr;
209 unsigned long status_addr;
210 unsigned long command_addr;
211 unsigned long altstatus_addr;
212 unsigned long ctl_addr;
213 unsigned long bmdma_addr;
214 unsigned long scr_addr;
215};
216
217struct ata_probe_ent {
218 struct list_head node;
219 struct device *dev;
Jeff Garzik057ace52005-10-22 14:27:05 -0400220 const struct ata_port_operations *port_ops;
Jeff Garzik193515d2005-11-07 00:59:37 -0500221 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 struct ata_ioports port[ATA_MAX_PORTS];
223 unsigned int n_ports;
224 unsigned int hard_port_no;
225 unsigned int pio_mask;
226 unsigned int mwdma_mask;
227 unsigned int udma_mask;
228 unsigned int legacy_mode;
229 unsigned long irq;
230 unsigned int irq_flags;
231 unsigned long host_flags;
232 void __iomem *mmio_base;
233 void *private_data;
234};
235
236struct ata_host_set {
237 spinlock_t lock;
238 struct device *dev;
239 unsigned long irq;
240 void __iomem *mmio_base;
241 unsigned int n_ports;
242 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400243 const struct ata_port_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct ata_port * ports[0];
245};
246
247struct ata_queued_cmd {
248 struct ata_port *ap;
249 struct ata_device *dev;
250
251 struct scsi_cmnd *scsicmd;
252 void (*scsidone)(struct scsi_cmnd *);
253
254 struct ata_taskfile tf;
255 u8 cdb[ATAPI_CDB_LEN];
256
257 unsigned long flags; /* ATA_QCFLAG_xxx */
258 unsigned int tag;
259 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400260 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
262 int dma_dir;
263
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400264 unsigned int pad_len;
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 unsigned int nsect;
267 unsigned int cursect;
268
269 unsigned int nbytes;
270 unsigned int curbytes;
271
272 unsigned int cursg;
273 unsigned int cursg_ofs;
274
275 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400276 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 void *buf_virt;
278
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400279 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
280 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Albert Leea22e2eb2005-12-05 15:38:02 +0800282 unsigned int err_mask;
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 ata_qc_cb_t complete_fn;
285
286 struct completion *waiting;
287
288 void *private_data;
289};
290
291struct ata_host_stats {
292 unsigned long unhandled_irq;
293 unsigned long idle_irq;
294 unsigned long rw_reqbuf;
295};
296
297struct ata_device {
298 u64 n_sectors; /* size of device, if ATA */
299 unsigned long flags; /* ATA_DFLAG_xxx */
300 unsigned int class; /* ATA_DEV_xxx */
301 unsigned int devno; /* 0 or 1 */
302 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
303 u8 pio_mode;
304 u8 dma_mode;
305 u8 xfer_mode;
306 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
307
Albert Lee8cbd6df2005-10-12 15:06:27 +0800308 unsigned int multi_count; /* sectors count for
309 READ/WRITE MULTIPLE */
Albert Lee8bf62ece2005-05-12 15:29:42 -0400310
311 /* for CHS addressing */
312 u16 cylinders; /* Number of cylinders */
313 u16 heads; /* Number of heads */
314 u16 sectors; /* Number of sectors per track */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315};
316
317struct ata_port {
318 struct Scsi_Host *host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400319 const struct ata_port_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 unsigned long flags; /* ATA_FLAG_xxx */
321 unsigned int id; /* unique id req'd by scsi midlyr */
322 unsigned int port_no; /* unique port #; from zero */
323 unsigned int hard_port_no; /* hardware port #; from zero */
324
325 struct ata_prd *prd; /* our SG list */
326 dma_addr_t prd_dma; /* and its DMA mapping */
327
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400328 void *pad; /* array of DMA pad buffers */
329 dma_addr_t pad_dma;
330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
332
333 u8 ctl; /* cache of ATA control register */
334 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 unsigned int pio_mask;
336 unsigned int mwdma_mask;
337 unsigned int udma_mask;
338 unsigned int cbl; /* cable type; ATA_CBL_xxx */
339 unsigned int cdb_len;
340
341 struct ata_device device[ATA_MAX_DEVICES];
342
343 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
344 unsigned long qactive;
345 unsigned int active_tag;
346
347 struct ata_host_stats stats;
348 struct ata_host_set *host_set;
349
350 struct work_struct packet_task;
351
352 struct work_struct pio_task;
Albert Lee14be71f2005-09-27 17:36:35 +0800353 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 unsigned long pio_task_timeout;
355
356 void *private_data;
357};
358
359struct ata_port_operations {
360 void (*port_disable) (struct ata_port *);
361
362 void (*dev_config) (struct ata_port *, struct ata_device *);
363
364 void (*set_piomode) (struct ata_port *, struct ata_device *);
365 void (*set_dmamode) (struct ata_port *, struct ata_device *);
366
Jeff Garzik057ace52005-10-22 14:27:05 -0400367 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
369
Jeff Garzik057ace52005-10-22 14:27:05 -0400370 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 u8 (*check_status)(struct ata_port *ap);
372 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 void (*dev_select)(struct ata_port *ap, unsigned int device);
374
375 void (*phy_reset) (struct ata_port *ap);
376 void (*post_set_mode) (struct ata_port *ap);
377
378 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
379
380 void (*bmdma_setup) (struct ata_queued_cmd *qc);
381 void (*bmdma_start) (struct ata_queued_cmd *qc);
382
383 void (*qc_prep) (struct ata_queued_cmd *qc);
384 int (*qc_issue) (struct ata_queued_cmd *qc);
385
386 void (*eng_timeout) (struct ata_port *ap);
387
388 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
389 void (*irq_clear) (struct ata_port *);
390
391 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
392 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
393 u32 val);
394
395 int (*port_start) (struct ata_port *ap);
396 void (*port_stop) (struct ata_port *ap);
397
398 void (*host_stop) (struct ata_host_set *host_set);
399
Alan Coxb73fc892005-08-26 16:03:19 +0100400 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 u8 (*bmdma_status) (struct ata_port *ap);
402};
403
404struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100405 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 unsigned long host_flags;
407 unsigned long pio_mask;
408 unsigned long mwdma_mask;
409 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400410 const struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000411 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412};
413
Alan Cox452503f2005-10-21 19:01:32 -0400414struct ata_timing {
415 unsigned short mode; /* ATA mode */
416 unsigned short setup; /* t1 */
417 unsigned short act8b; /* t2 for 8-bit I/O */
418 unsigned short rec8b; /* t2i for 8-bit I/O */
419 unsigned short cyc8b; /* t0 for 8-bit I/O */
420 unsigned short active; /* t2 or tD */
421 unsigned short recover; /* t2i or tK */
422 unsigned short cycle; /* t0 */
423 unsigned short udma; /* t2CYCTYP/2 */
424};
425
426#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
428extern void ata_port_probe(struct ata_port *);
429extern void __sata_phy_reset(struct ata_port *ap);
430extern void sata_phy_reset(struct ata_port *ap);
431extern void ata_bus_reset(struct ata_port *ap);
432extern void ata_port_disable(struct ata_port *);
433extern void ata_std_ports(struct ata_ioports *ioaddr);
434#ifdef CONFIG_PCI
435extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
436 unsigned int n_ports);
437extern void ata_pci_remove_one (struct pci_dev *pdev);
438#endif /* CONFIG_PCI */
Jeff Garzik057ace52005-10-22 14:27:05 -0400439extern int ata_device_add(const struct ata_probe_ent *ent);
Alan Cox17b14452005-09-15 15:44:00 +0100440extern void ata_host_set_remove(struct ata_host_set *host_set);
Jeff Garzik193515d2005-11-07 00:59:37 -0500441extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
443extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
444extern int ata_scsi_error(struct Scsi_Host *host);
445extern int ata_scsi_release(struct Scsi_Host *host);
446extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Jeff Garzik67846b32005-10-05 02:58:32 -0400447extern int ata_ratelimit(void);
448
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449/*
450 * Default driver ops implementations
451 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400452extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400454extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
455extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
457extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
458extern u8 ata_check_status(struct ata_port *ap);
459extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400460extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461extern int ata_port_start (struct ata_port *ap);
462extern void ata_port_stop (struct ata_port *ap);
Jeff Garzikaa8f0dc2005-05-26 21:54:27 -0400463extern void ata_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
465extern void ata_qc_prep(struct ata_queued_cmd *qc);
466extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
467extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
468 unsigned int buflen);
469extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
470 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400471extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
472extern void ata_dev_id_string(const u16 *id, unsigned char *s,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 unsigned int ofs, unsigned int len);
Brad Campbell6f2f3812005-05-12 15:07:47 -0400474extern void ata_dev_config(struct ata_port *ap, unsigned int i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
476extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100477extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478extern u8 ata_bmdma_status(struct ata_port *ap);
479extern void ata_bmdma_irq_clear(struct ata_port *ap);
Albert Leea22e2eb2005-12-05 15:38:02 +0800480extern void ata_qc_complete(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481extern void ata_eng_timeout(struct ata_port *ap);
482extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
483 void (*done)(struct scsi_cmnd *));
484extern int ata_std_bios_param(struct scsi_device *sdev,
485 struct block_device *bdev,
486 sector_t capacity, int geom[]);
487extern int ata_scsi_slave_config(struct scsi_device *sdev);
488
Alan Cox452503f2005-10-21 19:01:32 -0400489/*
490 * Timing helpers
491 */
492extern int ata_timing_compute(struct ata_device *, unsigned short,
493 struct ata_timing *, int, int);
494extern void ata_timing_merge(const struct ata_timing *,
495 const struct ata_timing *, struct ata_timing *,
496 unsigned int);
497
498enum {
499 ATA_TIMING_SETUP = (1 << 0),
500 ATA_TIMING_ACT8B = (1 << 1),
501 ATA_TIMING_REC8B = (1 << 2),
502 ATA_TIMING_CYC8B = (1 << 3),
503 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
504 ATA_TIMING_CYC8B,
505 ATA_TIMING_ACTIVE = (1 << 4),
506 ATA_TIMING_RECOVER = (1 << 5),
507 ATA_TIMING_CYCLE = (1 << 6),
508 ATA_TIMING_UDMA = (1 << 7),
509 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
510 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
511 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
512 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
513};
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516#ifdef CONFIG_PCI
517struct pci_bits {
518 unsigned int reg; /* PCI config register to read */
519 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
520 unsigned long mask;
521 unsigned long val;
522};
523
Jeff Garzik374b1872005-08-30 05:42:52 -0400524extern void ata_pci_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400526ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Jeff Garzik057ace52005-10-22 14:27:05 -0400527extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529#endif /* CONFIG_PCI */
530
531
Jeff Garzik972c26b2005-10-18 22:14:54 -0400532static inline int
533ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
534{
535 if (sg == &qc->pad_sgent)
536 return 1;
537 if (qc->pad_len)
538 return 0;
539 if (((sg - qc->__sg) + 1) == qc->n_elem)
540 return 1;
541 return 0;
542}
543
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400544static inline struct scatterlist *
545ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
546{
547 if (sg == &qc->pad_sgent)
548 return NULL;
549 if (++sg - qc->__sg < qc->n_elem)
550 return sg;
551 return qc->pad_len ? &qc->pad_sgent : NULL;
552}
553
554#define ata_for_each_sg(sg, qc) \
555 for (sg = qc->__sg; sg; sg = ata_qc_next_sg(sg, qc))
556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557static inline unsigned int ata_tag_valid(unsigned int tag)
558{
559 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
560}
561
Jeff Garzik057ace52005-10-22 14:27:05 -0400562static inline unsigned int ata_dev_present(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563{
564 return ((dev->class == ATA_DEV_ATA) ||
565 (dev->class == ATA_DEV_ATAPI));
566}
567
568static inline u8 ata_chk_status(struct ata_port *ap)
569{
570 return ap->ops->check_status(ap);
571}
572
Edward Falk0baab862005-06-02 18:17:13 -0400573
574/**
575 * ata_pause - Flush writes and pause 400 nanoseconds.
576 * @ap: Port to wait for.
577 *
578 * LOCKING:
579 * Inherited from caller.
580 */
581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582static inline void ata_pause(struct ata_port *ap)
583{
584 ata_altstatus(ap);
585 ndelay(400);
586}
587
Edward Falk0baab862005-06-02 18:17:13 -0400588
589/**
590 * ata_busy_wait - Wait for a port status register
591 * @ap: Port to wait for.
592 *
593 * Waits up to max*10 microseconds for the selected bits in the port's
594 * status register to be cleared.
595 * Returns final value of status register.
596 *
597 * LOCKING:
598 * Inherited from caller.
599 */
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
602 unsigned int max)
603{
604 u8 status;
605
606 do {
607 udelay(10);
608 status = ata_chk_status(ap);
609 max--;
610 } while ((status & bits) && (max > 0));
611
612 return status;
613}
614
Edward Falk0baab862005-06-02 18:17:13 -0400615
616/**
617 * ata_wait_idle - Wait for a port to be idle.
618 * @ap: Port to wait for.
619 *
620 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
621 * Returns final value of status register.
622 *
623 * LOCKING:
624 * Inherited from caller.
625 */
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627static inline u8 ata_wait_idle(struct ata_port *ap)
628{
629 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
630
631 if (status & (ATA_BUSY | ATA_DRQ)) {
632 unsigned long l = ap->ioaddr.status_addr;
633 printk(KERN_WARNING
634 "ATA: abnormal status 0x%X on port 0x%lX\n",
635 status, l);
636 }
637
638 return status;
639}
640
641static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
642{
643 qc->tf.ctl |= ATA_NIEN;
644}
645
646static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
647 unsigned int tag)
648{
649 if (likely(ata_tag_valid(tag)))
650 return &ap->qcmd[tag];
651 return NULL;
652}
653
654static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
655{
656 memset(tf, 0, sizeof(*tf));
657
658 tf->ctl = ap->ctl;
659 if (device == 0)
660 tf->device = ATA_DEVICE_OBS;
661 else
662 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
663}
664
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500665static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
666{
667 qc->__sg = NULL;
668 qc->flags = 0;
669 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
670 qc->nsect = 0;
671 qc->nbytes = qc->curbytes = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +0800672 qc->err_mask = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -0500673
674 ata_tf_init(qc->ap, &qc->tf, qc->dev->devno);
675}
676
Edward Falk0baab862005-06-02 18:17:13 -0400677
678/**
679 * ata_irq_on - Enable interrupts on a port.
680 * @ap: Port on which interrupts are enabled.
681 *
682 * Enable interrupts on a legacy IDE device using MMIO or PIO,
683 * wait for idle, clear any pending interrupts.
684 *
685 * LOCKING:
686 * Inherited from caller.
687 */
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689static inline u8 ata_irq_on(struct ata_port *ap)
690{
691 struct ata_ioports *ioaddr = &ap->ioaddr;
692 u8 tmp;
693
694 ap->ctl &= ~ATA_NIEN;
695 ap->last_ctl = ap->ctl;
696
697 if (ap->flags & ATA_FLAG_MMIO)
698 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
699 else
700 outb(ap->ctl, ioaddr->ctl_addr);
701 tmp = ata_wait_idle(ap);
702
703 ap->ops->irq_clear(ap);
704
705 return tmp;
706}
707
Edward Falk0baab862005-06-02 18:17:13 -0400708
709/**
710 * ata_irq_ack - Acknowledge a device interrupt.
711 * @ap: Port on which interrupts are enabled.
712 *
713 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
714 * or BUSY+DRQ clear). Obtain dma status and port status from
715 * device. Clear the interrupt. Return port status.
716 *
717 * LOCKING:
718 */
719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
721{
722 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
723 u8 host_stat, post_stat, status;
724
725 status = ata_busy_wait(ap, bits, 1000);
726 if (status & bits)
727 DPRINTK("abnormal status 0x%X\n", status);
728
729 /* get controller status; clear intr, err bits */
730 if (ap->flags & ATA_FLAG_MMIO) {
731 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
732 host_stat = readb(mmio + ATA_DMA_STATUS);
733 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
734 mmio + ATA_DMA_STATUS);
735
736 post_stat = readb(mmio + ATA_DMA_STATUS);
737 } else {
738 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
739 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
740 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
741
742 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
743 }
744
745 VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
746 host_stat, post_stat, status);
747
748 return status;
749}
750
751static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
752{
753 return ap->ops->scr_read(ap, reg);
754}
755
756static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
757{
758 ap->ops->scr_write(ap, reg, val);
759}
760
Jeff Garzik8a60a072005-07-31 13:13:24 -0400761static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
Brett Russcdcca89e2005-03-28 15:10:27 -0500762 u32 val)
763{
764 ap->ops->scr_write(ap, reg, val);
765 (void) ap->ops->scr_read(ap, reg);
766}
767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768static inline unsigned int sata_dev_present(struct ata_port *ap)
769{
770 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
771}
772
Jeff Garzik057ace52005-10-22 14:27:05 -0400773static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774{
775 return ata_id_wcache_enabled(dev->id) ||
776 ata_id_has_flush(dev->id) ||
777 ata_id_has_flush_ext(dev->id);
778}
779
Jeff Garzika7dac442005-10-30 04:44:42 -0500780static inline unsigned int ac_err_mask(u8 status)
781{
782 if (status & ATA_BUSY)
783 return AC_ERR_ATA_BUS;
784 if (status & (ATA_ERR | ATA_DF))
785 return AC_ERR_DEV;
786 return 0;
787}
788
789static inline unsigned int __ac_err_mask(u8 status)
790{
791 unsigned int mask = ac_err_mask(status);
792 if (mask == 0)
793 return AC_ERR_OTHER;
794 return mask;
795}
796
Jeff Garzik6037d6b2005-11-04 22:08:00 -0500797static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
798{
799 ap->pad_dma = 0;
800 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
801 &ap->pad_dma, GFP_KERNEL);
802 return (ap->pad == NULL) ? -ENOMEM : 0;
803}
804
805static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
806{
807 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
808}
809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810#endif /* __LINUX_LIBATA_H__ */