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