1 /* $OpenBSD: if_hme_pci.c,v 1.16 2009/10/15 17:54:56 deraadt Exp $ */ 2 /* $NetBSD: if_hme_pci.c,v 1.3 2000/12/28 22:59:13 sommerfeld Exp $ */ 3 4 /* 5 * Copyright (c) 2000 Matthew R. Green 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. The name of the author may not be used to endorse or promote products 17 * derived from this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 26 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 27 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 /* 33 * PCI front-end device driver for the HME ethernet device. 34 */ 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_media.h> 46 47 #ifdef INET 48 #include <netinet/in.h> 49 #include <netinet/in_systm.h> 50 #include <netinet/in_var.h> 51 #include <netinet/ip.h> 52 #include <netinet/if_ether.h> 53 #endif 54 55 #include <dev/mii/mii.h> 56 #include <dev/mii/miivar.h> 57 58 #ifdef __sparc64__ 59 #include <machine/autoconf.h> 60 #include <dev/ofw/openfirm.h> 61 #endif 62 #include <machine/cpu.h> 63 64 #include <dev/pci/pcivar.h> 65 #include <dev/pci/pcireg.h> 66 #include <dev/pci/pcidevs.h> 67 68 #include <dev/ic/hmevar.h> 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 bus_size_t hsc_memsize; 75 void *hsc_ih; 76 pci_chipset_tag_t hsc_pc; 77 }; 78 79 int hmematch_pci(struct device *, void *, void *); 80 void hmeattach_pci(struct device *, struct device *, void *); 81 int hmedetach_pci(struct device *, int); 82 int hme_pci_enaddr(struct hme_softc *, struct pci_attach_args *); 83 84 struct cfattach hme_pci_ca = { 85 sizeof(struct hme_pci_softc), hmematch_pci, hmeattach_pci, hmedetach_pci 86 }; 87 88 int 89 hmematch_pci(parent, vcf, aux) 90 struct device *parent; 91 void *vcf; 92 void *aux; 93 { 94 struct pci_attach_args *pa = aux; 95 96 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN && 97 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_HME) 98 return (1); 99 100 return (0); 101 } 102 103 #define PCI_EBUS2_BOOTROM 0x10 104 #define PCI_EBUS2_BOOTROM_SIZE 0x20000 105 #define PROMHDR_PTR_DATA 0x18 106 #define PROMDATA_PTR_VPD 0x08 107 #define PROMDATA_LENGTH 0x0a 108 #define PROMDATA_REVISION 0x0c 109 #define PROMDATA_SUBCLASS 0x0e 110 #define PROMDATA_CLASS 0x0f 111 112 static const u_int8_t hme_promhdr[] = { 0x55, 0xaa }; 113 static const u_int8_t hme_promdat[] = { 114 'P', 'C', 'I', 'R', 115 PCI_VENDOR_SUN & 0xff, PCI_VENDOR_SUN >> 8, 116 PCI_PRODUCT_SUN_HME & 0xff, PCI_PRODUCT_SUN_HME >> 8 117 }; 118 119 int 120 hme_pci_enaddr(struct hme_softc *sc, struct pci_attach_args *hpa) 121 { 122 struct pci_attach_args epa; 123 struct pci_vpd *vpd; 124 pcireg_t cl, id; 125 bus_space_handle_t romh; 126 bus_space_tag_t romt; 127 bus_size_t romsize = 0; 128 u_int8_t buf[32]; 129 int dataoff, vpdoff, length; 130 131 /* 132 * Dig out VPD (vital product data) and acquire Ethernet address. 133 * The VPD of hme resides in the Boot PROM (PCI FCode) attached 134 * to the EBus interface. 135 * ``Writing FCode 3.x Programs'' (newer ones, dated 1997 and later) 136 * chapter 2 describes the data structure. 137 */ 138 139 /* get a PCI tag for the EBus bridge (function 0 of the same device) */ 140 epa = *hpa; 141 epa.pa_tag = pci_make_tag(hpa->pa_pc, hpa->pa_bus, hpa->pa_device, 0); 142 cl = pci_conf_read(epa.pa_pc, epa.pa_tag, PCI_CLASS_REG); 143 id = pci_conf_read(epa.pa_pc, epa.pa_tag, PCI_ID_REG); 144 145 if (PCI_CLASS(cl) != PCI_CLASS_BRIDGE || 146 PCI_PRODUCT(id) != PCI_PRODUCT_SUN_EBUS) 147 goto fail; 148 149 if (pci_mapreg_map(&epa, PCI_EBUS2_BOOTROM, PCI_MAPREG_TYPE_MEM, 0, 150 &romt, &romh, 0, &romsize, PCI_EBUS2_BOOTROM_SIZE)) 151 goto fail; 152 153 bus_space_read_region_1(romt, romh, 0, buf, sizeof(buf)); 154 if (bcmp(buf, hme_promhdr, sizeof(hme_promhdr))) 155 goto fail; 156 157 dataoff = buf[PROMHDR_PTR_DATA] | (buf[PROMHDR_PTR_DATA + 1] << 8); 158 if (dataoff < 0x1c) 159 goto fail; 160 161 bus_space_read_region_1(romt, romh, dataoff, buf, sizeof(buf)); 162 if (bcmp(buf, hme_promdat, sizeof(hme_promdat))) 163 goto fail; 164 165 /* 166 * Don't check the interface part of the class code, since 167 * some cards have a bogus value there. 168 */ 169 length = buf[PROMDATA_LENGTH] | (buf[PROMDATA_LENGTH + 1] << 8); 170 if (length != 0x18 || buf[PROMDATA_REVISION] != 0x00 || 171 buf[PROMDATA_SUBCLASS] != PCI_SUBCLASS_NETWORK_ETHERNET || 172 buf[PROMDATA_CLASS] != PCI_CLASS_NETWORK) 173 goto fail; 174 175 vpdoff = buf[PROMDATA_PTR_VPD] | (buf[PROMDATA_PTR_VPD + 1] << 8); 176 if (vpdoff < 0x1c) 177 goto fail; 178 179 /* 180 * The VPD of hme is not in PCI 2.2 standard format. The length 181 * in the resource header is in big endian, and resources are not 182 * properly terminated (only one resource and no end tag). 183 */ 184 bus_space_read_region_1(romt, romh, vpdoff, buf, sizeof(buf)); 185 186 /* XXX TODO: Get the data from VPD */ 187 vpd = (struct pci_vpd *)(buf + 3); 188 if (!PCI_VPDRES_ISLARGE(buf[0]) || 189 PCI_VPDRES_LARGE_NAME(buf[0]) != PCI_VPDRES_TYPE_VPD) 190 goto fail; 191 if (vpd->vpd_key0 != 'N' || vpd->vpd_key1 != 'A') 192 goto fail; 193 194 bcopy(buf + 6, sc->sc_arpcom.ac_enaddr, ETHER_ADDR_LEN); 195 sc->sc_arpcom.ac_enaddr[5] += hpa->pa_device; 196 bus_space_unmap(romt, romh, romsize); 197 return (0); 198 199 fail: 200 if (romsize != 0) 201 bus_space_unmap(romt, romh, romsize); 202 return (-1); 203 } 204 205 void 206 hmeattach_pci(parent, self, aux) 207 struct device *parent, *self; 208 void *aux; 209 { 210 struct pci_attach_args *pa = aux; 211 struct hme_pci_softc *hsc = (void *)self; 212 struct hme_softc *sc = &hsc->hsc_hme; 213 pci_intr_handle_t ih; 214 /* XXX the following declarations should be elsewhere */ 215 extern void myetheraddr(u_char *); 216 pcireg_t csr; 217 const char *intrstr = NULL; 218 int type, gotenaddr = 0; 219 220 hsc->hsc_pc = pa->pa_pc; 221 222 /* 223 * enable io/memory-space accesses. this is kinda of gross; but 224 * the hme comes up with neither IO space enabled, or memory space. 225 */ 226 if (pa->pa_memt) 227 pa->pa_flags |= PCI_FLAGS_MEM_ENABLED; 228 if (pa->pa_iot) 229 pa->pa_flags |= PCI_FLAGS_IO_ENABLED; 230 csr = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG); 231 if (pa->pa_memt) { 232 type = PCI_MAPREG_TYPE_MEM; 233 csr |= PCI_COMMAND_MEM_ENABLE; 234 sc->sc_bustag = pa->pa_memt; 235 } else { 236 type = PCI_MAPREG_TYPE_IO; 237 csr |= PCI_COMMAND_IO_ENABLE; 238 sc->sc_bustag = pa->pa_iot; 239 } 240 pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG, 241 csr | PCI_COMMAND_MEM_ENABLE); 242 243 sc->sc_dmatag = pa->pa_dmat; 244 245 sc->sc_pci = 1; /* XXXXX should all be done in bus_dma. */ 246 /* 247 * Map five register banks: 248 * 249 * bank 0: HME SEB registers: +0x0000 250 * bank 1: HME ETX registers: +0x2000 251 * bank 2: HME ERX registers: +0x4000 252 * bank 3: HME MAC registers: +0x6000 253 * bank 4: HME MIF registers: +0x7000 254 * 255 */ 256 257 #define PCI_HME_BASEADDR 0x10 258 if (pci_mapreg_map(pa, PCI_HME_BASEADDR, type, 0, 259 &hsc->hsc_memt, &hsc->hsc_memh, NULL, &hsc->hsc_memsize, 0) != 0) { 260 printf(": can't map registers\n"); 261 return; 262 } 263 sc->sc_seb = hsc->hsc_memh; 264 bus_space_subregion(sc->sc_bustag, hsc->hsc_memh, 0x2000, 0x2000, 265 &sc->sc_etx); 266 bus_space_subregion(sc->sc_bustag, hsc->hsc_memh, 0x4000, 0x2000, 267 &sc->sc_erx); 268 bus_space_subregion(sc->sc_bustag, hsc->hsc_memh, 0x6000, 0x1000, 269 &sc->sc_mac); 270 bus_space_subregion(sc->sc_bustag, hsc->hsc_memh, 0x7000, 0x1000, 271 &sc->sc_mif); 272 273 if (hme_pci_enaddr(sc, pa) == 0) 274 gotenaddr = 1; 275 276 #ifdef __sparc64__ 277 if (!gotenaddr) { 278 if (OF_getprop(PCITAG_NODE(pa->pa_tag), "local-mac-address", 279 sc->sc_arpcom.ac_enaddr, ETHER_ADDR_LEN) <= 0) 280 myetheraddr(sc->sc_arpcom.ac_enaddr); 281 gotenaddr = 1; 282 } 283 #endif 284 #ifdef __powerpc__ 285 if (!gotenaddr) { 286 pci_ether_hw_addr(pa->pa_pc, sc->sc_arpcom.ac_enaddr); 287 gotenaddr = 1; 288 } 289 #endif 290 291 sc->sc_burst = 16; /* XXX */ 292 293 if (pci_intr_map(pa, &ih) != 0) { 294 printf(": couldn't map interrupt\n"); 295 bus_space_unmap(hsc->hsc_memt, hsc->hsc_memh, hsc->hsc_memsize); 296 return; 297 } 298 intrstr = pci_intr_string(pa->pa_pc, ih); 299 hsc->hsc_ih = pci_intr_establish(pa->pa_pc, ih, IPL_NET, 300 hme_intr, sc, self->dv_xname); 301 if (hsc->hsc_ih == NULL) { 302 printf(": couldn't establish interrupt"); 303 if (intrstr != NULL) 304 printf(" at %s", intrstr); 305 printf("\n"); 306 bus_space_unmap(hsc->hsc_memt, hsc->hsc_memh, hsc->hsc_memsize); 307 return; 308 } 309 310 printf(": %s", intrstr); 311 312 /* 313 * call the main configure 314 */ 315 hme_config(sc); 316 } 317 318 int 319 hmedetach_pci(struct device *self, int flags) 320 { 321 struct hme_pci_softc *hsc = (void *)self; 322 struct hme_softc *sc = &hsc->hsc_hme; 323 324 timeout_del(&sc->sc_tick_ch); 325 pci_intr_disestablish(hsc->hsc_pc, hsc->hsc_ih); 326 327 hme_unconfig(sc); 328 bus_space_unmap(hsc->hsc_memt, hsc->hsc_memh, hsc->hsc_memsize); 329 return (0); 330 } 331