if_rum.c revision 190532
1/*	$FreeBSD: head/sys/dev/usb/wlan/if_rum.c 190532 2009-03-29 21:17:08Z sam $	*/
2
3/*-
4 * Copyright (c) 2005-2007 Damien Bergamini <damien.bergamini@free.fr>
5 * Copyright (c) 2006 Niall O'Higgins <niallo@openbsd.org>
6 * Copyright (c) 2007-2008 Hans Petter Selasky <hselasky@FreeBSD.org>
7 *
8 * Permission to use, copy, modify, and distribute this software for any
9 * purpose with or without fee is hereby granted, provided that the above
10 * copyright notice and this permission notice appear in all copies.
11 *
12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 */
20
21#include <sys/cdefs.h>
22__FBSDID("$FreeBSD: head/sys/dev/usb/wlan/if_rum.c 190532 2009-03-29 21:17:08Z sam $");
23
24/*-
25 * Ralink Technology RT2501USB/RT2601USB chipset driver
26 * http://www.ralinktech.com.tw/
27 */
28
29#include "usbdevs.h"
30#include <dev/usb/usb.h>
31#include <dev/usb/usb_mfunc.h>
32#include <dev/usb/usb_error.h>
33
34#define	USB_DEBUG_VAR rum_debug
35
36#include <dev/usb/usb_core.h>
37#include <dev/usb/usb_lookup.h>
38#include <dev/usb/usb_process.h>
39#include <dev/usb/usb_debug.h>
40#include <dev/usb/usb_request.h>
41#include <dev/usb/usb_busdma.h>
42#include <dev/usb/usb_util.h>
43
44#include <dev/usb/wlan/usb_wlan.h>
45#include <dev/usb/wlan/if_rumreg.h>
46#include <dev/usb/wlan/if_rumvar.h>
47#include <dev/usb/wlan/if_rumfw.h>
48
49#if USB_DEBUG
50static int rum_debug = 0;
51
52SYSCTL_NODE(_hw_usb2, OID_AUTO, rum, CTLFLAG_RW, 0, "USB rum");
53SYSCTL_INT(_hw_usb2_rum, OID_AUTO, debug, CTLFLAG_RW, &rum_debug, 0,
54    "Debug level");
55#endif
56
57static const struct usb2_device_id rum_devs[] = {
58    { USB_VP(USB_VENDOR_ABOCOM,		USB_PRODUCT_ABOCOM_HWU54DM) },
59    { USB_VP(USB_VENDOR_ABOCOM,		USB_PRODUCT_ABOCOM_RT2573_2) },
60    { USB_VP(USB_VENDOR_ABOCOM,		USB_PRODUCT_ABOCOM_RT2573_3) },
61    { USB_VP(USB_VENDOR_ABOCOM,		USB_PRODUCT_ABOCOM_RT2573_4) },
62    { USB_VP(USB_VENDOR_ABOCOM,		USB_PRODUCT_ABOCOM_WUG2700) },
63    { USB_VP(USB_VENDOR_AMIT,		USB_PRODUCT_AMIT_CGWLUSB2GO) },
64    { USB_VP(USB_VENDOR_ASUS,		USB_PRODUCT_ASUS_RT2573_1) },
65    { USB_VP(USB_VENDOR_ASUS,		USB_PRODUCT_ASUS_RT2573_2) },
66    { USB_VP(USB_VENDOR_BELKIN,		USB_PRODUCT_BELKIN_F5D7050A) },
67    { USB_VP(USB_VENDOR_BELKIN,		USB_PRODUCT_BELKIN_F5D9050V3) },
68    { USB_VP(USB_VENDOR_CISCOLINKSYS,	USB_PRODUCT_CISCOLINKSYS_WUSB54GC) },
69    { USB_VP(USB_VENDOR_CISCOLINKSYS,	USB_PRODUCT_CISCOLINKSYS_WUSB54GR) },
70    { USB_VP(USB_VENDOR_CONCEPTRONIC2,	USB_PRODUCT_CONCEPTRONIC2_C54RU2) },
71    { USB_VP(USB_VENDOR_COREGA,		USB_PRODUCT_COREGA_CGWLUSB2GL) },
72    { USB_VP(USB_VENDOR_COREGA,		USB_PRODUCT_COREGA_CGWLUSB2GPX) },
73    { USB_VP(USB_VENDOR_DICKSMITH,	USB_PRODUCT_DICKSMITH_CWD854F) },
74    { USB_VP(USB_VENDOR_DICKSMITH,	USB_PRODUCT_DICKSMITH_RT2573) },
75    { USB_VP(USB_VENDOR_DLINK2,		USB_PRODUCT_DLINK2_DWLG122C1) },
76    { USB_VP(USB_VENDOR_DLINK2,		USB_PRODUCT_DLINK2_WUA1340) },
77    { USB_VP(USB_VENDOR_DLINK2,		USB_PRODUCT_DLINK2_DWA111) },
78    { USB_VP(USB_VENDOR_DLINK2,		USB_PRODUCT_DLINK2_DWA110) },
79    { USB_VP(USB_VENDOR_GIGABYTE,	USB_PRODUCT_GIGABYTE_GNWB01GS) },
80    { USB_VP(USB_VENDOR_GIGABYTE,	USB_PRODUCT_GIGABYTE_GNWI05GS) },
81    { USB_VP(USB_VENDOR_GIGASET,	USB_PRODUCT_GIGASET_RT2573) },
82    { USB_VP(USB_VENDOR_GOODWAY,	USB_PRODUCT_GOODWAY_RT2573) },
83    { USB_VP(USB_VENDOR_GUILLEMOT,	USB_PRODUCT_GUILLEMOT_HWGUSB254LB) },
84    { USB_VP(USB_VENDOR_GUILLEMOT,	USB_PRODUCT_GUILLEMOT_HWGUSB254V2AP) },
85    { USB_VP(USB_VENDOR_HUAWEI3COM,	USB_PRODUCT_HUAWEI3COM_WUB320G) },
86    { USB_VP(USB_VENDOR_MELCO,		USB_PRODUCT_MELCO_G54HP) },
87    { USB_VP(USB_VENDOR_MELCO,		USB_PRODUCT_MELCO_SG54HP) },
88    { USB_VP(USB_VENDOR_MSI,		USB_PRODUCT_MSI_RT2573_1) },
89    { USB_VP(USB_VENDOR_MSI,		USB_PRODUCT_MSI_RT2573_2) },
90    { USB_VP(USB_VENDOR_MSI,		USB_PRODUCT_MSI_RT2573_3) },
91    { USB_VP(USB_VENDOR_MSI,		USB_PRODUCT_MSI_RT2573_4) },
92    { USB_VP(USB_VENDOR_NOVATECH,	USB_PRODUCT_NOVATECH_RT2573) },
93    { USB_VP(USB_VENDOR_PLANEX2,	USB_PRODUCT_PLANEX2_GWUS54HP) },
94    { USB_VP(USB_VENDOR_PLANEX2,	USB_PRODUCT_PLANEX2_GWUS54MINI2) },
95    { USB_VP(USB_VENDOR_PLANEX2,	USB_PRODUCT_PLANEX2_GWUSMM) },
96    { USB_VP(USB_VENDOR_QCOM,		USB_PRODUCT_QCOM_RT2573) },
97    { USB_VP(USB_VENDOR_QCOM,		USB_PRODUCT_QCOM_RT2573_2) },
98    { USB_VP(USB_VENDOR_RALINK,		USB_PRODUCT_RALINK_RT2573) },
99    { USB_VP(USB_VENDOR_RALINK,		USB_PRODUCT_RALINK_RT2573_2) },
100    { USB_VP(USB_VENDOR_RALINK,		USB_PRODUCT_RALINK_RT2671) },
101    { USB_VP(USB_VENDOR_SITECOMEU,	USB_PRODUCT_SITECOMEU_WL113R2) },
102    { USB_VP(USB_VENDOR_SITECOMEU,	USB_PRODUCT_SITECOMEU_WL172) },
103    { USB_VP(USB_VENDOR_SPARKLAN,	USB_PRODUCT_SPARKLAN_RT2573) },
104    { USB_VP(USB_VENDOR_SURECOM,	USB_PRODUCT_SURECOM_RT2573) },
105};
106
107MODULE_DEPEND(rum, wlan, 1, 1, 1);
108MODULE_DEPEND(rum, wlan_amrr, 1, 1, 1);
109MODULE_DEPEND(rum, usb, 1, 1, 1);
110
111static device_probe_t rum_match;
112static device_attach_t rum_attach;
113static device_detach_t rum_detach;
114
115static usb2_callback_t rum_bulk_read_callback;
116static usb2_callback_t rum_bulk_write_callback;
117
118static usb2_proc_callback_t rum_command_wrapper;
119static usb2_proc_callback_t rum_attach_post;
120static usb2_proc_callback_t rum_task;
121static usb2_proc_callback_t rum_scantask;
122static usb2_proc_callback_t rum_promisctask;
123static usb2_proc_callback_t rum_amrr_task;
124static usb2_proc_callback_t rum_init_task;
125static usb2_proc_callback_t rum_stop_task;
126static usb2_proc_callback_t rum_flush_task;
127
128static usb2_error_t	rum_do_request(struct rum_softc *sc,
129			    struct usb2_device_request *req, void *data);
130static struct ieee80211vap *rum_vap_create(struct ieee80211com *,
131			    const char name[IFNAMSIZ], int unit, int opmode,
132			    int flags, const uint8_t bssid[IEEE80211_ADDR_LEN],
133			    const uint8_t mac[IEEE80211_ADDR_LEN]);
134static void		rum_vap_delete(struct ieee80211vap *);
135static void		rum_tx_free(struct rum_tx_data *, int);
136static void		rum_setup_tx_list(struct rum_softc *);
137static void		rum_unsetup_tx_list(struct rum_softc *);
138static int		rum_newstate(struct ieee80211vap *,
139			    enum ieee80211_state, int);
140static void		rum_setup_tx_desc(struct rum_softc *,
141			    struct rum_tx_desc *, uint32_t, uint16_t, int,
142			    int);
143static int		rum_tx_mgt(struct rum_softc *, struct mbuf *,
144			    struct ieee80211_node *);
145static int		rum_tx_raw(struct rum_softc *, struct mbuf *,
146			    struct ieee80211_node *,
147			    const struct ieee80211_bpf_params *);
148static int		rum_tx_data(struct rum_softc *, struct mbuf *,
149			    struct ieee80211_node *);
150static void		rum_start(struct ifnet *);
151static int		rum_ioctl(struct ifnet *, u_long, caddr_t);
152static void		rum_eeprom_read(struct rum_softc *, uint16_t, void *,
153			    int);
154static uint32_t		rum_read(struct rum_softc *, uint16_t);
155static void		rum_read_multi(struct rum_softc *, uint16_t, void *,
156			    int);
157static usb2_error_t	rum_write(struct rum_softc *, uint16_t, uint32_t);
158static usb2_error_t	rum_write_multi(struct rum_softc *, uint16_t, void *,
159			    size_t);
160static void		rum_bbp_write(struct rum_softc *, uint8_t, uint8_t);
161static uint8_t		rum_bbp_read(struct rum_softc *, uint8_t);
162static void		rum_rf_write(struct rum_softc *, uint8_t, uint32_t);
163static void		rum_select_antenna(struct rum_softc *);
164static void		rum_enable_mrr(struct rum_softc *);
165static void		rum_set_txpreamble(struct rum_softc *);
166static void		rum_set_basicrates(struct rum_softc *);
167static void		rum_select_band(struct rum_softc *,
168			    struct ieee80211_channel *);
169static void		rum_set_chan(struct rum_softc *,
170			    struct ieee80211_channel *);
171static void		rum_enable_tsf_sync(struct rum_softc *);
172static void		rum_update_slot(struct ifnet *);
173static void		rum_set_bssid(struct rum_softc *, const uint8_t *);
174static void		rum_set_macaddr(struct rum_softc *, const uint8_t *);
175static void		rum_update_promisc(struct ifnet *);
176static const char	*rum_get_rf(int);
177static void		rum_read_eeprom(struct rum_softc *);
178static int		rum_bbp_init(struct rum_softc *);
179static void		rum_init(void *);
180static void		rum_load_microcode(struct rum_softc *, const uint8_t *,
181			    size_t);
182static int		rum_prepare_beacon(struct rum_softc *,
183			    struct ieee80211vap *);
184static int		rum_raw_xmit(struct ieee80211_node *, struct mbuf *,
185			    const struct ieee80211_bpf_params *);
186static struct ieee80211_node *rum_node_alloc(struct ieee80211vap *,
187			    const uint8_t mac[IEEE80211_ADDR_LEN]);
188static void		rum_newassoc(struct ieee80211_node *, int);
189static void		rum_scan_start(struct ieee80211com *);
190static void		rum_scan_end(struct ieee80211com *);
191static void		rum_set_channel(struct ieee80211com *);
192static int		rum_get_rssi(struct rum_softc *, uint8_t);
193static void		rum_amrr_start(struct rum_softc *,
194			    struct ieee80211_node *);
195static void		rum_amrr_timeout(void *);
196static int		rum_pause(struct rum_softc *, int);
197static void		rum_queue_command(struct rum_softc *,
198			    usb2_proc_callback_t *, struct usb2_proc_msg *,
199			    struct usb2_proc_msg *);
200
201static const struct {
202	uint32_t	reg;
203	uint32_t	val;
204} rum_def_mac[] = {
205	{ RT2573_TXRX_CSR0,  0x025fb032 },
206	{ RT2573_TXRX_CSR1,  0x9eaa9eaf },
207	{ RT2573_TXRX_CSR2,  0x8a8b8c8d },
208	{ RT2573_TXRX_CSR3,  0x00858687 },
209	{ RT2573_TXRX_CSR7,  0x2e31353b },
210	{ RT2573_TXRX_CSR8,  0x2a2a2a2c },
211	{ RT2573_TXRX_CSR15, 0x0000000f },
212	{ RT2573_MAC_CSR6,   0x00000fff },
213	{ RT2573_MAC_CSR8,   0x016c030a },
214	{ RT2573_MAC_CSR10,  0x00000718 },
215	{ RT2573_MAC_CSR12,  0x00000004 },
216	{ RT2573_MAC_CSR13,  0x00007f00 },
217	{ RT2573_SEC_CSR0,   0x00000000 },
218	{ RT2573_SEC_CSR1,   0x00000000 },
219	{ RT2573_SEC_CSR5,   0x00000000 },
220	{ RT2573_PHY_CSR1,   0x000023b0 },
221	{ RT2573_PHY_CSR5,   0x00040a06 },
222	{ RT2573_PHY_CSR6,   0x00080606 },
223	{ RT2573_PHY_CSR7,   0x00000408 },
224	{ RT2573_AIFSN_CSR,  0x00002273 },
225	{ RT2573_CWMIN_CSR,  0x00002344 },
226	{ RT2573_CWMAX_CSR,  0x000034aa }
227};
228
229static const struct {
230	uint8_t	reg;
231	uint8_t	val;
232} rum_def_bbp[] = {
233	{   3, 0x80 },
234	{  15, 0x30 },
235	{  17, 0x20 },
236	{  21, 0xc8 },
237	{  22, 0x38 },
238	{  23, 0x06 },
239	{  24, 0xfe },
240	{  25, 0x0a },
241	{  26, 0x0d },
242	{  32, 0x0b },
243	{  34, 0x12 },
244	{  37, 0x07 },
245	{  39, 0xf8 },
246	{  41, 0x60 },
247	{  53, 0x10 },
248	{  54, 0x18 },
249	{  60, 0x10 },
250	{  61, 0x04 },
251	{  62, 0x04 },
252	{  75, 0xfe },
253	{  86, 0xfe },
254	{  88, 0xfe },
255	{  90, 0x0f },
256	{  99, 0x00 },
257	{ 102, 0x16 },
258	{ 107, 0x04 }
259};
260
261static const struct rfprog {
262	uint8_t		chan;
263	uint32_t	r1, r2, r3, r4;
264}  rum_rf5226[] = {
265	{   1, 0x00b03, 0x001e1, 0x1a014, 0x30282 },
266	{   2, 0x00b03, 0x001e1, 0x1a014, 0x30287 },
267	{   3, 0x00b03, 0x001e2, 0x1a014, 0x30282 },
268	{   4, 0x00b03, 0x001e2, 0x1a014, 0x30287 },
269	{   5, 0x00b03, 0x001e3, 0x1a014, 0x30282 },
270	{   6, 0x00b03, 0x001e3, 0x1a014, 0x30287 },
271	{   7, 0x00b03, 0x001e4, 0x1a014, 0x30282 },
272	{   8, 0x00b03, 0x001e4, 0x1a014, 0x30287 },
273	{   9, 0x00b03, 0x001e5, 0x1a014, 0x30282 },
274	{  10, 0x00b03, 0x001e5, 0x1a014, 0x30287 },
275	{  11, 0x00b03, 0x001e6, 0x1a014, 0x30282 },
276	{  12, 0x00b03, 0x001e6, 0x1a014, 0x30287 },
277	{  13, 0x00b03, 0x001e7, 0x1a014, 0x30282 },
278	{  14, 0x00b03, 0x001e8, 0x1a014, 0x30284 },
279
280	{  34, 0x00b03, 0x20266, 0x36014, 0x30282 },
281	{  38, 0x00b03, 0x20267, 0x36014, 0x30284 },
282	{  42, 0x00b03, 0x20268, 0x36014, 0x30286 },
283	{  46, 0x00b03, 0x20269, 0x36014, 0x30288 },
284
285	{  36, 0x00b03, 0x00266, 0x26014, 0x30288 },
286	{  40, 0x00b03, 0x00268, 0x26014, 0x30280 },
287	{  44, 0x00b03, 0x00269, 0x26014, 0x30282 },
288	{  48, 0x00b03, 0x0026a, 0x26014, 0x30284 },
289	{  52, 0x00b03, 0x0026b, 0x26014, 0x30286 },
290	{  56, 0x00b03, 0x0026c, 0x26014, 0x30288 },
291	{  60, 0x00b03, 0x0026e, 0x26014, 0x30280 },
292	{  64, 0x00b03, 0x0026f, 0x26014, 0x30282 },
293
294	{ 100, 0x00b03, 0x0028a, 0x2e014, 0x30280 },
295	{ 104, 0x00b03, 0x0028b, 0x2e014, 0x30282 },
296	{ 108, 0x00b03, 0x0028c, 0x2e014, 0x30284 },
297	{ 112, 0x00b03, 0x0028d, 0x2e014, 0x30286 },
298	{ 116, 0x00b03, 0x0028e, 0x2e014, 0x30288 },
299	{ 120, 0x00b03, 0x002a0, 0x2e014, 0x30280 },
300	{ 124, 0x00b03, 0x002a1, 0x2e014, 0x30282 },
301	{ 128, 0x00b03, 0x002a2, 0x2e014, 0x30284 },
302	{ 132, 0x00b03, 0x002a3, 0x2e014, 0x30286 },
303	{ 136, 0x00b03, 0x002a4, 0x2e014, 0x30288 },
304	{ 140, 0x00b03, 0x002a6, 0x2e014, 0x30280 },
305
306	{ 149, 0x00b03, 0x002a8, 0x2e014, 0x30287 },
307	{ 153, 0x00b03, 0x002a9, 0x2e014, 0x30289 },
308	{ 157, 0x00b03, 0x002ab, 0x2e014, 0x30281 },
309	{ 161, 0x00b03, 0x002ac, 0x2e014, 0x30283 },
310	{ 165, 0x00b03, 0x002ad, 0x2e014, 0x30285 }
311}, rum_rf5225[] = {
312	{   1, 0x00b33, 0x011e1, 0x1a014, 0x30282 },
313	{   2, 0x00b33, 0x011e1, 0x1a014, 0x30287 },
314	{   3, 0x00b33, 0x011e2, 0x1a014, 0x30282 },
315	{   4, 0x00b33, 0x011e2, 0x1a014, 0x30287 },
316	{   5, 0x00b33, 0x011e3, 0x1a014, 0x30282 },
317	{   6, 0x00b33, 0x011e3, 0x1a014, 0x30287 },
318	{   7, 0x00b33, 0x011e4, 0x1a014, 0x30282 },
319	{   8, 0x00b33, 0x011e4, 0x1a014, 0x30287 },
320	{   9, 0x00b33, 0x011e5, 0x1a014, 0x30282 },
321	{  10, 0x00b33, 0x011e5, 0x1a014, 0x30287 },
322	{  11, 0x00b33, 0x011e6, 0x1a014, 0x30282 },
323	{  12, 0x00b33, 0x011e6, 0x1a014, 0x30287 },
324	{  13, 0x00b33, 0x011e7, 0x1a014, 0x30282 },
325	{  14, 0x00b33, 0x011e8, 0x1a014, 0x30284 },
326
327	{  34, 0x00b33, 0x01266, 0x26014, 0x30282 },
328	{  38, 0x00b33, 0x01267, 0x26014, 0x30284 },
329	{  42, 0x00b33, 0x01268, 0x26014, 0x30286 },
330	{  46, 0x00b33, 0x01269, 0x26014, 0x30288 },
331
332	{  36, 0x00b33, 0x01266, 0x26014, 0x30288 },
333	{  40, 0x00b33, 0x01268, 0x26014, 0x30280 },
334	{  44, 0x00b33, 0x01269, 0x26014, 0x30282 },
335	{  48, 0x00b33, 0x0126a, 0x26014, 0x30284 },
336	{  52, 0x00b33, 0x0126b, 0x26014, 0x30286 },
337	{  56, 0x00b33, 0x0126c, 0x26014, 0x30288 },
338	{  60, 0x00b33, 0x0126e, 0x26014, 0x30280 },
339	{  64, 0x00b33, 0x0126f, 0x26014, 0x30282 },
340
341	{ 100, 0x00b33, 0x0128a, 0x2e014, 0x30280 },
342	{ 104, 0x00b33, 0x0128b, 0x2e014, 0x30282 },
343	{ 108, 0x00b33, 0x0128c, 0x2e014, 0x30284 },
344	{ 112, 0x00b33, 0x0128d, 0x2e014, 0x30286 },
345	{ 116, 0x00b33, 0x0128e, 0x2e014, 0x30288 },
346	{ 120, 0x00b33, 0x012a0, 0x2e014, 0x30280 },
347	{ 124, 0x00b33, 0x012a1, 0x2e014, 0x30282 },
348	{ 128, 0x00b33, 0x012a2, 0x2e014, 0x30284 },
349	{ 132, 0x00b33, 0x012a3, 0x2e014, 0x30286 },
350	{ 136, 0x00b33, 0x012a4, 0x2e014, 0x30288 },
351	{ 140, 0x00b33, 0x012a6, 0x2e014, 0x30280 },
352
353	{ 149, 0x00b33, 0x012a8, 0x2e014, 0x30287 },
354	{ 153, 0x00b33, 0x012a9, 0x2e014, 0x30289 },
355	{ 157, 0x00b33, 0x012ab, 0x2e014, 0x30281 },
356	{ 161, 0x00b33, 0x012ac, 0x2e014, 0x30283 },
357	{ 165, 0x00b33, 0x012ad, 0x2e014, 0x30285 }
358};
359
360static const struct usb2_config rum_config[RUM_N_TRANSFER] = {
361	[RUM_BULK_WR] = {
362		.type = UE_BULK,
363		.endpoint = UE_ADDR_ANY,
364		.direction = UE_DIR_OUT,
365		.mh.bufsize = (MCLBYTES + RT2573_TX_DESC_SIZE + 8),
366		.mh.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
367		.mh.callback = rum_bulk_write_callback,
368		.mh.timeout = 5000,	/* ms */
369	},
370	[RUM_BULK_RD] = {
371		.type = UE_BULK,
372		.endpoint = UE_ADDR_ANY,
373		.direction = UE_DIR_IN,
374		.mh.bufsize = (MCLBYTES + RT2573_RX_DESC_SIZE),
375		.mh.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
376		.mh.callback = rum_bulk_read_callback,
377	},
378};
379
380static int
381rum_match(device_t self)
382{
383	struct usb2_attach_arg *uaa = device_get_ivars(self);
384
385	if (uaa->usb2_mode != USB_MODE_HOST)
386		return (ENXIO);
387	if (uaa->info.bConfigIndex != 0)
388		return (ENXIO);
389	if (uaa->info.bIfaceIndex != RT2573_IFACE_INDEX)
390		return (ENXIO);
391
392	return (usb2_lookup_id_by_uaa(rum_devs, sizeof(rum_devs), uaa));
393}
394
395static int
396rum_attach(device_t self)
397{
398	struct usb2_attach_arg *uaa = device_get_ivars(self);
399	struct rum_softc *sc = device_get_softc(self);
400	uint8_t iface_index;
401	int error;
402
403	device_set_usb2_desc(self);
404	sc->sc_udev = uaa->device;
405	sc->sc_dev = self;
406
407	mtx_init(&sc->sc_mtx, device_get_nameunit(self),
408	    MTX_NETWORK_LOCK, MTX_DEF);
409
410	cv_init(&sc->sc_cmd_cv, "wtxdone");
411
412	iface_index = RT2573_IFACE_INDEX;
413	error = usb2_transfer_setup(uaa->device, &iface_index,
414	    sc->sc_xfer, rum_config, RUM_N_TRANSFER, sc, &sc->sc_mtx);
415	if (error) {
416		device_printf(self, "could not allocate USB transfers, "
417		    "err=%s\n", usb2_errstr(error));
418		goto detach;
419	}
420	error = usb2_proc_create(&sc->sc_tq, &sc->sc_mtx,
421	    device_get_nameunit(self), USB_PRI_MED);
422	if (error) {
423		device_printf(self, "could not setup config thread!\n");
424		goto detach;
425	}
426
427	/* fork rest of the attach code */
428	RUM_LOCK(sc);
429	rum_queue_command(sc, rum_attach_post,
430	    &sc->sc_synctask[0].hdr,
431	    &sc->sc_synctask[1].hdr);
432	RUM_UNLOCK(sc);
433	return (0);
434
435detach:
436	rum_detach(self);
437	return (ENXIO);			/* failure */
438}
439
440static void
441rum_attach_post(struct usb2_proc_msg *pm)
442{
443	struct rum_task *task = (struct rum_task *)pm;
444	struct rum_softc *sc = task->sc;
445	struct ifnet *ifp;
446	struct ieee80211com *ic;
447	unsigned int ntries;
448	uint32_t tmp;
449	uint8_t bands;
450
451	/* retrieve RT2573 rev. no */
452	for (ntries = 0; ntries < 100; ntries++) {
453		if ((tmp = rum_read(sc, RT2573_MAC_CSR0)) != 0)
454			break;
455		if (rum_pause(sc, hz / 100))
456			break;
457	}
458	if (ntries == 100) {
459		device_printf(sc->sc_dev, "timeout waiting for chip to settle\n");
460		return;
461	}
462
463	/* retrieve MAC address and various other things from EEPROM */
464	rum_read_eeprom(sc);
465
466	device_printf(sc->sc_dev, "MAC/BBP RT2573 (rev 0x%05x), RF %s\n",
467	    tmp, rum_get_rf(sc->rf_rev));
468
469	rum_load_microcode(sc, rt2573_ucode, sizeof(rt2573_ucode));
470
471	/* XXX Async attach race */
472	if (usb2_proc_is_gone(&sc->sc_tq))
473		return;
474
475	RUM_UNLOCK(sc);
476
477	ifp = sc->sc_ifp = if_alloc(IFT_IEEE80211);
478	if (ifp == NULL) {
479		device_printf(sc->sc_dev, "can not if_alloc()\n");
480		RUM_LOCK(sc);
481		return;
482	}
483	ic = ifp->if_l2com;
484
485	ifp->if_softc = sc;
486	if_initname(ifp, "rum", device_get_unit(sc->sc_dev));
487	ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
488	ifp->if_init = rum_init;
489	ifp->if_ioctl = rum_ioctl;
490	ifp->if_start = rum_start;
491	IFQ_SET_MAXLEN(&ifp->if_snd, IFQ_MAXLEN);
492	ifp->if_snd.ifq_drv_maxlen = IFQ_MAXLEN;
493	IFQ_SET_READY(&ifp->if_snd);
494
495	ic->ic_ifp = ifp;
496	ic->ic_phytype = IEEE80211_T_OFDM;	/* not only, but not used */
497
498	/* set device capabilities */
499	ic->ic_caps =
500	      IEEE80211_C_STA		/* station mode supported */
501	    | IEEE80211_C_IBSS		/* IBSS mode supported */
502	    | IEEE80211_C_MONITOR	/* monitor mode supported */
503	    | IEEE80211_C_HOSTAP	/* HostAp mode supported */
504	    | IEEE80211_C_TXPMGT	/* tx power management */
505	    | IEEE80211_C_SHPREAMBLE	/* short preamble supported */
506	    | IEEE80211_C_SHSLOT	/* short slot time supported */
507	    | IEEE80211_C_BGSCAN	/* bg scanning supported */
508	    | IEEE80211_C_WPA		/* 802.11i */
509	    ;
510
511	bands = 0;
512	setbit(&bands, IEEE80211_MODE_11B);
513	setbit(&bands, IEEE80211_MODE_11G);
514	if (sc->rf_rev == RT2573_RF_5225 || sc->rf_rev == RT2573_RF_5226)
515		setbit(&bands, IEEE80211_MODE_11A);
516	ieee80211_init_channels(ic, NULL, &bands);
517
518	ieee80211_ifattach(ic, sc->sc_bssid);
519	ic->ic_update_promisc = rum_update_promisc;
520	ic->ic_newassoc = rum_newassoc;
521	ic->ic_raw_xmit = rum_raw_xmit;
522	ic->ic_node_alloc = rum_node_alloc;
523	ic->ic_scan_start = rum_scan_start;
524	ic->ic_scan_end = rum_scan_end;
525	ic->ic_set_channel = rum_set_channel;
526
527	ic->ic_vap_create = rum_vap_create;
528	ic->ic_vap_delete = rum_vap_delete;
529
530	bpfattach(ifp, DLT_IEEE802_11_RADIO,
531	    sizeof (struct ieee80211_frame) + sizeof(sc->sc_txtap));
532
533	sc->sc_rxtap_len = sizeof sc->sc_rxtap;
534	sc->sc_rxtap.wr_ihdr.it_len = htole16(sc->sc_rxtap_len);
535	sc->sc_rxtap.wr_ihdr.it_present = htole32(RT2573_RX_RADIOTAP_PRESENT);
536
537	sc->sc_txtap_len = sizeof sc->sc_txtap;
538	sc->sc_txtap.wt_ihdr.it_len = htole16(sc->sc_txtap_len);
539	sc->sc_txtap.wt_ihdr.it_present = htole32(RT2573_TX_RADIOTAP_PRESENT);
540
541	if (bootverbose)
542		ieee80211_announce(ic);
543
544	RUM_LOCK(sc);
545}
546
547static int
548rum_detach(device_t self)
549{
550	struct rum_softc *sc = device_get_softc(self);
551	struct ifnet *ifp = sc->sc_ifp;
552	struct ieee80211com *ic;
553
554	/* wait for any post attach or other command to complete */
555	usb2_proc_drain(&sc->sc_tq);
556
557	/* stop all USB transfers */
558	usb2_transfer_unsetup(sc->sc_xfer, RUM_N_TRANSFER);
559	usb2_proc_free(&sc->sc_tq);
560
561	/* free TX list, if any */
562	RUM_LOCK(sc);
563	rum_unsetup_tx_list(sc);
564	RUM_UNLOCK(sc);
565
566	if (ifp) {
567		ic = ifp->if_l2com;
568		bpfdetach(ifp);
569		ieee80211_ifdetach(ic);
570		if_free(ifp);
571	}
572	cv_destroy(&sc->sc_cmd_cv);
573	mtx_destroy(&sc->sc_mtx);
574
575	return (0);
576}
577
578static usb2_error_t
579rum_do_request(struct rum_softc *sc,
580    struct usb2_device_request *req, void *data)
581{
582	usb2_error_t err;
583	int ntries = 10;
584
585	while (ntries--) {
586		err = usb2_do_request_proc(sc->sc_udev, &sc->sc_tq,
587		    req, data, 0, NULL, 250 /* ms */);
588		if (err == 0)
589			break;
590
591		DPRINTFN(1, "Control request failed, %s (retrying)\n",
592		    usb2_errstr(err));
593		if (rum_pause(sc, hz / 100))
594			break;
595	}
596	return (err);
597}
598
599static struct ieee80211vap *
600rum_vap_create(struct ieee80211com *ic,
601	const char name[IFNAMSIZ], int unit, int opmode, int flags,
602	const uint8_t bssid[IEEE80211_ADDR_LEN],
603	const uint8_t mac[IEEE80211_ADDR_LEN])
604{
605	struct rum_softc *sc = ic->ic_ifp->if_softc;
606	struct rum_vap *rvp;
607	struct ieee80211vap *vap;
608
609	if (!TAILQ_EMPTY(&ic->ic_vaps))		/* only one at a time */
610		return NULL;
611	rvp = (struct rum_vap *) malloc(sizeof(struct rum_vap),
612	    M_80211_VAP, M_NOWAIT | M_ZERO);
613	if (rvp == NULL)
614		return NULL;
615	vap = &rvp->vap;
616	/* enable s/w bmiss handling for sta mode */
617	ieee80211_vap_setup(ic, vap, name, unit, opmode,
618	    flags | IEEE80211_CLONE_NOBEACONS, bssid, mac);
619
620	/* override state transition machine */
621	rvp->newstate = vap->iv_newstate;
622	vap->iv_newstate = rum_newstate;
623
624	rvp->sc = sc;
625	usb2_callout_init_mtx(&rvp->amrr_ch, &sc->sc_mtx, 0);
626	ieee80211_amrr_init(&rvp->amrr, vap,
627	    IEEE80211_AMRR_MIN_SUCCESS_THRESHOLD,
628	    IEEE80211_AMRR_MAX_SUCCESS_THRESHOLD,
629	    1000 /* 1 sec */);
630
631	/* complete setup */
632	ieee80211_vap_attach(vap, ieee80211_media_change, ieee80211_media_status);
633	ic->ic_opmode = opmode;
634	return vap;
635}
636
637static void
638rum_flush_task(struct usb2_proc_msg *pm)
639{
640	/* Nothing to do */
641}
642
643static void
644rum_vap_delete(struct ieee80211vap *vap)
645{
646	struct rum_vap *rvp = RUM_VAP(vap);
647	struct rum_softc *sc = rvp->sc;
648
649	RUM_LOCK(sc);
650	/* wait for any pending tasks to complete */
651	rum_queue_command(sc, rum_flush_task,
652	    &sc->sc_synctask[0].hdr,
653	    &sc->sc_synctask[1].hdr);
654	RUM_UNLOCK(sc);
655
656	usb2_callout_drain(&rvp->amrr_ch);
657	ieee80211_amrr_cleanup(&rvp->amrr);
658	ieee80211_vap_detach(vap);
659	free(rvp, M_80211_VAP);
660}
661
662static void
663rum_tx_free(struct rum_tx_data *data, int txerr)
664{
665	struct rum_softc *sc = data->sc;
666
667	if (data->m != NULL) {
668		if (data->m->m_flags & M_TXCB)
669			ieee80211_process_callback(data->ni, data->m,
670			    txerr ? ETIMEDOUT : 0);
671		m_freem(data->m);
672		data->m = NULL;
673
674		ieee80211_free_node(data->ni);
675		data->ni = NULL;
676	}
677	STAILQ_INSERT_TAIL(&sc->tx_free, data, next);
678	sc->tx_nfree++;
679}
680
681static void
682rum_setup_tx_list(struct rum_softc *sc)
683{
684	struct rum_tx_data *data;
685	int i;
686
687	sc->tx_nfree = 0;
688	STAILQ_INIT(&sc->tx_q);
689	STAILQ_INIT(&sc->tx_free);
690
691	for (i = 0; i < RUM_TX_LIST_COUNT; i++) {
692		data = &sc->tx_data[i];
693
694		data->sc = sc;
695		STAILQ_INSERT_TAIL(&sc->tx_free, data, next);
696		sc->tx_nfree++;
697	}
698}
699
700static void
701rum_unsetup_tx_list(struct rum_softc *sc)
702{
703	struct rum_tx_data *data;
704	int i;
705
706	/* make sure any subsequent use of the queues will fail */
707	sc->tx_nfree = 0;
708	STAILQ_INIT(&sc->tx_q);
709	STAILQ_INIT(&sc->tx_free);
710
711	/* free up all node references and mbufs */
712	for (i = 0; i < RUM_TX_LIST_COUNT; i++) {
713		data = &sc->tx_data[i];
714
715		if (data->m != NULL) {
716			m_freem(data->m);
717			data->m = NULL;
718		}
719		if (data->ni != NULL) {
720			ieee80211_free_node(data->ni);
721			data->ni = NULL;
722		}
723	}
724}
725
726static void
727rum_task(struct usb2_proc_msg *pm)
728{
729	struct rum_task *task = (struct rum_task *)pm;
730	struct rum_softc *sc = task->sc;
731	struct ifnet *ifp = sc->sc_ifp;
732	struct ieee80211com *ic = ifp->if_l2com;
733	struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
734	struct rum_vap *rvp = RUM_VAP(vap);
735	const struct ieee80211_txparam *tp;
736	enum ieee80211_state ostate;
737	struct ieee80211_node *ni;
738	uint32_t tmp;
739
740	ostate = vap->iv_state;
741
742	switch (sc->sc_state) {
743	case IEEE80211_S_INIT:
744		if (ostate == IEEE80211_S_RUN) {
745			/* abort TSF synchronization */
746			tmp = rum_read(sc, RT2573_TXRX_CSR9);
747			rum_write(sc, RT2573_TXRX_CSR9, tmp & ~0x00ffffff);
748		}
749		break;
750
751	case IEEE80211_S_RUN:
752		ni = vap->iv_bss;
753
754		if (vap->iv_opmode != IEEE80211_M_MONITOR) {
755			rum_update_slot(ic->ic_ifp);
756			rum_enable_mrr(sc);
757			rum_set_txpreamble(sc);
758			rum_set_basicrates(sc);
759			IEEE80211_ADDR_COPY(sc->sc_bssid, ni->ni_bssid);
760			rum_set_bssid(sc, sc->sc_bssid);
761		}
762
763		if (vap->iv_opmode == IEEE80211_M_HOSTAP ||
764		    vap->iv_opmode == IEEE80211_M_IBSS)
765			rum_prepare_beacon(sc, vap);
766
767		if (vap->iv_opmode != IEEE80211_M_MONITOR)
768			rum_enable_tsf_sync(sc);
769
770		/* enable automatic rate adaptation */
771		tp = &vap->iv_txparms[ieee80211_chan2mode(ic->ic_bsschan)];
772		if (tp->ucastrate == IEEE80211_FIXED_RATE_NONE)
773			rum_amrr_start(sc, ni);
774		break;
775	default:
776		break;
777	}
778
779	RUM_UNLOCK(sc);
780	IEEE80211_LOCK(ic);
781	rvp->newstate(vap, sc->sc_state, sc->sc_arg);
782	if (vap->iv_newstate_cb != NULL)
783		vap->iv_newstate_cb(vap, sc->sc_state, sc->sc_arg);
784	IEEE80211_UNLOCK(ic);
785	RUM_LOCK(sc);
786}
787
788static int
789rum_newstate(struct ieee80211vap *vap, enum ieee80211_state nstate, int arg)
790{
791	struct rum_vap *rvp = RUM_VAP(vap);
792	struct ieee80211com *ic = vap->iv_ic;
793	struct rum_softc *sc = ic->ic_ifp->if_softc;
794
795	DPRINTF("%s -> %s\n",
796		ieee80211_state_name[vap->iv_state],
797		ieee80211_state_name[nstate]);
798
799	RUM_LOCK(sc);
800	usb2_callout_stop(&rvp->amrr_ch);
801
802	/* do it in a process context */
803	sc->sc_state = nstate;
804	sc->sc_arg = arg;
805	RUM_UNLOCK(sc);
806
807	if (nstate == IEEE80211_S_INIT) {
808		rvp->newstate(vap, nstate, arg);
809		return 0;
810	} else {
811		RUM_LOCK(sc);
812		rum_queue_command(sc, rum_task, &sc->sc_task[0].hdr,
813		    &sc->sc_task[1].hdr);
814		RUM_UNLOCK(sc);
815		return EINPROGRESS;
816	}
817}
818
819static void
820rum_bulk_write_callback(struct usb2_xfer *xfer)
821{
822	struct rum_softc *sc = xfer->priv_sc;
823	struct ifnet *ifp = sc->sc_ifp;
824	struct ieee80211com *ic = ifp->if_l2com;
825	struct ieee80211_channel *c = ic->ic_curchan;
826	struct rum_tx_data *data;
827	struct mbuf *m;
828	unsigned int len;
829
830	/* wakeup waiting command, if any */
831	if (sc->sc_last_task != NULL)
832		cv_signal(&sc->sc_cmd_cv);
833
834	switch (USB_GET_STATE(xfer)) {
835	case USB_ST_TRANSFERRED:
836		DPRINTFN(11, "transfer complete, %d bytes\n", xfer->actlen);
837
838		/* free resources */
839		data = xfer->priv_fifo;
840		rum_tx_free(data, 0);
841		xfer->priv_fifo = NULL;
842
843		ifp->if_opackets++;
844		ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
845
846		/* FALLTHROUGH */
847	case USB_ST_SETUP:
848tr_setup:
849		/* wait for command to complete, if any */
850		if (sc->sc_last_task != NULL)
851			break;
852
853		data = STAILQ_FIRST(&sc->tx_q);
854		if (data) {
855			STAILQ_REMOVE_HEAD(&sc->tx_q, next);
856			m = data->m;
857
858			if (m->m_pkthdr.len > (MCLBYTES + RT2573_TX_DESC_SIZE)) {
859				DPRINTFN(0, "data overflow, %u bytes\n",
860				    m->m_pkthdr.len);
861				m->m_pkthdr.len = (MCLBYTES + RT2573_TX_DESC_SIZE);
862			}
863			usb2_copy_in(xfer->frbuffers, 0, &data->desc,
864			    RT2573_TX_DESC_SIZE);
865			usb2_m_copy_in(xfer->frbuffers, RT2573_TX_DESC_SIZE, m,
866			    0, m->m_pkthdr.len);
867
868			if (bpf_peers_present(ifp->if_bpf)) {
869				struct rum_tx_radiotap_header *tap = &sc->sc_txtap;
870
871				tap->wt_flags = 0;
872				tap->wt_rate = data->rate;
873				tap->wt_chan_freq = htole16(c->ic_freq);
874				tap->wt_chan_flags = htole16(c->ic_flags);
875				tap->wt_antenna = sc->tx_ant;
876
877				bpf_mtap2(ifp->if_bpf, tap, sc->sc_txtap_len, m);
878			}
879
880			/* align end on a 4-bytes boundary */
881			len = (RT2573_TX_DESC_SIZE + m->m_pkthdr.len + 3) & ~3;
882			if ((len % 64) == 0)
883				len += 4;
884
885			DPRINTFN(11, "sending frame len=%u xferlen=%u\n",
886			    m->m_pkthdr.len, len);
887
888			xfer->frlengths[0] = len;
889			xfer->priv_fifo = data;
890
891			usb2_start_hardware(xfer);
892		}
893		break;
894
895	default:			/* Error */
896		DPRINTFN(11, "transfer error, %s\n",
897		    usb2_errstr(xfer->error));
898
899		ifp->if_oerrors++;
900		data = xfer->priv_fifo;
901		if (data != NULL) {
902			rum_tx_free(data, xfer->error);
903			xfer->priv_fifo = NULL;
904		}
905
906		if (xfer->error == USB_ERR_STALLED) {
907			/* try to clear stall first */
908			xfer->flags.stall_pipe = 1;
909			goto tr_setup;
910		}
911		if (xfer->error == USB_ERR_TIMEOUT)
912			device_printf(sc->sc_dev, "device timeout\n");
913		break;
914	}
915}
916
917static void
918rum_bulk_read_callback(struct usb2_xfer *xfer)
919{
920	struct rum_softc *sc = xfer->priv_sc;
921	struct ifnet *ifp = sc->sc_ifp;
922	struct ieee80211com *ic = ifp->if_l2com;
923	struct ieee80211_node *ni;
924	struct mbuf *m = NULL;
925	uint32_t flags;
926	uint8_t rssi = 0;
927	unsigned int len;
928
929	switch (USB_GET_STATE(xfer)) {
930	case USB_ST_TRANSFERRED:
931
932		DPRINTFN(15, "rx done, actlen=%d\n", xfer->actlen);
933
934		len = xfer->actlen;
935		if (len < RT2573_RX_DESC_SIZE + IEEE80211_MIN_LEN) {
936			DPRINTF("%s: xfer too short %d\n",
937			    device_get_nameunit(sc->sc_dev), len);
938			ifp->if_ierrors++;
939			goto tr_setup;
940		}
941
942		len -= RT2573_RX_DESC_SIZE;
943		usb2_copy_out(xfer->frbuffers, 0, &sc->sc_rx_desc,
944		    RT2573_RX_DESC_SIZE);
945
946		rssi = rum_get_rssi(sc, sc->sc_rx_desc.rssi);
947		flags = le32toh(sc->sc_rx_desc.flags);
948		if (flags & RT2573_RX_CRC_ERROR) {
949			/*
950		         * This should not happen since we did not
951		         * request to receive those frames when we
952		         * filled RUM_TXRX_CSR2:
953		         */
954			DPRINTFN(5, "PHY or CRC error\n");
955			ifp->if_ierrors++;
956			goto tr_setup;
957		}
958
959		m = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
960		if (m == NULL) {
961			DPRINTF("could not allocate mbuf\n");
962			ifp->if_ierrors++;
963			goto tr_setup;
964		}
965		usb2_copy_out(xfer->frbuffers, RT2573_RX_DESC_SIZE,
966		    mtod(m, uint8_t *), len);
967
968		/* finalize mbuf */
969		m->m_pkthdr.rcvif = ifp;
970		m->m_pkthdr.len = m->m_len = (flags >> 16) & 0xfff;
971
972		if (bpf_peers_present(ifp->if_bpf)) {
973			struct rum_rx_radiotap_header *tap = &sc->sc_rxtap;
974
975			tap->wr_flags = IEEE80211_RADIOTAP_F_FCS;
976			tap->wr_rate = ieee80211_plcp2rate(sc->sc_rx_desc.rate,
977			    (flags & RT2573_RX_OFDM) ?
978			    IEEE80211_T_OFDM : IEEE80211_T_CCK);
979			tap->wr_chan_freq = htole16(ic->ic_curchan->ic_freq);
980			tap->wr_chan_flags = htole16(ic->ic_curchan->ic_flags);
981			tap->wr_antenna = sc->rx_ant;
982			tap->wr_antsignal = rssi;
983
984			bpf_mtap2(ifp->if_bpf, tap, sc->sc_rxtap_len, m);
985		}
986		/* FALLTHROUGH */
987	case USB_ST_SETUP:
988tr_setup:
989		xfer->frlengths[0] = xfer->max_data_length;
990		usb2_start_hardware(xfer);
991
992		/*
993		 * At the end of a USB callback it is always safe to unlock
994		 * the private mutex of a device! That is why we do the
995		 * "ieee80211_input" here, and not some lines up!
996		 */
997		if (m) {
998			RUM_UNLOCK(sc);
999			ni = ieee80211_find_rxnode(ic,
1000			    mtod(m, struct ieee80211_frame_min *));
1001			if (ni != NULL) {
1002				(void) ieee80211_input(ni, m, rssi,
1003				    RT2573_NOISE_FLOOR, 0);
1004				ieee80211_free_node(ni);
1005			} else
1006				(void) ieee80211_input_all(ic, m, rssi,
1007				    RT2573_NOISE_FLOOR, 0);
1008			RUM_LOCK(sc);
1009		}
1010		return;
1011
1012	default:			/* Error */
1013		if (xfer->error != USB_ERR_CANCELLED) {
1014			/* try to clear stall first */
1015			xfer->flags.stall_pipe = 1;
1016			goto tr_setup;
1017		}
1018		return;
1019	}
1020}
1021
1022static uint8_t
1023rum_plcp_signal(int rate)
1024{
1025	switch (rate) {
1026	/* OFDM rates (cf IEEE Std 802.11a-1999, pp. 14 Table 80) */
1027	case 12:	return 0xb;
1028	case 18:	return 0xf;
1029	case 24:	return 0xa;
1030	case 36:	return 0xe;
1031	case 48:	return 0x9;
1032	case 72:	return 0xd;
1033	case 96:	return 0x8;
1034	case 108:	return 0xc;
1035
1036	/* CCK rates (NB: not IEEE std, device-specific) */
1037	case 2:		return 0x0;
1038	case 4:		return 0x1;
1039	case 11:	return 0x2;
1040	case 22:	return 0x3;
1041	}
1042	return 0xff;		/* XXX unsupported/unknown rate */
1043}
1044
1045static void
1046rum_setup_tx_desc(struct rum_softc *sc, struct rum_tx_desc *desc,
1047    uint32_t flags, uint16_t xflags, int len, int rate)
1048{
1049	struct ifnet *ifp = sc->sc_ifp;
1050	struct ieee80211com *ic = ifp->if_l2com;
1051	uint16_t plcp_length;
1052	int remainder;
1053
1054	desc->flags = htole32(flags);
1055	desc->flags |= htole32(RT2573_TX_VALID);
1056	desc->flags |= htole32(len << 16);
1057
1058	desc->xflags = htole16(xflags);
1059
1060	desc->wme = htole16(RT2573_QID(0) | RT2573_AIFSN(2) |
1061	    RT2573_LOGCWMIN(4) | RT2573_LOGCWMAX(10));
1062
1063	/* setup PLCP fields */
1064	desc->plcp_signal  = rum_plcp_signal(rate);
1065	desc->plcp_service = 4;
1066
1067	len += IEEE80211_CRC_LEN;
1068	if (ieee80211_rate2phytype(ic->ic_rt, rate) == IEEE80211_T_OFDM) {
1069		desc->flags |= htole32(RT2573_TX_OFDM);
1070
1071		plcp_length = len & 0xfff;
1072		desc->plcp_length_hi = plcp_length >> 6;
1073		desc->plcp_length_lo = plcp_length & 0x3f;
1074	} else {
1075		plcp_length = (16 * len + rate - 1) / rate;
1076		if (rate == 22) {
1077			remainder = (16 * len) % 22;
1078			if (remainder != 0 && remainder < 7)
1079				desc->plcp_service |= RT2573_PLCP_LENGEXT;
1080		}
1081		desc->plcp_length_hi = plcp_length >> 8;
1082		desc->plcp_length_lo = plcp_length & 0xff;
1083
1084		if (rate != 2 && (ic->ic_flags & IEEE80211_F_SHPREAMBLE))
1085			desc->plcp_signal |= 0x08;
1086	}
1087}
1088
1089static int
1090rum_sendprot(struct rum_softc *sc,
1091    const struct mbuf *m, struct ieee80211_node *ni, int prot, int rate)
1092{
1093	struct ieee80211com *ic = ni->ni_ic;
1094	const struct ieee80211_frame *wh;
1095	struct rum_tx_data *data;
1096	struct mbuf *mprot;
1097	int protrate, ackrate, pktlen, flags, isshort;
1098	uint16_t dur;
1099
1100	RUM_LOCK_ASSERT(sc, MA_OWNED);
1101	KASSERT(prot == IEEE80211_PROT_RTSCTS || prot == IEEE80211_PROT_CTSONLY,
1102	    ("protection %d", prot));
1103
1104	wh = mtod(m, const struct ieee80211_frame *);
1105	pktlen = m->m_pkthdr.len + IEEE80211_CRC_LEN;
1106
1107	protrate = ieee80211_ctl_rate(ic->ic_rt, rate);
1108	ackrate = ieee80211_ack_rate(ic->ic_rt, rate);
1109
1110	isshort = (ic->ic_flags & IEEE80211_F_SHPREAMBLE) != 0;
1111	dur = ieee80211_compute_duration(ic->ic_rt, pktlen, rate, isshort);
1112	    + ieee80211_ack_duration(ic->ic_rt, rate, isshort);
1113	flags = RT2573_TX_MORE_FRAG;
1114	if (prot == IEEE80211_PROT_RTSCTS) {
1115		/* NB: CTS is the same size as an ACK */
1116		dur += ieee80211_ack_duration(ic->ic_rt, rate, isshort);
1117		flags |= RT2573_TX_NEED_ACK;
1118		mprot = ieee80211_alloc_rts(ic, wh->i_addr1, wh->i_addr2, dur);
1119	} else {
1120		mprot = ieee80211_alloc_cts(ic, ni->ni_vap->iv_myaddr, dur);
1121	}
1122	if (mprot == NULL) {
1123		/* XXX stat + msg */
1124		return (ENOBUFS);
1125	}
1126	data = STAILQ_FIRST(&sc->tx_free);
1127	STAILQ_REMOVE_HEAD(&sc->tx_free, next);
1128	sc->tx_nfree--;
1129
1130	data->m = mprot;
1131	data->ni = ieee80211_ref_node(ni);
1132	data->rate = protrate;
1133	rum_setup_tx_desc(sc, &data->desc, flags, 0, mprot->m_pkthdr.len, protrate);
1134
1135	STAILQ_INSERT_TAIL(&sc->tx_q, data, next);
1136	usb2_transfer_start(sc->sc_xfer[RUM_BULK_WR]);
1137
1138	return 0;
1139}
1140
1141static int
1142rum_tx_mgt(struct rum_softc *sc, struct mbuf *m0, struct ieee80211_node *ni)
1143{
1144	struct ieee80211vap *vap = ni->ni_vap;
1145	struct ifnet *ifp = sc->sc_ifp;
1146	struct ieee80211com *ic = ifp->if_l2com;
1147	struct rum_tx_data *data;
1148	struct ieee80211_frame *wh;
1149	const struct ieee80211_txparam *tp;
1150	struct ieee80211_key *k;
1151	uint32_t flags = 0;
1152	uint16_t dur;
1153
1154	RUM_LOCK_ASSERT(sc, MA_OWNED);
1155
1156	data = STAILQ_FIRST(&sc->tx_free);
1157	STAILQ_REMOVE_HEAD(&sc->tx_free, next);
1158	sc->tx_nfree--;
1159
1160	wh = mtod(m0, struct ieee80211_frame *);
1161	if (wh->i_fc[1] & IEEE80211_FC1_WEP) {
1162		k = ieee80211_crypto_encap(ni, m0);
1163		if (k == NULL) {
1164			m_freem(m0);
1165			return ENOBUFS;
1166		}
1167		wh = mtod(m0, struct ieee80211_frame *);
1168	}
1169
1170	tp = &vap->iv_txparms[ieee80211_chan2mode(ic->ic_curchan)];
1171
1172	if (!IEEE80211_IS_MULTICAST(wh->i_addr1)) {
1173		flags |= RT2573_TX_NEED_ACK;
1174
1175		dur = ieee80211_ack_duration(ic->ic_rt, tp->mgmtrate,
1176		    ic->ic_flags & IEEE80211_F_SHPREAMBLE);
1177		*(uint16_t *)wh->i_dur = htole16(dur);
1178
1179		/* tell hardware to add timestamp for probe responses */
1180		if ((wh->i_fc[0] &
1181		    (IEEE80211_FC0_TYPE_MASK | IEEE80211_FC0_SUBTYPE_MASK)) ==
1182		    (IEEE80211_FC0_TYPE_MGT | IEEE80211_FC0_SUBTYPE_PROBE_RESP))
1183			flags |= RT2573_TX_TIMESTAMP;
1184	}
1185
1186	data->m = m0;
1187	data->ni = ni;
1188	data->rate = tp->mgmtrate;
1189
1190	rum_setup_tx_desc(sc, &data->desc, flags, 0, m0->m_pkthdr.len, tp->mgmtrate);
1191
1192	DPRINTFN(10, "sending mgt frame len=%d rate=%d\n",
1193	    m0->m_pkthdr.len + (int)RT2573_TX_DESC_SIZE, tp->mgmtrate);
1194
1195	STAILQ_INSERT_TAIL(&sc->tx_q, data, next);
1196	usb2_transfer_start(sc->sc_xfer[RUM_BULK_WR]);
1197
1198	return (0);
1199}
1200
1201static int
1202rum_tx_raw(struct rum_softc *sc, struct mbuf *m0, struct ieee80211_node *ni,
1203    const struct ieee80211_bpf_params *params)
1204{
1205	struct rum_tx_data *data;
1206	uint32_t flags;
1207	int rate, error;
1208
1209	RUM_LOCK_ASSERT(sc, MA_OWNED);
1210	KASSERT(params != NULL, ("no raw xmit params"));
1211
1212	rate = params->ibp_rate0 & IEEE80211_RATE_VAL;
1213	/* XXX validate */
1214	if (rate == 0) {
1215		m_freem(m0);
1216		return EINVAL;
1217	}
1218	flags = 0;
1219	if ((params->ibp_flags & IEEE80211_BPF_NOACK) == 0)
1220		flags |= RT2573_TX_NEED_ACK;
1221	if (params->ibp_flags & (IEEE80211_BPF_RTS|IEEE80211_BPF_CTS)) {
1222		error = rum_sendprot(sc, m0, ni,
1223		    params->ibp_flags & IEEE80211_BPF_RTS ?
1224			 IEEE80211_PROT_RTSCTS : IEEE80211_PROT_CTSONLY,
1225		    rate);
1226		if (error || sc->tx_nfree == 0) {
1227			m_freem(m0);
1228			return ENOBUFS;
1229		}
1230		flags |= RT2573_TX_LONG_RETRY | RT2573_TX_IFS_SIFS;
1231	}
1232
1233	data = STAILQ_FIRST(&sc->tx_free);
1234	STAILQ_REMOVE_HEAD(&sc->tx_free, next);
1235	sc->tx_nfree--;
1236
1237	data->m = m0;
1238	data->ni = ni;
1239	data->rate = rate;
1240
1241	/* XXX need to setup descriptor ourself */
1242	rum_setup_tx_desc(sc, &data->desc, flags, 0, m0->m_pkthdr.len, rate);
1243
1244	DPRINTFN(10, "sending raw frame len=%u rate=%u\n",
1245	    m0->m_pkthdr.len, rate);
1246
1247	STAILQ_INSERT_TAIL(&sc->tx_q, data, next);
1248	usb2_transfer_start(sc->sc_xfer[RUM_BULK_WR]);
1249
1250	return 0;
1251}
1252
1253static int
1254rum_tx_data(struct rum_softc *sc, struct mbuf *m0, struct ieee80211_node *ni)
1255{
1256	struct ieee80211vap *vap = ni->ni_vap;
1257	struct ifnet *ifp = sc->sc_ifp;
1258	struct ieee80211com *ic = ifp->if_l2com;
1259	struct rum_tx_data *data;
1260	struct ieee80211_frame *wh;
1261	const struct ieee80211_txparam *tp;
1262	struct ieee80211_key *k;
1263	uint32_t flags = 0;
1264	uint16_t dur;
1265	int error, rate;
1266
1267	RUM_LOCK_ASSERT(sc, MA_OWNED);
1268
1269	wh = mtod(m0, struct ieee80211_frame *);
1270
1271	tp = &vap->iv_txparms[ieee80211_chan2mode(ni->ni_chan)];
1272	if (IEEE80211_IS_MULTICAST(wh->i_addr1))
1273		rate = tp->mcastrate;
1274	else if (tp->ucastrate != IEEE80211_FIXED_RATE_NONE)
1275		rate = tp->ucastrate;
1276	else
1277		rate = ni->ni_txrate;
1278
1279	if (wh->i_fc[1] & IEEE80211_FC1_WEP) {
1280		k = ieee80211_crypto_encap(ni, m0);
1281		if (k == NULL) {
1282			m_freem(m0);
1283			return ENOBUFS;
1284		}
1285
1286		/* packet header may have moved, reset our local pointer */
1287		wh = mtod(m0, struct ieee80211_frame *);
1288	}
1289
1290	if (!IEEE80211_IS_MULTICAST(wh->i_addr1)) {
1291		int prot = IEEE80211_PROT_NONE;
1292		if (m0->m_pkthdr.len + IEEE80211_CRC_LEN > vap->iv_rtsthreshold)
1293			prot = IEEE80211_PROT_RTSCTS;
1294		else if ((ic->ic_flags & IEEE80211_F_USEPROT) &&
1295		    ieee80211_rate2phytype(ic->ic_rt, rate) == IEEE80211_T_OFDM)
1296			prot = ic->ic_protmode;
1297		if (prot != IEEE80211_PROT_NONE) {
1298			error = rum_sendprot(sc, m0, ni, prot, rate);
1299			if (error || sc->tx_nfree == 0) {
1300				m_freem(m0);
1301				return ENOBUFS;
1302			}
1303			flags |= RT2573_TX_LONG_RETRY | RT2573_TX_IFS_SIFS;
1304		}
1305	}
1306
1307	data = STAILQ_FIRST(&sc->tx_free);
1308	STAILQ_REMOVE_HEAD(&sc->tx_free, next);
1309	sc->tx_nfree--;
1310
1311	data->m = m0;
1312	data->ni = ni;
1313	data->rate = rate;
1314
1315	if (!IEEE80211_IS_MULTICAST(wh->i_addr1)) {
1316		flags |= RT2573_TX_NEED_ACK;
1317		flags |= RT2573_TX_MORE_FRAG;
1318
1319		dur = ieee80211_ack_duration(ic->ic_rt, rate,
1320		    ic->ic_flags & IEEE80211_F_SHPREAMBLE);
1321		*(uint16_t *)wh->i_dur = htole16(dur);
1322	}
1323
1324	rum_setup_tx_desc(sc, &data->desc, flags, 0, m0->m_pkthdr.len, rate);
1325
1326	DPRINTFN(10, "sending frame len=%d rate=%d\n",
1327	    m0->m_pkthdr.len + (int)RT2573_TX_DESC_SIZE, rate);
1328
1329	STAILQ_INSERT_TAIL(&sc->tx_q, data, next);
1330	usb2_transfer_start(sc->sc_xfer[RUM_BULK_WR]);
1331
1332	return 0;
1333}
1334
1335static void
1336rum_start(struct ifnet *ifp)
1337{
1338	struct rum_softc *sc = ifp->if_softc;
1339	struct ieee80211_node *ni;
1340	struct mbuf *m;
1341
1342	RUM_LOCK(sc);
1343	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
1344		RUM_UNLOCK(sc);
1345		return;
1346	}
1347	for (;;) {
1348		IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
1349		if (m == NULL)
1350			break;
1351		if (sc->tx_nfree < RUM_TX_MINFREE) {
1352			IFQ_DRV_PREPEND(&ifp->if_snd, m);
1353			ifp->if_drv_flags |= IFF_DRV_OACTIVE;
1354			break;
1355		}
1356		ni = (struct ieee80211_node *) m->m_pkthdr.rcvif;
1357		m = ieee80211_encap(ni, m);
1358		if (m == NULL) {
1359			ieee80211_free_node(ni);
1360			ifp->if_oerrors++;
1361			continue;
1362		}
1363		if (rum_tx_data(sc, m, ni) != 0) {
1364			ieee80211_free_node(ni);
1365			ifp->if_oerrors++;
1366			break;
1367		}
1368	}
1369	RUM_UNLOCK(sc);
1370}
1371
1372static int
1373rum_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
1374{
1375	struct rum_softc *sc = ifp->if_softc;
1376	struct ieee80211com *ic = ifp->if_l2com;
1377	struct ifreq *ifr = (struct ifreq *) data;
1378	int error = 0, startall = 0;
1379
1380	switch (cmd) {
1381	case SIOCSIFFLAGS:
1382		RUM_LOCK(sc);
1383		if (ifp->if_flags & IFF_UP) {
1384			if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
1385				rum_queue_command(sc, rum_init_task,
1386				    &sc->sc_synctask[0].hdr,
1387				    &sc->sc_synctask[1].hdr);
1388				startall = 1;
1389			} else
1390				rum_queue_command(sc, rum_promisctask,
1391				    &sc->sc_promisctask[0].hdr,
1392				    &sc->sc_promisctask[1].hdr);
1393		} else {
1394			if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
1395				rum_queue_command(sc, rum_stop_task,
1396				    &sc->sc_synctask[0].hdr,
1397				    &sc->sc_synctask[1].hdr);
1398			}
1399		}
1400		RUM_UNLOCK(sc);
1401		if (startall)
1402			ieee80211_start_all(ic);
1403		break;
1404	case SIOCGIFMEDIA:
1405		error = ifmedia_ioctl(ifp, ifr, &ic->ic_media, cmd);
1406		break;
1407	case SIOCGIFADDR:
1408		error = ether_ioctl(ifp, cmd, data);
1409		break;
1410	default:
1411		error = EINVAL;
1412		break;
1413	}
1414	return error;
1415}
1416
1417static void
1418rum_eeprom_read(struct rum_softc *sc, uint16_t addr, void *buf, int len)
1419{
1420	struct usb2_device_request req;
1421	usb2_error_t error;
1422
1423	req.bmRequestType = UT_READ_VENDOR_DEVICE;
1424	req.bRequest = RT2573_READ_EEPROM;
1425	USETW(req.wValue, 0);
1426	USETW(req.wIndex, addr);
1427	USETW(req.wLength, len);
1428
1429	error = rum_do_request(sc, &req, buf);
1430	if (error != 0) {
1431		device_printf(sc->sc_dev, "could not read EEPROM: %s\n",
1432		    usb2_errstr(error));
1433	}
1434}
1435
1436static uint32_t
1437rum_read(struct rum_softc *sc, uint16_t reg)
1438{
1439	uint32_t val;
1440
1441	rum_read_multi(sc, reg, &val, sizeof val);
1442
1443	return le32toh(val);
1444}
1445
1446static void
1447rum_read_multi(struct rum_softc *sc, uint16_t reg, void *buf, int len)
1448{
1449	struct usb2_device_request req;
1450	usb2_error_t error;
1451
1452	req.bmRequestType = UT_READ_VENDOR_DEVICE;
1453	req.bRequest = RT2573_READ_MULTI_MAC;
1454	USETW(req.wValue, 0);
1455	USETW(req.wIndex, reg);
1456	USETW(req.wLength, len);
1457
1458	error = rum_do_request(sc, &req, buf);
1459	if (error != 0) {
1460		device_printf(sc->sc_dev,
1461		    "could not multi read MAC register: %s\n",
1462		    usb2_errstr(error));
1463	}
1464}
1465
1466static usb2_error_t
1467rum_write(struct rum_softc *sc, uint16_t reg, uint32_t val)
1468{
1469	uint32_t tmp = htole32(val);
1470
1471	return (rum_write_multi(sc, reg, &tmp, sizeof tmp));
1472}
1473
1474static usb2_error_t
1475rum_write_multi(struct rum_softc *sc, uint16_t reg, void *buf, size_t len)
1476{
1477	struct usb2_device_request req;
1478	usb2_error_t error;
1479
1480	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1481	req.bRequest = RT2573_WRITE_MULTI_MAC;
1482	USETW(req.wValue, 0);
1483	USETW(req.wIndex, reg);
1484	USETW(req.wLength, len);
1485
1486	error = rum_do_request(sc, &req, buf);
1487	if (error != 0) {
1488		device_printf(sc->sc_dev,
1489		    "could not multi write MAC register: %s\n",
1490		    usb2_errstr(error));
1491	}
1492	return (error);
1493}
1494
1495static void
1496rum_bbp_write(struct rum_softc *sc, uint8_t reg, uint8_t val)
1497{
1498	uint32_t tmp;
1499	int ntries;
1500
1501	DPRINTFN(2, "reg=0x%08x\n", reg);
1502
1503	for (ntries = 0; ntries < 100; ntries++) {
1504		if (!(rum_read(sc, RT2573_PHY_CSR3) & RT2573_BBP_BUSY))
1505			break;
1506		if (rum_pause(sc, hz / 100))
1507			break;
1508	}
1509	if (ntries == 100) {
1510		device_printf(sc->sc_dev, "could not write to BBP\n");
1511		return;
1512	}
1513
1514	tmp = RT2573_BBP_BUSY | (reg & 0x7f) << 8 | val;
1515	rum_write(sc, RT2573_PHY_CSR3, tmp);
1516}
1517
1518static uint8_t
1519rum_bbp_read(struct rum_softc *sc, uint8_t reg)
1520{
1521	uint32_t val;
1522	int ntries;
1523
1524	DPRINTFN(2, "reg=0x%08x\n", reg);
1525
1526	for (ntries = 0; ntries < 100; ntries++) {
1527		if (!(rum_read(sc, RT2573_PHY_CSR3) & RT2573_BBP_BUSY))
1528			break;
1529		if (rum_pause(sc, hz / 100))
1530			break;
1531	}
1532	if (ntries == 100) {
1533		device_printf(sc->sc_dev, "could not read BBP\n");
1534		return 0;
1535	}
1536
1537	val = RT2573_BBP_BUSY | RT2573_BBP_READ | reg << 8;
1538	rum_write(sc, RT2573_PHY_CSR3, val);
1539
1540	for (ntries = 0; ntries < 100; ntries++) {
1541		val = rum_read(sc, RT2573_PHY_CSR3);
1542		if (!(val & RT2573_BBP_BUSY))
1543			return val & 0xff;
1544		if (rum_pause(sc, hz / 100))
1545			break;
1546	}
1547
1548	device_printf(sc->sc_dev, "could not read BBP\n");
1549	return 0;
1550}
1551
1552static void
1553rum_rf_write(struct rum_softc *sc, uint8_t reg, uint32_t val)
1554{
1555	uint32_t tmp;
1556	int ntries;
1557
1558	for (ntries = 0; ntries < 100; ntries++) {
1559		if (!(rum_read(sc, RT2573_PHY_CSR4) & RT2573_RF_BUSY))
1560			break;
1561		if (rum_pause(sc, hz / 100))
1562			break;
1563	}
1564	if (ntries == 100) {
1565		device_printf(sc->sc_dev, "could not write to RF\n");
1566		return;
1567	}
1568
1569	tmp = RT2573_RF_BUSY | RT2573_RF_20BIT | (val & 0xfffff) << 2 |
1570	    (reg & 3);
1571	rum_write(sc, RT2573_PHY_CSR4, tmp);
1572
1573	/* remember last written value in sc */
1574	sc->rf_regs[reg] = val;
1575
1576	DPRINTFN(15, "RF R[%u] <- 0x%05x\n", reg & 3, val & 0xfffff);
1577}
1578
1579static void
1580rum_select_antenna(struct rum_softc *sc)
1581{
1582	uint8_t bbp4, bbp77;
1583	uint32_t tmp;
1584
1585	bbp4  = rum_bbp_read(sc, 4);
1586	bbp77 = rum_bbp_read(sc, 77);
1587
1588	/* TBD */
1589
1590	/* make sure Rx is disabled before switching antenna */
1591	tmp = rum_read(sc, RT2573_TXRX_CSR0);
1592	rum_write(sc, RT2573_TXRX_CSR0, tmp | RT2573_DISABLE_RX);
1593
1594	rum_bbp_write(sc,  4, bbp4);
1595	rum_bbp_write(sc, 77, bbp77);
1596
1597	rum_write(sc, RT2573_TXRX_CSR0, tmp);
1598}
1599
1600/*
1601 * Enable multi-rate retries for frames sent at OFDM rates.
1602 * In 802.11b/g mode, allow fallback to CCK rates.
1603 */
1604static void
1605rum_enable_mrr(struct rum_softc *sc)
1606{
1607	struct ifnet *ifp = sc->sc_ifp;
1608	struct ieee80211com *ic = ifp->if_l2com;
1609	uint32_t tmp;
1610
1611	tmp = rum_read(sc, RT2573_TXRX_CSR4);
1612
1613	tmp &= ~RT2573_MRR_CCK_FALLBACK;
1614	if (!IEEE80211_IS_CHAN_5GHZ(ic->ic_bsschan))
1615		tmp |= RT2573_MRR_CCK_FALLBACK;
1616	tmp |= RT2573_MRR_ENABLED;
1617
1618	rum_write(sc, RT2573_TXRX_CSR4, tmp);
1619}
1620
1621static void
1622rum_set_txpreamble(struct rum_softc *sc)
1623{
1624	struct ifnet *ifp = sc->sc_ifp;
1625	struct ieee80211com *ic = ifp->if_l2com;
1626	uint32_t tmp;
1627
1628	tmp = rum_read(sc, RT2573_TXRX_CSR4);
1629
1630	tmp &= ~RT2573_SHORT_PREAMBLE;
1631	if (ic->ic_flags & IEEE80211_F_SHPREAMBLE)
1632		tmp |= RT2573_SHORT_PREAMBLE;
1633
1634	rum_write(sc, RT2573_TXRX_CSR4, tmp);
1635}
1636
1637static void
1638rum_set_basicrates(struct rum_softc *sc)
1639{
1640	struct ifnet *ifp = sc->sc_ifp;
1641	struct ieee80211com *ic = ifp->if_l2com;
1642
1643	/* update basic rate set */
1644	if (ic->ic_curmode == IEEE80211_MODE_11B) {
1645		/* 11b basic rates: 1, 2Mbps */
1646		rum_write(sc, RT2573_TXRX_CSR5, 0x3);
1647	} else if (IEEE80211_IS_CHAN_5GHZ(ic->ic_bsschan)) {
1648		/* 11a basic rates: 6, 12, 24Mbps */
1649		rum_write(sc, RT2573_TXRX_CSR5, 0x150);
1650	} else {
1651		/* 11b/g basic rates: 1, 2, 5.5, 11Mbps */
1652		rum_write(sc, RT2573_TXRX_CSR5, 0xf);
1653	}
1654}
1655
1656/*
1657 * Reprogram MAC/BBP to switch to a new band.  Values taken from the reference
1658 * driver.
1659 */
1660static void
1661rum_select_band(struct rum_softc *sc, struct ieee80211_channel *c)
1662{
1663	uint8_t bbp17, bbp35, bbp96, bbp97, bbp98, bbp104;
1664	uint32_t tmp;
1665
1666	/* update all BBP registers that depend on the band */
1667	bbp17 = 0x20; bbp96 = 0x48; bbp104 = 0x2c;
1668	bbp35 = 0x50; bbp97 = 0x48; bbp98  = 0x48;
1669	if (IEEE80211_IS_CHAN_5GHZ(c)) {
1670		bbp17 += 0x08; bbp96 += 0x10; bbp104 += 0x0c;
1671		bbp35 += 0x10; bbp97 += 0x10; bbp98  += 0x10;
1672	}
1673	if ((IEEE80211_IS_CHAN_2GHZ(c) && sc->ext_2ghz_lna) ||
1674	    (IEEE80211_IS_CHAN_5GHZ(c) && sc->ext_5ghz_lna)) {
1675		bbp17 += 0x10; bbp96 += 0x10; bbp104 += 0x10;
1676	}
1677
1678	sc->bbp17 = bbp17;
1679	rum_bbp_write(sc,  17, bbp17);
1680	rum_bbp_write(sc,  96, bbp96);
1681	rum_bbp_write(sc, 104, bbp104);
1682
1683	if ((IEEE80211_IS_CHAN_2GHZ(c) && sc->ext_2ghz_lna) ||
1684	    (IEEE80211_IS_CHAN_5GHZ(c) && sc->ext_5ghz_lna)) {
1685		rum_bbp_write(sc, 75, 0x80);
1686		rum_bbp_write(sc, 86, 0x80);
1687		rum_bbp_write(sc, 88, 0x80);
1688	}
1689
1690	rum_bbp_write(sc, 35, bbp35);
1691	rum_bbp_write(sc, 97, bbp97);
1692	rum_bbp_write(sc, 98, bbp98);
1693
1694	tmp = rum_read(sc, RT2573_PHY_CSR0);
1695	tmp &= ~(RT2573_PA_PE_2GHZ | RT2573_PA_PE_5GHZ);
1696	if (IEEE80211_IS_CHAN_2GHZ(c))
1697		tmp |= RT2573_PA_PE_2GHZ;
1698	else
1699		tmp |= RT2573_PA_PE_5GHZ;
1700	rum_write(sc, RT2573_PHY_CSR0, tmp);
1701}
1702
1703static void
1704rum_set_chan(struct rum_softc *sc, struct ieee80211_channel *c)
1705{
1706	struct ifnet *ifp = sc->sc_ifp;
1707	struct ieee80211com *ic = ifp->if_l2com;
1708	const struct rfprog *rfprog;
1709	uint8_t bbp3, bbp94 = RT2573_BBPR94_DEFAULT;
1710	int8_t power;
1711	int i, chan;
1712
1713	chan = ieee80211_chan2ieee(ic, c);
1714	if (chan == 0 || chan == IEEE80211_CHAN_ANY)
1715		return;
1716
1717	/* select the appropriate RF settings based on what EEPROM says */
1718	rfprog = (sc->rf_rev == RT2573_RF_5225 ||
1719		  sc->rf_rev == RT2573_RF_2527) ? rum_rf5225 : rum_rf5226;
1720
1721	/* find the settings for this channel (we know it exists) */
1722	for (i = 0; rfprog[i].chan != chan; i++);
1723
1724	power = sc->txpow[i];
1725	if (power < 0) {
1726		bbp94 += power;
1727		power = 0;
1728	} else if (power > 31) {
1729		bbp94 += power - 31;
1730		power = 31;
1731	}
1732
1733	/*
1734	 * If we are switching from the 2GHz band to the 5GHz band or
1735	 * vice-versa, BBP registers need to be reprogrammed.
1736	 */
1737	if (c->ic_flags != ic->ic_curchan->ic_flags) {
1738		rum_select_band(sc, c);
1739		rum_select_antenna(sc);
1740	}
1741	ic->ic_curchan = c;
1742
1743	rum_rf_write(sc, RT2573_RF1, rfprog[i].r1);
1744	rum_rf_write(sc, RT2573_RF2, rfprog[i].r2);
1745	rum_rf_write(sc, RT2573_RF3, rfprog[i].r3 | power << 7);
1746	rum_rf_write(sc, RT2573_RF4, rfprog[i].r4 | sc->rffreq << 10);
1747
1748	rum_rf_write(sc, RT2573_RF1, rfprog[i].r1);
1749	rum_rf_write(sc, RT2573_RF2, rfprog[i].r2);
1750	rum_rf_write(sc, RT2573_RF3, rfprog[i].r3 | power << 7 | 1);
1751	rum_rf_write(sc, RT2573_RF4, rfprog[i].r4 | sc->rffreq << 10);
1752
1753	rum_rf_write(sc, RT2573_RF1, rfprog[i].r1);
1754	rum_rf_write(sc, RT2573_RF2, rfprog[i].r2);
1755	rum_rf_write(sc, RT2573_RF3, rfprog[i].r3 | power << 7);
1756	rum_rf_write(sc, RT2573_RF4, rfprog[i].r4 | sc->rffreq << 10);
1757
1758	rum_pause(sc, hz / 100);
1759
1760	/* enable smart mode for MIMO-capable RFs */
1761	bbp3 = rum_bbp_read(sc, 3);
1762
1763	bbp3 &= ~RT2573_SMART_MODE;
1764	if (sc->rf_rev == RT2573_RF_5225 || sc->rf_rev == RT2573_RF_2527)
1765		bbp3 |= RT2573_SMART_MODE;
1766
1767	rum_bbp_write(sc, 3, bbp3);
1768
1769	if (bbp94 != RT2573_BBPR94_DEFAULT)
1770		rum_bbp_write(sc, 94, bbp94);
1771
1772	/* give the chip some extra time to do the switchover */
1773	rum_pause(sc, hz / 100);
1774}
1775
1776/*
1777 * Enable TSF synchronization and tell h/w to start sending beacons for IBSS
1778 * and HostAP operating modes.
1779 */
1780static void
1781rum_enable_tsf_sync(struct rum_softc *sc)
1782{
1783	struct ifnet *ifp = sc->sc_ifp;
1784	struct ieee80211com *ic = ifp->if_l2com;
1785	struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
1786	uint32_t tmp;
1787
1788	if (vap->iv_opmode != IEEE80211_M_STA) {
1789		/*
1790		 * Change default 16ms TBTT adjustment to 8ms.
1791		 * Must be done before enabling beacon generation.
1792		 */
1793		rum_write(sc, RT2573_TXRX_CSR10, 1 << 12 | 8);
1794	}
1795
1796	tmp = rum_read(sc, RT2573_TXRX_CSR9) & 0xff000000;
1797
1798	/* set beacon interval (in 1/16ms unit) */
1799	tmp |= vap->iv_bss->ni_intval * 16;
1800
1801	tmp |= RT2573_TSF_TICKING | RT2573_ENABLE_TBTT;
1802	if (vap->iv_opmode == IEEE80211_M_STA)
1803		tmp |= RT2573_TSF_MODE(1);
1804	else
1805		tmp |= RT2573_TSF_MODE(2) | RT2573_GENERATE_BEACON;
1806
1807	rum_write(sc, RT2573_TXRX_CSR9, tmp);
1808}
1809
1810static void
1811rum_update_slot(struct ifnet *ifp)
1812{
1813	struct rum_softc *sc = ifp->if_softc;
1814	struct ieee80211com *ic = ifp->if_l2com;
1815	uint8_t slottime;
1816	uint32_t tmp;
1817
1818	slottime = (ic->ic_flags & IEEE80211_F_SHSLOT) ? 9 : 20;
1819
1820	tmp = rum_read(sc, RT2573_MAC_CSR9);
1821	tmp = (tmp & ~0xff) | slottime;
1822	rum_write(sc, RT2573_MAC_CSR9, tmp);
1823
1824	DPRINTF("setting slot time to %uus\n", slottime);
1825}
1826
1827static void
1828rum_set_bssid(struct rum_softc *sc, const uint8_t *bssid)
1829{
1830	uint32_t tmp;
1831
1832	tmp = bssid[0] | bssid[1] << 8 | bssid[2] << 16 | bssid[3] << 24;
1833	rum_write(sc, RT2573_MAC_CSR4, tmp);
1834
1835	tmp = bssid[4] | bssid[5] << 8 | RT2573_ONE_BSSID << 16;
1836	rum_write(sc, RT2573_MAC_CSR5, tmp);
1837}
1838
1839static void
1840rum_set_macaddr(struct rum_softc *sc, const uint8_t *addr)
1841{
1842	uint32_t tmp;
1843
1844	tmp = addr[0] | addr[1] << 8 | addr[2] << 16 | addr[3] << 24;
1845	rum_write(sc, RT2573_MAC_CSR2, tmp);
1846
1847	tmp = addr[4] | addr[5] << 8 | 0xff << 16;
1848	rum_write(sc, RT2573_MAC_CSR3, tmp);
1849}
1850
1851static void
1852rum_promisctask(struct usb2_proc_msg *pm)
1853{
1854	struct rum_task *task = (struct rum_task *)pm;
1855	struct rum_softc *sc = task->sc;
1856	struct ifnet *ifp = sc->sc_ifp;
1857	uint32_t tmp;
1858
1859	tmp = rum_read(sc, RT2573_TXRX_CSR0);
1860
1861	tmp &= ~RT2573_DROP_NOT_TO_ME;
1862	if (!(ifp->if_flags & IFF_PROMISC))
1863		tmp |= RT2573_DROP_NOT_TO_ME;
1864
1865	rum_write(sc, RT2573_TXRX_CSR0, tmp);
1866
1867	DPRINTF("%s promiscuous mode\n", (ifp->if_flags & IFF_PROMISC) ?
1868	    "entering" : "leaving");
1869}
1870
1871static void
1872rum_update_promisc(struct ifnet *ifp)
1873{
1874	struct rum_softc *sc = ifp->if_softc;
1875
1876	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
1877		return;
1878
1879	RUM_LOCK(sc);
1880	rum_queue_command(sc, rum_promisctask,
1881	    &sc->sc_promisctask[0].hdr,
1882	    &sc->sc_promisctask[1].hdr);
1883	RUM_UNLOCK(sc);
1884}
1885
1886static const char *
1887rum_get_rf(int rev)
1888{
1889	switch (rev) {
1890	case RT2573_RF_2527:	return "RT2527 (MIMO XR)";
1891	case RT2573_RF_2528:	return "RT2528";
1892	case RT2573_RF_5225:	return "RT5225 (MIMO XR)";
1893	case RT2573_RF_5226:	return "RT5226";
1894	default:		return "unknown";
1895	}
1896}
1897
1898static void
1899rum_read_eeprom(struct rum_softc *sc)
1900{
1901	uint16_t val;
1902#ifdef RUM_DEBUG
1903	int i;
1904#endif
1905
1906	/* read MAC address */
1907	rum_eeprom_read(sc, RT2573_EEPROM_ADDRESS, sc->sc_bssid, 6);
1908
1909	rum_eeprom_read(sc, RT2573_EEPROM_ANTENNA, &val, 2);
1910	val = le16toh(val);
1911	sc->rf_rev =   (val >> 11) & 0x1f;
1912	sc->hw_radio = (val >> 10) & 0x1;
1913	sc->rx_ant =   (val >> 4)  & 0x3;
1914	sc->tx_ant =   (val >> 2)  & 0x3;
1915	sc->nb_ant =   val & 0x3;
1916
1917	DPRINTF("RF revision=%d\n", sc->rf_rev);
1918
1919	rum_eeprom_read(sc, RT2573_EEPROM_CONFIG2, &val, 2);
1920	val = le16toh(val);
1921	sc->ext_5ghz_lna = (val >> 6) & 0x1;
1922	sc->ext_2ghz_lna = (val >> 4) & 0x1;
1923
1924	DPRINTF("External 2GHz LNA=%d\nExternal 5GHz LNA=%d\n",
1925	    sc->ext_2ghz_lna, sc->ext_5ghz_lna);
1926
1927	rum_eeprom_read(sc, RT2573_EEPROM_RSSI_2GHZ_OFFSET, &val, 2);
1928	val = le16toh(val);
1929	if ((val & 0xff) != 0xff)
1930		sc->rssi_2ghz_corr = (int8_t)(val & 0xff);	/* signed */
1931
1932	/* Only [-10, 10] is valid */
1933	if (sc->rssi_2ghz_corr < -10 || sc->rssi_2ghz_corr > 10)
1934		sc->rssi_2ghz_corr = 0;
1935
1936	rum_eeprom_read(sc, RT2573_EEPROM_RSSI_5GHZ_OFFSET, &val, 2);
1937	val = le16toh(val);
1938	if ((val & 0xff) != 0xff)
1939		sc->rssi_5ghz_corr = (int8_t)(val & 0xff);	/* signed */
1940
1941	/* Only [-10, 10] is valid */
1942	if (sc->rssi_5ghz_corr < -10 || sc->rssi_5ghz_corr > 10)
1943		sc->rssi_5ghz_corr = 0;
1944
1945	if (sc->ext_2ghz_lna)
1946		sc->rssi_2ghz_corr -= 14;
1947	if (sc->ext_5ghz_lna)
1948		sc->rssi_5ghz_corr -= 14;
1949
1950	DPRINTF("RSSI 2GHz corr=%d\nRSSI 5GHz corr=%d\n",
1951	    sc->rssi_2ghz_corr, sc->rssi_5ghz_corr);
1952
1953	rum_eeprom_read(sc, RT2573_EEPROM_FREQ_OFFSET, &val, 2);
1954	val = le16toh(val);
1955	if ((val & 0xff) != 0xff)
1956		sc->rffreq = val & 0xff;
1957
1958	DPRINTF("RF freq=%d\n", sc->rffreq);
1959
1960	/* read Tx power for all a/b/g channels */
1961	rum_eeprom_read(sc, RT2573_EEPROM_TXPOWER, sc->txpow, 14);
1962	/* XXX default Tx power for 802.11a channels */
1963	memset(sc->txpow + 14, 24, sizeof (sc->txpow) - 14);
1964#ifdef RUM_DEBUG
1965	for (i = 0; i < 14; i++)
1966		DPRINTF("Channel=%d Tx power=%d\n", i + 1,  sc->txpow[i]);
1967#endif
1968
1969	/* read default values for BBP registers */
1970	rum_eeprom_read(sc, RT2573_EEPROM_BBP_BASE, sc->bbp_prom, 2 * 16);
1971#ifdef RUM_DEBUG
1972	for (i = 0; i < 14; i++) {
1973		if (sc->bbp_prom[i].reg == 0 || sc->bbp_prom[i].reg == 0xff)
1974			continue;
1975		DPRINTF("BBP R%d=%02x\n", sc->bbp_prom[i].reg,
1976		    sc->bbp_prom[i].val);
1977	}
1978#endif
1979}
1980
1981static int
1982rum_bbp_init(struct rum_softc *sc)
1983{
1984#define N(a)	(sizeof (a) / sizeof ((a)[0]))
1985	int i, ntries;
1986
1987	/* wait for BBP to be ready */
1988	for (ntries = 0; ntries < 100; ntries++) {
1989		const uint8_t val = rum_bbp_read(sc, 0);
1990		if (val != 0 && val != 0xff)
1991			break;
1992		if (rum_pause(sc, hz / 100))
1993			break;
1994	}
1995	if (ntries == 100) {
1996		device_printf(sc->sc_dev, "timeout waiting for BBP\n");
1997		return EIO;
1998	}
1999
2000	/* initialize BBP registers to default values */
2001	for (i = 0; i < N(rum_def_bbp); i++)
2002		rum_bbp_write(sc, rum_def_bbp[i].reg, rum_def_bbp[i].val);
2003
2004	/* write vendor-specific BBP values (from EEPROM) */
2005	for (i = 0; i < 16; i++) {
2006		if (sc->bbp_prom[i].reg == 0 || sc->bbp_prom[i].reg == 0xff)
2007			continue;
2008		rum_bbp_write(sc, sc->bbp_prom[i].reg, sc->bbp_prom[i].val);
2009	}
2010
2011	return 0;
2012#undef N
2013}
2014
2015static void
2016rum_init_task(struct usb2_proc_msg *pm)
2017{
2018#define N(a)	(sizeof (a) / sizeof ((a)[0]))
2019	struct rum_task *task = (struct rum_task *)pm;
2020	struct rum_softc *sc = task->sc;
2021	struct ifnet *ifp = sc->sc_ifp;
2022	struct ieee80211com *ic = ifp->if_l2com;
2023	uint32_t tmp;
2024	usb2_error_t error;
2025	int i, ntries;
2026
2027	RUM_LOCK_ASSERT(sc, MA_OWNED);
2028
2029	rum_stop_task(pm);
2030
2031	/* initialize MAC registers to default values */
2032	for (i = 0; i < N(rum_def_mac); i++)
2033		rum_write(sc, rum_def_mac[i].reg, rum_def_mac[i].val);
2034
2035	/* set host ready */
2036	rum_write(sc, RT2573_MAC_CSR1, 3);
2037	rum_write(sc, RT2573_MAC_CSR1, 0);
2038
2039	/* wait for BBP/RF to wakeup */
2040	for (ntries = 0; ntries < 100; ntries++) {
2041		if (rum_read(sc, RT2573_MAC_CSR12) & 8)
2042			break;
2043		rum_write(sc, RT2573_MAC_CSR12, 4);	/* force wakeup */
2044		if (rum_pause(sc, hz / 100))
2045			break;
2046	}
2047	if (ntries == 100) {
2048		device_printf(sc->sc_dev,
2049		    "timeout waiting for BBP/RF to wakeup\n");
2050		goto fail;
2051	}
2052
2053	if ((error = rum_bbp_init(sc)) != 0)
2054		goto fail;
2055
2056	/* select default channel */
2057	rum_select_band(sc, ic->ic_curchan);
2058	rum_select_antenna(sc);
2059	rum_set_chan(sc, ic->ic_curchan);
2060
2061	/* clear STA registers */
2062	rum_read_multi(sc, RT2573_STA_CSR0, sc->sta, sizeof sc->sta);
2063
2064	rum_set_macaddr(sc, IF_LLADDR(ifp));
2065
2066	/* initialize ASIC */
2067	rum_write(sc, RT2573_MAC_CSR1, 4);
2068
2069	/*
2070	 * Allocate Tx and Rx xfer queues.
2071	 */
2072	rum_setup_tx_list(sc);
2073
2074	/* update Rx filter */
2075	tmp = rum_read(sc, RT2573_TXRX_CSR0) & 0xffff;
2076
2077	tmp |= RT2573_DROP_PHY_ERROR | RT2573_DROP_CRC_ERROR;
2078	if (ic->ic_opmode != IEEE80211_M_MONITOR) {
2079		tmp |= RT2573_DROP_CTL | RT2573_DROP_VER_ERROR |
2080		       RT2573_DROP_ACKCTS;
2081		if (ic->ic_opmode != IEEE80211_M_HOSTAP)
2082			tmp |= RT2573_DROP_TODS;
2083		if (!(ifp->if_flags & IFF_PROMISC))
2084			tmp |= RT2573_DROP_NOT_TO_ME;
2085	}
2086	rum_write(sc, RT2573_TXRX_CSR0, tmp);
2087
2088	ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
2089	ifp->if_drv_flags |= IFF_DRV_RUNNING;
2090	usb2_transfer_set_stall(sc->sc_xfer[RUM_BULK_WR]);
2091	usb2_transfer_start(sc->sc_xfer[RUM_BULK_RD]);
2092	return;
2093
2094fail:	rum_stop_task(pm);
2095#undef N
2096}
2097
2098static void
2099rum_init(void *priv)
2100{
2101	struct rum_softc *sc = priv;
2102	struct ifnet *ifp = sc->sc_ifp;
2103	struct ieee80211com *ic = ifp->if_l2com;
2104
2105	RUM_LOCK(sc);
2106	rum_queue_command(sc, rum_init_task,
2107	    &sc->sc_synctask[0].hdr,
2108	    &sc->sc_synctask[1].hdr);
2109	RUM_UNLOCK(sc);
2110
2111	if (ifp->if_drv_flags & IFF_DRV_RUNNING)
2112		ieee80211_start_all(ic);		/* start all vap's */
2113}
2114
2115static void
2116rum_stop_task(struct usb2_proc_msg *pm)
2117{
2118	struct rum_task *task = (struct rum_task *)pm;
2119	struct rum_softc *sc = task->sc;
2120	struct ifnet *ifp = sc->sc_ifp;
2121	uint32_t tmp;
2122
2123	RUM_LOCK_ASSERT(sc, MA_OWNED);
2124
2125	ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
2126
2127	RUM_UNLOCK(sc);
2128
2129	/*
2130	 * Drain the USB transfers, if not already drained:
2131	 */
2132	usb2_transfer_drain(sc->sc_xfer[RUM_BULK_WR]);
2133	usb2_transfer_drain(sc->sc_xfer[RUM_BULK_RD]);
2134
2135	RUM_LOCK(sc);
2136
2137	rum_unsetup_tx_list(sc);
2138
2139	/* disable Rx */
2140	tmp = rum_read(sc, RT2573_TXRX_CSR0);
2141	rum_write(sc, RT2573_TXRX_CSR0, tmp | RT2573_DISABLE_RX);
2142
2143	/* reset ASIC */
2144	rum_write(sc, RT2573_MAC_CSR1, 3);
2145	rum_write(sc, RT2573_MAC_CSR1, 0);
2146}
2147
2148static void
2149rum_load_microcode(struct rum_softc *sc, const uint8_t *ucode, size_t size)
2150{
2151	struct usb2_device_request req;
2152	uint16_t reg = RT2573_MCU_CODE_BASE;
2153	usb2_error_t err;
2154
2155	/* copy firmware image into NIC */
2156	for (; size >= 4; reg += 4, ucode += 4, size -= 4) {
2157		err = rum_write(sc, reg, UGETDW(ucode));
2158		if (err) {
2159			/* firmware already loaded ? */
2160			device_printf(sc->sc_dev, "Firmware load "
2161			    "failure! (ignored)\n");
2162			break;
2163		}
2164	}
2165
2166	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
2167	req.bRequest = RT2573_MCU_CNTL;
2168	USETW(req.wValue, RT2573_MCU_RUN);
2169	USETW(req.wIndex, 0);
2170	USETW(req.wLength, 0);
2171
2172	err = rum_do_request(sc, &req, NULL);
2173	if (err != 0) {
2174		device_printf(sc->sc_dev, "could not run firmware: %s\n",
2175		    usb2_errstr(err));
2176	}
2177
2178	/* give the chip some time to boot */
2179	rum_pause(sc, hz / 8);
2180}
2181
2182static int
2183rum_prepare_beacon(struct rum_softc *sc, struct ieee80211vap *vap)
2184{
2185	struct ieee80211com *ic = vap->iv_ic;
2186	const struct ieee80211_txparam *tp;
2187	struct rum_tx_desc desc;
2188	struct mbuf *m0;
2189
2190	m0 = ieee80211_beacon_alloc(vap->iv_bss, &RUM_VAP(vap)->bo);
2191	if (m0 == NULL) {
2192		return ENOBUFS;
2193	}
2194
2195	tp = &vap->iv_txparms[ieee80211_chan2mode(ic->ic_bsschan)];
2196	rum_setup_tx_desc(sc, &desc, RT2573_TX_TIMESTAMP, RT2573_TX_HWSEQ,
2197	    m0->m_pkthdr.len, tp->mgmtrate);
2198
2199	/* copy the first 24 bytes of Tx descriptor into NIC memory */
2200	rum_write_multi(sc, RT2573_HW_BEACON_BASE0, (uint8_t *)&desc, 24);
2201
2202	/* copy beacon header and payload into NIC memory */
2203	rum_write_multi(sc, RT2573_HW_BEACON_BASE0 + 24, mtod(m0, uint8_t *),
2204	    m0->m_pkthdr.len);
2205
2206	m_freem(m0);
2207
2208	return 0;
2209}
2210
2211static int
2212rum_raw_xmit(struct ieee80211_node *ni, struct mbuf *m,
2213    const struct ieee80211_bpf_params *params)
2214{
2215	struct ifnet *ifp = ni->ni_ic->ic_ifp;
2216	struct rum_softc *sc = ifp->if_softc;
2217
2218	RUM_LOCK(sc);
2219	/* prevent management frames from being sent if we're not ready */
2220	if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
2221		RUM_UNLOCK(sc);
2222		m_freem(m);
2223		ieee80211_free_node(ni);
2224		return ENETDOWN;
2225	}
2226	if (sc->tx_nfree < RUM_TX_MINFREE) {
2227		ifp->if_drv_flags |= IFF_DRV_OACTIVE;
2228		RUM_UNLOCK(sc);
2229		m_freem(m);
2230		ieee80211_free_node(ni);
2231		return EIO;
2232	}
2233
2234	ifp->if_opackets++;
2235
2236	if (params == NULL) {
2237		/*
2238		 * Legacy path; interpret frame contents to decide
2239		 * precisely how to send the frame.
2240		 */
2241		if (rum_tx_mgt(sc, m, ni) != 0)
2242			goto bad;
2243	} else {
2244		/*
2245		 * Caller supplied explicit parameters to use in
2246		 * sending the frame.
2247		 */
2248		if (rum_tx_raw(sc, m, ni, params) != 0)
2249			goto bad;
2250	}
2251	RUM_UNLOCK(sc);
2252
2253	return 0;
2254bad:
2255	ifp->if_oerrors++;
2256	RUM_UNLOCK(sc);
2257	ieee80211_free_node(ni);
2258	return EIO;
2259}
2260
2261static void
2262rum_amrr_start(struct rum_softc *sc, struct ieee80211_node *ni)
2263{
2264	struct ieee80211vap *vap = ni->ni_vap;
2265	struct rum_vap *rvp = RUM_VAP(vap);
2266
2267	/* clear statistic registers (STA_CSR0 to STA_CSR5) */
2268	rum_read_multi(sc, RT2573_STA_CSR0, sc->sta, sizeof sc->sta);
2269
2270	ieee80211_amrr_node_init(&rvp->amrr, &RUM_NODE(ni)->amn, ni);
2271
2272	usb2_callout_reset(&rvp->amrr_ch, hz, rum_amrr_timeout, rvp);
2273}
2274
2275static void
2276rum_amrr_timeout(void *arg)
2277{
2278	struct rum_vap *rvp = arg;
2279	struct rum_softc *sc = rvp->sc;
2280
2281	rum_queue_command(sc, rum_amrr_task,
2282	    &rvp->amrr_task[0].hdr, &rvp->amrr_task[1].hdr);
2283}
2284
2285static void
2286rum_amrr_task(struct usb2_proc_msg *pm)
2287{
2288	struct rum_task *task = (struct rum_task *)pm;
2289	struct rum_softc *sc = task->sc;
2290	struct ifnet *ifp = sc->sc_ifp;
2291	struct ieee80211com *ic = ifp->if_l2com;
2292	struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
2293	struct rum_vap *rvp = RUM_VAP(vap);
2294	struct ieee80211_node *ni = vap->iv_bss;
2295	int ok, fail;
2296
2297	/* read and clear statistic registers (STA_CSR0 to STA_CSR10) */
2298	rum_read_multi(sc, RT2573_STA_CSR0, sc->sta, sizeof(sc->sta));
2299
2300	ok = (le32toh(sc->sta[4]) >> 16) +	/* TX ok w/o retry */
2301	    (le32toh(sc->sta[5]) & 0xffff);	/* TX ok w/ retry */
2302	fail = (le32toh(sc->sta[5]) >> 16);	/* TX retry-fail count */
2303
2304	ieee80211_amrr_tx_update(&RUM_NODE(ni)->amn,
2305	    ok+fail, ok, (le32toh(sc->sta[5]) & 0xffff) + fail);
2306	(void) ieee80211_amrr_choose(ni, &RUM_NODE(ni)->amn);
2307
2308	ifp->if_oerrors += fail;	/* count TX retry-fail as Tx errors */
2309
2310	usb2_callout_reset(&rvp->amrr_ch, hz, rum_amrr_timeout, rvp);
2311}
2312
2313/* ARGUSED */
2314static struct ieee80211_node *
2315rum_node_alloc(struct ieee80211vap *vap __unused,
2316	const uint8_t mac[IEEE80211_ADDR_LEN] __unused)
2317{
2318	struct rum_node *rn;
2319
2320	rn = malloc(sizeof(struct rum_node), M_80211_NODE, M_NOWAIT | M_ZERO);
2321	return rn != NULL ? &rn->ni : NULL;
2322}
2323
2324static void
2325rum_newassoc(struct ieee80211_node *ni, int isnew)
2326{
2327	struct ieee80211vap *vap = ni->ni_vap;
2328
2329	ieee80211_amrr_node_init(&RUM_VAP(vap)->amrr, &RUM_NODE(ni)->amn, ni);
2330}
2331
2332static void
2333rum_scan_start(struct ieee80211com *ic)
2334{
2335	struct rum_softc *sc = ic->ic_ifp->if_softc;
2336
2337	RUM_LOCK(sc);
2338	/* do it in a process context */
2339	sc->sc_scan_action = RUM_SCAN_START;
2340	rum_queue_command(sc, rum_scantask,
2341	    &sc->sc_scantask[0].hdr, &sc->sc_scantask[1].hdr);
2342	RUM_UNLOCK(sc);
2343
2344}
2345
2346static void
2347rum_scan_end(struct ieee80211com *ic)
2348{
2349	struct rum_softc *sc = ic->ic_ifp->if_softc;
2350
2351	RUM_LOCK(sc);
2352	/* do it in a process context */
2353	sc->sc_scan_action = RUM_SCAN_END;
2354	rum_queue_command(sc, rum_scantask,
2355	    &sc->sc_scantask[0].hdr, &sc->sc_scantask[1].hdr);
2356	RUM_UNLOCK(sc);
2357
2358}
2359
2360static void
2361rum_set_channel(struct ieee80211com *ic)
2362{
2363	struct rum_softc *sc = ic->ic_ifp->if_softc;
2364
2365	RUM_LOCK(sc);
2366	/* do it in a process context */
2367	sc->sc_scan_action = RUM_SET_CHANNEL;
2368	rum_queue_command(sc, rum_scantask,
2369	    &sc->sc_scantask[0].hdr, &sc->sc_scantask[1].hdr);
2370	RUM_UNLOCK(sc);
2371}
2372
2373static void
2374rum_scantask(struct usb2_proc_msg *pm)
2375{
2376	struct rum_task *task = (struct rum_task *)pm;
2377	struct rum_softc *sc = task->sc;
2378	struct ifnet *ifp = sc->sc_ifp;
2379	struct ieee80211com *ic = ifp->if_l2com;
2380	uint32_t tmp;
2381
2382	RUM_LOCK_ASSERT(sc, MA_OWNED);
2383
2384	switch (sc->sc_scan_action) {
2385	case RUM_SCAN_START:
2386		/* abort TSF synchronization */
2387		tmp = rum_read(sc, RT2573_TXRX_CSR9);
2388		rum_write(sc, RT2573_TXRX_CSR9, tmp & ~0x00ffffff);
2389		rum_set_bssid(sc, ifp->if_broadcastaddr);
2390		break;
2391
2392	case RUM_SET_CHANNEL:
2393		rum_set_chan(sc, ic->ic_curchan);
2394		break;
2395
2396	default: /* RUM_SCAN_END */
2397		rum_enable_tsf_sync(sc);
2398		rum_set_bssid(sc, sc->sc_bssid);
2399		break;
2400	}
2401}
2402
2403static int
2404rum_get_rssi(struct rum_softc *sc, uint8_t raw)
2405{
2406	struct ifnet *ifp = sc->sc_ifp;
2407	struct ieee80211com *ic = ifp->if_l2com;
2408	int lna, agc, rssi;
2409
2410	lna = (raw >> 5) & 0x3;
2411	agc = raw & 0x1f;
2412
2413	if (lna == 0) {
2414		/*
2415		 * No RSSI mapping
2416		 *
2417		 * NB: Since RSSI is relative to noise floor, -1 is
2418		 *     adequate for caller to know error happened.
2419		 */
2420		return -1;
2421	}
2422
2423	rssi = (2 * agc) - RT2573_NOISE_FLOOR;
2424
2425	if (IEEE80211_IS_CHAN_2GHZ(ic->ic_curchan)) {
2426		rssi += sc->rssi_2ghz_corr;
2427
2428		if (lna == 1)
2429			rssi -= 64;
2430		else if (lna == 2)
2431			rssi -= 74;
2432		else if (lna == 3)
2433			rssi -= 90;
2434	} else {
2435		rssi += sc->rssi_5ghz_corr;
2436
2437		if (!sc->ext_5ghz_lna && lna != 1)
2438			rssi += 4;
2439
2440		if (lna == 1)
2441			rssi -= 64;
2442		else if (lna == 2)
2443			rssi -= 86;
2444		else if (lna == 3)
2445			rssi -= 100;
2446	}
2447	return rssi;
2448}
2449
2450static int
2451rum_pause(struct rum_softc *sc, int timeout)
2452{
2453	if (usb2_proc_is_gone(&sc->sc_tq))
2454		return (1);
2455
2456	usb2_pause_mtx(&sc->sc_mtx, timeout);
2457	return (0);
2458}
2459
2460static void
2461rum_command_wrapper(struct usb2_proc_msg *pm)
2462{
2463	struct rum_task *task = (struct rum_task *)pm;
2464	struct rum_softc *sc = task->sc;
2465	struct ifnet *ifp;
2466
2467	/* wait for pending transfer, if any */
2468	while (usb2_transfer_pending(sc->sc_xfer[RUM_BULK_WR]))
2469		cv_wait(&sc->sc_cmd_cv, &sc->sc_mtx);
2470
2471	/* make sure any hardware buffers are emptied */
2472	rum_pause(sc, hz / 1000);
2473
2474	/* execute task */
2475	task->func(pm);
2476
2477	/* check if this is the last task executed */
2478	if (sc->sc_last_task == task) {
2479		sc->sc_last_task = NULL;
2480		ifp = sc->sc_ifp;
2481		/* re-start TX, if any */
2482		if ((ifp != NULL) && (ifp->if_drv_flags & IFF_DRV_RUNNING))
2483			usb2_transfer_start(sc->sc_xfer[RUM_BULK_WR]);
2484	}
2485}
2486
2487static void
2488rum_queue_command(struct rum_softc *sc, usb2_proc_callback_t *fn,
2489    struct usb2_proc_msg *t0, struct usb2_proc_msg *t1)
2490{
2491	struct rum_task *task;
2492
2493	RUM_LOCK_ASSERT(sc, MA_OWNED);
2494
2495	/*
2496	 * NOTE: The task cannot get executed before we drop the
2497	 * "sc_mtx" mutex. It is safe to update fields in the message
2498	 * structure after that the message got queued.
2499	 */
2500	task = (struct rum_task *)
2501	  usb2_proc_msignal(&sc->sc_tq, t0, t1);
2502
2503	/* Setup callback and softc pointers */
2504	task->hdr.pm_callback = rum_command_wrapper;
2505	task->func = fn;
2506	task->sc = sc;
2507
2508	/* Make sure that any TX operation will stop */
2509	sc->sc_last_task = task;
2510
2511	/*
2512	 * Init, stop and flush must be synchronous!
2513	 */
2514	if ((fn == rum_init_task) || (fn == rum_stop_task) ||
2515	    (fn == rum_flush_task))
2516		usb2_proc_mwait(&sc->sc_tq, t0, t1);
2517}
2518
2519static device_method_t rum_methods[] = {
2520	/* Device interface */
2521	DEVMETHOD(device_probe,		rum_match),
2522	DEVMETHOD(device_attach,	rum_attach),
2523	DEVMETHOD(device_detach,	rum_detach),
2524
2525	{ 0, 0 }
2526};
2527
2528static driver_t rum_driver = {
2529	.name = "rum",
2530	.methods = rum_methods,
2531	.size = sizeof(struct rum_softc),
2532};
2533
2534static devclass_t rum_devclass;
2535
2536DRIVER_MODULE(rum, uhub, rum_driver, rum_devclass, NULL, 0);
2537