xref: /freebsd/sys/dev/cardbus/cardbus.c (revision 82d692771239f1d156a875087dff4cf09f0e8b80)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2000,2001 Jonathan Chen.  All rights reserved.
5  * Copyright (c) 2003-2008 M. Warner Losh <imp@FreeBSD.org>
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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/param.h>
30 #include <sys/eventhandler.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 | CTLFLAG_MPSAFE, 0,
58     "CardBus parameters");
59 
60 int    cardbus_debug = 0;
61 SYSCTL_INT(_hw_cardbus, OID_AUTO, debug, CTLFLAG_RWTUN,
62     &cardbus_debug, 0, "CardBus debug");
63 
64 int    cardbus_cis_debug = 0;
65 SYSCTL_INT(_hw_cardbus, OID_AUTO, cis_debug, CTLFLAG_RWTUN,
66     &cardbus_cis_debug, 0, "CardBus CIS debug");
67 
68 #define	DPRINTF(a) if (cardbus_debug) printf a
69 #define	DEVPRINTF(x) if (cardbus_debug) device_printf x
70 
71 static int	cardbus_attach(device_t cbdev);
72 static int	cardbus_attach_card(device_t cbdev);
73 static int	cardbus_detach(device_t cbdev);
74 static int	cardbus_detach_card(device_t cbdev);
75 static void	cardbus_device_setup_regs(pcicfgregs *cfg);
76 static void	cardbus_driver_added(device_t cbdev, driver_t *driver);
77 static int	cardbus_probe(device_t cbdev);
78 static int	cardbus_read_ivar(device_t cbdev, device_t child, int which,
79 		    uintptr_t *result);
80 
81 /************************************************************************/
82 /* Probe/Attach								*/
83 /************************************************************************/
84 
85 static int
cardbus_probe(device_t cbdev)86 cardbus_probe(device_t cbdev)
87 {
88 	device_set_desc(cbdev, "CardBus bus");
89 	return (0);
90 }
91 
92 static int
cardbus_attach(device_t cbdev)93 cardbus_attach(device_t cbdev)
94 {
95 	struct cardbus_softc *sc;
96 	int rid;
97 
98 	sc = device_get_softc(cbdev);
99 	sc->sc_dev = cbdev;
100 	rid = 0;
101 	sc->sc_bus = bus_alloc_resource(cbdev, PCI_RES_BUS, &rid,
102 	    pcib_get_bus(cbdev), pcib_get_bus(cbdev), 1, 0);
103 	if (sc->sc_bus == NULL) {
104 		device_printf(cbdev, "failed to allocate bus number\n");
105 		return (ENXIO);
106 	}
107 	return (0);
108 }
109 
110 static int
cardbus_detach(device_t cbdev)111 cardbus_detach(device_t cbdev)
112 {
113 	struct cardbus_softc *sc;
114 
115 	cardbus_detach_card(cbdev);
116 	sc = device_get_softc(cbdev);
117 	device_printf(cbdev, "Freeing up the allocatd bus\n");
118 	(void)bus_release_resource(cbdev, PCI_RES_BUS, 0, sc->sc_bus);
119 	return (0);
120 }
121 
122 static int
cardbus_suspend(device_t self)123 cardbus_suspend(device_t self)
124 {
125 
126 	cardbus_detach_card(self);
127 	return (0);
128 }
129 
130 static int
cardbus_resume(device_t self)131 cardbus_resume(device_t self)
132 {
133 
134 	return (0);
135 }
136 
137 /************************************************************************/
138 /* Attach/Detach card							*/
139 /************************************************************************/
140 
141 static void
cardbus_device_setup_regs(pcicfgregs * cfg)142 cardbus_device_setup_regs(pcicfgregs *cfg)
143 {
144 	device_t dev = cfg->dev;
145 	int i;
146 
147 	/*
148 	 * Some cards power up with garbage in their BARs.  This
149 	 * code clears all that junk out.
150 	 */
151 	for (i = 0; i < PCIR_MAX_BAR_0; i++)
152 		pci_write_config(dev, PCIR_BAR(i), 0, 4);
153 
154 	cfg->intline =
155 	    pci_get_irq(device_get_parent(device_get_parent(dev)));
156 	pci_write_config(dev, PCIR_INTLINE, cfg->intline, 1);
157 	pci_write_config(dev, PCIR_CACHELNSZ, 0x08, 1);
158 	pci_write_config(dev, PCIR_LATTIMER, 0xa8, 1);
159 	pci_write_config(dev, PCIR_MINGNT, 0x14, 1);
160 	pci_write_config(dev, PCIR_MAXLAT, 0x14, 1);
161 }
162 
163 static struct pci_devinfo *
cardbus_alloc_devinfo(device_t dev)164 cardbus_alloc_devinfo(device_t dev)
165 {
166 	struct cardbus_devinfo *dinfo;
167 
168 	dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
169 	return (&dinfo->pci);
170 }
171 
172 static int
cardbus_attach_card(device_t cbdev)173 cardbus_attach_card(device_t cbdev)
174 {
175 	device_t brdev = device_get_parent(cbdev);
176 	device_t child;
177 	int bus, domain, slot, func;
178 	int cardattached = 0;
179 	int cardbusfunchigh = 0;
180 	struct cardbus_softc *sc;
181 
182 	sc = device_get_softc(cbdev);
183 	cardbus_detach_card(cbdev); /* detach existing cards */
184 	POWER_DISABLE_SOCKET(brdev, cbdev); /* Turn the socket off first */
185 	POWER_ENABLE_SOCKET(brdev, cbdev);
186 	domain = pcib_get_domain(cbdev);
187 	bus = pcib_get_bus(cbdev);
188 	slot = 0;
189 	bus_topo_lock();
190 	/* For each function, set it up and try to attach a driver to it */
191 	for (func = 0; func <= cardbusfunchigh; func++) {
192 		struct cardbus_devinfo *dinfo;
193 
194 		dinfo = (struct cardbus_devinfo *)
195 		    pci_read_device(brdev, cbdev, domain, bus, slot, func);
196 		if (dinfo == NULL)
197 			continue;
198 		if (dinfo->pci.cfg.mfdev)
199 			cardbusfunchigh = PCI_FUNCMAX;
200 
201 		child = device_add_child(cbdev, NULL, DEVICE_UNIT_ANY);
202 		if (child == NULL) {
203 			DEVPRINTF((cbdev, "Cannot add child!\n"));
204 			pci_freecfg((struct pci_devinfo *)dinfo);
205 			continue;
206 		}
207 		dinfo->pci.cfg.dev = child;
208 		resource_list_init(&dinfo->pci.resources);
209 		device_set_ivars(child, dinfo);
210 		cardbus_device_create(sc, dinfo, cbdev, child);
211 		if (cardbus_do_cis(cbdev, child) != 0)
212 			DEVPRINTF((cbdev, "Warning: Bogus CIS ignored\n"));
213 		pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 0);
214 		pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci);
215 		pci_clear_pme(child);
216 		cardbus_device_setup_regs(&dinfo->pci.cfg);
217 		pci_add_resources(cbdev, child, 1, dinfo->mprefetchable);
218 		pci_print_verbose(&dinfo->pci);
219 		if (device_probe_and_attach(child) == 0)
220 			cardattached++;
221 		else
222 			pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 1);
223 	}
224 	bus_topo_unlock();
225 	if (cardattached > 0)
226 		return (0);
227 /*	POWER_DISABLE_SOCKET(brdev, cbdev); */
228 	return (ENOENT);
229 }
230 
231 static void
cardbus_child_deleted(device_t cbdev,device_t child)232 cardbus_child_deleted(device_t cbdev, device_t child)
233 {
234 	struct cardbus_devinfo *dinfo = device_get_ivars(child);
235 
236 	if (dinfo->pci.cfg.dev != child)
237 		device_printf(cbdev, "devinfo dev mismatch\n");
238 	cardbus_device_destroy(dinfo);
239 	pci_child_deleted(cbdev, child);
240 }
241 
242 static int
cardbus_detach_card(device_t cbdev)243 cardbus_detach_card(device_t cbdev)
244 {
245 	int err = 0;
246 
247 	bus_topo_lock();
248 	err = bus_generic_detach(cbdev);
249 	bus_topo_unlock();
250 	if (err)
251 		return (err);
252 
253 	POWER_DISABLE_SOCKET(device_get_parent(cbdev), cbdev);
254 	return (err);
255 }
256 
257 static void
cardbus_driver_added(device_t cbdev,driver_t * driver)258 cardbus_driver_added(device_t cbdev, driver_t *driver)
259 {
260 	int numdevs;
261 	device_t *devlist;
262 	device_t dev;
263 	int i;
264 	struct cardbus_devinfo *dinfo;
265 
266 	DEVICE_IDENTIFY(driver, cbdev);
267 	if (device_get_children(cbdev, &devlist, &numdevs) != 0)
268 		return;
269 
270 	/*
271 	 * If there are no drivers attached, but there are children,
272 	 * then power the card up.
273 	 */
274 	for (i = 0; i < numdevs; i++) {
275 		dev = devlist[i];
276 		if (device_get_state(dev) != DS_NOTPRESENT)
277 		    break;
278 	}
279 	if (i > 0 && i == numdevs)
280 		POWER_ENABLE_SOCKET(device_get_parent(cbdev), cbdev);
281 	for (i = 0; i < numdevs; i++) {
282 		dev = devlist[i];
283 		if (device_get_state(dev) != DS_NOTPRESENT)
284 			continue;
285 		dinfo = device_get_ivars(dev);
286 		pci_print_verbose(&dinfo->pci);
287 		if (bootverbose)
288 			printf("pci%d:%d:%d:%d: reprobing on driver added\n",
289 			    dinfo->pci.cfg.domain, dinfo->pci.cfg.bus,
290 			    dinfo->pci.cfg.slot, dinfo->pci.cfg.func);
291 		pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci);
292 		if (device_probe_and_attach(dev) != 0)
293 			pci_cfg_save(dev, &dinfo->pci, 1);
294 	}
295 	free(devlist, M_TEMP);
296 }
297 
298 /************************************************************************/
299 /* Other Bus Methods							*/
300 /************************************************************************/
301 
302 static int
cardbus_read_ivar(device_t cbdev,device_t child,int which,uintptr_t * result)303 cardbus_read_ivar(device_t cbdev, device_t child, int which, uintptr_t *result)
304 {
305 	struct cardbus_devinfo *dinfo;
306 
307 	dinfo = device_get_ivars(child);
308 
309 	switch (which) {
310 	case PCI_IVAR_ETHADDR:
311 		/*
312 		 * The generic accessor doesn't deal with failure, so
313 		 * we set the return value, then return an error.
314 		 */
315 		if (dinfo->fepresent & (1 << PCCARD_TPLFE_TYPE_LAN_NID)) {
316 			*((uint8_t **) result) = dinfo->funce.lan.nid;
317 			break;
318 		}
319 		*((uint8_t **) result) = NULL;
320 		return (EINVAL);
321 	default:
322 		return (pci_read_ivar(cbdev, child, which, result));
323 	}
324 	return 0;
325 }
326 
327 static device_method_t cardbus_methods[] = {
328 	/* Device interface */
329 	DEVMETHOD(device_probe,		cardbus_probe),
330 	DEVMETHOD(device_attach,	cardbus_attach),
331 	DEVMETHOD(device_detach,	cardbus_detach),
332 	DEVMETHOD(device_suspend,	cardbus_suspend),
333 	DEVMETHOD(device_resume,	cardbus_resume),
334 
335 	/* Bus interface */
336 	DEVMETHOD(bus_child_deleted,	cardbus_child_deleted),
337 	DEVMETHOD(bus_get_dma_tag,	bus_generic_get_dma_tag),
338 	DEVMETHOD(bus_read_ivar,	cardbus_read_ivar),
339 	DEVMETHOD(bus_driver_added,	cardbus_driver_added),
340 	DEVMETHOD(bus_rescan,		bus_null_rescan),
341 
342 	/* Card Interface */
343 	DEVMETHOD(card_attach_card,	cardbus_attach_card),
344 	DEVMETHOD(card_detach_card,	cardbus_detach_card),
345 
346 	/* PCI interface */
347 	DEVMETHOD(pci_alloc_devinfo,	cardbus_alloc_devinfo),
348 	{0,0}
349 };
350 
351 DEFINE_CLASS_1(cardbus, cardbus_driver, cardbus_methods,
352     sizeof(struct cardbus_softc), pci_driver);
353 
354 DRIVER_MODULE(cardbus, cbb, cardbus_driver, 0, 0);
355 MODULE_VERSION(cardbus, 1);
356