xref: /dragonfly/sys/bus/isa/isavar.h (revision 6b5c5d0d)
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: src/sys/isa/isavar.h,v 1.16.2.2 2000/10/29 13:07:56 nyan Exp $
27  * $DragonFly: src/sys/bus/isa/isavar.h,v 1.9 2006/04/30 17:22:15 dillon Exp $
28  */
29 
30 #ifndef _ISA_ISAVAR_H_
31 #define _ISA_ISAVAR_H_
32 
33 struct buf;
34 struct isa_config;
35 struct isa_pnp_id;
36 
37 typedef void isa_config_cb(void *arg, struct isa_config *config, int enable);
38 
39 #include "isa_if.h"
40 #include "pnpvar.h"
41 
42 #ifdef _KERNEL
43 
44 /*
45  * ISA devices are partially ordered to ensure that devices which are
46  * sensitive to other driver probe routines are probed first. Plug and
47  * Play devices are added after devices with speculative probes so that
48  * the legacy hardware can claim resources allowing the Plug and Play
49  * hardware to choose different resources.
50  */
51 #define ISA_ORDER_SENSITIVE	0 /* legacy sensitive hardware */
52 #define ISA_ORDER_SPECULATIVE	1 /* legacy non-sensitive hardware */
53 #define ISA_ORDER_PNP		2 /* plug-and-play hardware */
54 
55 #define	ISA_NPORT	50
56 #define	ISA_NMEM	8
57 #define	ISA_NIRQ	2
58 #define	ISA_NDRQ	2
59 
60 #define ISADMA_READ     0x00000001
61 #define ISADMA_WRITE    0x00000002
62 #define ISADMA_RAW      0x00000004
63 
64 /*
65  * Plug and play cards can support a range of resource
66  * configurations. This structure is used by the isapnp parser to
67  * inform the isa bus about the resource possibilities of the
68  * device. Each different alternative should be supplied by calling
69  * ISA_ADD_CONFIG().
70  */
71 struct isa_range {
72 	u_int32_t		ir_start;
73 	u_int32_t		ir_end;
74 	u_int32_t		ir_size;
75 	u_int32_t		ir_align;
76 };
77 
78 struct isa_config {
79 	struct isa_range	ic_mem[ISA_NMEM];
80 	struct isa_range	ic_port[ISA_NPORT];
81 	u_int32_t		ic_irqmask[ISA_NIRQ];
82 	u_int32_t		ic_drqmask[ISA_NDRQ];
83 	int			ic_nmem;
84 	int			ic_nport;
85 	int			ic_nirq;
86 	int			ic_ndrq;
87 };
88 
89 /*
90  * Used to build lists of IDs and description strings for PnP drivers.
91  */
92 struct isa_pnp_id {
93 	u_int32_t		ip_id;
94 	const char		*ip_desc;
95 };
96 
97 enum isa_device_ivars {
98 	ISA_IVAR_PORT,
99 	ISA_IVAR_PORT_0 = ISA_IVAR_PORT,
100 	ISA_IVAR_PORT_1,
101 	ISA_IVAR_PORTSIZE,
102 	ISA_IVAR_PORTSIZE_0 = ISA_IVAR_PORTSIZE,
103 	ISA_IVAR_PORTSIZE_1,
104 	ISA_IVAR_MADDR,
105 	ISA_IVAR_MADDR_0 = ISA_IVAR_MADDR,
106 	ISA_IVAR_MADDR_1,
107 	ISA_IVAR_MSIZE,
108 	ISA_IVAR_MSIZE_0 = ISA_IVAR_MSIZE,
109 	ISA_IVAR_MSIZE_1,
110 	ISA_IVAR_IRQ,
111 	ISA_IVAR_IRQ_0 = ISA_IVAR_IRQ,
112 	ISA_IVAR_IRQ_1,
113 	ISA_IVAR_DRQ,
114 	ISA_IVAR_DRQ_0 = ISA_IVAR_DRQ,
115 	ISA_IVAR_DRQ_1,
116 	ISA_IVAR_VENDORID,
117 	ISA_IVAR_SERIAL,
118 	ISA_IVAR_LOGICALID,
119 	ISA_IVAR_COMPATID,
120 	ISA_IVAR_CONFIGATTR
121 };
122 
123 /*
124  * ISA_IVAR_CONFIGATTR bits
125  */
126 #define ISACFGATTR_CANDISABLE	(1 << 0)	/* can be disabled */
127 #define ISACFGATTR_DYNAMIC	(1 << 1)	/* dynamic configuration */
128 #define ISACFGATTR_MULTI	(1 << 2)	/* multiple configurations */
129 
130 /*
131  * Simplified accessors for isa devices
132  */
133 #define ISA_ACCESSOR(A, B, T)						\
134 									\
135 static __inline T isa_get_ ## A(device_t dev)				\
136 {									\
137 	uintptr_t v;							\
138 	BUS_READ_IVAR(device_get_parent(dev), dev, ISA_IVAR_ ## B, &v);	\
139 	return (T) v;							\
140 }									\
141 									\
142 static __inline void isa_set_ ## A(device_t dev, T t)			\
143 {									\
144 	u_long v = (u_long) t;						\
145 	BUS_WRITE_IVAR(device_get_parent(dev), dev, ISA_IVAR_ ## B, v);	\
146 }
147 
148 ISA_ACCESSOR(port, PORT, int)
149 ISA_ACCESSOR(portsize, PORTSIZE, int)
150 ISA_ACCESSOR(irq, IRQ, int)
151 ISA_ACCESSOR(drq, DRQ, int)
152 ISA_ACCESSOR(maddr, MADDR, int)
153 ISA_ACCESSOR(msize, MSIZE, int)
154 ISA_ACCESSOR(vendorid, VENDORID, int)
155 ISA_ACCESSOR(serial, SERIAL, int)
156 ISA_ACCESSOR(logicalid, LOGICALID, int)
157 ISA_ACCESSOR(compatid, COMPATID, int)
158 ISA_ACCESSOR(configattr, CONFIGATTR, int)
159 
160 /* Device class for ISA bridges. */
161 extern devclass_t isab_devclass;
162 
163 extern intrmask_t isa_irq_pending(void);
164 extern intrmask_t isa_irq_mask(void);
165 #ifdef __i386__
166 extern void	 isa_wrap_old_drivers(void);
167 #endif
168 extern void	isa_probe_children(device_t dev);
169 
170 extern void	isa_dmacascade (int chan);
171 extern void	isa_dmadone (int flags, caddr_t addr, int nbytes, int chan);
172 extern void	isa_dmainit (int chan, u_int bouncebufsize);
173 extern void	isa_dmastart (int flags, caddr_t addr, u_int nbytes, int chan);
174 extern int	isa_dma_acquire (int chan);
175 extern void	isa_dma_release (int chan);
176 extern int	isa_dmastatus (int chan);
177 extern int	isa_dmastop (int chan);
178 unsigned isa_dmabp (struct buf *);
179 
180 int isab_attach(device_t dev);
181 
182 #endif /* _KERNEL */
183 
184 #endif /* !_ISA_ISAVAR_H_ */
185