xref: /freebsd/sys/dev/pci/isa_pci.c (revision 17aab35a77a1b1bf02fc85bb8ffadccb0ca5006d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1994,1995 Stefan Esser, Wolfgang StanglMeier
5  * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
6  * Copyright (c) 2000 BSDi
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #include <sys/cdefs.h>
34 /*
35  * PCI:ISA bridge support
36  */
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
42 #include <sys/bus.h>
43 
44 #include <isa/isavar.h>
45 #include <dev/pci/pcivar.h>
46 #include <dev/pci/pcireg.h>
47 
48 #include <machine/bus.h>
49 #include <sys/rman.h>
50 #include <machine/resource.h>
51 
52 static int	isab_pci_probe(device_t dev);
53 static int	isab_pci_attach(device_t dev);
54 static struct resource *	isab_pci_alloc_resource(device_t dev,
55     device_t child, int type, int *rid, rman_res_t start, rman_res_t end,
56     rman_res_t count, u_int flags);
57 static int	isab_pci_release_resource(device_t dev, device_t child,
58     struct resource *r);
59 
60 static device_method_t isab_methods[] = {
61     /* Device interface */
62     DEVMETHOD(device_probe,		isab_pci_probe),
63     DEVMETHOD(device_attach,		isab_pci_attach),
64     DEVMETHOD(device_detach,		bus_generic_detach),
65     DEVMETHOD(device_shutdown,		bus_generic_shutdown),
66     DEVMETHOD(device_suspend,		bus_generic_suspend),
67     DEVMETHOD(device_resume,		bus_generic_resume),
68 
69     /* Bus interface */
70     DEVMETHOD(bus_add_child,		bus_generic_add_child),
71     DEVMETHOD(bus_alloc_resource,	isab_pci_alloc_resource),
72     DEVMETHOD(bus_release_resource,	isab_pci_release_resource),
73     DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
74     DEVMETHOD(bus_deactivate_resource,	bus_generic_deactivate_resource),
75     DEVMETHOD(bus_setup_intr,		bus_generic_setup_intr),
76     DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
77 
78     DEVMETHOD_END
79 };
80 
81 struct isab_pci_resource {
82 	struct resource	*ip_res;
83 	int	ip_refs;
84 };
85 
86 struct isab_pci_softc {
87 	struct isab_pci_resource isab_pci_res[PCIR_MAX_BAR_0 + 1];
88 };
89 
90 static driver_t isab_driver = {
91     "isab",
92     isab_methods,
93     sizeof(struct isab_pci_softc),
94 };
95 
96 DRIVER_MODULE(isab, pci, isab_driver, 0, 0);
97 
98 /*
99  * XXX we need to add a quirk list here for bridges that don't correctly
100  *     report themselves.
101  */
102 static int
103 isab_pci_probe(device_t dev)
104 {
105     int		matched = 0;
106 
107     /*
108      * Try for a generic match based on class/subclass.
109      */
110     if ((pci_get_class(dev) == PCIC_BRIDGE) &&
111 	(pci_get_subclass(dev) == PCIS_BRIDGE_ISA)) {
112 	matched = 1;
113     } else {
114 	/*
115 	 * These are devices that we *know* are PCI:ISA bridges.
116 	 * Sometimes, however, they don't report themselves as
117 	 * such.  Check in case one of them is pretending to be
118 	 * something else.
119 	 */
120 	switch (pci_get_devid(dev)) {
121 	case 0x04848086:	/* Intel 82378ZB/82378IB */
122 	case 0x122e8086:	/* Intel 82371FB */
123 	case 0x70008086:	/* Intel 82371SB */
124 	case 0x71108086:	/* Intel 82371AB */
125 	case 0x71988086:	/* Intel 82443MX */
126 	case 0x24108086:	/* Intel 82801AA (ICH) */
127 	case 0x24208086:	/* Intel 82801AB (ICH0) */
128 	case 0x24408086:	/* Intel 82801AB (ICH2) */
129 	case 0x00061004:	/* VLSI 82C593 */
130 	case 0x05861106:	/* VIA 82C586 */
131 	case 0x05961106:	/* VIA 82C596 */
132 	case 0x06861106:	/* VIA 82C686 */
133 	case 0x153310b9:	/* AcerLabs M1533 */
134 	case 0x154310b9:	/* AcerLabs M1543 */
135 	case 0x00081039:	/* SiS 85c503 */
136 	case 0x00001078:	/* Cyrix Cx5510 */
137 	case 0x01001078:	/* Cyrix Cx5530 */
138 	case 0xc7001045:	/* OPTi 82C700 (FireStar) */
139 	case 0x886a1060:	/* UMC UM8886 ISA */
140 	case 0x02001166:	/* ServerWorks IB6566 PCI */
141 	    if (bootverbose)
142 		printf("PCI-ISA bridge with incorrect subclass 0x%x\n",
143 		       pci_get_subclass(dev));
144 	    matched = 1;
145 	    break;
146 
147 	default:
148 	    break;
149 	}
150     }
151 
152     if (matched) {
153 	device_set_desc(dev, "PCI-ISA bridge");
154 	return(-10000);
155     }
156     return(ENXIO);
157 }
158 
159 static int
160 isab_pci_attach(device_t dev)
161 {
162 
163 	bus_identify_children(dev);
164 	return (isab_attach(dev));
165 }
166 
167 static struct resource *
168 isab_pci_alloc_resource(device_t dev, device_t child, int type, int *rid,
169     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
170 {
171 	struct isab_pci_softc *sc;
172 	int bar;
173 
174 	if (device_get_parent(child) != dev)
175 		return bus_generic_alloc_resource(dev, child, type, rid, start,
176 		    end, count, flags);
177 
178 	switch (type) {
179 	case SYS_RES_MEMORY:
180 	case SYS_RES_IOPORT:
181 		/*
182 		 * For BARs, we cache the resource so that we only allocate it
183 		 * from the PCI bus once.
184 		 */
185 		bar = PCI_RID2BAR(*rid);
186 		if (bar < 0 || bar > PCIR_MAX_BAR_0)
187 			return (NULL);
188 		sc = device_get_softc(dev);
189 		if (sc->isab_pci_res[bar].ip_res == NULL)
190 			sc->isab_pci_res[bar].ip_res = bus_alloc_resource(dev, type,
191 			    rid, start, end, count, flags);
192 		if (sc->isab_pci_res[bar].ip_res != NULL)
193 			sc->isab_pci_res[bar].ip_refs++;
194 		return (sc->isab_pci_res[bar].ip_res);
195 	}
196 
197 	return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child, type, rid,
198 		start, end, count, flags));
199 }
200 
201 static int
202 isab_pci_release_resource(device_t dev, device_t child, struct resource *r)
203 {
204 	struct isab_pci_softc *sc;
205 	int bar, error;
206 
207 	if (device_get_parent(child) != dev)
208 		return bus_generic_release_resource(dev, child, r);
209 
210 	switch (rman_get_type(r)) {
211 	case SYS_RES_MEMORY:
212 	case SYS_RES_IOPORT:
213 		/*
214 		 * For BARs, we release the resource from the PCI bus
215 		 * when the last child reference goes away.
216 		 */
217 		bar = PCI_RID2BAR(rman_get_rid(r));
218 		if (bar < 0 || bar > PCIR_MAX_BAR_0)
219 			return (EINVAL);
220 		sc = device_get_softc(dev);
221 		if (sc->isab_pci_res[bar].ip_res == NULL)
222 			return (EINVAL);
223 		KASSERT(sc->isab_pci_res[bar].ip_res == r,
224 		    ("isa_pci resource mismatch"));
225 		if (sc->isab_pci_res[bar].ip_refs > 1) {
226 			sc->isab_pci_res[bar].ip_refs--;
227 			return (0);
228 		}
229 		KASSERT(sc->isab_pci_res[bar].ip_refs > 0,
230 		    ("isa_pci resource reference count underflow"));
231 		error = bus_release_resource(dev, r);
232 		if (error == 0) {
233 			sc->isab_pci_res[bar].ip_res = NULL;
234 			sc->isab_pci_res[bar].ip_refs = 0;
235 		}
236 		return (error);
237 	}
238 
239 	return (bus_generic_release_resource(dev, child, r));
240 }
241