1 /* $NetBSD: if_ath_pci.c,v 1.39 2011/01/26 00:08:30 dyoung Exp $ */ 2 3 /*- 4 * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting 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 * without modification. 13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 14 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 15 * redistribution must be conditioned upon including a substantially 16 * similar Disclaimer requirement for further binary redistribution. 17 * 3. Neither the names of the above-listed copyright holders nor the names 18 * of any contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * Alternatively, this software may be distributed under the terms of the 22 * GNU General Public License ("GPL") version 2 as published by the Free 23 * Software Foundation. 24 * 25 * NO WARRANTY 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 28 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 29 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 30 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 31 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 34 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 36 * THE POSSIBILITY OF SUCH DAMAGES. 37 */ 38 39 #include <sys/cdefs.h> 40 __KERNEL_RCSID(0, "$NetBSD: if_ath_pci.c,v 1.39 2011/01/26 00:08:30 dyoung Exp $"); 41 42 /* 43 * PCI/Cardbus front-end for the Atheros Wireless LAN controller driver. 44 */ 45 46 #include <sys/param.h> 47 #include <sys/systm.h> 48 #include <sys/kernel.h> 49 #include <sys/errno.h> 50 #include <sys/device.h> 51 52 #include <external/isc/atheros_hal/dist/ah.h> 53 54 #include <dev/ic/ath_netbsd.h> 55 #include <dev/ic/athvar.h> 56 57 #include <dev/pci/pcivar.h> 58 #include <dev/pci/pcireg.h> 59 #include <dev/pci/pcidevs.h> 60 61 /* 62 * PCI configuration space registers 63 */ 64 #define ATH_PCI_MMBA 0x10 /* memory mapped base */ 65 66 struct ath_pci_softc { 67 struct ath_softc sc_sc; 68 pci_chipset_tag_t sc_pc; 69 pcitag_t sc_tag; 70 pci_intr_handle_t sc_pih; 71 void *sc_ih; 72 bus_space_tag_t sc_iot; 73 bus_space_handle_t sc_ioh; 74 bus_size_t sc_mapsz; 75 }; 76 77 static void ath_pci_attach(device_t, device_t, void *); 78 static int ath_pci_detach(device_t, int); 79 static int ath_pci_match(device_t, cfdata_t, void *); 80 static bool ath_pci_setup(struct ath_pci_softc *); 81 82 CFATTACH_DECL_NEW(ath_pci, sizeof(struct ath_pci_softc), 83 ath_pci_match, ath_pci_attach, ath_pci_detach, NULL); 84 85 static int 86 ath_pci_match(device_t parent, cfdata_t match, void *aux) 87 { 88 const char *devname; 89 struct pci_attach_args *pa = aux; 90 91 devname = ath_hal_probe(PCI_VENDOR(pa->pa_id), PCI_PRODUCT(pa->pa_id)); 92 return (devname != NULL) ? 1 : 0; 93 } 94 95 static bool 96 ath_pci_suspend(device_t self, const pmf_qual_t *qual) 97 { 98 struct ath_pci_softc *sc = device_private(self); 99 100 ath_suspend(&sc->sc_sc); 101 if (sc->sc_ih != NULL) { 102 pci_intr_disestablish(sc->sc_pc, sc->sc_ih); 103 sc->sc_ih = NULL; 104 } 105 return true; 106 } 107 108 static bool 109 ath_pci_resume(device_t self, const pmf_qual_t *qual) 110 { 111 struct ath_pci_softc *sc = device_private(self); 112 113 sc->sc_ih = pci_intr_establish(sc->sc_pc, sc->sc_pih, IPL_NET, ath_intr, 114 &sc->sc_sc); 115 if (sc->sc_ih == NULL) { 116 aprint_error_dev(self, "couldn't map interrupt\n"); 117 return false; 118 } 119 return ath_resume(&sc->sc_sc); 120 } 121 122 static void 123 ath_pci_attach(device_t parent, device_t self, void *aux) 124 { 125 struct ath_pci_softc *psc = device_private(self); 126 struct ath_softc *sc = &psc->sc_sc; 127 struct pci_attach_args *pa = aux; 128 pci_chipset_tag_t pc = pa->pa_pc; 129 const char *intrstr = NULL; 130 pcireg_t mem_type; 131 132 sc->sc_dev = self; 133 sc->sc_dmat = pa->pa_dmat; 134 psc->sc_pc = pc; 135 psc->sc_tag = pa->pa_tag; 136 137 aprint_normal("\n"); 138 139 if (!ath_pci_setup(psc)) 140 goto bad; 141 142 /* 143 * Setup memory-mapping of PCI registers. 144 */ 145 mem_type = pci_mapreg_type(pc, pa->pa_tag, ATH_PCI_MMBA); 146 if (mem_type != PCI_MAPREG_TYPE_MEM && 147 mem_type != PCI_MAPREG_MEM_TYPE_64BIT) { 148 aprint_error_dev(self, "bad pci register type %d\n", 149 (int)mem_type); 150 goto bad; 151 } 152 if (pci_mapreg_map(pa, ATH_PCI_MMBA, mem_type, 0, &psc->sc_iot, 153 &psc->sc_ioh, NULL, &psc->sc_mapsz) != 0) { 154 aprint_error_dev(self, "cannot map register space\n"); 155 goto bad; 156 } 157 158 sc->sc_st = HALTAG(psc->sc_iot); 159 sc->sc_sh = HALHANDLE(psc->sc_ioh); 160 161 /* 162 * Arrange interrupt line. 163 */ 164 if (pci_intr_map(pa, &psc->sc_pih)) { 165 aprint_error("couldn't map interrupt\n"); 166 goto bad1; 167 } 168 169 intrstr = pci_intr_string(pc, psc->sc_pih); 170 psc->sc_ih = pci_intr_establish(pc, psc->sc_pih, IPL_NET, ath_intr, sc); 171 if (psc->sc_ih == NULL) { 172 aprint_error("couldn't map interrupt\n"); 173 goto bad1; 174 } 175 176 aprint_verbose_dev(self, "interrupting at %s\n", intrstr); 177 178 ATH_LOCK_INIT(sc); 179 180 if (ath_attach(PCI_PRODUCT(pa->pa_id), sc) != 0) 181 goto bad3; 182 183 if (pmf_device_register(self, ath_pci_suspend, ath_pci_resume)) { 184 pmf_class_network_register(self, &sc->sc_if); 185 pmf_device_suspend(self, &sc->sc_qual); 186 } else 187 aprint_error_dev(self, "couldn't establish power handler\n"); 188 return; 189 bad3: 190 ATH_LOCK_DESTROY(sc); 191 192 pci_intr_disestablish(pc, psc->sc_ih); 193 bad1: 194 bus_space_unmap(psc->sc_iot, psc->sc_ioh, psc->sc_mapsz); 195 bad: 196 return; 197 } 198 199 static int 200 ath_pci_detach(device_t self, int flags) 201 { 202 struct ath_pci_softc *psc = device_private(self); 203 int rv; 204 205 if ((rv = ath_detach(&psc->sc_sc)) != 0) 206 return rv; 207 208 pmf_device_deregister(self); 209 210 if (psc->sc_ih != NULL) 211 pci_intr_disestablish(psc->sc_pc, psc->sc_ih); 212 213 ATH_LOCK_DESTROY(&psc->sc_sc); 214 215 bus_space_unmap(psc->sc_iot, psc->sc_ioh, psc->sc_mapsz); 216 return 0; 217 } 218 219 static bool 220 ath_pci_setup(struct ath_pci_softc *sc) 221 { 222 int rc; 223 pcireg_t bhlc, csr, icr, lattimer; 224 225 if ((rc = pci_set_powerstate(sc->sc_pc, sc->sc_tag, PCI_PWR_D0)) != 0) 226 aprint_debug("%s: pci_set_powerstate %d\n", __func__, rc); 227 /* 228 * Enable memory mapping and bus mastering. 229 */ 230 csr = pci_conf_read(sc->sc_pc, sc->sc_tag, PCI_COMMAND_STATUS_REG); 231 csr |= PCI_COMMAND_MASTER_ENABLE | PCI_COMMAND_MEM_ENABLE; 232 pci_conf_write(sc->sc_pc, sc->sc_tag, PCI_COMMAND_STATUS_REG, csr); 233 csr = pci_conf_read(sc->sc_pc, sc->sc_tag, PCI_COMMAND_STATUS_REG); 234 235 if ((csr & PCI_COMMAND_MEM_ENABLE) == 0) { 236 aprint_error_dev(sc->sc_sc.sc_dev, 237 "couldn't enable memory mapping\n"); 238 return false; 239 } 240 if ((csr & PCI_COMMAND_MASTER_ENABLE) == 0) { 241 aprint_error_dev(sc->sc_sc.sc_dev, 242 "couldn't enable bus mastering\n"); 243 return false; 244 } 245 246 /* 247 * XXX Both this comment and code are replicated in 248 * XXX cardbus_rescan(). 249 * 250 * Make sure the latency timer is set to some reasonable 251 * value. 252 * 253 * I will set the initial value of the Latency Timer here. 254 * 255 * While a PCI device owns the bus, its Latency Timer counts 256 * down bus cycles from its initial value to 0. Minimum 257 * Grant tells for how long the device wants to own the 258 * bus once it gets access, in units of 250ns. 259 * 260 * On a 33 MHz bus, there are 8 cycles per 250ns. So I 261 * multiply the Minimum Grant by 8 to find out the initial 262 * value of the Latency Timer. 263 * 264 * I never set a Latency Timer less than 0x10, since that 265 * is what the old code did. 266 */ 267 bhlc = pci_conf_read(sc->sc_pc, sc->sc_tag, PCI_BHLC_REG); 268 icr = pci_conf_read(sc->sc_pc, sc->sc_tag, PCI_INTERRUPT_REG); 269 lattimer = MAX(0x10, MIN(0xf8, 8 * PCI_MIN_GNT(icr))); 270 if (PCI_LATTIMER(bhlc) < lattimer) { 271 bhlc &= ~(PCI_LATTIMER_MASK << PCI_LATTIMER_SHIFT); 272 bhlc |= (lattimer << PCI_LATTIMER_SHIFT); 273 pci_conf_write(sc->sc_pc, sc->sc_tag, PCI_BHLC_REG, bhlc); 274 } 275 return true; 276 } 277