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