xref: /freebsd/sys/dev/cardbus/cardbus.c (revision 1b833d535b9ce1789dca84d8bd15d22e1ed58d46)
1 /*-
2  * Copyright (c) 2003-2008 M. Warner Losh.  All Rights Reserved.
3  * Copyright (c) 2000,2001 Jonathan Chen.  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 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/malloc.h>
33 #include <sys/module.h>
34 #include <sys/kernel.h>
35 #include <sys/sysctl.h>
36 
37 #include <sys/bus.h>
38 #include <machine/bus.h>
39 #include <sys/rman.h>
40 #include <machine/resource.h>
41 
42 #include <sys/pciio.h>
43 #include <dev/pci/pcivar.h>
44 #include <dev/pci/pcireg.h>
45 #include <dev/pci/pci_private.h>
46 
47 #include <dev/cardbus/cardbusreg.h>
48 #include <dev/cardbus/cardbusvar.h>
49 #include <dev/cardbus/cardbus_cis.h>
50 #include <dev/pccard/pccard_cis.h>
51 #include <dev/pccard/pccardvar.h>
52 
53 #include "power_if.h"
54 #include "pcib_if.h"
55 
56 /* sysctl vars */
57 static SYSCTL_NODE(_hw, OID_AUTO, cardbus, CTLFLAG_RD, 0, "CardBus parameters");
58 
59 int    cardbus_debug = 0;
60 SYSCTL_INT(_hw_cardbus, OID_AUTO, debug, CTLFLAG_RWTUN,
61     &cardbus_debug, 0, "CardBus debug");
62 
63 int    cardbus_cis_debug = 0;
64 SYSCTL_INT(_hw_cardbus, OID_AUTO, cis_debug, CTLFLAG_RWTUN,
65     &cardbus_cis_debug, 0, "CardBus CIS debug");
66 
67 #define	DPRINTF(a) if (cardbus_debug) printf a
68 #define	DEVPRINTF(x) if (cardbus_debug) device_printf x
69 
70 static int	cardbus_attach(device_t cbdev);
71 static int	cardbus_attach_card(device_t cbdev);
72 static int	cardbus_detach(device_t cbdev);
73 static int	cardbus_detach_card(device_t cbdev);
74 static void	cardbus_device_setup_regs(pcicfgregs *cfg);
75 static void	cardbus_driver_added(device_t cbdev, driver_t *driver);
76 static int	cardbus_probe(device_t cbdev);
77 static int	cardbus_read_ivar(device_t cbdev, device_t child, int which,
78 		    uintptr_t *result);
79 
80 /************************************************************************/
81 /* Probe/Attach								*/
82 /************************************************************************/
83 
84 static int
85 cardbus_probe(device_t cbdev)
86 {
87 	device_set_desc(cbdev, "CardBus bus");
88 	return (0);
89 }
90 
91 static int
92 cardbus_attach(device_t cbdev)
93 {
94 	struct cardbus_softc *sc;
95 #ifdef PCI_RES_BUS
96 	int rid;
97 #endif
98 
99 	sc = device_get_softc(cbdev);
100 	sc->sc_dev = cbdev;
101 #ifdef PCI_RES_BUS
102 	rid = 0;
103 	sc->sc_bus = bus_alloc_resource(cbdev, PCI_RES_BUS, &rid,
104 	    pcib_get_bus(cbdev), pcib_get_bus(cbdev), 1, 0);
105 	if (sc->sc_bus == NULL) {
106 		device_printf(cbdev, "failed to allocate bus number\n");
107 		return (ENXIO);
108 	}
109 #endif
110 	return (0);
111 }
112 
113 static int
114 cardbus_detach(device_t cbdev)
115 {
116 #ifdef PCI_RES_BUS
117 	struct cardbus_softc *sc;
118 #endif
119 
120 	cardbus_detach_card(cbdev);
121 #ifdef PCI_RES_BUS
122 	sc = device_get_softc(cbdev);
123 	(void)bus_release_resource(cbdev, PCI_RES_BUS, 0, sc->sc_bus);
124 #endif
125 	return (0);
126 }
127 
128 static int
129 cardbus_suspend(device_t self)
130 {
131 
132 	cardbus_detach_card(self);
133 	return (0);
134 }
135 
136 static int
137 cardbus_resume(device_t self)
138 {
139 
140 	return (0);
141 }
142 
143 /************************************************************************/
144 /* Attach/Detach card							*/
145 /************************************************************************/
146 
147 static void
148 cardbus_device_setup_regs(pcicfgregs *cfg)
149 {
150 	device_t dev = cfg->dev;
151 	int i;
152 
153 	/*
154 	 * Some cards power up with garbage in their BARs.  This
155 	 * code clears all that junk out.
156 	 */
157 	for (i = 0; i < PCIR_MAX_BAR_0; i++)
158 		pci_write_config(dev, PCIR_BAR(i), 0, 4);
159 
160 	cfg->intline =
161 	    pci_get_irq(device_get_parent(device_get_parent(dev)));
162 	pci_write_config(dev, PCIR_INTLINE, cfg->intline, 1);
163 	pci_write_config(dev, PCIR_CACHELNSZ, 0x08, 1);
164 	pci_write_config(dev, PCIR_LATTIMER, 0xa8, 1);
165 	pci_write_config(dev, PCIR_MINGNT, 0x14, 1);
166 	pci_write_config(dev, PCIR_MAXLAT, 0x14, 1);
167 }
168 
169 static int
170 cardbus_attach_card(device_t cbdev)
171 {
172 	device_t brdev = device_get_parent(cbdev);
173 	device_t child;
174 	int bus, domain, slot, func;
175 	int cardattached = 0;
176 	int cardbusfunchigh = 0;
177 	struct cardbus_softc *sc;
178 
179 	sc = device_get_softc(cbdev);
180 	cardbus_detach_card(cbdev); /* detach existing cards */
181 	POWER_ENABLE_SOCKET(brdev, cbdev);
182 	domain = pcib_get_domain(cbdev);
183 	bus = pcib_get_bus(cbdev);
184 	slot = 0;
185 	/* For each function, set it up and try to attach a driver to it */
186 	for (func = 0; func <= cardbusfunchigh; func++) {
187 		struct cardbus_devinfo *dinfo;
188 
189 		dinfo = (struct cardbus_devinfo *)
190 		    pci_read_device(brdev, domain, bus, slot, func,
191 			sizeof(struct cardbus_devinfo));
192 		if (dinfo == NULL)
193 			continue;
194 		if (dinfo->pci.cfg.mfdev)
195 			cardbusfunchigh = PCI_FUNCMAX;
196 
197 		child = device_add_child(cbdev, NULL, -1);
198 		if (child == NULL) {
199 			DEVPRINTF((cbdev, "Cannot add child!\n"));
200 			pci_freecfg((struct pci_devinfo *)dinfo);
201 			continue;
202 		}
203 		dinfo->pci.cfg.dev = child;
204 		resource_list_init(&dinfo->pci.resources);
205 		device_set_ivars(child, dinfo);
206 		cardbus_device_create(sc, dinfo, cbdev, child);
207 		if (cardbus_do_cis(cbdev, child) != 0)
208 			DEVPRINTF((cbdev, "Warning: Bogus CIS ignored\n"));
209 		pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 0);
210 		pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci);
211 		cardbus_device_setup_regs(&dinfo->pci.cfg);
212 		pci_add_resources(cbdev, child, 1, dinfo->mprefetchable);
213 		pci_print_verbose(&dinfo->pci);
214 		if (device_probe_and_attach(child) == 0)
215 			cardattached++;
216 		else
217 			pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 1);
218 	}
219 	if (cardattached > 0)
220 		return (0);
221 /*	POWER_DISABLE_SOCKET(brdev, cbdev); */
222 	return (ENOENT);
223 }
224 
225 static int
226 cardbus_detach_card(device_t cbdev)
227 {
228 	int numdevs;
229 	device_t *devlist;
230 	int tmp;
231 	int err = 0;
232 
233 	if (device_get_children(cbdev, &devlist, &numdevs) != 0)
234 		return (ENOENT);
235 	if (numdevs == 0) {
236 		free(devlist, M_TEMP);
237 		return (ENOENT);
238 	}
239 
240 	for (tmp = 0; tmp < numdevs; tmp++) {
241 		struct cardbus_devinfo *dinfo = device_get_ivars(devlist[tmp]);
242 
243 		if (dinfo->pci.cfg.dev != devlist[tmp])
244 			device_printf(cbdev, "devinfo dev mismatch\n");
245 		cardbus_device_destroy(dinfo);
246 		pci_delete_child(cbdev, devlist[tmp]);
247 	}
248 	POWER_DISABLE_SOCKET(device_get_parent(cbdev), cbdev);
249 	free(devlist, M_TEMP);
250 	return (err);
251 }
252 
253 static void
254 cardbus_driver_added(device_t cbdev, driver_t *driver)
255 {
256 	int numdevs;
257 	device_t *devlist;
258 	device_t dev;
259 	int i;
260 	struct cardbus_devinfo *dinfo;
261 
262 	DEVICE_IDENTIFY(driver, cbdev);
263 	if (device_get_children(cbdev, &devlist, &numdevs) != 0)
264 		return;
265 
266 	/*
267 	 * If there are no drivers attached, but there are children,
268 	 * then power the card up.
269 	 */
270 	for (i = 0; i < numdevs; i++) {
271 		dev = devlist[i];
272 		if (device_get_state(dev) != DS_NOTPRESENT)
273 		    break;
274 	}
275 	if (i > 0 && i == numdevs)
276 		POWER_ENABLE_SOCKET(device_get_parent(cbdev), cbdev);
277 	for (i = 0; i < numdevs; i++) {
278 		dev = devlist[i];
279 		if (device_get_state(dev) != DS_NOTPRESENT)
280 			continue;
281 		dinfo = device_get_ivars(dev);
282 		pci_print_verbose(&dinfo->pci);
283 		if (bootverbose)
284 			printf("pci%d:%d:%d:%d: reprobing on driver added\n",
285 			    dinfo->pci.cfg.domain, dinfo->pci.cfg.bus,
286 			    dinfo->pci.cfg.slot, dinfo->pci.cfg.func);
287 		pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci);
288 		if (device_probe_and_attach(dev) != 0)
289 			pci_cfg_save(dev, &dinfo->pci, 1);
290 	}
291 	free(devlist, M_TEMP);
292 }
293 
294 /************************************************************************/
295 /* Other Bus Methods							*/
296 /************************************************************************/
297 
298 static int
299 cardbus_read_ivar(device_t cbdev, device_t child, int which, uintptr_t *result)
300 {
301 	struct cardbus_devinfo *dinfo;
302 	pcicfgregs *cfg;
303 
304 	dinfo = device_get_ivars(child);
305 	cfg = &dinfo->pci.cfg;
306 
307 	switch (which) {
308 	case PCI_IVAR_ETHADDR:
309 		/*
310 		 * The generic accessor doesn't deal with failure, so
311 		 * we set the return value, then return an error.
312 		 */
313 		if (dinfo->fepresent & (1 << PCCARD_TPLFE_TYPE_LAN_NID)) {
314 			*((uint8_t **) result) = dinfo->funce.lan.nid;
315 			break;
316 		}
317 		*((uint8_t **) result) = NULL;
318 		return (EINVAL);
319 	default:
320 		return (pci_read_ivar(cbdev, child, which, result));
321 	}
322 	return 0;
323 }
324 
325 static device_method_t cardbus_methods[] = {
326 	/* Device interface */
327 	DEVMETHOD(device_probe,		cardbus_probe),
328 	DEVMETHOD(device_attach,	cardbus_attach),
329 	DEVMETHOD(device_detach,	cardbus_detach),
330 	DEVMETHOD(device_suspend,	cardbus_suspend),
331 	DEVMETHOD(device_resume,	cardbus_resume),
332 
333 	/* Bus interface */
334 	DEVMETHOD(bus_get_dma_tag,	bus_generic_get_dma_tag),
335 	DEVMETHOD(bus_read_ivar,	cardbus_read_ivar),
336 	DEVMETHOD(bus_driver_added,	cardbus_driver_added),
337 
338 	/* Card Interface */
339 	DEVMETHOD(card_attach_card,	cardbus_attach_card),
340 	DEVMETHOD(card_detach_card,	cardbus_detach_card),
341 
342 	{0,0}
343 };
344 
345 DEFINE_CLASS_1(cardbus, cardbus_driver, cardbus_methods,
346     sizeof(struct cardbus_softc), pci_driver);
347 
348 static devclass_t cardbus_devclass;
349 
350 DRIVER_MODULE(cardbus, cbb, cardbus_driver, cardbus_devclass, 0, 0);
351 MODULE_VERSION(cardbus, 1);
352