xref: /linux/drivers/net/wireless/broadcom/brcm80211/brcmfmac/fwil_types.h (revision 3bdab16c55f57a24245c97d707241dd9b48d1a91)
1 /*
2  * Copyright (c) 2012 Broadcom Corporation
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 
18 #ifndef FWIL_TYPES_H_
19 #define FWIL_TYPES_H_
20 
21 #include <linux/if_ether.h>
22 
23 
24 #define BRCMF_FIL_ACTION_FRAME_SIZE	1800
25 
26 /* ARP Offload feature flags for arp_ol iovar */
27 #define BRCMF_ARP_OL_AGENT		0x00000001
28 #define BRCMF_ARP_OL_SNOOP		0x00000002
29 #define BRCMF_ARP_OL_HOST_AUTO_REPLY	0x00000004
30 #define BRCMF_ARP_OL_PEER_AUTO_REPLY	0x00000008
31 
32 #define	BRCMF_BSS_INFO_VERSION	109 /* curr ver of brcmf_bss_info_le struct */
33 #define BRCMF_BSS_RSSI_ON_CHANNEL	0x0002
34 
35 #define BRCMF_STA_BRCM			0x00000001	/* Running a Broadcom driver */
36 #define BRCMF_STA_WME			0x00000002	/* WMM association */
37 #define BRCMF_STA_NONERP		0x00000004	/* No ERP */
38 #define BRCMF_STA_AUTHE			0x00000008	/* Authenticated */
39 #define BRCMF_STA_ASSOC			0x00000010	/* Associated */
40 #define BRCMF_STA_AUTHO			0x00000020	/* Authorized */
41 #define BRCMF_STA_WDS			0x00000040	/* Wireless Distribution System */
42 #define BRCMF_STA_WDS_LINKUP		0x00000080	/* WDS traffic/probes flowing properly */
43 #define BRCMF_STA_PS			0x00000100	/* STA is in power save mode from AP's viewpoint */
44 #define BRCMF_STA_APSD_BE		0x00000200	/* APSD delv/trigger for AC_BE is default enabled */
45 #define BRCMF_STA_APSD_BK		0x00000400	/* APSD delv/trigger for AC_BK is default enabled */
46 #define BRCMF_STA_APSD_VI		0x00000800	/* APSD delv/trigger for AC_VI is default enabled */
47 #define BRCMF_STA_APSD_VO		0x00001000	/* APSD delv/trigger for AC_VO is default enabled */
48 #define BRCMF_STA_N_CAP			0x00002000	/* STA 802.11n capable */
49 #define BRCMF_STA_SCBSTATS		0x00004000	/* Per STA debug stats */
50 #define BRCMF_STA_AMPDU_CAP		0x00008000	/* STA AMPDU capable */
51 #define BRCMF_STA_AMSDU_CAP		0x00010000	/* STA AMSDU capable */
52 #define BRCMF_STA_MIMO_PS		0x00020000	/* mimo ps mode is enabled */
53 #define BRCMF_STA_MIMO_RTS		0x00040000	/* send rts in mimo ps mode */
54 #define BRCMF_STA_RIFS_CAP		0x00080000	/* rifs enabled */
55 #define BRCMF_STA_VHT_CAP		0x00100000	/* STA VHT(11ac) capable */
56 #define BRCMF_STA_WPS			0x00200000	/* WPS state */
57 #define BRCMF_STA_DWDS_CAP		0x01000000	/* DWDS CAP */
58 #define BRCMF_STA_DWDS			0x02000000	/* DWDS active */
59 
60 /* size of brcmf_scan_params not including variable length array */
61 #define BRCMF_SCAN_PARAMS_FIXED_SIZE	64
62 
63 /* masks for channel and ssid count */
64 #define BRCMF_SCAN_PARAMS_COUNT_MASK	0x0000ffff
65 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT	16
66 
67 /* scan type definitions */
68 #define BRCMF_SCANTYPE_DEFAULT		0xFF
69 #define BRCMF_SCANTYPE_ACTIVE		0
70 #define BRCMF_SCANTYPE_PASSIVE		1
71 
72 #define BRCMF_WSEC_MAX_PSK_LEN		32
73 #define	BRCMF_WSEC_PASSPHRASE		BIT(0)
74 
75 /* primary (ie tx) key */
76 #define BRCMF_PRIMARY_KEY		(1 << 1)
77 #define DOT11_BSSTYPE_ANY		2
78 #define BRCMF_ESCAN_REQ_VERSION		1
79 
80 #define BRCMF_MAXRATES_IN_SET		16	/* max # of rates in rateset */
81 
82 /* OBSS Coex Auto/On/Off */
83 #define BRCMF_OBSS_COEX_AUTO		(-1)
84 #define BRCMF_OBSS_COEX_OFF		0
85 #define BRCMF_OBSS_COEX_ON		1
86 
87 /* WOWL bits */
88 /* Wakeup on Magic packet: */
89 #define BRCMF_WOWL_MAGIC		(1 << 0)
90 /* Wakeup on Netpattern */
91 #define BRCMF_WOWL_NET			(1 << 1)
92 /* Wakeup on loss-of-link due to Disassoc/Deauth: */
93 #define BRCMF_WOWL_DIS			(1 << 2)
94 /* Wakeup on retrograde TSF: */
95 #define BRCMF_WOWL_RETR			(1 << 3)
96 /* Wakeup on loss of beacon: */
97 #define BRCMF_WOWL_BCN			(1 << 4)
98 /* Wakeup after test: */
99 #define BRCMF_WOWL_TST			(1 << 5)
100 /* Wakeup after PTK refresh: */
101 #define BRCMF_WOWL_M1			(1 << 6)
102 /* Wakeup after receipt of EAP-Identity Req: */
103 #define BRCMF_WOWL_EAPID		(1 << 7)
104 /* Wakeind via PME(0) or GPIO(1): */
105 #define BRCMF_WOWL_PME_GPIO		(1 << 8)
106 /* need tkip phase 1 key to be updated by the driver: */
107 #define BRCMF_WOWL_NEEDTKIP1		(1 << 9)
108 /* enable wakeup if GTK fails: */
109 #define BRCMF_WOWL_GTK_FAILURE		(1 << 10)
110 /* support extended magic packets: */
111 #define BRCMF_WOWL_EXTMAGPAT		(1 << 11)
112 /* support ARP/NS/keepalive offloading: */
113 #define BRCMF_WOWL_ARPOFFLOAD		(1 << 12)
114 /* read protocol version for EAPOL frames: */
115 #define BRCMF_WOWL_WPA2			(1 << 13)
116 /* If the bit is set, use key rotaton: */
117 #define BRCMF_WOWL_KEYROT		(1 << 14)
118 /* If the bit is set, frm received was bcast frame: */
119 #define BRCMF_WOWL_BCAST		(1 << 15)
120 /* If the bit is set, scan offload is enabled: */
121 #define BRCMF_WOWL_SCANOL		(1 << 16)
122 /* Wakeup on tcpkeep alive timeout: */
123 #define BRCMF_WOWL_TCPKEEP_TIME		(1 << 17)
124 /* Wakeup on mDNS Conflict Resolution: */
125 #define BRCMF_WOWL_MDNS_CONFLICT	(1 << 18)
126 /* Wakeup on mDNS Service Connect: */
127 #define BRCMF_WOWL_MDNS_SERVICE		(1 << 19)
128 /* tcp keepalive got data: */
129 #define BRCMF_WOWL_TCPKEEP_DATA		(1 << 20)
130 /* Firmware died in wowl mode: */
131 #define BRCMF_WOWL_FW_HALT		(1 << 21)
132 /* Enable detection of radio button changes: */
133 #define BRCMF_WOWL_ENAB_HWRADIO		(1 << 22)
134 /* Offloads detected MIC failure(s): */
135 #define BRCMF_WOWL_MIC_FAIL		(1 << 23)
136 /* Wakeup in Unassociated state (Net/Magic Pattern): */
137 #define BRCMF_WOWL_UNASSOC		(1 << 24)
138 /* Wakeup if received matched secured pattern: */
139 #define BRCMF_WOWL_SECURE		(1 << 25)
140 /* Wakeup on finding preferred network */
141 #define BRCMF_WOWL_PFN_FOUND		(1 << 27)
142 /* Wakeup on receiving pairwise key EAP packets: */
143 #define WIPHY_WOWL_EAP_PK		(1 << 28)
144 /* Link Down indication in WoWL mode: */
145 #define BRCMF_WOWL_LINKDOWN		(1 << 31)
146 
147 #define BRCMF_WOWL_MAXPATTERNS		8
148 #define BRCMF_WOWL_MAXPATTERNSIZE	128
149 
150 #define BRCMF_COUNTRY_BUF_SZ		4
151 #define BRCMF_ANT_MAX			4
152 
153 #define BRCMF_MAX_ASSOCLIST		128
154 
155 #define BRCMF_TXBF_SU_BFE_CAP		BIT(0)
156 #define BRCMF_TXBF_MU_BFE_CAP		BIT(1)
157 #define BRCMF_TXBF_SU_BFR_CAP		BIT(0)
158 #define BRCMF_TXBF_MU_BFR_CAP		BIT(1)
159 
160 #define	BRCMF_MAXPMKID			16	/* max # PMKID cache entries */
161 #define BRCMF_NUMCHANNELS		64
162 
163 #define BRCMF_PFN_MACADDR_CFG_VER	1
164 #define BRCMF_PFN_MAC_OUI_ONLY		BIT(0)
165 #define BRCMF_PFN_SET_MAC_UNASSOC	BIT(1)
166 
167 #define BRCMF_MCSSET_LEN		16
168 
169 #define BRCMF_RSN_KCK_LENGTH		16
170 #define BRCMF_RSN_KEK_LENGTH		16
171 #define BRCMF_RSN_REPLAY_LEN		8
172 
173 #define BRCMF_MFP_NONE			0
174 #define BRCMF_MFP_CAPABLE		1
175 #define BRCMF_MFP_REQUIRED		2
176 
177 #define BRCMF_VHT_CAP_MCS_MAP_NSS_MAX	8
178 
179 #define BRCMF_HE_CAP_MCS_MAP_NSS_MAX	8
180 
181 /* MAX_CHUNK_LEN is the maximum length for data passing to firmware in each
182  * ioctl. It is relatively small because firmware has small maximum size input
183  * playload restriction for ioctls.
184  */
185 #define MAX_CHUNK_LEN			1400
186 
187 #define DLOAD_HANDLER_VER		1	/* Downloader version */
188 #define DLOAD_FLAG_VER_MASK		0xf000	/* Downloader version mask */
189 #define DLOAD_FLAG_VER_SHIFT		12	/* Downloader version shift */
190 
191 #define DL_BEGIN			0x0002
192 #define DL_END				0x0004
193 
194 #define DL_TYPE_CLM			2
195 
196 /* join preference types for join_pref iovar */
197 enum brcmf_join_pref_types {
198 	BRCMF_JOIN_PREF_RSSI = 1,
199 	BRCMF_JOIN_PREF_WPA,
200 	BRCMF_JOIN_PREF_BAND,
201 	BRCMF_JOIN_PREF_RSSI_DELTA,
202 };
203 
204 enum brcmf_fil_p2p_if_types {
205 	BRCMF_FIL_P2P_IF_CLIENT,
206 	BRCMF_FIL_P2P_IF_GO,
207 	BRCMF_FIL_P2P_IF_DYNBCN_GO,
208 	BRCMF_FIL_P2P_IF_DEV,
209 };
210 
211 enum brcmf_wowl_pattern_type {
212 	BRCMF_WOWL_PATTERN_TYPE_BITMAP = 0,
213 	BRCMF_WOWL_PATTERN_TYPE_ARP,
214 	BRCMF_WOWL_PATTERN_TYPE_NA
215 };
216 
217 struct brcmf_fil_p2p_if_le {
218 	u8 addr[ETH_ALEN];
219 	__le16 type;
220 	__le16 chspec;
221 };
222 
223 struct brcmf_fil_chan_info_le {
224 	__le32 hw_channel;
225 	__le32 target_channel;
226 	__le32 scan_channel;
227 };
228 
229 struct brcmf_fil_action_frame_le {
230 	u8	da[ETH_ALEN];
231 	__le16	len;
232 	__le32	packet_id;
233 	u8	data[BRCMF_FIL_ACTION_FRAME_SIZE];
234 };
235 
236 struct brcmf_fil_af_params_le {
237 	__le32					channel;
238 	__le32					dwell_time;
239 	u8					bssid[ETH_ALEN];
240 	u8					pad[2];
241 	struct brcmf_fil_action_frame_le	action_frame;
242 };
243 
244 struct brcmf_fil_bss_enable_le {
245 	__le32 bsscfgidx;
246 	__le32 enable;
247 };
248 
249 struct brcmf_fil_bwcap_le {
250 	__le32 band;
251 	__le32 bw_cap;
252 };
253 
254 /**
255  * struct tdls_iovar - common structure for tdls iovars.
256  *
257  * @ea: ether address of peer station.
258  * @mode: mode value depending on specific tdls iovar.
259  * @chanspec: channel specification.
260  * @pad: unused (for future use).
261  */
262 struct brcmf_tdls_iovar_le {
263 	u8 ea[ETH_ALEN];		/* Station address */
264 	u8 mode;			/* mode: depends on iovar */
265 	__le16 chanspec;
266 	__le32 pad;			/* future */
267 };
268 
269 enum brcmf_tdls_manual_ep_ops {
270 	BRCMF_TDLS_MANUAL_EP_CREATE = 1,
271 	BRCMF_TDLS_MANUAL_EP_DELETE = 3,
272 	BRCMF_TDLS_MANUAL_EP_DISCOVERY = 6
273 };
274 
275 /* Pattern matching filter. Specifies an offset within received packets to
276  * start matching, the pattern to match, the size of the pattern, and a bitmask
277  * that indicates which bits within the pattern should be matched.
278  */
279 struct brcmf_pkt_filter_pattern_le {
280 	/*
281 	 * Offset within received packet to start pattern matching.
282 	 * Offset '0' is the first byte of the ethernet header.
283 	 */
284 	__le32 offset;
285 	/* Size of the pattern.  Bitmask must be the same size.*/
286 	__le32 size_bytes;
287 	/*
288 	 * Variable length mask and pattern data. mask starts at offset 0.
289 	 * Pattern immediately follows mask.
290 	 */
291 	u8 mask_and_pattern[1];
292 };
293 
294 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
295 struct brcmf_pkt_filter_le {
296 	__le32 id;		/* Unique filter id, specified by app. */
297 	__le32 type;		/* Filter type (WL_PKT_FILTER_TYPE_xxx). */
298 	__le32 negate_match;	/* Negate the result of filter matches */
299 	union {			/* Filter definitions */
300 		struct brcmf_pkt_filter_pattern_le pattern; /* Filter pattern */
301 	} u;
302 };
303 
304 /* IOVAR "pkt_filter_enable" parameter. */
305 struct brcmf_pkt_filter_enable_le {
306 	__le32 id;		/* Unique filter id */
307 	__le32 enable;		/* Enable/disable bool */
308 };
309 
310 /* BSS info structure
311  * Applications MUST CHECK ie_offset field and length field to access IEs and
312  * next bss_info structure in a vector (in struct brcmf_scan_results)
313  */
314 struct brcmf_bss_info_le {
315 	__le32 version;		/* version field */
316 	__le32 length;		/* byte length of data in this record,
317 				 * starting at version and including IEs
318 				 */
319 	u8 BSSID[ETH_ALEN];
320 	__le16 beacon_period;	/* units are Kusec */
321 	__le16 capability;	/* Capability information */
322 	u8 SSID_len;
323 	u8 SSID[32];
324 	struct {
325 		__le32 count;   /* # rates in this set */
326 		u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
327 	} rateset;		/* supported rates */
328 	__le16 chanspec;	/* chanspec for bss */
329 	__le16 atim_window;	/* units are Kusec */
330 	u8 dtim_period;	/* DTIM period */
331 	__le16 RSSI;		/* receive signal strength (in dBm) */
332 	s8 phy_noise;		/* noise (in dBm) */
333 
334 	u8 n_cap;		/* BSS is 802.11N Capable */
335 	/* 802.11N BSS Capabilities (based on HT_CAP_*): */
336 	__le32 nbss_cap;
337 	u8 ctl_ch;		/* 802.11N BSS control channel number */
338 	__le32 reserved32[1];	/* Reserved for expansion of BSS properties */
339 	u8 flags;		/* flags */
340 	u8 reserved[3];	/* Reserved for expansion of BSS properties */
341 	u8 basic_mcs[BRCMF_MCSSET_LEN];	/* 802.11N BSS required MCS set */
342 
343 	__le16 ie_offset;	/* offset at which IEs start, from beginning */
344 	__le32 ie_length;	/* byte length of Information Elements */
345 	__le16 SNR;		/* average SNR of during frame reception */
346 	/* Add new fields here */
347 	/* variable length Information Elements */
348 };
349 
350 struct brcm_rateset_le {
351 	/* # rates in this set */
352 	__le32 count;
353 	/* rates in 500kbps units w/hi bit set if basic */
354 	u8 rates[BRCMF_MAXRATES_IN_SET];
355 };
356 
357 struct brcmf_ssid_le {
358 	__le32 SSID_len;
359 	unsigned char SSID[IEEE80211_MAX_SSID_LEN];
360 };
361 
362 struct brcmf_scan_params_le {
363 	struct brcmf_ssid_le ssid_le;	/* default: {0, ""} */
364 	u8 bssid[ETH_ALEN];	/* default: bcast */
365 	s8 bss_type;		/* default: any,
366 				 * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
367 				 */
368 	u8 scan_type;	/* flags, 0 use default */
369 	__le32 nprobes;	  /* -1 use default, number of probes per channel */
370 	__le32 active_time;	/* -1 use default, dwell time per channel for
371 				 * active scanning
372 				 */
373 	__le32 passive_time;	/* -1 use default, dwell time per channel
374 				 * for passive scanning
375 				 */
376 	__le32 home_time;	/* -1 use default, dwell time for the
377 				 * home channel between channel scans
378 				 */
379 	__le32 channel_num;	/* count of channels and ssids that follow
380 				 *
381 				 * low half is count of channels in
382 				 * channel_list, 0 means default (use all
383 				 * available channels)
384 				 *
385 				 * high half is entries in struct brcmf_ssid
386 				 * array that follows channel_list, aligned for
387 				 * s32 (4 bytes) meaning an odd channel count
388 				 * implies a 2-byte pad between end of
389 				 * channel_list and first ssid
390 				 *
391 				 * if ssid count is zero, single ssid in the
392 				 * fixed parameter portion is assumed, otherwise
393 				 * ssid in the fixed portion is ignored
394 				 */
395 	__le16 channel_list[1];	/* list of chanspecs */
396 };
397 
398 struct brcmf_scan_results {
399 	u32 buflen;
400 	u32 version;
401 	u32 count;
402 	struct brcmf_bss_info_le bss_info_le[];
403 };
404 
405 struct brcmf_escan_params_le {
406 	__le32 version;
407 	__le16 action;
408 	__le16 sync_id;
409 	struct brcmf_scan_params_le params_le;
410 };
411 
412 struct brcmf_escan_result_le {
413 	__le32 buflen;
414 	__le32 version;
415 	__le16 sync_id;
416 	__le16 bss_count;
417 	struct brcmf_bss_info_le bss_info_le;
418 };
419 
420 #define WL_ESCAN_RESULTS_FIXED_SIZE (sizeof(struct brcmf_escan_result_le) - \
421 	sizeof(struct brcmf_bss_info_le))
422 
423 /* used for association with a specific BSSID and chanspec list */
424 struct brcmf_assoc_params_le {
425 	/* 00:00:00:00:00:00: broadcast scan */
426 	u8 bssid[ETH_ALEN];
427 	/* 0: all available channels, otherwise count of chanspecs in
428 	 * chanspec_list */
429 	__le32 chanspec_num;
430 	/* list of chanspecs */
431 	__le16 chanspec_list[1];
432 };
433 
434 /**
435  * struct join_pref params - parameters for preferred join selection.
436  *
437  * @type: preference type (see enum brcmf_join_pref_types).
438  * @len: length of bytes following (currently always 2).
439  * @rssi_gain: signal gain for selection (only when @type is RSSI_DELTA).
440  * @band: band to which selection preference applies.
441  *	This is used if @type is BAND or RSSI_DELTA.
442  */
443 struct brcmf_join_pref_params {
444 	u8 type;
445 	u8 len;
446 	u8 rssi_gain;
447 	u8 band;
448 };
449 
450 /* used for join with or without a specific bssid and channel list */
451 struct brcmf_join_params {
452 	struct brcmf_ssid_le ssid_le;
453 	struct brcmf_assoc_params_le params_le;
454 };
455 
456 /* scan params for extended join */
457 struct brcmf_join_scan_params_le {
458 	u8 scan_type;		/* 0 use default, active or passive scan */
459 	__le32 nprobes;		/* -1 use default, nr of probes per channel */
460 	__le32 active_time;	/* -1 use default, dwell time per channel for
461 				 * active scanning
462 				 */
463 	__le32 passive_time;	/* -1 use default, dwell time per channel
464 				 * for passive scanning
465 				 */
466 	__le32 home_time;	/* -1 use default, dwell time for the home
467 				 * channel between channel scans
468 				 */
469 };
470 
471 /* extended join params */
472 struct brcmf_ext_join_params_le {
473 	struct brcmf_ssid_le ssid_le;	/* {0, ""}: wildcard scan */
474 	struct brcmf_join_scan_params_le scan_le;
475 	struct brcmf_assoc_params_le assoc_le;
476 };
477 
478 struct brcmf_wsec_key {
479 	u32 index;		/* key index */
480 	u32 len;		/* key length */
481 	u8 data[WLAN_MAX_KEY_LEN];	/* key data */
482 	u32 pad_1[18];
483 	u32 algo;	/* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
484 	u32 flags;	/* misc flags */
485 	u32 pad_2[3];
486 	u32 iv_initialized;	/* has IV been initialized already? */
487 	u32 pad_3;
488 	/* Rx IV */
489 	struct {
490 		u32 hi;	/* upper 32 bits of IV */
491 		u16 lo;	/* lower 16 bits of IV */
492 	} rxiv;
493 	u32 pad_4[2];
494 	u8 ea[ETH_ALEN];	/* per station */
495 };
496 
497 /*
498  * dongle requires same struct as above but with fields in little endian order
499  */
500 struct brcmf_wsec_key_le {
501 	__le32 index;		/* key index */
502 	__le32 len;		/* key length */
503 	u8 data[WLAN_MAX_KEY_LEN];	/* key data */
504 	__le32 pad_1[18];
505 	__le32 algo;	/* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
506 	__le32 flags;	/* misc flags */
507 	__le32 pad_2[3];
508 	__le32 iv_initialized;	/* has IV been initialized already? */
509 	__le32 pad_3;
510 	/* Rx IV */
511 	struct {
512 		__le32 hi;	/* upper 32 bits of IV */
513 		__le16 lo;	/* lower 16 bits of IV */
514 	} rxiv;
515 	__le32 pad_4[2];
516 	u8 ea[ETH_ALEN];	/* per station */
517 };
518 
519 /**
520  * struct brcmf_wsec_pmk_le - firmware pmk material.
521  *
522  * @key_len: number of octets in key material.
523  * @flags: key handling qualifiers.
524  * @key: PMK key material.
525  */
526 struct brcmf_wsec_pmk_le {
527 	__le16  key_len;
528 	__le16  flags;
529 	u8 key[2 * BRCMF_WSEC_MAX_PSK_LEN + 1];
530 };
531 
532 /* Used to get specific STA parameters */
533 struct brcmf_scb_val_le {
534 	__le32 val;
535 	u8 ea[ETH_ALEN];
536 };
537 
538 /* channel encoding */
539 struct brcmf_channel_info_le {
540 	__le32 hw_channel;
541 	__le32 target_channel;
542 	__le32 scan_channel;
543 };
544 
545 struct brcmf_sta_info_le {
546 	__le16 ver;		/* version of this struct */
547 	__le16 len;		/* length in bytes of this structure */
548 	__le16 cap;		/* sta's advertised capabilities */
549 	__le32 flags;		/* flags defined below */
550 	__le32 idle;		/* time since data pkt rx'd from sta */
551 	u8 ea[ETH_ALEN];		/* Station address */
552 	__le32 count;			/* # rates in this set */
553 	u8 rates[BRCMF_MAXRATES_IN_SET];	/* rates in 500kbps units */
554 						/* w/hi bit set if basic */
555 	__le32 in;		/* seconds elapsed since associated */
556 	__le32 listen_interval_inms; /* Min Listen interval in ms for STA */
557 
558 	/* Fields valid for ver >= 3 */
559 	__le32 tx_pkts;	/* # of packets transmitted */
560 	__le32 tx_failures;	/* # of packets failed */
561 	__le32 rx_ucast_pkts;	/* # of unicast packets received */
562 	__le32 rx_mcast_pkts;	/* # of multicast packets received */
563 	__le32 tx_rate;	/* Rate of last successful tx frame */
564 	__le32 rx_rate;	/* Rate of last successful rx frame */
565 	__le32 rx_decrypt_succeeds;	/* # of packet decrypted successfully */
566 	__le32 rx_decrypt_failures;	/* # of packet decrypted failed */
567 
568 	/* Fields valid for ver >= 4 */
569 	__le32 tx_tot_pkts;    /* # of tx pkts (ucast + mcast) */
570 	__le32 rx_tot_pkts;    /* # of data packets recvd (uni + mcast) */
571 	__le32 tx_mcast_pkts;  /* # of mcast pkts txed */
572 	__le64 tx_tot_bytes;   /* data bytes txed (ucast + mcast) */
573 	__le64 rx_tot_bytes;   /* data bytes recvd (ucast + mcast) */
574 	__le64 tx_ucast_bytes; /* data bytes txed (ucast) */
575 	__le64 tx_mcast_bytes; /* # data bytes txed (mcast) */
576 	__le64 rx_ucast_bytes; /* data bytes recvd (ucast) */
577 	__le64 rx_mcast_bytes; /* data bytes recvd (mcast) */
578 	s8 rssi[BRCMF_ANT_MAX];   /* per antenna rssi */
579 	s8 nf[BRCMF_ANT_MAX];     /* per antenna noise floor */
580 	__le16 aid;                    /* association ID */
581 	__le16 ht_capabilities;        /* advertised ht caps */
582 	__le16 vht_flags;              /* converted vht flags */
583 	__le32 tx_pkts_retry_cnt;      /* # of frames where a retry was
584 					 * exhausted.
585 					 */
586 	__le32 tx_pkts_retry_exhausted; /* # of user frames where a retry
587 					 * was exhausted
588 					 */
589 	s8 rx_lastpkt_rssi[BRCMF_ANT_MAX]; /* Per antenna RSSI of last
590 					    * received data frame.
591 					    */
592 	/* TX WLAN retry/failure statistics:
593 	 * Separated for host requested frames and locally generated frames.
594 	 * Include unicast frame only where the retries/failures can be counted.
595 	 */
596 	__le32 tx_pkts_total;          /* # user frames sent successfully */
597 	__le32 tx_pkts_retries;        /* # user frames retries */
598 	__le32 tx_pkts_fw_total;       /* # FW generated sent successfully */
599 	__le32 tx_pkts_fw_retries;     /* # retries for FW generated frames */
600 	__le32 tx_pkts_fw_retry_exhausted;     /* # FW generated where a retry
601 						* was exhausted
602 						*/
603 	__le32 rx_pkts_retried;        /* # rx with retry bit set */
604 	__le32 tx_rate_fallback;       /* lowest fallback TX rate */
605 
606 	union {
607 		struct {
608 			struct {
609 				__le32 count;					/* # rates in this set */
610 				u8 rates[BRCMF_MAXRATES_IN_SET];		/* rates in 500kbps units w/hi bit set if basic */
611 				u8 mcs[BRCMF_MCSSET_LEN];			/* supported mcs index bit map */
612 				__le16 vht_mcs[BRCMF_VHT_CAP_MCS_MAP_NSS_MAX];	/* supported mcs index bit map per nss */
613 			} rateset_adv;
614 		} v5;
615 
616 		struct {
617 			__le32 rx_dur_total;	/* total user RX duration (estimated) */
618 			__le16 chanspec;	/** chanspec this sta is on */
619 			__le16 pad_1;
620 			struct {
621 				__le16 version;					/* version */
622 				__le16 len;					/* length */
623 				__le32 count;					/* # rates in this set */
624 				u8 rates[BRCMF_MAXRATES_IN_SET];		/* rates in 500kbps units w/hi bit set if basic */
625 				u8 mcs[BRCMF_MCSSET_LEN];			/* supported mcs index bit map */
626 				__le16 vht_mcs[BRCMF_VHT_CAP_MCS_MAP_NSS_MAX];	/* supported mcs index bit map per nss */
627 				__le16 he_mcs[BRCMF_HE_CAP_MCS_MAP_NSS_MAX];	/* supported he mcs index bit map per nss */
628 			} rateset_adv;		/* rateset along with mcs index bitmap */
629 			__le16 wpauth;		/* authentication type */
630 			u8 algo;		/* crypto algorithm */
631 			u8 pad_2;
632 			__le32 tx_rspec;	/* Rate of last successful tx frame */
633 			__le32 rx_rspec;	/* Rate of last successful rx frame */
634 			__le32 wnm_cap;		/* wnm capabilities */
635 		} v7;
636 	};
637 };
638 
639 struct brcmf_chanspec_list {
640 	__le32	count;		/* # of entries */
641 	__le32	element[1];	/* variable length uint32 list */
642 };
643 
644 /*
645  * WLC_E_PROBRESP_MSG
646  * WLC_E_P2P_PROBREQ_MSG
647  * WLC_E_ACTION_FRAME_RX
648  */
649 struct brcmf_rx_mgmt_data {
650 	__be16	version;
651 	__be16	chanspec;
652 	__be32	rssi;
653 	__be32	mactime;
654 	__be32	rate;
655 };
656 
657 /**
658  * struct brcmf_fil_wowl_pattern_le - wowl pattern configuration struct.
659  *
660  * @cmd: "add", "del" or "clr".
661  * @masksize: Size of the mask in #of bytes
662  * @offset: Pattern byte offset in packet
663  * @patternoffset: Offset of start of pattern. Starting from field masksize.
664  * @patternsize: Size of the pattern itself in #of bytes
665  * @id: id
666  * @reasonsize: Size of the wakeup reason code
667  * @type: Type of pattern (enum brcmf_wowl_pattern_type)
668  */
669 struct brcmf_fil_wowl_pattern_le {
670 	u8	cmd[4];
671 	__le32	masksize;
672 	__le32	offset;
673 	__le32	patternoffset;
674 	__le32	patternsize;
675 	__le32	id;
676 	__le32	reasonsize;
677 	__le32	type;
678 	/* u8 mask[] - Mask follows the structure above */
679 	/* u8 pattern[] - Pattern follows the mask is at 'patternoffset' */
680 };
681 
682 struct brcmf_mbss_ssid_le {
683 	__le32	bsscfgidx;
684 	__le32	SSID_len;
685 	unsigned char SSID[32];
686 };
687 
688 /**
689  * struct brcmf_fil_country_le - country configuration structure.
690  *
691  * @country_abbrev: null-terminated country code used in the country IE.
692  * @rev: revision specifier for ccode. on set, -1 indicates unspecified.
693  * @ccode: null-terminated built-in country code.
694  */
695 struct brcmf_fil_country_le {
696 	char country_abbrev[BRCMF_COUNTRY_BUF_SZ];
697 	__le32 rev;
698 	char ccode[BRCMF_COUNTRY_BUF_SZ];
699 };
700 
701 /**
702  * struct brcmf_rev_info_le - device revision info.
703  *
704  * @vendorid: PCI vendor id.
705  * @deviceid: device id of chip.
706  * @radiorev: radio revision.
707  * @chiprev: chip revision.
708  * @corerev: core revision.
709  * @boardid: board identifier (usu. PCI sub-device id).
710  * @boardvendor: board vendor (usu. PCI sub-vendor id).
711  * @boardrev: board revision.
712  * @driverrev: driver version.
713  * @ucoderev: microcode version.
714  * @bus: bus type.
715  * @chipnum: chip number.
716  * @phytype: phy type.
717  * @phyrev: phy revision.
718  * @anarev: anacore rev.
719  * @chippkg: chip package info.
720  * @nvramrev: nvram revision number.
721  */
722 struct brcmf_rev_info_le {
723 	__le32 vendorid;
724 	__le32 deviceid;
725 	__le32 radiorev;
726 	__le32 chiprev;
727 	__le32 corerev;
728 	__le32 boardid;
729 	__le32 boardvendor;
730 	__le32 boardrev;
731 	__le32 driverrev;
732 	__le32 ucoderev;
733 	__le32 bus;
734 	__le32 chipnum;
735 	__le32 phytype;
736 	__le32 phyrev;
737 	__le32 anarev;
738 	__le32 chippkg;
739 	__le32 nvramrev;
740 };
741 
742 /**
743  * struct brcmf_assoclist_le - request assoc list.
744  *
745  * @count: indicates number of stations.
746  * @mac: MAC addresses of stations.
747  */
748 struct brcmf_assoclist_le {
749 	__le32 count;
750 	u8 mac[BRCMF_MAX_ASSOCLIST][ETH_ALEN];
751 };
752 
753 /**
754  * struct brcmf_wowl_wakeind_le - Wakeup indicators
755  *	Note: note both fields contain same information.
756  *
757  * @pci_wakeind: Whether PCI PMECSR PMEStatus bit was set.
758  * @ucode_wakeind: What wakeup-event indication was set by ucode
759  */
760 struct brcmf_wowl_wakeind_le {
761 	__le32 pci_wakeind;
762 	__le32 ucode_wakeind;
763 };
764 
765 /**
766  * struct brcmf_pmksa - PMK Security Association
767  *
768  * @bssid: The AP's BSSID.
769  * @pmkid: he PMK material itself.
770  */
771 struct brcmf_pmksa {
772 	u8 bssid[ETH_ALEN];
773 	u8 pmkid[WLAN_PMKID_LEN];
774 };
775 
776 /**
777  * struct brcmf_pmk_list_le - List of pmksa's.
778  *
779  * @npmk: Number of pmksa's.
780  * @pmk: PMK SA information.
781  */
782 struct brcmf_pmk_list_le {
783 	__le32 npmk;
784 	struct brcmf_pmksa pmk[BRCMF_MAXPMKID];
785 };
786 
787 /**
788  * struct brcmf_pno_param_le - PNO scan configuration parameters
789  *
790  * @version: PNO parameters version.
791  * @scan_freq: scan frequency.
792  * @lost_network_timeout: #sec. to declare discovered network as lost.
793  * @flags: Bit field to control features of PFN such as sort criteria auto
794  *	enable switch and background scan.
795  * @rssi_margin: Margin to avoid jitter for choosing a PFN based on RSSI sort
796  *	criteria.
797  * @bestn: number of best networks in each scan.
798  * @mscan: number of scans recorded.
799  * @repeat: minimum number of scan intervals before scan frequency changes
800  *	in adaptive scan.
801  * @exp: exponent of 2 for maximum scan interval.
802  * @slow_freq: slow scan period.
803  */
804 struct brcmf_pno_param_le {
805 	__le32 version;
806 	__le32 scan_freq;
807 	__le32 lost_network_timeout;
808 	__le16 flags;
809 	__le16 rssi_margin;
810 	u8 bestn;
811 	u8 mscan;
812 	u8 repeat;
813 	u8 exp;
814 	__le32 slow_freq;
815 };
816 
817 /**
818  * struct brcmf_pno_config_le - PNO channel configuration.
819  *
820  * @reporttype: determines what is reported.
821  * @channel_num: number of channels specified in @channel_list.
822  * @channel_list: channels to use in PNO scan.
823  * @flags: reserved.
824  */
825 struct brcmf_pno_config_le {
826 	__le32  reporttype;
827 	__le32  channel_num;
828 	__le16  channel_list[BRCMF_NUMCHANNELS];
829 	__le32  flags;
830 };
831 
832 /**
833  * struct brcmf_pno_net_param_le - scan parameters per preferred network.
834  *
835  * @ssid: ssid name and its length.
836  * @flags: bit2: hidden.
837  * @infra: BSS vs IBSS.
838  * @auth: Open vs Closed.
839  * @wpa_auth: WPA type.
840  * @wsec: wsec value.
841  */
842 struct brcmf_pno_net_param_le {
843 	struct brcmf_ssid_le ssid;
844 	__le32 flags;
845 	__le32 infra;
846 	__le32 auth;
847 	__le32 wpa_auth;
848 	__le32 wsec;
849 };
850 
851 /**
852  * struct brcmf_pno_net_info_le - information per found network.
853  *
854  * @bssid: BSS network identifier.
855  * @channel: channel number only.
856  * @SSID_len: length of ssid.
857  * @SSID: ssid characters.
858  * @RSSI: receive signal strength (in dBm).
859  * @timestamp: age in seconds.
860  */
861 struct brcmf_pno_net_info_le {
862 	u8 bssid[ETH_ALEN];
863 	u8 channel;
864 	u8 SSID_len;
865 	u8 SSID[32];
866 	__le16	RSSI;
867 	__le16	timestamp;
868 };
869 
870 /**
871  * struct brcmf_pno_scanresults_le - result returned in PNO NET FOUND event.
872  *
873  * @version: PNO version identifier.
874  * @status: indicates completion status of PNO scan.
875  * @count: amount of brcmf_pno_net_info_le entries appended.
876  */
877 struct brcmf_pno_scanresults_le {
878 	__le32 version;
879 	__le32 status;
880 	__le32 count;
881 };
882 
883 struct brcmf_pno_scanresults_v2_le {
884 	__le32 version;
885 	__le32 status;
886 	__le32 count;
887 	__le32 scan_ch_bucket;
888 };
889 
890 /**
891  * struct brcmf_pno_macaddr_le - to configure PNO macaddr randomization.
892  *
893  * @version: PNO version identifier.
894  * @flags: Flags defining how mac addrss should be used.
895  * @mac: MAC address.
896  */
897 struct brcmf_pno_macaddr_le {
898 	u8 version;
899 	u8 flags;
900 	u8 mac[ETH_ALEN];
901 };
902 
903 /**
904  * struct brcmf_dload_data_le - data passing to firmware for downloading
905  * @flag: flags related to download data.
906  * @dload_type: type of download data.
907  * @len: length in bytes of download data.
908  * @crc: crc of download data.
909  * @data: download data.
910  */
911 struct brcmf_dload_data_le {
912 	__le16 flag;
913 	__le16 dload_type;
914 	__le32 len;
915 	__le32 crc;
916 	u8 data[1];
917 };
918 
919 /**
920  * struct brcmf_pno_bssid_le - bssid configuration for PNO scan.
921  *
922  * @bssid: BSS network identifier.
923  * @flags: flags for this BSSID.
924  */
925 struct brcmf_pno_bssid_le {
926 	u8 bssid[ETH_ALEN];
927 	__le16 flags;
928 };
929 
930 /**
931  * struct brcmf_pktcnt_le - packet counters.
932  *
933  * @rx_good_pkt: packets (MSDUs & MMPDUs) received from this station
934  * @rx_bad_pkt: failed rx packets
935  * @tx_good_pkt: packets (MSDUs & MMPDUs) transmitted to this station
936  * @tx_bad_pkt: failed tx packets
937  * @rx_ocast_good_pkt: unicast packets destined for others
938  */
939 struct brcmf_pktcnt_le {
940 	__le32 rx_good_pkt;
941 	__le32 rx_bad_pkt;
942 	__le32 tx_good_pkt;
943 	__le32 tx_bad_pkt;
944 	__le32 rx_ocast_good_pkt;
945 };
946 
947 /**
948  * struct brcmf_gtk_keyinfo_le - GTP rekey data
949  *
950  * @kck: key confirmation key.
951  * @kek: key encryption key.
952  * @replay_counter: replay counter.
953  */
954 struct brcmf_gtk_keyinfo_le {
955 	u8 kck[BRCMF_RSN_KCK_LENGTH];
956 	u8 kek[BRCMF_RSN_KEK_LENGTH];
957 	u8 replay_counter[BRCMF_RSN_REPLAY_LEN];
958 };
959 
960 #define BRCMF_PNO_REPORT_NO_BATCH	BIT(2)
961 
962 /**
963  * struct brcmf_gscan_bucket_config - configuration data for channel bucket.
964  *
965  * @bucket_end_index: last channel index in @channel_list in
966  *	@struct brcmf_pno_config_le.
967  * @bucket_freq_multiple: scan interval expressed in N * @scan_freq.
968  * @flag: channel bucket report flags.
969  * @reserved: for future use.
970  * @repeat: number of scan at interval for exponential scan.
971  * @max_freq_multiple: maximum scan interval for exponential scan.
972  */
973 struct brcmf_gscan_bucket_config {
974 	u8 bucket_end_index;
975 	u8 bucket_freq_multiple;
976 	u8 flag;
977 	u8 reserved;
978 	__le16 repeat;
979 	__le16 max_freq_multiple;
980 };
981 
982 /* version supported which must match firmware */
983 #define BRCMF_GSCAN_CFG_VERSION                     2
984 
985 /**
986  * enum brcmf_gscan_cfg_flags - bit values for gscan flags.
987  *
988  * @BRCMF_GSCAN_CFG_FLAGS_ALL_RESULTS: send probe responses/beacons to host.
989  * @BRCMF_GSCAN_CFG_ALL_BUCKETS_IN_1ST_SCAN: all buckets will be included in
990  *	first scan cycle.
991  * @BRCMF_GSCAN_CFG_FLAGS_CHANGE_ONLY: indicated only flags member is changed.
992  */
993 enum brcmf_gscan_cfg_flags {
994 	BRCMF_GSCAN_CFG_FLAGS_ALL_RESULTS = BIT(0),
995 	BRCMF_GSCAN_CFG_ALL_BUCKETS_IN_1ST_SCAN = BIT(3),
996 	BRCMF_GSCAN_CFG_FLAGS_CHANGE_ONLY = BIT(7),
997 };
998 
999 /**
1000  * struct brcmf_gscan_config - configuration data for gscan.
1001  *
1002  * @version: version of the api to match firmware.
1003  * @flags: flags according %enum brcmf_gscan_cfg_flags.
1004  * @buffer_threshold: percentage threshold of buffer to generate an event.
1005  * @swc_nbssid_threshold: number of BSSIDs with significant change that
1006  *	will generate an event.
1007  * @swc_rssi_window_size: size of rssi cache buffer (max=8).
1008  * @count_of_channel_buckets: number of array members in @bucket.
1009  * @retry_threshold: !unknown!
1010  * @lost_ap_window: !unknown!
1011  * @bucket: array of channel buckets.
1012  */
1013 struct brcmf_gscan_config {
1014 	__le16 version;
1015 	u8 flags;
1016 	u8 buffer_threshold;
1017 	u8 swc_nbssid_threshold;
1018 	u8 swc_rssi_window_size;
1019 	u8 count_of_channel_buckets;
1020 	u8 retry_threshold;
1021 	__le16  lost_ap_window;
1022 	struct brcmf_gscan_bucket_config bucket[1];
1023 };
1024 
1025 #endif /* FWIL_TYPES_H_ */
1026