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