if_hme_pci.c revision 1.32.2.1 1 /* $NetBSD: if_hme_pci.c,v 1.32.2.1 2010/05/30 05:17:33 rmind 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.32.2.1 2010/05/30 05:17:33 rmind 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
59 #define PCI_HME_BASEADDR PCI_BAR(0)
60
61 struct hme_pci_softc {
62 struct hme_softc hsc_hme; /* HME device */
63 bus_space_tag_t hsc_memt;
64 bus_space_handle_t hsc_memh;
65 void *hsc_ih;
66 };
67
68 int hmematch_pci(device_t, cfdata_t, void *);
69 void hmeattach_pci(device_t, device_t, void *);
70
71 CFATTACH_DECL_NEW(hme_pci, sizeof(struct hme_pci_softc),
72 hmematch_pci, hmeattach_pci, NULL, NULL);
73
74 int
75 hmematch_pci(device_t parent, cfdata_t cf, void *aux)
76 {
77 struct pci_attach_args *pa = aux;
78
79 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_SUN &&
80 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_SUN_HMENETWORK)
81 return (1);
82
83 return (0);
84 }
85
86 static inline int
87 hmepromvalid(uint8_t* buf)
88 {
89 return buf[0] == 0x18 && buf[1] == 0x00 && /* structure length */
90 buf[2] == 0x00 && /* revision */
91 (buf[3] == 0x00 || /* hme */
92 buf[3] == 0x80) && /* qfe */
93 buf[4] == PCI_SUBCLASS_NETWORK_ETHERNET && /* subclass code */
94 buf[5] == PCI_CLASS_NETWORK; /* class code */
95 }
96
97 static inline int
98 hmevpdoff(bus_space_tag_t romt, bus_space_handle_t romh, int vpdoff, int dev)
99 {
100 #define VPDLEN (3 + sizeof(struct pci_vpd) + ETHER_ADDR_LEN)
101 if (bus_space_read_1(romt, romh, vpdoff + VPDLEN) != 0x79 &&
102 bus_space_read_1(romt, romh, vpdoff + 4 * VPDLEN) == 0x79) {
103 /*
104 * Use the Nth NA for the Nth HME on
105 * this SUNW,qfe.
106 */
107 vpdoff += dev * VPDLEN;
108 }
109 return vpdoff;
110 }
111
112 void
113 hmeattach_pci(device_t parent, device_t self, void *aux)
114 {
115 struct pci_attach_args *pa = aux;
116 struct hme_pci_softc *hsc = device_private(self);
117 struct hme_softc *sc = &hsc->hsc_hme;
118 pci_intr_handle_t ih;
119 pcireg_t csr;
120 const char *intrstr;
121 int type;
122 struct pci_attach_args ebus_pa;
123 prop_data_t eaddrprop;
124 pcireg_t ebus_cl, ebus_id;
125 uint8_t *enaddr;
126 bus_space_tag_t romt;
127 bus_space_handle_t romh;
128 bus_size_t romsize;
129 uint8_t buf[64];
130 int dataoff, vpdoff;
131 struct pci_vpd *vpd;
132 static const uint8_t promhdr[] = { 0x55, 0xaa };
133 #define PROMHDR_PTR_DATA 0x18
134 static const uint8_t promdat[] = {
135 0x50, 0x43, 0x49, 0x52, /* "PCIR" */
136 PCI_VENDOR_SUN & 0xff, PCI_VENDOR_SUN >> 8,
137 PCI_PRODUCT_SUN_HMENETWORK & 0xff,
138 PCI_PRODUCT_SUN_HMENETWORK >> 8
139 };
140 #define PROMDATA_PTR_VPD 0x08
141 #define PROMDATA_DATA2 0x0a
142
143 sc->sc_dev = self;
144
145 aprint_normal(": Sun Happy Meal Ethernet, rev. %d\n",
146 PCI_REVISION(pa->pa_class));
147 aprint_naive(": Ethernet controller\n");
148
149 csr = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
150 type = pci_mapreg_type(pa->pa_pc, pa->pa_tag, PCI_HME_BASEADDR);
151
152 /*
153 * enable io/memory-space accesses. this is kinda of gross; but
154 * the hme comes up with neither IO space enabled, or memory space.
155 */
156 switch (type) {
157 case PCI_MAPREG_TYPE_MEM:
158 pa->pa_flags |= PCI_FLAGS_MEM_ENABLED;
159 csr |= PCI_COMMAND_MEM_ENABLE;
160 sc->sc_bustag = pa->pa_memt;
161 break;
162 case PCI_MAPREG_TYPE_IO:
163 pa->pa_flags |= PCI_FLAGS_IO_ENABLED;
164 csr |= PCI_COMMAND_IO_ENABLE;
165 sc->sc_bustag = pa->pa_iot;
166 break;
167 }
168 pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG,
169 csr | PCI_COMMAND_MEM_ENABLE);
170
171 sc->sc_dmatag = pa->pa_dmat;
172
173 sc->sc_pci = 1; /* XXXXX should all be done in bus_dma. */
174 /*
175 * Map five register banks:
176 *
177 * bank 0: HME SEB registers: +0x0000
178 * bank 1: HME ETX registers: +0x2000
179 * bank 2: HME ERX registers: +0x4000
180 * bank 3: HME MAC registers: +0x6000
181 * bank 4: HME MIF registers: +0x7000
182 *
183 */
184
185 if (pci_mapreg_map(pa, PCI_HME_BASEADDR, type, 0,
186 &hsc->hsc_memt, &hsc->hsc_memh, NULL, NULL) != 0) {
187 aprint_error_dev(self, "unable to map device registers\n");
188 return;
189 }
190 sc->sc_seb = hsc->hsc_memh;
191 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x2000,
192 0x1000, &sc->sc_etx)) {
193 aprint_error_dev(self, "unable to subregion ETX registers\n");
194 return;
195 }
196 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x4000,
197 0x1000, &sc->sc_erx)) {
198 aprint_error_dev(self, "unable to subregion ERX registers\n");
199 return;
200 }
201 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x6000,
202 0x1000, &sc->sc_mac)) {
203 aprint_error_dev(self, "unable to subregion MAC registers\n");
204 return;
205 }
206 if (bus_space_subregion(hsc->hsc_memt, hsc->hsc_memh, 0x7000,
207 0x1000, &sc->sc_mif)) {
208 aprint_error_dev(self, "unable to subregion MIF registers\n");
209 return;
210 }
211
212
213 /*
214 * Check if we got a mac-address property passed
215 */
216 eaddrprop = prop_dictionary_get(device_properties(self), "mac-address");
217
218 if (eaddrprop != NULL && prop_data_size(eaddrprop) == ETHER_ADDR_LEN) {
219 memcpy(&sc->sc_enaddr, prop_data_data_nocopy(eaddrprop),
220 ETHER_ADDR_LEN);
221 goto got_eaddr;
222 }
223
224 /*
225 * Dig out VPD (vital product data) and acquire Ethernet address.
226 * The VPD of hme resides in the Boot PROM (PCI FCode) attached
227 * to the EBus interface.
228 */
229 /*
230 * ``Writing FCode 3.x Programs'' (newer ones, dated 1997 and later)
231 * chapter 2 describes the data structure.
232 */
233
234 enaddr = NULL;
235
236 /* get a PCI tag for the EBus bridge (function 0 of the same device) */
237 ebus_pa = *pa;
238 ebus_pa.pa_tag = pci_make_tag(pa->pa_pc, pa->pa_bus, pa->pa_device, 0);
239
240 ebus_cl = pci_conf_read(ebus_pa.pa_pc, ebus_pa.pa_tag, PCI_CLASS_REG);
241 ebus_id = pci_conf_read(ebus_pa.pa_pc, ebus_pa.pa_tag, PCI_ID_REG);
242
243 #define PCI_EBUS2_BOOTROM 0x10
244 if (PCI_CLASS(ebus_cl) == PCI_CLASS_BRIDGE &&
245 PCI_PRODUCT(ebus_id) == PCI_PRODUCT_SUN_EBUS &&
246 pci_mapreg_map(&ebus_pa, PCI_EBUS2_BOOTROM, PCI_MAPREG_TYPE_MEM,
247 BUS_SPACE_MAP_CACHEABLE | BUS_SPACE_MAP_PREFETCHABLE,
248 &romt, &romh, 0, &romsize) == 0) {
249
250 /* read PCI Expansion PROM Header */
251 bus_space_read_region_1(romt, romh, 0, buf, sizeof buf);
252 if (memcmp(buf, promhdr, sizeof promhdr) == 0 &&
253 (dataoff = (buf[PROMHDR_PTR_DATA] |
254 (buf[PROMHDR_PTR_DATA + 1] << 8))) >= 0x1c) {
255
256 /* read PCI Expansion PROM Data */
257 bus_space_read_region_1(romt, romh, dataoff,
258 buf, sizeof buf);
259 if (memcmp(buf, promdat, sizeof promdat) == 0 &&
260 hmepromvalid(buf + PROMDATA_DATA2) &&
261 (vpdoff = (buf[PROMDATA_PTR_VPD] |
262 (buf[PROMDATA_PTR_VPD + 1] << 8))) >= 0x1c) {
263
264 /*
265 * The VPD of hme is not in PCI 2.2 standard
266 * format. The length in the resource header
267 * is in big endian, and resources are not
268 * properly terminated (only one resource
269 * and no end tag).
270 */
271 vpdoff = hmevpdoff(romt, romh, vpdoff,
272 pa->pa_device);
273 /* read PCI VPD */
274 bus_space_read_region_1(romt, romh,
275 vpdoff, buf, sizeof buf);
276 vpd = (void *)(buf + 3);
277 if (PCI_VPDRES_ISLARGE(buf[0]) &&
278 PCI_VPDRES_LARGE_NAME(buf[0])
279 == PCI_VPDRES_TYPE_VPD &&
280 /* buf[1] == 0 && buf[2] == 9 && */ /*len*/
281 vpd->vpd_key0 == 0x4e /* N */ &&
282 vpd->vpd_key1 == 0x41 /* A */ &&
283 vpd->vpd_len == ETHER_ADDR_LEN) {
284 /*
285 * Ethernet address found
286 */
287 enaddr = buf + 6;
288 }
289 }
290 }
291 bus_space_unmap(romt, romh, romsize);
292 }
293
294 if (enaddr) {
295 memcpy(sc->sc_enaddr, enaddr, ETHER_ADDR_LEN);
296 goto got_eaddr;
297 }
298
299 aprint_error_dev(self, "no Ethernet address found\n");
300 got_eaddr:
301
302 /*
303 * Map and establish our interrupt.
304 */
305 if (pci_intr_map(pa, &ih) != 0) {
306 aprint_error_dev(self, "unable to map interrupt\n");
307 return;
308 }
309 intrstr = pci_intr_string(pa->pa_pc, ih);
310 hsc->hsc_ih = pci_intr_establish(pa->pa_pc, ih, IPL_NET, hme_intr, sc);
311 if (hsc->hsc_ih == NULL) {
312 aprint_error_dev(self, "unable to establish interrupt");
313 if (intrstr != NULL)
314 aprint_error(" at %s", intrstr);
315 aprint_error("\n");
316 return;
317 }
318 aprint_normal_dev(self, "interrupting at %s\n", intrstr);
319
320 sc->sc_burst = 16; /* XXX */
321
322 /* Finish off the attach. */
323 hme_config(sc);
324 }
325