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>
33 #include <linux/ata.h>
34 #include <linux/workqueue.h>
37 * compile-time options
39 #undef ATA_DEBUG /* debugging output */
40 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
41 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
42 #undef ATA_NDEBUG /* define to disable quick runtime checks */
43 #undef ATA_ENABLE_PATA /* define to enable PATA support in some
44 * low-level drivers */
45 #undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */
48 /* note: prints function name for you */
50 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
51 #ifdef ATA_VERBOSE_DEBUG
52 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
54 #define VPRINTK(fmt, args...)
55 #endif /* ATA_VERBOSE_DEBUG */
57 #define DPRINTK(fmt, args...)
58 #define VPRINTK(fmt, args...)
59 #endif /* ATA_DEBUG */
64 #define assert(expr) \
65 if(unlikely(!(expr))) { \
66 printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \
67 #expr,__FILE__,__FUNCTION__,__LINE__); \
71 /* defines only for the constants which don't work well as enums */
72 #define ATA_TAG_POISON 0xfafbfcfdU
74 /* move to PCI layer? */
75 static inline struct device
*pci_dev_to_dev(struct pci_dev
*pdev
)
81 /* various global constants */
82 LIBATA_MAX_PRD
= ATA_MAX_PRD
/ 2,
86 ATA_MAX_SECTORS
= 200, /* FIXME */
88 ATA_DEF_BUSY_WAIT
= 10000,
89 ATA_SHORT_PAUSE
= (HZ
>> 6) + 1,
92 ATA_SHT_CMD_PER_LUN
= 1,
94 ATA_SHT_USE_CLUSTERING
= 0,
96 /* struct ata_device stuff */
97 ATA_DFLAG_LBA48
= (1 << 0), /* device supports LBA48 */
98 ATA_DFLAG_PIO
= (1 << 1), /* device currently in PIO mode */
99 ATA_DFLAG_LOCK_SECTORS
= (1 << 2), /* don't adjust max_sectors */
100 ATA_DFLAG_LBA
= (1 << 3), /* device supports LBA */
102 ATA_DEV_UNKNOWN
= 0, /* unknown device */
103 ATA_DEV_ATA
= 1, /* ATA device */
104 ATA_DEV_ATA_UNSUP
= 2, /* ATA device (unsupported) */
105 ATA_DEV_ATAPI
= 3, /* ATAPI device */
106 ATA_DEV_ATAPI_UNSUP
= 4, /* ATAPI device (unsupported) */
107 ATA_DEV_NONE
= 5, /* no device */
109 /* struct ata_port flags */
110 ATA_FLAG_SLAVE_POSS
= (1 << 1), /* host supports slave dev */
111 /* (doesn't imply presence) */
112 ATA_FLAG_PORT_DISABLED
= (1 << 2), /* port is disabled, ignore it */
113 ATA_FLAG_SATA
= (1 << 3),
114 ATA_FLAG_NO_LEGACY
= (1 << 4), /* no legacy mode check */
115 ATA_FLAG_SRST
= (1 << 5), /* use ATA SRST, not E.D.D. */
116 ATA_FLAG_MMIO
= (1 << 6), /* use MMIO, not PIO */
117 ATA_FLAG_SATA_RESET
= (1 << 7), /* use COMRESET */
118 ATA_FLAG_PIO_DMA
= (1 << 8), /* PIO cmds via DMA */
119 ATA_FLAG_NOINTR
= (1 << 9), /* FIXME: Remove this once
120 * proper HSM is in place. */
122 ATA_QCFLAG_ACTIVE
= (1 << 1), /* cmd not yet ack'd to scsi lyer */
123 ATA_QCFLAG_SG
= (1 << 3), /* have s/g table? */
124 ATA_QCFLAG_SINGLE
= (1 << 4), /* no s/g, just a single buffer */
125 ATA_QCFLAG_DMAMAP
= ATA_QCFLAG_SG
| ATA_QCFLAG_SINGLE
,
127 /* various lengths of time */
128 ATA_TMOUT_EDD
= 5 * HZ
, /* hueristic */
129 ATA_TMOUT_PIO
= 30 * HZ
,
130 ATA_TMOUT_BOOT
= 30 * HZ
, /* hueristic */
131 ATA_TMOUT_BOOT_QUICK
= 7 * HZ
, /* hueristic */
132 ATA_TMOUT_CDB
= 30 * HZ
,
133 ATA_TMOUT_CDB_QUICK
= 5 * HZ
,
147 /* SATA port states */
152 /* encoding various smaller bitmaps into a single
153 * unsigned long bitmap
159 /* Masks for port functions */
160 ATA_PORT_PRIMARY
= (1 << 0),
161 ATA_PORT_SECONDARY
= (1 << 1),
164 enum hsm_task_states
{
175 /* forward declarations */
177 struct ata_port_operations
;
179 struct ata_queued_cmd
;
182 typedef int (*ata_qc_cb_t
) (struct ata_queued_cmd
*qc
, u8 drv_stat
);
185 unsigned long cmd_addr
;
186 unsigned long data_addr
;
187 unsigned long error_addr
;
188 unsigned long feature_addr
;
189 unsigned long nsect_addr
;
190 unsigned long lbal_addr
;
191 unsigned long lbam_addr
;
192 unsigned long lbah_addr
;
193 unsigned long device_addr
;
194 unsigned long status_addr
;
195 unsigned long command_addr
;
196 unsigned long altstatus_addr
;
197 unsigned long ctl_addr
;
198 unsigned long bmdma_addr
;
199 unsigned long scr_addr
;
202 struct ata_probe_ent
{
203 struct list_head node
;
205 struct ata_port_operations
*port_ops
;
206 Scsi_Host_Template
*sht
;
207 struct ata_ioports port
[ATA_MAX_PORTS
];
208 unsigned int n_ports
;
209 unsigned int hard_port_no
;
210 unsigned int pio_mask
;
211 unsigned int mwdma_mask
;
212 unsigned int udma_mask
;
213 unsigned int legacy_mode
;
215 unsigned int irq_flags
;
216 unsigned long host_flags
;
217 void __iomem
*mmio_base
;
221 struct ata_host_set
{
225 void __iomem
*mmio_base
;
226 unsigned int n_ports
;
228 struct ata_port_operations
*ops
;
229 struct ata_port
* ports
[0];
232 struct ata_queued_cmd
{
234 struct ata_device
*dev
;
236 struct scsi_cmnd
*scsicmd
;
237 void (*scsidone
)(struct scsi_cmnd
*);
239 struct ata_taskfile tf
;
240 u8 cdb
[ATAPI_CDB_LEN
];
242 unsigned long flags
; /* ATA_QCFLAG_xxx */
249 unsigned int cursect
;
252 unsigned int curbytes
;
255 unsigned int cursg_ofs
;
257 struct scatterlist sgent
;
260 struct scatterlist
*sg
;
262 ata_qc_cb_t complete_fn
;
264 struct completion
*waiting
;
269 struct ata_host_stats
{
270 unsigned long unhandled_irq
;
271 unsigned long idle_irq
;
272 unsigned long rw_reqbuf
;
276 u64 n_sectors
; /* size of device, if ATA */
277 unsigned long flags
; /* ATA_DFLAG_xxx */
278 unsigned int class; /* ATA_DEV_xxx */
279 unsigned int devno
; /* 0 or 1 */
280 u16 id
[ATA_ID_WORDS
]; /* IDENTIFY xxx DEVICE data */
284 unsigned int xfer_shift
; /* ATA_SHIFT_xxx */
286 /* cache info about current transfer mode */
287 u8 xfer_protocol
; /* taskfile xfer protocol */
288 u8 read_cmd
; /* opcode to use on read */
289 u8 write_cmd
; /* opcode to use on write */
291 /* for CHS addressing */
292 u16 cylinders
; /* Number of cylinders */
293 u16 heads
; /* Number of heads */
294 u16 sectors
; /* Number of sectors per track */
298 struct Scsi_Host
*host
; /* our co-allocated scsi host */
299 struct ata_port_operations
*ops
;
300 unsigned long flags
; /* ATA_FLAG_xxx */
301 unsigned int id
; /* unique id req'd by scsi midlyr */
302 unsigned int port_no
; /* unique port #; from zero */
303 unsigned int hard_port_no
; /* hardware port #; from zero */
305 struct ata_prd
*prd
; /* our SG list */
306 dma_addr_t prd_dma
; /* and its DMA mapping */
308 struct ata_ioports ioaddr
; /* ATA cmd/ctl/dma register blocks */
310 u8 ctl
; /* cache of ATA control register */
311 u8 last_ctl
; /* Cache last written value */
312 unsigned int bus_state
;
313 unsigned int port_state
;
314 unsigned int pio_mask
;
315 unsigned int mwdma_mask
;
316 unsigned int udma_mask
;
317 unsigned int cbl
; /* cable type; ATA_CBL_xxx */
318 unsigned int cdb_len
;
320 struct ata_device device
[ATA_MAX_DEVICES
];
322 struct ata_queued_cmd qcmd
[ATA_MAX_QUEUE
];
323 unsigned long qactive
;
324 unsigned int active_tag
;
326 struct ata_host_stats stats
;
327 struct ata_host_set
*host_set
;
329 struct work_struct packet_task
;
331 struct work_struct pio_task
;
332 unsigned int hsm_task_state
;
333 unsigned long pio_task_timeout
;
338 struct ata_port_operations
{
339 void (*port_disable
) (struct ata_port
*);
341 void (*dev_config
) (struct ata_port
*, struct ata_device
*);
343 void (*set_piomode
) (struct ata_port
*, struct ata_device
*);
344 void (*set_dmamode
) (struct ata_port
*, struct ata_device
*);
346 void (*tf_load
) (struct ata_port
*ap
, struct ata_taskfile
*tf
);
347 void (*tf_read
) (struct ata_port
*ap
, struct ata_taskfile
*tf
);
349 void (*exec_command
)(struct ata_port
*ap
, struct ata_taskfile
*tf
);
350 u8 (*check_status
)(struct ata_port
*ap
);
351 u8 (*check_altstatus
)(struct ata_port
*ap
);
352 u8 (*check_err
)(struct ata_port
*ap
);
353 void (*dev_select
)(struct ata_port
*ap
, unsigned int device
);
355 void (*phy_reset
) (struct ata_port
*ap
);
356 void (*post_set_mode
) (struct ata_port
*ap
);
358 int (*check_atapi_dma
) (struct ata_queued_cmd
*qc
);
360 void (*bmdma_setup
) (struct ata_queued_cmd
*qc
);
361 void (*bmdma_start
) (struct ata_queued_cmd
*qc
);
363 void (*qc_prep
) (struct ata_queued_cmd
*qc
);
364 int (*qc_issue
) (struct ata_queued_cmd
*qc
);
366 void (*eng_timeout
) (struct ata_port
*ap
);
368 irqreturn_t (*irq_handler
)(int, void *, struct pt_regs
*);
369 void (*irq_clear
) (struct ata_port
*);
371 u32 (*scr_read
) (struct ata_port
*ap
, unsigned int sc_reg
);
372 void (*scr_write
) (struct ata_port
*ap
, unsigned int sc_reg
,
375 int (*port_start
) (struct ata_port
*ap
);
376 void (*port_stop
) (struct ata_port
*ap
);
378 void (*host_stop
) (struct ata_host_set
*host_set
);
380 void (*bmdma_stop
) (struct ata_queued_cmd
*qc
);
381 u8 (*bmdma_status
) (struct ata_port
*ap
);
384 struct ata_port_info
{
385 Scsi_Host_Template
*sht
;
386 unsigned long host_flags
;
387 unsigned long pio_mask
;
388 unsigned long mwdma_mask
;
389 unsigned long udma_mask
;
390 struct ata_port_operations
*port_ops
;
394 extern void ata_port_probe(struct ata_port
*);
395 extern void __sata_phy_reset(struct ata_port
*ap
);
396 extern void sata_phy_reset(struct ata_port
*ap
);
397 extern void ata_bus_reset(struct ata_port
*ap
);
398 extern void ata_port_disable(struct ata_port
*);
399 extern void ata_std_ports(struct ata_ioports
*ioaddr
);
401 extern int ata_pci_init_one (struct pci_dev
*pdev
, struct ata_port_info
**port_info
,
402 unsigned int n_ports
);
403 extern void ata_pci_remove_one (struct pci_dev
*pdev
);
404 #endif /* CONFIG_PCI */
405 extern int ata_device_add(struct ata_probe_ent
*ent
);
406 extern void ata_host_set_remove(struct ata_host_set
*host_set
);
407 extern int ata_scsi_detect(Scsi_Host_Template
*sht
);
408 extern int ata_scsi_ioctl(struct scsi_device
*dev
, int cmd
, void __user
*arg
);
409 extern int ata_scsi_queuecmd(struct scsi_cmnd
*cmd
, void (*done
)(struct scsi_cmnd
*));
410 extern int ata_scsi_error(struct Scsi_Host
*host
);
411 extern int ata_scsi_release(struct Scsi_Host
*host
);
412 extern unsigned int ata_host_intr(struct ata_port
*ap
, struct ata_queued_cmd
*qc
);
414 * Default driver ops implementations
416 extern void ata_tf_load(struct ata_port
*ap
, struct ata_taskfile
*tf
);
417 extern void ata_tf_read(struct ata_port
*ap
, struct ata_taskfile
*tf
);
418 extern void ata_tf_to_fis(struct ata_taskfile
*tf
, u8
*fis
, u8 pmp
);
419 extern void ata_tf_from_fis(u8
*fis
, struct ata_taskfile
*tf
);
420 extern void ata_noop_dev_select (struct ata_port
*ap
, unsigned int device
);
421 extern void ata_std_dev_select (struct ata_port
*ap
, unsigned int device
);
422 extern u8
ata_check_status(struct ata_port
*ap
);
423 extern u8
ata_altstatus(struct ata_port
*ap
);
424 extern u8
ata_chk_err(struct ata_port
*ap
);
425 extern void ata_exec_command(struct ata_port
*ap
, struct ata_taskfile
*tf
);
426 extern int ata_port_start (struct ata_port
*ap
);
427 extern void ata_port_stop (struct ata_port
*ap
);
428 extern void ata_host_stop (struct ata_host_set
*host_set
);
429 extern irqreturn_t
ata_interrupt (int irq
, void *dev_instance
, struct pt_regs
*regs
);
430 extern void ata_qc_prep(struct ata_queued_cmd
*qc
);
431 extern int ata_qc_issue_prot(struct ata_queued_cmd
*qc
);
432 extern void ata_sg_init_one(struct ata_queued_cmd
*qc
, void *buf
,
433 unsigned int buflen
);
434 extern void ata_sg_init(struct ata_queued_cmd
*qc
, struct scatterlist
*sg
,
435 unsigned int n_elem
);
436 extern unsigned int ata_dev_classify(struct ata_taskfile
*tf
);
437 extern void ata_dev_id_string(u16
*id
, unsigned char *s
,
438 unsigned int ofs
, unsigned int len
);
439 extern void ata_dev_config(struct ata_port
*ap
, unsigned int i
);
440 extern void ata_bmdma_setup (struct ata_queued_cmd
*qc
);
441 extern void ata_bmdma_start (struct ata_queued_cmd
*qc
);
442 extern void ata_bmdma_stop(struct ata_queued_cmd
*qc
);
443 extern u8
ata_bmdma_status(struct ata_port
*ap
);
444 extern void ata_bmdma_irq_clear(struct ata_port
*ap
);
445 extern void ata_qc_complete(struct ata_queued_cmd
*qc
, u8 drv_stat
);
446 extern void ata_eng_timeout(struct ata_port
*ap
);
447 extern void ata_scsi_simulate(u16
*id
, struct scsi_cmnd
*cmd
,
448 void (*done
)(struct scsi_cmnd
*));
449 extern int ata_std_bios_param(struct scsi_device
*sdev
,
450 struct block_device
*bdev
,
451 sector_t capacity
, int geom
[]);
452 extern int ata_scsi_slave_config(struct scsi_device
*sdev
);
457 unsigned int reg
; /* PCI config register to read */
458 unsigned int width
; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
463 extern void ata_pci_host_stop (struct ata_host_set
*host_set
);
464 extern struct ata_probe_ent
*
465 ata_pci_init_native_mode(struct pci_dev
*pdev
, struct ata_port_info
**port
, int portmask
);
466 extern int pci_test_config_bits(struct pci_dev
*pdev
, struct pci_bits
*bits
);
468 #endif /* CONFIG_PCI */
471 static inline unsigned int ata_tag_valid(unsigned int tag
)
473 return (tag
< ATA_MAX_QUEUE
) ? 1 : 0;
476 static inline unsigned int ata_dev_present(struct ata_device
*dev
)
478 return ((dev
->class == ATA_DEV_ATA
) ||
479 (dev
->class == ATA_DEV_ATAPI
));
482 static inline u8
ata_chk_status(struct ata_port
*ap
)
484 return ap
->ops
->check_status(ap
);
489 * ata_pause - Flush writes and pause 400 nanoseconds.
490 * @ap: Port to wait for.
493 * Inherited from caller.
496 static inline void ata_pause(struct ata_port
*ap
)
504 * ata_busy_wait - Wait for a port status register
505 * @ap: Port to wait for.
507 * Waits up to max*10 microseconds for the selected bits in the port's
508 * status register to be cleared.
509 * Returns final value of status register.
512 * Inherited from caller.
515 static inline u8
ata_busy_wait(struct ata_port
*ap
, unsigned int bits
,
522 status
= ata_chk_status(ap
);
524 } while ((status
& bits
) && (max
> 0));
531 * ata_wait_idle - Wait for a port to be idle.
532 * @ap: Port to wait for.
534 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
535 * Returns final value of status register.
538 * Inherited from caller.
541 static inline u8
ata_wait_idle(struct ata_port
*ap
)
543 u8 status
= ata_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
545 if (status
& (ATA_BUSY
| ATA_DRQ
)) {
546 unsigned long l
= ap
->ioaddr
.status_addr
;
548 "ATA: abnormal status 0x%X on port 0x%lX\n",
555 static inline void ata_qc_set_polling(struct ata_queued_cmd
*qc
)
557 qc
->tf
.ctl
|= ATA_NIEN
;
560 static inline struct ata_queued_cmd
*ata_qc_from_tag (struct ata_port
*ap
,
563 if (likely(ata_tag_valid(tag
)))
564 return &ap
->qcmd
[tag
];
568 static inline void ata_tf_init(struct ata_port
*ap
, struct ata_taskfile
*tf
, unsigned int device
)
570 memset(tf
, 0, sizeof(*tf
));
574 tf
->device
= ATA_DEVICE_OBS
;
576 tf
->device
= ATA_DEVICE_OBS
| ATA_DEV1
;
581 * ata_irq_on - Enable interrupts on a port.
582 * @ap: Port on which interrupts are enabled.
584 * Enable interrupts on a legacy IDE device using MMIO or PIO,
585 * wait for idle, clear any pending interrupts.
588 * Inherited from caller.
591 static inline u8
ata_irq_on(struct ata_port
*ap
)
593 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
596 ap
->ctl
&= ~ATA_NIEN
;
597 ap
->last_ctl
= ap
->ctl
;
599 if (ap
->flags
& ATA_FLAG_MMIO
)
600 writeb(ap
->ctl
, (void __iomem
*) ioaddr
->ctl_addr
);
602 outb(ap
->ctl
, ioaddr
->ctl_addr
);
603 tmp
= ata_wait_idle(ap
);
605 ap
->ops
->irq_clear(ap
);
612 * ata_irq_ack - Acknowledge a device interrupt.
613 * @ap: Port on which interrupts are enabled.
615 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
616 * or BUSY+DRQ clear). Obtain dma status and port status from
617 * device. Clear the interrupt. Return port status.
622 static inline u8
ata_irq_ack(struct ata_port
*ap
, unsigned int chk_drq
)
624 unsigned int bits
= chk_drq
? ATA_BUSY
| ATA_DRQ
: ATA_BUSY
;
625 u8 host_stat
, post_stat
, status
;
627 status
= ata_busy_wait(ap
, bits
, 1000);
629 DPRINTK("abnormal status 0x%X\n", status
);
631 /* get controller status; clear intr, err bits */
632 if (ap
->flags
& ATA_FLAG_MMIO
) {
633 void __iomem
*mmio
= (void __iomem
*) ap
->ioaddr
.bmdma_addr
;
634 host_stat
= readb(mmio
+ ATA_DMA_STATUS
);
635 writeb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
636 mmio
+ ATA_DMA_STATUS
);
638 post_stat
= readb(mmio
+ ATA_DMA_STATUS
);
640 host_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
641 outb(host_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
,
642 ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
644 post_stat
= inb(ap
->ioaddr
.bmdma_addr
+ ATA_DMA_STATUS
);
647 VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
648 host_stat
, post_stat
, status
);
653 static inline u32
scr_read(struct ata_port
*ap
, unsigned int reg
)
655 return ap
->ops
->scr_read(ap
, reg
);
658 static inline void scr_write(struct ata_port
*ap
, unsigned int reg
, u32 val
)
660 ap
->ops
->scr_write(ap
, reg
, val
);
663 static inline void scr_write_flush(struct ata_port
*ap
, unsigned int reg
,
666 ap
->ops
->scr_write(ap
, reg
, val
);
667 (void) ap
->ops
->scr_read(ap
, reg
);
670 static inline unsigned int sata_dev_present(struct ata_port
*ap
)
672 return ((scr_read(ap
, SCR_STATUS
) & 0xf) == 0x3) ? 1 : 0;
675 static inline int ata_try_flush_cache(struct ata_device
*dev
)
677 return ata_id_wcache_enabled(dev
->id
) ||
678 ata_id_has_flush(dev
->id
) ||
679 ata_id_has_flush_ext(dev
->id
);
682 #endif /* __LINUX_LIBATA_H__ */