2 * Copyright (c) 2012 Broadcom Corporation
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.
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.
21 #include <linux/if_ether.h>
24 #define BRCMF_FIL_ACTION_FRAME_SIZE 1800
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
32 #define BRCMF_BSS_INFO_VERSION 109 /* curr ver of brcmf_bss_info_le struct */
33 #define BRCMF_BSS_RSSI_ON_CHANNEL 0x0002
35 #define BRCMF_STA_WME 0x00000002 /* WMM association */
36 #define BRCMF_STA_AUTHE 0x00000008 /* Authenticated */
37 #define BRCMF_STA_ASSOC 0x00000010 /* Associated */
38 #define BRCMF_STA_AUTHO 0x00000020 /* Authorized */
39 #define BRCMF_STA_SCBSTATS 0x00004000 /* Per STA debug stats */
41 /* size of brcmf_scan_params not including variable length array */
42 #define BRCMF_SCAN_PARAMS_FIXED_SIZE 64
44 /* masks for channel and ssid count */
45 #define BRCMF_SCAN_PARAMS_COUNT_MASK 0x0000ffff
46 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT 16
48 /* primary (ie tx) key */
49 #define BRCMF_PRIMARY_KEY (1 << 1)
50 #define DOT11_BSSTYPE_ANY 2
51 #define BRCMF_ESCAN_REQ_VERSION 1
53 #define BRCMF_MAXRATES_IN_SET 16 /* max # of rates in rateset */
55 /* OBSS Coex Auto/On/Off */
56 #define BRCMF_OBSS_COEX_AUTO (-1)
57 #define BRCMF_OBSS_COEX_OFF 0
58 #define BRCMF_OBSS_COEX_ON 1
61 /* Wakeup on Magic packet: */
62 #define BRCMF_WOWL_MAGIC (1 << 0)
63 /* Wakeup on Netpattern */
64 #define BRCMF_WOWL_NET (1 << 1)
65 /* Wakeup on loss-of-link due to Disassoc/Deauth: */
66 #define BRCMF_WOWL_DIS (1 << 2)
67 /* Wakeup on retrograde TSF: */
68 #define BRCMF_WOWL_RETR (1 << 3)
69 /* Wakeup on loss of beacon: */
70 #define BRCMF_WOWL_BCN (1 << 4)
71 /* Wakeup after test: */
72 #define BRCMF_WOWL_TST (1 << 5)
73 /* Wakeup after PTK refresh: */
74 #define BRCMF_WOWL_M1 (1 << 6)
75 /* Wakeup after receipt of EAP-Identity Req: */
76 #define BRCMF_WOWL_EAPID (1 << 7)
77 /* Wakeind via PME(0) or GPIO(1): */
78 #define BRCMF_WOWL_PME_GPIO (1 << 8)
79 /* need tkip phase 1 key to be updated by the driver: */
80 #define BRCMF_WOWL_NEEDTKIP1 (1 << 9)
81 /* enable wakeup if GTK fails: */
82 #define BRCMF_WOWL_GTK_FAILURE (1 << 10)
83 /* support extended magic packets: */
84 #define BRCMF_WOWL_EXTMAGPAT (1 << 11)
85 /* support ARP/NS/keepalive offloading: */
86 #define BRCMF_WOWL_ARPOFFLOAD (1 << 12)
87 /* read protocol version for EAPOL frames: */
88 #define BRCMF_WOWL_WPA2 (1 << 13)
89 /* If the bit is set, use key rotaton: */
90 #define BRCMF_WOWL_KEYROT (1 << 14)
91 /* If the bit is set, frm received was bcast frame: */
92 #define BRCMF_WOWL_BCAST (1 << 15)
93 /* If the bit is set, scan offload is enabled: */
94 #define BRCMF_WOWL_SCANOL (1 << 16)
95 /* Wakeup on tcpkeep alive timeout: */
96 #define BRCMF_WOWL_TCPKEEP_TIME (1 << 17)
97 /* Wakeup on mDNS Conflict Resolution: */
98 #define BRCMF_WOWL_MDNS_CONFLICT (1 << 18)
99 /* Wakeup on mDNS Service Connect: */
100 #define BRCMF_WOWL_MDNS_SERVICE (1 << 19)
101 /* tcp keepalive got data: */
102 #define BRCMF_WOWL_TCPKEEP_DATA (1 << 20)
103 /* Firmware died in wowl mode: */
104 #define BRCMF_WOWL_FW_HALT (1 << 21)
105 /* Enable detection of radio button changes: */
106 #define BRCMF_WOWL_ENAB_HWRADIO (1 << 22)
107 /* Offloads detected MIC failure(s): */
108 #define BRCMF_WOWL_MIC_FAIL (1 << 23)
109 /* Wakeup in Unassociated state (Net/Magic Pattern): */
110 #define BRCMF_WOWL_UNASSOC (1 << 24)
111 /* Wakeup if received matched secured pattern: */
112 #define BRCMF_WOWL_SECURE (1 << 25)
113 /* Link Down indication in WoWL mode: */
114 #define BRCMF_WOWL_LINKDOWN (1 << 31)
116 #define BRCMF_WOWL_MAXPATTERNS 8
117 #define BRCMF_WOWL_MAXPATTERNSIZE 128
119 #define BRCMF_COUNTRY_BUF_SZ 4
120 #define BRCMF_ANT_MAX 4
122 /* join preference types for join_pref iovar */
123 enum brcmf_join_pref_types {
124 BRCMF_JOIN_PREF_RSSI = 1,
126 BRCMF_JOIN_PREF_BAND,
127 BRCMF_JOIN_PREF_RSSI_DELTA,
130 enum brcmf_fil_p2p_if_types {
131 BRCMF_FIL_P2P_IF_CLIENT,
133 BRCMF_FIL_P2P_IF_DYNBCN_GO,
134 BRCMF_FIL_P2P_IF_DEV,
137 enum brcmf_wowl_pattern_type {
138 BRCMF_WOWL_PATTERN_TYPE_BITMAP = 0,
139 BRCMF_WOWL_PATTERN_TYPE_ARP,
140 BRCMF_WOWL_PATTERN_TYPE_NA
143 struct brcmf_fil_p2p_if_le {
149 struct brcmf_fil_chan_info_le {
151 __le32 target_channel;
155 struct brcmf_fil_action_frame_le {
159 u8 data[BRCMF_FIL_ACTION_FRAME_SIZE];
162 struct brcmf_fil_af_params_le {
167 struct brcmf_fil_action_frame_le action_frame;
170 struct brcmf_fil_bss_enable_le {
175 struct brcmf_fil_bwcap_le {
181 * struct tdls_iovar - common structure for tdls iovars.
183 * @ea: ether address of peer station.
184 * @mode: mode value depending on specific tdls iovar.
185 * @chanspec: channel specification.
186 * @pad: unused (for future use).
188 struct brcmf_tdls_iovar_le {
189 u8 ea[ETH_ALEN]; /* Station address */
190 u8 mode; /* mode: depends on iovar */
192 __le32 pad; /* future */
195 enum brcmf_tdls_manual_ep_ops {
196 BRCMF_TDLS_MANUAL_EP_CREATE = 1,
197 BRCMF_TDLS_MANUAL_EP_DELETE = 3,
198 BRCMF_TDLS_MANUAL_EP_DISCOVERY = 6
201 /* Pattern matching filter. Specifies an offset within received packets to
202 * start matching, the pattern to match, the size of the pattern, and a bitmask
203 * that indicates which bits within the pattern should be matched.
205 struct brcmf_pkt_filter_pattern_le {
207 * Offset within received packet to start pattern matching.
208 * Offset '0' is the first byte of the ethernet header.
211 /* Size of the pattern. Bitmask must be the same size.*/
214 * Variable length mask and pattern data. mask starts at offset 0.
215 * Pattern immediately follows mask.
217 u8 mask_and_pattern[1];
220 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
221 struct brcmf_pkt_filter_le {
222 __le32 id; /* Unique filter id, specified by app. */
223 __le32 type; /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
224 __le32 negate_match; /* Negate the result of filter matches */
225 union { /* Filter definitions */
226 struct brcmf_pkt_filter_pattern_le pattern; /* Filter pattern */
230 /* IOVAR "pkt_filter_enable" parameter. */
231 struct brcmf_pkt_filter_enable_le {
232 __le32 id; /* Unique filter id */
233 __le32 enable; /* Enable/disable bool */
236 /* BSS info structure
237 * Applications MUST CHECK ie_offset field and length field to access IEs and
238 * next bss_info structure in a vector (in struct brcmf_scan_results)
240 struct brcmf_bss_info_le {
241 __le32 version; /* version field */
242 __le32 length; /* byte length of data in this record,
243 * starting at version and including IEs
246 __le16 beacon_period; /* units are Kusec */
247 __le16 capability; /* Capability information */
251 __le32 count; /* # rates in this set */
252 u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
253 } rateset; /* supported rates */
254 __le16 chanspec; /* chanspec for bss */
255 __le16 atim_window; /* units are Kusec */
256 u8 dtim_period; /* DTIM period */
257 __le16 RSSI; /* receive signal strength (in dBm) */
258 s8 phy_noise; /* noise (in dBm) */
260 u8 n_cap; /* BSS is 802.11N Capable */
261 /* 802.11N BSS Capabilities (based on HT_CAP_*): */
263 u8 ctl_ch; /* 802.11N BSS control channel number */
264 __le32 reserved32[1]; /* Reserved for expansion of BSS properties */
265 u8 flags; /* flags */
266 u8 reserved[3]; /* Reserved for expansion of BSS properties */
267 u8 basic_mcs[MCSSET_LEN]; /* 802.11N BSS required MCS set */
269 __le16 ie_offset; /* offset at which IEs start, from beginning */
270 __le32 ie_length; /* byte length of Information Elements */
271 __le16 SNR; /* average SNR of during frame reception */
272 /* Add new fields here */
273 /* variable length Information Elements */
276 struct brcm_rateset_le {
277 /* # rates in this set */
279 /* rates in 500kbps units w/hi bit set if basic */
280 u8 rates[BRCMF_MAXRATES_IN_SET];
285 unsigned char SSID[32];
288 struct brcmf_ssid_le {
290 unsigned char SSID[32];
293 struct brcmf_scan_params_le {
294 struct brcmf_ssid_le ssid_le; /* default: {0, ""} */
295 u8 bssid[ETH_ALEN]; /* default: bcast */
296 s8 bss_type; /* default: any,
297 * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
299 u8 scan_type; /* flags, 0 use default */
300 __le32 nprobes; /* -1 use default, number of probes per channel */
301 __le32 active_time; /* -1 use default, dwell time per channel for
304 __le32 passive_time; /* -1 use default, dwell time per channel
305 * for passive scanning
307 __le32 home_time; /* -1 use default, dwell time for the
308 * home channel between channel scans
310 __le32 channel_num; /* count of channels and ssids that follow
312 * low half is count of channels in
313 * channel_list, 0 means default (use all
314 * available channels)
316 * high half is entries in struct brcmf_ssid
317 * array that follows channel_list, aligned for
318 * s32 (4 bytes) meaning an odd channel count
319 * implies a 2-byte pad between end of
320 * channel_list and first ssid
322 * if ssid count is zero, single ssid in the
323 * fixed parameter portion is assumed, otherwise
324 * ssid in the fixed portion is ignored
326 __le16 channel_list[1]; /* list of chanspecs */
329 struct brcmf_scan_results {
333 struct brcmf_bss_info_le bss_info_le[];
336 struct brcmf_escan_params_le {
340 struct brcmf_scan_params_le params_le;
343 struct brcmf_escan_result_le {
348 struct brcmf_bss_info_le bss_info_le;
351 #define WL_ESCAN_RESULTS_FIXED_SIZE (sizeof(struct brcmf_escan_result_le) - \
352 sizeof(struct brcmf_bss_info_le))
354 /* used for association with a specific BSSID and chanspec list */
355 struct brcmf_assoc_params_le {
356 /* 00:00:00:00:00:00: broadcast scan */
358 /* 0: all available channels, otherwise count of chanspecs in
361 /* list of chanspecs */
362 __le16 chanspec_list[1];
366 * struct join_pref params - parameters for preferred join selection.
368 * @type: preference type (see enum brcmf_join_pref_types).
369 * @len: length of bytes following (currently always 2).
370 * @rssi_gain: signal gain for selection (only when @type is RSSI_DELTA).
371 * @band: band to which selection preference applies.
372 * This is used if @type is BAND or RSSI_DELTA.
374 struct brcmf_join_pref_params {
381 /* used for join with or without a specific bssid and channel list */
382 struct brcmf_join_params {
383 struct brcmf_ssid_le ssid_le;
384 struct brcmf_assoc_params_le params_le;
387 /* scan params for extended join */
388 struct brcmf_join_scan_params_le {
389 u8 scan_type; /* 0 use default, active or passive scan */
390 __le32 nprobes; /* -1 use default, nr of probes per channel */
391 __le32 active_time; /* -1 use default, dwell time per channel for
394 __le32 passive_time; /* -1 use default, dwell time per channel
395 * for passive scanning
397 __le32 home_time; /* -1 use default, dwell time for the home
398 * channel between channel scans
402 /* extended join params */
403 struct brcmf_ext_join_params_le {
404 struct brcmf_ssid_le ssid_le; /* {0, ""}: wildcard scan */
405 struct brcmf_join_scan_params_le scan_le;
406 struct brcmf_assoc_params_le assoc_le;
409 struct brcmf_wsec_key {
410 u32 index; /* key index */
411 u32 len; /* key length */
412 u8 data[WLAN_MAX_KEY_LEN]; /* key data */
414 u32 algo; /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
415 u32 flags; /* misc flags */
417 u32 iv_initialized; /* has IV been initialized already? */
421 u32 hi; /* upper 32 bits of IV */
422 u16 lo; /* lower 16 bits of IV */
425 u8 ea[ETH_ALEN]; /* per station */
429 * dongle requires same struct as above but with fields in little endian order
431 struct brcmf_wsec_key_le {
432 __le32 index; /* key index */
433 __le32 len; /* key length */
434 u8 data[WLAN_MAX_KEY_LEN]; /* key data */
436 __le32 algo; /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
437 __le32 flags; /* misc flags */
439 __le32 iv_initialized; /* has IV been initialized already? */
443 __le32 hi; /* upper 32 bits of IV */
444 __le16 lo; /* lower 16 bits of IV */
447 u8 ea[ETH_ALEN]; /* per station */
450 /* Used to get specific STA parameters */
451 struct brcmf_scb_val_le {
456 /* channel encoding */
457 struct brcmf_channel_info_le {
459 __le32 target_channel;
463 struct brcmf_sta_info_le {
464 __le16 ver; /* version of this struct */
465 __le16 len; /* length in bytes of this structure */
466 __le16 cap; /* sta's advertised capabilities */
467 __le32 flags; /* flags defined below */
468 __le32 idle; /* time since data pkt rx'd from sta */
469 u8 ea[ETH_ALEN]; /* Station address */
470 __le32 count; /* # rates in this set */
471 u8 rates[BRCMF_MAXRATES_IN_SET]; /* rates in 500kbps units */
472 /* w/hi bit set if basic */
473 __le32 in; /* seconds elapsed since associated */
474 __le32 listen_interval_inms; /* Min Listen interval in ms for STA */
475 __le32 tx_pkts; /* # of packets transmitted */
476 __le32 tx_failures; /* # of packets failed */
477 __le32 rx_ucast_pkts; /* # of unicast packets received */
478 __le32 rx_mcast_pkts; /* # of multicast packets received */
479 __le32 tx_rate; /* Rate of last successful tx frame */
480 __le32 rx_rate; /* Rate of last successful rx frame */
481 __le32 rx_decrypt_succeeds; /* # of packet decrypted successfully */
482 __le32 rx_decrypt_failures; /* # of packet decrypted failed */
483 __le32 tx_tot_pkts; /* # of tx pkts (ucast + mcast) */
484 __le32 rx_tot_pkts; /* # of data packets recvd (uni + mcast) */
485 __le32 tx_mcast_pkts; /* # of mcast pkts txed */
486 __le64 tx_tot_bytes; /* data bytes txed (ucast + mcast) */
487 __le64 rx_tot_bytes; /* data bytes recvd (ucast + mcast) */
488 __le64 tx_ucast_bytes; /* data bytes txed (ucast) */
489 __le64 tx_mcast_bytes; /* # data bytes txed (mcast) */
490 __le64 rx_ucast_bytes; /* data bytes recvd (ucast) */
491 __le64 rx_mcast_bytes; /* data bytes recvd (mcast) */
492 s8 rssi[BRCMF_ANT_MAX]; /* per antenna rssi */
493 s8 nf[BRCMF_ANT_MAX]; /* per antenna noise floor */
494 __le16 aid; /* association ID */
495 __le16 ht_capabilities; /* advertised ht caps */
496 __le16 vht_flags; /* converted vht flags */
497 __le32 tx_pkts_retry_cnt; /* # of frames where a retry was
500 __le32 tx_pkts_retry_exhausted; /* # of user frames where a retry
503 s8 rx_lastpkt_rssi[BRCMF_ANT_MAX]; /* Per antenna RSSI of last
504 * received data frame.
506 /* TX WLAN retry/failure statistics:
507 * Separated for host requested frames and locally generated frames.
508 * Include unicast frame only where the retries/failures can be counted.
510 __le32 tx_pkts_total; /* # user frames sent successfully */
511 __le32 tx_pkts_retries; /* # user frames retries */
512 __le32 tx_pkts_fw_total; /* # FW generated sent successfully */
513 __le32 tx_pkts_fw_retries; /* # retries for FW generated frames */
514 __le32 tx_pkts_fw_retry_exhausted; /* # FW generated where a retry
517 __le32 rx_pkts_retried; /* # rx with retry bit set */
518 __le32 tx_rate_fallback; /* lowest fallback TX rate */
521 struct brcmf_chanspec_list {
522 __le32 count; /* # of entries */
523 __le32 element[1]; /* variable length uint32 list */
528 * WLC_E_P2P_PROBREQ_MSG
529 * WLC_E_ACTION_FRAME_RX
531 struct brcmf_rx_mgmt_data {
540 * struct brcmf_fil_wowl_pattern_le - wowl pattern configuration struct.
542 * @cmd: "add", "del" or "clr".
543 * @masksize: Size of the mask in #of bytes
544 * @offset: Pattern byte offset in packet
545 * @patternoffset: Offset of start of pattern. Starting from field masksize.
546 * @patternsize: Size of the pattern itself in #of bytes
548 * @reasonsize: Size of the wakeup reason code
549 * @type: Type of pattern (enum brcmf_wowl_pattern_type)
551 struct brcmf_fil_wowl_pattern_le {
555 __le32 patternoffset;
560 /* u8 mask[] - Mask follows the structure above */
561 /* u8 pattern[] - Pattern follows the mask is at 'patternoffset' */
564 struct brcmf_mbss_ssid_le {
567 unsigned char SSID[32];
571 * struct brcmf_fil_country_le - country configuration structure.
573 * @country_abbrev: null-terminated country code used in the country IE.
574 * @rev: revision specifier for ccode. on set, -1 indicates unspecified.
575 * @ccode: null-terminated built-in country code.
577 struct brcmf_fil_country_le {
578 char country_abbrev[BRCMF_COUNTRY_BUF_SZ];
580 char ccode[BRCMF_COUNTRY_BUF_SZ];
584 * struct brcmf_rev_info_le - device revision info.
586 * @vendorid: PCI vendor id.
587 * @deviceid: device id of chip.
588 * @radiorev: radio revision.
589 * @chiprev: chip revision.
590 * @corerev: core revision.
591 * @boardid: board identifier (usu. PCI sub-device id).
592 * @boardvendor: board vendor (usu. PCI sub-vendor id).
593 * @boardrev: board revision.
594 * @driverrev: driver version.
595 * @ucoderev: microcode version.
597 * @chipnum: chip number.
598 * @phytype: phy type.
599 * @phyrev: phy revision.
600 * @anarev: anacore rev.
601 * @chippkg: chip package info.
602 * @nvramrev: nvram revision number.
604 struct brcmf_rev_info_le {
624 #endif /* FWIL_TYPES_H_ */