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)
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>
34 #include <linux/ata.h>
35 #include <linux/workqueue.h>
36 #include <scsi/scsi_host.h>
39 * compile-time options: to be removed as soon as all the drivers are
40 * converted to the new debugging mechanism
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 */
50 /* note: prints function name for you */
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)
56 #define VPRINTK(fmt, args...)
57 #endif /* ATA_VERBOSE_DEBUG */
59 #define DPRINTK(fmt, args...)
60 #define VPRINTK(fmt, args...)
61 #endif /* ATA_DEBUG */
63 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65 /* NEW: debug levels */
66 #define HAVE_LIBATA_MSG 1
70 ATA_MSG_INFO
= 0x0002,
71 ATA_MSG_PROBE
= 0x0004,
72 ATA_MSG_WARN
= 0x0008,
73 ATA_MSG_MALLOC
= 0x0010,
75 ATA_MSG_INTR
= 0x0040,
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)
88 static inline u32
ata_msg_init(int dval
, int default_msg_enable_bits
)
90 if (dval
< 0 || dval
>= (sizeof(u32
) * 8))
91 return default_msg_enable_bits
; /* should be 0x1 - only driver info msgs */
94 return (1 << dval
) - 1;
97 /* defines only for the constants which don't work well as enums */
98 #define ATA_TAG_POISON 0xfafbfcfdU
100 /* move to PCI layer? */
101 static inline struct device
*pci_dev_to_dev(struct pci_dev
*pdev
)
107 /* various global constants */
108 LIBATA_MAX_PRD
= ATA_MAX_PRD
/ 2,
111 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
113 ATA_TAG_INTERNAL
= ATA_MAX_QUEUE
- 1,
114 ATA_MAX_SECTORS
= 200, /* FIXME */
116 ATA_DEF_BUSY_WAIT
= 10000,
117 ATA_SHORT_PAUSE
= (HZ
>> 6) + 1,
119 ATA_SHT_EMULATED
= 1,
120 ATA_SHT_CMD_PER_LUN
= 1,
121 ATA_SHT_THIS_ID
= -1,
122 ATA_SHT_USE_CLUSTERING
= 1,
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,
129 ATA_DFLAG_PIO
= (1 << 8), /* device currently in PIO mode */
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 */
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 */
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 */
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 */
160 ATA_FLAG_DISABLED
= (1 << 22), /* port is disabled, ignore it */
161 ATA_FLAG_SUSPENDED
= (1 << 23), /* port is suspended (power) */
163 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
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 */
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) */
178 ATA_HOST_SIMPLEX
= (1 << 0), /* Host is simplex, one DMA channel per host_set only */
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
,
201 /* SATA port states */
206 /* encoding various smaller bitmaps into a single
207 * unsigned int bitmap
214 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_BITS_PIO
,
215 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_BITS_MWDMA
,
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
,
221 /* size of buffer to pad xfers ending on unaligned boundaries */
223 ATA_DMA_PAD_BUF_SZ
= ATA_DMA_PAD_SZ
* ATA_MAX_QUEUE
,
225 /* masks for port functions */
226 ATA_PORT_PRIMARY
= (1 << 0),
227 ATA_PORT_SECONDARY
= (1 << 1),
232 /* desc_len for ata_eh_info and context */
233 ATA_EH_DESC_LEN
= 80,
235 /* reset / recovery action types */
236 ATA_EH_REVALIDATE
= (1 << 0),
237 ATA_EH_SOFTRESET
= (1 << 1),
238 ATA_EH_HARDRESET
= (1 << 2),
240 ATA_EH_RESET_MASK
= ATA_EH_SOFTRESET
| ATA_EH_HARDRESET
,
242 /* ata_eh_info->flags */
243 ATA_EHI_DID_RESET
= (1 << 0), /* already reset this port */
245 /* max repeat if error condition is still set after ->error_handler */
246 ATA_EH_MAX_REPEAT
= 5,
248 /* how hard are we gonna try to probe/recover devices */
249 ATA_PROBE_MAX_TRIES
= 3,
252 enum hsm_task_states
{
263 enum ata_completion_errors
{
264 AC_ERR_DEV
= (1 << 0), /* device reported error */
265 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
266 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
267 AC_ERR_MEDIA
= (1 << 3), /* media error */
268 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
269 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
270 AC_ERR_SYSTEM
= (1 << 6), /* system error */
271 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
272 AC_ERR_OTHER
= (1 << 8), /* unknown */
275 /* forward declarations */
277 struct ata_port_operations
;
279 struct ata_queued_cmd
;
282 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
283 typedef void (*ata_probeinit_fn_t
)(struct ata_port
*);
284 typedef int (*ata_reset_fn_t
)(struct ata_port
*, unsigned int *);
285 typedef void (*ata_postreset_fn_t
)(struct ata_port
*ap
, unsigned int *);
288 unsigned long cmd_addr
;
289 unsigned long data_addr
;
290 unsigned long error_addr
;
291 unsigned long feature_addr
;
292 unsigned long nsect_addr
;
293 unsigned long lbal_addr
;
294 unsigned long lbam_addr
;
295 unsigned long lbah_addr
;
296 unsigned long device_addr
;
297 unsigned long status_addr
;
298 unsigned long command_addr
;
299 unsigned long altstatus_addr
;
300 unsigned long ctl_addr
;
301 unsigned long bmdma_addr
;
302 unsigned long scr_addr
;
305 struct ata_probe_ent
{
306 struct list_head node
;
308 const struct ata_port_operations
*port_ops
;
309 struct scsi_host_template
*sht
;
310 struct ata_ioports port
[ATA_MAX_PORTS
];
311 unsigned int n_ports
;
312 unsigned int hard_port_no
;
313 unsigned int pio_mask
;
314 unsigned int mwdma_mask
;
315 unsigned int udma_mask
;
316 unsigned int legacy_mode
;
318 unsigned int irq_flags
;
319 unsigned long host_flags
;
320 unsigned long host_set_flags
;
321 void __iomem
*mmio_base
;
325 struct ata_host_set
{
329 void __iomem
*mmio_base
;
330 unsigned int n_ports
;
332 const struct ata_port_operations
*ops
;
334 int simplex_claimed
; /* Keep seperate in case we
335 ever need to do this locked */
336 struct ata_port
* ports
[0];
339 struct ata_queued_cmd
{
341 struct ata_device
*dev
;
343 struct scsi_cmnd
*scsicmd
;
344 void (*scsidone
)(struct scsi_cmnd
*);
346 struct ata_taskfile tf
;
347 u8 cdb
[ATAPI_CDB_LEN
];
349 unsigned long flags
; /* ATA_QCFLAG_xxx */
352 unsigned int orig_n_elem
;
356 unsigned int pad_len
;
359 unsigned int cursect
;
362 unsigned int curbytes
;
365 unsigned int cursg_ofs
;
367 struct scatterlist sgent
;
368 struct scatterlist pad_sgent
;
371 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
372 struct scatterlist
*__sg
;
374 unsigned int err_mask
;
375 struct ata_taskfile result_tf
;
376 ata_qc_cb_t complete_fn
;
381 struct ata_host_stats
{
382 unsigned long unhandled_irq
;
383 unsigned long idle_irq
;
384 unsigned long rw_reqbuf
;
387 struct ata_ering_entry
{
389 unsigned int err_mask
;
395 struct ata_ering_entry ring
[ATA_ERING_SIZE
];
400 u64 n_sectors
; /* size of device, if ATA */
401 unsigned long flags
; /* ATA_DFLAG_xxx */
402 unsigned int class; /* ATA_DEV_xxx */
403 unsigned int devno
; /* 0 or 1 */
404 u16 id
[ATA_ID_WORDS
]; /* IDENTIFY xxx DEVICE data */
408 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
410 unsigned int multi_count
; /* sectors count for
411 READ/WRITE MULTIPLE */
412 unsigned int max_sectors
; /* per-device max sectors */
413 unsigned int cdb_len
;
415 /* per-dev xfer mask */
416 unsigned int pio_mask
;
417 unsigned int mwdma_mask
;
418 unsigned int udma_mask
;
420 /* for CHS addressing */
421 u16 cylinders
; /* Number of cylinders */
422 u16 heads
; /* Number of heads */
423 u16 sectors
; /* Number of sectors per track */
426 struct ata_ering ering
;
430 struct ata_device
*dev
; /* offending device */
431 u32 serror
; /* SError from LLDD */
432 unsigned int err_mask
; /* port-wide err_mask */
433 unsigned int action
; /* ATA_EH_* action mask */
434 unsigned int flags
; /* ATA_EHI_* flags */
435 char desc
[ATA_EH_DESC_LEN
];
439 struct ata_eh_context
{
440 struct ata_eh_info i
;
441 int tries
[ATA_MAX_DEVICES
];
445 struct Scsi_Host
*host
; /* our co-allocated scsi host */
446 const struct ata_port_operations
*ops
;
447 unsigned long flags
; /* ATA_FLAG_xxx */
448 unsigned int id
; /* unique id req'd by scsi midlyr */
449 unsigned int port_no
; /* unique port #; from zero */
450 unsigned int hard_port_no
; /* hardware port #; from zero */
452 struct ata_prd
*prd
; /* our SG list */
453 dma_addr_t prd_dma
; /* and its DMA mapping */
455 void *pad
; /* array of DMA pad buffers */
458 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
460 u8 ctl
; /* cache of ATA control register */
461 u8 last_ctl
; /* Cache last written value */
462 unsigned int pio_mask
;
463 unsigned int mwdma_mask
;
464 unsigned int udma_mask
;
465 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
466 unsigned int sata_spd_limit
; /* SATA PHY speed limit */
468 /* record runtime error info, protected by host_set lock */
469 struct ata_eh_info eh_info
;
470 /* EH context owned by EH */
471 struct ata_eh_context eh_context
;
473 struct ata_device device
[ATA_MAX_DEVICES
];
475 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
476 unsigned long qactive
;
477 unsigned int active_tag
;
479 struct ata_host_stats stats
;
480 struct ata_host_set
*host_set
;
483 struct work_struct port_task
;
485 unsigned int hsm_task_state
;
486 unsigned long pio_task_timeout
;
489 struct list_head eh_done_q
;
493 u8 sector_buf
[ATA_SECT_SIZE
]; /* owned by EH */
496 struct ata_port_operations
{
497 void (*port_disable
) (struct ata_port
*);
499 void (*dev_config
) (struct ata_port
*, struct ata_device
*);
501 void (*set_piomode
) (struct ata_port
*, struct ata_device
*);
502 void (*set_dmamode
) (struct ata_port
*, struct ata_device
*);
503 unsigned long (*mode_filter
) (const struct ata_port
*, struct ata_device
*, unsigned long);
505 void (*tf_load
) (struct ata_port
*ap
, const struct ata_taskfile
*tf
);
506 void (*tf_read
) (struct ata_port
*ap
, struct ata_taskfile
*tf
);
508 void (*exec_command
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
509 u8 (*check_status
)(struct ata_port
*ap
);
510 u8 (*check_altstatus
)(struct ata_port
*ap
);
511 void (*dev_select
)(struct ata_port
*ap
, unsigned int device
);
513 void (*phy_reset
) (struct ata_port
*ap
); /* obsolete */
514 void (*set_mode
) (struct ata_port
*ap
);
515 int (*probe_reset
) (struct ata_port
*ap
, unsigned int *classes
);
517 void (*post_set_mode
) (struct ata_port
*ap
);
519 int (*check_atapi_dma
) (struct ata_queued_cmd
*qc
);
521 void (*bmdma_setup
) (struct ata_queued_cmd
*qc
);
522 void (*bmdma_start
) (struct ata_queued_cmd
*qc
);
524 void (*qc_prep
) (struct ata_queued_cmd
*qc
);
525 unsigned int (*qc_issue
) (struct ata_queued_cmd
*qc
);
527 /* Error handlers. ->error_handler overrides ->eng_timeout and
528 * indicates that new-style EH is in place.
530 void (*eng_timeout
) (struct ata_port
*ap
); /* obsolete */
532 void (*freeze
) (struct ata_port
*ap
);
533 void (*thaw
) (struct ata_port
*ap
);
534 void (*error_handler
) (struct ata_port
*ap
);
535 void (*post_internal_cmd
) (struct ata_queued_cmd
*qc
);
537 irqreturn_t (*irq_handler
)(int, void *, struct pt_regs
*);
538 void (*irq_clear
) (struct ata_port
*);
540 u32 (*scr_read
) (struct ata_port
*ap
, unsigned int sc_reg
);
541 void (*scr_write
) (struct ata_port
*ap
, unsigned int sc_reg
,
544 int (*port_start
) (struct ata_port
*ap
);
545 void (*port_stop
) (struct ata_port
*ap
);
547 void (*host_stop
) (struct ata_host_set
*host_set
);
549 void (*bmdma_stop
) (struct ata_queued_cmd
*qc
);
550 u8 (*bmdma_status
) (struct ata_port
*ap
);
553 struct ata_port_info
{
554 struct scsi_host_template
*sht
;
555 unsigned long host_flags
;
556 unsigned long pio_mask
;
557 unsigned long mwdma_mask
;
558 unsigned long udma_mask
;
559 const struct ata_port_operations
*port_ops
;
564 unsigned short mode
; /* ATA mode */
565 unsigned short setup
; /* t1 */
566 unsigned short act8b
; /* t2 for 8-bit I/O */
567 unsigned short rec8b
; /* t2i for 8-bit I/O */
568 unsigned short cyc8b
; /* t0 for 8-bit I/O */
569 unsigned short active
; /* t2 or tD */
570 unsigned short recover
; /* t2i or tK */
571 unsigned short cycle
; /* t0 */
572 unsigned short udma
; /* t2CYCTYP/2 */
575 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
577 extern void ata_port_probe(struct ata_port
*);
578 extern void __sata_phy_reset(struct ata_port
*ap
);
579 extern void sata_phy_reset(struct ata_port
*ap
);
580 extern void ata_bus_reset(struct ata_port
*ap
);
581 extern int sata_set_spd(struct ata_port
*ap
);
582 extern int ata_drive_probe_reset(struct ata_port
*ap
,
583 ata_probeinit_fn_t probeinit
,
584 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
585 ata_postreset_fn_t postreset
, unsigned int *classes
);
586 extern void ata_std_probeinit(struct ata_port
*ap
);
587 extern int ata_std_softreset(struct ata_port
*ap
, unsigned int *classes
);
588 extern int sata_std_hardreset(struct ata_port
*ap
, unsigned int *class);
589 extern void ata_std_postreset(struct ata_port
*ap
, unsigned int *classes
);
590 extern int ata_dev_revalidate(struct ata_device
*dev
, int post_reset
);
591 extern void ata_port_disable(struct ata_port
*);
592 extern void ata_std_ports(struct ata_ioports
*ioaddr
);
594 extern int ata_pci_init_one (struct pci_dev
*pdev
, struct ata_port_info
**port_info
,
595 unsigned int n_ports
);
596 extern void ata_pci_remove_one (struct pci_dev
*pdev
);
597 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t state
);
598 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
599 extern int ata_pci_clear_simplex(struct pci_dev
*pdev
);
600 #endif /* CONFIG_PCI */
601 extern int ata_device_add(const struct ata_probe_ent
*ent
);
602 extern void ata_host_set_remove(struct ata_host_set
*host_set
);
603 extern int ata_scsi_detect(struct scsi_host_template
*sht
);
604 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
605 extern int ata_scsi_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*));
606 extern int ata_scsi_release(struct Scsi_Host
*host
);
607 extern unsigned int ata_host_intr(struct ata_port
*ap
, struct ata_queued_cmd
*qc
);
608 extern int sata_scr_valid(struct ata_port
*ap
);
609 extern int sata_scr_read(struct ata_port
*ap
, int reg
, u32
*val
);
610 extern int sata_scr_write(struct ata_port
*ap
, int reg
, u32 val
);
611 extern int sata_scr_write_flush(struct ata_port
*ap
, int reg
, u32 val
);
612 extern int ata_port_online(struct ata_port
*ap
);
613 extern int ata_port_offline(struct ata_port
*ap
);
614 extern int ata_scsi_device_resume(struct scsi_device
*);
615 extern int ata_scsi_device_suspend(struct scsi_device
*, pm_message_t state
);
616 extern int ata_device_resume(struct ata_device
*);
617 extern int ata_device_suspend(struct ata_device
*, pm_message_t state
);
618 extern int ata_ratelimit(void);
619 extern unsigned int ata_busy_sleep(struct ata_port
*ap
,
620 unsigned long timeout_pat
,
621 unsigned long timeout
);
622 extern void ata_port_queue_task(struct ata_port
*ap
, void (*fn
)(void *),
623 void *data
, unsigned long delay
);
624 extern u32
ata_wait_register(void __iomem
*reg
, u32 mask
, u32 val
,
625 unsigned long interval_msec
,
626 unsigned long timeout_msec
);
629 * Default driver ops implementations
631 extern void ata_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
632 extern void ata_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
633 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
, u8
*fis
, u8 pmp
);
634 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
635 extern void ata_noop_dev_select (struct ata_port
*ap
, unsigned int device
);
636 extern void ata_std_dev_select (struct ata_port
*ap
, unsigned int device
);
637 extern u8
ata_check_status(struct ata_port
*ap
);
638 extern u8
ata_altstatus(struct ata_port
*ap
);
639 extern void ata_exec_command(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
640 extern int ata_std_probe_reset(struct ata_port
*ap
, unsigned int *classes
);
641 extern int ata_port_start (struct ata_port
*ap
);
642 extern void ata_port_stop (struct ata_port
*ap
);
643 extern void ata_host_stop (struct ata_host_set
*host_set
);
644 extern irqreturn_t
ata_interrupt (int irq
, void *dev_instance
, struct pt_regs
*regs
);
645 extern void ata_qc_prep(struct ata_queued_cmd
*qc
);
646 extern void ata_noop_qc_prep(struct ata_queued_cmd
*qc
);
647 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd
*qc
);
648 extern void ata_sg_init_one(struct ata_queued_cmd
*qc
, void *buf
,
649 unsigned int buflen
);
650 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
651 unsigned int n_elem
);
652 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
653 extern void ata_id_string(const u16
*id
, unsigned char *s
,
654 unsigned int ofs
, unsigned int len
);
655 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
656 unsigned int ofs
, unsigned int len
);
657 extern void ata_bmdma_setup (struct ata_queued_cmd
*qc
);
658 extern void ata_bmdma_start (struct ata_queued_cmd
*qc
);
659 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
660 extern u8
ata_bmdma_status(struct ata_port
*ap
);
661 extern void ata_bmdma_irq_clear(struct ata_port
*ap
);
662 extern void ata_qc_complete(struct ata_queued_cmd
*qc
);
663 extern void ata_scsi_simulate(struct ata_device
*dev
, struct scsi_cmnd
*cmd
,
664 void (*done
)(struct scsi_cmnd
*));
665 extern int ata_std_bios_param(struct scsi_device
*sdev
,
666 struct block_device
*bdev
,
667 sector_t capacity
, int geom
[]);
668 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
669 extern struct ata_device
*ata_dev_pair(struct ata_device
*adev
);
675 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
676 extern int ata_timing_compute(struct ata_device
*, unsigned short,
677 struct ata_timing
*, int, int);
678 extern void ata_timing_merge(const struct ata_timing
*,
679 const struct ata_timing
*, struct ata_timing
*,
683 ATA_TIMING_SETUP
= (1 << 0),
684 ATA_TIMING_ACT8B
= (1 << 1),
685 ATA_TIMING_REC8B
= (1 << 2),
686 ATA_TIMING_CYC8B
= (1 << 3),
687 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
689 ATA_TIMING_ACTIVE
= (1 << 4),
690 ATA_TIMING_RECOVER
= (1 << 5),
691 ATA_TIMING_CYCLE
= (1 << 6),
692 ATA_TIMING_UDMA
= (1 << 7),
693 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
694 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
695 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
696 ATA_TIMING_CYCLE
| ATA_TIMING_UDMA
,
702 unsigned int reg
; /* PCI config register to read */
703 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
708 extern void ata_pci_host_stop (struct ata_host_set
*host_set
);
709 extern struct ata_probe_ent
*
710 ata_pci_init_native_mode(struct pci_dev
*pdev
, struct ata_port_info
**port
, int portmask
);
711 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
712 extern unsigned long ata_pci_default_filter(const struct ata_port
*, struct ata_device
*, unsigned long);
713 #endif /* CONFIG_PCI */
718 extern void ata_eng_timeout(struct ata_port
*ap
);
720 extern void ata_port_schedule_eh(struct ata_port
*ap
);
721 extern int ata_port_abort(struct ata_port
*ap
);
722 extern int ata_port_freeze(struct ata_port
*ap
);
724 extern void ata_eh_freeze_port(struct ata_port
*ap
);
725 extern void ata_eh_thaw_port(struct ata_port
*ap
);
727 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
728 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
733 #define ata_port_printk(ap, lv, fmt, args...) \
734 printk(lv"ata%u: "fmt, (ap)->id , ##args)
736 #define ata_dev_printk(dev, lv, fmt, args...) \
737 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
740 * ata_eh_info helpers
742 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
743 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
744 ATA_EH_DESC_LEN - (ehi)->desc_len, \
748 #define ata_ehi_clear_desc(ehi) do { \
749 (ehi)->desc[0] = '\0'; \
750 (ehi)->desc_len = 0; \
757 ata_sg_is_last(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
759 if (sg
== &qc
->pad_sgent
)
763 if (((sg
- qc
->__sg
) + 1) == qc
->n_elem
)
768 static inline struct scatterlist
*
769 ata_qc_first_sg(struct ata_queued_cmd
*qc
)
774 return &qc
->pad_sgent
;
778 static inline struct scatterlist
*
779 ata_qc_next_sg(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
781 if (sg
== &qc
->pad_sgent
)
783 if (++sg
- qc
->__sg
< qc
->n_elem
)
786 return &qc
->pad_sgent
;
790 #define ata_for_each_sg(sg, qc) \
791 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
793 static inline unsigned int ata_tag_valid(unsigned int tag
)
795 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
798 static inline unsigned int ata_tag_internal(unsigned int tag
)
800 return tag
== ATA_MAX_QUEUE
- 1;
803 static inline unsigned int ata_class_enabled(unsigned int class)
805 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
;
808 static inline unsigned int ata_class_disabled(unsigned int class)
810 return class == ATA_DEV_ATA_UNSUP
|| class == ATA_DEV_ATAPI_UNSUP
;
813 static inline unsigned int ata_class_absent(unsigned int class)
815 return !ata_class_enabled(class) && !ata_class_disabled(class);
818 static inline unsigned int ata_dev_enabled(const struct ata_device
*dev
)
820 return ata_class_enabled(dev
->class);
823 static inline unsigned int ata_dev_disabled(const struct ata_device
*dev
)
825 return ata_class_disabled(dev
->class);
828 static inline unsigned int ata_dev_absent(const struct ata_device
*dev
)
830 return ata_class_absent(dev
->class);
833 static inline u8
ata_chk_status(struct ata_port
*ap
)
835 return ap
->ops
->check_status(ap
);
840 * ata_pause - Flush writes and pause 400 nanoseconds.
841 * @ap: Port to wait for.
844 * Inherited from caller.
847 static inline void ata_pause(struct ata_port
*ap
)
855 * ata_busy_wait - Wait for a port status register
856 * @ap: Port to wait for.
858 * Waits up to max*10 microseconds for the selected bits in the port's
859 * status register to be cleared.
860 * Returns final value of status register.
863 * Inherited from caller.
866 static inline u8
ata_busy_wait(struct ata_port
*ap
, unsigned int bits
,
873 status
= ata_chk_status(ap
);
875 } while ((status
& bits
) && (max
> 0));
882 * ata_wait_idle - Wait for a port to be idle.
883 * @ap: Port to wait for.
885 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
886 * Returns final value of status register.
889 * Inherited from caller.
892 static inline u8
ata_wait_idle(struct ata_port
*ap
)
894 u8 status
= ata_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
896 if (status
& (ATA_BUSY
| ATA_DRQ
)) {
897 unsigned long l
= ap
->ioaddr
.status_addr
;
898 if (ata_msg_warn(ap
))
899 printk(KERN_WARNING
"ATA: abnormal status 0x%X on port 0x%lX\n",
906 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
908 qc
->tf
.ctl
|= ATA_NIEN
;
911 static inline struct ata_queued_cmd
*__ata_qc_from_tag(struct ata_port
*ap
,
914 if (likely(ata_tag_valid(tag
)))
915 return &ap
->qcmd
[tag
];
919 static inline struct ata_queued_cmd
*ata_qc_from_tag(struct ata_port
*ap
,
922 struct ata_queued_cmd
*qc
= __ata_qc_from_tag(ap
, tag
);
924 if (unlikely(!qc
) || !ap
->ops
->error_handler
)
927 if ((qc
->flags
& (ATA_QCFLAG_ACTIVE
|
928 ATA_QCFLAG_FAILED
)) == ATA_QCFLAG_ACTIVE
)
934 static inline void ata_tf_init(struct ata_device
*dev
, struct ata_taskfile
*tf
)
936 memset(tf
, 0, sizeof(*tf
));
938 tf
->ctl
= dev
->ap
->ctl
;
940 tf
->device
= ATA_DEVICE_OBS
;
942 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
945 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
949 qc
->cursect
= qc
->cursg
= qc
->cursg_ofs
= 0;
951 qc
->nbytes
= qc
->curbytes
= 0;
954 ata_tf_init(qc
->dev
, &qc
->tf
);
956 /* init result_tf such that it indicates normal completion */
957 qc
->result_tf
.command
= ATA_DRDY
;
958 qc
->result_tf
.feature
= 0;
962 * ata_irq_on - Enable interrupts on a port.
963 * @ap: Port on which interrupts are enabled.
965 * Enable interrupts on a legacy IDE device using MMIO or PIO,
966 * wait for idle, clear any pending interrupts.
969 * Inherited from caller.
972 static inline u8
ata_irq_on(struct ata_port
*ap
)
974 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
977 ap
->ctl
&= ~ATA_NIEN
;
978 ap
->last_ctl
= ap
->ctl
;
980 if (ap
->flags
& ATA_FLAG_MMIO
)
981 writeb(ap
->ctl
, (void __iomem
*) ioaddr
->ctl_addr
);
983 outb(ap
->ctl
, ioaddr
->ctl_addr
);
984 tmp
= ata_wait_idle(ap
);
986 ap
->ops
->irq_clear(ap
);
993 * ata_irq_ack - Acknowledge a device interrupt.
994 * @ap: Port on which interrupts are enabled.
996 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
997 * or BUSY+DRQ clear). Obtain dma status and port status from
998 * device. Clear the interrupt. Return port status.
1003 static inline u8
ata_irq_ack(struct ata_port
*ap
, unsigned int chk_drq
)
1005 unsigned int bits
= chk_drq
? ATA_BUSY
| ATA_DRQ
: ATA_BUSY
;
1006 u8 host_stat
, post_stat
, status
;
1008 status
= ata_busy_wait(ap
, bits
, 1000);
1010 if (ata_msg_err(ap
))
1011 printk(KERN_ERR
"abnormal status 0x%X\n", status
);
1013 /* get controller status; clear intr, err bits */
1014 if (ap
->flags
& ATA_FLAG_MMIO
) {
1015 void __iomem
*mmio
= (void __iomem
*) ap
->ioaddr
.bmdma_addr
;
1016 host_stat
= readb(mmio
+ ATA_DMA_STATUS
);
1017 writeb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
1018 mmio
+ ATA_DMA_STATUS
);
1020 post_stat
= readb(mmio
+ ATA_DMA_STATUS
);
1022 host_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
1023 outb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
1024 ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
1026 post_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
1029 if (ata_msg_intr(ap
))
1030 printk(KERN_INFO
"%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1032 host_stat
, post_stat
, status
);
1037 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
1039 return ata_id_wcache_enabled(dev
->id
) ||
1040 ata_id_has_flush(dev
->id
) ||
1041 ata_id_has_flush_ext(dev
->id
);
1044 static inline unsigned int ac_err_mask(u8 status
)
1046 if (status
& ATA_BUSY
)
1048 if (status
& (ATA_ERR
| ATA_DF
))
1053 static inline unsigned int __ac_err_mask(u8 status
)
1055 unsigned int mask
= ac_err_mask(status
);
1057 return AC_ERR_OTHER
;
1061 static inline int ata_pad_alloc(struct ata_port
*ap
, struct device
*dev
)
1064 ap
->pad
= dma_alloc_coherent(dev
, ATA_DMA_PAD_BUF_SZ
,
1065 &ap
->pad_dma
, GFP_KERNEL
);
1066 return (ap
->pad
== NULL
) ? -ENOMEM
: 0;
1069 static inline void ata_pad_free(struct ata_port
*ap
, struct device
*dev
)
1071 dma_free_coherent(dev
, ATA_DMA_PAD_BUF_SZ
, ap
->pad
, ap
->pad_dma
);
1074 static inline struct ata_port
*ata_shost_to_port(struct Scsi_Host
*host
)
1076 return (struct ata_port
*) &host
->hostdata
[0];
1079 #endif /* __LINUX_LIBATA_H__ */