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>
38 * compile-time options: to be removed as soon as all the drivers are
39 * converted to the new debugging mechanism
41 #undef ATA_DEBUG /* debugging output */
42 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
43 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
44 #undef ATA_NDEBUG /* define to disable quick runtime checks */
45 #undef ATA_ENABLE_PATA /* define to enable PATA support in some
46 * low-level drivers */
47 #undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */
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,
112 ATA_MAX_SECTORS
= 200, /* FIXME */
114 ATA_DEF_BUSY_WAIT
= 10000,
115 ATA_SHORT_PAUSE
= (HZ
>> 6) + 1,
117 ATA_SHT_EMULATED
= 1,
118 ATA_SHT_CMD_PER_LUN
= 1,
119 ATA_SHT_THIS_ID
= -1,
120 ATA_SHT_USE_CLUSTERING
= 1,
122 /* struct ata_device stuff */
123 ATA_DFLAG_LBA48
= (1 << 0), /* device supports LBA48 */
124 ATA_DFLAG_PIO
= (1 << 1), /* device currently in PIO mode */
125 ATA_DFLAG_LBA
= (1 << 2), /* device supports LBA */
127 ATA_DEV_UNKNOWN
= 0, /* unknown device */
128 ATA_DEV_ATA
= 1, /* ATA device */
129 ATA_DEV_ATA_UNSUP
= 2, /* ATA device (unsupported) */
130 ATA_DEV_ATAPI
= 3, /* ATAPI device */
131 ATA_DEV_ATAPI_UNSUP
= 4, /* ATAPI device (unsupported) */
132 ATA_DEV_NONE
= 5, /* no device */
134 /* struct ata_port flags */
135 ATA_FLAG_SLAVE_POSS
= (1 << 1), /* host supports slave dev */
136 /* (doesn't imply presence) */
137 ATA_FLAG_PORT_DISABLED
= (1 << 2), /* port is disabled, ignore it */
138 ATA_FLAG_SATA
= (1 << 3),
139 ATA_FLAG_NO_LEGACY
= (1 << 4), /* no legacy mode check */
140 ATA_FLAG_SRST
= (1 << 5), /* (obsolete) use ATA SRST, not E.D.D. */
141 ATA_FLAG_MMIO
= (1 << 6), /* use MMIO, not PIO */
142 ATA_FLAG_SATA_RESET
= (1 << 7), /* (obsolete) use COMRESET */
143 ATA_FLAG_PIO_DMA
= (1 << 8), /* PIO cmds via DMA */
144 ATA_FLAG_NOINTR
= (1 << 9), /* FIXME: Remove this once
145 * proper HSM is in place. */
146 ATA_FLAG_DEBUGMSG
= (1 << 10),
147 ATA_FLAG_NO_ATAPI
= (1 << 11), /* No ATAPI support */
149 ATA_FLAG_SUSPENDED
= (1 << 12), /* port is suspended */
151 ATA_FLAG_PIO_LBA48
= (1 << 13), /* Host DMA engine is LBA28 only */
152 ATA_FLAG_IRQ_MASK
= (1 << 14), /* Mask IRQ in PIO xfers */
154 ATA_FLAG_FLUSH_PORT_TASK
= (1 << 15), /* Flush port task */
155 ATA_FLAG_IN_EH
= (1 << 16), /* EH in progress */
157 ATA_QCFLAG_ACTIVE
= (1 << 1), /* cmd not yet ack'd to scsi lyer */
158 ATA_QCFLAG_SG
= (1 << 3), /* have s/g table? */
159 ATA_QCFLAG_SINGLE
= (1 << 4), /* no s/g, just a single buffer */
160 ATA_QCFLAG_DMAMAP
= ATA_QCFLAG_SG
| ATA_QCFLAG_SINGLE
,
161 ATA_QCFLAG_EH_SCHEDULED
= (1 << 5), /* EH scheduled */
163 /* various lengths of time */
164 ATA_TMOUT_EDD
= 5 * HZ
, /* heuristic */
165 ATA_TMOUT_PIO
= 30 * HZ
,
166 ATA_TMOUT_BOOT
= 30 * HZ
, /* heuristic */
167 ATA_TMOUT_BOOT_QUICK
= 7 * HZ
, /* heuristic */
168 ATA_TMOUT_CDB
= 30 * HZ
,
169 ATA_TMOUT_CDB_QUICK
= 5 * HZ
,
170 ATA_TMOUT_INTERNAL
= 30 * HZ
,
171 ATA_TMOUT_INTERNAL_QUICK
= 5 * HZ
,
185 /* SATA port states */
190 /* encoding various smaller bitmaps into a single
191 * unsigned int bitmap
198 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_BITS_PIO
,
199 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_BITS_MWDMA
,
201 ATA_MASK_PIO
= ((1 << ATA_BITS_PIO
) - 1) << ATA_SHIFT_PIO
,
202 ATA_MASK_MWDMA
= ((1 << ATA_BITS_MWDMA
) - 1) << ATA_SHIFT_MWDMA
,
203 ATA_MASK_UDMA
= ((1 << ATA_BITS_UDMA
) - 1) << ATA_SHIFT_UDMA
,
205 /* size of buffer to pad xfers ending on unaligned boundaries */
207 ATA_DMA_PAD_BUF_SZ
= ATA_DMA_PAD_SZ
* ATA_MAX_QUEUE
,
209 /* Masks for port functions */
210 ATA_PORT_PRIMARY
= (1 << 0),
211 ATA_PORT_SECONDARY
= (1 << 1),
214 enum hsm_task_states
{
225 enum ata_completion_errors
{
226 AC_ERR_DEV
= (1 << 0), /* device reported error */
227 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
228 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
229 AC_ERR_MEDIA
= (1 << 3), /* media error */
230 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
231 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
232 AC_ERR_SYSTEM
= (1 << 6), /* system error */
233 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
234 AC_ERR_OTHER
= (1 << 8), /* unknown */
237 /* forward declarations */
239 struct ata_port_operations
;
241 struct ata_queued_cmd
;
244 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
245 typedef void (*ata_probeinit_fn_t
)(struct ata_port
*);
246 typedef int (*ata_reset_fn_t
)(struct ata_port
*, int, unsigned int *);
247 typedef void (*ata_postreset_fn_t
)(struct ata_port
*ap
, unsigned int *);
250 unsigned long cmd_addr
;
251 unsigned long data_addr
;
252 unsigned long error_addr
;
253 unsigned long feature_addr
;
254 unsigned long nsect_addr
;
255 unsigned long lbal_addr
;
256 unsigned long lbam_addr
;
257 unsigned long lbah_addr
;
258 unsigned long device_addr
;
259 unsigned long status_addr
;
260 unsigned long command_addr
;
261 unsigned long altstatus_addr
;
262 unsigned long ctl_addr
;
263 unsigned long bmdma_addr
;
264 unsigned long scr_addr
;
267 struct ata_probe_ent
{
268 struct list_head node
;
270 const struct ata_port_operations
*port_ops
;
271 struct scsi_host_template
*sht
;
272 struct ata_ioports port
[ATA_MAX_PORTS
];
273 unsigned int n_ports
;
274 unsigned int hard_port_no
;
275 unsigned int pio_mask
;
276 unsigned int mwdma_mask
;
277 unsigned int udma_mask
;
278 unsigned int legacy_mode
;
280 unsigned int irq_flags
;
281 unsigned long host_flags
;
282 void __iomem
*mmio_base
;
286 struct ata_host_set
{
290 void __iomem
*mmio_base
;
291 unsigned int n_ports
;
293 const struct ata_port_operations
*ops
;
294 struct ata_port
* ports
[0];
297 struct ata_queued_cmd
{
299 struct ata_device
*dev
;
301 struct scsi_cmnd
*scsicmd
;
302 void (*scsidone
)(struct scsi_cmnd
*);
304 struct ata_taskfile tf
;
305 u8 cdb
[ATAPI_CDB_LEN
];
307 unsigned long flags
; /* ATA_QCFLAG_xxx */
310 unsigned int orig_n_elem
;
314 unsigned int pad_len
;
317 unsigned int cursect
;
320 unsigned int curbytes
;
323 unsigned int cursg_ofs
;
325 struct scatterlist sgent
;
326 struct scatterlist pad_sgent
;
329 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
330 struct scatterlist
*__sg
;
332 unsigned int err_mask
;
334 ata_qc_cb_t complete_fn
;
339 struct ata_host_stats
{
340 unsigned long unhandled_irq
;
341 unsigned long idle_irq
;
342 unsigned long rw_reqbuf
;
346 u64 n_sectors
; /* size of device, if ATA */
347 unsigned long flags
; /* ATA_DFLAG_xxx */
348 unsigned int class; /* ATA_DEV_xxx */
349 unsigned int devno
; /* 0 or 1 */
350 u16
*id
; /* IDENTIFY xxx DEVICE data */
354 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
356 unsigned int multi_count
; /* sectors count for
357 READ/WRITE MULTIPLE */
358 unsigned int max_sectors
; /* per-device max sectors */
359 unsigned int cdb_len
;
361 /* per-dev xfer mask */
362 unsigned int pio_mask
;
363 unsigned int mwdma_mask
;
364 unsigned int udma_mask
;
366 /* for CHS addressing */
367 u16 cylinders
; /* Number of cylinders */
368 u16 heads
; /* Number of heads */
369 u16 sectors
; /* Number of sectors per track */
373 struct Scsi_Host
*host
; /* our co-allocated scsi host */
374 const struct ata_port_operations
*ops
;
375 unsigned long flags
; /* ATA_FLAG_xxx */
376 unsigned int id
; /* unique id req'd by scsi midlyr */
377 unsigned int port_no
; /* unique port #; from zero */
378 unsigned int hard_port_no
; /* hardware port #; from zero */
380 struct ata_prd
*prd
; /* our SG list */
381 dma_addr_t prd_dma
; /* and its DMA mapping */
383 void *pad
; /* array of DMA pad buffers */
386 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
388 u8 ctl
; /* cache of ATA control register */
389 u8 last_ctl
; /* Cache last written value */
390 unsigned int pio_mask
;
391 unsigned int mwdma_mask
;
392 unsigned int udma_mask
;
393 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
395 struct ata_device device
[ATA_MAX_DEVICES
];
397 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
398 unsigned long qactive
;
399 unsigned int active_tag
;
401 struct ata_host_stats stats
;
402 struct ata_host_set
*host_set
;
404 struct work_struct port_task
;
406 unsigned int hsm_task_state
;
407 unsigned long pio_task_timeout
;
410 struct list_head eh_done_q
;
415 struct ata_port_operations
{
416 void (*port_disable
) (struct ata_port
*);
418 void (*dev_config
) (struct ata_port
*, struct ata_device
*);
420 void (*set_piomode
) (struct ata_port
*, struct ata_device
*);
421 void (*set_dmamode
) (struct ata_port
*, struct ata_device
*);
423 void (*tf_load
) (struct ata_port
*ap
, const struct ata_taskfile
*tf
);
424 void (*tf_read
) (struct ata_port
*ap
, struct ata_taskfile
*tf
);
426 void (*exec_command
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
427 u8 (*check_status
)(struct ata_port
*ap
);
428 u8 (*check_altstatus
)(struct ata_port
*ap
);
429 void (*dev_select
)(struct ata_port
*ap
, unsigned int device
);
431 void (*phy_reset
) (struct ata_port
*ap
); /* obsolete */
432 int (*probe_reset
) (struct ata_port
*ap
, unsigned int *classes
);
434 void (*post_set_mode
) (struct ata_port
*ap
);
436 int (*check_atapi_dma
) (struct ata_queued_cmd
*qc
);
438 void (*bmdma_setup
) (struct ata_queued_cmd
*qc
);
439 void (*bmdma_start
) (struct ata_queued_cmd
*qc
);
441 void (*qc_prep
) (struct ata_queued_cmd
*qc
);
442 unsigned int (*qc_issue
) (struct ata_queued_cmd
*qc
);
444 void (*eng_timeout
) (struct ata_port
*ap
);
446 irqreturn_t (*irq_handler
)(int, void *, struct pt_regs
*);
447 void (*irq_clear
) (struct ata_port
*);
449 u32 (*scr_read
) (struct ata_port
*ap
, unsigned int sc_reg
);
450 void (*scr_write
) (struct ata_port
*ap
, unsigned int sc_reg
,
453 int (*port_start
) (struct ata_port
*ap
);
454 void (*port_stop
) (struct ata_port
*ap
);
456 void (*host_stop
) (struct ata_host_set
*host_set
);
458 void (*bmdma_stop
) (struct ata_queued_cmd
*qc
);
459 u8 (*bmdma_status
) (struct ata_port
*ap
);
462 struct ata_port_info
{
463 struct scsi_host_template
*sht
;
464 unsigned long host_flags
;
465 unsigned long pio_mask
;
466 unsigned long mwdma_mask
;
467 unsigned long udma_mask
;
468 const struct ata_port_operations
*port_ops
;
473 unsigned short mode
; /* ATA mode */
474 unsigned short setup
; /* t1 */
475 unsigned short act8b
; /* t2 for 8-bit I/O */
476 unsigned short rec8b
; /* t2i for 8-bit I/O */
477 unsigned short cyc8b
; /* t0 for 8-bit I/O */
478 unsigned short active
; /* t2 or tD */
479 unsigned short recover
; /* t2i or tK */
480 unsigned short cycle
; /* t0 */
481 unsigned short udma
; /* t2CYCTYP/2 */
484 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
486 extern void ata_port_probe(struct ata_port
*);
487 extern void __sata_phy_reset(struct ata_port
*ap
);
488 extern void sata_phy_reset(struct ata_port
*ap
);
489 extern void ata_bus_reset(struct ata_port
*ap
);
490 extern int ata_drive_probe_reset(struct ata_port
*ap
,
491 ata_probeinit_fn_t probeinit
,
492 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
493 ata_postreset_fn_t postreset
, unsigned int *classes
);
494 extern void ata_std_probeinit(struct ata_port
*ap
);
495 extern int ata_std_softreset(struct ata_port
*ap
, int verbose
,
496 unsigned int *classes
);
497 extern int sata_std_hardreset(struct ata_port
*ap
, int verbose
,
498 unsigned int *class);
499 extern void ata_std_postreset(struct ata_port
*ap
, unsigned int *classes
);
500 extern int ata_dev_revalidate(struct ata_port
*ap
, struct ata_device
*dev
,
502 extern void ata_port_disable(struct ata_port
*);
503 extern void ata_std_ports(struct ata_ioports
*ioaddr
);
505 extern int ata_pci_init_one (struct pci_dev
*pdev
, struct ata_port_info
**port_info
,
506 unsigned int n_ports
);
507 extern void ata_pci_remove_one (struct pci_dev
*pdev
);
508 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t state
);
509 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
510 extern int ata_pci_clear_simplex(struct pci_dev
*pdev
);
511 #endif /* CONFIG_PCI */
512 extern int ata_device_add(const struct ata_probe_ent
*ent
);
513 extern void ata_host_set_remove(struct ata_host_set
*host_set
);
514 extern int ata_scsi_detect(struct scsi_host_template
*sht
);
515 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
516 extern int ata_scsi_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*));
517 extern int ata_scsi_error(struct Scsi_Host
*host
);
518 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
519 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
520 extern int ata_scsi_release(struct Scsi_Host
*host
);
521 extern unsigned int ata_host_intr(struct ata_port
*ap
, struct ata_queued_cmd
*qc
);
522 extern int ata_scsi_device_resume(struct scsi_device
*);
523 extern int ata_scsi_device_suspend(struct scsi_device
*, pm_message_t state
);
524 extern int ata_device_resume(struct ata_port
*, struct ata_device
*);
525 extern int ata_device_suspend(struct ata_port
*, struct ata_device
*, pm_message_t state
);
526 extern int ata_ratelimit(void);
527 extern unsigned int ata_busy_sleep(struct ata_port
*ap
,
528 unsigned long timeout_pat
,
529 unsigned long timeout
);
530 extern void ata_port_queue_task(struct ata_port
*ap
, void (*fn
)(void *),
531 void *data
, unsigned long delay
);
534 * Default driver ops implementations
536 extern void ata_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
537 extern void ata_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
538 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
, u8
*fis
, u8 pmp
);
539 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
540 extern void ata_noop_dev_select (struct ata_port
*ap
, unsigned int device
);
541 extern void ata_std_dev_select (struct ata_port
*ap
, unsigned int device
);
542 extern u8
ata_check_status(struct ata_port
*ap
);
543 extern u8
ata_altstatus(struct ata_port
*ap
);
544 extern void ata_exec_command(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
545 extern int ata_std_probe_reset(struct ata_port
*ap
, unsigned int *classes
);
546 extern int ata_port_start (struct ata_port
*ap
);
547 extern void ata_port_stop (struct ata_port
*ap
);
548 extern void ata_host_stop (struct ata_host_set
*host_set
);
549 extern irqreturn_t
ata_interrupt (int irq
, void *dev_instance
, struct pt_regs
*regs
);
550 extern void ata_qc_prep(struct ata_queued_cmd
*qc
);
551 extern void ata_noop_qc_prep(struct ata_queued_cmd
*qc
);
552 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd
*qc
);
553 extern void ata_sg_init_one(struct ata_queued_cmd
*qc
, void *buf
,
554 unsigned int buflen
);
555 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
556 unsigned int n_elem
);
557 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
558 extern void ata_id_string(const u16
*id
, unsigned char *s
,
559 unsigned int ofs
, unsigned int len
);
560 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
561 unsigned int ofs
, unsigned int len
);
562 extern void ata_bmdma_setup (struct ata_queued_cmd
*qc
);
563 extern void ata_bmdma_start (struct ata_queued_cmd
*qc
);
564 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
565 extern u8
ata_bmdma_status(struct ata_port
*ap
);
566 extern void ata_bmdma_irq_clear(struct ata_port
*ap
);
567 extern void __ata_qc_complete(struct ata_queued_cmd
*qc
);
568 extern void ata_eng_timeout(struct ata_port
*ap
);
569 extern void ata_scsi_simulate(struct ata_port
*ap
, struct ata_device
*dev
,
570 struct scsi_cmnd
*cmd
,
571 void (*done
)(struct scsi_cmnd
*));
572 extern int ata_std_bios_param(struct scsi_device
*sdev
,
573 struct block_device
*bdev
,
574 sector_t capacity
, int geom
[]);
575 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
576 extern struct ata_device
*ata_dev_pair(struct ata_port
*ap
,
577 struct ata_device
*adev
);
583 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
584 extern int ata_timing_compute(struct ata_device
*, unsigned short,
585 struct ata_timing
*, int, int);
586 extern void ata_timing_merge(const struct ata_timing
*,
587 const struct ata_timing
*, struct ata_timing
*,
591 ATA_TIMING_SETUP
= (1 << 0),
592 ATA_TIMING_ACT8B
= (1 << 1),
593 ATA_TIMING_REC8B
= (1 << 2),
594 ATA_TIMING_CYC8B
= (1 << 3),
595 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
597 ATA_TIMING_ACTIVE
= (1 << 4),
598 ATA_TIMING_RECOVER
= (1 << 5),
599 ATA_TIMING_CYCLE
= (1 << 6),
600 ATA_TIMING_UDMA
= (1 << 7),
601 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
602 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
603 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
604 ATA_TIMING_CYCLE
| ATA_TIMING_UDMA
,
610 unsigned int reg
; /* PCI config register to read */
611 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
616 extern void ata_pci_host_stop (struct ata_host_set
*host_set
);
617 extern struct ata_probe_ent
*
618 ata_pci_init_native_mode(struct pci_dev
*pdev
, struct ata_port_info
**port
, int portmask
);
619 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
620 extern unsigned long ata_pci_default_filter(const struct ata_port
*, struct ata_device
*, unsigned long);
621 #endif /* CONFIG_PCI */
625 ata_sg_is_last(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
627 if (sg
== &qc
->pad_sgent
)
631 if (((sg
- qc
->__sg
) + 1) == qc
->n_elem
)
636 static inline struct scatterlist
*
637 ata_qc_first_sg(struct ata_queued_cmd
*qc
)
642 return &qc
->pad_sgent
;
646 static inline struct scatterlist
*
647 ata_qc_next_sg(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
649 if (sg
== &qc
->pad_sgent
)
651 if (++sg
- qc
->__sg
< qc
->n_elem
)
654 return &qc
->pad_sgent
;
658 #define ata_for_each_sg(sg, qc) \
659 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
661 static inline unsigned int ata_tag_valid(unsigned int tag
)
663 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
666 static inline unsigned int ata_class_present(unsigned int class)
668 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
;
671 static inline unsigned int ata_dev_present(const struct ata_device
*dev
)
673 return ata_class_present(dev
->class);
676 static inline u8
ata_chk_status(struct ata_port
*ap
)
678 return ap
->ops
->check_status(ap
);
683 * ata_pause - Flush writes and pause 400 nanoseconds.
684 * @ap: Port to wait for.
687 * Inherited from caller.
690 static inline void ata_pause(struct ata_port
*ap
)
698 * ata_busy_wait - Wait for a port status register
699 * @ap: Port to wait for.
701 * Waits up to max*10 microseconds for the selected bits in the port's
702 * status register to be cleared.
703 * Returns final value of status register.
706 * Inherited from caller.
709 static inline u8
ata_busy_wait(struct ata_port
*ap
, unsigned int bits
,
716 status
= ata_chk_status(ap
);
718 } while ((status
& bits
) && (max
> 0));
725 * ata_wait_idle - Wait for a port to be idle.
726 * @ap: Port to wait for.
728 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
729 * Returns final value of status register.
732 * Inherited from caller.
735 static inline u8
ata_wait_idle(struct ata_port
*ap
)
737 u8 status
= ata_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
739 if (status
& (ATA_BUSY
| ATA_DRQ
)) {
740 unsigned long l
= ap
->ioaddr
.status_addr
;
741 if (ata_msg_warn(ap
))
742 printk(KERN_WARNING
"ATA: abnormal status 0x%X on port 0x%lX\n",
749 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
751 qc
->tf
.ctl
|= ATA_NIEN
;
754 static inline struct ata_queued_cmd
*ata_qc_from_tag (struct ata_port
*ap
,
757 if (likely(ata_tag_valid(tag
)))
758 return &ap
->qcmd
[tag
];
762 static inline void ata_tf_init(struct ata_port
*ap
, struct ata_taskfile
*tf
, unsigned int device
)
764 memset(tf
, 0, sizeof(*tf
));
768 tf
->device
= ATA_DEVICE_OBS
;
770 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
773 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
777 qc
->cursect
= qc
->cursg
= qc
->cursg_ofs
= 0;
779 qc
->nbytes
= qc
->curbytes
= 0;
782 ata_tf_init(qc
->ap
, &qc
->tf
, qc
->dev
->devno
);
786 * ata_qc_complete - Complete an active ATA command
787 * @qc: Command to complete
788 * @err_mask: ATA Status register contents
790 * Indicate to the mid and upper layers that an ATA
791 * command has completed, with either an ok or not-ok status.
794 * spin_lock_irqsave(host_set lock)
796 static inline void ata_qc_complete(struct ata_queued_cmd
*qc
)
798 if (unlikely(qc
->flags
& ATA_QCFLAG_EH_SCHEDULED
))
801 __ata_qc_complete(qc
);
805 * ata_irq_on - Enable interrupts on a port.
806 * @ap: Port on which interrupts are enabled.
808 * Enable interrupts on a legacy IDE device using MMIO or PIO,
809 * wait for idle, clear any pending interrupts.
812 * Inherited from caller.
815 static inline u8
ata_irq_on(struct ata_port
*ap
)
817 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
820 ap
->ctl
&= ~ATA_NIEN
;
821 ap
->last_ctl
= ap
->ctl
;
823 if (ap
->flags
& ATA_FLAG_MMIO
)
824 writeb(ap
->ctl
, (void __iomem
*) ioaddr
->ctl_addr
);
826 outb(ap
->ctl
, ioaddr
->ctl_addr
);
827 tmp
= ata_wait_idle(ap
);
829 ap
->ops
->irq_clear(ap
);
836 * ata_irq_ack - Acknowledge a device interrupt.
837 * @ap: Port on which interrupts are enabled.
839 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
840 * or BUSY+DRQ clear). Obtain dma status and port status from
841 * device. Clear the interrupt. Return port status.
846 static inline u8
ata_irq_ack(struct ata_port
*ap
, unsigned int chk_drq
)
848 unsigned int bits
= chk_drq
? ATA_BUSY
| ATA_DRQ
: ATA_BUSY
;
849 u8 host_stat
, post_stat
, status
;
851 status
= ata_busy_wait(ap
, bits
, 1000);
854 printk(KERN_ERR
"abnormal status 0x%X\n", status
);
856 /* get controller status; clear intr, err bits */
857 if (ap
->flags
& ATA_FLAG_MMIO
) {
858 void __iomem
*mmio
= (void __iomem
*) ap
->ioaddr
.bmdma_addr
;
859 host_stat
= readb(mmio
+ ATA_DMA_STATUS
);
860 writeb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
861 mmio
+ ATA_DMA_STATUS
);
863 post_stat
= readb(mmio
+ ATA_DMA_STATUS
);
865 host_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
866 outb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
867 ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
869 post_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
872 if (ata_msg_intr(ap
))
873 printk(KERN_INFO
"%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
875 host_stat
, post_stat
, status
);
880 static inline u32
scr_read(struct ata_port
*ap
, unsigned int reg
)
882 return ap
->ops
->scr_read(ap
, reg
);
885 static inline void scr_write(struct ata_port
*ap
, unsigned int reg
, u32 val
)
887 ap
->ops
->scr_write(ap
, reg
, val
);
890 static inline void scr_write_flush(struct ata_port
*ap
, unsigned int reg
,
893 ap
->ops
->scr_write(ap
, reg
, val
);
894 (void) ap
->ops
->scr_read(ap
, reg
);
897 static inline unsigned int sata_dev_present(struct ata_port
*ap
)
899 return ((scr_read(ap
, SCR_STATUS
) & 0xf) == 0x3) ? 1 : 0;
902 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
904 return ata_id_wcache_enabled(dev
->id
) ||
905 ata_id_has_flush(dev
->id
) ||
906 ata_id_has_flush_ext(dev
->id
);
909 static inline unsigned int ac_err_mask(u8 status
)
911 if (status
& ATA_BUSY
)
913 if (status
& (ATA_ERR
| ATA_DF
))
918 static inline unsigned int __ac_err_mask(u8 status
)
920 unsigned int mask
= ac_err_mask(status
);
926 static inline int ata_pad_alloc(struct ata_port
*ap
, struct device
*dev
)
929 ap
->pad
= dma_alloc_coherent(dev
, ATA_DMA_PAD_BUF_SZ
,
930 &ap
->pad_dma
, GFP_KERNEL
);
931 return (ap
->pad
== NULL
) ? -ENOMEM
: 0;
934 static inline void ata_pad_free(struct ata_port
*ap
, struct device
*dev
)
936 dma_free_coherent(dev
, ATA_DMA_PAD_BUF_SZ
, ap
->pad
, ap
->pad_dma
);
939 #endif /* __LINUX_LIBATA_H__ */