xref: /freebsd/sys/isa/isavar.h (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1 /*-
2  * Copyright (c) 1998 Doug Rabson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _ISA_ISAVAR_H_
30 #define _ISA_ISAVAR_H_
31 
32 struct isa_config;
33 struct isa_pnp_id;
34 typedef void isa_config_cb(void *arg, struct isa_config *config, int enable);
35 
36 #include "isa_if.h"
37 #include <isa/pnpvar.h>
38 
39 #ifdef _KERNEL
40 
41 /*
42  * ISA devices are partially ordered to ensure that devices which are
43  * sensitive to other driver probe routines are probed first. Plug and
44  * Play devices are added after devices with speculative probes so that
45  * the legacy hardware can claim resources allowing the Plug and Play
46  * hardware to choose different resources.
47  */
48 #define ISA_ORDER_SENSITIVE	0 /* legacy sensitive hardware */
49 #define ISA_ORDER_SPECULATIVE	1 /* legacy non-sensitive hardware */
50 #define ISA_ORDER_PNP		2 /* plug-and-play hardware */
51 
52 #define	ISA_NPORT	50
53 #define	ISA_NMEM	8
54 #define	ISA_NIRQ	2
55 #define	ISA_NDRQ	2
56 
57 /*
58  * Plug and play cards can support a range of resource
59  * configurations. This structure is used by the isapnp parser to
60  * inform the isa bus about the resource possibilities of the
61  * device. Each different alternative should be supplied by calling
62  * ISA_ADD_CONFIG().
63  */
64 struct isa_range {
65 	u_int32_t		ir_start;
66 	u_int32_t		ir_end;
67 	u_int32_t		ir_size;
68 	u_int32_t		ir_align;
69 };
70 
71 struct isa_config {
72 	struct isa_range	ic_mem[ISA_NMEM];
73 	struct isa_range	ic_port[ISA_NPORT];
74 	u_int32_t		ic_irqmask[ISA_NIRQ];
75 	u_int32_t		ic_drqmask[ISA_NDRQ];
76 	int			ic_nmem;
77 	int			ic_nport;
78 	int			ic_nirq;
79 	int			ic_ndrq;
80 };
81 
82 /*
83  * Used to build lists of IDs and description strings for PnP drivers.
84  */
85 struct isa_pnp_id {
86 	u_int32_t		ip_id;
87 	const char		*ip_desc;
88 };
89 
90 enum isa_device_ivars {
91 	ISA_IVAR_PORT,
92 	ISA_IVAR_PORT_0 = ISA_IVAR_PORT,
93 	ISA_IVAR_PORT_1,
94 	ISA_IVAR_PORTSIZE,
95 	ISA_IVAR_PORTSIZE_0 = ISA_IVAR_PORTSIZE,
96 	ISA_IVAR_PORTSIZE_1,
97 	ISA_IVAR_MADDR,
98 	ISA_IVAR_MADDR_0 = ISA_IVAR_MADDR,
99 	ISA_IVAR_MADDR_1,
100 	ISA_IVAR_MSIZE,
101 	ISA_IVAR_MSIZE_0 = ISA_IVAR_MSIZE,
102 	ISA_IVAR_MSIZE_1,
103 	ISA_IVAR_IRQ,
104 	ISA_IVAR_IRQ_0 = ISA_IVAR_IRQ,
105 	ISA_IVAR_IRQ_1,
106 	ISA_IVAR_DRQ,
107 	ISA_IVAR_DRQ_0 = ISA_IVAR_DRQ,
108 	ISA_IVAR_DRQ_1,
109 	ISA_IVAR_VENDORID,
110 	ISA_IVAR_SERIAL,
111 	ISA_IVAR_LOGICALID,
112 	ISA_IVAR_COMPATID
113 };
114 
115 /*
116  * Simplified accessors for isa devices
117  */
118 #define ISA_ACCESSOR(A, B, T)						\
119 									\
120 static __inline T isa_get_ ## A(device_t dev)				\
121 {									\
122 	uintptr_t v;							\
123 	BUS_READ_IVAR(device_get_parent(dev), dev, ISA_IVAR_ ## B, &v);	\
124 	return (T) v;							\
125 }									\
126 									\
127 static __inline void isa_set_ ## A(device_t dev, T t)			\
128 {									\
129 	u_long v = (u_long) t;						\
130 	BUS_WRITE_IVAR(device_get_parent(dev), dev, ISA_IVAR_ ## B, v);	\
131 }
132 
133 ISA_ACCESSOR(port, PORT, int)
134 ISA_ACCESSOR(portsize, PORTSIZE, int)
135 ISA_ACCESSOR(irq, IRQ, int)
136 ISA_ACCESSOR(drq, DRQ, int)
137 ISA_ACCESSOR(maddr, MADDR, int)
138 ISA_ACCESSOR(msize, MSIZE, int)
139 ISA_ACCESSOR(vendorid, VENDORID, int)
140 ISA_ACCESSOR(serial, SERIAL, int)
141 ISA_ACCESSOR(logicalid, LOGICALID, int)
142 ISA_ACCESSOR(compatid, COMPATID, int)
143 
144 extern intrmask_t isa_irq_pending(void);
145 extern intrmask_t isa_irq_mask(void);
146 #ifdef __i386__
147 extern void	 isa_wrap_old_drivers(void);
148 #endif
149 extern void	isa_probe_children(device_t dev);
150 
151 extern void	isa_dmacascade __P((int chan));
152 extern void	isa_dmadone __P((int flags, caddr_t addr, int nbytes, int chan));
153 extern void	isa_dmainit __P((int chan, u_int bouncebufsize));
154 extern void	isa_dmastart __P((int flags, caddr_t addr, u_int nbytes, int chan));
155 extern int	isa_dma_acquire __P((int chan));
156 extern void	isa_dma_release __P((int chan));
157 extern int	isa_dmastatus __P((int chan));
158 extern int	isa_dmastop __P((int chan));
159 
160 #endif /* _KERNEL */
161 
162 #endif /* !_ISA_ISAVAR_H_ */
163