2 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
3 * Copyright (c) 2010-2011 Adrian Chadd, Xenion Pty Ltd
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer,
11 * without modification.
12 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
13 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
14 * redistribution must be conditioned upon including a substantially
15 * similar Disclaimer requirement for further binary redistribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
21 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
23 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
26 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28 * THE POSSIBILITY OF SUCH DAMAGES.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
35 * AHB bus front-end for the Atheros Wireless LAN controller driver.
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
44 #include <sys/kernel.h>
46 #include <sys/mutex.h>
47 #include <sys/errno.h>
49 #include <machine/bus.h>
50 #include <machine/resource.h>
54 #include <sys/socket.h>
57 #include <net/if_media.h>
58 #include <net/if_arp.h>
59 #include <net/ethernet.h>
61 #include <net80211/ieee80211_var.h>
63 #include <dev/ath/if_athvar.h>
65 #include <mips/atheros/ar71xxreg.h>
66 #include <mips/atheros/ar91xxreg.h>
67 #include <mips/atheros/ar71xx_cpudef.h>
73 /* number of 16 bit words */
74 #define ATH_EEPROM_DATA_SIZE 2048
76 struct ath_ahb_softc {
77 struct ath_softc sc_sc;
78 struct resource *sc_sr; /* memory resource */
79 struct resource *sc_irq; /* irq resource */
80 struct resource *sc_eeprom; /* eeprom location */
81 void *sc_ih; /* interrupt handler */
84 #define VENDOR_ATHEROS 0x168c
85 #define AR9130_DEVID 0x000b
88 ath_ahb_probe(device_t dev)
90 int vendor_id, device_id;
94 * Check if a device/vendor ID is provided in hints.
96 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
97 "vendor_id", &vendor_id) != 0) {
98 vendor_id = VENDOR_ATHEROS;
101 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
102 "device_id", &device_id) != 0) {
103 device_id = AR9130_DEVID;
106 device_printf(dev, "Vendor=0x%04x, Device=0x%04x\n",
110 /* Attempt to probe */
111 devname = ath_hal_probe(vendor_id, device_id);
113 if (devname != NULL) {
114 device_set_desc(dev, devname);
115 return BUS_PROBE_DEFAULT;
121 ath_ahb_intr(void *arg)
123 /* XXX TODO: check if its ours! */
124 ar71xx_device_flush_ddr(AR71XX_CPU_DDR_FLUSH_WMAC);
129 ath_ahb_attach(device_t dev)
131 struct ath_ahb_softc *psc = device_get_softc(dev);
132 struct ath_softc *sc = &psc->sc_sc;
138 int device_id, vendor_id;
143 psc->sc_sr = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
144 if (psc->sc_sr == NULL) {
145 device_printf(dev, "cannot map register space\n");
149 if (resource_long_value(device_get_name(dev), device_get_unit(dev),
150 "eepromaddr", &eepromaddr) != 0) {
151 device_printf(dev, "cannot fetch 'eepromaddr' from hints\n");
156 * The default EEPROM size is 2048 * 16 bit words.
157 * Later EEPROM/OTP/flash regions may be quite a bit bigger.
159 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
160 "eepromsize", &eepromsize) != 0) {
161 eepromsize = ATH_EEPROM_DATA_SIZE * 2;
165 device_printf(sc->sc_dev, "eeprom @ %p (%d bytes)\n",
166 (void *) eepromaddr, eepromsize);
168 * XXX this assumes that the parent device is the nexus
169 * and will just pass through requests for all of memory.
171 * Later on, when this has to attach off of the actual
172 * AHB, this won't work.
174 * Ideally this would be done in machdep code in mips/atheros/
175 * and it'd expose the EEPROM via the firmware interface,
176 * so the ath/ath_ahb drivers can be loaded as modules
179 psc->sc_eeprom = bus_alloc_resource(dev, SYS_RES_MEMORY,
180 &rid, (uintptr_t) eepromaddr,
181 (uintptr_t) eepromaddr + (uintptr_t) (eepromsize - 1), 0, RF_ACTIVE);
182 if (psc->sc_eeprom == NULL) {
183 device_printf(dev, "cannot map eeprom space\n");
187 sc->sc_st = (HAL_BUS_TAG) rman_get_bustag(psc->sc_sr);
188 sc->sc_sh = (HAL_BUS_HANDLE) rman_get_bushandle(psc->sc_sr);
190 * Mark device invalid so any interrupts (shared or otherwise)
191 * that arrive before the HAL is setup are discarded.
195 /* Copy the EEPROM data out */
196 sc->sc_eepromdata = malloc(eepromsize, M_TEMP, M_NOWAIT | M_ZERO);
197 if (sc->sc_eepromdata == NULL) {
198 device_printf(dev, "cannot allocate memory for eeprom data\n");
201 device_printf(sc->sc_dev, "eeprom data @ %p\n", (void *) rman_get_bushandle(psc->sc_eeprom));
202 /* XXX why doesn't this work? -adrian */
204 bus_space_read_multi_1(
205 rman_get_bustag(psc->sc_eeprom),
206 rman_get_bushandle(psc->sc_eeprom),
207 0, (u_int8_t *) sc->sc_eepromdata, eepromsize);
209 p = (void *) rman_get_bushandle(psc->sc_eeprom);
210 memcpy(sc->sc_eepromdata, p, eepromsize);
213 * Arrange interrupt line.
216 psc->sc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_SHAREABLE|RF_ACTIVE);
217 if (psc->sc_irq == NULL) {
218 device_printf(dev, "could not map interrupt\n");
221 if (bus_setup_intr(dev, psc->sc_irq,
222 INTR_TYPE_NET | INTR_MPSAFE,
223 NULL, ath_ahb_intr, sc, &psc->sc_ih)) {
224 device_printf(dev, "could not establish interrupt\n");
229 * Setup DMA descriptor area.
231 if (bus_dma_tag_create(bus_get_dma_tag(dev), /* parent */
232 1, 0, /* alignment, bounds */
233 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
234 BUS_SPACE_MAXADDR, /* highaddr */
235 NULL, NULL, /* filter, filterarg */
236 0x3ffff, /* maxsize XXX */
237 ATH_MAX_SCATTER, /* nsegments */
238 0x3ffff, /* maxsegsize XXX */
239 BUS_DMA_ALLOCNOW, /* flags */
243 device_printf(dev, "cannot allocate DMA tag\n");
248 * Check if a device/vendor ID is provided in hints.
250 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
251 "vendor_id", &vendor_id) != 0) {
252 vendor_id = VENDOR_ATHEROS;
255 if (resource_int_value(device_get_name(dev), device_get_unit(dev),
256 "device_id", &device_id) != 0) {
257 device_id = AR9130_DEVID;
261 ATH_PCU_LOCK_INIT(sc);
262 ATH_RX_LOCK_INIT(sc);
263 ATH_TX_LOCK_INIT(sc);
264 ATH_TX_IC_LOCK_INIT(sc);
265 ATH_TXSTATUS_LOCK_INIT(sc);
267 error = ath_attach(device_id, sc);
268 if (error == 0) /* success */
271 ATH_TXSTATUS_LOCK_DESTROY(sc);
272 ATH_RX_LOCK_DESTROY(sc);
273 ATH_TX_LOCK_DESTROY(sc);
274 ATH_TX_IC_LOCK_DESTROY(sc);
275 ATH_PCU_LOCK_DESTROY(sc);
276 ATH_LOCK_DESTROY(sc);
277 bus_dma_tag_destroy(sc->sc_dmat);
279 bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
281 bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
283 bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_eeprom);
285 bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_sr);
288 if (sc->sc_eepromdata)
289 free(sc->sc_eepromdata, M_TEMP);
294 ath_ahb_detach(device_t dev)
296 struct ath_ahb_softc *psc = device_get_softc(dev);
297 struct ath_softc *sc = &psc->sc_sc;
299 /* check if device was removed */
300 sc->sc_invalid = !bus_child_present(dev);
304 bus_generic_detach(dev);
305 bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
306 bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
308 bus_dma_tag_destroy(sc->sc_dmat);
309 bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_sr);
310 bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_eeprom);
312 if (sc->sc_eepromdata)
313 free(sc->sc_eepromdata, M_TEMP);
315 ATH_TXSTATUS_LOCK_DESTROY(sc);
316 ATH_RX_LOCK_DESTROY(sc);
317 ATH_TX_LOCK_DESTROY(sc);
318 ATH_TX_IC_LOCK_DESTROY(sc);
319 ATH_PCU_LOCK_DESTROY(sc);
320 ATH_LOCK_DESTROY(sc);
326 ath_ahb_shutdown(device_t dev)
328 struct ath_ahb_softc *psc = device_get_softc(dev);
330 ath_shutdown(&psc->sc_sc);
335 ath_ahb_suspend(device_t dev)
337 struct ath_ahb_softc *psc = device_get_softc(dev);
339 ath_suspend(&psc->sc_sc);
345 ath_ahb_resume(device_t dev)
347 struct ath_ahb_softc *psc = device_get_softc(dev);
349 ath_resume(&psc->sc_sc);
354 static device_method_t ath_ahb_methods[] = {
355 /* Device interface */
356 DEVMETHOD(device_probe, ath_ahb_probe),
357 DEVMETHOD(device_attach, ath_ahb_attach),
358 DEVMETHOD(device_detach, ath_ahb_detach),
359 DEVMETHOD(device_shutdown, ath_ahb_shutdown),
360 DEVMETHOD(device_suspend, ath_ahb_suspend),
361 DEVMETHOD(device_resume, ath_ahb_resume),
365 static driver_t ath_ahb_driver = {
368 sizeof (struct ath_ahb_softc)
370 static devclass_t ath_devclass;
371 DRIVER_MODULE(ath, nexus, ath_ahb_driver, ath_devclass, 0, 0);
372 DRIVER_MODULE(ath, apb, ath_ahb_driver, ath_devclass, 0, 0);
373 MODULE_VERSION(ath, 1);
374 MODULE_DEPEND(ath, wlan, 1, 1, 1); /* 802.11 media layer */
375 MODULE_DEPEND(ath, if_ath, 1, 1, 1); /* if_ath driver */