1 /* $NetBSD: if_hme_pci.c,v 1.28 2009/05/12 08:23:00 cegger Exp $ */ 2 3 /* 4 * Copyright (c) 2000 Matthew R. Green 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 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24 * 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 /* 30 * PCI front-end device driver for the HME ethernet device. 31 */ 32 33 #include <sys/cdefs.h> 34 __KERNEL_RCSID(0, "$NetBSD: if_hme_pci.c,v 1.28 2009/05/12 08:23:00 cegger Exp $"); 35 36 #include <sys/param.h> 37 #include <sys/systm.h> 38 #include <sys/syslog.h> 39 #include <sys/device.h> 40 #include <sys/malloc.h> 41 #include <sys/socket.h> 42 43 #include <net/if.h> 44 #include <net/if_dl.h> 45 #include <net/if_ether.h> 46 #include <net/if_media.h> 47 48 #include <dev/mii/mii.h> 49 #include <dev/mii/miivar.h> 50 51 #include <sys/intr.h> 52 53 #include <dev/pci/pcivar.h> 54 #include <dev/pci/pcireg.h> 55 #include <dev/pci/pcidevs.h> 56 57 #include <dev/ic/hmevar.h> 58 #ifdef __sparc__ 59 #include <machine/promlib.h> 60 #endif 61 62 #ifndef HME_USE_LOCAL_MAC_ADDRESS 63 #ifdef __sparc__ 64 #define HME_USE_LOCAL_MAC_ADDRESS 0 /* use system-wide address */ 65 #else 66 #define HME_USE_LOCAL_MAC_ADDRESS 1 67 #endif 68 #endif 69 70 struct hme_pci_softc { 71 struct hme_softc hsc_hme; /* HME device */ 72 bus_space_tag_t hsc_memt; 73 bus_space_handle_t hsc_memh; 74 void *hsc_ih; 75 }; 76 77 int hmematch_pci(device_t, cfdata_t, void *); 78 void hmeattach_pci(device_t, device_t, void *); 79 80 CFATTACH_DECL(hme_pci, sizeof(struct hme_pci_softc), 81 hmematch_pci, hmeattach_pci, NULL, NULL); 82 83 int 84 hmematch_pci(device_t parent, cfdata_t cf, void *aux) 85 { 86 struct pci_attach_args *pa = aux; 87 88 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN && 89 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_HMENETWORK) 90 return (1); 91 92 return (0); 93 } 94 95 #if HME_USE_LOCAL_MAC_ADDRESS 96 static inline int 97 hmepromvalid(u_int8_t* buf) 98 { 99 return buf[0] == 0x18 && buf[1] == 0x00 && /* structure length */ 100 buf[2] == 0x00 && /* revision */ 101 (buf[3] == 0x00 || /* hme */ 102 buf[3] == 0x80) && /* qfe */ 103 buf[4] == PCI_SUBCLASS_NETWORK_ETHERNET && /* subclass code */ 104 buf[5] == PCI_CLASS_NETWORK; /* class code */ 105 } 106 107 static inline int 108 hmevpdoff(bus_space_tag_t romt, bus_space_handle_t romh, int vpdoff, int dev) 109 { 110 #define VPDLEN (3 + sizeof(struct pci_vpd) + ETHER_ADDR_LEN) 111 if (bus_space_read_1(romt, romh, vpdoff + VPDLEN) != 0x79 && 112 bus_space_read_1(romt, romh, vpdoff + 4 * VPDLEN) == 0x79) { 113 /* 114 * Use the Nth NA for the Nth HME on 115 * this SUNW,qfe. 116 */ 117 vpdoff += dev * VPDLEN; 118 } 119 return vpdoff; 120 } 121 #endif 122 123 void 124 hmeattach_pci(device_t parent, device_t self, void *aux) 125 { 126 struct pci_attach_args *pa = aux; 127 struct hme_pci_softc *hsc = device_private(self); 128 struct hme_softc *sc = &hsc->hsc_hme; 129 pci_intr_handle_t ih; 130 pcireg_t csr; 131 const char *intrstr; 132 int type; 133 #if HME_USE_LOCAL_MAC_ADDRESS 134 struct pci_attach_args ebus_pa; 135 pcireg_t ebus_cl, ebus_id; 136 u_int8_t *enaddr; 137 bus_space_tag_t romt; 138 bus_space_handle_t romh; 139 bus_size_t romsize; 140 u_int8_t buf[64]; 141 int dataoff, vpdoff; 142 struct pci_vpd *vpd; 143 static const u_int8_t promhdr[] = { 0x55, 0xaa }; 144 #define PROMHDR_PTR_DATA 0x18 145 static const u_int8_t promdat[] = { 146 0x50, 0x43, 0x49, 0x52, /* "PCIR" */ 147 PCI_VENDOR_SUN & 0xff, PCI_VENDOR_SUN >> 8, 148 PCI_PRODUCT_SUN_HMENETWORK & 0xff, 149 PCI_PRODUCT_SUN_HMENETWORK >> 8 150 }; 151 #define PROMDATA_PTR_VPD 0x08 152 #define PROMDATA_DATA2 0x0a 153 #endif /* HME_USE_LOCAL_MAC_ADDRESS */ 154 155 printf(": Sun Happy Meal Ethernet, rev. %d\n", 156 PCI_REVISION(pa->pa_class)); 157 158 /* 159 * enable io/memory-space accesses. this is kinda of gross; but 160 # the hme comes up with neither IO space enabled, or memory space. 161 */ 162 if (pa->pa_memt) 163 pa->pa_flags |= PCI_FLAGS_MEM_ENABLED; 164 if (pa->pa_iot) 165 pa->pa_flags |= PCI_FLAGS_IO_ENABLED; 166 csr = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG); 167 if (pa->pa_memt) { 168 type = PCI_MAPREG_TYPE_MEM; 169 csr |= PCI_COMMAND_MEM_ENABLE; 170 sc->sc_bustag = pa->pa_memt; 171 } else { 172 type = PCI_MAPREG_TYPE_IO; 173 csr |= PCI_COMMAND_IO_ENABLE; 174 sc->sc_bustag = pa->pa_iot; 175 } 176 pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, 177 csr | PCI_COMMAND_MEM_ENABLE); 178 179 sc->sc_dmatag = pa->pa_dmat; 180 181 sc->sc_pci = 1; /* XXXXX should all be done in bus_dma. */ 182 /* 183 * Map five register banks: 184 * 185 * bank 0: HME SEB registers: +0x0000 186 * bank 1: HME ETX registers: +0x2000 187 * bank 2: HME ERX registers: +0x4000 188 * bank 3: HME MAC registers: +0x6000 189 * bank 4: HME MIF registers: +0x7000 190 * 191 */ 192 193 #define PCI_HME_BASEADDR 0x10 194 if (pci_mapreg_map(pa, PCI_HME_BASEADDR, type, 0, 195 &hsc->hsc_memt, &hsc->hsc_memh, NULL, NULL) != 0) 196 { 197 aprint_error_dev(&sc->sc_dev, "unable to map device registers\n"); 198 return; 199 } 200 sc->sc_seb = hsc->hsc_memh; 201 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x2000, 202 0x1000, &sc->sc_etx)) { 203 aprint_error_dev(&sc->sc_dev, "unable to subregion ETX registers\n"); 204 return; 205 } 206 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x4000, 207 0x1000, &sc->sc_erx)) { 208 aprint_error_dev(&sc->sc_dev, "unable to subregion ERX registers\n"); 209 return; 210 } 211 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x6000, 212 0x1000, &sc->sc_mac)) { 213 aprint_error_dev(&sc->sc_dev, "unable to subregion MAC registers\n"); 214 return; 215 } 216 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x7000, 217 0x1000, &sc->sc_mif)) { 218 aprint_error_dev(&sc->sc_dev, "unable to subregion MIF registers\n"); 219 return; 220 } 221 222 #if HME_USE_LOCAL_MAC_ADDRESS 223 /* 224 * Dig out VPD (vital product data) and acquire Ethernet address. 225 * The VPD of hme resides in the Boot PROM (PCI FCode) attached 226 * to the EBus interface. 227 */ 228 /* 229 * ``Writing FCode 3.x Programs'' (newer ones, dated 1997 and later) 230 * chapter 2 describes the data structure. 231 */ 232 233 enaddr = NULL; 234 235 /* get a PCI tag for the EBus bridge (function 0 of the same device) */ 236 ebus_pa = *pa; 237 ebus_pa.pa_tag = pci_make_tag(pa->pa_pc, pa->pa_bus, pa->pa_device, 0); 238 239 ebus_cl = pci_conf_read(ebus_pa.pa_pc, ebus_pa.pa_tag, PCI_CLASS_REG); 240 ebus_id = pci_conf_read(ebus_pa.pa_pc, ebus_pa.pa_tag, PCI_ID_REG); 241 242 #define PCI_EBUS2_BOOTROM 0x10 243 if (PCI_CLASS(ebus_cl) == PCI_CLASS_BRIDGE && 244 PCI_PRODUCT(ebus_id) == PCI_PRODUCT_SUN_EBUS && 245 pci_mapreg_map(&ebus_pa, PCI_EBUS2_BOOTROM, PCI_MAPREG_TYPE_MEM, 246 BUS_SPACE_MAP_CACHEABLE | BUS_SPACE_MAP_PREFETCHABLE, 247 &romt, &romh, 0, &romsize) == 0) { 248 249 /* read PCI Expansion PROM Header */ 250 bus_space_read_region_1(romt, romh, 0, buf, sizeof buf); 251 if (memcmp(buf, promhdr, sizeof promhdr) == 0 && 252 (dataoff = (buf[PROMHDR_PTR_DATA] | 253 (buf[PROMHDR_PTR_DATA + 1] << 8))) >= 0x1c) { 254 255 /* read PCI Expansion PROM Data */ 256 bus_space_read_region_1(romt, romh, dataoff, 257 buf, sizeof buf); 258 if (memcmp(buf, promdat, sizeof promdat) == 0 && 259 hmepromvalid(buf + PROMDATA_DATA2) && 260 (vpdoff = (buf[PROMDATA_PTR_VPD] | 261 (buf[PROMDATA_PTR_VPD + 1] << 8))) >= 0x1c) { 262 263 /* 264 * The VPD of hme is not in PCI 2.2 standard 265 * format. The length in the resource header 266 * is in big endian, and resources are not 267 * properly terminated (only one resource 268 * and no end tag). 269 */ 270 vpdoff = hmevpdoff(romt, romh, vpdoff, 271 pa->pa_device); 272 /* read PCI VPD */ 273 bus_space_read_region_1(romt, romh, 274 vpdoff, buf, sizeof buf); 275 vpd = (void *)(buf + 3); 276 if (PCI_VPDRES_ISLARGE(buf[0]) && 277 PCI_VPDRES_LARGE_NAME(buf[0]) 278 == PCI_VPDRES_TYPE_VPD && 279 /* buf[1] == 0 && buf[2] == 9 && */ /*len*/ 280 vpd->vpd_key0 == 0x4e /* N */ && 281 vpd->vpd_key1 == 0x41 /* A */ && 282 vpd->vpd_len == ETHER_ADDR_LEN) { 283 /* 284 * Ethernet address found 285 */ 286 enaddr = buf + 6; 287 } 288 } 289 } 290 bus_space_unmap(romt, romh, romsize); 291 } 292 293 if (enaddr) 294 memcpy(sc->sc_enaddr, enaddr, ETHER_ADDR_LEN); 295 else 296 #endif /* HME_USE_LOCAL_MAC_ADDRESS */ 297 #ifdef __sparc__ 298 prom_getether(PCITAG_NODE(pa->pa_tag), sc->sc_enaddr); 299 #else 300 printf("%s: no Ethernet address found\n", device_xname(&sc->sc_dev)); 301 #endif 302 303 /* 304 * Map and establish our interrupt. 305 */ 306 if (pci_intr_map(pa, &ih) != 0) { 307 aprint_error_dev(&sc->sc_dev, "unable to map interrupt\n"); 308 return; 309 } 310 intrstr = pci_intr_string(pa->pa_pc, ih); 311 hsc->hsc_ih = pci_intr_establish(pa->pa_pc, ih, IPL_NET, hme_intr, sc); 312 if (hsc->hsc_ih == NULL) { 313 aprint_error_dev(&sc->sc_dev, "unable to establish interrupt"); 314 if (intrstr != NULL) 315 printf(" at %s", intrstr); 316 printf("\n"); 317 return; 318 } 319 printf("%s: interrupting at %s\n", device_xname(&sc->sc_dev), intrstr); 320 321 sc->sc_burst = 16; /* XXX */ 322 323 /* Finish off the attach. */ 324 hme_config(sc); 325 } 326