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