blob: d3dfefefabece15cb9ffded87297966da842b943 [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,
94 ATA_SHT_USE_CLUSTERING = 0,
95
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 Lee8bf62ec2005-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,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400158
159 /* size of buffer to pad xfers ending on unaligned boundaries */
160 ATA_DMA_PAD_SZ = 4,
161 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Alan Cox47a86592005-10-04 08:09:19 -0400162
163 /* Masks for port functions */
164 ATA_PORT_PRIMARY = (1 << 0),
165 ATA_PORT_SECONDARY = (1 << 1),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166};
167
Albert Lee14be71f2005-09-27 17:36:35 +0800168enum hsm_task_states {
169 HSM_ST_UNKNOWN,
170 HSM_ST_IDLE,
171 HSM_ST_POLL,
172 HSM_ST_TMOUT,
173 HSM_ST,
174 HSM_ST_LAST,
175 HSM_ST_LAST_POLL,
176 HSM_ST_ERR,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177};
178
179/* forward declarations */
180struct scsi_device;
181struct ata_port_operations;
182struct ata_port;
183struct ata_queued_cmd;
184
185/* typedefs */
186typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, u8 drv_stat);
187
188struct ata_ioports {
189 unsigned long cmd_addr;
190 unsigned long data_addr;
191 unsigned long error_addr;
192 unsigned long feature_addr;
193 unsigned long nsect_addr;
194 unsigned long lbal_addr;
195 unsigned long lbam_addr;
196 unsigned long lbah_addr;
197 unsigned long device_addr;
198 unsigned long status_addr;
199 unsigned long command_addr;
200 unsigned long altstatus_addr;
201 unsigned long ctl_addr;
202 unsigned long bmdma_addr;
203 unsigned long scr_addr;
204};
205
206struct ata_probe_ent {
207 struct list_head node;
208 struct device *dev;
209 struct ata_port_operations *port_ops;
210 Scsi_Host_Template *sht;
211 struct ata_ioports port[ATA_MAX_PORTS];
212 unsigned int n_ports;
213 unsigned int hard_port_no;
214 unsigned int pio_mask;
215 unsigned int mwdma_mask;
216 unsigned int udma_mask;
217 unsigned int legacy_mode;
218 unsigned long irq;
219 unsigned int irq_flags;
220 unsigned long host_flags;
221 void __iomem *mmio_base;
222 void *private_data;
223};
224
225struct ata_host_set {
226 spinlock_t lock;
227 struct device *dev;
228 unsigned long irq;
229 void __iomem *mmio_base;
230 unsigned int n_ports;
231 void *private_data;
232 struct ata_port_operations *ops;
233 struct ata_port * ports[0];
234};
235
236struct ata_queued_cmd {
237 struct ata_port *ap;
238 struct ata_device *dev;
239
240 struct scsi_cmnd *scsicmd;
241 void (*scsidone)(struct scsi_cmnd *);
242
243 struct ata_taskfile tf;
244 u8 cdb[ATAPI_CDB_LEN];
245
246 unsigned long flags; /* ATA_QCFLAG_xxx */
247 unsigned int tag;
248 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400249 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251 int dma_dir;
252
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400253 unsigned int pad_len;
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 unsigned int nsect;
256 unsigned int cursect;
257
258 unsigned int nbytes;
259 unsigned int curbytes;
260
261 unsigned int cursg;
262 unsigned int cursg_ofs;
263
264 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400265 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 void *buf_virt;
267
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400268 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
269 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271 ata_qc_cb_t complete_fn;
272
273 struct completion *waiting;
274
275 void *private_data;
276};
277
278struct ata_host_stats {
279 unsigned long unhandled_irq;
280 unsigned long idle_irq;
281 unsigned long rw_reqbuf;
282};
283
284struct ata_device {
285 u64 n_sectors; /* size of device, if ATA */
286 unsigned long flags; /* ATA_DFLAG_xxx */
287 unsigned int class; /* ATA_DEV_xxx */
288 unsigned int devno; /* 0 or 1 */
289 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
290 u8 pio_mode;
291 u8 dma_mode;
292 u8 xfer_mode;
293 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
294
Albert Lee8cbd6df2005-10-12 15:06:27 +0800295 unsigned int multi_count; /* sectors count for
296 READ/WRITE MULTIPLE */
Albert Lee8bf62ec2005-05-12 15:29:42 -0400297
298 /* for CHS addressing */
299 u16 cylinders; /* Number of cylinders */
300 u16 heads; /* Number of heads */
301 u16 sectors; /* Number of sectors per track */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302};
303
304struct ata_port {
305 struct Scsi_Host *host; /* our co-allocated scsi host */
306 struct ata_port_operations *ops;
307 unsigned long flags; /* ATA_FLAG_xxx */
308 unsigned int id; /* unique id req'd by scsi midlyr */
309 unsigned int port_no; /* unique port #; from zero */
310 unsigned int hard_port_no; /* hardware port #; from zero */
311
312 struct ata_prd *prd; /* our SG list */
313 dma_addr_t prd_dma; /* and its DMA mapping */
314
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400315 void *pad; /* array of DMA pad buffers */
316 dma_addr_t pad_dma;
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
319
320 u8 ctl; /* cache of ATA control register */
321 u8 last_ctl; /* Cache last written value */
322 unsigned int bus_state;
323 unsigned int port_state;
324 unsigned int pio_mask;
325 unsigned int mwdma_mask;
326 unsigned int udma_mask;
327 unsigned int cbl; /* cable type; ATA_CBL_xxx */
328 unsigned int cdb_len;
329
330 struct ata_device device[ATA_MAX_DEVICES];
331
332 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
333 unsigned long qactive;
334 unsigned int active_tag;
335
336 struct ata_host_stats stats;
337 struct ata_host_set *host_set;
338
339 struct work_struct packet_task;
340
341 struct work_struct pio_task;
Albert Lee14be71f2005-09-27 17:36:35 +0800342 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 unsigned long pio_task_timeout;
344
345 void *private_data;
346};
347
348struct ata_port_operations {
349 void (*port_disable) (struct ata_port *);
350
351 void (*dev_config) (struct ata_port *, struct ata_device *);
352
353 void (*set_piomode) (struct ata_port *, struct ata_device *);
354 void (*set_dmamode) (struct ata_port *, struct ata_device *);
355
356 void (*tf_load) (struct ata_port *ap, struct ata_taskfile *tf);
357 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
358
359 void (*exec_command)(struct ata_port *ap, struct ata_taskfile *tf);
360 u8 (*check_status)(struct ata_port *ap);
361 u8 (*check_altstatus)(struct ata_port *ap);
362 u8 (*check_err)(struct ata_port *ap);
363 void (*dev_select)(struct ata_port *ap, unsigned int device);
364
365 void (*phy_reset) (struct ata_port *ap);
366 void (*post_set_mode) (struct ata_port *ap);
367
368 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
369
370 void (*bmdma_setup) (struct ata_queued_cmd *qc);
371 void (*bmdma_start) (struct ata_queued_cmd *qc);
372
373 void (*qc_prep) (struct ata_queued_cmd *qc);
374 int (*qc_issue) (struct ata_queued_cmd *qc);
375
376 void (*eng_timeout) (struct ata_port *ap);
377
378 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
379 void (*irq_clear) (struct ata_port *);
380
381 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
382 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
383 u32 val);
384
385 int (*port_start) (struct ata_port *ap);
386 void (*port_stop) (struct ata_port *ap);
387
388 void (*host_stop) (struct ata_host_set *host_set);
389
Alan Coxb73fc892005-08-26 16:03:19 +0100390 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 u8 (*bmdma_status) (struct ata_port *ap);
392};
393
394struct ata_port_info {
395 Scsi_Host_Template *sht;
396 unsigned long host_flags;
397 unsigned long pio_mask;
398 unsigned long mwdma_mask;
399 unsigned long udma_mask;
400 struct ata_port_operations *port_ops;
401};
402
403
404extern void ata_port_probe(struct ata_port *);
405extern void __sata_phy_reset(struct ata_port *ap);
406extern void sata_phy_reset(struct ata_port *ap);
407extern void ata_bus_reset(struct ata_port *ap);
408extern void ata_port_disable(struct ata_port *);
409extern void ata_std_ports(struct ata_ioports *ioaddr);
410#ifdef CONFIG_PCI
411extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
412 unsigned int n_ports);
413extern void ata_pci_remove_one (struct pci_dev *pdev);
414#endif /* CONFIG_PCI */
415extern int ata_device_add(struct ata_probe_ent *ent);
Alan Cox17b14452005-09-15 15:44:00 +0100416extern void ata_host_set_remove(struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417extern int ata_scsi_detect(Scsi_Host_Template *sht);
418extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
419extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
420extern int ata_scsi_error(struct Scsi_Host *host);
421extern int ata_scsi_release(struct Scsi_Host *host);
422extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Jeff Garzik67846b32005-10-05 02:58:32 -0400423extern int ata_ratelimit(void);
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425/*
426 * Default driver ops implementations
427 */
428extern void ata_tf_load(struct ata_port *ap, struct ata_taskfile *tf);
429extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
430extern void ata_tf_to_fis(struct ata_taskfile *tf, u8 *fis, u8 pmp);
431extern void ata_tf_from_fis(u8 *fis, struct ata_taskfile *tf);
432extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
433extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
434extern u8 ata_check_status(struct ata_port *ap);
435extern u8 ata_altstatus(struct ata_port *ap);
436extern u8 ata_chk_err(struct ata_port *ap);
437extern void ata_exec_command(struct ata_port *ap, struct ata_taskfile *tf);
438extern int ata_port_start (struct ata_port *ap);
439extern void ata_port_stop (struct ata_port *ap);
Jeff Garzikaa8f0dc2005-05-26 21:54:27 -0400440extern void ata_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
442extern void ata_qc_prep(struct ata_queued_cmd *qc);
443extern int ata_qc_issue_prot(struct ata_queued_cmd *qc);
444extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
445 unsigned int buflen);
446extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
447 unsigned int n_elem);
448extern unsigned int ata_dev_classify(struct ata_taskfile *tf);
449extern void ata_dev_id_string(u16 *id, unsigned char *s,
450 unsigned int ofs, unsigned int len);
Brad Campbell6f2f3812005-05-12 15:07:47 -0400451extern void ata_dev_config(struct ata_port *ap, unsigned int i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
453extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100454extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455extern u8 ata_bmdma_status(struct ata_port *ap);
456extern void ata_bmdma_irq_clear(struct ata_port *ap);
457extern void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat);
458extern void ata_eng_timeout(struct ata_port *ap);
459extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd,
460 void (*done)(struct scsi_cmnd *));
461extern int ata_std_bios_param(struct scsi_device *sdev,
462 struct block_device *bdev,
463 sector_t capacity, int geom[]);
464extern int ata_scsi_slave_config(struct scsi_device *sdev);
465
466
467#ifdef CONFIG_PCI
468struct pci_bits {
469 unsigned int reg; /* PCI config register to read */
470 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
471 unsigned long mask;
472 unsigned long val;
473};
474
Jeff Garzik374b1872005-08-30 05:42:52 -0400475extern void ata_pci_host_stop (struct ata_host_set *host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400477ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478extern int pci_test_config_bits(struct pci_dev *pdev, struct pci_bits *bits);
479
480#endif /* CONFIG_PCI */
481
482
Jeff Garzik972c26b2005-10-18 22:14:54 -0400483static inline int
484ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
485{
486 if (sg == &qc->pad_sgent)
487 return 1;
488 if (qc->pad_len)
489 return 0;
490 if (((sg - qc->__sg) + 1) == qc->n_elem)
491 return 1;
492 return 0;
493}
494
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400495static inline struct scatterlist *
496ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
497{
498 if (sg == &qc->pad_sgent)
499 return NULL;
500 if (++sg - qc->__sg < qc->n_elem)
501 return sg;
502 return qc->pad_len ? &qc->pad_sgent : NULL;
503}
504
505#define ata_for_each_sg(sg, qc) \
506 for (sg = qc->__sg; sg; sg = ata_qc_next_sg(sg, qc))
507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508static inline unsigned int ata_tag_valid(unsigned int tag)
509{
510 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
511}
512
513static inline unsigned int ata_dev_present(struct ata_device *dev)
514{
515 return ((dev->class == ATA_DEV_ATA) ||
516 (dev->class == ATA_DEV_ATAPI));
517}
518
519static inline u8 ata_chk_status(struct ata_port *ap)
520{
521 return ap->ops->check_status(ap);
522}
523
Edward Falk0baab862005-06-02 18:17:13 -0400524
525/**
526 * ata_pause - Flush writes and pause 400 nanoseconds.
527 * @ap: Port to wait for.
528 *
529 * LOCKING:
530 * Inherited from caller.
531 */
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533static inline void ata_pause(struct ata_port *ap)
534{
535 ata_altstatus(ap);
536 ndelay(400);
537}
538
Edward Falk0baab862005-06-02 18:17:13 -0400539
540/**
541 * ata_busy_wait - Wait for a port status register
542 * @ap: Port to wait for.
543 *
544 * Waits up to max*10 microseconds for the selected bits in the port's
545 * status register to be cleared.
546 * Returns final value of status register.
547 *
548 * LOCKING:
549 * Inherited from caller.
550 */
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
553 unsigned int max)
554{
555 u8 status;
556
557 do {
558 udelay(10);
559 status = ata_chk_status(ap);
560 max--;
561 } while ((status & bits) && (max > 0));
562
563 return status;
564}
565
Edward Falk0baab862005-06-02 18:17:13 -0400566
567/**
568 * ata_wait_idle - Wait for a port to be idle.
569 * @ap: Port to wait for.
570 *
571 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
572 * Returns final value of status register.
573 *
574 * LOCKING:
575 * Inherited from caller.
576 */
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578static inline u8 ata_wait_idle(struct ata_port *ap)
579{
580 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
581
582 if (status & (ATA_BUSY | ATA_DRQ)) {
583 unsigned long l = ap->ioaddr.status_addr;
584 printk(KERN_WARNING
585 "ATA: abnormal status 0x%X on port 0x%lX\n",
586 status, l);
587 }
588
589 return status;
590}
591
592static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
593{
594 qc->tf.ctl |= ATA_NIEN;
595}
596
597static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
598 unsigned int tag)
599{
600 if (likely(ata_tag_valid(tag)))
601 return &ap->qcmd[tag];
602 return NULL;
603}
604
605static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
606{
607 memset(tf, 0, sizeof(*tf));
608
609 tf->ctl = ap->ctl;
610 if (device == 0)
611 tf->device = ATA_DEVICE_OBS;
612 else
613 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
614}
615
Edward Falk0baab862005-06-02 18:17:13 -0400616
617/**
618 * ata_irq_on - Enable interrupts on a port.
619 * @ap: Port on which interrupts are enabled.
620 *
621 * Enable interrupts on a legacy IDE device using MMIO or PIO,
622 * wait for idle, clear any pending interrupts.
623 *
624 * LOCKING:
625 * Inherited from caller.
626 */
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628static inline u8 ata_irq_on(struct ata_port *ap)
629{
630 struct ata_ioports *ioaddr = &ap->ioaddr;
631 u8 tmp;
632
633 ap->ctl &= ~ATA_NIEN;
634 ap->last_ctl = ap->ctl;
635
636 if (ap->flags & ATA_FLAG_MMIO)
637 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
638 else
639 outb(ap->ctl, ioaddr->ctl_addr);
640 tmp = ata_wait_idle(ap);
641
642 ap->ops->irq_clear(ap);
643
644 return tmp;
645}
646
Edward Falk0baab862005-06-02 18:17:13 -0400647
648/**
649 * ata_irq_ack - Acknowledge a device interrupt.
650 * @ap: Port on which interrupts are enabled.
651 *
652 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
653 * or BUSY+DRQ clear). Obtain dma status and port status from
654 * device. Clear the interrupt. Return port status.
655 *
656 * LOCKING:
657 */
658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
660{
661 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
662 u8 host_stat, post_stat, status;
663
664 status = ata_busy_wait(ap, bits, 1000);
665 if (status & bits)
666 DPRINTK("abnormal status 0x%X\n", status);
667
668 /* get controller status; clear intr, err bits */
669 if (ap->flags & ATA_FLAG_MMIO) {
670 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
671 host_stat = readb(mmio + ATA_DMA_STATUS);
672 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
673 mmio + ATA_DMA_STATUS);
674
675 post_stat = readb(mmio + ATA_DMA_STATUS);
676 } else {
677 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
678 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
679 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
680
681 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
682 }
683
684 VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
685 host_stat, post_stat, status);
686
687 return status;
688}
689
690static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
691{
692 return ap->ops->scr_read(ap, reg);
693}
694
695static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
696{
697 ap->ops->scr_write(ap, reg, val);
698}
699
Jeff Garzik8a60a072005-07-31 13:13:24 -0400700static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
Brett Russcdcca892005-03-28 15:10:27 -0500701 u32 val)
702{
703 ap->ops->scr_write(ap, reg, val);
704 (void) ap->ops->scr_read(ap, reg);
705}
706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707static inline unsigned int sata_dev_present(struct ata_port *ap)
708{
709 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
710}
711
712static inline int ata_try_flush_cache(struct ata_device *dev)
713{
714 return ata_id_wcache_enabled(dev->id) ||
715 ata_id_has_flush(dev->id) ||
716 ata_id_has_flush_ext(dev->id);
717}
718
719#endif /* __LINUX_LIBATA_H__ */