?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
[PATCH] libata: add ATA_QCFLAG_EH_SCHEDULED
[firewire-audio.git] / include / linux / libata.h
blob5c70a57f93eedd1b81206668448dd56ef71bc016
1 /*
2 * 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 *
24 */
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 <linux/dma-mapping.h>
33 #include <asm/io.h>
34 #include <linux/ata.h>
35 #include <linux/workqueue.h>
36
37 /*
38 * compile-time options: to be removed as soon as all the drivers are
39 * converted to the new debugging mechanism
40 */
41 #undef ATA_DEBUG /* debugging output */
42 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
43 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
44 #undef ATA_NDEBUG /* define to disable quick runtime checks */
45 #undef ATA_ENABLE_PATA /* define to enable PATA support in some
46 * low-level drivers */
47 #undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */
48
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
63 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64
65 #ifdef ATA_NDEBUG
66 #define assert(expr)
67 #else
68 #define assert(expr) \
69 if(unlikely(!(expr))) { \
70 printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \
71 #expr,__FILE__,__FUNCTION__,__LINE__); \
72 }
73 #endif
74
75 /* NEW: debug levels */
76 #define HAVE_LIBATA_MSG 1
77
78 enum {
79 ATA_MSG_DRV = 0x0001,
80 ATA_MSG_INFO = 0x0002,
81 ATA_MSG_PROBE = 0x0004,
82 ATA_MSG_WARN = 0x0008,
83 ATA_MSG_MALLOC = 0x0010,
84 ATA_MSG_CTL = 0x0020,
85 ATA_MSG_INTR = 0x0040,
86 ATA_MSG_ERR = 0x0080,
87 };
88
89 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
90 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
91 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
92 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
95 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
96 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
97
98 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
99 {
100 if (dval < 0 || dval >= (sizeof(u32) * 8))
101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
102 if (!dval)
103 return 0;
104 return (1 << dval) - 1;
105 }
106
107 /* defines only for the constants which don't work well as enums */
108 #define ATA_TAG_POISON 0xfafbfcfdU
109
110 /* move to PCI layer? */
111 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
112 {
113 return &pdev->dev;
114 }
115
116 enum {
117 /* various global constants */
118 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
119 ATA_MAX_PORTS = 8,
120 ATA_DEF_QUEUE = 1,
121 ATA_MAX_QUEUE = 1,
122 ATA_MAX_SECTORS = 200, /* FIXME */
123 ATA_MAX_BUS = 2,
124 ATA_DEF_BUSY_WAIT = 10000,
125 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
126
127 ATA_SHT_EMULATED = 1,
128 ATA_SHT_CMD_PER_LUN = 1,
129 ATA_SHT_THIS_ID = -1,
130 ATA_SHT_USE_CLUSTERING = 1,
131
132 /* struct ata_device stuff */
133 ATA_DFLAG_LBA48 = (1 << 0), /* device supports LBA48 */
134 ATA_DFLAG_PIO = (1 << 1), /* device currently in PIO mode */
135 ATA_DFLAG_LOCK_SECTORS = (1 << 2), /* don't adjust max_sectors */
136 ATA_DFLAG_LBA = (1 << 3), /* device supports LBA */
137
138 ATA_DEV_UNKNOWN = 0, /* unknown device */
139 ATA_DEV_ATA = 1, /* ATA device */
140 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
141 ATA_DEV_ATAPI = 3, /* ATAPI device */
142 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
143 ATA_DEV_NONE = 5, /* no device */
144
145 /* struct ata_port flags */
146 ATA_FLAG_SLAVE_POSS = (1 << 1), /* host supports slave dev */
147 /* (doesn't imply presence) */
148 ATA_FLAG_PORT_DISABLED = (1 << 2), /* port is disabled, ignore it */
149 ATA_FLAG_SATA = (1 << 3),
150 ATA_FLAG_NO_LEGACY = (1 << 4), /* no legacy mode check */
151 ATA_FLAG_SRST = (1 << 5), /* (obsolete) use ATA SRST, not E.D.D. */
152 ATA_FLAG_MMIO = (1 << 6), /* use MMIO, not PIO */
153 ATA_FLAG_SATA_RESET = (1 << 7), /* (obsolete) use COMRESET */
154 ATA_FLAG_PIO_DMA = (1 << 8), /* PIO cmds via DMA */
155 ATA_FLAG_NOINTR = (1 << 9), /* FIXME: Remove this once
156 * proper HSM is in place. */
157 ATA_FLAG_DEBUGMSG = (1 << 10),
158 ATA_FLAG_NO_ATAPI = (1 << 11), /* No ATAPI support */
159
160 ATA_FLAG_SUSPENDED = (1 << 12), /* port is suspended */
161
162 ATA_FLAG_PIO_LBA48 = (1 << 13), /* Host DMA engine is LBA28 only */
163 ATA_FLAG_IRQ_MASK = (1 << 14), /* Mask IRQ in PIO xfers */
164
165 ATA_FLAG_FLUSH_PIO_TASK = (1 << 15), /* Flush PIO task */
166 ATA_FLAG_IN_EH = (1 << 16), /* EH in progress */
167
168 ATA_QCFLAG_ACTIVE = (1 << 1), /* cmd not yet ack'd to scsi lyer */
169 ATA_QCFLAG_SG = (1 << 3), /* have s/g table? */
170 ATA_QCFLAG_SINGLE = (1 << 4), /* no s/g, just a single buffer */
171 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
172 ATA_QCFLAG_EH_SCHEDULED = (1 << 5), /* EH scheduled */
173
174 /* various lengths of time */
175 ATA_TMOUT_EDD = 5 * HZ, /* heuristic */
176 ATA_TMOUT_PIO = 30 * HZ,
177 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
178 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
179 ATA_TMOUT_CDB = 30 * HZ,
180 ATA_TMOUT_CDB_QUICK = 5 * HZ,
181 ATA_TMOUT_INTERNAL = 30 * HZ,
182 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
183
184 /* ATA bus states */
185 BUS_UNKNOWN = 0,
186 BUS_DMA = 1,
187 BUS_IDLE = 2,
188 BUS_NOINTR = 3,
189 BUS_NODATA = 4,
190 BUS_TIMER = 5,
191 BUS_PIO = 6,
192 BUS_EDD = 7,
193 BUS_IDENTIFY = 8,
194 BUS_PACKET = 9,
195
196 /* SATA port states */
197 PORT_UNKNOWN = 0,
198 PORT_ENABLED = 1,
199 PORT_DISABLED = 2,
200
201 /* encoding various smaller bitmaps into a single
202 * unsigned long bitmap
203 */
204 ATA_SHIFT_UDMA = 0,
205 ATA_SHIFT_MWDMA = 8,
206 ATA_SHIFT_PIO = 11,
207
208 /* size of buffer to pad xfers ending on unaligned boundaries */
209 ATA_DMA_PAD_SZ = 4,
210 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
211
212 /* Masks for port functions */
213 ATA_PORT_PRIMARY = (1 << 0),
214 ATA_PORT_SECONDARY = (1 << 1),
215 };
216
217 enum hsm_task_states {
218 HSM_ST_UNKNOWN,
219 HSM_ST_IDLE,
220 HSM_ST_POLL,
221 HSM_ST_TMOUT,
222 HSM_ST,
223 HSM_ST_LAST,
224 HSM_ST_LAST_POLL,
225 HSM_ST_ERR,
226 };
227
228 enum ata_completion_errors {
229 AC_ERR_DEV = (1 << 0), /* device reported error */
230 AC_ERR_HSM = (1 << 1), /* host state machine violation */
231 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
232 AC_ERR_MEDIA = (1 << 3), /* media error */
233 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
234 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
235 AC_ERR_SYSTEM = (1 << 6), /* system error */
236 AC_ERR_INVALID = (1 << 7), /* invalid argument */
237 AC_ERR_OTHER = (1 << 8), /* unknown */
238 };
239
240 /* forward declarations */
241 struct scsi_device;
242 struct ata_port_operations;
243 struct ata_port;
244 struct ata_queued_cmd;
245
246 /* typedefs */
247 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
248 typedef void (*ata_probeinit_fn_t)(struct ata_port *);
249 typedef int (*ata_reset_fn_t)(struct ata_port *, int, unsigned int *);
250 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
251
252 struct ata_ioports {
253 unsigned long cmd_addr;
254 unsigned long data_addr;
255 unsigned long error_addr;
256 unsigned long feature_addr;
257 unsigned long nsect_addr;
258 unsigned long lbal_addr;
259 unsigned long lbam_addr;
260 unsigned long lbah_addr;
261 unsigned long device_addr;
262 unsigned long status_addr;
263 unsigned long command_addr;
264 unsigned long altstatus_addr;
265 unsigned long ctl_addr;
266 unsigned long bmdma_addr;
267 unsigned long scr_addr;
268 };
269
270 struct ata_probe_ent {
271 struct list_head node;
272 struct device *dev;
273 const struct ata_port_operations *port_ops;
274 struct scsi_host_template *sht;
275 struct ata_ioports port[ATA_MAX_PORTS];
276 unsigned int n_ports;
277 unsigned int hard_port_no;
278 unsigned int pio_mask;
279 unsigned int mwdma_mask;
280 unsigned int udma_mask;
281 unsigned int legacy_mode;
282 unsigned long irq;
283 unsigned int irq_flags;
284 unsigned long host_flags;
285 void __iomem *mmio_base;
286 void *private_data;
287 };
288
289 struct ata_host_set {
290 spinlock_t lock;
291 struct device *dev;
292 unsigned long irq;
293 void __iomem *mmio_base;
294 unsigned int n_ports;
295 void *private_data;
296 const struct ata_port_operations *ops;
297 struct ata_port * ports[0];
298 };
299
300 struct ata_queued_cmd {
301 struct ata_port *ap;
302 struct ata_device *dev;
303
304 struct scsi_cmnd *scsicmd;
305 void (*scsidone)(struct scsi_cmnd *);
306
307 struct ata_taskfile tf;
308 u8 cdb[ATAPI_CDB_LEN];
309
310 unsigned long flags; /* ATA_QCFLAG_xxx */
311 unsigned int tag;
312 unsigned int n_elem;
313 unsigned int orig_n_elem;
314
315 int dma_dir;
316
317 unsigned int pad_len;
318
319 unsigned int nsect;
320 unsigned int cursect;
321
322 unsigned int nbytes;
323 unsigned int curbytes;
324
325 unsigned int cursg;
326 unsigned int cursg_ofs;
327
328 struct scatterlist sgent;
329 struct scatterlist pad_sgent;
330 void *buf_virt;
331
332 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
333 struct scatterlist *__sg;
334
335 unsigned int err_mask;
336
337 ata_qc_cb_t complete_fn;
338
339 void *private_data;
340 };
341
342 struct ata_host_stats {
343 unsigned long unhandled_irq;
344 unsigned long idle_irq;
345 unsigned long rw_reqbuf;
346 };
347
348 struct ata_device {
349 u64 n_sectors; /* size of device, if ATA */
350 unsigned long flags; /* ATA_DFLAG_xxx */
351 unsigned int class; /* ATA_DEV_xxx */
352 unsigned int devno; /* 0 or 1 */
353 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
354 u8 pio_mode;
355 u8 dma_mode;
356 u8 xfer_mode;
357 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
358
359 unsigned int multi_count; /* sectors count for
360 READ/WRITE MULTIPLE */
361
362 /* for CHS addressing */
363 u16 cylinders; /* Number of cylinders */
364 u16 heads; /* Number of heads */
365 u16 sectors; /* Number of sectors per track */
366 };
367
368 struct ata_port {
369 struct Scsi_Host *host; /* our co-allocated scsi host */
370 const struct ata_port_operations *ops;
371 unsigned long flags; /* ATA_FLAG_xxx */
372 unsigned int id; /* unique id req'd by scsi midlyr */
373 unsigned int port_no; /* unique port #; from zero */
374 unsigned int hard_port_no; /* hardware port #; from zero */
375
376 struct ata_prd *prd; /* our SG list */
377 dma_addr_t prd_dma; /* and its DMA mapping */
378
379 void *pad; /* array of DMA pad buffers */
380 dma_addr_t pad_dma;
381
382 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
383
384 u8 ctl; /* cache of ATA control register */
385 u8 last_ctl; /* Cache last written value */
386 unsigned int pio_mask;
387 unsigned int mwdma_mask;
388 unsigned int udma_mask;
389 unsigned int cbl; /* cable type; ATA_CBL_xxx */
390 unsigned int cdb_len;
391
392 struct ata_device device[ATA_MAX_DEVICES];
393
394 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
395 unsigned long qactive;
396 unsigned int active_tag;
397
398 struct ata_host_stats stats;
399 struct ata_host_set *host_set;
400
401 struct work_struct packet_task;
402
403 struct work_struct pio_task;
404 unsigned int hsm_task_state;
405 unsigned long pio_task_timeout;
406
407 u32 msg_enable;
408 struct list_head eh_done_q;
409
410 void *private_data;
411 };
412
413 struct ata_port_operations {
414 void (*port_disable) (struct ata_port *);
415
416 void (*dev_config) (struct ata_port *, struct ata_device *);
417
418 void (*set_piomode) (struct ata_port *, struct ata_device *);
419 void (*set_dmamode) (struct ata_port *, struct ata_device *);
420
421 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
422 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
423
424 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
425 u8 (*check_status)(struct ata_port *ap);
426 u8 (*check_altstatus)(struct ata_port *ap);
427 void (*dev_select)(struct ata_port *ap, unsigned int device);
428
429 void (*phy_reset) (struct ata_port *ap); /* obsolete */
430 int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
431
432 void (*post_set_mode) (struct ata_port *ap);
433
434 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
435
436 void (*bmdma_setup) (struct ata_queued_cmd *qc);
437 void (*bmdma_start) (struct ata_queued_cmd *qc);
438
439 void (*qc_prep) (struct ata_queued_cmd *qc);
440 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
441
442 void (*eng_timeout) (struct ata_port *ap);
443
444 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
445 void (*irq_clear) (struct ata_port *);
446
447 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
448 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
449 u32 val);
450
451 int (*port_start) (struct ata_port *ap);
452 void (*port_stop) (struct ata_port *ap);
453
454 void (*host_stop) (struct ata_host_set *host_set);
455
456 void (*bmdma_stop) (struct ata_queued_cmd *qc);
457 u8 (*bmdma_status) (struct ata_port *ap);
458 };
459
460 struct ata_port_info {
461 struct scsi_host_template *sht;
462 unsigned long host_flags;
463 unsigned long pio_mask;
464 unsigned long mwdma_mask;
465 unsigned long udma_mask;
466 const struct ata_port_operations *port_ops;
467 void *private_data;
468 };
469
470 struct ata_timing {
471 unsigned short mode; /* ATA mode */
472 unsigned short setup; /* t1 */
473 unsigned short act8b; /* t2 for 8-bit I/O */
474 unsigned short rec8b; /* t2i for 8-bit I/O */
475 unsigned short cyc8b; /* t0 for 8-bit I/O */
476 unsigned short active; /* t2 or tD */
477 unsigned short recover; /* t2i or tK */
478 unsigned short cycle; /* t0 */
479 unsigned short udma; /* t2CYCTYP/2 */
480 };
481
482 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
483
484 extern void ata_port_probe(struct ata_port *);
485 extern void __sata_phy_reset(struct ata_port *ap);
486 extern void sata_phy_reset(struct ata_port *ap);
487 extern void ata_bus_reset(struct ata_port *ap);
488 extern int ata_drive_probe_reset(struct ata_port *ap,
489 ata_probeinit_fn_t probeinit,
490 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
491 ata_postreset_fn_t postreset, unsigned int *classes);
492 extern void ata_std_probeinit(struct ata_port *ap);
493 extern int ata_std_softreset(struct ata_port *ap, int verbose,
494 unsigned int *classes);
495 extern int sata_std_hardreset(struct ata_port *ap, int verbose,
496 unsigned int *class);
497 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
498 extern void ata_port_disable(struct ata_port *);
499 extern void ata_std_ports(struct ata_ioports *ioaddr);
500 #ifdef CONFIG_PCI
501 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
502 unsigned int n_ports);
503 extern void ata_pci_remove_one (struct pci_dev *pdev);
504 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
505 extern int ata_pci_device_resume(struct pci_dev *pdev);
506 #endif /* CONFIG_PCI */
507 extern int ata_device_add(const struct ata_probe_ent *ent);
508 extern void ata_host_set_remove(struct ata_host_set *host_set);
509 extern int ata_scsi_detect(struct scsi_host_template *sht);
510 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
511 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
512 extern int ata_scsi_error(struct Scsi_Host *host);
513 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
514 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
515 extern int ata_scsi_release(struct Scsi_Host *host);
516 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
517 extern int ata_scsi_device_resume(struct scsi_device *);
518 extern int ata_scsi_device_suspend(struct scsi_device *);
519 extern int ata_device_resume(struct ata_port *, struct ata_device *);
520 extern int ata_device_suspend(struct ata_port *, struct ata_device *);
521 extern int ata_ratelimit(void);
522 extern unsigned int ata_busy_sleep(struct ata_port *ap,
523 unsigned long timeout_pat,
524 unsigned long timeout);
525
526 /*
527 * Default driver ops implementations
528 */
529 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
530 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
531 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
532 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
533 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
534 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
535 extern u8 ata_check_status(struct ata_port *ap);
536 extern u8 ata_altstatus(struct ata_port *ap);
537 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
538 extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
539 extern int ata_port_start (struct ata_port *ap);
540 extern void ata_port_stop (struct ata_port *ap);
541 extern void ata_host_stop (struct ata_host_set *host_set);
542 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
543 extern void ata_qc_prep(struct ata_queued_cmd *qc);
544 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
545 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
546 unsigned int buflen);
547 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
548 unsigned int n_elem);
549 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
550 extern void ata_dev_id_string(const u16 *id, unsigned char *s,
551 unsigned int ofs, unsigned int len);
552 extern void ata_dev_config(struct ata_port *ap, unsigned int i);
553 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
554 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
555 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
556 extern u8 ata_bmdma_status(struct ata_port *ap);
557 extern void ata_bmdma_irq_clear(struct ata_port *ap);
558 extern void ata_qc_complete(struct ata_queued_cmd *qc);
559 extern void ata_eng_timeout(struct ata_port *ap);
560 extern void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
561 struct scsi_cmnd *cmd,
562 void (*done)(struct scsi_cmnd *));
563 extern int ata_std_bios_param(struct scsi_device *sdev,
564 struct block_device *bdev,
565 sector_t capacity, int geom[]);
566 extern int ata_scsi_slave_config(struct scsi_device *sdev);
567
568 /*
569 * Timing helpers
570 */
571
572 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
573 extern int ata_timing_compute(struct ata_device *, unsigned short,
574 struct ata_timing *, int, int);
575 extern void ata_timing_merge(const struct ata_timing *,
576 const struct ata_timing *, struct ata_timing *,
577 unsigned int);
578
579 enum {
580 ATA_TIMING_SETUP = (1 << 0),
581 ATA_TIMING_ACT8B = (1 << 1),
582 ATA_TIMING_REC8B = (1 << 2),
583 ATA_TIMING_CYC8B = (1 << 3),
584 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
585 ATA_TIMING_CYC8B,
586 ATA_TIMING_ACTIVE = (1 << 4),
587 ATA_TIMING_RECOVER = (1 << 5),
588 ATA_TIMING_CYCLE = (1 << 6),
589 ATA_TIMING_UDMA = (1 << 7),
590 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
591 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
592 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
593 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
594 };
595
596
597 #ifdef CONFIG_PCI
598 struct pci_bits {
599 unsigned int reg; /* PCI config register to read */
600 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
601 unsigned long mask;
602 unsigned long val;
603 };
604
605 extern void ata_pci_host_stop (struct ata_host_set *host_set);
606 extern struct ata_probe_ent *
607 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
608 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
609
610 #endif /* CONFIG_PCI */
611
612
613 static inline int
614 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
615 {
616 if (sg == &qc->pad_sgent)
617 return 1;
618 if (qc->pad_len)
619 return 0;
620 if (((sg - qc->__sg) + 1) == qc->n_elem)
621 return 1;
622 return 0;
623 }
624
625 static inline struct scatterlist *
626 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
627 {
628 if (sg == &qc->pad_sgent)
629 return NULL;
630 if (++sg - qc->__sg < qc->n_elem)
631 return sg;
632 return qc->pad_len ? &qc->pad_sgent : NULL;
633 }
634
635 #define ata_for_each_sg(sg, qc) \
636 for (sg = qc->__sg; sg; sg = ata_qc_next_sg(sg, qc))
637
638 static inline unsigned int ata_tag_valid(unsigned int tag)
639 {
640 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
641 }
642
643 static inline unsigned int ata_dev_present(const struct ata_device *dev)
644 {
645 return ((dev->class == ATA_DEV_ATA) ||
646 (dev->class == ATA_DEV_ATAPI));
647 }
648
649 static inline u8 ata_chk_status(struct ata_port *ap)
650 {
651 return ap->ops->check_status(ap);
652 }
653
654
655 /**
656 * ata_pause - Flush writes and pause 400 nanoseconds.
657 * @ap: Port to wait for.
658 *
659 * LOCKING:
660 * Inherited from caller.
661 */
662
663 static inline void ata_pause(struct ata_port *ap)
664 {
665 ata_altstatus(ap);
666 ndelay(400);
667 }
668
669
670 /**
671 * ata_busy_wait - Wait for a port status register
672 * @ap: Port to wait for.
673 *
674 * Waits up to max*10 microseconds for the selected bits in the port's
675 * status register to be cleared.
676 * Returns final value of status register.
677 *
678 * LOCKING:
679 * Inherited from caller.
680 */
681
682 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
683 unsigned int max)
684 {
685 u8 status;
686
687 do {
688 udelay(10);
689 status = ata_chk_status(ap);
690 max--;
691 } while ((status & bits) && (max > 0));
692
693 return status;
694 }
695
696
697 /**
698 * ata_wait_idle - Wait for a port to be idle.
699 * @ap: Port to wait for.
700 *
701 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
702 * Returns final value of status register.
703 *
704 * LOCKING:
705 * Inherited from caller.
706 */
707
708 static inline u8 ata_wait_idle(struct ata_port *ap)
709 {
710 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
711
712 if (status & (ATA_BUSY | ATA_DRQ)) {
713 unsigned long l = ap->ioaddr.status_addr;
714 if (ata_msg_warn(ap))
715 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
716 status, l);
717 }
718
719 return status;
720 }
721
722 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
723 {
724 qc->tf.ctl |= ATA_NIEN;
725 }
726
727 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
728 unsigned int tag)
729 {
730 if (likely(ata_tag_valid(tag)))
731 return &ap->qcmd[tag];
732 return NULL;
733 }
734
735 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
736 {
737 memset(tf, 0, sizeof(*tf));
738
739 tf->ctl = ap->ctl;
740 if (device == 0)
741 tf->device = ATA_DEVICE_OBS;
742 else
743 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
744 }
745
746 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
747 {
748 qc->__sg = NULL;
749 qc->flags = 0;
750 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
751 qc->nsect = 0;
752 qc->nbytes = qc->curbytes = 0;
753 qc->err_mask = 0;
754
755 ata_tf_init(qc->ap, &qc->tf, qc->dev->devno);
756 }
757
758
759 /**
760 * ata_irq_on - Enable interrupts on a port.
761 * @ap: Port on which interrupts are enabled.
762 *
763 * Enable interrupts on a legacy IDE device using MMIO or PIO,
764 * wait for idle, clear any pending interrupts.
765 *
766 * LOCKING:
767 * Inherited from caller.
768 */
769
770 static inline u8 ata_irq_on(struct ata_port *ap)
771 {
772 struct ata_ioports *ioaddr = &ap->ioaddr;
773 u8 tmp;
774
775 ap->ctl &= ~ATA_NIEN;
776 ap->last_ctl = ap->ctl;
777
778 if (ap->flags & ATA_FLAG_MMIO)
779 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
780 else
781 outb(ap->ctl, ioaddr->ctl_addr);
782 tmp = ata_wait_idle(ap);
783
784 ap->ops->irq_clear(ap);
785
786 return tmp;
787 }
788
789
790 /**
791 * ata_irq_ack - Acknowledge a device interrupt.
792 * @ap: Port on which interrupts are enabled.
793 *
794 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
795 * or BUSY+DRQ clear). Obtain dma status and port status from
796 * device. Clear the interrupt. Return port status.
797 *
798 * LOCKING:
799 */
800
801 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
802 {
803 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
804 u8 host_stat, post_stat, status;
805
806 status = ata_busy_wait(ap, bits, 1000);
807 if (status & bits)
808 if (ata_msg_err(ap))
809 printk(KERN_ERR "abnormal status 0x%X\n", status);
810
811 /* get controller status; clear intr, err bits */
812 if (ap->flags & ATA_FLAG_MMIO) {
813 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
814 host_stat = readb(mmio + ATA_DMA_STATUS);
815 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
816 mmio + ATA_DMA_STATUS);
817
818 post_stat = readb(mmio + ATA_DMA_STATUS);
819 } else {
820 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
821 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
822 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
823
824 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
825 }
826
827 if (ata_msg_intr(ap))
828 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
829 __FUNCTION__,
830 host_stat, post_stat, status);
831
832 return status;
833 }
834
835 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
836 {
837 return ap->ops->scr_read(ap, reg);
838 }
839
840 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
841 {
842 ap->ops->scr_write(ap, reg, val);
843 }
844
845 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
846 u32 val)
847 {
848 ap->ops->scr_write(ap, reg, val);
849 (void) ap->ops->scr_read(ap, reg);
850 }
851
852 static inline unsigned int sata_dev_present(struct ata_port *ap)
853 {
854 return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
855 }
856
857 static inline int ata_try_flush_cache(const struct ata_device *dev)
858 {
859 return ata_id_wcache_enabled(dev->id) ||
860 ata_id_has_flush(dev->id) ||
861 ata_id_has_flush_ext(dev->id);
862 }
863
864 static inline unsigned int ac_err_mask(u8 status)
865 {
866 if (status & ATA_BUSY)
867 return AC_ERR_HSM;
868 if (status & (ATA_ERR | ATA_DF))
869 return AC_ERR_DEV;
870 return 0;
871 }
872
873 static inline unsigned int __ac_err_mask(u8 status)
874 {
875 unsigned int mask = ac_err_mask(status);
876 if (mask == 0)
877 return AC_ERR_OTHER;
878 return mask;
879 }
880
881 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
882 {
883 ap->pad_dma = 0;
884 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
885 &ap->pad_dma, GFP_KERNEL);
886 return (ap->pad == NULL) ? -ENOMEM : 0;
887 }
888
889 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
890 {
891 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
892 }
893
894 #endif /* __LINUX_LIBATA_H__ */
AMDTP streaming driver for the Linux FireWire stack (Juju)