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