3
4/*
5 * Copyright (c) 2007 Marcus Glocker <mglocker@openbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20#include <sys/param.h>
21#include <sys/systm.h>
22#include <sys/kernel.h>
23#include <sys/endian.h>
24#include <sys/firmware.h>
25#include <sys/linker.h>
26#include <sys/mbuf.h>
27#include <sys/malloc.h>
28#include <sys/module.h>
29#include <sys/socket.h>
30#include <sys/sockio.h>
31#include <sys/sysctl.h>
32
33#include <net/if.h>
34#include <net/if_arp.h>
35#include <net/ethernet.h>
36#include <net/if_dl.h>
37#include <net/if_media.h>
38#include <net/if_types.h>
39
40#include <sys/bus.h>
41#include <machine/bus.h>
42
43#include <net80211/ieee80211_var.h>
44#include <net80211/ieee80211_phy.h>
45#include <net80211/ieee80211_radiotap.h>
46#include <net80211/ieee80211_regdomain.h>
47
48#include <net/bpf.h>
49
50#include <dev/usb/usb.h>
51#include <dev/usb/usbdi.h>
52#include "usbdevs.h"
53
54#include <dev/usb/wlan/if_upgtvar.h>
55
56/*
57 * Driver for the USB PrismGT devices.
58 *
59 * For now just USB 2.0 devices with the GW3887 chipset are supported.
60 * The driver has been written based on the firmware version 2.13.1.0_LM87.
61 *
62 * TODO's:
63 * - MONITOR mode test.
64 * - Add HOSTAP mode.
65 * - Add IBSS mode.
66 * - Support the USB 1.0 devices (NET2280, ISL3880, ISL3886 chipsets).
67 *
68 * Parts of this driver has been influenced by reading the p54u driver
69 * written by Jean-Baptiste Note <jean-baptiste.note@m4x.org> and
70 * Sebastien Bourdeauducq <lekernel@prism54.org>.
71 */
72
73static SYSCTL_NODE(_hw, OID_AUTO, upgt, CTLFLAG_RD, 0,
74 "USB PrismGT GW3887 driver parameters");
75
76#ifdef UPGT_DEBUG
77int upgt_debug = 0;
78SYSCTL_INT(_hw_upgt, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN, &upgt_debug,
79 0, "control debugging printfs");
80TUNABLE_INT("hw.upgt.debug", &upgt_debug);
81enum {
82 UPGT_DEBUG_XMIT = 0x00000001, /* basic xmit operation */
83 UPGT_DEBUG_RECV = 0x00000002, /* basic recv operation */
84 UPGT_DEBUG_RESET = 0x00000004, /* reset processing */
85 UPGT_DEBUG_INTR = 0x00000008, /* INTR */
86 UPGT_DEBUG_TX_PROC = 0x00000010, /* tx ISR proc */
87 UPGT_DEBUG_RX_PROC = 0x00000020, /* rx ISR proc */
88 UPGT_DEBUG_STATE = 0x00000040, /* 802.11 state transitions */
89 UPGT_DEBUG_STAT = 0x00000080, /* statistic */
90 UPGT_DEBUG_FW = 0x00000100, /* firmware */
91 UPGT_DEBUG_ANY = 0xffffffff
92};
93#define DPRINTF(sc, m, fmt, ...) do { \
94 if (sc->sc_debug & (m)) \
95 printf(fmt, __VA_ARGS__); \
96} while (0)
97#else
98#define DPRINTF(sc, m, fmt, ...) do { \
99 (void) sc; \
100} while (0)
101#endif
102
103/*
104 * Prototypes.
105 */
106static device_probe_t upgt_match;
107static device_attach_t upgt_attach;
108static device_detach_t upgt_detach;
109static int upgt_alloc_tx(struct upgt_softc *);
110static int upgt_alloc_rx(struct upgt_softc *);
111static int upgt_device_reset(struct upgt_softc *);
112static void upgt_bulk_tx(struct upgt_softc *, struct upgt_data *);
113static int upgt_fw_verify(struct upgt_softc *);
114static int upgt_mem_init(struct upgt_softc *);
115static int upgt_fw_load(struct upgt_softc *);
116static int upgt_fw_copy(const uint8_t *, char *, int);
117static uint32_t upgt_crc32_le(const void *, size_t);
118static struct mbuf *
119 upgt_rxeof(struct usb_xfer *, struct upgt_data *, int *);
120static struct mbuf *
121 upgt_rx(struct upgt_softc *, uint8_t *, int, int *);
122static void upgt_txeof(struct usb_xfer *, struct upgt_data *);
123static int upgt_eeprom_read(struct upgt_softc *);
124static int upgt_eeprom_parse(struct upgt_softc *);
125static void upgt_eeprom_parse_hwrx(struct upgt_softc *, uint8_t *);
126static void upgt_eeprom_parse_freq3(struct upgt_softc *, uint8_t *, int);
127static void upgt_eeprom_parse_freq4(struct upgt_softc *, uint8_t *, int);
128static void upgt_eeprom_parse_freq6(struct upgt_softc *, uint8_t *, int);
129static uint32_t upgt_chksum_le(const uint32_t *, size_t);
130static void upgt_tx_done(struct upgt_softc *, uint8_t *);
131static void upgt_init(void *);
132static void upgt_init_locked(struct upgt_softc *);
133static int upgt_ioctl(struct ifnet *, u_long, caddr_t);
134static void upgt_start(struct ifnet *);
135static int upgt_raw_xmit(struct ieee80211_node *, struct mbuf *,
136 const struct ieee80211_bpf_params *);
137static void upgt_scan_start(struct ieee80211com *);
138static void upgt_scan_end(struct ieee80211com *);
139static void upgt_set_channel(struct ieee80211com *);
140static struct ieee80211vap *upgt_vap_create(struct ieee80211com *,
141 const char [IFNAMSIZ], int, enum ieee80211_opmode, int,
142 const uint8_t [IEEE80211_ADDR_LEN],
143 const uint8_t [IEEE80211_ADDR_LEN]);
144static void upgt_vap_delete(struct ieee80211vap *);
145static void upgt_update_mcast(struct ifnet *);
146static uint8_t upgt_rx_rate(struct upgt_softc *, const int);
147static void upgt_set_multi(void *);
148static void upgt_stop(struct upgt_softc *);
149static void upgt_setup_rates(struct ieee80211vap *, struct ieee80211com *);
150static int upgt_set_macfilter(struct upgt_softc *, uint8_t);
151static int upgt_newstate(struct ieee80211vap *, enum ieee80211_state, int);
152static void upgt_set_chan(struct upgt_softc *, struct ieee80211_channel *);
153static void upgt_set_led(struct upgt_softc *, int);
154static void upgt_set_led_blink(void *);
155static void upgt_get_stats(struct upgt_softc *);
156static void upgt_mem_free(struct upgt_softc *, uint32_t);
157static uint32_t upgt_mem_alloc(struct upgt_softc *);
158static void upgt_free_tx(struct upgt_softc *);
159static void upgt_free_rx(struct upgt_softc *);
160static void upgt_watchdog(void *);
161static void upgt_abort_xfers(struct upgt_softc *);
162static void upgt_abort_xfers_locked(struct upgt_softc *);
163static void upgt_sysctl_node(struct upgt_softc *);
164static struct upgt_data *
165 upgt_getbuf(struct upgt_softc *);
166static struct upgt_data *
167 upgt_gettxbuf(struct upgt_softc *);
168static int upgt_tx_start(struct upgt_softc *, struct mbuf *,
169 struct ieee80211_node *, struct upgt_data *);
170
171static const char *upgt_fwname = "upgt-gw3887";
172
173static const STRUCT_USB_HOST_ID upgt_devs[] = {
174#define UPGT_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
175 /* version 2 devices */
176 UPGT_DEV(ACCTON, PRISM_GT),
177 UPGT_DEV(BELKIN, F5D7050),
178 UPGT_DEV(CISCOLINKSYS, WUSB54AG),
179 UPGT_DEV(CONCEPTRONIC, PRISM_GT),
180 UPGT_DEV(DELL, PRISM_GT_1),
181 UPGT_DEV(DELL, PRISM_GT_2),
182 UPGT_DEV(FSC, E5400),
183 UPGT_DEV(GLOBESPAN, PRISM_GT_1),
184 UPGT_DEV(GLOBESPAN, PRISM_GT_2),
185 UPGT_DEV(NETGEAR, WG111V2_2),
186 UPGT_DEV(INTERSIL, PRISM_GT),
187 UPGT_DEV(SMC, 2862WG),
188 UPGT_DEV(USR, USR5422),
189 UPGT_DEV(WISTRONNEWEB, UR045G),
190 UPGT_DEV(XYRATEX, PRISM_GT_1),
191 UPGT_DEV(XYRATEX, PRISM_GT_2),
192 UPGT_DEV(ZCOM, XG703A),
193 UPGT_DEV(ZCOM, XM142)
194};
195
196static usb_callback_t upgt_bulk_rx_callback;
197static usb_callback_t upgt_bulk_tx_callback;
198
199static const struct usb_config upgt_config[UPGT_N_XFERS] = {
200 [UPGT_BULK_TX] = {
201 .type = UE_BULK,
202 .endpoint = UE_ADDR_ANY,
203 .direction = UE_DIR_OUT,
204 .bufsize = MCLBYTES * UPGT_TX_MAXCOUNT,
205 .flags = {
206 .force_short_xfer = 1,
207 .pipe_bof = 1
208 },
209 .callback = upgt_bulk_tx_callback,
210 .timeout = UPGT_USB_TIMEOUT, /* ms */
211 },
212 [UPGT_BULK_RX] = {
213 .type = UE_BULK,
214 .endpoint = UE_ADDR_ANY,
215 .direction = UE_DIR_IN,
216 .bufsize = MCLBYTES * UPGT_RX_MAXCOUNT,
217 .flags = {
218 .pipe_bof = 1,
219 .short_xfer_ok = 1
220 },
221 .callback = upgt_bulk_rx_callback,
222 },
223};
224
225static int
226upgt_match(device_t dev)
227{
228 struct usb_attach_arg *uaa = device_get_ivars(dev);
229
230 if (uaa->usb_mode != USB_MODE_HOST)
231 return (ENXIO);
232 if (uaa->info.bConfigIndex != UPGT_CONFIG_INDEX)
233 return (ENXIO);
234 if (uaa->info.bIfaceIndex != UPGT_IFACE_INDEX)
235 return (ENXIO);
236
237 return (usbd_lookup_id_by_uaa(upgt_devs, sizeof(upgt_devs), uaa));
238}
239
240static int
241upgt_attach(device_t dev)
242{
243 int error;
244 struct ieee80211com *ic;
245 struct ifnet *ifp;
246 struct upgt_softc *sc = device_get_softc(dev);
247 struct usb_attach_arg *uaa = device_get_ivars(dev);
248 uint8_t bands, iface_index = UPGT_IFACE_INDEX;
249
250 sc->sc_dev = dev;
251 sc->sc_udev = uaa->device;
252#ifdef UPGT_DEBUG
253 sc->sc_debug = upgt_debug;
254#endif
255 device_set_usb_desc(dev);
256
257 mtx_init(&sc->sc_mtx, device_get_nameunit(sc->sc_dev), MTX_NETWORK_LOCK,
258 MTX_DEF);
259 callout_init(&sc->sc_led_ch, 0);
260 callout_init(&sc->sc_watchdog_ch, 0);
261
262 error = usbd_transfer_setup(uaa->device, &iface_index, sc->sc_xfer,
263 upgt_config, UPGT_N_XFERS, sc, &sc->sc_mtx);
264 if (error) {
265 device_printf(dev, "could not allocate USB transfers, "
266 "err=%s\n", usbd_errstr(error));
267 goto fail1;
268 }
269
270 sc->sc_rx_dma_buf = usbd_xfer_get_frame_buffer(
271 sc->sc_xfer[UPGT_BULK_RX], 0);
272 sc->sc_tx_dma_buf = usbd_xfer_get_frame_buffer(
273 sc->sc_xfer[UPGT_BULK_TX], 0);
274
275 /* Setup TX and RX buffers */
276 error = upgt_alloc_tx(sc);
277 if (error)
278 goto fail2;
279 error = upgt_alloc_rx(sc);
280 if (error)
281 goto fail3;
282
283 ifp = sc->sc_ifp = if_alloc(IFT_IEEE80211);
284 if (ifp == NULL) {
285 device_printf(dev, "can not if_alloc()\n");
286 goto fail4;
287 }
288
289 /* Initialize the device. */
290 error = upgt_device_reset(sc);
291 if (error)
292 goto fail5;
293 /* Verify the firmware. */
294 error = upgt_fw_verify(sc);
295 if (error)
296 goto fail5;
297 /* Calculate device memory space. */
298 if (sc->sc_memaddr_frame_start == 0 || sc->sc_memaddr_frame_end == 0) {
299 device_printf(dev,
300 "could not find memory space addresses on FW\n");
301 error = EIO;
302 goto fail5;
303 }
304 sc->sc_memaddr_frame_end -= UPGT_MEMSIZE_RX + 1;
305 sc->sc_memaddr_rx_start = sc->sc_memaddr_frame_end + 1;
306
307 DPRINTF(sc, UPGT_DEBUG_FW, "memory address frame start=0x%08x\n",
308 sc->sc_memaddr_frame_start);
309 DPRINTF(sc, UPGT_DEBUG_FW, "memory address frame end=0x%08x\n",
310 sc->sc_memaddr_frame_end);
311 DPRINTF(sc, UPGT_DEBUG_FW, "memory address rx start=0x%08x\n",
312 sc->sc_memaddr_rx_start);
313
314 upgt_mem_init(sc);
315
316 /* Load the firmware. */
317 error = upgt_fw_load(sc);
318 if (error)
319 goto fail5;
320
321 /* Read the whole EEPROM content and parse it. */
322 error = upgt_eeprom_read(sc);
323 if (error)
324 goto fail5;
325 error = upgt_eeprom_parse(sc);
326 if (error)
327 goto fail5;
328
329 /* all works related with the device have done here. */
330 upgt_abort_xfers(sc);
331
332 /* Setup the 802.11 device. */
333 ifp->if_softc = sc;
334 if_initname(ifp, "upgt", device_get_unit(sc->sc_dev));
335 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
336 ifp->if_init = upgt_init;
337 ifp->if_ioctl = upgt_ioctl;
338 ifp->if_start = upgt_start;
339 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
340 IFQ_SET_READY(&ifp->if_snd);
341
342 ic = ifp->if_l2com;
343 ic->ic_ifp = ifp;
344 ic->ic_phytype = IEEE80211_T_OFDM; /* not only, but not used */
345 ic->ic_opmode = IEEE80211_M_STA;
346 /* set device capabilities */
347 ic->ic_caps =
348 IEEE80211_C_STA /* station mode */
349 | IEEE80211_C_MONITOR /* monitor mode */
350 | IEEE80211_C_SHPREAMBLE /* short preamble supported */
351 | IEEE80211_C_SHSLOT /* short slot time supported */
352 | IEEE80211_C_BGSCAN /* capable of bg scanning */
353 | IEEE80211_C_WPA /* 802.11i */
354 ;
355
356 bands = 0;
357 setbit(&bands, IEEE80211_MODE_11B);
358 setbit(&bands, IEEE80211_MODE_11G);
359 ieee80211_init_channels(ic, NULL, &bands);
360
361 ieee80211_ifattach(ic, sc->sc_myaddr);
362 ic->ic_raw_xmit = upgt_raw_xmit;
363 ic->ic_scan_start = upgt_scan_start;
364 ic->ic_scan_end = upgt_scan_end;
365 ic->ic_set_channel = upgt_set_channel;
366
367 ic->ic_vap_create = upgt_vap_create;
368 ic->ic_vap_delete = upgt_vap_delete;
369 ic->ic_update_mcast = upgt_update_mcast;
370
371 ieee80211_radiotap_attach(ic,
372 &sc->sc_txtap.wt_ihdr, sizeof(sc->sc_txtap),
373 UPGT_TX_RADIOTAP_PRESENT,
374 &sc->sc_rxtap.wr_ihdr, sizeof(sc->sc_rxtap),
375 UPGT_RX_RADIOTAP_PRESENT);
376
377 upgt_sysctl_node(sc);
378
379 if (bootverbose)
380 ieee80211_announce(ic);
381
382 return (0);
383
384fail5: if_free(ifp);
385fail4: upgt_free_rx(sc);
386fail3: upgt_free_tx(sc);
387fail2: usbd_transfer_unsetup(sc->sc_xfer, UPGT_N_XFERS);
388fail1: mtx_destroy(&sc->sc_mtx);
389
390 return (error);
391}
392
393static void
394upgt_txeof(struct usb_xfer *xfer, struct upgt_data *data)
395{
396 struct upgt_softc *sc = usbd_xfer_softc(xfer);
397 struct ifnet *ifp = sc->sc_ifp;
398 struct mbuf *m;
399
400 UPGT_ASSERT_LOCKED(sc);
401
402 /*
403 * Do any tx complete callback. Note this must be done before releasing
404 * the node reference.
405 */
406 if (data->m) {
407 m = data->m;
408 if (m->m_flags & M_TXCB) {
409 /* XXX status? */
410 ieee80211_process_callback(data->ni, m, 0);
411 }
412 m_freem(m);
413 data->m = NULL;
414 }
415 if (data->ni) {
416 ieee80211_free_node(data->ni);
417 data->ni = NULL;
418 }
419 ifp->if_opackets++;
420}
421
422static void
423upgt_get_stats(struct upgt_softc *sc)
424{
425 struct upgt_data *data_cmd;
426 struct upgt_lmac_mem *mem;
427 struct upgt_lmac_stats *stats;
428
429 data_cmd = upgt_getbuf(sc);
430 if (data_cmd == NULL) {
431 device_printf(sc->sc_dev, "%s: out of buffer.\n", __func__);
432 return;
433 }
434
435 /*
436 * Transmit the URB containing the CMD data.
437 */
438 memset(data_cmd->buf, 0, MCLBYTES);
439
440 mem = (struct upgt_lmac_mem *)data_cmd->buf;
441 mem->addr = htole32(sc->sc_memaddr_frame_start +
442 UPGT_MEMSIZE_FRAME_HEAD);
443
444 stats = (struct upgt_lmac_stats *)(mem + 1);
445
446 stats->header1.flags = 0;
447 stats->header1.type = UPGT_H1_TYPE_CTRL;
448 stats->header1.len = htole16(
449 sizeof(struct upgt_lmac_stats) - sizeof(struct upgt_lmac_header));
450
451 stats->header2.reqid = htole32(sc->sc_memaddr_frame_start);
452 stats->header2.type = htole16(UPGT_H2_TYPE_STATS);
453 stats->header2.flags = 0;
454
455 data_cmd->buflen = sizeof(*mem) + sizeof(*stats);
456
457 mem->chksum = upgt_chksum_le((uint32_t *)stats,
458 data_cmd->buflen - sizeof(*mem));
459
460 upgt_bulk_tx(sc, data_cmd);
461}
462
463static int
464upgt_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
465{
466 struct upgt_softc *sc = ifp->if_softc;
467 struct ieee80211com *ic = ifp->if_l2com;
468 struct ifreq *ifr = (struct ifreq *) data;
|
478 switch (cmd) {
479 case SIOCSIFFLAGS:
480 if (ifp->if_flags & IFF_UP) {
481 if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
482 if ((ifp->if_flags ^ sc->sc_if_flags) &
483 (IFF_ALLMULTI | IFF_PROMISC))
484 upgt_set_multi(sc);
485 } else {
486 upgt_init(sc);
487 startall = 1;
488 }
489 } else {
490 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
491 upgt_stop(sc);
492 }
493 sc->sc_if_flags = ifp->if_flags;
494 if (startall)
495 ieee80211_start_all(ic);
496 break;
497 case SIOCGIFMEDIA:
498 error = ifmedia_ioctl(ifp, ifr, &ic->ic_media, cmd);
499 break;
500 case SIOCGIFADDR:
501 error = ether_ioctl(ifp, cmd, data);
502 break;
503 default:
504 error = EINVAL;
505 break;
506 }
507 return error;
508}
509
510static void
511upgt_stop_locked(struct upgt_softc *sc)
512{
513 struct ifnet *ifp = sc->sc_ifp;
514
515 UPGT_ASSERT_LOCKED(sc);
516
517 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
518 upgt_set_macfilter(sc, IEEE80211_S_INIT);
519 upgt_abort_xfers_locked(sc);
520}
521
522static void
523upgt_stop(struct upgt_softc *sc)
524{
525 struct ifnet *ifp = sc->sc_ifp;
526
527 UPGT_LOCK(sc);
528 upgt_stop_locked(sc);
529 UPGT_UNLOCK(sc);
530
531 /* device down */
532 sc->sc_tx_timer = 0;
533 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
534 sc->sc_flags &= ~UPGT_FLAG_INITDONE;
535}
536
537static void
538upgt_set_led(struct upgt_softc *sc, int action)
539{
540 struct upgt_data *data_cmd;
541 struct upgt_lmac_mem *mem;
542 struct upgt_lmac_led *led;
543
544 data_cmd = upgt_getbuf(sc);
545 if (data_cmd == NULL) {
546 device_printf(sc->sc_dev, "%s: out of buffers.\n", __func__);
547 return;
548 }
549
550 /*
551 * Transmit the URB containing the CMD data.
552 */
553 memset(data_cmd->buf, 0, MCLBYTES);
554
555 mem = (struct upgt_lmac_mem *)data_cmd->buf;
556 mem->addr = htole32(sc->sc_memaddr_frame_start +
557 UPGT_MEMSIZE_FRAME_HEAD);
558
559 led = (struct upgt_lmac_led *)(mem + 1);
560
561 led->header1.flags = UPGT_H1_FLAGS_TX_NO_CALLBACK;
562 led->header1.type = UPGT_H1_TYPE_CTRL;
563 led->header1.len = htole16(
564 sizeof(struct upgt_lmac_led) -
565 sizeof(struct upgt_lmac_header));
566
567 led->header2.reqid = htole32(sc->sc_memaddr_frame_start);
568 led->header2.type = htole16(UPGT_H2_TYPE_LED);
569 led->header2.flags = 0;
570
571 switch (action) {
572 case UPGT_LED_OFF:
573 led->mode = htole16(UPGT_LED_MODE_SET);
574 led->action_fix = 0;
575 led->action_tmp = htole16(UPGT_LED_ACTION_OFF);
576 led->action_tmp_dur = 0;
577 break;
578 case UPGT_LED_ON:
579 led->mode = htole16(UPGT_LED_MODE_SET);
580 led->action_fix = 0;
581 led->action_tmp = htole16(UPGT_LED_ACTION_ON);
582 led->action_tmp_dur = 0;
583 break;
584 case UPGT_LED_BLINK:
585 if (sc->sc_state != IEEE80211_S_RUN) {
586 STAILQ_INSERT_TAIL(&sc->sc_tx_inactive, data_cmd, next);
587 return;
588 }
589 if (sc->sc_led_blink) {
590 /* previous blink was not finished */
591 STAILQ_INSERT_TAIL(&sc->sc_tx_inactive, data_cmd, next);
592 return;
593 }
594 led->mode = htole16(UPGT_LED_MODE_SET);
595 led->action_fix = htole16(UPGT_LED_ACTION_OFF);
596 led->action_tmp = htole16(UPGT_LED_ACTION_ON);
597 led->action_tmp_dur = htole16(UPGT_LED_ACTION_TMP_DUR);
598 /* lock blink */
599 sc->sc_led_blink = 1;
600 callout_reset(&sc->sc_led_ch, hz, upgt_set_led_blink, sc);
601 break;
602 default:
603 STAILQ_INSERT_TAIL(&sc->sc_tx_inactive, data_cmd, next);
604 return;
605 }
606
607 data_cmd->buflen = sizeof(*mem) + sizeof(*led);
608
609 mem->chksum = upgt_chksum_le((uint32_t *)led,
610 data_cmd->buflen - sizeof(*mem));
611
612 upgt_bulk_tx(sc, data_cmd);
613}
614
615static void
616upgt_set_led_blink(void *arg)
617{
618 struct upgt_softc *sc = arg;
619
620 /* blink finished, we are ready for a next one */
621 sc->sc_led_blink = 0;
622}
623
624static void
625upgt_init(void *priv)
626{
627 struct upgt_softc *sc = priv;
628 struct ifnet *ifp = sc->sc_ifp;
629 struct ieee80211com *ic = ifp->if_l2com;
630
631 UPGT_LOCK(sc);
632 upgt_init_locked(sc);
633 UPGT_UNLOCK(sc);
634
635 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
636 ieee80211_start_all(ic); /* start all vap's */
637}
638
639static void
640upgt_init_locked(struct upgt_softc *sc)
641{
642 struct ifnet *ifp = sc->sc_ifp;
643
644 UPGT_ASSERT_LOCKED(sc);
645
646 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
647 upgt_stop_locked(sc);
648
649 usbd_transfer_start(sc->sc_xfer[UPGT_BULK_RX]);
650
651 (void)upgt_set_macfilter(sc, IEEE80211_S_SCAN);
652
653 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
654 ifp->if_drv_flags |= IFF_DRV_RUNNING;
655 sc->sc_flags |= UPGT_FLAG_INITDONE;
656
657 callout_reset(&sc->sc_watchdog_ch, hz, upgt_watchdog, sc);
658}
659
660static int
661upgt_set_macfilter(struct upgt_softc *sc, uint8_t state)
662{
663 struct ifnet *ifp = sc->sc_ifp;
664 struct ieee80211com *ic = ifp->if_l2com;
665 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
666 struct ieee80211_node *ni;
667 struct upgt_data *data_cmd;
668 struct upgt_lmac_mem *mem;
669 struct upgt_lmac_filter *filter;
670 uint8_t broadcast[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
671
672 UPGT_ASSERT_LOCKED(sc);
673
674 data_cmd = upgt_getbuf(sc);
675 if (data_cmd == NULL) {
676 device_printf(sc->sc_dev, "out of TX buffers.\n");
677 return (ENOBUFS);
678 }
679
680 /*
681 * Transmit the URB containing the CMD data.
682 */
683 memset(data_cmd->buf, 0, MCLBYTES);
684
685 mem = (struct upgt_lmac_mem *)data_cmd->buf;
686 mem->addr = htole32(sc->sc_memaddr_frame_start +
687 UPGT_MEMSIZE_FRAME_HEAD);
688
689 filter = (struct upgt_lmac_filter *)(mem + 1);
690
691 filter->header1.flags = UPGT_H1_FLAGS_TX_NO_CALLBACK;
692 filter->header1.type = UPGT_H1_TYPE_CTRL;
693 filter->header1.len = htole16(
694 sizeof(struct upgt_lmac_filter) -
695 sizeof(struct upgt_lmac_header));
696
697 filter->header2.reqid = htole32(sc->sc_memaddr_frame_start);
698 filter->header2.type = htole16(UPGT_H2_TYPE_MACFILTER);
699 filter->header2.flags = 0;
700
701 switch (state) {
702 case IEEE80211_S_INIT:
703 DPRINTF(sc, UPGT_DEBUG_STATE, "%s: set MAC filter to INIT\n",
704 __func__);
705 filter->type = htole16(UPGT_FILTER_TYPE_RESET);
706 break;
707 case IEEE80211_S_SCAN:
708 DPRINTF(sc, UPGT_DEBUG_STATE,
709 "set MAC filter to SCAN (bssid %s)\n",
710 ether_sprintf(broadcast));
711 filter->type = htole16(UPGT_FILTER_TYPE_NONE);
712 IEEE80211_ADDR_COPY(filter->dst, sc->sc_myaddr);
713 IEEE80211_ADDR_COPY(filter->src, broadcast);
714 filter->unknown1 = htole16(UPGT_FILTER_UNKNOWN1);
715 filter->rxaddr = htole32(sc->sc_memaddr_rx_start);
716 filter->unknown2 = htole16(UPGT_FILTER_UNKNOWN2);
717 filter->rxhw = htole32(sc->sc_eeprom_hwrx);
718 filter->unknown3 = htole16(UPGT_FILTER_UNKNOWN3);
719 break;
720 case IEEE80211_S_RUN:
721 ni = ieee80211_ref_node(vap->iv_bss);
722 /* XXX monitor mode isn't tested yet. */
723 if (vap->iv_opmode == IEEE80211_M_MONITOR) {
724 filter->type = htole16(UPGT_FILTER_TYPE_MONITOR);
725 IEEE80211_ADDR_COPY(filter->dst, sc->sc_myaddr);
726 IEEE80211_ADDR_COPY(filter->src, ni->ni_bssid);
727 filter->unknown1 = htole16(UPGT_FILTER_MONITOR_UNKNOWN1);
728 filter->rxaddr = htole32(sc->sc_memaddr_rx_start);
729 filter->unknown2 = htole16(UPGT_FILTER_MONITOR_UNKNOWN2);
730 filter->rxhw = htole32(sc->sc_eeprom_hwrx);
731 filter->unknown3 = htole16(UPGT_FILTER_MONITOR_UNKNOWN3);
732 } else {
733 DPRINTF(sc, UPGT_DEBUG_STATE,
734 "set MAC filter to RUN (bssid %s)\n",
735 ether_sprintf(ni->ni_bssid));
736 filter->type = htole16(UPGT_FILTER_TYPE_STA);
737 IEEE80211_ADDR_COPY(filter->dst, sc->sc_myaddr);
738 IEEE80211_ADDR_COPY(filter->src, ni->ni_bssid);
739 filter->unknown1 = htole16(UPGT_FILTER_UNKNOWN1);
740 filter->rxaddr = htole32(sc->sc_memaddr_rx_start);
741 filter->unknown2 = htole16(UPGT_FILTER_UNKNOWN2);
742 filter->rxhw = htole32(sc->sc_eeprom_hwrx);
743 filter->unknown3 = htole16(UPGT_FILTER_UNKNOWN3);
744 }
745 ieee80211_free_node(ni);
746 break;
747 default:
748 device_printf(sc->sc_dev,
749 "MAC filter does not know that state\n");
750 break;
751 }
752
753 data_cmd->buflen = sizeof(*mem) + sizeof(*filter);
754
755 mem->chksum = upgt_chksum_le((uint32_t *)filter,
756 data_cmd->buflen - sizeof(*mem));
757
758 upgt_bulk_tx(sc, data_cmd);
759
760 return (0);
761}
762
763static void
764upgt_setup_rates(struct ieee80211vap *vap, struct ieee80211com *ic)
765{
766 struct ifnet *ifp = ic->ic_ifp;
767 struct upgt_softc *sc = ifp->if_softc;
768 const struct ieee80211_txparam *tp;
769
770 /*
771 * 0x01 = OFMD6 0x10 = DS1
772 * 0x04 = OFDM9 0x11 = DS2
773 * 0x06 = OFDM12 0x12 = DS5
774 * 0x07 = OFDM18 0x13 = DS11
775 * 0x08 = OFDM24
776 * 0x09 = OFDM36
777 * 0x0a = OFDM48
778 * 0x0b = OFDM54
779 */
780 const uint8_t rateset_auto_11b[] =
781 { 0x13, 0x13, 0x12, 0x11, 0x11, 0x10, 0x10, 0x10 };
782 const uint8_t rateset_auto_11g[] =
783 { 0x0b, 0x0a, 0x09, 0x08, 0x07, 0x06, 0x04, 0x01 };
784 const uint8_t rateset_fix_11bg[] =
785 { 0x10, 0x11, 0x12, 0x13, 0x01, 0x04, 0x06, 0x07,
786 0x08, 0x09, 0x0a, 0x0b };
787
788 tp = &vap->iv_txparms[ieee80211_chan2mode(ic->ic_curchan)];
789
790 /* XXX */
791 if (tp->ucastrate == IEEE80211_FIXED_RATE_NONE) {
792 /*
793 * Automatic rate control is done by the device.
794 * We just pass the rateset from which the device
795 * will pickup a rate.
796 */
797 if (ic->ic_curmode == IEEE80211_MODE_11B)
798 memcpy(sc->sc_cur_rateset, rateset_auto_11b,
799 sizeof(sc->sc_cur_rateset));
800 if (ic->ic_curmode == IEEE80211_MODE_11G ||
801 ic->ic_curmode == IEEE80211_MODE_AUTO)
802 memcpy(sc->sc_cur_rateset, rateset_auto_11g,
803 sizeof(sc->sc_cur_rateset));
804 } else {
805 /* set a fixed rate */
806 memset(sc->sc_cur_rateset, rateset_fix_11bg[tp->ucastrate],
807 sizeof(sc->sc_cur_rateset));
808 }
809}
810
811static void
812upgt_set_multi(void *arg)
813{
814 struct upgt_softc *sc = arg;
815 struct ifnet *ifp = sc->sc_ifp;
816
817 if (!(ifp->if_flags & IFF_UP))
818 return;
819
820 /*
821 * XXX don't know how to set a device. Lack of docs. Just try to set
822 * IFF_ALLMULTI flag here.
823 */
824 ifp->if_flags |= IFF_ALLMULTI;
825}
826
827static void
828upgt_start(struct ifnet *ifp)
829{
830 struct upgt_softc *sc = ifp->if_softc;
831 struct upgt_data *data_tx;
832 struct ieee80211_node *ni;
833 struct mbuf *m;
834
835 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
836 return;
837
838 UPGT_LOCK(sc);
839 for (;;) {
840 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
841 if (m == NULL)
842 break;
843
844 data_tx = upgt_gettxbuf(sc);
845 if (data_tx == NULL) {
846 IFQ_DRV_PREPEND(&ifp->if_snd, m);
847 break;
848 }
849
850 ni = (struct ieee80211_node *)m->m_pkthdr.rcvif;
851 m->m_pkthdr.rcvif = NULL;
852
853 if (upgt_tx_start(sc, m, ni, data_tx) != 0) {
854 STAILQ_INSERT_HEAD(&sc->sc_tx_inactive, data_tx, next);
855 UPGT_STAT_INC(sc, st_tx_inactive);
856 ieee80211_free_node(ni);
857 ifp->if_oerrors++;
858 continue;
859 }
860 sc->sc_tx_timer = 5;
861 }
862 UPGT_UNLOCK(sc);
863}
864
865static int
866upgt_raw_xmit(struct ieee80211_node *ni, struct mbuf *m,
867 const struct ieee80211_bpf_params *params)
868{
869 struct ieee80211com *ic = ni->ni_ic;
870 struct ifnet *ifp = ic->ic_ifp;
871 struct upgt_softc *sc = ifp->if_softc;
872 struct upgt_data *data_tx = NULL;
873
874 /* prevent management frames from being sent if we're not ready */
875 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
876 m_freem(m);
877 ieee80211_free_node(ni);
878 return ENETDOWN;
879 }
880
881 UPGT_LOCK(sc);
882 data_tx = upgt_gettxbuf(sc);
883 if (data_tx == NULL) {
884 ieee80211_free_node(ni);
885 m_freem(m);
886 UPGT_UNLOCK(sc);
887 return (ENOBUFS);
888 }
889
890 if (upgt_tx_start(sc, m, ni, data_tx) != 0) {
891 STAILQ_INSERT_HEAD(&sc->sc_tx_inactive, data_tx, next);
892 UPGT_STAT_INC(sc, st_tx_inactive);
893 ieee80211_free_node(ni);
894 ifp->if_oerrors++;
895 UPGT_UNLOCK(sc);
896 return (EIO);
897 }
898 UPGT_UNLOCK(sc);
899
900 sc->sc_tx_timer = 5;
901 return (0);
902}
903
904static void
905upgt_watchdog(void *arg)
906{
907 struct upgt_softc *sc = arg;
908 struct ifnet *ifp = sc->sc_ifp;
909
910 if (sc->sc_tx_timer > 0) {
911 if (--sc->sc_tx_timer == 0) {
912 device_printf(sc->sc_dev, "watchdog timeout\n");
913 /* upgt_init(ifp); XXX needs a process context ? */
914 ifp->if_oerrors++;
915 return;
916 }
917 callout_reset(&sc->sc_watchdog_ch, hz, upgt_watchdog, sc);
918 }
919}
920
921static uint32_t
922upgt_mem_alloc(struct upgt_softc *sc)
923{
924 int i;
925
926 for (i = 0; i < sc->sc_memory.pages; i++) {
927 if (sc->sc_memory.page[i].used == 0) {
928 sc->sc_memory.page[i].used = 1;
929 return (sc->sc_memory.page[i].addr);
930 }
931 }
932
933 return (0);
934}
935
936static void
937upgt_scan_start(struct ieee80211com *ic)
938{
939 /* do nothing. */
940}
941
942static void
943upgt_scan_end(struct ieee80211com *ic)
944{
945 /* do nothing. */
946}
947
948static void
949upgt_set_channel(struct ieee80211com *ic)
950{
951 struct upgt_softc *sc = ic->ic_ifp->if_softc;
952
953 UPGT_LOCK(sc);
954 upgt_set_chan(sc, ic->ic_curchan);
955 UPGT_UNLOCK(sc);
956}
957
958static void
959upgt_set_chan(struct upgt_softc *sc, struct ieee80211_channel *c)
960{
961 struct ifnet *ifp = sc->sc_ifp;
962 struct ieee80211com *ic = ifp->if_l2com;
963 struct upgt_data *data_cmd;
964 struct upgt_lmac_mem *mem;
965 struct upgt_lmac_channel *chan;
966 int channel;
967
968 UPGT_ASSERT_LOCKED(sc);
969
970 channel = ieee80211_chan2ieee(ic, c);
971 if (channel == 0 || channel == IEEE80211_CHAN_ANY) {
972 /* XXX should NEVER happen */
973 device_printf(sc->sc_dev,
974 "%s: invalid channel %x\n", __func__, channel);
975 return;
976 }
977
978 DPRINTF(sc, UPGT_DEBUG_STATE, "%s: channel %d\n", __func__, channel);
979
980 data_cmd = upgt_getbuf(sc);
981 if (data_cmd == NULL) {
982 device_printf(sc->sc_dev, "%s: out of buffers.\n", __func__);
983 return;
984 }
985 /*
986 * Transmit the URB containing the CMD data.
987 */
988 memset(data_cmd->buf, 0, MCLBYTES);
989
990 mem = (struct upgt_lmac_mem *)data_cmd->buf;
991 mem->addr = htole32(sc->sc_memaddr_frame_start +
992 UPGT_MEMSIZE_FRAME_HEAD);
993
994 chan = (struct upgt_lmac_channel *)(mem + 1);
995
996 chan->header1.flags = UPGT_H1_FLAGS_TX_NO_CALLBACK;
997 chan->header1.type = UPGT_H1_TYPE_CTRL;
998 chan->header1.len = htole16(
999 sizeof(struct upgt_lmac_channel) - sizeof(struct upgt_lmac_header));
1000
1001 chan->header2.reqid = htole32(sc->sc_memaddr_frame_start);
1002 chan->header2.type = htole16(UPGT_H2_TYPE_CHANNEL);
1003 chan->header2.flags = 0;
1004
1005 chan->unknown1 = htole16(UPGT_CHANNEL_UNKNOWN1);
1006 chan->unknown2 = htole16(UPGT_CHANNEL_UNKNOWN2);
1007 chan->freq6 = sc->sc_eeprom_freq6[channel];
1008 chan->settings = sc->sc_eeprom_freq6_settings;
1009 chan->unknown3 = UPGT_CHANNEL_UNKNOWN3;
1010
1011 memcpy(chan->freq3_1, &sc->sc_eeprom_freq3[channel].data,
1012 sizeof(chan->freq3_1));
1013 memcpy(chan->freq4, &sc->sc_eeprom_freq4[channel],
1014 sizeof(sc->sc_eeprom_freq4[channel]));
1015 memcpy(chan->freq3_2, &sc->sc_eeprom_freq3[channel].data,
1016 sizeof(chan->freq3_2));
1017
1018 data_cmd->buflen = sizeof(*mem) + sizeof(*chan);
1019
1020 mem->chksum = upgt_chksum_le((uint32_t *)chan,
1021 data_cmd->buflen - sizeof(*mem));
1022
1023 upgt_bulk_tx(sc, data_cmd);
1024}
1025
1026static struct ieee80211vap *
1027upgt_vap_create(struct ieee80211com *ic, const char name[IFNAMSIZ], int unit,
1028 enum ieee80211_opmode opmode, int flags,
1029 const uint8_t bssid[IEEE80211_ADDR_LEN],
1030 const uint8_t mac[IEEE80211_ADDR_LEN])
1031{
1032 struct upgt_vap *uvp;
1033 struct ieee80211vap *vap;
1034
1035 if (!TAILQ_EMPTY(&ic->ic_vaps)) /* only one at a time */
1036 return NULL;
1037 uvp = (struct upgt_vap *) malloc(sizeof(struct upgt_vap),
1038 M_80211_VAP, M_NOWAIT | M_ZERO);
1039 if (uvp == NULL)
1040 return NULL;
1041 vap = &uvp->vap;
1042 /* enable s/w bmiss handling for sta mode */
1043 ieee80211_vap_setup(ic, vap, name, unit, opmode,
1044 flags | IEEE80211_CLONE_NOBEACONS, bssid, mac);
1045
1046 /* override state transition machine */
1047 uvp->newstate = vap->iv_newstate;
1048 vap->iv_newstate = upgt_newstate;
1049
1050 /* setup device rates */
1051 upgt_setup_rates(vap, ic);
1052
1053 /* complete setup */
1054 ieee80211_vap_attach(vap, ieee80211_media_change,
1055 ieee80211_media_status);
1056 ic->ic_opmode = opmode;
1057 return vap;
1058}
1059
1060static int
1061upgt_newstate(struct ieee80211vap *vap, enum ieee80211_state nstate, int arg)
1062{
1063 struct upgt_vap *uvp = UPGT_VAP(vap);
1064 struct ieee80211com *ic = vap->iv_ic;
1065 struct upgt_softc *sc = ic->ic_ifp->if_softc;
1066
1067 /* do it in a process context */
1068 sc->sc_state = nstate;
1069
1070 IEEE80211_UNLOCK(ic);
1071 UPGT_LOCK(sc);
1072 callout_stop(&sc->sc_led_ch);
1073 callout_stop(&sc->sc_watchdog_ch);
1074
1075 switch (nstate) {
1076 case IEEE80211_S_INIT:
1077 /* do not accept any frames if the device is down */
1078 (void)upgt_set_macfilter(sc, sc->sc_state);
1079 upgt_set_led(sc, UPGT_LED_OFF);
1080 break;
1081 case IEEE80211_S_SCAN:
1082 upgt_set_chan(sc, ic->ic_curchan);
1083 break;
1084 case IEEE80211_S_AUTH:
1085 upgt_set_chan(sc, ic->ic_curchan);
1086 break;
1087 case IEEE80211_S_ASSOC:
1088 break;
1089 case IEEE80211_S_RUN:
1090 upgt_set_macfilter(sc, sc->sc_state);
1091 upgt_set_led(sc, UPGT_LED_ON);
1092 break;
1093 default:
1094 break;
1095 }
1096 UPGT_UNLOCK(sc);
1097 IEEE80211_LOCK(ic);
1098 return (uvp->newstate(vap, nstate, arg));
1099}
1100
1101static void
1102upgt_vap_delete(struct ieee80211vap *vap)
1103{
1104 struct upgt_vap *uvp = UPGT_VAP(vap);
1105
1106 ieee80211_vap_detach(vap);
1107 free(uvp, M_80211_VAP);
1108}
1109
1110static void
1111upgt_update_mcast(struct ifnet *ifp)
1112{
1113 struct upgt_softc *sc = ifp->if_softc;
1114
1115 upgt_set_multi(sc);
1116}
1117
1118static int
1119upgt_eeprom_parse(struct upgt_softc *sc)
1120{
1121 struct upgt_eeprom_header *eeprom_header;
1122 struct upgt_eeprom_option *eeprom_option;
1123 uint16_t option_len;
1124 uint16_t option_type;
1125 uint16_t preamble_len;
1126 int option_end = 0;
1127
1128 /* calculate eeprom options start offset */
1129 eeprom_header = (struct upgt_eeprom_header *)sc->sc_eeprom;
1130 preamble_len = le16toh(eeprom_header->preamble_len);
1131 eeprom_option = (struct upgt_eeprom_option *)(sc->sc_eeprom +
1132 (sizeof(struct upgt_eeprom_header) + preamble_len));
1133
1134 while (!option_end) {
1135 /* the eeprom option length is stored in words */
1136 option_len =
1137 (le16toh(eeprom_option->len) - 1) * sizeof(uint16_t);
1138 option_type =
1139 le16toh(eeprom_option->type);
1140
1141 switch (option_type) {
1142 case UPGT_EEPROM_TYPE_NAME:
1143 DPRINTF(sc, UPGT_DEBUG_FW,
1144 "EEPROM name len=%d\n", option_len);
1145 break;
1146 case UPGT_EEPROM_TYPE_SERIAL:
1147 DPRINTF(sc, UPGT_DEBUG_FW,
1148 "EEPROM serial len=%d\n", option_len);
1149 break;
1150 case UPGT_EEPROM_TYPE_MAC:
1151 DPRINTF(sc, UPGT_DEBUG_FW,
1152 "EEPROM mac len=%d\n", option_len);
1153
1154 IEEE80211_ADDR_COPY(sc->sc_myaddr, eeprom_option->data);
1155 break;
1156 case UPGT_EEPROM_TYPE_HWRX:
1157 DPRINTF(sc, UPGT_DEBUG_FW,
1158 "EEPROM hwrx len=%d\n", option_len);
1159
1160 upgt_eeprom_parse_hwrx(sc, eeprom_option->data);
1161 break;
1162 case UPGT_EEPROM_TYPE_CHIP:
1163 DPRINTF(sc, UPGT_DEBUG_FW,
1164 "EEPROM chip len=%d\n", option_len);
1165 break;
1166 case UPGT_EEPROM_TYPE_FREQ3:
1167 DPRINTF(sc, UPGT_DEBUG_FW,
1168 "EEPROM freq3 len=%d\n", option_len);
1169
1170 upgt_eeprom_parse_freq3(sc, eeprom_option->data,
1171 option_len);
1172 break;
1173 case UPGT_EEPROM_TYPE_FREQ4:
1174 DPRINTF(sc, UPGT_DEBUG_FW,
1175 "EEPROM freq4 len=%d\n", option_len);
1176
1177 upgt_eeprom_parse_freq4(sc, eeprom_option->data,
1178 option_len);
1179 break;
1180 case UPGT_EEPROM_TYPE_FREQ5:
1181 DPRINTF(sc, UPGT_DEBUG_FW,
1182 "EEPROM freq5 len=%d\n", option_len);
1183 break;
1184 case UPGT_EEPROM_TYPE_FREQ6:
1185 DPRINTF(sc, UPGT_DEBUG_FW,
1186 "EEPROM freq6 len=%d\n", option_len);
1187
1188 upgt_eeprom_parse_freq6(sc, eeprom_option->data,
1189 option_len);
1190 break;
1191 case UPGT_EEPROM_TYPE_END:
1192 DPRINTF(sc, UPGT_DEBUG_FW,
1193 "EEPROM end len=%d\n", option_len);
1194 option_end = 1;
1195 break;
1196 case UPGT_EEPROM_TYPE_OFF:
1197 DPRINTF(sc, UPGT_DEBUG_FW,
1198 "%s: EEPROM off without end option\n", __func__);
1199 return (EIO);
1200 default:
1201 DPRINTF(sc, UPGT_DEBUG_FW,
1202 "EEPROM unknown type 0x%04x len=%d\n",
1203 option_type, option_len);
1204 break;
1205 }
1206
1207 /* jump to next EEPROM option */
1208 eeprom_option = (struct upgt_eeprom_option *)
1209 (eeprom_option->data + option_len);
1210 }
1211
1212 return (0);
1213}
1214
1215static void
1216upgt_eeprom_parse_freq3(struct upgt_softc *sc, uint8_t *data, int len)
1217{
1218 struct upgt_eeprom_freq3_header *freq3_header;
1219 struct upgt_lmac_freq3 *freq3;
1220 int i, elements, flags;
1221 unsigned channel;
1222
1223 freq3_header = (struct upgt_eeprom_freq3_header *)data;
1224 freq3 = (struct upgt_lmac_freq3 *)(freq3_header + 1);
1225
1226 flags = freq3_header->flags;
1227 elements = freq3_header->elements;
1228
1229 DPRINTF(sc, UPGT_DEBUG_FW, "flags=0x%02x elements=%d\n",
1230 flags, elements);
1231
1232 for (i = 0; i < elements; i++) {
1233 channel = ieee80211_mhz2ieee(le16toh(freq3[i].freq), 0);
1234 if (channel >= IEEE80211_CHAN_MAX)
1235 continue;
1236
1237 sc->sc_eeprom_freq3[channel] = freq3[i];
1238
1239 DPRINTF(sc, UPGT_DEBUG_FW, "frequence=%d, channel=%d\n",
1240 le16toh(sc->sc_eeprom_freq3[channel].freq), channel);
1241 }
1242}
1243
1244void
1245upgt_eeprom_parse_freq4(struct upgt_softc *sc, uint8_t *data, int len)
1246{
1247 struct upgt_eeprom_freq4_header *freq4_header;
1248 struct upgt_eeprom_freq4_1 *freq4_1;
1249 struct upgt_eeprom_freq4_2 *freq4_2;
1250 int i, j, elements, settings, flags;
1251 unsigned channel;
1252
1253 freq4_header = (struct upgt_eeprom_freq4_header *)data;
1254 freq4_1 = (struct upgt_eeprom_freq4_1 *)(freq4_header + 1);
1255 flags = freq4_header->flags;
1256 elements = freq4_header->elements;
1257 settings = freq4_header->settings;
1258
1259 /* we need this value later */
1260 sc->sc_eeprom_freq6_settings = freq4_header->settings;
1261
1262 DPRINTF(sc, UPGT_DEBUG_FW, "flags=0x%02x elements=%d settings=%d\n",
1263 flags, elements, settings);
1264
1265 for (i = 0; i < elements; i++) {
1266 channel = ieee80211_mhz2ieee(le16toh(freq4_1[i].freq), 0);
1267 if (channel >= IEEE80211_CHAN_MAX)
1268 continue;
1269
1270 freq4_2 = (struct upgt_eeprom_freq4_2 *)freq4_1[i].data;
1271 for (j = 0; j < settings; j++) {
1272 sc->sc_eeprom_freq4[channel][j].cmd = freq4_2[j];
1273 sc->sc_eeprom_freq4[channel][j].pad = 0;
1274 }
1275
1276 DPRINTF(sc, UPGT_DEBUG_FW, "frequence=%d, channel=%d\n",
1277 le16toh(freq4_1[i].freq), channel);
1278 }
1279}
1280
1281void
1282upgt_eeprom_parse_freq6(struct upgt_softc *sc, uint8_t *data, int len)
1283{
1284 struct upgt_lmac_freq6 *freq6;
1285 int i, elements;
1286 unsigned channel;
1287
1288 freq6 = (struct upgt_lmac_freq6 *)data;
1289 elements = len / sizeof(struct upgt_lmac_freq6);
1290
1291 DPRINTF(sc, UPGT_DEBUG_FW, "elements=%d\n", elements);
1292
1293 for (i = 0; i < elements; i++) {
1294 channel = ieee80211_mhz2ieee(le16toh(freq6[i].freq), 0);
1295 if (channel >= IEEE80211_CHAN_MAX)
1296 continue;
1297
1298 sc->sc_eeprom_freq6[channel] = freq6[i];
1299
1300 DPRINTF(sc, UPGT_DEBUG_FW, "frequence=%d, channel=%d\n",
1301 le16toh(sc->sc_eeprom_freq6[channel].freq), channel);
1302 }
1303}
1304
1305static void
1306upgt_eeprom_parse_hwrx(struct upgt_softc *sc, uint8_t *data)
1307{
1308 struct upgt_eeprom_option_hwrx *option_hwrx;
1309
1310 option_hwrx = (struct upgt_eeprom_option_hwrx *)data;
1311
1312 sc->sc_eeprom_hwrx = option_hwrx->rxfilter - UPGT_EEPROM_RX_CONST;
1313
1314 DPRINTF(sc, UPGT_DEBUG_FW, "hwrx option value=0x%04x\n",
1315 sc->sc_eeprom_hwrx);
1316}
1317
1318static int
1319upgt_eeprom_read(struct upgt_softc *sc)
1320{
1321 struct upgt_data *data_cmd;
1322 struct upgt_lmac_mem *mem;
1323 struct upgt_lmac_eeprom *eeprom;
1324 int block, error, offset;
1325
1326 UPGT_LOCK(sc);
1327 usb_pause_mtx(&sc->sc_mtx, 100);
1328
1329 offset = 0;
1330 block = UPGT_EEPROM_BLOCK_SIZE;
1331 while (offset < UPGT_EEPROM_SIZE) {
1332 DPRINTF(sc, UPGT_DEBUG_FW,
1333 "request EEPROM block (offset=%d, len=%d)\n", offset, block);
1334
1335 data_cmd = upgt_getbuf(sc);
1336 if (data_cmd == NULL) {
1337 UPGT_UNLOCK(sc);
1338 return (ENOBUFS);
1339 }
1340
1341 /*
1342 * Transmit the URB containing the CMD data.
1343 */
1344 memset(data_cmd->buf, 0, MCLBYTES);
1345
1346 mem = (struct upgt_lmac_mem *)data_cmd->buf;
1347 mem->addr = htole32(sc->sc_memaddr_frame_start +
1348 UPGT_MEMSIZE_FRAME_HEAD);
1349
1350 eeprom = (struct upgt_lmac_eeprom *)(mem + 1);
1351 eeprom->header1.flags = 0;
1352 eeprom->header1.type = UPGT_H1_TYPE_CTRL;
1353 eeprom->header1.len = htole16((
1354 sizeof(struct upgt_lmac_eeprom) -
1355 sizeof(struct upgt_lmac_header)) + block);
1356
1357 eeprom->header2.reqid = htole32(sc->sc_memaddr_frame_start);
1358 eeprom->header2.type = htole16(UPGT_H2_TYPE_EEPROM);
1359 eeprom->header2.flags = 0;
1360
1361 eeprom->offset = htole16(offset);
1362 eeprom->len = htole16(block);
1363
1364 data_cmd->buflen = sizeof(*mem) + sizeof(*eeprom) + block;
1365
1366 mem->chksum = upgt_chksum_le((uint32_t *)eeprom,
1367 data_cmd->buflen - sizeof(*mem));
1368 upgt_bulk_tx(sc, data_cmd);
1369
1370 error = mtx_sleep(sc, &sc->sc_mtx, 0, "eeprom_request", hz);
1371 if (error != 0) {
1372 device_printf(sc->sc_dev,
1373 "timeout while waiting for EEPROM data\n");
1374 UPGT_UNLOCK(sc);
1375 return (EIO);
1376 }
1377
1378 offset += block;
1379 if (UPGT_EEPROM_SIZE - offset < block)
1380 block = UPGT_EEPROM_SIZE - offset;
1381 }
1382
1383 UPGT_UNLOCK(sc);
1384 return (0);
1385}
1386
1387/*
1388 * When a rx data came in the function returns a mbuf and a rssi values.
1389 */
1390static struct mbuf *
1391upgt_rxeof(struct usb_xfer *xfer, struct upgt_data *data, int *rssi)
1392{
1393 struct mbuf *m = NULL;
1394 struct upgt_softc *sc = usbd_xfer_softc(xfer);
1395 struct upgt_lmac_header *header;
1396 struct upgt_lmac_eeprom *eeprom;
1397 uint8_t h1_type;
1398 uint16_t h2_type;
1399 int actlen, sumlen;
1400
1401 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1402
1403 UPGT_ASSERT_LOCKED(sc);
1404
1405 if (actlen < 1)
1406 return (NULL);
1407
1408 /* Check only at the very beginning. */
1409 if (!(sc->sc_flags & UPGT_FLAG_FWLOADED) &&
1410 (memcmp(data->buf, "OK", 2) == 0)) {
1411 sc->sc_flags |= UPGT_FLAG_FWLOADED;
1412 wakeup_one(sc);
1413 return (NULL);
1414 }
1415
1416 if (actlen < (int)UPGT_RX_MINSZ)
1417 return (NULL);
1418
1419 /*
1420 * Check what type of frame came in.
1421 */
1422 header = (struct upgt_lmac_header *)(data->buf + 4);
1423
1424 h1_type = header->header1.type;
1425 h2_type = le16toh(header->header2.type);
1426
1427 if (h1_type == UPGT_H1_TYPE_CTRL && h2_type == UPGT_H2_TYPE_EEPROM) {
1428 eeprom = (struct upgt_lmac_eeprom *)(data->buf + 4);
1429 uint16_t eeprom_offset = le16toh(eeprom->offset);
1430 uint16_t eeprom_len = le16toh(eeprom->len);
1431
1432 DPRINTF(sc, UPGT_DEBUG_FW,
1433 "received EEPROM block (offset=%d, len=%d)\n",
1434 eeprom_offset, eeprom_len);
1435
1436 memcpy(sc->sc_eeprom + eeprom_offset,
1437 data->buf + sizeof(struct upgt_lmac_eeprom) + 4,
1438 eeprom_len);
1439
1440 /* EEPROM data has arrived in time, wakeup. */
1441 wakeup(sc);
1442 } else if (h1_type == UPGT_H1_TYPE_CTRL &&
1443 h2_type == UPGT_H2_TYPE_TX_DONE) {
1444 DPRINTF(sc, UPGT_DEBUG_XMIT, "%s: received 802.11 TX done\n",
1445 __func__);
1446 upgt_tx_done(sc, data->buf + 4);
1447 } else if (h1_type == UPGT_H1_TYPE_RX_DATA ||
1448 h1_type == UPGT_H1_TYPE_RX_DATA_MGMT) {
1449 DPRINTF(sc, UPGT_DEBUG_RECV, "%s: received 802.11 RX data\n",
1450 __func__);
1451 m = upgt_rx(sc, data->buf + 4, le16toh(header->header1.len),
1452 rssi);
1453 } else if (h1_type == UPGT_H1_TYPE_CTRL &&
1454 h2_type == UPGT_H2_TYPE_STATS) {
1455 DPRINTF(sc, UPGT_DEBUG_STAT, "%s: received statistic data\n",
1456 __func__);
1457 /* TODO: what could we do with the statistic data? */
1458 } else {
1459 /* ignore unknown frame types */
1460 DPRINTF(sc, UPGT_DEBUG_INTR,
1461 "received unknown frame type 0x%02x\n",
1462 header->header1.type);
1463 }
1464 return (m);
1465}
1466
1467/*
1468 * The firmware awaits a checksum for each frame we send to it.
1469 * The algorithm used therefor is uncommon but somehow similar to CRC32.
1470 */
1471static uint32_t
1472upgt_chksum_le(const uint32_t *buf, size_t size)
1473{
1474 size_t i;
1475 uint32_t crc = 0;
1476
1477 for (i = 0; i < size; i += sizeof(uint32_t)) {
1478 crc = htole32(crc ^ *buf++);
1479 crc = htole32((crc >> 5) ^ (crc << 3));
1480 }
1481
1482 return (crc);
1483}
1484
1485static struct mbuf *
1486upgt_rx(struct upgt_softc *sc, uint8_t *data, int pkglen, int *rssi)
1487{
1488 struct ifnet *ifp = sc->sc_ifp;
1489 struct ieee80211com *ic = ifp->if_l2com;
1490 struct upgt_lmac_rx_desc *rxdesc;
1491 struct mbuf *m;
1492
1493 /*
1494 * don't pass packets to the ieee80211 framework if the driver isn't
1495 * RUNNING.
1496 */
1497 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
1498 return (NULL);
1499
1500 /* access RX packet descriptor */
1501 rxdesc = (struct upgt_lmac_rx_desc *)data;
1502
1503 /* create mbuf which is suitable for strict alignment archs */
1504 KASSERT((pkglen + ETHER_ALIGN) < MCLBYTES,
1505 ("A current mbuf storage is small (%d)", pkglen + ETHER_ALIGN));
1506 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1507 if (m == NULL) {
1508 device_printf(sc->sc_dev, "could not create RX mbuf\n");
1509 return (NULL);
1510 }
1511 m_adj(m, ETHER_ALIGN);
1512 memcpy(mtod(m, char *), rxdesc->data, pkglen);
1513 /* trim FCS */
1514 m->m_len = m->m_pkthdr.len = pkglen - IEEE80211_CRC_LEN;
1515 m->m_pkthdr.rcvif = ifp;
1516
1517 if (ieee80211_radiotap_active(ic)) {
1518 struct upgt_rx_radiotap_header *tap = &sc->sc_rxtap;
1519
1520 tap->wr_flags = 0;
1521 tap->wr_rate = upgt_rx_rate(sc, rxdesc->rate);
1522 tap->wr_antsignal = rxdesc->rssi;
1523 }
1524 ifp->if_ipackets++;
1525
1526 DPRINTF(sc, UPGT_DEBUG_RX_PROC, "%s: RX done\n", __func__);
1527 *rssi = rxdesc->rssi;
1528 return (m);
1529}
1530
1531static uint8_t
1532upgt_rx_rate(struct upgt_softc *sc, const int rate)
1533{
1534 struct ifnet *ifp = sc->sc_ifp;
1535 struct ieee80211com *ic = ifp->if_l2com;
1536 static const uint8_t cck_upgt2rate[4] = { 2, 4, 11, 22 };
1537 static const uint8_t ofdm_upgt2rate[12] =
1538 { 2, 4, 11, 22, 12, 18, 24, 36, 48, 72, 96, 108 };
1539
1540 if (ic->ic_curmode == IEEE80211_MODE_11B &&
1541 !(rate < 0 || rate > 3))
1542 return cck_upgt2rate[rate & 0xf];
1543
1544 if (ic->ic_curmode == IEEE80211_MODE_11G &&
1545 !(rate < 0 || rate > 11))
1546 return ofdm_upgt2rate[rate & 0xf];
1547
1548 return (0);
1549}
1550
1551static void
1552upgt_tx_done(struct upgt_softc *sc, uint8_t *data)
1553{
1554 struct ifnet *ifp = sc->sc_ifp;
1555 struct upgt_lmac_tx_done_desc *desc;
1556 int i, freed = 0;
1557
1558 UPGT_ASSERT_LOCKED(sc);
1559
1560 desc = (struct upgt_lmac_tx_done_desc *)data;
1561
1562 for (i = 0; i < UPGT_TX_MAXCOUNT; i++) {
1563 struct upgt_data *data_tx = &sc->sc_tx_data[i];
1564
1565 if (data_tx->addr == le32toh(desc->header2.reqid)) {
1566 upgt_mem_free(sc, data_tx->addr);
1567 data_tx->ni = NULL;
1568 data_tx->addr = 0;
1569 data_tx->m = NULL;
1570 data_tx->use = 0;
1571
1572 DPRINTF(sc, UPGT_DEBUG_TX_PROC,
1573 "TX done: memaddr=0x%08x, status=0x%04x, rssi=%d, ",
1574 le32toh(desc->header2.reqid),
1575 le16toh(desc->status), le16toh(desc->rssi));
1576 DPRINTF(sc, UPGT_DEBUG_TX_PROC, "seq=%d\n",
1577 le16toh(desc->seq));
1578
1579 freed++;
1580 }
1581 }
1582
1583 if (freed != 0) {
1584 sc->sc_tx_timer = 0;
1585 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1586 UPGT_UNLOCK(sc);
1587 upgt_start(ifp);
1588 UPGT_LOCK(sc);
1589 }
1590}
1591
1592static void
1593upgt_mem_free(struct upgt_softc *sc, uint32_t addr)
1594{
1595 int i;
1596
1597 for (i = 0; i < sc->sc_memory.pages; i++) {
1598 if (sc->sc_memory.page[i].addr == addr) {
1599 sc->sc_memory.page[i].used = 0;
1600 return;
1601 }
1602 }
1603
1604 device_printf(sc->sc_dev,
1605 "could not free memory address 0x%08x\n", addr);
1606}
1607
1608static int
1609upgt_fw_load(struct upgt_softc *sc)
1610{
1611 const struct firmware *fw;
1612 struct upgt_data *data_cmd;
1613 struct upgt_fw_x2_header *x2;
1614 char start_fwload_cmd[] = { 0x3c, 0x0d };
1615 int error = 0;
1616 size_t offset;
1617 int bsize;
1618 int n;
1619 uint32_t crc32;
1620
1621 fw = firmware_get(upgt_fwname);
1622 if (fw == NULL) {
1623 device_printf(sc->sc_dev, "could not read microcode %s\n",
1624 upgt_fwname);
1625 return (EIO);
1626 }
1627
1628 UPGT_LOCK(sc);
1629
1630 /* send firmware start load command */
1631 data_cmd = upgt_getbuf(sc);
1632 if (data_cmd == NULL) {
1633 error = ENOBUFS;
1634 goto fail;
1635 }
1636 data_cmd->buflen = sizeof(start_fwload_cmd);
1637 memcpy(data_cmd->buf, start_fwload_cmd, data_cmd->buflen);
1638 upgt_bulk_tx(sc, data_cmd);
1639
1640 /* send X2 header */
1641 data_cmd = upgt_getbuf(sc);
1642 if (data_cmd == NULL) {
1643 error = ENOBUFS;
1644 goto fail;
1645 }
1646 data_cmd->buflen = sizeof(struct upgt_fw_x2_header);
1647 x2 = (struct upgt_fw_x2_header *)data_cmd->buf;
1648 memcpy(x2->signature, UPGT_X2_SIGNATURE, UPGT_X2_SIGNATURE_SIZE);
1649 x2->startaddr = htole32(UPGT_MEMADDR_FIRMWARE_START);
1650 x2->len = htole32(fw->datasize);
1651 x2->crc = upgt_crc32_le((uint8_t *)data_cmd->buf +
1652 UPGT_X2_SIGNATURE_SIZE,
1653 sizeof(struct upgt_fw_x2_header) - UPGT_X2_SIGNATURE_SIZE -
1654 sizeof(uint32_t));
1655 upgt_bulk_tx(sc, data_cmd);
1656
1657 /* download firmware */
1658 for (offset = 0; offset < fw->datasize; offset += bsize) {
1659 if (fw->datasize - offset > UPGT_FW_BLOCK_SIZE)
1660 bsize = UPGT_FW_BLOCK_SIZE;
1661 else
1662 bsize = fw->datasize - offset;
1663
1664 data_cmd = upgt_getbuf(sc);
1665 if (data_cmd == NULL) {
1666 error = ENOBUFS;
1667 goto fail;
1668 }
1669 n = upgt_fw_copy((const uint8_t *)fw->data + offset,
1670 data_cmd->buf, bsize);
1671 data_cmd->buflen = bsize;
1672 upgt_bulk_tx(sc, data_cmd);
1673
1674 DPRINTF(sc, UPGT_DEBUG_FW, "FW offset=%d, read=%d, sent=%d\n",
1675 offset, n, bsize);
1676 bsize = n;
1677 }
1678 DPRINTF(sc, UPGT_DEBUG_FW, "%s: firmware downloaded\n", __func__);
1679
1680 /* load firmware */
1681 data_cmd = upgt_getbuf(sc);
1682 if (data_cmd == NULL) {
1683 error = ENOBUFS;
1684 goto fail;
1685 }
1686 crc32 = upgt_crc32_le(fw->data, fw->datasize);
1687 *((uint32_t *)(data_cmd->buf) ) = crc32;
1688 *((uint8_t *)(data_cmd->buf) + 4) = 'g';
1689 *((uint8_t *)(data_cmd->buf) + 5) = '\r';
1690 data_cmd->buflen = 6;
1691 upgt_bulk_tx(sc, data_cmd);
1692
1693 /* waiting 'OK' response. */
1694 usbd_transfer_start(sc->sc_xfer[UPGT_BULK_RX]);
1695 error = mtx_sleep(sc, &sc->sc_mtx, 0, "upgtfw", 2 * hz);
1696 if (error != 0) {
1697 device_printf(sc->sc_dev, "firmware load failed\n");
1698 error = EIO;
1699 }
1700
1701 DPRINTF(sc, UPGT_DEBUG_FW, "%s: firmware loaded\n", __func__);
1702fail:
1703 UPGT_UNLOCK(sc);
1704 firmware_put(fw, FIRMWARE_UNLOAD);
1705 return (error);
1706}
1707
1708static uint32_t
1709upgt_crc32_le(const void *buf, size_t size)
1710{
1711 uint32_t crc;
1712
1713 crc = ether_crc32_le(buf, size);
1714
1715 /* apply final XOR value as common for CRC-32 */
1716 crc = htole32(crc ^ 0xffffffffU);
1717
1718 return (crc);
1719}
1720
1721/*
1722 * While copying the version 2 firmware, we need to replace two characters:
1723 *
1724 * 0x7e -> 0x7d 0x5e
1725 * 0x7d -> 0x7d 0x5d
1726 */
1727static int
1728upgt_fw_copy(const uint8_t *src, char *dst, int size)
1729{
1730 int i, j;
1731
1732 for (i = 0, j = 0; i < size && j < size; i++) {
1733 switch (src[i]) {
1734 case 0x7e:
1735 dst[j] = 0x7d;
1736 j++;
1737 dst[j] = 0x5e;
1738 j++;
1739 break;
1740 case 0x7d:
1741 dst[j] = 0x7d;
1742 j++;
1743 dst[j] = 0x5d;
1744 j++;
1745 break;
1746 default:
1747 dst[j] = src[i];
1748 j++;
1749 break;
1750 }
1751 }
1752
1753 return (i);
1754}
1755
1756static int
1757upgt_mem_init(struct upgt_softc *sc)
1758{
1759 int i;
1760
1761 for (i = 0; i < UPGT_MEMORY_MAX_PAGES; i++) {
1762 sc->sc_memory.page[i].used = 0;
1763
1764 if (i == 0) {
1765 /*
1766 * The first memory page is always reserved for
1767 * command data.
1768 */
1769 sc->sc_memory.page[i].addr =
1770 sc->sc_memaddr_frame_start + MCLBYTES;
1771 } else {
1772 sc->sc_memory.page[i].addr =
1773 sc->sc_memory.page[i - 1].addr + MCLBYTES;
1774 }
1775
1776 if (sc->sc_memory.page[i].addr + MCLBYTES >=
1777 sc->sc_memaddr_frame_end)
1778 break;
1779
1780 DPRINTF(sc, UPGT_DEBUG_FW, "memory address page %d=0x%08x\n",
1781 i, sc->sc_memory.page[i].addr);
1782 }
1783
1784 sc->sc_memory.pages = i;
1785
1786 DPRINTF(sc, UPGT_DEBUG_FW, "memory pages=%d\n", sc->sc_memory.pages);
1787 return (0);
1788}
1789
1790static int
1791upgt_fw_verify(struct upgt_softc *sc)
1792{
1793 const struct firmware *fw;
1794 const struct upgt_fw_bra_option *bra_opt;
1795 const struct upgt_fw_bra_descr *descr;
1796 const uint8_t *p;
1797 const uint32_t *uc;
1798 uint32_t bra_option_type, bra_option_len;
1799 size_t offset;
1800 int bra_end = 0;
1801 int error = 0;
1802
1803 fw = firmware_get(upgt_fwname);
1804 if (fw == NULL) {
1805 device_printf(sc->sc_dev, "could not read microcode %s\n",
1806 upgt_fwname);
1807 return EIO;
1808 }
1809
1810 /*
1811 * Seek to beginning of Boot Record Area (BRA).
1812 */
1813 for (offset = 0; offset < fw->datasize; offset += sizeof(*uc)) {
1814 uc = (const uint32_t *)((const uint8_t *)fw->data + offset);
1815 if (*uc == 0)
1816 break;
1817 }
1818 for (; offset < fw->datasize; offset += sizeof(*uc)) {
1819 uc = (const uint32_t *)((const uint8_t *)fw->data + offset);
1820 if (*uc != 0)
1821 break;
1822 }
1823 if (offset == fw->datasize) {
1824 device_printf(sc->sc_dev,
1825 "firmware Boot Record Area not found\n");
1826 error = EIO;
1827 goto fail;
1828 }
1829
1830 DPRINTF(sc, UPGT_DEBUG_FW,
1831 "firmware Boot Record Area found at offset %d\n", offset);
1832
1833 /*
1834 * Parse Boot Record Area (BRA) options.
1835 */
1836 while (offset < fw->datasize && bra_end == 0) {
1837 /* get current BRA option */
1838 p = (const uint8_t *)fw->data + offset;
1839 bra_opt = (const struct upgt_fw_bra_option *)p;
1840 bra_option_type = le32toh(bra_opt->type);
1841 bra_option_len = le32toh(bra_opt->len) * sizeof(*uc);
1842
1843 switch (bra_option_type) {
1844 case UPGT_BRA_TYPE_FW:
1845 DPRINTF(sc, UPGT_DEBUG_FW, "UPGT_BRA_TYPE_FW len=%d\n",
1846 bra_option_len);
1847
1848 if (bra_option_len != UPGT_BRA_FWTYPE_SIZE) {
1849 device_printf(sc->sc_dev,
1850 "wrong UPGT_BRA_TYPE_FW len\n");
1851 error = EIO;
1852 goto fail;
1853 }
1854 if (memcmp(UPGT_BRA_FWTYPE_LM86, bra_opt->data,
1855 bra_option_len) == 0) {
1856 sc->sc_fw_type = UPGT_FWTYPE_LM86;
1857 break;
1858 }
1859 if (memcmp(UPGT_BRA_FWTYPE_LM87, bra_opt->data,
1860 bra_option_len) == 0) {
1861 sc->sc_fw_type = UPGT_FWTYPE_LM87;
1862 break;
1863 }
1864 device_printf(sc->sc_dev,
1865 "unsupported firmware type\n");
1866 error = EIO;
1867 goto fail;
1868 case UPGT_BRA_TYPE_VERSION:
1869 DPRINTF(sc, UPGT_DEBUG_FW,
1870 "UPGT_BRA_TYPE_VERSION len=%d\n", bra_option_len);
1871 break;
1872 case UPGT_BRA_TYPE_DEPIF:
1873 DPRINTF(sc, UPGT_DEBUG_FW,
1874 "UPGT_BRA_TYPE_DEPIF len=%d\n", bra_option_len);
1875 break;
1876 case UPGT_BRA_TYPE_EXPIF:
1877 DPRINTF(sc, UPGT_DEBUG_FW,
1878 "UPGT_BRA_TYPE_EXPIF len=%d\n", bra_option_len);
1879 break;
1880 case UPGT_BRA_TYPE_DESCR:
1881 DPRINTF(sc, UPGT_DEBUG_FW,
1882 "UPGT_BRA_TYPE_DESCR len=%d\n", bra_option_len);
1883
1884 descr = (const struct upgt_fw_bra_descr *)bra_opt->data;
1885
1886 sc->sc_memaddr_frame_start =
1887 le32toh(descr->memaddr_space_start);
1888 sc->sc_memaddr_frame_end =
1889 le32toh(descr->memaddr_space_end);
1890
1891 DPRINTF(sc, UPGT_DEBUG_FW,
1892 "memory address space start=0x%08x\n",
1893 sc->sc_memaddr_frame_start);
1894 DPRINTF(sc, UPGT_DEBUG_FW,
1895 "memory address space end=0x%08x\n",
1896 sc->sc_memaddr_frame_end);
1897 break;
1898 case UPGT_BRA_TYPE_END:
1899 DPRINTF(sc, UPGT_DEBUG_FW, "UPGT_BRA_TYPE_END len=%d\n",
1900 bra_option_len);
1901 bra_end = 1;
1902 break;
1903 default:
1904 DPRINTF(sc, UPGT_DEBUG_FW, "unknown BRA option len=%d\n",
1905 bra_option_len);
1906 error = EIO;
1907 goto fail;
1908 }
1909
1910 /* jump to next BRA option */
1911 offset += sizeof(struct upgt_fw_bra_option) + bra_option_len;
1912 }
1913
1914 DPRINTF(sc, UPGT_DEBUG_FW, "%s: firmware verified", __func__);
1915fail:
1916 firmware_put(fw, FIRMWARE_UNLOAD);
1917 return (error);
1918}
1919
1920static void
1921upgt_bulk_tx(struct upgt_softc *sc, struct upgt_data *data)
1922{
1923
1924 UPGT_ASSERT_LOCKED(sc);
1925
1926 STAILQ_INSERT_TAIL(&sc->sc_tx_pending, data, next);
1927 UPGT_STAT_INC(sc, st_tx_pending);
1928 usbd_transfer_start(sc->sc_xfer[UPGT_BULK_TX]);
1929}
1930
1931static int
1932upgt_device_reset(struct upgt_softc *sc)
1933{
1934 struct upgt_data *data;
1935 char init_cmd[] = { 0x7e, 0x7e, 0x7e, 0x7e };
1936
1937 UPGT_LOCK(sc);
1938
1939 data = upgt_getbuf(sc);
1940 if (data == NULL) {
1941 UPGT_UNLOCK(sc);
1942 return (ENOBUFS);
1943 }
1944 memcpy(data->buf, init_cmd, sizeof(init_cmd));
1945 data->buflen = sizeof(init_cmd);
1946 upgt_bulk_tx(sc, data);
1947 usb_pause_mtx(&sc->sc_mtx, 100);
1948
1949 UPGT_UNLOCK(sc);
1950 DPRINTF(sc, UPGT_DEBUG_FW, "%s: device initialized\n", __func__);
1951 return (0);
1952}
1953
1954static int
1955upgt_alloc_tx(struct upgt_softc *sc)
1956{
1957 int i;
1958
1959 STAILQ_INIT(&sc->sc_tx_active);
1960 STAILQ_INIT(&sc->sc_tx_inactive);
1961 STAILQ_INIT(&sc->sc_tx_pending);
1962
1963 for (i = 0; i < UPGT_TX_MAXCOUNT; i++) {
1964 struct upgt_data *data = &sc->sc_tx_data[i];
1965 data->buf = ((uint8_t *)sc->sc_tx_dma_buf) + (i * MCLBYTES);
1966 STAILQ_INSERT_TAIL(&sc->sc_tx_inactive, data, next);
1967 UPGT_STAT_INC(sc, st_tx_inactive);
1968 }
1969
1970 return (0);
1971}
1972
1973static int
1974upgt_alloc_rx(struct upgt_softc *sc)
1975{
1976 int i;
1977
1978 STAILQ_INIT(&sc->sc_rx_active);
1979 STAILQ_INIT(&sc->sc_rx_inactive);
1980
1981 for (i = 0; i < UPGT_RX_MAXCOUNT; i++) {
1982 struct upgt_data *data = &sc->sc_rx_data[i];
1983 data->buf = ((uint8_t *)sc->sc_rx_dma_buf) + (i * MCLBYTES);
1984 STAILQ_INSERT_TAIL(&sc->sc_rx_inactive, data, next);
1985 }
|
2061 data->buf = NULL;
2062 data->ni = NULL;
2063 }
2064}
2065
2066static void
2067upgt_abort_xfers_locked(struct upgt_softc *sc)
2068{
2069 int i;
2070
2071 UPGT_ASSERT_LOCKED(sc);
2072 /* abort any pending transfers */
2073 for (i = 0; i < UPGT_N_XFERS; i++)
2074 usbd_transfer_stop(sc->sc_xfer[i]);
2075}
2076
2077static void
2078upgt_abort_xfers(struct upgt_softc *sc)
2079{
2080
2081 UPGT_LOCK(sc);
2082 upgt_abort_xfers_locked(sc);
2083 UPGT_UNLOCK(sc);
2084}
2085
2086#define UPGT_SYSCTL_STAT_ADD32(c, h, n, p, d) \
2087 SYSCTL_ADD_UINT(c, h, OID_AUTO, n, CTLFLAG_RD, p, 0, d)
2088
2089static void
2090upgt_sysctl_node(struct upgt_softc *sc)
2091{
2092 struct sysctl_ctx_list *ctx;
2093 struct sysctl_oid_list *child;
2094 struct sysctl_oid *tree;
2095 struct upgt_stat *stats;
2096
2097 stats = &sc->sc_stat;
2098 ctx = device_get_sysctl_ctx(sc->sc_dev);
2099 child = SYSCTL_CHILDREN(device_get_sysctl_tree(sc->sc_dev));
2100
2101 tree = SYSCTL_ADD_NODE(ctx, child, OID_AUTO, "stats", CTLFLAG_RD,
2102 NULL, "UPGT statistics");
2103 child = SYSCTL_CHILDREN(tree);
2104 UPGT_SYSCTL_STAT_ADD32(ctx, child, "tx_active",
2105 &stats->st_tx_active, "Active numbers in TX queue");
2106 UPGT_SYSCTL_STAT_ADD32(ctx, child, "tx_inactive",
2107 &stats->st_tx_inactive, "Inactive numbers in TX queue");
2108 UPGT_SYSCTL_STAT_ADD32(ctx, child, "tx_pending",
2109 &stats->st_tx_pending, "Pending numbers in TX queue");
2110}
2111
2112#undef UPGT_SYSCTL_STAT_ADD32
2113
2114static struct upgt_data *
2115_upgt_getbuf(struct upgt_softc *sc)
2116{
2117 struct upgt_data *bf;
2118
2119 bf = STAILQ_FIRST(&sc->sc_tx_inactive);
2120 if (bf != NULL) {
2121 STAILQ_REMOVE_HEAD(&sc->sc_tx_inactive, next);
2122 UPGT_STAT_DEC(sc, st_tx_inactive);
2123 } else
2124 bf = NULL;
2125 if (bf == NULL)
2126 DPRINTF(sc, UPGT_DEBUG_XMIT, "%s: %s\n", __func__,
2127 "out of xmit buffers");
2128 return (bf);
2129}
2130
2131static struct upgt_data *
2132upgt_getbuf(struct upgt_softc *sc)
2133{
2134 struct upgt_data *bf;
2135
2136 UPGT_ASSERT_LOCKED(sc);
2137
2138 bf = _upgt_getbuf(sc);
2139 if (bf == NULL) {
2140 struct ifnet *ifp = sc->sc_ifp;
2141
2142 DPRINTF(sc, UPGT_DEBUG_XMIT, "%s: stop queue\n", __func__);
2143 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
2144 }
2145
2146 return (bf);
2147}
2148
2149static struct upgt_data *
2150upgt_gettxbuf(struct upgt_softc *sc)
2151{
2152 struct upgt_data *bf;
2153
2154 UPGT_ASSERT_LOCKED(sc);
2155
2156 bf = upgt_getbuf(sc);
2157 if (bf == NULL)
2158 return (NULL);
2159
2160 bf->addr = upgt_mem_alloc(sc);
2161 if (bf->addr == 0) {
2162 struct ifnet *ifp = sc->sc_ifp;
2163
2164 DPRINTF(sc, UPGT_DEBUG_XMIT, "%s: no free prism memory!\n",
2165 __func__);
2166 STAILQ_INSERT_HEAD(&sc->sc_tx_inactive, bf, next);
2167 UPGT_STAT_INC(sc, st_tx_inactive);
2168 if (!(ifp->if_drv_flags & IFF_DRV_OACTIVE))
2169 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
2170 return (NULL);
2171 }
2172 return (bf);
2173}
2174
2175static int
2176upgt_tx_start(struct upgt_softc *sc, struct mbuf *m, struct ieee80211_node *ni,
2177 struct upgt_data *data)
2178{
2179 struct ieee80211vap *vap = ni->ni_vap;
2180 int error = 0, len;
2181 struct ieee80211_frame *wh;
2182 struct ieee80211_key *k;
2183 struct ifnet *ifp = sc->sc_ifp;
2184 struct upgt_lmac_mem *mem;
2185 struct upgt_lmac_tx_desc *txdesc;
2186
2187 UPGT_ASSERT_LOCKED(sc);
2188
2189 upgt_set_led(sc, UPGT_LED_BLINK);
2190
2191 /*
2192 * Software crypto.
2193 */
2194 wh = mtod(m, struct ieee80211_frame *);
2195 if (wh->i_fc[1] & IEEE80211_FC1_WEP) {
2196 k = ieee80211_crypto_encap(ni, m);
2197 if (k == NULL) {
2198 device_printf(sc->sc_dev,
2199 "ieee80211_crypto_encap returns NULL.\n");
2200 error = EIO;
2201 goto done;
2202 }
2203
2204 /* in case packet header moved, reset pointer */
2205 wh = mtod(m, struct ieee80211_frame *);
2206 }
2207
2208 /* Transmit the URB containing the TX data. */
2209 memset(data->buf, 0, MCLBYTES);
2210 mem = (struct upgt_lmac_mem *)data->buf;
2211 mem->addr = htole32(data->addr);
2212 txdesc = (struct upgt_lmac_tx_desc *)(mem + 1);
2213
2214 if ((wh->i_fc[0] & IEEE80211_FC0_TYPE_MASK) ==
2215 IEEE80211_FC0_TYPE_MGT) {
2216 /* mgmt frames */
2217 txdesc->header1.flags = UPGT_H1_FLAGS_TX_MGMT;
2218 /* always send mgmt frames at lowest rate (DS1) */
2219 memset(txdesc->rates, 0x10, sizeof(txdesc->rates));
2220 } else {
2221 /* data frames */
2222 txdesc->header1.flags = UPGT_H1_FLAGS_TX_DATA;
2223 memcpy(txdesc->rates, sc->sc_cur_rateset, sizeof(txdesc->rates));
2224 }
2225 txdesc->header1.type = UPGT_H1_TYPE_TX_DATA;
2226 txdesc->header1.len = htole16(m->m_pkthdr.len);
2227 txdesc->header2.reqid = htole32(data->addr);
2228 txdesc->header2.type = htole16(UPGT_H2_TYPE_TX_ACK_YES);
2229 txdesc->header2.flags = htole16(UPGT_H2_FLAGS_TX_ACK_YES);
2230 txdesc->type = htole32(UPGT_TX_DESC_TYPE_DATA);
2231 txdesc->pad3[0] = UPGT_TX_DESC_PAD3_SIZE;
2232
2233 if (ieee80211_radiotap_active_vap(vap)) {
2234 struct upgt_tx_radiotap_header *tap = &sc->sc_txtap;
2235
2236 tap->wt_flags = 0;
2237 tap->wt_rate = 0; /* XXX where to get from? */
2238
2239 ieee80211_radiotap_tx(vap, m);
2240 }
2241
2242 /* copy frame below our TX descriptor header */
2243 m_copydata(m, 0, m->m_pkthdr.len,
2244 data->buf + (sizeof(*mem) + sizeof(*txdesc)));
2245 /* calculate frame size */
2246 len = sizeof(*mem) + sizeof(*txdesc) + m->m_pkthdr.len;
2247 /* we need to align the frame to a 4 byte boundary */
2248 len = (len + 3) & ~3;
2249 /* calculate frame checksum */
2250 mem->chksum = upgt_chksum_le((uint32_t *)txdesc, len - sizeof(*mem));
2251 data->ni = ni;
2252 data->m = m;
2253 data->buflen = len;
2254
2255 DPRINTF(sc, UPGT_DEBUG_XMIT, "%s: TX start data sending (%d bytes)\n",
2256 __func__, len);
2257 KASSERT(len <= MCLBYTES, ("mbuf is small for saving data"));
2258
2259 upgt_bulk_tx(sc, data);
2260done:
2261 /*
2262 * If we don't regulary read the device statistics, the RX queue
2263 * will stall. It's strange, but it works, so we keep reading
2264 * the statistics here. *shrug*
2265 */
2266 if (!(ifp->if_opackets % UPGT_TX_STAT_INTERVAL))
2267 upgt_get_stats(sc);
2268
2269 return (error);
2270}
2271
2272static void
2273upgt_bulk_rx_callback(struct usb_xfer *xfer, usb_error_t error)
2274{
2275 struct upgt_softc *sc = usbd_xfer_softc(xfer);
2276 struct ifnet *ifp = sc->sc_ifp;
2277 struct ieee80211com *ic = ifp->if_l2com;
2278 struct ieee80211_frame *wh;
2279 struct ieee80211_node *ni;
2280 struct mbuf *m = NULL;
2281 struct upgt_data *data;
2282 int8_t nf;
2283 int rssi = -1;
2284
2285 UPGT_ASSERT_LOCKED(sc);
2286
2287 switch (USB_GET_STATE(xfer)) {
2288 case USB_ST_TRANSFERRED:
2289 data = STAILQ_FIRST(&sc->sc_rx_active);
2290 if (data == NULL)
2291 goto setup;
2292 STAILQ_REMOVE_HEAD(&sc->sc_rx_active, next);
2293 m = upgt_rxeof(xfer, data, &rssi);
2294 STAILQ_INSERT_TAIL(&sc->sc_rx_inactive, data, next);
2295 /* FALLTHROUGH */
2296 case USB_ST_SETUP:
2297setup:
2298 data = STAILQ_FIRST(&sc->sc_rx_inactive);
2299 if (data == NULL)
2300 return;
2301 STAILQ_REMOVE_HEAD(&sc->sc_rx_inactive, next);
2302 STAILQ_INSERT_TAIL(&sc->sc_rx_active, data, next);
2303 usbd_xfer_set_frame_data(xfer, 0, data->buf, MCLBYTES);
2304 usbd_transfer_submit(xfer);
2305
2306 /*
2307 * To avoid LOR we should unlock our private mutex here to call
2308 * ieee80211_input() because here is at the end of a USB
2309 * callback and safe to unlock.
2310 */
2311 UPGT_UNLOCK(sc);
2312 if (m != NULL) {
2313 wh = mtod(m, struct ieee80211_frame *);
2314 ni = ieee80211_find_rxnode(ic,
2315 (struct ieee80211_frame_min *)wh);
2316 nf = -95; /* XXX */
2317 if (ni != NULL) {
2318 (void) ieee80211_input(ni, m, rssi, nf);
2319 /* node is no longer needed */
2320 ieee80211_free_node(ni);
2321 } else
2322 (void) ieee80211_input_all(ic, m, rssi, nf);
2323 m = NULL;
2324 }
2325 if ((ifp->if_drv_flags & IFF_DRV_OACTIVE) == 0 &&
2326 !IFQ_IS_EMPTY(&ifp->if_snd))
2327 upgt_start(ifp);
2328 UPGT_LOCK(sc);
2329 break;
2330 default:
2331 /* needs it to the inactive queue due to a error. */
2332 data = STAILQ_FIRST(&sc->sc_rx_active);
2333 if (data != NULL) {
2334 STAILQ_REMOVE_HEAD(&sc->sc_rx_active, next);
2335 STAILQ_INSERT_TAIL(&sc->sc_rx_inactive, data, next);
2336 }
2337 if (error != USB_ERR_CANCELLED) {
2338 usbd_xfer_set_stall(xfer);
2339 ifp->if_ierrors++;
2340 goto setup;
2341 }
2342 break;
2343 }
2344}
2345
2346static void
2347upgt_bulk_tx_callback(struct usb_xfer *xfer, usb_error_t error)
2348{
2349 struct upgt_softc *sc = usbd_xfer_softc(xfer);
2350 struct ifnet *ifp = sc->sc_ifp;
2351 struct upgt_data *data;
2352
2353 UPGT_ASSERT_LOCKED(sc);
2354 switch (USB_GET_STATE(xfer)) {
2355 case USB_ST_TRANSFERRED:
2356 data = STAILQ_FIRST(&sc->sc_tx_active);
2357 if (data == NULL)
2358 goto setup;
2359 STAILQ_REMOVE_HEAD(&sc->sc_tx_active, next);
2360 UPGT_STAT_DEC(sc, st_tx_active);
2361 upgt_txeof(xfer, data);
2362 STAILQ_INSERT_TAIL(&sc->sc_tx_inactive, data, next);
2363 UPGT_STAT_INC(sc, st_tx_inactive);
2364 /* FALLTHROUGH */
2365 case USB_ST_SETUP:
2366setup:
2367 data = STAILQ_FIRST(&sc->sc_tx_pending);
2368 if (data == NULL) {
2369 DPRINTF(sc, UPGT_DEBUG_XMIT, "%s: empty pending queue\n",
2370 __func__);
2371 return;
2372 }
2373 STAILQ_REMOVE_HEAD(&sc->sc_tx_pending, next);
2374 UPGT_STAT_DEC(sc, st_tx_pending);
2375 STAILQ_INSERT_TAIL(&sc->sc_tx_active, data, next);
2376 UPGT_STAT_INC(sc, st_tx_active);
2377
2378 usbd_xfer_set_frame_data(xfer, 0, data->buf, data->buflen);
2379 usbd_transfer_submit(xfer);
2380 UPGT_UNLOCK(sc);
2381 upgt_start(ifp);
2382 UPGT_LOCK(sc);
2383 break;
2384 default:
2385 data = STAILQ_FIRST(&sc->sc_tx_active);
2386 if (data == NULL)
2387 goto setup;
2388 if (data->ni != NULL) {
2389 ieee80211_free_node(data->ni);
2390 data->ni = NULL;
2391 ifp->if_oerrors++;
2392 }
2393 if (error != USB_ERR_CANCELLED) {
2394 usbd_xfer_set_stall(xfer);
2395 goto setup;
2396 }
2397 break;
2398 }
2399}
2400
2401static device_method_t upgt_methods[] = {
2402 /* Device interface */
2403 DEVMETHOD(device_probe, upgt_match),
2404 DEVMETHOD(device_attach, upgt_attach),
2405 DEVMETHOD(device_detach, upgt_detach),
2406 DEVMETHOD_END
2407};
2408
2409static driver_t upgt_driver = {
2410 .name = "upgt",
2411 .methods = upgt_methods,
2412 .size = sizeof(struct upgt_softc)
2413};
2414
2415static devclass_t upgt_devclass;
2416
2417DRIVER_MODULE(if_upgt, uhub, upgt_driver, upgt_devclass, NULL, 0);
2418MODULE_VERSION(if_upgt, 1);
2419MODULE_DEPEND(if_upgt, usb, 1, 1, 1);
2420MODULE_DEPEND(if_upgt, wlan, 1, 1, 1);
2421MODULE_DEPEND(if_upgt, upgtfw_fw, 1, 1, 1);
|