bwfmreg.h revision 1.8 1 /* $NetBSD: bwfmreg.h,v 1.8 2022/03/14 06:40:12 mlelstv Exp $ */
2 /* $OpenBSD: bwfmreg.h,v 1.16 2018/02/07 21:44:09 patrick Exp $ */
3 /*
4 * Copyright (c) 2010-2016 Broadcom Corporation
5 * Copyright (c) 2016,2017 Patrick Wildt <patrick (at) blueri.se>
6 *
7 * Permission to use, copy, modify, and/or distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20 #ifndef _DEV_IC_BWFMREG_H
21 #define _DEV_IC_BWFMREG_H
22
23 #include <sys/param.h>
24 #include <sys/types.h>
25
26 #include <sys/cdefs.h>
27
28 #include <net/if.h>
29 #include <net/if_ether.h>
30
31 #include <net80211/ieee80211.h>
32
33 /* SDIO registers */
34 #define BWFM_SDIO_FUNC1_SBADDRLOW 0x1000A
35 #define BWFM_SDIO_FUNC1_SBADDRMID 0x1000B
36 #define BWFM_SDIO_FUNC1_SBADDRHIGH 0x1000C
37 #define BWFM_SDIO_FUNC1_CHIPCLKCSR 0x1000E
38 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_FORCE_ALP 0x01
39 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_FORCE_HT 0x02
40 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_FORCE_ILP 0x04
41 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_ALP_AVAIL_REQ 0x08
42 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_HT_AVAIL_REQ 0x10
43 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_FORCE_HW_CLKREQ_OFF 0x20
44 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_ALP_AVAIL 0x40
45 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_HT_AVAIL 0x80
46 #define BWFM_SDIO_FUNC1_CHIPCLKCSR_CSR_MASK 0x1F
47 #define BWFM_SDIO_FUNC1_SDIOPULLUP 0x1000F
48
49 #define BWFM_SDIO_SB_OFT_ADDR_MASK 0x07FFF
50 #define BWFM_SDIO_SB_ACCESS_2_4B_FLAG 0x08000
51
52 /* Chip registers */
53 #define BWFM_CHIP_BASE 0x18000000
54 #define BWFM_CHIP_REG_CHIPID 0x00000000
55 #define BWFM_CHIP_CHIPID_ID(x) (((x) >> 0) & 0xffff)
56 #define BWFM_CHIP_CHIPID_REV(x) (((x) >> 16) & 0xf)
57 #define BWFM_CHIP_CHIPID_PKG(x) (((x) >> 20) & 0xf)
58 #define BWFM_CHIP_CHIPID_CC(x) (((x) >> 24) & 0xf)
59 #define BWFM_CHIP_CHIPID_TYPE(x) (((x) >> 28) & 0xf)
60 #define BWFM_CHIP_CHIPID_TYPE_SOCI_SB 0
61 #define BWFM_CHIP_CHIPID_TYPE_SOCI_AI 1
62 #define BWFM_CHIP_REG_CAPABILITIES 0x00000004
63 #define BWFM_CHIP_REG_CAPABILITIES_PMU 0x10000000
64 #define BWFM_CHIP_REG_CAPABILITIES_EXT 0x000000AC
65 #define BWFM_CHIP_REG_CAPABILITIES_EXT_AOB_PRESENT 0x00000040
66 #define BWFM_CHIP_REG_WATCHDOG 0x00000080
67 #define BWFM_CHIP_REG_EROMPTR 0x000000FC
68 #define BWFM_CHIP_REG_SR_CAPABILITY 0x00000500
69 #define BWFM_CHIP_REG_SR_CONTROL0 0x00000504
70 #define BWFM_CHIP_REG_SR_CONTROL1 0x00000508
71 #define BWFM_CHIP_REG_PMUCONTROL 0x00000600
72 #define BWFM_CHIP_REG_PMUCONTROL_RES_MASK 0x00006000
73 #define BWFM_CHIP_REG_PMUCONTROL_RES_SHIFT 13
74 #define BWFM_CHIP_REG_PMUCONTROL_RES_RELOAD 0x2
75 #define BWFM_CHIP_REG_PMUCAPABILITIES 0x00000604
76 #define BWFM_CHIP_REG_PMUCAPABILITIES_REV_MASK 0x000000ff
77 #define BWFM_CHIP_REG_PMUCAPABILITIES_EXT 0x0000064C
78 #define BWFM_CHIP_REG_PMUCAPABILITIES_SR_SUPP (1 << 1)
79 #define BWFM_CHIP_REG_CHIPCONTROL_ADDR 0x00000650
80 #define BWFM_CHIP_REG_CHIPCONTROL_DATA 0x00000654
81 #define BWFM_CHIP_REG_RETENTION_CTL 0x00000670
82 #define BWFM_CHIP_REG_RETENTION_CTL_MACPHY_DIS (1 << 26)
83 #define BWFM_CHIP_REG_RETENTION_CTL_LOGIC_DIS (1 << 27)
84
85 /* Agent registers */
86 #define BWFM_AGENT_IOCTL 0x0408
87 #define BWFM_AGENT_IOCTL_CLK 0x0001
88 #define BWFM_AGENT_IOCTL_FGC 0x0002
89 #define BWFM_AGENT_IOCTL_CORE_BITS 0x3FFC
90 #define BWFM_AGENT_IOCTL_PME_EN 0x4000
91 #define BWFM_AGENT_IOCTL_BIST_EN 0x8000
92 #define BWFM_AGENT_IOCTL_ARMCR4_CPUHALT 0x0020
93 #define BWFM_AGENT_RESET_CTL 0x0800
94 #define BWFM_AGENT_RESET_CTL_RESET 0x0001
95
96 /* Agent Core-IDs */
97 #define BWFM_AGENT_CORE_CHIPCOMMON 0x800
98 #define BWFM_AGENT_INTERNAL_MEM 0x80E
99 #define BWFM_AGENT_CORE_80211 0x812
100 #define BWFM_AGENT_CORE_PMU 0x827
101 #define BWFM_AGENT_CORE_SDIO_DEV 0x829
102 #define BWFM_AGENT_CORE_ARM_CM3 0x82A
103 #define BWFM_AGENT_CORE_PCIE2 0x83C
104 #define BWFM_AGENT_CORE_ARM_CR4 0x83E
105 #define BWFM_AGENT_CORE_ARM_CA7 0x847
106 #define BWFM_AGENT_SYS_MEM 0x849
107
108 /* Specific Core Bits */
109 #define BWFM_AGENT_ARMCR4_IOCTL_CPUHALT 0x0020
110 #define BWFM_AGENT_D11_IOCTL_PHYCLOCKEN 0x0004
111 #define BWFM_AGENT_D11_IOCTL_PHYRESET 0x0008
112
113 /* CR4 registers */
114 #define BWFM_ARMCR4_CAP 0x0004
115 #define BWFM_ARMCR4_CAP_TCBANB_MASK 0xf
116 #define BWFM_ARMCR4_CAP_TCBANB_SHIFT 0
117 #define BWFM_ARMCR4_CAP_TCBBNB_MASK 0xf0
118 #define BWFM_ARMCR4_CAP_TCBBNB_SHIFT 4
119 #define BWFM_ARMCR4_BANKIDX 0x0040
120 #define BWFM_ARMCR4_BANKINFO 0x0044
121 #define BWFM_ARMCR4_BANKINFO_BSZ_MASK 0x3f
122 #define BWFM_ARMCR4_BANKINFO_BSZ_MULT 8192
123 #define BWFM_ARMCR4_BANKPDA 0x004C
124
125 /* SOCRAM registers */
126 #define BWFM_SOCRAM_COREINFO 0x0000
127 #define BWFM_SOCRAM_COREINFO_SRBSZ_BASE 14
128 #define BWFM_SOCRAM_COREINFO_SRBSZ_MASK 0xf
129 #define BWFM_SOCRAM_COREINFO_SRBSZ_SHIFT 0
130 #define BWFM_SOCRAM_COREINFO_SRNB_MASK 0xf0
131 #define BWFM_SOCRAM_COREINFO_SRNB_SHIFT 4
132 #define BWFM_SOCRAM_COREINFO_LSS_MASK 0xf00000
133 #define BWFM_SOCRAM_COREINFO_LSS_SHIFT 20
134 #define BWFM_SOCRAM_BANKIDX 0x0010
135 #define BWFM_SOCRAM_BANKIDX_MEMTYPE_RAM 0
136 #define BWFM_SOCRAM_BANKIDX_MEMTYPE_ROM 1
137 #define BWFM_SOCRAM_BANKIDX_MEMTYPE_DEVRAM 2
138 #define BWFM_SOCRAM_BANKIDX_MEMTYPE_SHIFT 8
139 #define BWFM_SOCRAM_BANKINFO 0x0040
140 #define BWFM_SOCRAM_BANKINFO_SZBASE 8192
141 #define BWFM_SOCRAM_BANKINFO_SZMASK 0x7f
142 #define BWFM_SOCRAM_BANKINFO_RETNTRAM_MASK 0x10000
143 #define BWFM_SOCRAM_BANKPDA 0x0044
144
145 /* SDPCMD registers */
146 #define BWFM_SDPCMD_INTSTATUS 0x0020
147
148 /* DMP descriptor */
149 #define BWFM_DMP_DESC_MASK 0x0000000F
150 #define BWFM_DMP_DESC_EMPTY 0x00000000
151 #define BWFM_DMP_DESC_VALID 0x00000001
152 #define BWFM_DMP_DESC_COMPONENT 0x00000001
153 #define BWFM_DMP_DESC_MASTER_PORT 0x00000003
154 #define BWFM_DMP_DESC_ADDRESS 0x00000005
155 #define BWFM_DMP_DESC_ADDRSIZE_GT32 0x00000008
156 #define BWFM_DMP_DESC_EOT 0x0000000F
157 #define BWFM_DMP_COMP_DESIGNER 0xFFF00000
158 #define BWFM_DMP_COMP_DESIGNER_S 20
159 #define BWFM_DMP_COMP_PARTNUM 0x000FFF00
160 #define BWFM_DMP_COMP_PARTNUM_S 8
161 #define BWFM_DMP_COMP_CLASS 0x000000F0
162 #define BWFM_DMP_COMP_CLASS_S 4
163 #define BWFM_DMP_COMP_REVISION 0xFF000000
164 #define BWFM_DMP_COMP_REVISION_S 24
165 #define BWFM_DMP_COMP_NUM_SWRAP 0x00F80000
166 #define BWFM_DMP_COMP_NUM_SWRAP_S 19
167 #define BWFM_DMP_COMP_NUM_MWRAP 0x0007C000
168 #define BWFM_DMP_COMP_NUM_MWRAP_S 14
169 #define BWFM_DMP_COMP_NUM_SPORT 0x00003E00
170 #define BWFM_DMP_COMP_NUM_SPORT_S 9
171 #define BWFM_DMP_COMP_NUM_MPORT 0x000001F0
172 #define BWFM_DMP_COMP_NUM_MPORT_S 4
173 #define BWFM_DMP_MASTER_PORT_UID 0x0000FF00
174 #define BWFM_DMP_MASTER_PORT_UID_S 8
175 #define BWFM_DMP_MASTER_PORT_NUM 0x000000F0
176 #define BWFM_DMP_MASTER_PORT_NUM_S 4
177 #define BWFM_DMP_SLAVE_ADDR_BASE 0xFFFFF000
178 #define BWFM_DMP_SLAVE_ADDR_BASE_S 12
179 #define BWFM_DMP_SLAVE_PORT_NUM 0x00000F00
180 #define BWFM_DMP_SLAVE_PORT_NUM_S 8
181 #define BWFM_DMP_SLAVE_TYPE 0x000000C0
182 #define BWFM_DMP_SLAVE_TYPE_S 6
183 #define BWFM_DMP_SLAVE_TYPE_SLAVE 0
184 #define BWFM_DMP_SLAVE_TYPE_BRIDGE 1
185 #define BWFM_DMP_SLAVE_TYPE_SWRAP 2
186 #define BWFM_DMP_SLAVE_TYPE_MWRAP 3
187 #define BWFM_DMP_SLAVE_SIZE_TYPE 0x00000030
188 #define BWFM_DMP_SLAVE_SIZE_TYPE_S 4
189 #define BWFM_DMP_SLAVE_SIZE_4K 0
190 #define BWFM_DMP_SLAVE_SIZE_8K 1
191 #define BWFM_DMP_SLAVE_SIZE_16K 2
192 #define BWFM_DMP_SLAVE_SIZE_DESC 3
193
194 /* Security Parameters */
195 #define BWFM_AUTH_OPEN 0
196 #define BWFM_AUTH_SHARED_KEY 1
197 #define BWFM_AUTH_AUTO 2
198 #define BWFM_CRYPTO_ALGO_OFF 0
199 #define BWFM_CRYPTO_ALGO_WEP1 1
200 #define BWFM_CRYPTO_ALGO_TKIP 2
201 #define BWFM_CRYPTO_ALGO_WEP128 3
202 #define BWFM_CRYPTO_ALGO_AES_CCM 4
203 #define BWFM_CRYPTO_ALGO_AES_RESERVED1 5
204 #define BWFM_CRYPTO_ALGO_AES_RESERVED2 6
205 #define BWFM_MFP_NONE 0
206 #define BWFM_MFP_CAPABLE 1
207 #define BWFM_MFP_REQUIRED 2
208 #define BWFM_WPA_AUTH_DISABLED (0 << 0)
209 #define BWFM_WPA_AUTH_NONE (1 << 0)
210 #define BWFM_WPA_AUTH_WPA_UNSPECIFIED (1 << 1)
211 #define BWFM_WPA_AUTH_WPA_PSK (1 << 2)
212 #define BWFM_WPA_AUTH_WPA2_UNSPECIFIED (1 << 6)
213 #define BWFM_WPA_AUTH_WPA2_PSK (1 << 7)
214 #define BWFM_WPA_AUTH_WPA2_1X_SHA256 (1 << 12)
215 #define BWFM_WPA_AUTH_WPA2_PSK_SHA256 (1 << 15)
216 #define BWFM_WSEC_NONE (0 << 0)
217 #define BWFM_WSEC_WEP (1 << 0)
218 #define BWFM_WSEC_TKIP (1 << 1)
219 #define BWFM_WSEC_AES (1 << 2)
220
221 /* Channel Parameters */
222 #define BWFM_CHANSPEC_CHAN_MASK 0xff
223 #define BWFM_CHANSPEC_CHAN_SHIFT 0
224 #define BWFM_CHANSPEC_D11N_SB_L (0x1 << 8) /* control lower */
225 #define BWFM_CHANSPEC_D11N_SB_U (0x2 << 8) /* control lower */
226 #define BWFM_CHANSPEC_D11N_SB_N (0x3 << 8) /* none */
227 #define BWFM_CHANSPEC_D11N_SB_MASK (0x3 << 8)
228 #define BWFM_CHANSPEC_D11N_SB_SHIFT 8
229 #define BWFM_CHANSPEC_D11N_BW_10 (0x1 << 10)
230 #define BWFM_CHANSPEC_D11N_BW_20 (0x2 << 10)
231 #define BWFM_CHANSPEC_D11N_BW_40 (0x3 << 10)
232 #define BWFM_CHANSPEC_D11N_BW_MASK (0x3 << 10)
233 #define BWFM_CHANSPEC_D11N_BW_SHIFT 10
234 #define BWFM_CHANSPEC_D11N_BND_5G (0x1 << 12)
235 #define BWFM_CHANSPEC_D11N_BND_2G (0x2 << 12)
236 #define BWFM_CHANSPEC_D11N_BND_MASK (0x3 << 12)
237 #define BWFM_CHANSPEC_D11N_BND_SHIFT 12
238 #define BWFM_CHANSPEC_D11AC_SB_LLL (0x0 << 8)
239 #define BWFM_CHANSPEC_D11AC_SB_LLU (0x1 << 8)
240 #define BWFM_CHANSPEC_D11AC_SB_LUL (0x2 << 8)
241 #define BWFM_CHANSPEC_D11AC_SB_LUU (0x3 << 8)
242 #define BWFM_CHANSPEC_D11AC_SB_ULL (0x4 << 8)
243 #define BWFM_CHANSPEC_D11AC_SB_ULU (0x5 << 8)
244 #define BWFM_CHANSPEC_D11AC_SB_UUL (0x6 << 8)
245 #define BWFM_CHANSPEC_D11AC_SB_UUU (0x7 << 8)
246 #define BWFM_CHANSPEC_D11AC_SB_MASK (0x7 << 8)
247 #define BWFM_CHANSPEC_D11AC_SB_SHIFT 8
248 #define BWFM_CHANSPEC_D11AC_BW_5 (0x0 << 11)
249 #define BWFM_CHANSPEC_D11AC_BW_10 (0x1 << 11)
250 #define BWFM_CHANSPEC_D11AC_BW_20 (0x2 << 11)
251 #define BWFM_CHANSPEC_D11AC_BW_40 (0x3 << 11)
252 #define BWFM_CHANSPEC_D11AC_BW_80 (0x4 << 11)
253 #define BWFM_CHANSPEC_D11AC_BW_160 (0x5 << 11)
254 #define BWFM_CHANSPEC_D11AC_BW_8080 (0x6 << 11)
255 #define BWFM_CHANSPEC_D11AC_BW_MASK (0x7 << 11)
256 #define BWFM_CHANSPEC_D11AC_BW_SHIFT 11
257 #define BWFM_CHANSPEC_D11AC_BND_2G (0x0 << 14)
258 #define BWFM_CHANSPEC_D11AC_BND_3G (0x1 << 14)
259 #define BWFM_CHANSPEC_D11AC_BND_4G (0x2 << 14)
260 #define BWFM_CHANSPEC_D11AC_BND_5G (0x3 << 14)
261 #define BWFM_CHANSPEC_D11AC_BND_MASK (0x3 << 14)
262 #define BWFM_CHANSPEC_D11AC_BND_SHIFT 14
263
264 #define BWFM_BAND_AUTO 0
265 #define BWFM_BAND_5G 1
266 #define BWFM_BAND_2G 2
267 #define BWFM_BAND_ALL 3
268
269 /* Power Modes */
270 #define BWFM_PM_CAM 0
271 #define BWFM_PM_PS 1
272 #define BWFM_PM_FAST_PS 2
273
274 /* DCMD commands */
275 #define BWFM_C_GET_VERSION 1
276 #define BWFM_C_UP 2
277 #define BWFM_C_DOWN 3
278 #define BWFM_C_SET_PROMISC 10
279 #define BWFM_C_GET_RATE 12
280 #define BWFM_C_GET_INFRA 19
281 #define BWFM_C_SET_INFRA 20
282 #define BWFM_C_GET_AUTH 21
283 #define BWFM_C_SET_AUTH 22
284 #define BWFM_C_GET_BSSID 23
285 #define BWFM_C_GET_SSID 25
286 #define BWFM_C_SET_SSID 26
287 #define BWFM_C_TERMINATED 28
288 #define BWFM_C_GET_CHANNEL 29
289 #define BWFM_C_SET_CHANNEL 30
290 #define BWFM_C_GET_SRL 31
291 #define BWFM_C_SET_SRL 32
292 #define BWFM_C_GET_LRL 33
293 #define BWFM_C_SET_LRL 34
294 #define BWFM_C_GET_RADIO 37
295 #define BWFM_C_SET_RADIO 38
296 #define BWFM_C_GET_PHYTYPE 39
297 #define BWFM_C_SET_KEY 45
298 #define BWFM_C_GET_REGULATORY 46
299 #define BWFM_C_SET_REGULATORY 47
300 #define BWFM_C_SET_PASSIVE_SCAN 49
301 #define BWFM_C_SCAN 50
302 #define BWFM_C_SCAN_RESULTS 51
303 #define BWFM_C_DISASSOC 52
304 #define BWFM_C_REASSOC 53
305 #define BWFM_C_SET_ROAM_TRIGGER 55
306 #define BWFM_C_SET_ROAM_DELTA 57
307 #define BWFM_C_GET_BCNPRD 75
308 #define BWFM_C_SET_BCNPRD 76
309 #define BWFM_C_GET_DTIMPRD 77
310 #define BWFM_C_SET_DTIMPRD 78
311 #define BWFM_C_SET_COUNTRY 84
312 #define BWFM_C_GET_PM 85
313 #define BWFM_C_SET_PM 86
314 #define BWFM_C_GET_REVINFO 98
315 #define BWFM_C_GET_CURR_RATESET 114
316 #define BWFM_C_GET_AP 117
317 #define BWFM_C_SET_AP 118
318 #define BWFM_C_SET_SCB_AUTHORIZE 121
319 #define BWFM_C_SET_SCB_DEAUTHORIZE 122
320 #define BWFM_C_GET_RSSI 127
321 #define BWFM_C_GET_WSEC 133
322 #define BWFM_C_SET_WSEC 134
323 #define BWFM_C_GET_PHY_NOISE 135
324 #define BWFM_C_GET_BSS_INFO 136
325 #define BWFM_C_GET_GET_PKTCNTS 137
326 #define BWFM_C_GET_BANDLIST 140
327 #define BWFM_C_SET_SCB_TIMEOUT 158
328 #define BWFM_C_GET_ASSOCLIST 159
329 #define BWFM_C_GET_PHYLIST 180
330 #define BWFM_C_SET_SCAN_CHANNEL_TIME 185
331 #define BWFM_C_SET_SCAN_UNASSOC_TIME 187
332 #define BWFM_C_SCB_DEAUTHENTICATE_FOR_REASON 201
333 #define BWFM_C_SET_ASSOC_PREFER 205
334 #define BWFM_C_GET_VALID_CHANNELS 217
335 #define BWFM_C_GET_KEY_PRIMARY 235
336 #define BWFM_C_SET_KEY_PRIMARY 236
337 #define BWFM_C_SET_SCAN_PASSIVE_TIME 258
338 #define BWFM_C_GET_VAR 262
339 #define BWFM_C_SET_VAR 263
340 #define BWFM_C_SET_WSEC_PMK 268
341
342 /* Small, medium, and maximum buffer size for dcmd */
343 #define BWFM_DCMD_SMLEN 256
344 #define BWFM_DCMD_MEDLEN 1536
345 #define BWFM_DCMD_MAXLEN 8192
346
347 struct bwfm_proto_bcdc_dcmd {
348 struct {
349 uint32_t cmd;
350 uint32_t len;
351 uint32_t flags;
352 #define BWFM_BCDC_DCMD_ERROR (1 << 0)
353 #define BWFM_BCDC_DCMD_GET (0 << 1)
354 #define BWFM_BCDC_DCMD_SET (1 << 1)
355 #define BWFM_BCDC_DCMD_IF_GET(x) (((x) >> 12) & 0xf)
356 #define BWFM_BCDC_DCMD_IF_SET(x) (((x) & 0xf) << 12)
357 #define BWFM_BCDC_DCMD_ID_GET(x) (((x) >> 16) & 0xffff)
358 #define BWFM_BCDC_DCMD_ID_SET(x) (((x) & 0xffff) << 16)
359 uint32_t status;
360 } hdr;
361 char buf[8192];
362 };
363
364 struct bwfm_proto_bcdc_hdr {
365 uint8_t flags;
366 #define BWFM_BCDC_FLAG_PROTO_VER 2
367 #define BWFM_BCDC_FLAG_VER(x) (((x) & 0xf) << 4)
368 #define BWFM_BCDC_FLAG_SUM_GOOD (1 << 2) /* rx */
369 #define BWFM_BCDC_FLAG_SUM_NEEDED (1 << 3) /* tx */
370 uint8_t priority;
371 #define BWFM_BCDC_PRIORITY_MASK 0x7
372 uint8_t flags2;
373 #define BWFM_BCDC_FLAG2_IF_MASK 0xf
374 uint8_t data_offset;
375 };
376
377 #define BWFM_MCSSET_LEN 16
378 #define BWFM_MAX_SSID_LEN 32
379 #define BWFM_BSS_INFO_BUFLEN 2048
380 struct bwfm_bss_info {
381 uint32_t version;
382 uint32_t length;
383 uint8_t bssid[ETHER_ADDR_LEN];
384 uint16_t beacon_period;
385 uint16_t capability;
386 uint8_t ssid_len;
387 uint8_t ssid[BWFM_MAX_SSID_LEN];
388 uint8_t pad0;
389 uint32_t nrates;
390 uint8_t rates[16];
391 uint16_t chanspec;
392 uint16_t atim_window;
393 uint8_t dtim_period;
394 uint8_t pad1;
395 uint16_t rssi;
396 uint8_t phy_noise;
397 uint8_t n_cap;
398 uint16_t pad2;
399 uint32_t nbss_cap;
400 uint8_t ctl_ch;
401 uint8_t pad3[3];
402 uint32_t reserved32[1];
403 uint8_t flags;
404 uint8_t reserved[3];
405 uint8_t basic_mcs[BWFM_MCSSET_LEN];
406 uint16_t ie_offset;
407 uint16_t pad4;
408 uint32_t ie_length;
409 uint16_t snr;
410 };
411
412 #define BWFM_MAXRATES_IN_SET BWFM_MCSSET_LEN
413 #define BWFM_ANT_MAX 4
414 #define BWFM_VHT_CAP_MCS_MAP_NSS_MAX 8
415 #define BWFM_HE_CAP_MCS_MAP_NSS_MAX BWFM_VHT_CAP_MCS_MAP_NSS_MAX
416
417 struct bwfm_sta_rateset_v5 {
418 uint32_t count;
419 /* rates in 500kbps units w/hi bit set if basic */
420 uint8_t rates[BWFM_MAXRATES_IN_SET];
421 uint8_t mcs[BWFM_MCSSET_LEN];
422 uint16_t vht_mcs[BWFM_VHT_CAP_MCS_MAP_NSS_MAX];
423 };
424
425 struct bwfm_sta_rateset_v7 {
426 uint16_t version;
427 uint16_t len;
428 uint32_t count;
429 /* rates in 500kbps units w/hi bit set if basic */
430 uint8_t rates[BWFM_MAXRATES_IN_SET];
431 uint8_t mcs[BWFM_MCSSET_LEN];
432 uint16_t vht_mcs[BWFM_VHT_CAP_MCS_MAP_NSS_MAX];
433 uint16_t he_mcs[BWFM_HE_CAP_MCS_MAP_NSS_MAX];
434 };
435
436 struct bwfm_sta_info {
437 uint16_t ver;
438 uint16_t len;
439 uint16_t cap; /* sta's advertised capabilities */
440
441 uint32_t flags;
442 #define BWFM_STA_BRCM 0x00000001 /* Running a Broadcom driver */
443 #define BWFM_STA_WME 0x00000002 /* WMM association */
444 #define BWFM_STA_NONERP 0x00000004 /* No ERP */
445 #define BWFM_STA_AUTHE 0x00000008 /* Authenticated */
446 #define BWFM_STA_ASSOC 0x00000010 /* Associated */
447 #define BWFM_STA_AUTHO 0x00000020 /* Authorized */
448 #define BWFM_STA_WDS 0x00000040 /* Wireless Distribution System */
449 #define BWFM_STA_WDS_LINKUP 0x00000080 /* WDS traffic/probes flowing */
450 #define BWFM_STA_PS 0x00000100 /* STA in power save mode, says AP */
451 #define BWFM_STA_APSD_BE 0x00000200 /* APSD for AC_BE default enabled */
452 #define BWFM_STA_APSD_BK 0x00000400 /* APSD for AC_BK default enabled */
453 #define BWFM_STA_APSD_VI 0x00000800 /* APSD for AC_VI default enabled */
454 #define BWFM_STA_APSD_VO 0x00001000 /* APSD for AC_VO default enabled */
455 #define BWFM_STA_N_CAP 0x00002000 /* STA 802.11n capable */
456 #define BWFM_STA_SCBSTATS 0x00004000 /* Per STA debug stats */
457 #define BWFM_STA_AMPDU_CAP 0x00008000 /* STA AMPDU capable */
458 #define BWFM_STA_AMSDU_CAP 0x00010000 /* STA AMSDU capable */
459 #define BWFM_STA_MIMO_PS 0x00020000 /* mimo ps mode is enabled */
460 #define BWFM_STA_MIMO_RTS 0x00040000 /* send rts in mimo ps mode */
461 #define BWFM_STA_RIFS_CAP 0x00080000 /* rifs enabled */
462 #define BWFM_STA_VHT_CAP 0x00100000 /* STA VHT(11ac) capable */
463 #define BWFM_STA_WPS 0x00200000 /* WPS state */
464 #define BWFM_STA_DWDS_CAP 0x01000000 /* DWDS CAP */
465 #define BWFM_STA_DWDS 0x02000000 /* DWDS active */
466
467 uint32_t idle; /* time since data pkt rx'd from sta */
468 uint8_t ea[ETHER_ADDR_LEN];
469 uint32_t count; /* # rates in this set */
470 uint8_t rates[BWFM_MAXRATES_IN_SET]; /* rates in 500kbps units */
471 /* w/hi bit set if basic */
472 uint32_t in; /* seconds elapsed since associated */
473 uint32_t listen_interval_inms; /* Min Listen interval in ms for STA */
474
475 /* Fields valid for ver >= 3 */
476 uint32_t tx_pkts; /* # of packets transmitted */
477 uint32_t tx_failures; /* # of packets failed */
478 uint32_t rx_ucast_pkts; /* # of unicast packets received */
479 uint32_t rx_mcast_pkts; /* # of multicast packets received */
480 uint32_t tx_rate; /* Rate of last successful tx frame, in bps */
481 uint32_t rx_rate; /* Rate of last successful rx frame, in bps */
482 uint32_t rx_decrypt_succeeds; /* # of packet decrypted successfully */
483 uint32_t rx_decrypt_failures; /* # of packet decrypted failed */
484
485 /* Fields valid for ver >= 4 */
486 uint32_t tx_tot_pkts; /* # of tx pkts (ucast + mcast) */
487 uint32_t rx_tot_pkts; /* # of data packets recvd (uni + mcast) */
488 uint32_t tx_mcast_pkts; /* # of mcast pkts txed */
489 uint64_t tx_tot_bytes; /* data bytes txed (ucast + mcast) */
490 uint64_t rx_tot_bytes; /* data bytes recvd (ucast + mcast) */
491 uint64_t tx_ucast_bytes; /* data bytes txed (ucast) */
492 uint64_t tx_mcast_bytes; /* # data bytes txed (mcast) */
493 uint64_t rx_ucast_bytes; /* data bytes recvd (ucast) */
494 uint64_t rx_mcast_bytes; /* data bytes recvd (mcast) */
495 int8_t rssi[BWFM_ANT_MAX]; /* per antenna rssi */
496 int8_t nf[BWFM_ANT_MAX]; /* per antenna noise floor */
497 uint16_t aid; /* association ID */
498 uint16_t ht_capabilities; /* advertised ht caps */
499 uint16_t vht_flags; /* converted vht flags */
500 uint32_t tx_pkts_retry_cnt; /* # of frames where a retry was
501 * exhausted.
502 */
503 uint32_t tx_pkts_retry_exhausted; /* # of user frames where a retry
504 * was exhausted
505 */
506 int8_t rx_lastpkt_rssi[BWFM_ANT_MAX]; /* Per antenna RSSI of last
507 * received data frame.
508 */
509 /* TX WLAN retry/failure statistics:
510 * Separated for host requested frames and locally generated frames.
511 * Include unicast frame only where the retries/failures can be counted.
512 */
513 uint32_t tx_pkts_total; /* # user frames sent successfully */
514 uint32_t tx_pkts_retries; /* # user frames retries */
515 uint32_t tx_pkts_fw_total; /* # FW generated sent successfully */
516 uint32_t tx_pkts_fw_retries; /* # retries for FW generated frames */
517 uint32_t tx_pkts_fw_retry_exhausted; /* # FW generated where a retry
518 * was exhausted
519 */
520 uint32_t rx_pkts_retried; /* # rx with retry bit set */
521 uint32_t tx_rate_fallback; /* lowest fallback TX rate */
522
523 union {
524 struct {
525 struct bwfm_sta_rateset_v5 rateset_adv;
526 } v5;
527
528 struct {
529 uint32_t rx_dur_total; /* user RX duration (estimate) */
530 uint16_t chanspec;
531 uint16_t pad_1;
532 struct bwfm_sta_rateset_v7 rateset_adv;
533 uint16_t wpauth; /* authentication type */
534 uint8_t algo; /* crypto alogorithm */
535 uint8_t pad_2;
536 uint32_t tx_rspec;/* Rate of last successful tx frame */
537 uint32_t rx_rspec;/* Rate of last successful rx frame */
538 uint32_t wnm_cap;
539 } v7;
540 };
541 };
542
543 struct bwfm_ssid {
544 uint32_t len;
545 uint8_t ssid[BWFM_MAX_SSID_LEN];
546 };
547
548 struct bwfm_scan_params {
549 struct bwfm_ssid ssid;
550 uint8_t bssid[ETHER_ADDR_LEN];
551 uint8_t bss_type;
552 #define DOT11_BSSTYPE_ANY 2
553 uint8_t scan_type;
554 #define BWFM_SCANTYPE_ACTIVE 0
555 #define BWFM_SCANTYPE_PASSIVE 1
556 #define BWFM_SCANTYPE_DEFAULT 0xff
557 uint32_t nprobes;
558 uint32_t active_time;
559 uint32_t passive_time;
560 uint32_t home_time;
561 uint32_t channel_num;
562 uint16_t channel_list[];
563 };
564
565 struct bwfm_scan_results {
566 uint32_t buflen;
567 uint32_t version;
568 uint32_t count;
569 struct bwfm_bss_info bss_info[];
570 };
571
572 struct bwfm_escan_params {
573 uint32_t version;
574 #define BWFM_ESCAN_REQ_VERSION 1
575 uint16_t action;
576 #define WL_ESCAN_ACTION_START 1
577 #define WL_ESCAN_ACTION_CONTINUE 2
578 #define WL_ESCAN_ACTION_ABORT 3
579 uint16_t sync_id;
580 struct bwfm_scan_params scan_params;
581 };
582
583 struct bwfm_escan_results {
584 uint32_t buflen;
585 uint32_t version;
586 uint16_t sync_id;
587 uint16_t bss_count;
588 struct bwfm_bss_info bss_info[];
589 };
590
591 struct bwfm_assoc_params {
592 uint8_t bssid[ETHER_ADDR_LEN];
593 uint16_t pad;
594 uint32_t chanspec_num;
595 uint16_t chanspec_list[];
596 };
597
598 struct bwfm_join_pref_params {
599 uint8_t type;
600 #define BWFM_JOIN_PREF_RSSI 1
601 #define BWFM_JOIN_PREF_WPA 2
602 #define BWFM_JOIN_PREF_BAND 3
603 #define BWFM_JOIN_PREF_RSSI_DELTA 4
604 uint8_t len;
605 uint8_t rssi_gain;
606 #define BWFM_JOIN_PREF_RSSI_BOOST 8
607 uint8_t band;
608 #define BWFM_JOIN_PREF_BAND_AUTO 0
609 #define BWFM_JOIN_PREF_BAND_5G 1
610 #define BWFM_JOIN_PREF_BAND_2G 2
611 #define BWFM_JOIN_PREF_BAND_ALL 3
612 };
613
614 struct bwfm_join_params {
615 struct bwfm_ssid ssid;
616 struct bwfm_assoc_params assoc;
617 };
618
619 struct bwfm_join_scan_params {
620 uint8_t scan_type;
621 uint8_t pad[3];
622 uint32_t nprobes;
623 uint32_t active_time;
624 uint32_t passive_time;
625 uint32_t home_time;
626 };
627
628 struct bwfm_ext_join_params {
629 struct bwfm_ssid ssid;
630 struct bwfm_join_scan_params scan;
631 struct bwfm_assoc_params assoc;
632 };
633
634 struct bwfm_wsec_pmk {
635 uint16_t key_len;
636 #define BWFM_WSEC_MAX_PSK_LEN 32
637 uint16_t flags;
638 #define BWFM_WSEC_PASSPHRASE (1 << 0)
639 uint8_t key[2 * BWFM_WSEC_MAX_PSK_LEN + 1];
640 };
641
642 struct bwfm_wsec_key {
643 uint32_t index;
644 uint32_t len;
645 uint8_t data[32];
646 uint32_t pad_1[18];
647 uint32_t algo;
648 #define BWFM_CRYPTO_ALGO_OFF 0
649 #define BWFM_CRYPTO_ALGO_WEP1 1
650 #define BWFM_CRYPTO_ALGO_TKIP 2
651 #define BWFM_CRYPTO_ALGO_WEP128 3
652 #define BWFM_CRYPTO_ALGO_AES_CCM 4
653 #define BWFM_CRYPTO_ALGO_AES_RESERVED1 5
654 #define BWFM_CRYPTO_ALGO_AES_RESERVED2 6
655 uint32_t flags;
656 #define BWFM_WSEC_PRIMARY_KEY (1 << 1)
657 #define BWFM_PRIMARY_KEY BWFM_WSEC_PRIMARY_KEY
658 uint32_t pad_2[3];
659 uint32_t iv_initialized;
660 uint32_t pad_3;
661 /* Rx IV */
662 struct {
663 uint32_t hi;
664 uint16_t lo;
665 uint16_t pad_4;
666 } rxiv;
667 uint32_t pad_5[2];
668 uint8_t ea[IEEE80211_ADDR_LEN];
669 };
670
671 #define BWFM_BAND_5G 1
672 #define BWFM_BAND_2G 2
673
674 /* Event handling */
675 enum bwfm_fweh_event_code {
676 BWFM_E_SET_SSID = 0,
677 BWFM_E_JOIN = 1,
678 BWFM_E_START = 2,
679 BWFM_E_AUTH = 3,
680 BWFM_E_AUTH_IND = 4,
681 BWFM_E_DEAUTH = 5,
682 BWFM_E_DEAUTH_IND = 6,
683 BWFM_E_ASSOC = 7,
684 BWFM_E_ASSOC_IND = 8,
685 BWFM_E_REASSOC = 9,
686 BWFM_E_REASSOC_IND = 10,
687 BWFM_E_DISASSOC = 11,
688 BWFM_E_DISASSOC_IND = 12,
689 BWFM_E_QUIET_START = 13,
690 BWFM_E_QUIET_END = 14,
691 BWFM_E_BEACON_RX = 15,
692 BWFM_E_LINK = 16,
693 BWFM_E_MIC_ERROR = 17,
694 BWFM_E_NDIS_LINK = 18,
695 BWFM_E_ROAM = 19,
696 BWFM_E_TXFAIL = 20,
697 BWFM_E_PMKID_CACHE = 21,
698 BWFM_E_RETROGRADE_TSF = 22,
699 BWFM_E_PRUNE = 23,
700 BWFM_E_AUTOAUTH = 24,
701 BWFM_E_EAPOL_MSG = 25,
702 BWFM_E_SCAN_COMPLETE = 26,
703 BWFM_E_ADDTS_IND = 27,
704 BWFM_E_DELTS_IND = 28,
705 BWFM_E_BCNSENT_IND = 29,
706 BWFM_E_BCNRX_MSG = 30,
707 BWFM_E_BCNLOST_MSG = 31,
708 BWFM_E_ROAM_PREP = 32,
709 BWFM_E_PFN_NET_FOUND = 33,
710 BWFM_E_PFN_NET_LOST = 34,
711 BWFM_E_RESET_COMPLETE = 35,
712 BWFM_E_JOIN_START = 36,
713 BWFM_E_ROAM_START = 37,
714 BWFM_E_ASSOC_START = 38,
715 BWFM_E_IBSS_ASSOC = 39,
716 BWFM_E_RADIO = 40,
717 BWFM_E_PSM_WATCHDOG = 41,
718 BWFM_E_PROBREQ_MSG = 44,
719 BWFM_E_SCAN_CONFIRM_IND = 45,
720 BWFM_E_PSK_SUP = 46,
721 BWFM_E_COUNTRY_CODE_CHANGED = 47,
722 BWFM_E_EXCEEDED_MEDIUM_TIME = 48,
723 BWFM_E_ICV_ERROR = 49,
724 BWFM_E_UNICAST_DECODE_ERROR = 50,
725 BWFM_E_MULTICAST_DECODE_ERROR = 51,
726 BWFM_E_TRACE = 52,
727 BWFM_E_IF = 54,
728 BWFM_E_P2P_DISC_LISTEN_COMPLETE = 55,
729 BWFM_E_RSSI = 56,
730 BWFM_E_EXTLOG_MSG = 58,
731 BWFM_E_ACTION_FRAME = 59,
732 BWFM_E_ACTION_FRAME_COMPLETE = 60,
733 BWFM_E_PRE_ASSOC_IND = 61,
734 BWFM_E_PRE_REASSOC_IND = 62,
735 BWFM_E_CHANNEL_ADOPTED = 63,
736 BWFM_E_AP_STARTED = 64,
737 BWFM_E_DFS_AP_STOP = 65,
738 BWFM_E_DFS_AP_RESUME = 66,
739 BWFM_E_ESCAN_RESULT = 69,
740 BWFM_E_ACTION_FRAME_OFF_CHAN_COMPLETE = 70,
741 BWFM_E_PROBERESP_MSG = 71,
742 BWFM_E_P2P_PROBEREQ_MSG = 72,
743 BWFM_E_DCS_REQUEST = 73,
744 BWFM_E_FIFO_CREDIT_MAP = 74,
745 BWFM_E_ACTION_FRAME_RX = 75,
746 BWFM_E_TDLS_PEER_EVENT = 92,
747 BWFM_E_BCMC_CREDIT_SUPPORT = 127,
748 BWFM_E_LAST = 139
749 };
750 #define BWFM_EVENT_MASK_LEN (roundup(BWFM_E_LAST, 8) / 8)
751
752 enum bwfm_fweh_event_status {
753 BWFM_E_STATUS_SUCCESS = 0,
754 BWFM_E_STATUS_FAIL = 1,
755 BWFM_E_STATUS_TIMEOUT = 2,
756 BWFM_E_STATUS_NO_NETWORKS = 3,
757 BWFM_E_STATUS_ABORT = 4,
758 BWFM_E_STATUS_NO_ACK = 5,
759 BWFM_E_STATUS_UNSOLICITED = 6,
760 BWFM_E_STATUS_ATTEMPT = 7,
761 BWFM_E_STATUS_PARTIAL = 8,
762 BWFM_E_STATUS_NEWSCAN = 9,
763 BWFM_E_STATUS_NEWASSOC = 10,
764 BWFM_E_STATUS_11HQUIET = 11,
765 BWFM_E_STATUS_SUPPRESS = 12,
766 BWFM_E_STATUS_NOCHANS = 13,
767 BWFM_E_STATUS_CS_ABORT = 15,
768 BWFM_E_STATUS_ERROR = 16,
769 };
770
771 struct bwfm_ethhdr {
772 uint16_t subtype;
773 uint16_t length;
774 uint8_t version;
775 uint8_t oui[3];
776 #define BWFM_BRCM_OUI "\x00\x10\x18"
777 uint16_t usr_subtype;
778 #define BWFM_BRCM_SUBTYPE_EVENT 1
779 } __packed;
780
781 struct bwfm_event_msg {
782 uint16_t version;
783 uint16_t flags;
784 uint32_t event_type;
785 uint32_t status;
786 uint32_t reason;
787 uint32_t auth_type;
788 uint32_t datalen;
789 struct ether_addr addr;
790 char ifname[IFNAMSIZ];
791 uint8_t ifidx;
792 uint8_t bsscfgidx;
793 } __packed;
794
795 struct bwfm_event {
796 struct ether_header ehdr;
797 #define BWFM_ETHERTYPE_LINK_CTL 0x886c
798 struct bwfm_ethhdr hdr;
799 struct bwfm_event_msg msg;
800 } __packed;
801
802 struct bwfm_dload_data {
803 uint16_t flag;
804 #define BWFM_DLOAD_FLAG_BEGIN (1 << 1)
805 #define BWFM_DLOAD_FLAG_END (1 << 2)
806 #define BWFM_DLOAD_FLAG_HANDLER_VER_1 (1 << 12)
807 #define BWFM_DLOAD_FLAG_HANDLER_VER_MASK (0xf << 12)
808 uint16_t type;
809 #define BWFM_DLOAD_TYPE_CLM 2
810 uint32_t len;
811 #define BWFM_DLOAD_MAX_LEN 1400
812 uint32_t crc;
813 uint8_t data[];
814 } __packed;
815
816 #endif /* _DEV_IC_BWFMREG_H */
817