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