1253789Srpaulo/*-
2253789Srpaulo * Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
3253789Srpaulo *
4253789Srpaulo * Permission to use, copy, modify, and distribute this software for any
5253789Srpaulo * purpose with or without fee is hereby granted, provided that the above
6253789Srpaulo * copyright notice and this permission notice appear in all copies.
7253789Srpaulo *
8253789Srpaulo * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9253789Srpaulo * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10253789Srpaulo * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11253789Srpaulo * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12253789Srpaulo * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13253789Srpaulo * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14253789Srpaulo * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15253789Srpaulo *
16253789Srpaulo * $OpenBSD: if_rsureg.h,v 1.3 2013/04/15 09:23:01 mglocker Exp $
17253789Srpaulo * $FreeBSD$
18253789Srpaulo */
19253789Srpaulo
20253789Srpaulo/* USB Requests. */
21253789Srpaulo#define R92S_REQ_REGS	0x05
22253789Srpaulo
23253789Srpaulo/*
24253789Srpaulo * MAC registers.
25253789Srpaulo */
26253789Srpaulo#define R92S_SYSCFG		0x0000
27253789Srpaulo#define R92S_SYS_ISO_CTRL	(R92S_SYSCFG + 0x000)
28253789Srpaulo#define R92S_SYS_FUNC_EN	(R92S_SYSCFG + 0x002)
29253789Srpaulo#define R92S_PMC_FSM		(R92S_SYSCFG + 0x004)
30253789Srpaulo#define R92S_SYS_CLKR		(R92S_SYSCFG + 0x008)
31253789Srpaulo#define R92S_EE_9346CR		(R92S_SYSCFG + 0x00a)
32253789Srpaulo#define R92S_AFE_MISC		(R92S_SYSCFG + 0x010)
33253789Srpaulo#define R92S_SPS0_CTRL		(R92S_SYSCFG + 0x011)
34253789Srpaulo#define R92S_SPS1_CTRL		(R92S_SYSCFG + 0x018)
35253789Srpaulo#define R92S_RF_CTRL		(R92S_SYSCFG + 0x01f)
36253789Srpaulo#define R92S_LDOA15_CTRL	(R92S_SYSCFG + 0x020)
37253789Srpaulo#define R92S_LDOV12D_CTRL	(R92S_SYSCFG + 0x021)
38253789Srpaulo#define R92S_AFE_XTAL_CTRL	(R92S_SYSCFG + 0x026)
39253789Srpaulo#define R92S_AFE_PLL_CTRL	(R92S_SYSCFG + 0x028)
40253789Srpaulo#define R92S_EFUSE_CTRL		(R92S_SYSCFG + 0x030)
41253789Srpaulo#define R92S_EFUSE_TEST		(R92S_SYSCFG + 0x034)
42253789Srpaulo#define R92S_EFUSE_CLK_CTRL	(R92S_SYSCFG + 0x2f8)
43253789Srpaulo
44253789Srpaulo#define R92S_CMDCTRL		0x0040
45253789Srpaulo#define R92S_CR			(R92S_CMDCTRL + 0x000)
46253789Srpaulo#define R92S_TCR		(R92S_CMDCTRL + 0x004)
47253789Srpaulo#define R92S_RCR		(R92S_CMDCTRL + 0x008)
48253789Srpaulo
49253789Srpaulo#define R92S_MACIDSETTING	0x0050
50253789Srpaulo#define R92S_MACID		(R92S_MACIDSETTING + 0x000)
51253789Srpaulo
52253789Srpaulo#define R92S_GP			0x01e0
53253789Srpaulo#define R92S_GPIO_CTRL		(R92S_GP + 0x00c)
54253789Srpaulo#define R92S_GPIO_IO_SEL	(R92S_GP + 0x00e)
55253789Srpaulo#define R92S_MAC_PINMUX_CTRL	(R92S_GP + 0x011)
56253789Srpaulo
57253789Srpaulo#define R92S_IOCMD_CTRL		0x0370
58253789Srpaulo#define R92S_IOCMD_DATA		0x0374
59253789Srpaulo
60253789Srpaulo#define R92S_USB_HRPWM		0xfe58
61253789Srpaulo
62253789Srpaulo/* Bits for R92S_SYS_FUNC_EN. */
63253789Srpaulo#define R92S_FEN_CPUEN	0x0400
64253789Srpaulo
65253789Srpaulo/* Bits for R92S_PMC_FSM. */
66253789Srpaulo#define R92S_PMC_FSM_CUT_M	0x000f8000
67253789Srpaulo#define R92S_PMC_FSM_CUT_S	15
68253789Srpaulo
69253789Srpaulo/* Bits for R92S_SYS_CLKR. */
70253789Srpaulo#define R92S_SYS_CLKSEL		0x0001
71253789Srpaulo#define R92S_SYS_PS_CLKSEL	0x0002
72253789Srpaulo#define R92S_SYS_CPU_CLKSEL	0x0004
73253789Srpaulo#define R92S_MAC_CLK_EN		0x0800
74253789Srpaulo#define R92S_SYS_CLK_EN		0x1000
75253789Srpaulo#define R92S_SWHW_SEL		0x4000
76253789Srpaulo#define R92S_FWHW_SEL		0x8000
77253789Srpaulo
78253789Srpaulo/* Bits for R92S_EE_9346CR. */
79253789Srpaulo#define R92S_9356SEL		0x10
80253789Srpaulo#define R92S_EEPROM_EN		0x20
81253789Srpaulo
82253789Srpaulo/* Bits for R92S_AFE_MISC. */
83253789Srpaulo#define R92S_AFE_MISC_BGEN	0x01
84253789Srpaulo#define R92S_AFE_MISC_MBEN	0x02
85253789Srpaulo#define R92S_AFE_MISC_I32_EN	0x08
86253789Srpaulo
87253789Srpaulo/* Bits for R92S_SPS1_CTRL. */
88253789Srpaulo#define R92S_SPS1_LDEN	0x01
89253789Srpaulo#define R92S_SPS1_SWEN	0x02
90253789Srpaulo
91253789Srpaulo/* Bits for R92S_LDOA15_CTRL. */
92253789Srpaulo#define R92S_LDA15_EN	0x01
93253789Srpaulo
94253789Srpaulo/* Bits for R92S_LDOV12D_CTRL. */
95253789Srpaulo#define R92S_LDV12_EN	0x01
96253789Srpaulo
97253789Srpaulo/* Bits for R92C_EFUSE_CTRL. */
98253789Srpaulo#define R92S_EFUSE_CTRL_DATA_M	0x000000ff
99253789Srpaulo#define R92S_EFUSE_CTRL_DATA_S	0
100253789Srpaulo#define R92S_EFUSE_CTRL_ADDR_M	0x0003ff00
101253789Srpaulo#define R92S_EFUSE_CTRL_ADDR_S	8
102253789Srpaulo#define R92S_EFUSE_CTRL_VALID	0x80000000
103253789Srpaulo
104253789Srpaulo/* Bits for R92S_CR. */
105253789Srpaulo#define R92S_CR_TXDMA_EN	0x10
106253789Srpaulo
107253789Srpaulo/* Bits for R92S_TCR. */
108253789Srpaulo#define R92S_TCR_IMEM_CODE_DONE	0x01
109253789Srpaulo#define R92S_TCR_IMEM_CHK_RPT	0x02
110253789Srpaulo#define R92S_TCR_EMEM_CODE_DONE	0x04
111253789Srpaulo#define R92S_TCR_EMEM_CHK_RPT	0x08
112253789Srpaulo#define R92S_TCR_DMEM_CODE_DONE	0x10
113253789Srpaulo#define R92S_TCR_IMEM_RDY	0x20
114253789Srpaulo#define R92S_TCR_FWRDY		0x80
115253789Srpaulo
116253789Srpaulo/* Bits for R92S_GPIO_IO_SEL. */
117253789Srpaulo#define R92S_GPIO_WPS	0x10
118253789Srpaulo
119253789Srpaulo/* Bits for R92S_MAC_PINMUX_CTRL. */
120253789Srpaulo#define R92S_GPIOSEL_GPIO_M		0x03
121253789Srpaulo#define R92S_GPIOSEL_GPIO_S		0
122253789Srpaulo#define R92S_GPIOSEL_GPIO_JTAG		0
123253789Srpaulo#define R92S_GPIOSEL_GPIO_PHYDBG	1
124253789Srpaulo#define R92S_GPIOSEL_GPIO_BT		2
125253789Srpaulo#define R92S_GPIOSEL_GPIO_WLANDBG	3
126253789Srpaulo#define R92S_GPIOMUX_EN			0x08
127253789Srpaulo
128253789Srpaulo/* Bits for R92S_IOCMD_CTRL. */
129253789Srpaulo#define R92S_IOCMD_CLASS_M		0xff000000
130253789Srpaulo#define R92S_IOCMD_CLASS_S		24
131253789Srpaulo#define R92S_IOCMD_CLASS_BB_RF		0xf0
132253789Srpaulo#define R92S_IOCMD_VALUE_M		0x00ffff00
133253789Srpaulo#define R92S_IOCMD_VALUE_S		8
134253789Srpaulo#define R92S_IOCMD_INDEX_M		0x000000ff
135253789Srpaulo#define R92S_IOCMD_INDEX_S		0
136253789Srpaulo#define R92S_IOCMD_INDEX_BB_READ	0
137253789Srpaulo#define R92S_IOCMD_INDEX_BB_WRITE	1
138253789Srpaulo#define R92S_IOCMD_INDEX_RF_READ	2
139253789Srpaulo#define R92S_IOCMD_INDEX_RF_WRITE	3
140253789Srpaulo
141253789Srpaulo/* Bits for R92S_USB_HRPWM. */
142253789Srpaulo#define R92S_USB_HRPWM_PS_ALL_ON	0x04
143253789Srpaulo#define R92S_USB_HRPWM_PS_ST_ACTIVE	0x08
144253789Srpaulo
145253789Srpaulo/*
146253789Srpaulo * Macros to access subfields in registers.
147253789Srpaulo */
148253789Srpaulo/* Mask and Shift (getter). */
149253789Srpaulo#define MS(val, field)							\
150253789Srpaulo	(((val) & field##_M) >> field##_S)
151253789Srpaulo
152253789Srpaulo/* Shift and Mask (setter). */
153253789Srpaulo#define SM(field, val)							\
154253789Srpaulo	(((val) << field##_S) & field##_M)
155253789Srpaulo
156253789Srpaulo/* Rewrite. */
157253789Srpaulo#define RW(var, field, val)						\
158253789Srpaulo	(((var) & ~field##_M) | SM(field, val))
159253789Srpaulo
160253789Srpaulo/*
161253789Srpaulo * Firmware image header.
162253789Srpaulo */
163253789Srpaulostruct r92s_fw_priv {
164253789Srpaulo	/* QWORD0 */
165253789Srpaulo	uint16_t	signature;
166253789Srpaulo	uint8_t		hci_sel;
167253789Srpaulo#define R92S_HCI_SEL_PCIE	0x01
168253789Srpaulo#define R92S_HCI_SEL_USB	0x02
169253789Srpaulo#define R92S_HCI_SEL_SDIO	0x04
170253789Srpaulo#define R92S_HCI_SEL_8172	0x10
171253789Srpaulo#define R92S_HCI_SEL_AP		0x80
172253789Srpaulo
173253789Srpaulo	uint8_t		chip_version;
174253789Srpaulo	uint16_t	custid;
175253789Srpaulo	uint8_t		rf_config;
176253789Srpaulo	uint8_t		nendpoints;
177253789Srpaulo	/* QWORD1 */
178253789Srpaulo	uint32_t	regulatory;
179253789Srpaulo	uint8_t		rfintfs;
180253789Srpaulo	uint8_t		def_nettype;
181253789Srpaulo	uint8_t		turbo_mode;
182253789Srpaulo	uint8_t		lowpower_mode;
183253789Srpaulo	/* QWORD2 */
184253789Srpaulo	uint8_t		lbk_mode;
185253789Srpaulo	uint8_t		mp_mode;
186253789Srpaulo	uint8_t		vcs_type;
187253789Srpaulo#define R92S_VCS_TYPE_DISABLE	0
188253789Srpaulo#define R92S_VCS_TYPE_ENABLE	1
189253789Srpaulo#define R92S_VCS_TYPE_AUTO	2
190253789Srpaulo
191253789Srpaulo	uint8_t		vcs_mode;
192253789Srpaulo#define R92S_VCS_MODE_NONE	0
193253789Srpaulo#define R92S_VCS_MODE_RTS_CTS	1
194253789Srpaulo#define R92S_VCS_MODE_CTS2SELF	2
195253789Srpaulo
196253789Srpaulo	uint32_t	reserved1;
197253789Srpaulo	/* QWORD3 */
198253789Srpaulo	uint8_t		qos_en;
199253789Srpaulo	uint8_t		bw40_en;
200253789Srpaulo	uint8_t		amsdu2ampdu_en;
201253789Srpaulo	uint8_t		ampdu_en;
202253789Srpaulo	uint8_t		rc_offload;
203253789Srpaulo	uint8_t		agg_offload;
204253789Srpaulo	uint16_t	reserved2;
205253789Srpaulo	/* QWORD4 */
206253789Srpaulo	uint8_t		beacon_offload;
207253789Srpaulo	uint8_t		mlme_offload;
208253789Srpaulo	uint8_t		hwpc_offload;
209253789Srpaulo	uint8_t		tcpcsum_offload;
210253789Srpaulo	uint8_t		tcp_offload;
211253789Srpaulo	uint8_t		ps_offload;
212253789Srpaulo	uint8_t		wwlan_offload;
213253789Srpaulo	uint8_t		reserved3;
214253789Srpaulo	/* QWORD5 */
215253789Srpaulo	uint16_t	tcp_tx_len;
216253789Srpaulo	uint16_t	tcp_rx_len;
217253789Srpaulo	uint32_t	reserved4;
218253789Srpaulo} __packed;
219253789Srpaulo
220253789Srpaulostruct r92s_fw_hdr {
221253789Srpaulo	uint16_t	signature;
222253789Srpaulo	uint16_t	version;
223253789Srpaulo	uint32_t	dmemsz;
224253789Srpaulo	uint32_t	imemsz;
225253789Srpaulo	uint32_t	sramsz;
226253789Srpaulo	uint32_t	privsz;
227253789Srpaulo	uint16_t	efuse_addr;
228253789Srpaulo	uint16_t	h2c_resp_addr;
229253789Srpaulo	uint32_t	svnrev;
230253789Srpaulo	uint8_t		month;
231253789Srpaulo	uint8_t		day;
232253789Srpaulo	uint8_t		hour;
233253789Srpaulo	uint8_t		minute;
234253789Srpaulo	struct		r92s_fw_priv priv;
235253789Srpaulo} __packed;
236253789Srpaulo
237253789Srpaulo/* Structure for FW commands and FW events notifications. */
238253789Srpaulostruct r92s_fw_cmd_hdr {
239253789Srpaulo	uint16_t	len;
240253789Srpaulo	uint8_t		code;
241253789Srpaulo	uint8_t		seq;
242253789Srpaulo#define R92S_FW_CMD_MORE	0x80
243253789Srpaulo
244253789Srpaulo	uint32_t	reserved;
245253789Srpaulo} __packed;
246253789Srpaulo
247253789Srpaulo/* FW commands codes. */
248253789Srpaulo#define R92S_CMD_READ_MACREG		0
249253789Srpaulo#define R92S_CMD_WRITE_MACREG		1
250253789Srpaulo#define R92S_CMD_READ_BBREG		2
251253789Srpaulo#define R92S_CMD_WRITE_BBREG		3
252253789Srpaulo#define R92S_CMD_READ_RFREG		4
253253789Srpaulo#define R92S_CMD_WRITE_RFREG		5
254253789Srpaulo#define R92S_CMD_READ_EEPROM		6
255253789Srpaulo#define R92S_CMD_WRITE_EEPROM		7
256253789Srpaulo#define R92S_CMD_READ_EFUSE		8
257253789Srpaulo#define R92S_CMD_WRITE_EFUSE		9
258253789Srpaulo#define R92S_CMD_READ_CAM		10
259253789Srpaulo#define R92S_CMD_WRITE_CAM		11
260253789Srpaulo#define R92S_CMD_SET_BCNITV		12
261253789Srpaulo#define R92S_CMD_SET_MBIDCFG		13
262253789Srpaulo#define R92S_CMD_JOIN_BSS		14
263253789Srpaulo#define R92S_CMD_DISCONNECT		15
264253789Srpaulo#define R92S_CMD_CREATE_BSS		16
265253789Srpaulo#define R92S_CMD_SET_OPMODE		17
266253789Srpaulo#define R92S_CMD_SITE_SURVEY		18
267253789Srpaulo#define R92S_CMD_SET_AUTH		19
268253789Srpaulo#define R92S_CMD_SET_KEY		20
269253789Srpaulo#define R92S_CMD_SET_STA_KEY		21
270253789Srpaulo#define R92S_CMD_SET_ASSOC_STA		22
271253789Srpaulo#define R92S_CMD_DEL_ASSOC_STA		23
272253789Srpaulo#define R92S_CMD_SET_STAPWRSTATE	24
273253789Srpaulo#define R92S_CMD_SET_BASIC_RATE		25
274253789Srpaulo#define R92S_CMD_GET_BASIC_RATE		26
275253789Srpaulo#define R92S_CMD_SET_DATA_RATE		27
276253789Srpaulo#define R92S_CMD_GET_DATA_RATE		28
277253789Srpaulo#define R92S_CMD_SET_PHY_INFO		29
278253789Srpaulo#define R92S_CMD_GET_PHY_INFO		30
279253789Srpaulo#define R92S_CMD_SET_PHY		31
280253789Srpaulo#define R92S_CMD_GET_PHY		32
281253789Srpaulo#define R92S_CMD_READ_RSSI		33
282253789Srpaulo#define R92S_CMD_READ_GAIN		34
283253789Srpaulo#define R92S_CMD_SET_ATIM		35
284253789Srpaulo#define R92S_CMD_SET_PWR_MODE		36
285253789Srpaulo#define R92S_CMD_JOIN_BSS_RPT		37
286253789Srpaulo#define R92S_CMD_SET_RA_TABLE		38
287253789Srpaulo#define R92S_CMD_GET_RA_TABLE		39
288253789Srpaulo#define R92S_CMD_GET_CCX_REPORT		40
289253789Srpaulo#define R92S_CMD_GET_DTM_REPORT		41
290253789Srpaulo#define R92S_CMD_GET_TXRATE_STATS	42
291253789Srpaulo#define R92S_CMD_SET_USB_SUSPEND	43
292253789Srpaulo#define R92S_CMD_SET_H2C_LBK		44
293253789Srpaulo#define R92S_CMD_ADDBA_REQ		45
294253789Srpaulo#define R92S_CMD_SET_CHANNEL		46
295253789Srpaulo#define R92S_CMD_SET_TXPOWER		47
296253789Srpaulo#define R92S_CMD_SWITCH_ANTENNA		48
297253789Srpaulo#define R92S_CMD_SET_CRYSTAL_CAL	49
298253789Srpaulo#define R92S_CMD_SET_SINGLE_CARRIER_TX	50
299253789Srpaulo#define R92S_CMD_SET_SINGLE_TONE_TX	51
300253789Srpaulo#define R92S_CMD_SET_CARRIER_SUPPR_TX	52
301253789Srpaulo#define R92S_CMD_SET_CONTINUOUS_TX	53
302253789Srpaulo#define R92S_CMD_SWITCH_BANDWIDTH	54
303253789Srpaulo#define R92S_CMD_TX_BEACON		55
304253789Srpaulo#define R92S_CMD_SET_POWER_TRACKING	56
305253789Srpaulo#define R92S_CMD_AMSDU_TO_AMPDU		57
306253789Srpaulo#define R92S_CMD_SET_MAC_ADDRESS	58
307253789Srpaulo#define R92S_CMD_GET_H2C_LBK		59
308253789Srpaulo#define R92S_CMD_SET_PBREQ_IE		60
309253789Srpaulo#define R92S_CMD_SET_ASSOCREQ_IE	61
310253789Srpaulo#define R92S_CMD_SET_PBRESP_IE		62
311253789Srpaulo#define R92S_CMD_SET_ASSOCRESP_IE	63
312253789Srpaulo#define R92S_CMD_GET_CURDATARATE	64
313253789Srpaulo#define R92S_CMD_GET_TXRETRY_CNT	65
314253789Srpaulo#define R92S_CMD_GET_RXRETRY_CNT	66
315253789Srpaulo#define R92S_CMD_GET_BCNOK_CNT		67
316253789Srpaulo#define R92S_CMD_GET_BCNERR_CNT		68
317253789Srpaulo#define R92S_CMD_GET_CURTXPWR_LEVEL	69
318253789Srpaulo#define R92S_CMD_SET_DIG		70
319253789Srpaulo#define R92S_CMD_SET_RA			71
320253789Srpaulo#define R92S_CMD_SET_PT			72
321253789Srpaulo#define R92S_CMD_READ_TSSI		73
322253789Srpaulo
323253789Srpaulo/* FW events notifications codes. */
324253789Srpaulo#define R92S_EVT_READ_MACREG		0
325253789Srpaulo#define R92S_EVT_READ_BBREG		1
326253789Srpaulo#define R92S_EVT_READ_RFREG		2
327253789Srpaulo#define R92S_EVT_READ_EEPROM		3
328253789Srpaulo#define R92S_EVT_READ_EFUSE		4
329253789Srpaulo#define R92S_EVT_READ_CAM		5
330253789Srpaulo#define R92S_EVT_GET_BASICRATE		6
331253789Srpaulo#define R92S_EVT_GET_DATARATE		7
332253789Srpaulo#define R92S_EVT_SURVEY			8
333253789Srpaulo#define R92S_EVT_SURVEY_DONE		9
334253789Srpaulo#define R92S_EVT_JOIN_BSS		10
335253789Srpaulo#define R92S_EVT_ADD_STA		11
336253789Srpaulo#define R92S_EVT_DEL_STA		12
337253789Srpaulo#define R92S_EVT_ATIM_DONE		13
338253789Srpaulo#define R92S_EVT_TX_REPORT		14
339253789Srpaulo#define R92S_EVT_CCX_REPORT		15
340253789Srpaulo#define R92S_EVT_DTM_REPORT		16
341253789Srpaulo#define R92S_EVT_TXRATE_STATS		17
342253789Srpaulo#define R92S_EVT_C2H_LBK		18
343253789Srpaulo#define R92S_EVT_FWDBG			19
344253789Srpaulo#define R92S_EVT_C2H_FEEDBACK		20
345253789Srpaulo#define R92S_EVT_ADDBA			21
346253789Srpaulo#define R92S_EVT_C2H_BCN		22
347253789Srpaulo#define R92S_EVT_PWR_STATE		23
348253789Srpaulo#define R92S_EVT_WPS_PBC		24
349253789Srpaulo#define R92S_EVT_ADDBA_REQ_REPORT	25
350253789Srpaulo
351253789Srpaulo/* Structure for R92S_CMD_SITE_SURVEY. */
352253789Srpaulostruct r92s_fw_cmd_sitesurvey {
353253789Srpaulo	uint32_t	active;
354253789Srpaulo	uint32_t	limit;
355253789Srpaulo	uint32_t	ssidlen;
356253789Srpaulo	uint8_t		ssid[32 + 1];
357253789Srpaulo} __packed;
358253789Srpaulo
359253789Srpaulo/* Structure for R92S_CMD_SET_AUTH. */
360253789Srpaulostruct r92s_fw_cmd_auth {
361253789Srpaulo	uint8_t	mode;
362253789Srpaulo#define R92S_AUTHMODE_OPEN	0
363253789Srpaulo#define R92S_AUTHMODE_SHARED	1
364253789Srpaulo#define R92S_AUTHMODE_WPA	2
365253789Srpaulo
366253789Srpaulo	uint8_t	dot1x;
367253789Srpaulo} __packed;
368253789Srpaulo
369253789Srpaulo/* Structure for R92S_CMD_SET_KEY. */
370253789Srpaulostruct r92s_fw_cmd_set_key {
371253789Srpaulo	uint8_t	algo;
372253789Srpaulo#define R92S_KEY_ALGO_NONE	0
373253789Srpaulo#define R92S_KEY_ALGO_WEP40	1
374253789Srpaulo#define R92S_KEY_ALGO_TKIP	2
375253789Srpaulo#define R92S_KEY_ALGO_TKIP_MMIC	3
376253789Srpaulo#define R92S_KEY_ALGO_AES	4
377253789Srpaulo#define R92S_KEY_ALGO_WEP104	5
378253789Srpaulo
379253789Srpaulo	uint8_t	id;
380253789Srpaulo	uint8_t	grpkey;
381253789Srpaulo	uint8_t	key[16];
382253789Srpaulo} __packed;
383253789Srpaulo
384253789Srpaulo/* Structures for R92S_EVENT_SURVEY/R92S_CMD_JOIN_BSS. */
385253789Srpaulo/* NDIS_802_11_SSID. */
386253789Srpaulostruct ndis_802_11_ssid {
387253789Srpaulo	uint32_t	ssidlen;
388253789Srpaulo	uint8_t		ssid[32];
389253789Srpaulo} __packed;
390253789Srpaulo
391253789Srpaulo/* NDIS_802_11_CONFIGURATION_FH. */
392253789Srpaulostruct ndis_802_11_configuration_fh {
393253789Srpaulo	uint32_t	len;
394253789Srpaulo	uint32_t	hoppattern;
395253789Srpaulo	uint32_t	hopset;
396253789Srpaulo	uint32_t	dwelltime;
397253789Srpaulo} __packed;
398253789Srpaulo
399253789Srpaulo/* NDIS_802_11_CONFIGURATION. */
400253789Srpaulostruct ndis_802_11_configuration {
401253789Srpaulo	uint32_t	len;
402253789Srpaulo	uint32_t	bintval;
403253789Srpaulo	uint32_t	atim;
404253789Srpaulo	uint32_t	dsconfig;
405253789Srpaulo	struct		ndis_802_11_configuration_fh fhconfig;
406253789Srpaulo} __packed;
407253789Srpaulo
408253789Srpaulo/* NDIS_WLAN_BSSID_EX. */
409253789Srpaulostruct ndis_wlan_bssid_ex {
410253789Srpaulo	uint32_t	len;
411253789Srpaulo	uint8_t		macaddr[IEEE80211_ADDR_LEN];
412253789Srpaulo	uint8_t		reserved[2];
413253789Srpaulo	struct		ndis_802_11_ssid ssid;
414253789Srpaulo	uint32_t	privacy;
415253789Srpaulo	int32_t		rssi;
416253789Srpaulo	uint32_t	networktype;
417253789Srpaulo#define NDIS802_11FH		0
418253789Srpaulo#define NDIS802_11DS		1
419253789Srpaulo#define NDIS802_11OFDM5		2
420253789Srpaulo#define NDIS802_11OFDM24	3
421253789Srpaulo#define NDIS802_11AUTOMODE	4
422253789Srpaulo
423253789Srpaulo	struct		ndis_802_11_configuration config;
424253789Srpaulo	uint32_t	inframode;
425253789Srpaulo#define NDIS802_11IBSS			0
426253789Srpaulo#define NDIS802_11INFRASTRUCTURE	1
427253789Srpaulo#define NDIS802_11AUTOUNKNOWN		2
428253789Srpaulo#define NDIS802_11MONITOR		3
429253789Srpaulo#define NDIS802_11APMODE		4
430253789Srpaulo
431253789Srpaulo	uint8_t		supprates[16];
432253789Srpaulo	uint32_t	ieslen;
433253789Srpaulo	/* Followed by ``ieslen'' bytes. */
434253789Srpaulo} __packed;
435253789Srpaulo
436253789Srpaulo/* NDIS_802_11_FIXED_IEs. */
437253789Srpaulostruct ndis_802_11_fixed_ies {
438253789Srpaulo	uint8_t		tstamp[8];
439253789Srpaulo	uint16_t	bintval;
440253789Srpaulo	uint16_t	capabilities;
441253789Srpaulo} __packed;
442253789Srpaulo
443253789Srpaulo/* Structure for R92S_CMD_SET_PWR_MODE. */
444253789Srpaulostruct r92s_set_pwr_mode {
445253789Srpaulo	uint8_t		mode;
446253789Srpaulo#define R92S_PS_MODE_ACTIVE	0
447253789Srpaulo#define R92S_PS_MODE_MIN	1
448253789Srpaulo#define R92S_PS_MODE_MAX	2
449253789Srpaulo#define R92S_PS_MODE_DTIM	3
450253789Srpaulo#define R92S_PS_MODE_VOIP	4
451253789Srpaulo#define R92S_PS_MODE_UAPSD_WMM	5
452253789Srpaulo#define R92S_PS_MODE_UAPSD	6
453253789Srpaulo#define R92S_PS_MODE_IBSS	7
454253789Srpaulo#define R92S_PS_MODE_WWLAN	8
455253789Srpaulo#define R92S_PS_MODE_RADIOOFF	9
456253789Srpaulo#define R92S_PS_MODE_DISABLE	10
457253789Srpaulo
458253789Srpaulo	uint8_t		low_traffic_en;
459253789Srpaulo	uint8_t		lpnav_en;
460253789Srpaulo	uint8_t		rf_low_snr_en;
461253789Srpaulo	uint8_t		dps_en;
462253789Srpaulo	uint8_t		bcn_rx_en;
463253789Srpaulo	uint8_t		bcn_pass_cnt;
464253789Srpaulo	uint8_t		bcn_to;
465253789Srpaulo	uint16_t	bcn_itv;
466253789Srpaulo	uint8_t		app_itv;
467253789Srpaulo	uint8_t		awake_bcn_itv;
468253789Srpaulo	uint8_t		smart_ps;
469253789Srpaulo	uint8_t		bcn_pass_time;
470253789Srpaulo} __packed;
471253789Srpaulo
472253789Srpaulo/* Structure for event R92S_EVENT_JOIN_BSS. */
473253789Srpaulostruct r92s_event_join_bss {
474253789Srpaulo	uint32_t	next;
475253789Srpaulo	uint32_t	prev;
476253789Srpaulo	uint32_t	networktype;
477253789Srpaulo	uint32_t	fixed;
478253789Srpaulo	uint32_t	lastscanned;
479253789Srpaulo	uint32_t	associd;
480253789Srpaulo	uint32_t	join_res;
481253789Srpaulo	struct		ndis_wlan_bssid_ex bss;
482253789Srpaulo} __packed;
483253789Srpaulo
484253789Srpaulo#define R92S_MACID_BSS	5
485253789Srpaulo
486253789Srpaulo/* Rx MAC descriptor. */
487253789Srpaulostruct r92s_rx_stat {
488253789Srpaulo	uint32_t	rxdw0;
489253789Srpaulo#define R92S_RXDW0_PKTLEN_M	0x00003fff
490253789Srpaulo#define R92S_RXDW0_PKTLEN_S	0
491253789Srpaulo#define R92S_RXDW0_CRCERR	0x00004000
492253789Srpaulo#define R92S_RXDW0_INFOSZ_M	0x000f0000
493253789Srpaulo#define R92S_RXDW0_INFOSZ_S	16
494253789Srpaulo#define R92S_RXDW0_QOS		0x00800000
495253789Srpaulo#define R92S_RXDW0_SHIFT_M	0x03000000
496253789Srpaulo#define R92S_RXDW0_SHIFT_S	24
497253789Srpaulo#define R92S_RXDW0_DECRYPTED	0x08000000
498253789Srpaulo
499253789Srpaulo	uint32_t	rxdw1;
500253789Srpaulo#define R92S_RXDW1_MOREFRAG	0x08000000
501253789Srpaulo
502253789Srpaulo	uint32_t	rxdw2;
503253789Srpaulo#define R92S_RXDW2_FRAG_M	0x0000f000
504253789Srpaulo#define R92S_RXDW2_FRAG_S	12
505253789Srpaulo#define R92S_RXDW2_PKTCNT_M	0x00ff0000
506253789Srpaulo#define R92S_RXDW2_PKTCNT_S	16
507253789Srpaulo
508253789Srpaulo	uint32_t	rxdw3;
509253789Srpaulo#define R92S_RXDW3_RATE_M	0x0000003f
510253789Srpaulo#define R92S_RXDW3_RATE_S	0
511253789Srpaulo#define R92S_RXDW3_TCPCHKRPT	0x00000800
512253789Srpaulo#define R92S_RXDW3_IPCHKRPT	0x00001000
513253789Srpaulo#define R92S_RXDW3_TCPCHKVALID	0x00002000
514253789Srpaulo#define R92S_RXDW3_HTC		0x00004000
515253789Srpaulo
516253789Srpaulo	uint32_t	rxdw4;
517253789Srpaulo	uint32_t	rxdw5;
518266577Shselasky} __packed __aligned(4);
519253789Srpaulo
520253789Srpaulo/* Rx PHY descriptor. */
521253789Srpaulostruct r92s_rx_phystat {
522253789Srpaulo	uint32_t	phydw0;
523253789Srpaulo	uint32_t	phydw1;
524253789Srpaulo	uint32_t	phydw2;
525253789Srpaulo	uint32_t	phydw3;
526253789Srpaulo	uint32_t	phydw4;
527253789Srpaulo	uint32_t	phydw5;
528253789Srpaulo	uint32_t	phydw6;
529253789Srpaulo	uint32_t	phydw7;
530266577Shselasky} __packed __aligned(4);
531253789Srpaulo
532253789Srpaulo/* Rx PHY CCK descriptor. */
533253789Srpaulostruct r92s_rx_cck {
534253789Srpaulo	uint8_t		adc_pwdb[4];
535253789Srpaulo	uint8_t		sq_rpt;
536253789Srpaulo	uint8_t		agc_rpt;
537253789Srpaulo} __packed;
538253789Srpaulo
539253789Srpaulo/* Tx MAC descriptor. */
540253789Srpaulostruct r92s_tx_desc {
541253789Srpaulo	uint32_t	txdw0;
542253789Srpaulo#define R92S_TXDW0_PKTLEN_M	0x0000ffff
543253789Srpaulo#define R92S_TXDW0_PKTLEN_S	0
544253789Srpaulo#define R92S_TXDW0_OFFSET_M	0x00ff0000
545253789Srpaulo#define R92S_TXDW0_OFFSET_S	16
546253789Srpaulo#define R92S_TXDW0_TYPE_M	0x03000000
547253789Srpaulo#define R92S_TXDW0_TYPE_S	24
548253789Srpaulo#define R92S_TXDW0_LSG		0x04000000
549253789Srpaulo#define R92S_TXDW0_FSG		0x08000000
550253789Srpaulo#define R92S_TXDW0_LINIP	0x10000000
551253789Srpaulo#define R92S_TXDW0_OWN		0x80000000
552253789Srpaulo
553253789Srpaulo	uint32_t	txdw1;
554253789Srpaulo#define R92S_TXDW1_MACID_M	0x0000001f
555253789Srpaulo#define R92S_TXDW1_MACID_S	0
556253789Srpaulo#define R92S_TXDW1_MOREDATA	0x00000020
557253789Srpaulo#define R92S_TXDW1_MOREFRAG	0x00000040
558253789Srpaulo#define R92S_TXDW1_QSEL_M	0x00001f00
559253789Srpaulo#define R92S_TXDW1_QSEL_S	8
560253789Srpaulo#define R92S_TXDW1_QSEL_BE	0x03
561253789Srpaulo#define R92S_TXDW1_QSEL_H2C	0x1f
562253789Srpaulo#define R92S_TXDW1_NONQOS	0x00010000
563253789Srpaulo#define R92S_TXDW1_KEYIDX_M	0x00060000
564253789Srpaulo#define R92S_TXDW1_KEYIDX_S	17
565253789Srpaulo#define R92S_TXDW1_CIPHER_M	0x00c00000
566253789Srpaulo#define R92S_TXDW1_CIPHER_S	22
567253789Srpaulo#define R92S_TXDW1_CIPHER_WEP	1
568253789Srpaulo#define R92S_TXDW1_CIPHER_TKIP	2
569253789Srpaulo#define R92S_TXDW1_CIPHER_AES	3
570253789Srpaulo#define R92S_TXDW1_HWPC		0x80000000
571253789Srpaulo
572253789Srpaulo	uint32_t	txdw2;
573253789Srpaulo#define R92S_TXDW2_BMCAST	0x00000080
574253789Srpaulo#define R92S_TXDW2_AGGEN	0x20000000
575253789Srpaulo#define R92S_TXDW2_BK		0x40000000
576253789Srpaulo
577253789Srpaulo	uint32_t	txdw3;
578253789Srpaulo#define R92S_TXDW3_SEQ_M	0x0fff0000
579253789Srpaulo#define R92S_TXDW3_SEQ_S	16
580253789Srpaulo#define R92S_TXDW3_FRAG_M	0xf0000000
581253789Srpaulo#define R92S_TXDW3_FRAG_S	28
582253789Srpaulo
583253789Srpaulo	uint32_t	txdw4;
584253789Srpaulo#define R92S_TXDW4_TXBW		0x00040000
585253789Srpaulo
586253789Srpaulo	uint32_t	txdw5;
587253789Srpaulo#define R92S_TXDW5_DISFB	0x00008000
588253789Srpaulo
589253789Srpaulo	uint16_t	ipchksum;
590253789Srpaulo	uint16_t	tcpchksum;
591253789Srpaulo
592253789Srpaulo	uint16_t	txbufsize;
593253789Srpaulo	uint16_t	reserved1;
594266577Shselasky} __packed __aligned(4);
595253789Srpaulo
596253789Srpaulo
597253789Srpaulo/*
598253789Srpaulo * Driver definitions.
599253789Srpaulo */
600253789Srpaulo#define RSU_RX_LIST_COUNT	1
601253789Srpaulo#define RSU_TX_LIST_COUNT	32
602253789Srpaulo
603253789Srpaulo#define RSU_HOST_CMD_RING_COUNT	32
604253789Srpaulo
605253789Srpaulo#define RSU_RXBUFSZ	(8 * 1024)
606253789Srpaulo#define RSU_TXBUFSZ	\
607253789Srpaulo	((sizeof(struct r92s_tx_desc) + IEEE80211_MAX_LEN + 3) & ~3)
608253789Srpaulo
609253789Srpaulo#define RSU_TX_TIMEOUT	5000	/* ms */
610253789Srpaulo#define RSU_CMD_TIMEOUT	2000	/* ms */
611253789Srpaulo
612253789Srpaulo/* Queue ids (used by soft only). */
613253789Srpaulo#define RSU_QID_BCN	0
614253789Srpaulo#define RSU_QID_MGT	1
615253789Srpaulo#define RSU_QID_BMC	2
616253789Srpaulo#define RSU_QID_VO	3
617253789Srpaulo#define RSU_QID_VI	4
618253789Srpaulo#define RSU_QID_BE	5
619253789Srpaulo#define RSU_QID_BK	6
620253789Srpaulo#define RSU_QID_RXOFF	7
621253789Srpaulo#define RSU_QID_H2C	8
622253789Srpaulo#define RSU_QID_C2H	9
623253789Srpaulo
624253789Srpaulo/* Map AC to queue id. */
625253789Srpaulostatic const uint8_t rsu_ac2qid[WME_NUM_AC] = {
626253789Srpaulo	RSU_QID_BE,
627253789Srpaulo	RSU_QID_BK,
628253789Srpaulo	RSU_QID_VI,
629253789Srpaulo	RSU_QID_VO
630253789Srpaulo};
631253789Srpaulo
632253789Srpaulo/* Pipe index to endpoint address mapping. */
633253789Srpaulostatic const uint8_t r92s_epaddr[] =
634253789Srpaulo    { 0x83, 0x04, 0x06, 0x0d,
635253789Srpaulo      0x05, 0x07,
636253789Srpaulo      0x89, 0x0a, 0x0b, 0x0c };
637253789Srpaulo
638253789Srpaulo/* Queue id to pipe index mapping for 4 endpoints configurations. */
639253789Srpaulostatic const uint8_t rsu_qid2idx_4ep[] =
640253789Srpaulo    { 3, 3, 3, 1, 1, 2, 2, 0, 3, 0 };
641253789Srpaulo
642253789Srpaulo/* Queue id to pipe index mapping for 6 endpoints configurations. */
643253789Srpaulostatic const uint8_t rsu_qid2idx_6ep[] =
644253789Srpaulo    { 3, 3, 3, 1, 4, 2, 5, 0, 3, 0 };
645253789Srpaulo
646253789Srpaulo/* Queue id to pipe index mapping for 11 endpoints configurations. */
647253789Srpaulostatic const uint8_t rsu_qid2idx_11ep[] =
648253789Srpaulo    { 7, 9, 8, 1, 4, 2, 5, 0, 3, 6 };
649253789Srpaulo
650253789Srpaulostruct rsu_rx_radiotap_header {
651253789Srpaulo	struct ieee80211_radiotap_header wr_ihdr;
652253789Srpaulo	uint8_t		wr_flags;
653253789Srpaulo	uint8_t		wr_rate;
654253789Srpaulo	uint16_t	wr_chan_freq;
655253789Srpaulo	uint16_t	wr_chan_flags;
656253789Srpaulo	uint8_t		wr_dbm_antsignal;
657253789Srpaulo} __packed __aligned(8);
658253789Srpaulo
659253789Srpaulo#define RSU_RX_RADIOTAP_PRESENT			\
660253789Srpaulo	(1 << IEEE80211_RADIOTAP_FLAGS |	\
661253789Srpaulo	 1 << IEEE80211_RADIOTAP_RATE |		\
662253789Srpaulo	 1 << IEEE80211_RADIOTAP_CHANNEL |	\
663253789Srpaulo	 1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL)
664253789Srpaulo
665253789Srpaulostruct rsu_tx_radiotap_header {
666253789Srpaulo	struct ieee80211_radiotap_header wt_ihdr;
667253789Srpaulo	uint8_t		wt_flags;
668253789Srpaulo	uint16_t	wt_chan_freq;
669253789Srpaulo	uint16_t	wt_chan_flags;
670253789Srpaulo} __packed __aligned(8);
671253789Srpaulo
672253789Srpaulo#define RSU_TX_RADIOTAP_PRESENT			\
673253789Srpaulo	(1 << IEEE80211_RADIOTAP_FLAGS |	\
674253789Srpaulo	 1 << IEEE80211_RADIOTAP_CHANNEL)
675253789Srpaulo
676253789Srpaulostruct rsu_softc;
677253789Srpaulo
678253789Srpaulostruct rsu_host_cmd {
679253789Srpaulo	void	(*cb)(struct rsu_softc *, void *);
680253789Srpaulo	uint8_t	data[256];
681253789Srpaulo};
682253789Srpaulo
683253789Srpaulostruct rsu_cmd_newstate {
684253789Srpaulo	enum ieee80211_state	state;
685253789Srpaulo	int			arg;
686253789Srpaulo};
687253789Srpaulo
688253789Srpaulostruct rsu_cmd_key {
689253789Srpaulo	struct ieee80211_key	key;
690253789Srpaulo};
691253789Srpaulo
692253789Srpaulostruct rsu_host_cmd_ring {
693253789Srpaulo	struct rsu_host_cmd	cmd[RSU_HOST_CMD_RING_COUNT];
694253789Srpaulo	int			cur;
695253789Srpaulo	int			next;
696253789Srpaulo	int			queued;
697253789Srpaulo};
698253789Srpaulo
699253789Srpauloenum {
700253789Srpaulo	RSU_BULK_RX,
701267349Shselasky	RSU_BULK_TX_BE_BK,	/* = WME_AC_BE/BK */
702267349Shselasky	RSU_BULK_TX_VI_VO,	/* = WME_AC_VI/VO */
703267349Shselasky	RSU_N_TRANSFER,
704253789Srpaulo};
705253789Srpaulo
706253789Srpaulostruct rsu_data {
707253789Srpaulo	struct rsu_softc	*sc;
708253789Srpaulo	uint8_t			*buf;
709253789Srpaulo	uint16_t		buflen;
710253789Srpaulo	struct mbuf		*m;
711253789Srpaulo	struct ieee80211_node	*ni;
712253789Srpaulo	STAILQ_ENTRY(rsu_data)  next;
713253789Srpaulo};
714253789Srpaulo
715253789Srpaulostruct rsu_vap {
716253789Srpaulo	struct ieee80211vap		vap;
717253789Srpaulo	struct ieee80211_beacon_offsets bo;
718253789Srpaulo
719253789Srpaulo	int				(*newstate)(struct ieee80211vap *,
720253789Srpaulo					    enum ieee80211_state, int);
721253789Srpaulo};
722253789Srpaulo#define RSU_VAP(vap) 			((struct rsu_vap *)(vap))
723253789Srpaulo
724253789Srpaulo#define	RSU_LOCK(sc)			mtx_lock(&(sc)->sc_mtx)
725253789Srpaulo#define	RSU_UNLOCK(sc)			mtx_unlock(&(sc)->sc_mtx)
726253789Srpaulo#define	RSU_ASSERT_LOCKED(sc)		mtx_assert(&(sc)->sc_mtx, MA_OWNED)
727253789Srpaulo
728253789Srpaulostruct rsu_softc {
729253789Srpaulo	struct ifnet			*sc_ifp;
730253789Srpaulo	device_t			sc_dev;
731253789Srpaulo	struct usb_device		*sc_udev;
732253789Srpaulo	int				(*sc_newstate)(struct ieee80211com *,
733253789Srpaulo					    enum ieee80211_state, int);
734253789Srpaulo	struct usbd_interface		*sc_iface;
735253789Srpaulo	struct timeout_task		calib_task;
736253789Srpaulo	const uint8_t			*qid2idx;
737253789Srpaulo	struct mtx			sc_mtx;
738253789Srpaulo
739253789Srpaulo	u_int				cut;
740253789Srpaulo	int				scan_pass;
741253789Srpaulo	struct rsu_host_cmd_ring	cmdq;
742253789Srpaulo	struct rsu_data			sc_rx[RSU_RX_LIST_COUNT];
743253789Srpaulo	struct rsu_data			sc_tx[RSU_TX_LIST_COUNT];
744253789Srpaulo	struct rsu_data			*fwcmd_data;
745253789Srpaulo	uint8_t				cmd_seq;
746253789Srpaulo	uint8_t				rom[128];
747253789Srpaulo	uint8_t				sc_bssid[IEEE80211_ADDR_LEN];
748253789Srpaulo	struct usb_xfer			*sc_xfer[RSU_N_TRANSFER];
749253789Srpaulo	uint8_t				sc_calibrating;
750253789Srpaulo
751253789Srpaulo	STAILQ_HEAD(, rsu_data)		sc_rx_active;
752253789Srpaulo	STAILQ_HEAD(, rsu_data)		sc_rx_inactive;
753267349Shselasky	STAILQ_HEAD(, rsu_data)		sc_tx_active[RSU_N_TRANSFER];
754253789Srpaulo	STAILQ_HEAD(, rsu_data)		sc_tx_inactive;
755267349Shselasky	STAILQ_HEAD(, rsu_data)		sc_tx_pending[RSU_N_TRANSFER];
756253789Srpaulo
757253789Srpaulo	union {
758253789Srpaulo		struct rsu_rx_radiotap_header th;
759253789Srpaulo		uint8_t	pad[64];
760253789Srpaulo	}				sc_rxtapu;
761253789Srpaulo#define sc_rxtap	sc_rxtapu.th
762253789Srpaulo	int				sc_rxtap_len;
763253789Srpaulo
764253789Srpaulo	union {
765253789Srpaulo		struct rsu_tx_radiotap_header th;
766253789Srpaulo		uint8_t	pad[64];
767253789Srpaulo	}				sc_txtapu;
768253789Srpaulo#define sc_txtap	sc_txtapu.th
769253789Srpaulo	int				sc_txtap_len;
770253789Srpaulo};
771