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 */
164 ATA_HOST_SIMPLEX
= (1 << 0), /* Host is simplex, one DMA channel per host_set only */
166 /* various lengths of time */
167 ATA_TMOUT_PIO
= 30 * HZ
,
168 ATA_TMOUT_BOOT
= 30 * HZ
, /* heuristic */
169 ATA_TMOUT_BOOT_QUICK
= 7 * HZ
, /* heuristic */
170 ATA_TMOUT_CDB
= 30 * HZ
,
171 ATA_TMOUT_CDB_QUICK
= 5 * HZ
,
172 ATA_TMOUT_INTERNAL
= 30 * HZ
,
173 ATA_TMOUT_INTERNAL_QUICK
= 5 * HZ
,
187 /* SATA port states */
192 /* encoding various smaller bitmaps into a single
193 * unsigned int bitmap
200 ATA_SHIFT_MWDMA
= ATA_SHIFT_PIO
+ ATA_BITS_PIO
,
201 ATA_SHIFT_UDMA
= ATA_SHIFT_MWDMA
+ ATA_BITS_MWDMA
,
203 ATA_MASK_PIO
= ((1 << ATA_BITS_PIO
) - 1) << ATA_SHIFT_PIO
,
204 ATA_MASK_MWDMA
= ((1 << ATA_BITS_MWDMA
) - 1) << ATA_SHIFT_MWDMA
,
205 ATA_MASK_UDMA
= ((1 << ATA_BITS_UDMA
) - 1) << ATA_SHIFT_UDMA
,
207 /* size of buffer to pad xfers ending on unaligned boundaries */
209 ATA_DMA_PAD_BUF_SZ
= ATA_DMA_PAD_SZ
* ATA_MAX_QUEUE
,
211 /* Masks for port functions */
212 ATA_PORT_PRIMARY
= (1 << 0),
213 ATA_PORT_SECONDARY
= (1 << 1),
215 /* how hard are we gonna try to probe/recover devices */
216 ATA_PROBE_MAX_TRIES
= 3,
219 enum hsm_task_states
{
230 enum ata_completion_errors
{
231 AC_ERR_DEV
= (1 << 0), /* device reported error */
232 AC_ERR_HSM
= (1 << 1), /* host state machine violation */
233 AC_ERR_TIMEOUT
= (1 << 2), /* timeout */
234 AC_ERR_MEDIA
= (1 << 3), /* media error */
235 AC_ERR_ATA_BUS
= (1 << 4), /* ATA bus error */
236 AC_ERR_HOST_BUS
= (1 << 5), /* host bus error */
237 AC_ERR_SYSTEM
= (1 << 6), /* system error */
238 AC_ERR_INVALID
= (1 << 7), /* invalid argument */
239 AC_ERR_OTHER
= (1 << 8), /* unknown */
242 /* forward declarations */
244 struct ata_port_operations
;
246 struct ata_queued_cmd
;
249 typedef void (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
);
250 typedef void (*ata_probeinit_fn_t
)(struct ata_port
*);
251 typedef int (*ata_reset_fn_t
)(struct ata_port
*, int, unsigned int *);
252 typedef void (*ata_postreset_fn_t
)(struct ata_port
*ap
, unsigned int *);
255 unsigned long cmd_addr
;
256 unsigned long data_addr
;
257 unsigned long error_addr
;
258 unsigned long feature_addr
;
259 unsigned long nsect_addr
;
260 unsigned long lbal_addr
;
261 unsigned long lbam_addr
;
262 unsigned long lbah_addr
;
263 unsigned long device_addr
;
264 unsigned long status_addr
;
265 unsigned long command_addr
;
266 unsigned long altstatus_addr
;
267 unsigned long ctl_addr
;
268 unsigned long bmdma_addr
;
269 unsigned long scr_addr
;
272 struct ata_probe_ent
{
273 struct list_head node
;
275 const struct ata_port_operations
*port_ops
;
276 struct scsi_host_template
*sht
;
277 struct ata_ioports port
[ATA_MAX_PORTS
];
278 unsigned int n_ports
;
279 unsigned int hard_port_no
;
280 unsigned int pio_mask
;
281 unsigned int mwdma_mask
;
282 unsigned int udma_mask
;
283 unsigned int legacy_mode
;
285 unsigned int irq_flags
;
286 unsigned long host_flags
;
287 unsigned long host_set_flags
;
288 void __iomem
*mmio_base
;
292 struct ata_host_set
{
296 void __iomem
*mmio_base
;
297 unsigned int n_ports
;
299 const struct ata_port_operations
*ops
;
301 int simplex_claimed
; /* Keep seperate in case we
302 ever need to do this locked */
303 struct ata_port
* ports
[0];
306 struct ata_queued_cmd
{
308 struct ata_device
*dev
;
310 struct scsi_cmnd
*scsicmd
;
311 void (*scsidone
)(struct scsi_cmnd
*);
313 struct ata_taskfile tf
;
314 u8 cdb
[ATAPI_CDB_LEN
];
316 unsigned long flags
; /* ATA_QCFLAG_xxx */
319 unsigned int orig_n_elem
;
323 unsigned int pad_len
;
326 unsigned int cursect
;
329 unsigned int curbytes
;
332 unsigned int cursg_ofs
;
334 struct scatterlist sgent
;
335 struct scatterlist pad_sgent
;
338 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
339 struct scatterlist
*__sg
;
341 unsigned int err_mask
;
343 ata_qc_cb_t complete_fn
;
348 struct ata_host_stats
{
349 unsigned long unhandled_irq
;
350 unsigned long idle_irq
;
351 unsigned long rw_reqbuf
;
355 u64 n_sectors
; /* size of device, if ATA */
356 unsigned long flags
; /* ATA_DFLAG_xxx */
357 unsigned int class; /* ATA_DEV_xxx */
358 unsigned int devno
; /* 0 or 1 */
359 u16
*id
; /* IDENTIFY xxx DEVICE data */
363 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
365 unsigned int multi_count
; /* sectors count for
366 READ/WRITE MULTIPLE */
367 unsigned int max_sectors
; /* per-device max sectors */
368 unsigned int cdb_len
;
370 /* per-dev xfer mask */
371 unsigned int pio_mask
;
372 unsigned int mwdma_mask
;
373 unsigned int udma_mask
;
375 /* for CHS addressing */
376 u16 cylinders
; /* Number of cylinders */
377 u16 heads
; /* Number of heads */
378 u16 sectors
; /* Number of sectors per track */
382 struct Scsi_Host
*host
; /* our co-allocated scsi host */
383 const struct ata_port_operations
*ops
;
384 unsigned long flags
; /* ATA_FLAG_xxx */
385 unsigned int id
; /* unique id req'd by scsi midlyr */
386 unsigned int port_no
; /* unique port #; from zero */
387 unsigned int hard_port_no
; /* hardware port #; from zero */
389 struct ata_prd
*prd
; /* our SG list */
390 dma_addr_t prd_dma
; /* and its DMA mapping */
392 void *pad
; /* array of DMA pad buffers */
395 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
397 u8 ctl
; /* cache of ATA control register */
398 u8 last_ctl
; /* Cache last written value */
399 unsigned int pio_mask
;
400 unsigned int mwdma_mask
;
401 unsigned int udma_mask
;
402 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
403 unsigned int sata_spd_limit
; /* SATA PHY speed limit */
405 struct ata_device device
[ATA_MAX_DEVICES
];
407 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
408 unsigned long qactive
;
409 unsigned int active_tag
;
411 struct ata_host_stats stats
;
412 struct ata_host_set
*host_set
;
415 struct work_struct port_task
;
417 unsigned int hsm_task_state
;
418 unsigned long pio_task_timeout
;
421 struct list_head eh_done_q
;
426 struct ata_port_operations
{
427 void (*port_disable
) (struct ata_port
*);
429 void (*dev_config
) (struct ata_port
*, struct ata_device
*);
431 void (*set_piomode
) (struct ata_port
*, struct ata_device
*);
432 void (*set_dmamode
) (struct ata_port
*, struct ata_device
*);
433 unsigned long (*mode_filter
) (const struct ata_port
*, struct ata_device
*, unsigned long);
435 void (*tf_load
) (struct ata_port
*ap
, const struct ata_taskfile
*tf
);
436 void (*tf_read
) (struct ata_port
*ap
, struct ata_taskfile
*tf
);
438 void (*exec_command
)(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
439 u8 (*check_status
)(struct ata_port
*ap
);
440 u8 (*check_altstatus
)(struct ata_port
*ap
);
441 void (*dev_select
)(struct ata_port
*ap
, unsigned int device
);
443 void (*phy_reset
) (struct ata_port
*ap
); /* obsolete */
444 void (*set_mode
) (struct ata_port
*ap
);
445 int (*probe_reset
) (struct ata_port
*ap
, unsigned int *classes
);
447 void (*post_set_mode
) (struct ata_port
*ap
);
449 int (*check_atapi_dma
) (struct ata_queued_cmd
*qc
);
451 void (*bmdma_setup
) (struct ata_queued_cmd
*qc
);
452 void (*bmdma_start
) (struct ata_queued_cmd
*qc
);
454 void (*qc_prep
) (struct ata_queued_cmd
*qc
);
455 unsigned int (*qc_issue
) (struct ata_queued_cmd
*qc
);
457 void (*eng_timeout
) (struct ata_port
*ap
);
459 irqreturn_t (*irq_handler
)(int, void *, struct pt_regs
*);
460 void (*irq_clear
) (struct ata_port
*);
462 u32 (*scr_read
) (struct ata_port
*ap
, unsigned int sc_reg
);
463 void (*scr_write
) (struct ata_port
*ap
, unsigned int sc_reg
,
466 int (*port_start
) (struct ata_port
*ap
);
467 void (*port_stop
) (struct ata_port
*ap
);
469 void (*host_stop
) (struct ata_host_set
*host_set
);
471 void (*bmdma_stop
) (struct ata_queued_cmd
*qc
);
472 u8 (*bmdma_status
) (struct ata_port
*ap
);
475 struct ata_port_info
{
476 struct scsi_host_template
*sht
;
477 unsigned long host_flags
;
478 unsigned long pio_mask
;
479 unsigned long mwdma_mask
;
480 unsigned long udma_mask
;
481 const struct ata_port_operations
*port_ops
;
486 unsigned short mode
; /* ATA mode */
487 unsigned short setup
; /* t1 */
488 unsigned short act8b
; /* t2 for 8-bit I/O */
489 unsigned short rec8b
; /* t2i for 8-bit I/O */
490 unsigned short cyc8b
; /* t0 for 8-bit I/O */
491 unsigned short active
; /* t2 or tD */
492 unsigned short recover
; /* t2i or tK */
493 unsigned short cycle
; /* t0 */
494 unsigned short udma
; /* t2CYCTYP/2 */
497 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
499 extern void ata_port_probe(struct ata_port
*);
500 extern void __sata_phy_reset(struct ata_port
*ap
);
501 extern void sata_phy_reset(struct ata_port
*ap
);
502 extern void ata_bus_reset(struct ata_port
*ap
);
503 extern int ata_drive_probe_reset(struct ata_port
*ap
,
504 ata_probeinit_fn_t probeinit
,
505 ata_reset_fn_t softreset
, ata_reset_fn_t hardreset
,
506 ata_postreset_fn_t postreset
, unsigned int *classes
);
507 extern void ata_std_probeinit(struct ata_port
*ap
);
508 extern int ata_std_softreset(struct ata_port
*ap
, int verbose
,
509 unsigned int *classes
);
510 extern int sata_std_hardreset(struct ata_port
*ap
, int verbose
,
511 unsigned int *class);
512 extern void ata_std_postreset(struct ata_port
*ap
, unsigned int *classes
);
513 extern int ata_dev_revalidate(struct ata_port
*ap
, struct ata_device
*dev
,
515 extern void ata_port_disable(struct ata_port
*);
516 extern void ata_std_ports(struct ata_ioports
*ioaddr
);
518 extern int ata_pci_init_one (struct pci_dev
*pdev
, struct ata_port_info
**port_info
,
519 unsigned int n_ports
);
520 extern void ata_pci_remove_one (struct pci_dev
*pdev
);
521 extern int ata_pci_device_suspend(struct pci_dev
*pdev
, pm_message_t state
);
522 extern int ata_pci_device_resume(struct pci_dev
*pdev
);
523 extern int ata_pci_clear_simplex(struct pci_dev
*pdev
);
524 #endif /* CONFIG_PCI */
525 extern int ata_device_add(const struct ata_probe_ent
*ent
);
526 extern void ata_host_set_remove(struct ata_host_set
*host_set
);
527 extern int ata_scsi_detect(struct scsi_host_template
*sht
);
528 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
529 extern int ata_scsi_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*));
530 extern int ata_scsi_error(struct Scsi_Host
*host
);
531 extern void ata_eh_qc_complete(struct ata_queued_cmd
*qc
);
532 extern void ata_eh_qc_retry(struct ata_queued_cmd
*qc
);
533 extern int ata_scsi_release(struct Scsi_Host
*host
);
534 extern unsigned int ata_host_intr(struct ata_port
*ap
, struct ata_queued_cmd
*qc
);
535 extern int ata_scsi_device_resume(struct scsi_device
*);
536 extern int ata_scsi_device_suspend(struct scsi_device
*, pm_message_t state
);
537 extern int ata_device_resume(struct ata_port
*, struct ata_device
*);
538 extern int ata_device_suspend(struct ata_port
*, struct ata_device
*, pm_message_t state
);
539 extern int ata_ratelimit(void);
540 extern unsigned int ata_busy_sleep(struct ata_port
*ap
,
541 unsigned long timeout_pat
,
542 unsigned long timeout
);
543 extern void ata_port_queue_task(struct ata_port
*ap
, void (*fn
)(void *),
544 void *data
, unsigned long delay
);
547 * Default driver ops implementations
549 extern void ata_tf_load(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
550 extern void ata_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
551 extern void ata_tf_to_fis(const struct ata_taskfile
*tf
, u8
*fis
, u8 pmp
);
552 extern void ata_tf_from_fis(const u8
*fis
, struct ata_taskfile
*tf
);
553 extern void ata_noop_dev_select (struct ata_port
*ap
, unsigned int device
);
554 extern void ata_std_dev_select (struct ata_port
*ap
, unsigned int device
);
555 extern u8
ata_check_status(struct ata_port
*ap
);
556 extern u8
ata_altstatus(struct ata_port
*ap
);
557 extern void ata_exec_command(struct ata_port
*ap
, const struct ata_taskfile
*tf
);
558 extern int ata_std_probe_reset(struct ata_port
*ap
, unsigned int *classes
);
559 extern int ata_port_start (struct ata_port
*ap
);
560 extern void ata_port_stop (struct ata_port
*ap
);
561 extern void ata_host_stop (struct ata_host_set
*host_set
);
562 extern irqreturn_t
ata_interrupt (int irq
, void *dev_instance
, struct pt_regs
*regs
);
563 extern void ata_qc_prep(struct ata_queued_cmd
*qc
);
564 extern void ata_noop_qc_prep(struct ata_queued_cmd
*qc
);
565 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd
*qc
);
566 extern void ata_sg_init_one(struct ata_queued_cmd
*qc
, void *buf
,
567 unsigned int buflen
);
568 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
569 unsigned int n_elem
);
570 extern unsigned int ata_dev_classify(const struct ata_taskfile
*tf
);
571 extern void ata_id_string(const u16
*id
, unsigned char *s
,
572 unsigned int ofs
, unsigned int len
);
573 extern void ata_id_c_string(const u16
*id
, unsigned char *s
,
574 unsigned int ofs
, unsigned int len
);
575 extern void ata_bmdma_setup (struct ata_queued_cmd
*qc
);
576 extern void ata_bmdma_start (struct ata_queued_cmd
*qc
);
577 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
578 extern u8
ata_bmdma_status(struct ata_port
*ap
);
579 extern void ata_bmdma_irq_clear(struct ata_port
*ap
);
580 extern void __ata_qc_complete(struct ata_queued_cmd
*qc
);
581 extern void ata_eng_timeout(struct ata_port
*ap
);
582 extern void ata_scsi_simulate(struct ata_port
*ap
, struct ata_device
*dev
,
583 struct scsi_cmnd
*cmd
,
584 void (*done
)(struct scsi_cmnd
*));
585 extern int ata_std_bios_param(struct scsi_device
*sdev
,
586 struct block_device
*bdev
,
587 sector_t capacity
, int geom
[]);
588 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
589 extern struct ata_device
*ata_dev_pair(struct ata_port
*ap
,
590 struct ata_device
*adev
);
596 extern unsigned int ata_pio_need_iordy(const struct ata_device
*);
597 extern int ata_timing_compute(struct ata_device
*, unsigned short,
598 struct ata_timing
*, int, int);
599 extern void ata_timing_merge(const struct ata_timing
*,
600 const struct ata_timing
*, struct ata_timing
*,
604 ATA_TIMING_SETUP
= (1 << 0),
605 ATA_TIMING_ACT8B
= (1 << 1),
606 ATA_TIMING_REC8B
= (1 << 2),
607 ATA_TIMING_CYC8B
= (1 << 3),
608 ATA_TIMING_8BIT
= ATA_TIMING_ACT8B
| ATA_TIMING_REC8B
|
610 ATA_TIMING_ACTIVE
= (1 << 4),
611 ATA_TIMING_RECOVER
= (1 << 5),
612 ATA_TIMING_CYCLE
= (1 << 6),
613 ATA_TIMING_UDMA
= (1 << 7),
614 ATA_TIMING_ALL
= ATA_TIMING_SETUP
| ATA_TIMING_ACT8B
|
615 ATA_TIMING_REC8B
| ATA_TIMING_CYC8B
|
616 ATA_TIMING_ACTIVE
| ATA_TIMING_RECOVER
|
617 ATA_TIMING_CYCLE
| ATA_TIMING_UDMA
,
623 unsigned int reg
; /* PCI config register to read */
624 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
629 extern void ata_pci_host_stop (struct ata_host_set
*host_set
);
630 extern struct ata_probe_ent
*
631 ata_pci_init_native_mode(struct pci_dev
*pdev
, struct ata_port_info
**port
, int portmask
);
632 extern int pci_test_config_bits(struct pci_dev
*pdev
, const struct pci_bits
*bits
);
633 extern unsigned long ata_pci_default_filter(const struct ata_port
*, struct ata_device
*, unsigned long);
634 #endif /* CONFIG_PCI */
638 ata_sg_is_last(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
640 if (sg
== &qc
->pad_sgent
)
644 if (((sg
- qc
->__sg
) + 1) == qc
->n_elem
)
649 static inline struct scatterlist
*
650 ata_qc_first_sg(struct ata_queued_cmd
*qc
)
655 return &qc
->pad_sgent
;
659 static inline struct scatterlist
*
660 ata_qc_next_sg(struct scatterlist
*sg
, struct ata_queued_cmd
*qc
)
662 if (sg
== &qc
->pad_sgent
)
664 if (++sg
- qc
->__sg
< qc
->n_elem
)
667 return &qc
->pad_sgent
;
671 #define ata_for_each_sg(sg, qc) \
672 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
674 static inline unsigned int ata_tag_valid(unsigned int tag
)
676 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
679 static inline unsigned int ata_class_enabled(unsigned int class)
681 return class == ATA_DEV_ATA
|| class == ATA_DEV_ATAPI
;
684 static inline unsigned int ata_class_disabled(unsigned int class)
686 return class == ATA_DEV_ATA_UNSUP
|| class == ATA_DEV_ATAPI_UNSUP
;
689 static inline unsigned int ata_class_absent(unsigned int class)
691 return !ata_class_enabled(class) && !ata_class_disabled(class);
694 static inline unsigned int ata_dev_enabled(const struct ata_device
*dev
)
696 return ata_class_enabled(dev
->class);
699 static inline unsigned int ata_dev_disabled(const struct ata_device
*dev
)
701 return ata_class_disabled(dev
->class);
704 static inline unsigned int ata_dev_absent(const struct ata_device
*dev
)
706 return ata_class_absent(dev
->class);
709 static inline u8
ata_chk_status(struct ata_port
*ap
)
711 return ap
->ops
->check_status(ap
);
716 * ata_pause - Flush writes and pause 400 nanoseconds.
717 * @ap: Port to wait for.
720 * Inherited from caller.
723 static inline void ata_pause(struct ata_port
*ap
)
731 * ata_busy_wait - Wait for a port status register
732 * @ap: Port to wait for.
734 * Waits up to max*10 microseconds for the selected bits in the port's
735 * status register to be cleared.
736 * Returns final value of status register.
739 * Inherited from caller.
742 static inline u8
ata_busy_wait(struct ata_port
*ap
, unsigned int bits
,
749 status
= ata_chk_status(ap
);
751 } while ((status
& bits
) && (max
> 0));
758 * ata_wait_idle - Wait for a port to be idle.
759 * @ap: Port to wait for.
761 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
762 * Returns final value of status register.
765 * Inherited from caller.
768 static inline u8
ata_wait_idle(struct ata_port
*ap
)
770 u8 status
= ata_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
772 if (status
& (ATA_BUSY
| ATA_DRQ
)) {
773 unsigned long l
= ap
->ioaddr
.status_addr
;
774 if (ata_msg_warn(ap
))
775 printk(KERN_WARNING
"ATA: abnormal status 0x%X on port 0x%lX\n",
782 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
784 qc
->tf
.ctl
|= ATA_NIEN
;
787 static inline struct ata_queued_cmd
*ata_qc_from_tag (struct ata_port
*ap
,
790 if (likely(ata_tag_valid(tag
)))
791 return &ap
->qcmd
[tag
];
795 static inline void ata_tf_init(struct ata_port
*ap
, struct ata_taskfile
*tf
, unsigned int device
)
797 memset(tf
, 0, sizeof(*tf
));
801 tf
->device
= ATA_DEVICE_OBS
;
803 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
806 static inline void ata_qc_reinit(struct ata_queued_cmd
*qc
)
810 qc
->cursect
= qc
->cursg
= qc
->cursg_ofs
= 0;
812 qc
->nbytes
= qc
->curbytes
= 0;
815 ata_tf_init(qc
->ap
, &qc
->tf
, qc
->dev
->devno
);
819 * ata_qc_complete - Complete an active ATA command
820 * @qc: Command to complete
821 * @err_mask: ATA Status register contents
823 * Indicate to the mid and upper layers that an ATA
824 * command has completed, with either an ok or not-ok status.
827 * spin_lock_irqsave(host_set lock)
829 static inline void ata_qc_complete(struct ata_queued_cmd
*qc
)
831 if (unlikely(qc
->flags
& ATA_QCFLAG_EH_SCHEDULED
))
834 __ata_qc_complete(qc
);
838 * ata_irq_on - Enable interrupts on a port.
839 * @ap: Port on which interrupts are enabled.
841 * Enable interrupts on a legacy IDE device using MMIO or PIO,
842 * wait for idle, clear any pending interrupts.
845 * Inherited from caller.
848 static inline u8
ata_irq_on(struct ata_port
*ap
)
850 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
853 ap
->ctl
&= ~ATA_NIEN
;
854 ap
->last_ctl
= ap
->ctl
;
856 if (ap
->flags
& ATA_FLAG_MMIO
)
857 writeb(ap
->ctl
, (void __iomem
*) ioaddr
->ctl_addr
);
859 outb(ap
->ctl
, ioaddr
->ctl_addr
);
860 tmp
= ata_wait_idle(ap
);
862 ap
->ops
->irq_clear(ap
);
869 * ata_irq_ack - Acknowledge a device interrupt.
870 * @ap: Port on which interrupts are enabled.
872 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
873 * or BUSY+DRQ clear). Obtain dma status and port status from
874 * device. Clear the interrupt. Return port status.
879 static inline u8
ata_irq_ack(struct ata_port
*ap
, unsigned int chk_drq
)
881 unsigned int bits
= chk_drq
? ATA_BUSY
| ATA_DRQ
: ATA_BUSY
;
882 u8 host_stat
, post_stat
, status
;
884 status
= ata_busy_wait(ap
, bits
, 1000);
887 printk(KERN_ERR
"abnormal status 0x%X\n", status
);
889 /* get controller status; clear intr, err bits */
890 if (ap
->flags
& ATA_FLAG_MMIO
) {
891 void __iomem
*mmio
= (void __iomem
*) ap
->ioaddr
.bmdma_addr
;
892 host_stat
= readb(mmio
+ ATA_DMA_STATUS
);
893 writeb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
894 mmio
+ ATA_DMA_STATUS
);
896 post_stat
= readb(mmio
+ ATA_DMA_STATUS
);
898 host_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
899 outb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
900 ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
902 post_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
905 if (ata_msg_intr(ap
))
906 printk(KERN_INFO
"%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
908 host_stat
, post_stat
, status
);
913 static inline u32
scr_read(struct ata_port
*ap
, unsigned int reg
)
915 return ap
->ops
->scr_read(ap
, reg
);
918 static inline void scr_write(struct ata_port
*ap
, unsigned int reg
, u32 val
)
920 ap
->ops
->scr_write(ap
, reg
, val
);
923 static inline void scr_write_flush(struct ata_port
*ap
, unsigned int reg
,
926 ap
->ops
->scr_write(ap
, reg
, val
);
927 (void) ap
->ops
->scr_read(ap
, reg
);
930 static inline unsigned int sata_dev_present(struct ata_port
*ap
)
932 return ((scr_read(ap
, SCR_STATUS
) & 0xf) == 0x3) ? 1 : 0;
935 static inline int ata_try_flush_cache(const struct ata_device
*dev
)
937 return ata_id_wcache_enabled(dev
->id
) ||
938 ata_id_has_flush(dev
->id
) ||
939 ata_id_has_flush_ext(dev
->id
);
942 static inline unsigned int ac_err_mask(u8 status
)
944 if (status
& ATA_BUSY
)
946 if (status
& (ATA_ERR
| ATA_DF
))
951 static inline unsigned int __ac_err_mask(u8 status
)
953 unsigned int mask
= ac_err_mask(status
);
959 static inline int ata_pad_alloc(struct ata_port
*ap
, struct device
*dev
)
962 ap
->pad
= dma_alloc_coherent(dev
, ATA_DMA_PAD_BUF_SZ
,
963 &ap
->pad_dma
, GFP_KERNEL
);
964 return (ap
->pad
== NULL
) ? -ENOMEM
: 0;
967 static inline void ata_pad_free(struct ata_port
*ap
, struct device
*dev
)
969 dma_free_coherent(dev
, ATA_DMA_PAD_BUF_SZ
, ap
->pad
, ap
->pad_dma
);
972 #endif /* __LINUX_LIBATA_H__ */