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