[PATCH] libata: add ap->pflags and move core dynamic flags to it
[linux-2.6/cjktty.git] / include / linux / libata.h
blobb5d247d780f8117f9aeaa26c6570a598cf6c284c
1 /*
2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
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.
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.
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.
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/DocBook/libata.*
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <linux/dma-mapping.h>
33 #include <asm/scatterlist.h>
34 #include <asm/io.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
40 * compile-time options: to be removed as soon as all the drivers are
41 * converted to the new debugging mechanism
43 #undef ATA_DEBUG /* debugging output */
44 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
45 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
46 #undef ATA_NDEBUG /* define to disable quick runtime checks */
47 #undef ATA_ENABLE_PATA /* define to enable PATA support in some
48 * low-level drivers */
51 /* note: prints function name for you */
52 #ifdef ATA_DEBUG
53 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
54 #ifdef ATA_VERBOSE_DEBUG
55 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
56 #else
57 #define VPRINTK(fmt, args...)
58 #endif /* ATA_VERBOSE_DEBUG */
59 #else
60 #define DPRINTK(fmt, args...)
61 #define VPRINTK(fmt, args...)
62 #endif /* ATA_DEBUG */
64 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66 /* NEW: debug levels */
67 #define HAVE_LIBATA_MSG 1
69 enum {
70 ATA_MSG_DRV = 0x0001,
71 ATA_MSG_INFO = 0x0002,
72 ATA_MSG_PROBE = 0x0004,
73 ATA_MSG_WARN = 0x0008,
74 ATA_MSG_MALLOC = 0x0010,
75 ATA_MSG_CTL = 0x0020,
76 ATA_MSG_INTR = 0x0040,
77 ATA_MSG_ERR = 0x0080,
80 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
81 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
82 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
83 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
84 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
85 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
86 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
87 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
89 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
91 if (dval < 0 || dval >= (sizeof(u32) * 8))
92 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
93 if (!dval)
94 return 0;
95 return (1 << dval) - 1;
98 /* defines only for the constants which don't work well as enums */
99 #define ATA_TAG_POISON 0xfafbfcfdU
101 /* move to PCI layer? */
102 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
104 return &pdev->dev;
107 enum {
108 /* various global constants */
109 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
110 ATA_MAX_PORTS = 8,
111 ATA_DEF_QUEUE = 1,
112 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
113 ATA_MAX_QUEUE = 32,
114 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
115 ATA_MAX_SECTORS = 200, /* FIXME */
116 ATA_MAX_SECTORS_LBA48 = 65535,
117 ATA_MAX_BUS = 2,
118 ATA_DEF_BUSY_WAIT = 10000,
119 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
121 ATA_SHT_EMULATED = 1,
122 ATA_SHT_CMD_PER_LUN = 1,
123 ATA_SHT_THIS_ID = -1,
124 ATA_SHT_USE_CLUSTERING = 1,
126 /* struct ata_device stuff */
127 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
128 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
129 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
130 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
131 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
133 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
134 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
136 ATA_DFLAG_DETACH = (1 << 16),
137 ATA_DFLAG_DETACHED = (1 << 17),
139 ATA_DEV_UNKNOWN = 0, /* unknown device */
140 ATA_DEV_ATA = 1, /* ATA device */
141 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
142 ATA_DEV_ATAPI = 3, /* ATAPI device */
143 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
144 ATA_DEV_NONE = 5, /* no device */
146 /* struct ata_port flags */
147 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
148 /* (doesn't imply presence) */
149 ATA_FLAG_SATA = (1 << 1),
150 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
151 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
152 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
153 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
154 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
155 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
156 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
157 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
158 * doesn't handle PIO interrupts */
159 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
160 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
161 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
162 * Register FIS clearing BSY */
163 ATA_FLAG_DEBUGMSG = (1 << 13),
165 /* The following flag belongs to ap->pflags but is kept in
166 * ap->flags because it's referenced in many LLDs and will be
167 * removed in not-too-distant future.
169 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
171 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
173 /* struct ata_port pflags */
174 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
175 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
176 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
177 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
178 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
179 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
180 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
182 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
183 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
185 /* struct ata_queued_cmd flags */
186 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
187 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
188 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
189 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
190 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
191 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
193 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
194 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
195 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
197 /* host set flags */
198 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
200 /* various lengths of time */
201 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
202 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
203 ATA_TMOUT_INTERNAL = 30 * HZ,
204 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
206 /* ATA bus states */
207 BUS_UNKNOWN = 0,
208 BUS_DMA = 1,
209 BUS_IDLE = 2,
210 BUS_NOINTR = 3,
211 BUS_NODATA = 4,
212 BUS_TIMER = 5,
213 BUS_PIO = 6,
214 BUS_EDD = 7,
215 BUS_IDENTIFY = 8,
216 BUS_PACKET = 9,
218 /* SATA port states */
219 PORT_UNKNOWN = 0,
220 PORT_ENABLED = 1,
221 PORT_DISABLED = 2,
223 /* encoding various smaller bitmaps into a single
224 * unsigned int bitmap
226 ATA_BITS_PIO = 5,
227 ATA_BITS_MWDMA = 3,
228 ATA_BITS_UDMA = 8,
230 ATA_SHIFT_PIO = 0,
231 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
232 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
234 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
235 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
236 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
238 /* size of buffer to pad xfers ending on unaligned boundaries */
239 ATA_DMA_PAD_SZ = 4,
240 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
242 /* masks for port functions */
243 ATA_PORT_PRIMARY = (1 << 0),
244 ATA_PORT_SECONDARY = (1 << 1),
246 /* ering size */
247 ATA_ERING_SIZE = 32,
249 /* desc_len for ata_eh_info and context */
250 ATA_EH_DESC_LEN = 80,
252 /* reset / recovery action types */
253 ATA_EH_REVALIDATE = (1 << 0),
254 ATA_EH_SOFTRESET = (1 << 1),
255 ATA_EH_HARDRESET = (1 << 2),
257 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
258 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
260 /* ata_eh_info->flags */
261 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
263 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
265 /* max repeat if error condition is still set after ->error_handler */
266 ATA_EH_MAX_REPEAT = 5,
268 /* how hard are we gonna try to probe/recover devices */
269 ATA_PROBE_MAX_TRIES = 3,
270 ATA_EH_RESET_TRIES = 3,
271 ATA_EH_DEV_TRIES = 3,
273 /* Drive spinup time (time from power-on to the first D2H FIS)
274 * in msecs - 8s currently. Failing to get ready in this time
275 * isn't critical. It will result in reset failure for
276 * controllers which can't wait for the first D2H FIS. libata
277 * will retry, so it just has to be long enough to spin up
278 * most devices.
280 ATA_SPINUP_WAIT = 8000,
283 enum hsm_task_states {
284 HSM_ST_UNKNOWN, /* state unknown */
285 HSM_ST_IDLE, /* no command on going */
286 HSM_ST, /* (waiting the device to) transfer data */
287 HSM_ST_LAST, /* (waiting the device to) complete command */
288 HSM_ST_ERR, /* error */
289 HSM_ST_FIRST, /* (waiting the device to)
290 write CDB or first data block */
293 enum ata_completion_errors {
294 AC_ERR_DEV = (1 << 0), /* device reported error */
295 AC_ERR_HSM = (1 << 1), /* host state machine violation */
296 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
297 AC_ERR_MEDIA = (1 << 3), /* media error */
298 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
299 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
300 AC_ERR_SYSTEM = (1 << 6), /* system error */
301 AC_ERR_INVALID = (1 << 7), /* invalid argument */
302 AC_ERR_OTHER = (1 << 8), /* unknown */
305 /* forward declarations */
306 struct scsi_device;
307 struct ata_port_operations;
308 struct ata_port;
309 struct ata_queued_cmd;
311 /* typedefs */
312 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
313 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
314 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
315 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
317 struct ata_ioports {
318 unsigned long cmd_addr;
319 unsigned long data_addr;
320 unsigned long error_addr;
321 unsigned long feature_addr;
322 unsigned long nsect_addr;
323 unsigned long lbal_addr;
324 unsigned long lbam_addr;
325 unsigned long lbah_addr;
326 unsigned long device_addr;
327 unsigned long status_addr;
328 unsigned long command_addr;
329 unsigned long altstatus_addr;
330 unsigned long ctl_addr;
331 unsigned long bmdma_addr;
332 unsigned long scr_addr;
335 struct ata_probe_ent {
336 struct list_head node;
337 struct device *dev;
338 const struct ata_port_operations *port_ops;
339 struct scsi_host_template *sht;
340 struct ata_ioports port[ATA_MAX_PORTS];
341 unsigned int n_ports;
342 unsigned int hard_port_no;
343 unsigned int pio_mask;
344 unsigned int mwdma_mask;
345 unsigned int udma_mask;
346 unsigned int legacy_mode;
347 unsigned long irq;
348 unsigned int irq_flags;
349 unsigned long host_flags;
350 unsigned long host_set_flags;
351 void __iomem *mmio_base;
352 void *private_data;
355 struct ata_host_set {
356 spinlock_t lock;
357 struct device *dev;
358 unsigned long irq;
359 void __iomem *mmio_base;
360 unsigned int n_ports;
361 void *private_data;
362 const struct ata_port_operations *ops;
363 unsigned long flags;
364 int simplex_claimed; /* Keep seperate in case we
365 ever need to do this locked */
366 struct ata_host_set *next; /* for legacy mode */
367 struct ata_port *ports[0];
370 struct ata_queued_cmd {
371 struct ata_port *ap;
372 struct ata_device *dev;
374 struct scsi_cmnd *scsicmd;
375 void (*scsidone)(struct scsi_cmnd *);
377 struct ata_taskfile tf;
378 u8 cdb[ATAPI_CDB_LEN];
380 unsigned long flags; /* ATA_QCFLAG_xxx */
381 unsigned int tag;
382 unsigned int n_elem;
383 unsigned int orig_n_elem;
385 int dma_dir;
387 unsigned int pad_len;
389 unsigned int nsect;
390 unsigned int cursect;
392 unsigned int nbytes;
393 unsigned int curbytes;
395 unsigned int cursg;
396 unsigned int cursg_ofs;
398 struct scatterlist sgent;
399 struct scatterlist pad_sgent;
400 void *buf_virt;
402 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
403 struct scatterlist *__sg;
405 unsigned int err_mask;
406 struct ata_taskfile result_tf;
407 ata_qc_cb_t complete_fn;
409 void *private_data;
412 struct ata_host_stats {
413 unsigned long unhandled_irq;
414 unsigned long idle_irq;
415 unsigned long rw_reqbuf;
418 struct ata_ering_entry {
419 int is_io;
420 unsigned int err_mask;
421 u64 timestamp;
424 struct ata_ering {
425 int cursor;
426 struct ata_ering_entry ring[ATA_ERING_SIZE];
429 struct ata_device {
430 struct ata_port *ap;
431 unsigned int devno; /* 0 or 1 */
432 unsigned long flags; /* ATA_DFLAG_xxx */
433 struct scsi_device *sdev; /* attached SCSI device */
434 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
435 u64 n_sectors; /* size of device, if ATA */
436 unsigned int class; /* ATA_DEV_xxx */
437 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
438 u8 pio_mode;
439 u8 dma_mode;
440 u8 xfer_mode;
441 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
443 unsigned int multi_count; /* sectors count for
444 READ/WRITE MULTIPLE */
445 unsigned int max_sectors; /* per-device max sectors */
446 unsigned int cdb_len;
448 /* per-dev xfer mask */
449 unsigned int pio_mask;
450 unsigned int mwdma_mask;
451 unsigned int udma_mask;
453 /* for CHS addressing */
454 u16 cylinders; /* Number of cylinders */
455 u16 heads; /* Number of heads */
456 u16 sectors; /* Number of sectors per track */
458 /* error history */
459 struct ata_ering ering;
462 /* Offset into struct ata_device. Fields above it are maintained
463 * acress device init. Fields below are zeroed.
465 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
467 struct ata_eh_info {
468 struct ata_device *dev; /* offending device */
469 u32 serror; /* SError from LLDD */
470 unsigned int err_mask; /* port-wide err_mask */
471 unsigned int action; /* ATA_EH_* action mask */
472 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
473 unsigned int flags; /* ATA_EHI_* flags */
475 unsigned long hotplug_timestamp;
476 unsigned int probe_mask;
478 char desc[ATA_EH_DESC_LEN];
479 int desc_len;
482 struct ata_eh_context {
483 struct ata_eh_info i;
484 int tries[ATA_MAX_DEVICES];
485 unsigned int classes[ATA_MAX_DEVICES];
486 unsigned int did_probe_mask;
489 struct ata_port {
490 struct Scsi_Host *host; /* our co-allocated scsi host */
491 const struct ata_port_operations *ops;
492 spinlock_t *lock;
493 unsigned long flags; /* ATA_FLAG_xxx */
494 unsigned int pflags; /* ATA_PFLAG_xxx */
495 unsigned int id; /* unique id req'd by scsi midlyr */
496 unsigned int port_no; /* unique port #; from zero */
497 unsigned int hard_port_no; /* hardware port #; from zero */
499 struct ata_prd *prd; /* our SG list */
500 dma_addr_t prd_dma; /* and its DMA mapping */
502 void *pad; /* array of DMA pad buffers */
503 dma_addr_t pad_dma;
505 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
507 u8 ctl; /* cache of ATA control register */
508 u8 last_ctl; /* Cache last written value */
509 unsigned int pio_mask;
510 unsigned int mwdma_mask;
511 unsigned int udma_mask;
512 unsigned int cbl; /* cable type; ATA_CBL_xxx */
513 unsigned int hw_sata_spd_limit;
514 unsigned int sata_spd_limit; /* SATA PHY speed limit */
516 /* record runtime error info, protected by host_set lock */
517 struct ata_eh_info eh_info;
518 /* EH context owned by EH */
519 struct ata_eh_context eh_context;
521 struct ata_device device[ATA_MAX_DEVICES];
523 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
524 unsigned long qc_allocated;
525 unsigned int qc_active;
527 unsigned int active_tag;
528 u32 sactive;
530 struct ata_host_stats stats;
531 struct ata_host_set *host_set;
532 struct device *dev;
534 struct work_struct port_task;
535 struct work_struct hotplug_task;
536 struct work_struct scsi_rescan_task;
538 unsigned int hsm_task_state;
540 u32 msg_enable;
541 struct list_head eh_done_q;
542 wait_queue_head_t eh_wait_q;
544 void *private_data;
546 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
549 struct ata_port_operations {
550 void (*port_disable) (struct ata_port *);
552 void (*dev_config) (struct ata_port *, struct ata_device *);
554 void (*set_piomode) (struct ata_port *, struct ata_device *);
555 void (*set_dmamode) (struct ata_port *, struct ata_device *);
556 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
558 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
559 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
561 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
562 u8 (*check_status)(struct ata_port *ap);
563 u8 (*check_altstatus)(struct ata_port *ap);
564 void (*dev_select)(struct ata_port *ap, unsigned int device);
566 void (*phy_reset) (struct ata_port *ap); /* obsolete */
567 void (*set_mode) (struct ata_port *ap);
569 void (*post_set_mode) (struct ata_port *ap);
571 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
573 void (*bmdma_setup) (struct ata_queued_cmd *qc);
574 void (*bmdma_start) (struct ata_queued_cmd *qc);
576 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
578 void (*qc_prep) (struct ata_queued_cmd *qc);
579 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
581 /* Error handlers. ->error_handler overrides ->eng_timeout and
582 * indicates that new-style EH is in place.
584 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
586 void (*freeze) (struct ata_port *ap);
587 void (*thaw) (struct ata_port *ap);
588 void (*error_handler) (struct ata_port *ap);
589 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
591 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
592 void (*irq_clear) (struct ata_port *);
594 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
595 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
596 u32 val);
598 int (*port_start) (struct ata_port *ap);
599 void (*port_stop) (struct ata_port *ap);
601 void (*host_stop) (struct ata_host_set *host_set);
603 void (*bmdma_stop) (struct ata_queued_cmd *qc);
604 u8 (*bmdma_status) (struct ata_port *ap);
607 struct ata_port_info {
608 struct scsi_host_template *sht;
609 unsigned long host_flags;
610 unsigned long pio_mask;
611 unsigned long mwdma_mask;
612 unsigned long udma_mask;
613 const struct ata_port_operations *port_ops;
614 void *private_data;
617 struct ata_timing {
618 unsigned short mode; /* ATA mode */
619 unsigned short setup; /* t1 */
620 unsigned short act8b; /* t2 for 8-bit I/O */
621 unsigned short rec8b; /* t2i for 8-bit I/O */
622 unsigned short cyc8b; /* t0 for 8-bit I/O */
623 unsigned short active; /* t2 or tD */
624 unsigned short recover; /* t2i or tK */
625 unsigned short cycle; /* t0 */
626 unsigned short udma; /* t2CYCTYP/2 */
629 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
631 extern const unsigned long sata_deb_timing_boot[];
632 extern const unsigned long sata_deb_timing_eh[];
633 extern const unsigned long sata_deb_timing_before_fsrst[];
635 extern void ata_port_probe(struct ata_port *);
636 extern void __sata_phy_reset(struct ata_port *ap);
637 extern void sata_phy_reset(struct ata_port *ap);
638 extern void ata_bus_reset(struct ata_port *ap);
639 extern int sata_set_spd(struct ata_port *ap);
640 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
641 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
642 extern int ata_std_prereset(struct ata_port *ap);
643 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
644 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
645 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
646 extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
647 extern void ata_port_disable(struct ata_port *);
648 extern void ata_std_ports(struct ata_ioports *ioaddr);
649 #ifdef CONFIG_PCI
650 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
651 unsigned int n_ports);
652 extern void ata_pci_remove_one (struct pci_dev *pdev);
653 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
654 extern int ata_pci_device_resume(struct pci_dev *pdev);
655 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
656 #endif /* CONFIG_PCI */
657 extern int ata_device_add(const struct ata_probe_ent *ent);
658 extern void ata_port_detach(struct ata_port *ap);
659 extern void ata_host_set_remove(struct ata_host_set *host_set);
660 extern int ata_scsi_detect(struct scsi_host_template *sht);
661 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
662 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
663 extern int ata_scsi_release(struct Scsi_Host *host);
664 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
665 extern int sata_scr_valid(struct ata_port *ap);
666 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
667 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
668 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
669 extern int ata_port_online(struct ata_port *ap);
670 extern int ata_port_offline(struct ata_port *ap);
671 extern int ata_scsi_device_resume(struct scsi_device *);
672 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
673 extern int ata_device_resume(struct ata_device *);
674 extern int ata_device_suspend(struct ata_device *, pm_message_t state);
675 extern int ata_ratelimit(void);
676 extern unsigned int ata_busy_sleep(struct ata_port *ap,
677 unsigned long timeout_pat,
678 unsigned long timeout);
679 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
680 void *data, unsigned long delay);
681 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
682 unsigned long interval_msec,
683 unsigned long timeout_msec);
686 * Default driver ops implementations
688 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
689 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
690 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
691 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
692 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
693 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
694 extern u8 ata_check_status(struct ata_port *ap);
695 extern u8 ata_altstatus(struct ata_port *ap);
696 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
697 extern int ata_port_start (struct ata_port *ap);
698 extern void ata_port_stop (struct ata_port *ap);
699 extern void ata_host_stop (struct ata_host_set *host_set);
700 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
701 extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
702 unsigned int buflen, int write_data);
703 extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
704 unsigned int buflen, int write_data);
705 extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
706 unsigned int buflen, int write_data);
707 extern void ata_qc_prep(struct ata_queued_cmd *qc);
708 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
709 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
710 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
711 unsigned int buflen);
712 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
713 unsigned int n_elem);
714 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
715 extern void ata_id_string(const u16 *id, unsigned char *s,
716 unsigned int ofs, unsigned int len);
717 extern void ata_id_c_string(const u16 *id, unsigned char *s,
718 unsigned int ofs, unsigned int len);
719 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
720 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
721 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
722 extern u8 ata_bmdma_status(struct ata_port *ap);
723 extern void ata_bmdma_irq_clear(struct ata_port *ap);
724 extern void ata_bmdma_freeze(struct ata_port *ap);
725 extern void ata_bmdma_thaw(struct ata_port *ap);
726 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
727 ata_reset_fn_t softreset,
728 ata_reset_fn_t hardreset,
729 ata_postreset_fn_t postreset);
730 extern void ata_bmdma_error_handler(struct ata_port *ap);
731 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
732 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
733 u8 status, int in_wq);
734 extern void ata_qc_complete(struct ata_queued_cmd *qc);
735 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
736 void (*finish_qc)(struct ata_queued_cmd *));
737 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
738 void (*done)(struct scsi_cmnd *));
739 extern int ata_std_bios_param(struct scsi_device *sdev,
740 struct block_device *bdev,
741 sector_t capacity, int geom[]);
742 extern int ata_scsi_slave_config(struct scsi_device *sdev);
743 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
744 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
745 int queue_depth);
746 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
749 * Timing helpers
752 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
753 extern int ata_timing_compute(struct ata_device *, unsigned short,
754 struct ata_timing *, int, int);
755 extern void ata_timing_merge(const struct ata_timing *,
756 const struct ata_timing *, struct ata_timing *,
757 unsigned int);
759 enum {
760 ATA_TIMING_SETUP = (1 << 0),
761 ATA_TIMING_ACT8B = (1 << 1),
762 ATA_TIMING_REC8B = (1 << 2),
763 ATA_TIMING_CYC8B = (1 << 3),
764 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
765 ATA_TIMING_CYC8B,
766 ATA_TIMING_ACTIVE = (1 << 4),
767 ATA_TIMING_RECOVER = (1 << 5),
768 ATA_TIMING_CYCLE = (1 << 6),
769 ATA_TIMING_UDMA = (1 << 7),
770 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
771 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
772 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
773 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
777 #ifdef CONFIG_PCI
778 struct pci_bits {
779 unsigned int reg; /* PCI config register to read */
780 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
781 unsigned long mask;
782 unsigned long val;
785 extern void ata_pci_host_stop (struct ata_host_set *host_set);
786 extern struct ata_probe_ent *
787 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
788 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
789 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
790 #endif /* CONFIG_PCI */
793 * EH
795 extern void ata_eng_timeout(struct ata_port *ap);
797 extern void ata_port_schedule_eh(struct ata_port *ap);
798 extern int ata_port_abort(struct ata_port *ap);
799 extern int ata_port_freeze(struct ata_port *ap);
801 extern void ata_eh_freeze_port(struct ata_port *ap);
802 extern void ata_eh_thaw_port(struct ata_port *ap);
804 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
805 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
807 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
808 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
809 ata_postreset_fn_t postreset);
812 * printk helpers
814 #define ata_port_printk(ap, lv, fmt, args...) \
815 printk(lv"ata%u: "fmt, (ap)->id , ##args)
817 #define ata_dev_printk(dev, lv, fmt, args...) \
818 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
821 * ata_eh_info helpers
823 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
824 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
825 ATA_EH_DESC_LEN - (ehi)->desc_len, \
826 fmt , ##args); \
827 } while (0)
829 #define ata_ehi_clear_desc(ehi) do { \
830 (ehi)->desc[0] = '\0'; \
831 (ehi)->desc_len = 0; \
832 } while (0)
834 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
836 if (ehi->flags & ATA_EHI_HOTPLUGGED)
837 return;
839 ehi->flags |= ATA_EHI_HOTPLUGGED;
840 ehi->hotplug_timestamp = jiffies;
842 ehi->err_mask |= AC_ERR_ATA_BUS;
843 ehi->action |= ATA_EH_SOFTRESET;
844 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
848 * qc helpers
850 static inline int
851 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
853 if (sg == &qc->pad_sgent)
854 return 1;
855 if (qc->pad_len)
856 return 0;
857 if (((sg - qc->__sg) + 1) == qc->n_elem)
858 return 1;
859 return 0;
862 static inline struct scatterlist *
863 ata_qc_first_sg(struct ata_queued_cmd *qc)
865 if (qc->n_elem)
866 return qc->__sg;
867 if (qc->pad_len)
868 return &qc->pad_sgent;
869 return NULL;
872 static inline struct scatterlist *
873 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
875 if (sg == &qc->pad_sgent)
876 return NULL;
877 if (++sg - qc->__sg < qc->n_elem)
878 return sg;
879 if (qc->pad_len)
880 return &qc->pad_sgent;
881 return NULL;
884 #define ata_for_each_sg(sg, qc) \
885 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
887 static inline unsigned int ata_tag_valid(unsigned int tag)
889 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
892 static inline unsigned int ata_tag_internal(unsigned int tag)
894 return tag == ATA_MAX_QUEUE - 1;
898 * device helpers
900 static inline unsigned int ata_class_enabled(unsigned int class)
902 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
905 static inline unsigned int ata_class_disabled(unsigned int class)
907 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
910 static inline unsigned int ata_class_absent(unsigned int class)
912 return !ata_class_enabled(class) && !ata_class_disabled(class);
915 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
917 return ata_class_enabled(dev->class);
920 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
922 return ata_class_disabled(dev->class);
925 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
927 return ata_class_absent(dev->class);
931 * port helpers
933 static inline int ata_port_max_devices(const struct ata_port *ap)
935 if (ap->flags & ATA_FLAG_SLAVE_POSS)
936 return 2;
937 return 1;
941 static inline u8 ata_chk_status(struct ata_port *ap)
943 return ap->ops->check_status(ap);
948 * ata_pause - Flush writes and pause 400 nanoseconds.
949 * @ap: Port to wait for.
951 * LOCKING:
952 * Inherited from caller.
955 static inline void ata_pause(struct ata_port *ap)
957 ata_altstatus(ap);
958 ndelay(400);
963 * ata_busy_wait - Wait for a port status register
964 * @ap: Port to wait for.
966 * Waits up to max*10 microseconds for the selected bits in the port's
967 * status register to be cleared.
968 * Returns final value of status register.
970 * LOCKING:
971 * Inherited from caller.
974 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
975 unsigned int max)
977 u8 status;
979 do {
980 udelay(10);
981 status = ata_chk_status(ap);
982 max--;
983 } while ((status & bits) && (max > 0));
985 return status;
990 * ata_wait_idle - Wait for a port to be idle.
991 * @ap: Port to wait for.
993 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
994 * Returns final value of status register.
996 * LOCKING:
997 * Inherited from caller.
1000 static inline u8 ata_wait_idle(struct ata_port *ap)
1002 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1004 if (status & (ATA_BUSY | ATA_DRQ)) {
1005 unsigned long l = ap->ioaddr.status_addr;
1006 if (ata_msg_warn(ap))
1007 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1008 status, l);
1011 return status;
1014 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1016 qc->tf.ctl |= ATA_NIEN;
1019 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1020 unsigned int tag)
1022 if (likely(ata_tag_valid(tag)))
1023 return &ap->qcmd[tag];
1024 return NULL;
1027 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1028 unsigned int tag)
1030 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1032 if (unlikely(!qc) || !ap->ops->error_handler)
1033 return qc;
1035 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1036 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1037 return qc;
1039 return NULL;
1042 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1044 memset(tf, 0, sizeof(*tf));
1046 tf->ctl = dev->ap->ctl;
1047 if (dev->devno == 0)
1048 tf->device = ATA_DEVICE_OBS;
1049 else
1050 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1053 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1055 qc->__sg = NULL;
1056 qc->flags = 0;
1057 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1058 qc->nsect = 0;
1059 qc->nbytes = qc->curbytes = 0;
1060 qc->err_mask = 0;
1062 ata_tf_init(qc->dev, &qc->tf);
1064 /* init result_tf such that it indicates normal completion */
1065 qc->result_tf.command = ATA_DRDY;
1066 qc->result_tf.feature = 0;
1070 * ata_irq_on - Enable interrupts on a port.
1071 * @ap: Port on which interrupts are enabled.
1073 * Enable interrupts on a legacy IDE device using MMIO or PIO,
1074 * wait for idle, clear any pending interrupts.
1076 * LOCKING:
1077 * Inherited from caller.
1080 static inline u8 ata_irq_on(struct ata_port *ap)
1082 struct ata_ioports *ioaddr = &ap->ioaddr;
1083 u8 tmp;
1085 ap->ctl &= ~ATA_NIEN;
1086 ap->last_ctl = ap->ctl;
1088 if (ap->flags & ATA_FLAG_MMIO)
1089 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1090 else
1091 outb(ap->ctl, ioaddr->ctl_addr);
1092 tmp = ata_wait_idle(ap);
1094 ap->ops->irq_clear(ap);
1096 return tmp;
1101 * ata_irq_ack - Acknowledge a device interrupt.
1102 * @ap: Port on which interrupts are enabled.
1104 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
1105 * or BUSY+DRQ clear). Obtain dma status and port status from
1106 * device. Clear the interrupt. Return port status.
1108 * LOCKING:
1111 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1113 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1114 u8 host_stat, post_stat, status;
1116 status = ata_busy_wait(ap, bits, 1000);
1117 if (status & bits)
1118 if (ata_msg_err(ap))
1119 printk(KERN_ERR "abnormal status 0x%X\n", status);
1121 /* get controller status; clear intr, err bits */
1122 if (ap->flags & ATA_FLAG_MMIO) {
1123 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1124 host_stat = readb(mmio + ATA_DMA_STATUS);
1125 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1126 mmio + ATA_DMA_STATUS);
1128 post_stat = readb(mmio + ATA_DMA_STATUS);
1129 } else {
1130 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1131 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1132 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1134 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1137 if (ata_msg_intr(ap))
1138 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1139 __FUNCTION__,
1140 host_stat, post_stat, status);
1142 return status;
1145 static inline int ata_try_flush_cache(const struct ata_device *dev)
1147 return ata_id_wcache_enabled(dev->id) ||
1148 ata_id_has_flush(dev->id) ||
1149 ata_id_has_flush_ext(dev->id);
1152 static inline unsigned int ac_err_mask(u8 status)
1154 if (status & (ATA_BUSY | ATA_DRQ))
1155 return AC_ERR_HSM;
1156 if (status & (ATA_ERR | ATA_DF))
1157 return AC_ERR_DEV;
1158 return 0;
1161 static inline unsigned int __ac_err_mask(u8 status)
1163 unsigned int mask = ac_err_mask(status);
1164 if (mask == 0)
1165 return AC_ERR_OTHER;
1166 return mask;
1169 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1171 ap->pad_dma = 0;
1172 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1173 &ap->pad_dma, GFP_KERNEL);
1174 return (ap->pad == NULL) ? -ENOMEM : 0;
1177 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1179 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1182 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1184 return (struct ata_port *) &host->hostdata[0];
1187 #endif /* __LINUX_LIBATA_H__ */