LINT build test. Aggregated source code adjustments to bring most of the
[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.2 2003/06/17 04:28:40 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 <isa/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 };
118
119 /*
120  * Simplified accessors for isa devices
121  */
122 #define ISA_ACCESSOR(A, B, T)                                           \
123                                                                         \
124 static __inline T isa_get_ ## A(device_t dev)                           \
125 {                                                                       \
126         uintptr_t v;                                                    \
127         BUS_READ_IVAR(device_get_parent(dev), dev, ISA_IVAR_ ## B, &v); \
128         return (T) v;                                                   \
129 }                                                                       \
130                                                                         \
131 static __inline void isa_set_ ## A(device_t dev, T t)                   \
132 {                                                                       \
133         u_long v = (u_long) t;                                          \
134         BUS_WRITE_IVAR(device_get_parent(dev), dev, ISA_IVAR_ ## B, v); \
135 }
136
137 ISA_ACCESSOR(port, PORT, int)
138 ISA_ACCESSOR(portsize, PORTSIZE, int)
139 ISA_ACCESSOR(irq, IRQ, int)
140 ISA_ACCESSOR(drq, DRQ, int)
141 ISA_ACCESSOR(maddr, MADDR, int)
142 ISA_ACCESSOR(msize, MSIZE, int)
143 ISA_ACCESSOR(vendorid, VENDORID, int)
144 ISA_ACCESSOR(serial, SERIAL, int)
145 ISA_ACCESSOR(logicalid, LOGICALID, int)
146 ISA_ACCESSOR(compatid, COMPATID, int)
147
148 extern intrmask_t isa_irq_pending(void);
149 extern intrmask_t isa_irq_mask(void);
150 #ifdef __i386__
151 extern void      isa_wrap_old_drivers(void);
152 #endif
153 extern void     isa_probe_children(device_t dev);
154
155 extern void     isa_dmacascade __P((int chan));
156 extern void     isa_dmadone __P((int flags, caddr_t addr, int nbytes, int chan));
157 extern void     isa_dmainit __P((int chan, u_int bouncebufsize));
158 extern void     isa_dmastart __P((int flags, caddr_t addr, u_int nbytes, int chan));
159 extern int      isa_dma_acquire __P((int chan));
160 extern void     isa_dma_release __P((int chan));
161 extern int      isa_dmastatus __P((int chan));
162 extern int      isa_dmastop __P((int chan));
163
164 #ifdef PC98
165 #include <machine/bus.h>
166
167 /*
168  * Allocate discontinuous resources for ISA bus.
169  */
170 struct resource *
171 isa_alloc_resourcev(device_t child, int type, int *rid,
172                     bus_addr_t *res, bus_size_t count, u_int flags);
173 int
174 isa_load_resourcev(struct resource *re, bus_addr_t *res, bus_size_t count);
175 #endif
176
177 #endif /* _KERNEL */
178
179 #endif /* !_ISA_ISAVAR_H_ */