1 | #include <machine/rtems-bsd-kernel-space.h> |
---|
2 | |
---|
3 | /*- |
---|
4 | * Copyright (c) 1997, 1998, 1999, 2000 |
---|
5 | * Bill Paul <wpaul@ee.columbia.edu>. 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 | * 3. All advertising materials mentioning features or use of this software |
---|
16 | * must display the following acknowledgement: |
---|
17 | * This product includes software developed by Bill Paul. |
---|
18 | * 4. Neither the name of the author nor the names of any co-contributors |
---|
19 | * may be used to endorse or promote products derived from this software |
---|
20 | * without specific prior written permission. |
---|
21 | * |
---|
22 | * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND |
---|
23 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
24 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
25 | * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD |
---|
26 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
27 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
28 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
29 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
30 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
31 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
---|
32 | * THE POSSIBILITY OF SUCH DAMAGE. |
---|
33 | */ |
---|
34 | |
---|
35 | #include <sys/cdefs.h> |
---|
36 | __FBSDID("$FreeBSD$"); |
---|
37 | |
---|
38 | /* |
---|
39 | * Kawasaki LSI KL5KUSB101B USB to ethernet adapter driver. |
---|
40 | * |
---|
41 | * Written by Bill Paul <wpaul@ee.columbia.edu> |
---|
42 | * Electrical Engineering Department |
---|
43 | * Columbia University, New York City |
---|
44 | */ |
---|
45 | |
---|
46 | /* |
---|
47 | * The KLSI USB to ethernet adapter chip contains an USB serial interface, |
---|
48 | * ethernet MAC and embedded microcontroller (called the QT Engine). |
---|
49 | * The chip must have firmware loaded into it before it will operate. |
---|
50 | * Packets are passed between the chip and host via bulk transfers. |
---|
51 | * There is an interrupt endpoint mentioned in the software spec, however |
---|
52 | * it's currently unused. This device is 10Mbps half-duplex only, hence |
---|
53 | * there is no media selection logic. The MAC supports a 128 entry |
---|
54 | * multicast filter, though the exact size of the filter can depend |
---|
55 | * on the firmware. Curiously, while the software spec describes various |
---|
56 | * ethernet statistics counters, my sample adapter and firmware combination |
---|
57 | * claims not to support any statistics counters at all. |
---|
58 | * |
---|
59 | * Note that once we load the firmware in the device, we have to be |
---|
60 | * careful not to load it again: if you restart your computer but |
---|
61 | * leave the adapter attached to the USB controller, it may remain |
---|
62 | * powered on and retain its firmware. In this case, we don't need |
---|
63 | * to load the firmware a second time. |
---|
64 | * |
---|
65 | * Special thanks to Rob Furr for providing an ADS Technologies |
---|
66 | * adapter for development and testing. No monkeys were harmed during |
---|
67 | * the development of this driver. |
---|
68 | */ |
---|
69 | |
---|
70 | #include <sys/stdint.h> |
---|
71 | #include <sys/stddef.h> |
---|
72 | #include <rtems/bsd/sys/param.h> |
---|
73 | #include <sys/queue.h> |
---|
74 | #include <sys/types.h> |
---|
75 | #include <sys/systm.h> |
---|
76 | #include <sys/socket.h> |
---|
77 | #include <sys/kernel.h> |
---|
78 | #include <sys/bus.h> |
---|
79 | #include <sys/module.h> |
---|
80 | #include <rtems/bsd/sys/lock.h> |
---|
81 | #include <sys/mutex.h> |
---|
82 | #include <sys/condvar.h> |
---|
83 | #include <sys/sysctl.h> |
---|
84 | #include <sys/sx.h> |
---|
85 | #include <rtems/bsd/sys/unistd.h> |
---|
86 | #include <sys/callout.h> |
---|
87 | #include <sys/malloc.h> |
---|
88 | #include <sys/priv.h> |
---|
89 | |
---|
90 | #include <net/if.h> |
---|
91 | #include <net/if_var.h> |
---|
92 | |
---|
93 | #include <dev/usb/usb.h> |
---|
94 | #include <dev/usb/usbdi.h> |
---|
95 | #include <dev/usb/usbdi_util.h> |
---|
96 | #include <rtems/bsd/local/usbdevs.h> |
---|
97 | |
---|
98 | #define USB_DEBUG_VAR kue_debug |
---|
99 | #include <dev/usb/usb_debug.h> |
---|
100 | #include <dev/usb/usb_process.h> |
---|
101 | |
---|
102 | #include <dev/usb/net/usb_ethernet.h> |
---|
103 | #include <dev/usb/net/if_kuereg.h> |
---|
104 | #include <dev/usb/net/if_kuefw.h> |
---|
105 | |
---|
106 | /* |
---|
107 | * Various supported device vendors/products. |
---|
108 | */ |
---|
109 | static const STRUCT_USB_HOST_ID kue_devs[] = { |
---|
110 | #define KUE_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) } |
---|
111 | KUE_DEV(3COM, 3C19250), |
---|
112 | KUE_DEV(3COM, 3C460), |
---|
113 | KUE_DEV(ABOCOM, URE450), |
---|
114 | KUE_DEV(ADS, UBS10BT), |
---|
115 | KUE_DEV(ADS, UBS10BTX), |
---|
116 | KUE_DEV(AOX, USB101), |
---|
117 | KUE_DEV(ASANTE, EA), |
---|
118 | KUE_DEV(ATEN, DSB650C), |
---|
119 | KUE_DEV(ATEN, UC10T), |
---|
120 | KUE_DEV(COREGA, ETHER_USB_T), |
---|
121 | KUE_DEV(DLINK, DSB650C), |
---|
122 | KUE_DEV(ENTREGA, E45), |
---|
123 | KUE_DEV(ENTREGA, XX1), |
---|
124 | KUE_DEV(ENTREGA, XX2), |
---|
125 | KUE_DEV(IODATA, USBETT), |
---|
126 | KUE_DEV(JATON, EDA), |
---|
127 | KUE_DEV(KINGSTON, XX1), |
---|
128 | KUE_DEV(KLSI, DUH3E10BT), |
---|
129 | KUE_DEV(KLSI, DUH3E10BTN), |
---|
130 | KUE_DEV(LINKSYS, USB10T), |
---|
131 | KUE_DEV(MOBILITY, EA), |
---|
132 | KUE_DEV(NETGEAR, EA101), |
---|
133 | KUE_DEV(NETGEAR, EA101X), |
---|
134 | KUE_DEV(PERACOM, ENET), |
---|
135 | KUE_DEV(PERACOM, ENET2), |
---|
136 | KUE_DEV(PERACOM, ENET3), |
---|
137 | KUE_DEV(PORTGEAR, EA8), |
---|
138 | KUE_DEV(PORTGEAR, EA9), |
---|
139 | KUE_DEV(PORTSMITH, EEA), |
---|
140 | KUE_DEV(SHARK, PA), |
---|
141 | KUE_DEV(SILICOM, GPE), |
---|
142 | KUE_DEV(SILICOM, U2E), |
---|
143 | KUE_DEV(SMC, 2102USB), |
---|
144 | #undef KUE_DEV |
---|
145 | }; |
---|
146 | |
---|
147 | /* prototypes */ |
---|
148 | |
---|
149 | static device_probe_t kue_probe; |
---|
150 | static device_attach_t kue_attach; |
---|
151 | static device_detach_t kue_detach; |
---|
152 | |
---|
153 | static usb_callback_t kue_bulk_read_callback; |
---|
154 | static usb_callback_t kue_bulk_write_callback; |
---|
155 | |
---|
156 | static uether_fn_t kue_attach_post; |
---|
157 | static uether_fn_t kue_init; |
---|
158 | static uether_fn_t kue_stop; |
---|
159 | static uether_fn_t kue_start; |
---|
160 | static uether_fn_t kue_setmulti; |
---|
161 | static uether_fn_t kue_setpromisc; |
---|
162 | |
---|
163 | static int kue_do_request(struct kue_softc *, |
---|
164 | struct usb_device_request *, void *); |
---|
165 | static int kue_setword(struct kue_softc *, uint8_t, uint16_t); |
---|
166 | static int kue_ctl(struct kue_softc *, uint8_t, uint8_t, uint16_t, |
---|
167 | void *, int); |
---|
168 | static int kue_load_fw(struct kue_softc *); |
---|
169 | static void kue_reset(struct kue_softc *); |
---|
170 | |
---|
171 | #ifdef USB_DEBUG |
---|
172 | static int kue_debug = 0; |
---|
173 | |
---|
174 | static SYSCTL_NODE(_hw_usb, OID_AUTO, kue, CTLFLAG_RW, 0, "USB kue"); |
---|
175 | SYSCTL_INT(_hw_usb_kue, OID_AUTO, debug, CTLFLAG_RWTUN, &kue_debug, 0, |
---|
176 | "Debug level"); |
---|
177 | #endif |
---|
178 | |
---|
179 | static const struct usb_config kue_config[KUE_N_TRANSFER] = { |
---|
180 | |
---|
181 | [KUE_BULK_DT_WR] = { |
---|
182 | .type = UE_BULK, |
---|
183 | .endpoint = UE_ADDR_ANY, |
---|
184 | .direction = UE_DIR_OUT, |
---|
185 | .bufsize = (MCLBYTES + 2 + 64), |
---|
186 | .flags = {.pipe_bof = 1,}, |
---|
187 | .callback = kue_bulk_write_callback, |
---|
188 | .timeout = 10000, /* 10 seconds */ |
---|
189 | }, |
---|
190 | |
---|
191 | [KUE_BULK_DT_RD] = { |
---|
192 | .type = UE_BULK, |
---|
193 | .endpoint = UE_ADDR_ANY, |
---|
194 | .direction = UE_DIR_IN, |
---|
195 | .bufsize = (MCLBYTES + 2), |
---|
196 | .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, |
---|
197 | .callback = kue_bulk_read_callback, |
---|
198 | .timeout = 0, /* no timeout */ |
---|
199 | }, |
---|
200 | }; |
---|
201 | |
---|
202 | static device_method_t kue_methods[] = { |
---|
203 | /* Device interface */ |
---|
204 | DEVMETHOD(device_probe, kue_probe), |
---|
205 | DEVMETHOD(device_attach, kue_attach), |
---|
206 | DEVMETHOD(device_detach, kue_detach), |
---|
207 | |
---|
208 | DEVMETHOD_END |
---|
209 | }; |
---|
210 | |
---|
211 | static driver_t kue_driver = { |
---|
212 | .name = "kue", |
---|
213 | .methods = kue_methods, |
---|
214 | .size = sizeof(struct kue_softc), |
---|
215 | }; |
---|
216 | |
---|
217 | static devclass_t kue_devclass; |
---|
218 | |
---|
219 | DRIVER_MODULE(kue, uhub, kue_driver, kue_devclass, NULL, 0); |
---|
220 | MODULE_DEPEND(kue, uether, 1, 1, 1); |
---|
221 | MODULE_DEPEND(kue, usb, 1, 1, 1); |
---|
222 | MODULE_DEPEND(kue, ether, 1, 1, 1); |
---|
223 | MODULE_VERSION(kue, 1); |
---|
224 | USB_PNP_HOST_INFO(kue_devs); |
---|
225 | |
---|
226 | static const struct usb_ether_methods kue_ue_methods = { |
---|
227 | .ue_attach_post = kue_attach_post, |
---|
228 | .ue_start = kue_start, |
---|
229 | .ue_init = kue_init, |
---|
230 | .ue_stop = kue_stop, |
---|
231 | .ue_setmulti = kue_setmulti, |
---|
232 | .ue_setpromisc = kue_setpromisc, |
---|
233 | }; |
---|
234 | |
---|
235 | /* |
---|
236 | * We have a custom do_request function which is almost like the |
---|
237 | * regular do_request function, except it has a much longer timeout. |
---|
238 | * Why? Because we need to make requests over the control endpoint |
---|
239 | * to download the firmware to the device, which can take longer |
---|
240 | * than the default timeout. |
---|
241 | */ |
---|
242 | static int |
---|
243 | kue_do_request(struct kue_softc *sc, struct usb_device_request *req, |
---|
244 | void *data) |
---|
245 | { |
---|
246 | usb_error_t err; |
---|
247 | |
---|
248 | err = uether_do_request(&sc->sc_ue, req, data, 60000); |
---|
249 | |
---|
250 | return (err); |
---|
251 | } |
---|
252 | |
---|
253 | static int |
---|
254 | kue_setword(struct kue_softc *sc, uint8_t breq, uint16_t word) |
---|
255 | { |
---|
256 | struct usb_device_request req; |
---|
257 | |
---|
258 | req.bmRequestType = UT_WRITE_VENDOR_DEVICE; |
---|
259 | req.bRequest = breq; |
---|
260 | USETW(req.wValue, word); |
---|
261 | USETW(req.wIndex, 0); |
---|
262 | USETW(req.wLength, 0); |
---|
263 | |
---|
264 | return (kue_do_request(sc, &req, NULL)); |
---|
265 | } |
---|
266 | |
---|
267 | static int |
---|
268 | kue_ctl(struct kue_softc *sc, uint8_t rw, uint8_t breq, |
---|
269 | uint16_t val, void *data, int len) |
---|
270 | { |
---|
271 | struct usb_device_request req; |
---|
272 | |
---|
273 | if (rw == KUE_CTL_WRITE) |
---|
274 | req.bmRequestType = UT_WRITE_VENDOR_DEVICE; |
---|
275 | else |
---|
276 | req.bmRequestType = UT_READ_VENDOR_DEVICE; |
---|
277 | |
---|
278 | |
---|
279 | req.bRequest = breq; |
---|
280 | USETW(req.wValue, val); |
---|
281 | USETW(req.wIndex, 0); |
---|
282 | USETW(req.wLength, len); |
---|
283 | |
---|
284 | return (kue_do_request(sc, &req, data)); |
---|
285 | } |
---|
286 | |
---|
287 | static int |
---|
288 | kue_load_fw(struct kue_softc *sc) |
---|
289 | { |
---|
290 | struct usb_device_descriptor *dd; |
---|
291 | uint16_t hwrev; |
---|
292 | usb_error_t err; |
---|
293 | |
---|
294 | dd = usbd_get_device_descriptor(sc->sc_ue.ue_udev); |
---|
295 | hwrev = UGETW(dd->bcdDevice); |
---|
296 | |
---|
297 | /* |
---|
298 | * First, check if we even need to load the firmware. |
---|
299 | * If the device was still attached when the system was |
---|
300 | * rebooted, it may already have firmware loaded in it. |
---|
301 | * If this is the case, we don't need to do it again. |
---|
302 | * And in fact, if we try to load it again, we'll hang, |
---|
303 | * so we have to avoid this condition if we don't want |
---|
304 | * to look stupid. |
---|
305 | * |
---|
306 | * We can test this quickly by checking the bcdRevision |
---|
307 | * code. The NIC will return a different revision code if |
---|
308 | * it's probed while the firmware is still loaded and |
---|
309 | * running. |
---|
310 | */ |
---|
311 | if (hwrev == 0x0202) |
---|
312 | return(0); |
---|
313 | |
---|
314 | /* Load code segment */ |
---|
315 | err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN, |
---|
316 | 0, kue_code_seg, sizeof(kue_code_seg)); |
---|
317 | if (err) { |
---|
318 | device_printf(sc->sc_ue.ue_dev, "failed to load code segment: %s\n", |
---|
319 | usbd_errstr(err)); |
---|
320 | return(ENXIO); |
---|
321 | } |
---|
322 | |
---|
323 | /* Load fixup segment */ |
---|
324 | err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN, |
---|
325 | 0, kue_fix_seg, sizeof(kue_fix_seg)); |
---|
326 | if (err) { |
---|
327 | device_printf(sc->sc_ue.ue_dev, "failed to load fixup segment: %s\n", |
---|
328 | usbd_errstr(err)); |
---|
329 | return(ENXIO); |
---|
330 | } |
---|
331 | |
---|
332 | /* Send trigger command. */ |
---|
333 | err = kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SEND_SCAN, |
---|
334 | 0, kue_trig_seg, sizeof(kue_trig_seg)); |
---|
335 | if (err) { |
---|
336 | device_printf(sc->sc_ue.ue_dev, "failed to load trigger segment: %s\n", |
---|
337 | usbd_errstr(err)); |
---|
338 | return(ENXIO); |
---|
339 | } |
---|
340 | |
---|
341 | return (0); |
---|
342 | } |
---|
343 | |
---|
344 | static void |
---|
345 | kue_setpromisc(struct usb_ether *ue) |
---|
346 | { |
---|
347 | struct kue_softc *sc = uether_getsc(ue); |
---|
348 | struct ifnet *ifp = uether_getifp(ue); |
---|
349 | |
---|
350 | KUE_LOCK_ASSERT(sc, MA_OWNED); |
---|
351 | |
---|
352 | if (ifp->if_flags & IFF_PROMISC) |
---|
353 | sc->sc_rxfilt |= KUE_RXFILT_PROMISC; |
---|
354 | else |
---|
355 | sc->sc_rxfilt &= ~KUE_RXFILT_PROMISC; |
---|
356 | |
---|
357 | kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt); |
---|
358 | } |
---|
359 | |
---|
360 | static void |
---|
361 | kue_setmulti(struct usb_ether *ue) |
---|
362 | { |
---|
363 | struct kue_softc *sc = uether_getsc(ue); |
---|
364 | struct ifnet *ifp = uether_getifp(ue); |
---|
365 | struct ifmultiaddr *ifma; |
---|
366 | int i = 0; |
---|
367 | |
---|
368 | KUE_LOCK_ASSERT(sc, MA_OWNED); |
---|
369 | |
---|
370 | if (ifp->if_flags & IFF_ALLMULTI || ifp->if_flags & IFF_PROMISC) { |
---|
371 | sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI; |
---|
372 | sc->sc_rxfilt &= ~KUE_RXFILT_MULTICAST; |
---|
373 | kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt); |
---|
374 | return; |
---|
375 | } |
---|
376 | |
---|
377 | sc->sc_rxfilt &= ~KUE_RXFILT_ALLMULTI; |
---|
378 | |
---|
379 | if_maddr_rlock(ifp); |
---|
380 | TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) |
---|
381 | { |
---|
382 | if (ifma->ifma_addr->sa_family != AF_LINK) |
---|
383 | continue; |
---|
384 | /* |
---|
385 | * If there are too many addresses for the |
---|
386 | * internal filter, switch over to allmulti mode. |
---|
387 | */ |
---|
388 | if (i == KUE_MCFILTCNT(sc)) |
---|
389 | break; |
---|
390 | memcpy(KUE_MCFILT(sc, i), |
---|
391 | LLADDR((struct sockaddr_dl *)ifma->ifma_addr), |
---|
392 | ETHER_ADDR_LEN); |
---|
393 | i++; |
---|
394 | } |
---|
395 | if_maddr_runlock(ifp); |
---|
396 | |
---|
397 | if (i == KUE_MCFILTCNT(sc)) |
---|
398 | sc->sc_rxfilt |= KUE_RXFILT_ALLMULTI; |
---|
399 | else { |
---|
400 | sc->sc_rxfilt |= KUE_RXFILT_MULTICAST; |
---|
401 | kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MCAST_FILTERS, |
---|
402 | i, sc->sc_mcfilters, i * ETHER_ADDR_LEN); |
---|
403 | } |
---|
404 | |
---|
405 | kue_setword(sc, KUE_CMD_SET_PKT_FILTER, sc->sc_rxfilt); |
---|
406 | } |
---|
407 | |
---|
408 | /* |
---|
409 | * Issue a SET_CONFIGURATION command to reset the MAC. This should be |
---|
410 | * done after the firmware is loaded into the adapter in order to |
---|
411 | * bring it into proper operation. |
---|
412 | */ |
---|
413 | static void |
---|
414 | kue_reset(struct kue_softc *sc) |
---|
415 | { |
---|
416 | struct usb_config_descriptor *cd; |
---|
417 | usb_error_t err; |
---|
418 | |
---|
419 | cd = usbd_get_config_descriptor(sc->sc_ue.ue_udev); |
---|
420 | |
---|
421 | err = usbd_req_set_config(sc->sc_ue.ue_udev, &sc->sc_mtx, |
---|
422 | cd->bConfigurationValue); |
---|
423 | if (err) |
---|
424 | DPRINTF("reset failed (ignored)\n"); |
---|
425 | |
---|
426 | /* wait a little while for the chip to get its brains in order */ |
---|
427 | uether_pause(&sc->sc_ue, hz / 100); |
---|
428 | } |
---|
429 | |
---|
430 | static void |
---|
431 | kue_attach_post(struct usb_ether *ue) |
---|
432 | { |
---|
433 | struct kue_softc *sc = uether_getsc(ue); |
---|
434 | int error; |
---|
435 | |
---|
436 | /* load the firmware into the NIC */ |
---|
437 | error = kue_load_fw(sc); |
---|
438 | if (error) { |
---|
439 | device_printf(sc->sc_ue.ue_dev, "could not load firmware\n"); |
---|
440 | /* ignore the error */ |
---|
441 | } |
---|
442 | |
---|
443 | /* reset the adapter */ |
---|
444 | kue_reset(sc); |
---|
445 | |
---|
446 | /* read ethernet descriptor */ |
---|
447 | kue_ctl(sc, KUE_CTL_READ, KUE_CMD_GET_ETHER_DESCRIPTOR, |
---|
448 | 0, &sc->sc_desc, sizeof(sc->sc_desc)); |
---|
449 | |
---|
450 | /* copy in ethernet address */ |
---|
451 | memcpy(ue->ue_eaddr, sc->sc_desc.kue_macaddr, sizeof(ue->ue_eaddr)); |
---|
452 | } |
---|
453 | |
---|
454 | /* |
---|
455 | * Probe for a KLSI chip. |
---|
456 | */ |
---|
457 | static int |
---|
458 | kue_probe(device_t dev) |
---|
459 | { |
---|
460 | struct usb_attach_arg *uaa = device_get_ivars(dev); |
---|
461 | |
---|
462 | if (uaa->usb_mode != USB_MODE_HOST) |
---|
463 | return (ENXIO); |
---|
464 | if (uaa->info.bConfigIndex != KUE_CONFIG_IDX) |
---|
465 | return (ENXIO); |
---|
466 | if (uaa->info.bIfaceIndex != KUE_IFACE_IDX) |
---|
467 | return (ENXIO); |
---|
468 | |
---|
469 | return (usbd_lookup_id_by_uaa(kue_devs, sizeof(kue_devs), uaa)); |
---|
470 | } |
---|
471 | |
---|
472 | /* |
---|
473 | * Attach the interface. Allocate softc structures, do |
---|
474 | * setup and ethernet/BPF attach. |
---|
475 | */ |
---|
476 | static int |
---|
477 | kue_attach(device_t dev) |
---|
478 | { |
---|
479 | struct usb_attach_arg *uaa = device_get_ivars(dev); |
---|
480 | struct kue_softc *sc = device_get_softc(dev); |
---|
481 | struct usb_ether *ue = &sc->sc_ue; |
---|
482 | uint8_t iface_index; |
---|
483 | int error; |
---|
484 | |
---|
485 | device_set_usb_desc(dev); |
---|
486 | mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF); |
---|
487 | |
---|
488 | iface_index = KUE_IFACE_IDX; |
---|
489 | error = usbd_transfer_setup(uaa->device, &iface_index, |
---|
490 | sc->sc_xfer, kue_config, KUE_N_TRANSFER, sc, &sc->sc_mtx); |
---|
491 | if (error) { |
---|
492 | device_printf(dev, "allocating USB transfers failed\n"); |
---|
493 | goto detach; |
---|
494 | } |
---|
495 | |
---|
496 | sc->sc_mcfilters = malloc(KUE_MCFILTCNT(sc) * ETHER_ADDR_LEN, |
---|
497 | M_USBDEV, M_WAITOK); |
---|
498 | if (sc->sc_mcfilters == NULL) { |
---|
499 | device_printf(dev, "failed allocating USB memory\n"); |
---|
500 | goto detach; |
---|
501 | } |
---|
502 | |
---|
503 | ue->ue_sc = sc; |
---|
504 | ue->ue_dev = dev; |
---|
505 | ue->ue_udev = uaa->device; |
---|
506 | ue->ue_mtx = &sc->sc_mtx; |
---|
507 | ue->ue_methods = &kue_ue_methods; |
---|
508 | |
---|
509 | error = uether_ifattach(ue); |
---|
510 | if (error) { |
---|
511 | device_printf(dev, "could not attach interface\n"); |
---|
512 | goto detach; |
---|
513 | } |
---|
514 | return (0); /* success */ |
---|
515 | |
---|
516 | detach: |
---|
517 | kue_detach(dev); |
---|
518 | return (ENXIO); /* failure */ |
---|
519 | } |
---|
520 | |
---|
521 | static int |
---|
522 | kue_detach(device_t dev) |
---|
523 | { |
---|
524 | struct kue_softc *sc = device_get_softc(dev); |
---|
525 | struct usb_ether *ue = &sc->sc_ue; |
---|
526 | |
---|
527 | usbd_transfer_unsetup(sc->sc_xfer, KUE_N_TRANSFER); |
---|
528 | uether_ifdetach(ue); |
---|
529 | mtx_destroy(&sc->sc_mtx); |
---|
530 | free(sc->sc_mcfilters, M_USBDEV); |
---|
531 | |
---|
532 | return (0); |
---|
533 | } |
---|
534 | |
---|
535 | /* |
---|
536 | * A frame has been uploaded: pass the resulting mbuf chain up to |
---|
537 | * the higher level protocols. |
---|
538 | */ |
---|
539 | static void |
---|
540 | kue_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) |
---|
541 | { |
---|
542 | struct kue_softc *sc = usbd_xfer_softc(xfer); |
---|
543 | struct usb_ether *ue = &sc->sc_ue; |
---|
544 | struct ifnet *ifp = uether_getifp(ue); |
---|
545 | struct usb_page_cache *pc; |
---|
546 | uint8_t buf[2]; |
---|
547 | int len; |
---|
548 | int actlen; |
---|
549 | |
---|
550 | usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); |
---|
551 | |
---|
552 | switch (USB_GET_STATE(xfer)) { |
---|
553 | case USB_ST_TRANSFERRED: |
---|
554 | |
---|
555 | if (actlen <= (int)(2 + sizeof(struct ether_header))) { |
---|
556 | if_inc_counter(ifp, IFCOUNTER_IERRORS, 1); |
---|
557 | goto tr_setup; |
---|
558 | } |
---|
559 | pc = usbd_xfer_get_frame(xfer, 0); |
---|
560 | usbd_copy_out(pc, 0, buf, 2); |
---|
561 | actlen -= 2; |
---|
562 | len = buf[0] | (buf[1] << 8); |
---|
563 | len = min(actlen, len); |
---|
564 | |
---|
565 | uether_rxbuf(ue, pc, 2, len); |
---|
566 | /* FALLTHROUGH */ |
---|
567 | case USB_ST_SETUP: |
---|
568 | tr_setup: |
---|
569 | usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); |
---|
570 | usbd_transfer_submit(xfer); |
---|
571 | uether_rxflush(ue); |
---|
572 | return; |
---|
573 | |
---|
574 | default: /* Error */ |
---|
575 | DPRINTF("bulk read error, %s\n", |
---|
576 | usbd_errstr(error)); |
---|
577 | |
---|
578 | if (error != USB_ERR_CANCELLED) { |
---|
579 | /* try to clear stall first */ |
---|
580 | usbd_xfer_set_stall(xfer); |
---|
581 | goto tr_setup; |
---|
582 | } |
---|
583 | return; |
---|
584 | |
---|
585 | } |
---|
586 | } |
---|
587 | |
---|
588 | static void |
---|
589 | kue_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) |
---|
590 | { |
---|
591 | struct kue_softc *sc = usbd_xfer_softc(xfer); |
---|
592 | struct ifnet *ifp = uether_getifp(&sc->sc_ue); |
---|
593 | struct usb_page_cache *pc; |
---|
594 | struct mbuf *m; |
---|
595 | int total_len; |
---|
596 | int temp_len; |
---|
597 | uint8_t buf[2]; |
---|
598 | |
---|
599 | switch (USB_GET_STATE(xfer)) { |
---|
600 | case USB_ST_TRANSFERRED: |
---|
601 | DPRINTFN(11, "transfer complete\n"); |
---|
602 | if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1); |
---|
603 | |
---|
604 | /* FALLTHROUGH */ |
---|
605 | case USB_ST_SETUP: |
---|
606 | tr_setup: |
---|
607 | IFQ_DRV_DEQUEUE(&ifp->if_snd, m); |
---|
608 | |
---|
609 | if (m == NULL) |
---|
610 | return; |
---|
611 | if (m->m_pkthdr.len > MCLBYTES) |
---|
612 | m->m_pkthdr.len = MCLBYTES; |
---|
613 | temp_len = (m->m_pkthdr.len + 2); |
---|
614 | total_len = (temp_len + (64 - (temp_len % 64))); |
---|
615 | |
---|
616 | /* the first two bytes are the frame length */ |
---|
617 | |
---|
618 | buf[0] = (uint8_t)(m->m_pkthdr.len); |
---|
619 | buf[1] = (uint8_t)(m->m_pkthdr.len >> 8); |
---|
620 | |
---|
621 | pc = usbd_xfer_get_frame(xfer, 0); |
---|
622 | usbd_copy_in(pc, 0, buf, 2); |
---|
623 | usbd_m_copy_in(pc, 2, m, 0, m->m_pkthdr.len); |
---|
624 | |
---|
625 | usbd_frame_zero(pc, temp_len, total_len - temp_len); |
---|
626 | usbd_xfer_set_frame_len(xfer, 0, total_len); |
---|
627 | |
---|
628 | /* |
---|
629 | * if there's a BPF listener, bounce a copy |
---|
630 | * of this frame to him: |
---|
631 | */ |
---|
632 | BPF_MTAP(ifp, m); |
---|
633 | |
---|
634 | m_freem(m); |
---|
635 | |
---|
636 | usbd_transfer_submit(xfer); |
---|
637 | |
---|
638 | return; |
---|
639 | |
---|
640 | default: /* Error */ |
---|
641 | DPRINTFN(11, "transfer error, %s\n", |
---|
642 | usbd_errstr(error)); |
---|
643 | |
---|
644 | if_inc_counter(ifp, IFCOUNTER_OERRORS, 1); |
---|
645 | |
---|
646 | if (error != USB_ERR_CANCELLED) { |
---|
647 | /* try to clear stall first */ |
---|
648 | usbd_xfer_set_stall(xfer); |
---|
649 | goto tr_setup; |
---|
650 | } |
---|
651 | return; |
---|
652 | |
---|
653 | } |
---|
654 | } |
---|
655 | |
---|
656 | static void |
---|
657 | kue_start(struct usb_ether *ue) |
---|
658 | { |
---|
659 | struct kue_softc *sc = uether_getsc(ue); |
---|
660 | |
---|
661 | /* |
---|
662 | * start the USB transfers, if not already started: |
---|
663 | */ |
---|
664 | usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_RD]); |
---|
665 | usbd_transfer_start(sc->sc_xfer[KUE_BULK_DT_WR]); |
---|
666 | } |
---|
667 | |
---|
668 | static void |
---|
669 | kue_init(struct usb_ether *ue) |
---|
670 | { |
---|
671 | struct kue_softc *sc = uether_getsc(ue); |
---|
672 | struct ifnet *ifp = uether_getifp(ue); |
---|
673 | |
---|
674 | KUE_LOCK_ASSERT(sc, MA_OWNED); |
---|
675 | |
---|
676 | /* set MAC address */ |
---|
677 | kue_ctl(sc, KUE_CTL_WRITE, KUE_CMD_SET_MAC, |
---|
678 | 0, IF_LLADDR(ifp), ETHER_ADDR_LEN); |
---|
679 | |
---|
680 | /* I'm not sure how to tune these. */ |
---|
681 | #if 0 |
---|
682 | /* |
---|
683 | * Leave this one alone for now; setting it |
---|
684 | * wrong causes lockups on some machines/controllers. |
---|
685 | */ |
---|
686 | kue_setword(sc, KUE_CMD_SET_SOFS, 1); |
---|
687 | #endif |
---|
688 | kue_setword(sc, KUE_CMD_SET_URB_SIZE, 64); |
---|
689 | |
---|
690 | /* load the multicast filter */ |
---|
691 | kue_setpromisc(ue); |
---|
692 | |
---|
693 | usbd_xfer_set_stall(sc->sc_xfer[KUE_BULK_DT_WR]); |
---|
694 | |
---|
695 | ifp->if_drv_flags |= IFF_DRV_RUNNING; |
---|
696 | kue_start(ue); |
---|
697 | } |
---|
698 | |
---|
699 | static void |
---|
700 | kue_stop(struct usb_ether *ue) |
---|
701 | { |
---|
702 | struct kue_softc *sc = uether_getsc(ue); |
---|
703 | struct ifnet *ifp = uether_getifp(ue); |
---|
704 | |
---|
705 | KUE_LOCK_ASSERT(sc, MA_OWNED); |
---|
706 | |
---|
707 | ifp->if_drv_flags &= ~IFF_DRV_RUNNING; |
---|
708 | |
---|
709 | /* |
---|
710 | * stop all the transfers, if not already stopped: |
---|
711 | */ |
---|
712 | usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_WR]); |
---|
713 | usbd_transfer_stop(sc->sc_xfer[KUE_BULK_DT_RD]); |
---|
714 | } |
---|