blob: 00a8a5738858bd4e3a13e53cd93c3ec03196f22b [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>
32#include <asm/io.h>
33#include <linux/ata.h>
34#include <linux/workqueue.h>
35
36/*
37 * compile-time options
38 */
39#undef ATA_DEBUG /* debugging output */
40#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
41#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
42#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#undef ATA_ENABLE_PATA /* define to enable PATA support in some
44 * low-level drivers */
45#undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */
46
47
48/* note: prints function name for you */
49#ifdef ATA_DEBUG
50#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
51#ifdef ATA_VERBOSE_DEBUG
52#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
53#else
54#define VPRINTK(fmt, args...)
55#endif /* ATA_VERBOSE_DEBUG */
56#else
57#define DPRINTK(fmt, args...)
58#define VPRINTK(fmt, args...)
59#endif /* ATA_DEBUG */
60
61#ifdef ATA_NDEBUG
62#define assert(expr)
63#else
64#define assert(expr) \
65 if(unlikely(!(expr))) { \
66 printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \
67 #expr,__FILE__,__FUNCTION__,__LINE__); \
68 }
69#endif
70
71/* defines only for the constants which don't work well as enums */
72#define ATA_TAG_POISON 0xfafbfcfdU
73
74/* move to PCI layer? */
75static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
76{
77 return &pdev->dev;
78}
79
80enum {
81 /* various global constants */
82 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
83 ATA_MAX_PORTS = 8,
84 ATA_DEF_QUEUE = 1,
85 ATA_MAX_QUEUE = 1,
86 ATA_MAX_SECTORS = 200, /* FIXME */
87 ATA_MAX_BUS = 2,
88 ATA_DEF_BUSY_WAIT = 10000,
89 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
90
91 ATA_SHT_EMULATED = 1,
92 ATA_SHT_CMD_PER_LUN = 1,
93 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -040094 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96 /* struct ata_device stuff */
97 ATA_DFLAG_LBA48 = (1 << 0), /* device supports LBA48 */
98 ATA_DFLAG_PIO = (1 << 1), /* device currently in PIO mode */
99 ATA_DFLAG_LOCK_SECTORS = (1 << 2), /* don't adjust max_sectors */
Albert Lee8bf62ece2005-05-12 15:29:42 -0400100 ATA_DFLAG_LBA = (1 << 3), /* device supports LBA */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102 ATA_DEV_UNKNOWN = 0, /* unknown device */
103 ATA_DEV_ATA = 1, /* ATA device */
104 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
105 ATA_DEV_ATAPI = 3, /* ATAPI device */
106 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
107 ATA_DEV_NONE = 5, /* no device */
108
109 /* struct ata_port flags */
110 ATA_FLAG_SLAVE_POSS = (1 << 1), /* host supports slave dev */
111 /* (doesn't imply presence) */
112 ATA_FLAG_PORT_DISABLED = (1 << 2), /* port is disabled, ignore it */
113 ATA_FLAG_SATA = (1 << 3),
114 ATA_FLAG_NO_LEGACY = (1 << 4), /* no legacy mode check */
115 ATA_FLAG_SRST = (1 << 5), /* use ATA SRST, not E.D.D. */
116 ATA_FLAG_MMIO = (1 << 6), /* use MMIO, not PIO */
117 ATA_FLAG_SATA_RESET = (1 << 7), /* use COMRESET */
118 ATA_FLAG_PIO_DMA = (1 << 8), /* PIO cmds via DMA */
Tejun Heoc1389502005-08-22 14:59:24 +0900119 ATA_FLAG_NOINTR = (1 << 9), /* FIXME: Remove this once
120 * proper HSM is in place. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122 ATA_QCFLAG_ACTIVE = (1 << 1), /* cmd not yet ack'd to scsi lyer */
123 ATA_QCFLAG_SG = (1 << 3), /* have s/g table? */
124 ATA_QCFLAG_SINGLE = (1 << 4), /* no s/g, just a single buffer */
125 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
126
127 /* various lengths of time */
128 ATA_TMOUT_EDD = 5 * HZ, /* hueristic */
129 ATA_TMOUT_PIO = 30 * HZ,
130 ATA_TMOUT_BOOT = 30 * HZ, /* hueristic */
131 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* hueristic */
132 ATA_TMOUT_CDB = 30 * HZ,
133 ATA_TMOUT_CDB_QUICK = 5 * HZ,
134
135 /* ATA bus states */
136 BUS_UNKNOWN = 0,
137 BUS_DMA = 1,
138 BUS_IDLE = 2,
139 BUS_NOINTR = 3,
140 BUS_NODATA = 4,
141 BUS_TIMER = 5,
142 BUS_PIO = 6,
143 BUS_EDD = 7,
144 BUS_IDENTIFY = 8,
145 BUS_PACKET = 9,
146
147 /* SATA port states */
148 PORT_UNKNOWN = 0,
149 PORT_ENABLED = 1,
150 PORT_DISABLED = 2,
151
152 /* encoding various smaller bitmaps into a single
153 * unsigned long bitmap
154 */
155 ATA_SHIFT_UDMA = 0,
156 ATA_SHIFT_MWDMA = 8,
157 ATA_SHIFT_PIO = 11,
Alan Cox47a86592005-10-04 08:09:19 -0400158
159 /* Masks for port functions */
160 ATA_PORT_PRIMARY = (1 << 0),
161 ATA_PORT_SECONDARY = (1 << 1),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162};
163
Albert Lee14be71f2005-09-27 17:36:35 +0800164enum hsm_task_states {
165 HSM_ST_UNKNOWN,
166 HSM_ST_IDLE,
167 HSM_ST_POLL,
168 HSM_ST_TMOUT,
169 HSM_ST,
170 HSM_ST_LAST,
171 HSM_ST_LAST_POLL,
172 HSM_ST_ERR,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173};
174
175/* forward declarations */
176struct scsi_device;
177struct ata_port_operations;
178struct ata_port;
179struct ata_queued_cmd;
180
181/* typedefs */
182typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, u8 drv_stat);
183
184struct ata_ioports {
185 unsigned long cmd_addr;
186 unsigned long data_addr;
187 unsigned long error_addr;
188 unsigned long feature_addr;
189 unsigned long nsect_addr;
190 unsigned long lbal_addr;
191 unsigned long lbam_addr;
192 unsigned long lbah_addr;
193 unsigned long device_addr;
194 unsigned long status_addr;
195 unsigned long command_addr;
196 unsigned long altstatus_addr;
197 unsigned long ctl_addr;
198 unsigned long bmdma_addr;
199 unsigned long scr_addr;
200};
201
202struct ata_probe_ent {
203 struct list_head node;
204 struct device *dev;
Jeff Garzik057ace52005-10-22 14:27:05 -0400205 const struct ata_port_operations *port_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 Scsi_Host_Template *sht;
207 struct ata_ioports port[ATA_MAX_PORTS];
208 unsigned int n_ports;
209 unsigned int hard_port_no;
210 unsigned int pio_mask;
211 unsigned int mwdma_mask;
212 unsigned int udma_mask;
213 unsigned int legacy_mode;
214 unsigned long irq;
215 unsigned int irq_flags;
216 unsigned long host_flags;
217 void __iomem *mmio_base;
218 void *private_data;
219};
220
221struct ata_host_set {
222 spinlock_t lock;
223 struct device *dev;
224 unsigned long irq;
225 void __iomem *mmio_base;
226 unsigned int n_ports;
227 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400228 const struct ata_port_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 struct ata_port * ports[0];
230};
231
232struct ata_queued_cmd {
233 struct ata_port *ap;
234 struct ata_device *dev;
235
236 struct scsi_cmnd *scsicmd;
237 void (*scsidone)(struct scsi_cmnd *);
238
239 struct ata_taskfile tf;
240 u8 cdb[ATAPI_CDB_LEN];
241
242 unsigned long flags; /* ATA_QCFLAG_xxx */
243 unsigned int tag;
244 unsigned int n_elem;
245
246 int dma_dir;
247
248 unsigned int nsect;
249 unsigned int cursect;
250
251 unsigned int nbytes;
252 unsigned int curbytes;
253
254 unsigned int cursg;
255 unsigned int cursg_ofs;
256
257 struct scatterlist sgent;
258 void *buf_virt;
259
260 struct scatterlist *sg;
261
262 ata_qc_cb_t complete_fn;
263
264 struct completion *waiting;
265
266 void *private_data;
267};
268
269struct ata_host_stats {
270 unsigned long unhandled_irq;
271 unsigned long idle_irq;
272 unsigned long rw_reqbuf;
273};
274
275struct ata_device {
276 u64 n_sectors; /* size of device, if ATA */
277 unsigned long flags; /* ATA_DFLAG_xxx */
278 unsigned int class; /* ATA_DEV_xxx */
279 unsigned int devno; /* 0 or 1 */
280 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
281 u8 pio_mode;
282 u8 dma_mode;
283 u8 xfer_mode;
284 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
285
Albert Lee8cbd6df2005-10-12 15:06:27 +0800286 unsigned int multi_count; /* sectors count for
287 READ/WRITE MULTIPLE */
Albert Lee8bf62ece2005-05-12 15:29:42 -0400288
289 /* for CHS addressing */
290 u16 cylinders; /* Number of cylinders */
291 u16 heads; /* Number of heads */
292 u16 sectors; /* Number of sectors per track */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293};
294
295struct ata_port {
296 struct Scsi_Host *host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400297 const struct ata_port_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 unsigned long flags; /* ATA_FLAG_xxx */
299 unsigned int id; /* unique id req'd by scsi midlyr */
300 unsigned int port_no; /* unique port #; from zero */
301 unsigned int hard_port_no; /* hardware port #; from zero */
302
303 struct ata_prd *prd; /* our SG list */
304 dma_addr_t prd_dma; /* and its DMA mapping */
305
306 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
307
308 u8 ctl; /* cache of ATA control register */
309 u8 last_ctl; /* Cache last written value */
310 unsigned int bus_state;
311 unsigned int port_state;
312 unsigned int pio_mask;
313 unsigned int mwdma_mask;
314 unsigned int udma_mask;
315 unsigned int cbl; /* cable type; ATA_CBL_xxx */
316 unsigned int cdb_len;
317
318 struct ata_device device[ATA_MAX_DEVICES];
319
320 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
321 unsigned long qactive;
322 unsigned int active_tag;
323
324 struct ata_host_stats stats;
325 struct ata_host_set *host_set;
326
327 struct work_struct packet_task;
328
329 struct work_struct pio_task;
Albert Lee14be71f2005-09-27 17:36:35 +0800330 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 unsigned long pio_task_timeout;
332
333 void *private_data;
334};
335
336struct ata_port_operations {
337 void (*port_disable) (struct ata_port *);
338
339 void (*dev_config) (struct ata_port *, struct ata_device *);
340
341 void (*set_piomode) (struct ata_port *, struct ata_device *);
342 void (*set_dmamode) (struct ata_port *, struct ata_device *);
343
Jeff Garzik057ace52005-10-22 14:27:05 -0400344 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
346
Jeff Garzik057ace52005-10-22 14:27:05 -0400347 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 u8 (*check_status)(struct ata_port *ap);
349 u8 (*check_altstatus)(struct ata_port *ap);
350 u8 (*check_err)(struct ata_port *ap);
351 void (*dev_select)(struct ata_port *ap, unsigned int device);
352
353 void (*phy_reset) (struct ata_port *ap);
354 void (*post_set_mode) (struct ata_port *ap);
355
356 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
357
358 void (*bmdma_setup) (struct ata_queued_cmd *qc);
359 void (*bmdma_start) (struct ata_queued_cmd *qc);
360
361 void (*qc_prep) (struct ata_queued_cmd *qc);
362 int (*qc_issue) (struct ata_queued_cmd *qc);
363
364 void (*eng_timeout) (struct ata_port *ap);
365
366 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
367 void (*irq_clear) (struct ata_port *);
368
369 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
370 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
371 u32 val);
372
373 int (*port_start) (struct ata_port *ap);
374 void (*port_stop) (struct ata_port *ap);
375
376 void (*host_stop) (struct ata_host_set *host_set);
377
Alan Coxb73fc892005-08-26 16:03:19 +0100378 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 u8 (*bmdma_status) (struct ata_port *ap);
380};
381
382struct ata_port_info {
383 Scsi_Host_Template *sht;
384 unsigned long host_flags;
385 unsigned long pio_mask;
386 unsigned long mwdma_mask;
387 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400388 const struct ata_port_operations *port_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389};
390
Alan Cox452503f2005-10-21 19:01:32 -0400391struct ata_timing {
392 unsigned short mode; /* ATA mode */
393 unsigned short setup; /* t1 */
394 unsigned short act8b; /* t2 for 8-bit I/O */
395 unsigned short rec8b; /* t2i for 8-bit I/O */
396 unsigned short cyc8b; /* t0 for 8-bit I/O */
397 unsigned short active; /* t2 or tD */
398 unsigned short recover; /* t2i or tK */
399 unsigned short cycle; /* t0 */
400 unsigned short udma; /* t2CYCTYP/2 */
401};
402
403#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405extern void ata_port_probe(struct ata_port *);
406extern void __sata_phy_reset(struct ata_port *ap);
407extern void sata_phy_reset(struct ata_port *ap);
408extern void ata_bus_reset(struct ata_port *ap);
409extern void ata_port_disable(struct ata_port *);
410extern void ata_std_ports(struct ata_ioports *ioaddr);
411#ifdef CONFIG_PCI
412extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
413 unsigned int n_ports);
414extern void ata_pci_remove_one (struct pci_dev *pdev);
415#endif /* CONFIG_PCI */
Jeff Garzik057ace52005-10-22 14:27:05 -0400416extern int ata_device_add(const struct ata_probe_ent *ent);
Alan Cox17b14452005-09-15 15:44:00 +0100417extern void ata_host_set_remove(struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418extern int ata_scsi_detect(Scsi_Host_Template *sht);
419extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
420extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
421extern int ata_scsi_error(struct Scsi_Host *host);
422extern int ata_scsi_release(struct Scsi_Host *host);
423extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Jeff Garzik67846b32005-10-05 02:58:32 -0400424extern int ata_ratelimit(void);
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426/*
427 * Default driver ops implementations
428 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400429extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400431extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
432extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
434extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
435extern u8 ata_check_status(struct ata_port *ap);
436extern u8 ata_altstatus(struct ata_port *ap);
437extern u8 ata_chk_err(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400438extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439extern int ata_port_start (struct ata_port *ap);
440extern void ata_port_stop (struct ata_port *ap);
Jeff Garzikaa8f0dc2005-05-26 21:54:27 -0400441extern void ata_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
443extern void ata_qc_prep(struct ata_queued_cmd *qc);
444extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
445extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
446 unsigned int buflen);
447extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
448 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400449extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
450extern void ata_dev_id_string(const u16 *id, unsigned char *s,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 unsigned int ofs, unsigned int len);
Brad Campbell6f2f3812005-05-12 15:07:47 -0400452extern void ata_dev_config(struct ata_port *ap, unsigned int i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
454extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100455extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456extern u8 ata_bmdma_status(struct ata_port *ap);
457extern void ata_bmdma_irq_clear(struct ata_port *ap);
458extern void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat);
459extern void ata_eng_timeout(struct ata_port *ap);
460extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
461 void (*done)(struct scsi_cmnd *));
462extern int ata_std_bios_param(struct scsi_device *sdev,
463 struct block_device *bdev,
464 sector_t capacity, int geom[]);
465extern int ata_scsi_slave_config(struct scsi_device *sdev);
466
Alan Cox452503f2005-10-21 19:01:32 -0400467/*
468 * Timing helpers
469 */
470extern int ata_timing_compute(struct ata_device *, unsigned short,
471 struct ata_timing *, int, int);
472extern void ata_timing_merge(const struct ata_timing *,
473 const struct ata_timing *, struct ata_timing *,
474 unsigned int);
475
476enum {
477 ATA_TIMING_SETUP = (1 << 0),
478 ATA_TIMING_ACT8B = (1 << 1),
479 ATA_TIMING_REC8B = (1 << 2),
480 ATA_TIMING_CYC8B = (1 << 3),
481 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
482 ATA_TIMING_CYC8B,
483 ATA_TIMING_ACTIVE = (1 << 4),
484 ATA_TIMING_RECOVER = (1 << 5),
485 ATA_TIMING_CYCLE = (1 << 6),
486 ATA_TIMING_UDMA = (1 << 7),
487 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
488 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
489 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
490 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
491};
492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
494#ifdef CONFIG_PCI
495struct pci_bits {
496 unsigned int reg; /* PCI config register to read */
497 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
498 unsigned long mask;
499 unsigned long val;
500};
501
Jeff Garzik374b1872005-08-30 05:42:52 -0400502extern void ata_pci_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400504ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Jeff Garzik057ace52005-10-22 14:27:05 -0400505extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
507#endif /* CONFIG_PCI */
508
509
510static inline unsigned int ata_tag_valid(unsigned int tag)
511{
512 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
513}
514
Jeff Garzik057ace52005-10-22 14:27:05 -0400515static inline unsigned int ata_dev_present(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
517 return ((dev->class == ATA_DEV_ATA) ||
518 (dev->class == ATA_DEV_ATAPI));
519}
520
521static inline u8 ata_chk_status(struct ata_port *ap)
522{
523 return ap->ops->check_status(ap);
524}
525
Edward Falk0baab862005-06-02 18:17:13 -0400526
527/**
528 * ata_pause - Flush writes and pause 400 nanoseconds.
529 * @ap: Port to wait for.
530 *
531 * LOCKING:
532 * Inherited from caller.
533 */
534
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535static inline void ata_pause(struct ata_port *ap)
536{
537 ata_altstatus(ap);
538 ndelay(400);
539}
540
Edward Falk0baab862005-06-02 18:17:13 -0400541
542/**
543 * ata_busy_wait - Wait for a port status register
544 * @ap: Port to wait for.
545 *
546 * Waits up to max*10 microseconds for the selected bits in the port's
547 * status register to be cleared.
548 * Returns final value of status register.
549 *
550 * LOCKING:
551 * Inherited from caller.
552 */
553
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
555 unsigned int max)
556{
557 u8 status;
558
559 do {
560 udelay(10);
561 status = ata_chk_status(ap);
562 max--;
563 } while ((status & bits) && (max > 0));
564
565 return status;
566}
567
Edward Falk0baab862005-06-02 18:17:13 -0400568
569/**
570 * ata_wait_idle - Wait for a port to be idle.
571 * @ap: Port to wait for.
572 *
573 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
574 * Returns final value of status register.
575 *
576 * LOCKING:
577 * Inherited from caller.
578 */
579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580static inline u8 ata_wait_idle(struct ata_port *ap)
581{
582 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
583
584 if (status & (ATA_BUSY | ATA_DRQ)) {
585 unsigned long l = ap->ioaddr.status_addr;
586 printk(KERN_WARNING
587 "ATA: abnormal status 0x%X on port 0x%lX\n",
588 status, l);
589 }
590
591 return status;
592}
593
594static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
595{
596 qc->tf.ctl |= ATA_NIEN;
597}
598
599static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
600 unsigned int tag)
601{
602 if (likely(ata_tag_valid(tag)))
603 return &ap->qcmd[tag];
604 return NULL;
605}
606
607static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
608{
609 memset(tf, 0, sizeof(*tf));
610
611 tf->ctl = ap->ctl;
612 if (device == 0)
613 tf->device = ATA_DEVICE_OBS;
614 else
615 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
616}
617
Edward Falk0baab862005-06-02 18:17:13 -0400618
619/**
620 * ata_irq_on - Enable interrupts on a port.
621 * @ap: Port on which interrupts are enabled.
622 *
623 * Enable interrupts on a legacy IDE device using MMIO or PIO,
624 * wait for idle, clear any pending interrupts.
625 *
626 * LOCKING:
627 * Inherited from caller.
628 */
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630static inline u8 ata_irq_on(struct ata_port *ap)
631{
632 struct ata_ioports *ioaddr = &ap->ioaddr;
633 u8 tmp;
634
635 ap->ctl &= ~ATA_NIEN;
636 ap->last_ctl = ap->ctl;
637
638 if (ap->flags & ATA_FLAG_MMIO)
639 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
640 else
641 outb(ap->ctl, ioaddr->ctl_addr);
642 tmp = ata_wait_idle(ap);
643
644 ap->ops->irq_clear(ap);
645
646 return tmp;
647}
648
Edward Falk0baab862005-06-02 18:17:13 -0400649
650/**
651 * ata_irq_ack - Acknowledge a device interrupt.
652 * @ap: Port on which interrupts are enabled.
653 *
654 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
655 * or BUSY+DRQ clear). Obtain dma status and port status from
656 * device. Clear the interrupt. Return port status.
657 *
658 * LOCKING:
659 */
660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
662{
663 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
664 u8 host_stat, post_stat, status;
665
666 status = ata_busy_wait(ap, bits, 1000);
667 if (status & bits)
668 DPRINTK("abnormal status 0x%X\n", status);
669
670 /* get controller status; clear intr, err bits */
671 if (ap->flags & ATA_FLAG_MMIO) {
672 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
673 host_stat = readb(mmio + ATA_DMA_STATUS);
674 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
675 mmio + ATA_DMA_STATUS);
676
677 post_stat = readb(mmio + ATA_DMA_STATUS);
678 } else {
679 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
680 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
681 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
682
683 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
684 }
685
686 VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
687 host_stat, post_stat, status);
688
689 return status;
690}
691
692static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
693{
694 return ap->ops->scr_read(ap, reg);
695}
696
697static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
698{
699 ap->ops->scr_write(ap, reg, val);
700}
701
Jeff Garzik8a60a072005-07-31 13:13:24 -0400702static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
Brett Russcdcca89e2005-03-28 15:10:27 -0500703 u32 val)
704{
705 ap->ops->scr_write(ap, reg, val);
706 (void) ap->ops->scr_read(ap, reg);
707}
708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709static inline unsigned int sata_dev_present(struct ata_port *ap)
710{
711 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
712}
713
Jeff Garzik057ace52005-10-22 14:27:05 -0400714static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
716 return ata_id_wcache_enabled(dev->id) ||
717 ata_id_has_flush(dev->id) ||
718 ata_id_has_flush_ext(dev->id);
719}
720
721#endif /* __LINUX_LIBATA_H__ */