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