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