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