2 * Broadcom Event protocol definitions
4 * Dependencies: bcmeth.h
6 * Copyright (C) 1999-2019, Broadcom.
8 * Unless you and Broadcom execute a separate written software license
9 * agreement governing use of this software, this software is licensed to you
10 * under the terms of the GNU General Public License version 2 (the "GPL"),
11 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
12 * following added to such license:
14 * As a special exception, the copyright holders of this software give you
15 * permission to link this software with independent modules, and to copy and
16 * distribute the resulting executable under terms of your choice, provided that
17 * you also meet, for each linked independent module, the terms and conditions of
18 * the license of that module. An independent module is a module which is not
19 * derived from this software. The special exception does not apply to any
20 * modifications of the software.
22 * Notwithstanding the above, under no circumstances may you combine this
23 * software in any way with any other Broadcom software provided under a license
24 * other than the GPL, without Broadcom's express prior written consent.
27 * <<Broadcom-WL-IPTag/Open:>>
29 * $Id: bcmevent.h 779385 2018-09-03 17:35:01Z $
34 * Broadcom Ethernet Events protocol defines
42 /* #include <ethernet.h> -- TODO: req., excluded to overwhelming coupling (break up ethernet.h) */
44 #if defined(DNGL_EVENT_SUPPORT)
45 #include <dnglevent.h>
48 /* This marks the start of a packed structure section. */
49 #include <packed_section_start.h>
51 #define BCM_EVENT_MSG_VERSION 2 /* wl_event_msg_t struct version */
52 #define BCM_MSG_IFNAME_MAX 16 /* max length of interface name */
55 #define WLC_EVENT_MSG_LINK 0x01 /* link is up */
56 #define WLC_EVENT_MSG_FLUSHTXQ 0x02 /* flush tx queue on MIC error */
57 #define WLC_EVENT_MSG_GROUP 0x04 /* group MIC error */
58 #define WLC_EVENT_MSG_UNKBSS 0x08 /* unknown source bsscfg */
59 #define WLC_EVENT_MSG_UNKIF 0x10 /* unknown source OS i/f */
61 /* these fields are stored in network order */
64 typedef BWL_PRE_PACKED_STRUCT
struct
67 uint16 flags
; /* see flags below */
68 uint32 event_type
; /* Message (see below) */
69 uint32 status
; /* Status code (see below) */
70 uint32 reason
; /* Reason code (if applicable) */
71 uint32 auth_type
; /* WLC_E_AUTH */
72 uint32 datalen
; /* data buf */
73 struct ether_addr addr
; /* Station address (if applicable) */
74 char ifname
[BCM_MSG_IFNAME_MAX
]; /* name of the packet incoming interface */
75 } BWL_POST_PACKED_STRUCT wl_event_msg_v1_t
;
77 /* the current version */
78 typedef BWL_PRE_PACKED_STRUCT
struct
81 uint16 flags
; /* see flags below */
82 uint32 event_type
; /* Message (see below) */
83 uint32 status
; /* Status code (see below) */
84 uint32 reason
; /* Reason code (if applicable) */
85 uint32 auth_type
; /* WLC_E_AUTH */
86 uint32 datalen
; /* data buf */
87 struct ether_addr addr
; /* Station address (if applicable) */
88 char ifname
[BCM_MSG_IFNAME_MAX
]; /* name of the packet incoming interface */
89 uint8 ifidx
; /* destination OS i/f index */
90 uint8 bsscfgidx
; /* source bsscfg index */
91 } BWL_POST_PACKED_STRUCT wl_event_msg_t
;
93 /* used by driver msgs */
94 typedef BWL_PRE_PACKED_STRUCT
struct bcm_event
{
95 struct ether_header eth
;
98 /* data portion follows */
99 } BWL_POST_PACKED_STRUCT bcm_event_t
;
103 * note: if additional event types are added, it should go with is_wlc_event_frame() as well.
105 typedef union bcm_event_msg_u
{
106 wl_event_msg_t event
;
107 #if defined(DNGL_EVENT_SUPPORT)
108 bcm_dngl_event_msg_t dngl_event
;
111 /* add new event here */
114 #define BCM_MSG_LEN (sizeof(bcm_event_t) - sizeof(bcmeth_hdr_t) - sizeof(struct ether_header))
117 #define WLC_E_SET_SSID 0 /* indicates status of set SSID */
118 #define WLC_E_JOIN 1 /* differentiates join IBSS from found (WLC_E_START) IBSS */
119 #define WLC_E_START 2 /* STA founded an IBSS or AP started a BSS */
120 #define WLC_E_AUTH 3 /* 802.11 AUTH request */
121 #define WLC_E_AUTH_IND 4 /* 802.11 AUTH indication */
122 #define WLC_E_DEAUTH 5 /* 802.11 DEAUTH request */
123 #define WLC_E_DEAUTH_IND 6 /* 802.11 DEAUTH indication */
124 #define WLC_E_ASSOC 7 /* 802.11 ASSOC request */
125 #define WLC_E_ASSOC_IND 8 /* 802.11 ASSOC indication */
126 #define WLC_E_REASSOC 9 /* 802.11 REASSOC request */
127 #define WLC_E_REASSOC_IND 10 /* 802.11 REASSOC indication */
128 #define WLC_E_DISASSOC 11 /* 802.11 DISASSOC request */
129 #define WLC_E_DISASSOC_IND 12 /* 802.11 DISASSOC indication */
130 #define WLC_E_QUIET_START 13 /* 802.11h Quiet period started */
131 #define WLC_E_QUIET_END 14 /* 802.11h Quiet period ended */
132 #define WLC_E_BEACON_RX 15 /* BEACONS received/lost indication */
133 #define WLC_E_LINK 16 /* generic link indication */
134 #define WLC_E_MIC_ERROR 17 /* TKIP MIC error occurred */
135 #define WLC_E_NDIS_LINK 18 /* NDIS style link indication */
136 #define WLC_E_ROAM 19 /* roam complete: indicate status & reason */
137 #define WLC_E_TXFAIL 20 /* change in dot11FailedCount (txfail) */
138 #define WLC_E_PMKID_CACHE 21 /* WPA2 pmkid cache indication */
139 #define WLC_E_RETROGRADE_TSF 22 /* current AP's TSF value went backward */
140 #define WLC_E_PRUNE 23 /* AP was pruned from join list for reason */
141 #define WLC_E_AUTOAUTH 24 /* report AutoAuth table entry match for join attempt */
142 #define WLC_E_EAPOL_MSG 25 /* Event encapsulating an EAPOL message */
143 #define WLC_E_SCAN_COMPLETE 26 /* Scan results are ready or scan was aborted */
144 #define WLC_E_ADDTS_IND 27 /* indicate to host addts fail/success */
145 #define WLC_E_DELTS_IND 28 /* indicate to host delts fail/success */
146 #define WLC_E_BCNSENT_IND 29 /* indicate to host of beacon transmit */
147 #define WLC_E_BCNRX_MSG 30 /* Send the received beacon up to the host */
148 #define WLC_E_BCNLOST_MSG 31 /* indicate to host loss of beacon */
149 #define WLC_E_ROAM_PREP 32 /* before attempting to roam association */
150 #define WLC_E_PFN_NET_FOUND 33 /* PFN network found event */
151 #define WLC_E_PFN_NET_LOST 34 /* PFN network lost event */
152 #define WLC_E_RESET_COMPLETE 35
153 #define WLC_E_JOIN_START 36
154 #define WLC_E_ROAM_START 37 /* roam attempt started: indicate reason */
155 #define WLC_E_ASSOC_START 38
156 #define WLC_E_IBSS_ASSOC 39
157 #define WLC_E_RADIO 40
158 #define WLC_E_PSM_WATCHDOG 41 /* PSM microcode watchdog fired */
160 #define WLC_E_PROBREQ_MSG 44 /* probe request received */
161 #define WLC_E_SCAN_CONFIRM_IND 45
162 #define WLC_E_PSK_SUP 46 /* WPA Handshake fail */
163 #define WLC_E_COUNTRY_CODE_CHANGED 47
164 #define WLC_E_EXCEEDED_MEDIUM_TIME 48 /* WMMAC excedded medium time */
165 #define WLC_E_ICV_ERROR 49 /* WEP ICV error occurred */
166 #define WLC_E_UNICAST_DECODE_ERROR 50 /* Unsupported unicast encrypted frame */
167 #define WLC_E_MULTICAST_DECODE_ERROR 51 /* Unsupported multicast encrypted frame */
168 #define WLC_E_TRACE 52
169 #define WLC_E_IF 54 /* I/F change (for dongle host notification) */
170 #define WLC_E_P2P_DISC_LISTEN_COMPLETE 55 /* listen state expires */
171 #define WLC_E_RSSI 56 /* indicate RSSI change based on configured levels */
172 #define WLC_E_PFN_BEST_BATCHING 57 /* PFN best network batching event */
173 #define WLC_E_EXTLOG_MSG 58
174 #define WLC_E_ACTION_FRAME 59 /* Action frame Rx */
175 #define WLC_E_ACTION_FRAME_COMPLETE 60 /* Action frame Tx complete */
176 #define WLC_E_PRE_ASSOC_IND 61 /* assoc request received */
177 #define WLC_E_PRE_REASSOC_IND 62 /* re-assoc request received */
178 #define WLC_E_CHANNEL_ADOPTED 63
179 #define WLC_E_AP_STARTED 64 /* AP started */
180 #define WLC_E_DFS_AP_STOP 65 /* AP stopped due to DFS */
181 #define WLC_E_DFS_AP_RESUME 66 /* AP resumed due to DFS */
182 #define WLC_E_WAI_STA_EVENT 67 /* WAI stations event */
183 #define WLC_E_WAI_MSG 68 /* event encapsulating an WAI message */
184 #define WLC_E_ESCAN_RESULT 69 /* escan result event */
185 #define WLC_E_ACTION_FRAME_OFF_CHAN_COMPLETE 70 /* action frame off channel complete */
186 #define WLC_E_PROBRESP_MSG 71 /* probe response received */
187 #define WLC_E_P2P_PROBREQ_MSG 72 /* P2P Probe request received */
188 #define WLC_E_DCS_REQUEST 73
189 #define WLC_E_FIFO_CREDIT_MAP 74 /* credits for D11 FIFOs. [AC0,AC1,AC2,AC3,BC_MC,ATIM] */
190 #define WLC_E_ACTION_FRAME_RX 75 /* Received action frame event WITH
191 * wl_event_rx_frame_data_t header
193 #define WLC_E_WAKE_EVENT 76 /* Wake Event timer fired, used for wake WLAN test mode */
194 #define WLC_E_RM_COMPLETE 77 /* Radio measurement complete */
195 #define WLC_E_HTSFSYNC 78 /* Synchronize TSF with the host */
196 #define WLC_E_OVERLAY_REQ 79 /* request an overlay IOCTL/iovar from the host */
197 #define WLC_E_CSA_COMPLETE_IND 80 /* 802.11 CHANNEL SWITCH ACTION completed */
198 #define WLC_E_EXCESS_PM_WAKE_EVENT 81 /* excess PM Wake Event to inform host */
199 #define WLC_E_PFN_SCAN_NONE 82 /* no PFN networks around */
200 /* PFN BSSID network found event, conflict/share with WLC_E_PFN_SCAN_NONE */
201 #define WLC_E_PFN_BSSID_NET_FOUND 82
202 #define WLC_E_PFN_SCAN_ALLGONE 83 /* last found PFN network gets lost */
203 /* PFN BSSID network lost event, conflict/share with WLC_E_PFN_SCAN_ALLGONE */
204 #define WLC_E_PFN_BSSID_NET_LOST 83
205 #define WLC_E_GTK_PLUMBED 84
206 #define WLC_E_ASSOC_IND_NDIS 85 /* 802.11 ASSOC indication for NDIS only */
207 #define WLC_E_REASSOC_IND_NDIS 86 /* 802.11 REASSOC indication for NDIS only */
208 #define WLC_E_ASSOC_REQ_IE 87
209 #define WLC_E_ASSOC_RESP_IE 88
210 #define WLC_E_ASSOC_RECREATED 89 /* association recreated on resume */
211 #define WLC_E_ACTION_FRAME_RX_NDIS 90 /* rx action frame event for NDIS only */
212 #define WLC_E_AUTH_REQ 91 /* authentication request received */
213 #define WLC_E_TDLS_PEER_EVENT 92 /* discovered peer, connected/disconnected peer */
214 #define WLC_E_SPEEDY_RECREATE_FAIL 93 /* fast assoc recreation failed */
215 #define WLC_E_NATIVE 94 /* port-specific event and payload (e.g. NDIS) */
216 #define WLC_E_PKTDELAY_IND 95 /* event for tx pkt delay suddently jump */
217 #define WLC_E_PSTA_PRIMARY_INTF_IND 99 /* psta primary interface indication */
218 #define WLC_E_NAN 100 /* NAN event - Reserved for future */
219 #define WLC_E_BEACON_FRAME_RX 101
220 #define WLC_E_SERVICE_FOUND 102 /* desired service found */
221 #define WLC_E_GAS_FRAGMENT_RX 103 /* GAS fragment received */
222 #define WLC_E_GAS_COMPLETE 104 /* GAS sessions all complete */
223 #define WLC_E_P2PO_ADD_DEVICE 105 /* New device found by p2p offload */
224 #define WLC_E_P2PO_DEL_DEVICE 106 /* device has been removed by p2p offload */
225 #define WLC_E_WNM_STA_SLEEP 107 /* WNM event to notify STA enter sleep mode */
226 #define WLC_E_TXFAIL_THRESH 108 /* Indication of MAC tx failures (exhaustion of
227 * 802.11 retries) exceeding threshold(s)
229 #define WLC_E_PROXD 109 /* Proximity Detection event */
230 #define WLC_E_IBSS_COALESCE 110 /* IBSS Coalescing */
231 #define WLC_E_AIBSS_TXFAIL 110 /* TXFAIL event for AIBSS, re using event 110 */
232 #define WLC_E_BSS_LOAD 114 /* Inform host of beacon bss load */
233 #define WLC_E_MIMO_PWR_SAVE 115 /* Inform host MIMO PWR SAVE learning events */
234 #define WLC_E_LEAKY_AP_STATS 116 /* Inform host leaky Ap stats events */
235 #define WLC_E_ALLOW_CREDIT_BORROW 117 /* Allow or disallow wlfc credit borrowing in DHD */
236 #define WLC_E_MSCH 120 /* Multiple channel scheduler event */
237 #define WLC_E_CSA_START_IND 121
238 #define WLC_E_CSA_DONE_IND 122
239 #define WLC_E_CSA_FAILURE_IND 123
240 #define WLC_E_CCA_CHAN_QUAL 124 /* CCA based channel quality report */
241 #define WLC_E_BSSID 125 /* to report change in BSSID while roaming */
242 #define WLC_E_TX_STAT_ERROR 126 /* tx error indication */
243 #define WLC_E_BCMC_CREDIT_SUPPORT 127 /* credit check for BCMC supported */
244 #define WLC_E_PEER_TIMEOUT 128 /* silently drop a STA because of inactivity */
245 #define WLC_E_BT_WIFI_HANDOVER_REQ 130 /* Handover Request Initiated */
246 #define WLC_E_SPW_TXINHIBIT 131 /* Southpaw TxInhibit notification */
247 #define WLC_E_FBT_AUTH_REQ_IND 132 /* FBT Authentication Request Indication */
248 #define WLC_E_RSSI_LQM 133 /* Enhancement addition for WLC_E_RSSI */
249 #define WLC_E_PFN_GSCAN_FULL_RESULT 134 /* Full probe/beacon (IEs etc) results */
250 #define WLC_E_PFN_SWC 135 /* Significant change in rssi of bssids being tracked */
251 #define WLC_E_AUTHORIZED 136 /* a STA been authroized for traffic */
252 #define WLC_E_PROBREQ_MSG_RX 137 /* probe req with wl_event_rx_frame_data_t header */
253 #define WLC_E_PFN_SCAN_COMPLETE 138 /* PFN completed scan of network list */
254 #define WLC_E_RMC_EVENT 139 /* RMC Event */
255 #define WLC_E_DPSTA_INTF_IND 140 /* DPSTA interface indication */
256 #define WLC_E_RRM 141 /* RRM Event */
257 #define WLC_E_PFN_SSID_EXT 142 /* SSID EXT event */
258 #define WLC_E_ROAM_EXP_EVENT 143 /* Expanded roam event */
259 #define WLC_E_ULP 146 /* ULP entered indication */
260 #define WLC_E_MACDBG 147 /* Ucode debugging event */
261 #define WLC_E_RESERVED 148 /* reserved */
262 #define WLC_E_PRE_ASSOC_RSEP_IND 149 /* assoc resp received */
263 #define WLC_E_PSK_AUTH 150 /* PSK AUTH WPA2-PSK 4 WAY Handshake failure */
264 #define WLC_E_TKO 151 /* TCP keepalive offload */
265 #define WLC_E_SDB_TRANSITION 152 /* SDB mode-switch event */
266 #define WLC_E_NATOE_NFCT 153 /* natoe event */
267 #define WLC_E_TEMP_THROTTLE 154 /* Temperature throttling control event */
268 #define WLC_E_LINK_QUALITY 155 /* Link quality measurement complete */
269 #define WLC_E_BSSTRANS_RESP 156 /* BSS Transition Response received */
270 #define WLC_E_TWT_SETUP 157 /* TWT Setup Complete event */
271 #define WLC_E_HE_TWT_SETUP 157 /* TODO:Remove after merging TWT changes to trunk */
272 #define WLC_E_NAN_CRITICAL 158 /* NAN Critical Event */
273 #define WLC_E_NAN_NON_CRITICAL 159 /* NAN Non-Critical Event */
274 #define WLC_E_RADAR_DETECTED 160 /* Radar Detected event */
275 #define WLC_E_RANGING_EVENT 161 /* Ranging event */
276 #define WLC_E_INVALID_IE 162 /* Received invalid IE */
277 #define WLC_E_MODE_SWITCH 163 /* Mode switch event */
278 #define WLC_E_PKT_FILTER 164 /* Packet filter event */
279 #define WLC_E_DMA_TXFLUSH_COMPLETE 165 /* TxFlush done before changing
282 #define WLC_E_FBT 166 /* FBT event */
283 #define WLC_E_PFN_SCAN_BACKOFF 167 /* PFN SCAN Backoff event */
284 #define WLC_E_PFN_BSSID_SCAN_BACKOFF 168 /* PFN BSSID SCAN BAckoff event */
285 #define WLC_E_AGGR_EVENT 169 /* Aggregated event */
286 #define WLC_E_TVPM_MITIGATION 171 /* Change in mitigation applied by TVPM */
287 #define WLC_E_SCAN_START 172 /* Deprecated */
288 #define WLC_E_SCAN 172 /* Scan event */
289 #define WLC_E_MBO 173 /* MBO event */
290 #define WLC_E_PHY_CAL 174 /* Phy calibration start indication to host */
291 #define WLC_E_RPSNOA 175 /* Radio power save start/end indication to host */
292 #define WLC_E_ADPS 176 /* ADPS event */
293 #define WLC_E_SLOTTED_BSS_PEER_OP 177 /* Per peer SCB delete */
294 #define WLC_E_HWA 178 /* HWA events */
295 #define WLC_E_GTK_KEYROT_NO_CHANSW 179 /* Avoid Chanswitch while GTK key rotation */
296 #define WLC_E_ONBODY_STATUS_CHANGE 180 /* Indication of onbody status change */
297 #define WLC_E_BCNRECV_ABORTED 181 /* Fake AP bcnrecv aborted roam event */
298 #define WLC_E_LAST 182 /* highest val + 1 for range checking */
299 #if (WLC_E_LAST > 182)
300 #error "WLC_E_LAST: Invalid value for last event; must be <= 182."
301 #endif /* WLC_E_LAST */
303 /* define an API for getting the string name of an event */
304 extern const char *bcmevent_get_name(uint event_type
);
305 extern void wl_event_to_host_order(wl_event_msg_t
* evt
);
306 extern void wl_event_to_network_order(wl_event_msg_t
* evt
);
308 /* validate if the event is proper and if valid copy event header to event */
309 extern int is_wlc_event_frame(void *pktdata
, uint pktlen
, uint16 exp_usr_subtype
,
310 bcm_event_msg_u_t
*out_event
);
312 /* conversion between host and network order for events */
313 void wl_event_to_host_order(wl_event_msg_t
* evt
);
314 void wl_event_to_network_order(wl_event_msg_t
* evt
);
316 /* Event status codes */
317 #define WLC_E_STATUS_SUCCESS 0 /* operation was successful */
318 #define WLC_E_STATUS_FAIL 1 /* operation failed */
319 #define WLC_E_STATUS_TIMEOUT 2 /* operation timed out */
320 #define WLC_E_STATUS_NO_NETWORKS 3 /* failed due to no matching network found */
321 #define WLC_E_STATUS_ABORT 4 /* operation was aborted */
322 #define WLC_E_STATUS_NO_ACK 5 /* protocol failure: packet not ack'd */
323 #define WLC_E_STATUS_UNSOLICITED 6 /* AUTH or ASSOC packet was unsolicited */
324 #define WLC_E_STATUS_ATTEMPT 7 /* attempt to assoc to an auto auth configuration */
325 #define WLC_E_STATUS_PARTIAL 8 /* scan results are incomplete */
326 #define WLC_E_STATUS_NEWSCAN 9 /* scan aborted by another scan */
327 #define WLC_E_STATUS_NEWASSOC 10 /* scan aborted due to assoc in progress */
328 #define WLC_E_STATUS_11HQUIET 11 /* 802.11h quiet period started */
329 #define WLC_E_STATUS_SUPPRESS 12 /* user disabled scanning (WLC_SET_SCANSUPPRESS) */
330 #define WLC_E_STATUS_NOCHANS 13 /* no allowable channels to scan */
332 #define WLC_E_STATUS_CCXFASTRM 14 /* scan aborted due to CCX fast roam */
334 #define WLC_E_STATUS_CS_ABORT 15 /* abort channel select */
335 #define WLC_E_STATUS_ERROR 16 /* request failed due to error */
336 #define WLC_E_STATUS_SLOTTED_PEER_ADD 17 /* Slotted scb for peer addition status */
337 #define WLC_E_STATUS_SLOTTED_PEER_DEL 18 /* Slotted scb for peer deletion status */
338 #define WLC_E_STATUS_RXBCN 19 /* Rx Beacon event for FAKEAP feature */
339 #define WLC_E_STATUS_RXBCN_ABORT 20 /* Rx Beacon abort event for FAKEAP feature */
340 #define WLC_E_STATUS_INVALID 0xff /* Invalid status code to init variables. */
342 /* 4-way handshake event type */
343 #define WLC_E_PSK_AUTH_SUB_EAPOL_START 1 /* EAPOL start */
344 #define WLC_E_PSK_AUTH_SUB_EAPOL_DONE 2 /* EAPOL end */
346 #define WLC_E_PSK_AUTH_SUB_GTK_DONE 3 /* GTK end */
348 /* 4-way handshake event status code */
349 #define WLC_E_STATUS_PSK_AUTH_WPA_TIMOUT 1 /* operation timed out */
350 #define WLC_E_STATUS_PSK_AUTH_MIC_WPA_ERR 2 /* MIC error */
351 #define WLC_E_STATUS_PSK_AUTH_IE_MISMATCH_ERR 3 /* IE Missmatch error */
352 #define WLC_E_STATUS_PSK_AUTH_REPLAY_COUNT_ERR 4
353 #define WLC_E_STATUS_PSK_AUTH_PEER_BLACKISTED 5 /* Blaclisted peer */
354 #define WLC_E_STATUS_PSK_AUTH_GTK_REKEY_FAIL 6 /* GTK event status code */
356 /* SDB transition status code */
357 #define WLC_E_STATUS_SDB_START 1
358 #define WLC_E_STATUS_SDB_COMPLETE 2
359 /* Slice-swap status code */
360 #define WLC_E_STATUS_SLICE_SWAP_START 3
361 #define WLC_E_STATUS_SLICE_SWAP_COMPLETE 4
363 /* SDB transition reason code */
364 #define WLC_E_REASON_HOST_DIRECT 0
365 #define WLC_E_REASON_INFRA_ASSOC 1
366 #define WLC_E_REASON_INFRA_ROAM 2
367 #define WLC_E_REASON_INFRA_DISASSOC 3
368 #define WLC_E_REASON_NO_MODE_CHANGE_NEEDED 4
369 #define WLC_E_REASON_AWDL_ENABLE 5
370 #define WLC_E_REASON_AWDL_DISABLE 6
372 /* WLC_E_SDB_TRANSITION event data */
373 #define WL_MAX_BSSCFG 4
374 #define WL_EVENT_SDB_TRANSITION_VER 1
375 typedef struct wl_event_sdb_data
{
376 uint8 wlunit
; /* Core index */
377 uint8 is_iftype
; /* Interface Type(Station, SoftAP, P2P_GO, P2P_GC */
378 uint16 chanspec
; /* Interface Channel/Chanspec */
379 char ssidbuf
[(4 * 32) + 1]; /* SSID_FMT_BUF_LEN: ((4 * DOT11_MAX_SSID_LEN) + 1) */
380 } wl_event_sdb_data_t
;
382 typedef struct wl_event_sdb_trans
{
383 uint8 version
; /* Event Data Version */
387 struct wl_event_sdb_data values
[WL_MAX_BSSCFG
];
388 } wl_event_sdb_trans_t
;
390 /* reason codes for WLC_E_GTK_KEYROT_NO_CHANSW event */
391 #define WLC_E_GTKKEYROT_SCANDELAY 0 /* Delay scan while gtk in progress */
392 #define WLC_E_GTKKEYROT_SKIPCHANSW_AWDL 1 /* Avoid chansw by awdl while gtk in progress */
393 #define WLC_E_GTKKEYROT_SKIPCHANSW_P2P 2 /* Avoid chansw by p2p while gtk in progress */
395 /* roam reason codes */
396 #define WLC_E_REASON_INITIAL_ASSOC 0 /* initial assoc */
397 #define WLC_E_REASON_LOW_RSSI 1 /* roamed due to low RSSI */
398 #define WLC_E_REASON_DEAUTH 2 /* roamed due to DEAUTH indication */
399 #define WLC_E_REASON_DISASSOC 3 /* roamed due to DISASSOC indication */
400 #define WLC_E_REASON_BCNS_LOST 4 /* roamed due to lost beacons */
402 #define WLC_E_REASON_FAST_ROAM_FAILED 5 /* roamed due to fast roam failure */
403 #define WLC_E_REASON_DIRECTED_ROAM 6 /* roamed due to request by AP */
404 #define WLC_E_REASON_TSPEC_REJECTED 7 /* roamed due to TSPEC rejection */
405 #define WLC_E_REASON_BETTER_AP 8 /* roamed due to finding better AP */
406 #define WLC_E_REASON_MINTXRATE 9 /* roamed because at mintxrate for too long */
407 #define WLC_E_REASON_TXFAIL 10 /* We can hear AP, but AP can't hear us */
408 /* retained for precommit auto-merging errors; remove once all branches are synced */
409 #define WLC_E_REASON_REQUESTED_ROAM 11
410 #define WLC_E_REASON_BSSTRANS_REQ 11 /* roamed due to BSS Transition request by AP */
411 #define WLC_E_REASON_LOW_RSSI_CU 12 /* roamed due to low RSSI and Channel Usage */
412 #define WLC_E_REASON_RADAR_DETECTED 13 /* roamed due to radar detection by STA */
413 #define WLC_E_REASON_CSA 14 /* roamed due to CSA from AP */
414 #define WLC_E_REASON_ESTM_LOW 15 /* roamed due to ESTM low tput */
415 #define WLC_E_REASON_LAST 16 /* NOTE: increment this as you add reasons above */
417 /* prune reason codes */
418 #define WLC_E_PRUNE_ENCR_MISMATCH 1 /* encryption mismatch */
419 #define WLC_E_PRUNE_BCAST_BSSID 2 /* AP uses a broadcast BSSID */
420 #define WLC_E_PRUNE_MAC_DENY 3 /* STA's MAC addr is in AP's MAC deny list */
421 #define WLC_E_PRUNE_MAC_NA 4 /* STA's MAC addr is not in AP's MAC allow list */
422 #define WLC_E_PRUNE_REG_PASSV 5 /* AP not allowed due to regulatory restriction */
423 #define WLC_E_PRUNE_SPCT_MGMT 6 /* AP does not support STA locale spectrum mgmt */
424 #define WLC_E_PRUNE_RADAR 7 /* AP is on a radar channel of STA locale */
425 #define WLC_E_RSN_MISMATCH 8 /* STA does not support AP's RSN */
426 #define WLC_E_PRUNE_NO_COMMON_RATES 9 /* No rates in common with AP */
427 #define WLC_E_PRUNE_BASIC_RATES 10 /* STA does not support all basic rates of BSS */
429 #define WLC_E_PRUNE_CCXFAST_PREVAP 11 /* CCX FAST ROAM: prune previous AP */
430 #endif /* def BCMCCX */
431 #define WLC_E_PRUNE_CIPHER_NA 12 /* BSS's cipher not supported */
432 #define WLC_E_PRUNE_KNOWN_STA 13 /* AP is already known to us as a STA */
434 #define WLC_E_PRUNE_CCXFAST_DROAM 14 /* CCX FAST ROAM: prune unqualified AP */
435 #endif /* def BCMCCX */
436 #define WLC_E_PRUNE_WDS_PEER 15 /* AP is already known to us as a WDS peer */
437 #define WLC_E_PRUNE_QBSS_LOAD 16 /* QBSS LOAD - AAC is too low */
438 #define WLC_E_PRUNE_HOME_AP 17 /* prune home AP */
440 #define WLC_E_PRUNE_AP_BLOCKED 18 /* prune blocked AP */
441 #define WLC_E_PRUNE_NO_DIAG_SUPPORT 19 /* prune due to diagnostic mode not supported */
443 #define WLC_E_PRUNE_AUTH_RESP_MAC 20 /* suppress auth resp by MAC filter */
444 #define WLC_E_PRUNE_ASSOC_RETRY_DELAY 21 /* MBO assoc retry delay */
445 #define WLC_E_PRUNE_RSSI_ASSOC_REJ 22 /* OCE RSSI-based assoc rejection */
447 /* WPA failure reason codes carried in the WLC_E_PSK_SUP event */
448 #define WLC_E_SUP_OTHER 0 /* Other reason */
449 #define WLC_E_SUP_DECRYPT_KEY_DATA 1 /* Decryption of key data failed */
450 #define WLC_E_SUP_BAD_UCAST_WEP128 2 /* Illegal use of ucast WEP128 */
451 #define WLC_E_SUP_BAD_UCAST_WEP40 3 /* Illegal use of ucast WEP40 */
452 #define WLC_E_SUP_UNSUP_KEY_LEN 4 /* Unsupported key length */
453 #define WLC_E_SUP_PW_KEY_CIPHER 5 /* Unicast cipher mismatch in pairwise key */
454 #define WLC_E_SUP_MSG3_TOO_MANY_IE 6 /* WPA IE contains > 1 RSN IE in key msg 3 */
455 #define WLC_E_SUP_MSG3_IE_MISMATCH 7 /* WPA IE mismatch in key message 3 */
456 #define WLC_E_SUP_NO_INSTALL_FLAG 8 /* INSTALL flag unset in 4-way msg */
457 #define WLC_E_SUP_MSG3_NO_GTK 9 /* encapsulated GTK missing from msg 3 */
458 #define WLC_E_SUP_GRP_KEY_CIPHER 10 /* Multicast cipher mismatch in group key */
459 #define WLC_E_SUP_GRP_MSG1_NO_GTK 11 /* encapsulated GTK missing from group msg 1 */
460 #define WLC_E_SUP_GTK_DECRYPT_FAIL 12 /* GTK decrypt failure */
461 #define WLC_E_SUP_SEND_FAIL 13 /* message send failure */
462 #define WLC_E_SUP_DEAUTH 14 /* received FC_DEAUTH */
463 #define WLC_E_SUP_WPA_PSK_TMO 15 /* WPA PSK 4-way handshake timeout */
464 #define WLC_E_SUP_WPA_PSK_M1_TMO 16 /* WPA PSK 4-way handshake M1 timeout */
465 #define WLC_E_SUP_WPA_PSK_M3_TMO 17 /* WPA PSK 4-way handshake M3 timeout */
466 #define WLC_E_SUP_GTK_UPDATE_FAIL 18 /* GTK update failure */
467 #define WLC_E_SUP_TK_UPDATE_FAIL 19 /* TK update failure */
468 #define WLC_E_SUP_KEY_INSTALL_FAIL 20 /* Buffered key install failure */
470 /* Ucode reason codes carried in the WLC_E_MACDBG event */
471 #define WLC_E_MACDBG_LIST_PSM 0 /* Dump list update for PSM registers */
472 #define WLC_E_MACDBG_LIST_PSMX 1 /* Dump list update for PSMx registers */
473 #define WLC_E_MACDBG_REGALL 2 /* Dump all registers */
475 /* Event data for events that include frames received over the air */
476 /* WLC_E_PROBRESP_MSG
477 * WLC_E_P2P_PROBREQ_MSG
478 * WLC_E_ACTION_FRAME_RX
481 #define MAX_PHY_CORE_NUM 4u
483 #define BCM_RX_FRAME_DATA_VERSION_2 2u
485 typedef BWL_PRE_PACKED_STRUCT
struct wl_event_rx_frame_data_v2
{
488 uint16 channel
; /* Matches chanspec_t format from bcmwifi_channels.h */
493 int8 per_core_rssi
[MAX_PHY_CORE_NUM
];
494 } BWL_POST_PACKED_STRUCT wl_event_rx_frame_data_v2_t
;
496 typedef BWL_PRE_PACKED_STRUCT
struct wl_event_rx_frame_data_v1
{
498 uint16 channel
; /* Matches chanspec_t format from bcmwifi_channels.h */
502 } BWL_POST_PACKED_STRUCT wl_event_rx_frame_data_v1_t
;
504 #define BCM_RX_FRAME_DATA_VERSION_1 1u
506 #ifndef WL_EVENT_RX_FRAME_DATA_ALIAS
507 #define BCM_RX_FRAME_DATA_VERSION BCM_RX_FRAME_DATA_VERSION_1
508 typedef wl_event_rx_frame_data_v1_t wl_event_rx_frame_data_t
;
511 /* WLC_E_IF event data */
512 typedef struct wl_event_data_if
{
513 uint8 ifidx
; /* RTE virtual device index (for dongle) */
514 uint8 opcode
; /* see I/F opcode */
515 uint8 reserved
; /* bit mask (WLC_E_IF_FLAGS_XXX ) */
516 uint8 bssidx
; /* bsscfg index */
517 uint8 role
; /* see I/F role */
518 } wl_event_data_if_t
;
520 /* WLC_E_NATOE event data */
521 typedef struct wl_event_data_natoe
{
526 } wl_event_data_natoe_t
;
528 /* opcode in WLC_E_IF event */
529 #define WLC_E_IF_ADD 1 /* bsscfg add */
530 #define WLC_E_IF_DEL 2 /* bsscfg delete */
531 #define WLC_E_IF_CHANGE 3 /* bsscfg role change */
533 /* I/F role code in WLC_E_IF event */
534 #define WLC_E_IF_ROLE_STA 0 /* Infra STA */
535 #define WLC_E_IF_ROLE_AP 1 /* Access Point */
536 #define WLC_E_IF_ROLE_WDS 2 /* WDS link */
537 #define WLC_E_IF_ROLE_P2P_GO 3 /* P2P Group Owner */
538 #define WLC_E_IF_ROLE_P2P_CLIENT 4 /* P2P Client */
539 #define WLC_E_IF_ROLE_IBSS 8 /* IBSS */
540 #define WLC_E_IF_ROLE_NAN 9 /* NAN */
542 /* WLC_E_RSSI event data */
543 typedef struct wl_event_data_rssi
{
547 } wl_event_data_rssi_t
;
550 #define WLC_E_IF_FLAGS_BSSCFG_NOIF 0x1 /* no host I/F creation needed */
552 /* Reason codes for LINK */
553 #define WLC_E_LINK_BCN_LOSS 1 /* Link down because of beacon loss */
554 #define WLC_E_LINK_DISASSOC 2 /* Link down because of disassoc */
555 #define WLC_E_LINK_ASSOC_REC 3 /* Link down because assoc recreate failed */
556 #define WLC_E_LINK_BSSCFG_DIS 4 /* Link down due to bsscfg down */
558 /* WLC_E_NDIS_LINK event data */
559 typedef BWL_PRE_PACKED_STRUCT
struct ndis_link_parms
{
560 struct ether_addr peer_mac
; /* 6 bytes */
561 uint16 chanspec
; /* 2 bytes */
562 uint32 link_speed
; /* current datarate in units of 500 Kbit/s */
563 uint32 max_link_speed
; /* max possible datarate for link in units of 500 Kbit/s */
564 int32 rssi
; /* average rssi */
565 } BWL_POST_PACKED_STRUCT ndis_link_parms_t
;
567 /* reason codes for WLC_E_OVERLAY_REQ event */
568 #define WLC_E_OVL_DOWNLOAD 0 /* overlay download request */
569 #define WLC_E_OVL_UPDATE_IND 1 /* device indication of host overlay update */
571 /* reason codes for WLC_E_TDLS_PEER_EVENT event */
572 #define WLC_E_TDLS_PEER_DISCOVERED 0 /* peer is ready to establish TDLS */
573 #define WLC_E_TDLS_PEER_CONNECTED 1
574 #define WLC_E_TDLS_PEER_DISCONNECTED 2
576 /* reason codes for WLC_E_RMC_EVENT event */
577 #define WLC_E_REASON_RMC_NONE 0
578 #define WLC_E_REASON_RMC_AR_LOST 1
579 #define WLC_E_REASON_RMC_AR_NO_ACK 2
582 /* TDLS Action Category code */
583 #define TDLS_AF_CATEGORY 12
584 /* Wi-Fi Display (WFD) Vendor Specific Category */
585 /* used for WFD Tunneled Probe Request and Response */
586 #define TDLS_VENDOR_SPECIFIC 127
587 /* TDLS Action Field Values */
588 #define TDLS_ACTION_SETUP_REQ 0
589 #define TDLS_ACTION_SETUP_RESP 1
590 #define TDLS_ACTION_SETUP_CONFIRM 2
591 #define TDLS_ACTION_TEARDOWN 3
592 #define WLAN_TDLS_SET_PROBE_WFD_IE 11
593 #define WLAN_TDLS_SET_SETUP_WFD_IE 12
594 #define WLAN_TDLS_SET_WFD_ENABLED 13
595 #define WLAN_TDLS_SET_WFD_DISABLED 14
598 /* WLC_E_RANGING_EVENT subtypes */
599 #define WLC_E_RANGING_RESULTS 0
601 #define PHY_CAL_EVT_VERSION 1
602 typedef struct wlc_phy_cal_info
{
603 uint16 version
; /* structure version */
604 uint16 length
; /* length of the rest of the structure - pad */
611 } wlc_phy_cal_info_t
;
614 typedef BWL_PRE_PACKED_STRUCT
struct wl_event_gas
{
615 uint16 channel
; /* channel of GAS protocol */
616 uint8 dialog_token
; /* GAS dialog token */
617 uint8 fragment_id
; /* fragment id */
618 uint16 status_code
; /* status code on GAS completion */
619 uint16 data_len
; /* length of data to follow */
620 uint8 data
[1]; /* variable length specified by data_len */
621 } BWL_POST_PACKED_STRUCT wl_event_gas_t
;
623 /* service discovery TLV */
624 typedef BWL_PRE_PACKED_STRUCT
struct wl_sd_tlv
{
625 uint16 length
; /* length of response_data */
626 uint8 protocol
; /* service protocol type */
627 uint8 transaction_id
; /* service transaction id */
628 uint8 status_code
; /* status code */
629 uint8 data
[1]; /* response data */
630 } BWL_POST_PACKED_STRUCT wl_sd_tlv_t
;
632 /* service discovery event data */
633 typedef BWL_PRE_PACKED_STRUCT
struct wl_event_sd
{
634 uint16 channel
; /* channel */
635 uint8 count
; /* number of tlvs */
636 wl_sd_tlv_t tlv
[1]; /* service discovery TLV */
637 } BWL_POST_PACKED_STRUCT wl_event_sd_t
;
639 /* WLC_E_PKT_FILTER event sub-classification codes */
640 #define WLC_E_PKT_FILTER_TIMEOUT 1 /* Matching packet not received in last timeout seconds */
642 /* Note: proxd has a new API (ver 3.0) deprecates the following */
644 /* Reason codes for WLC_E_PROXD */
645 #define WLC_E_PROXD_FOUND 1 /* Found a proximity device */
646 #define WLC_E_PROXD_GONE 2 /* Lost a proximity device */
647 #define WLC_E_PROXD_START 3 /* used by: target */
648 #define WLC_E_PROXD_STOP 4 /* used by: target */
649 #define WLC_E_PROXD_COMPLETED 5 /* used by: initiator completed */
650 #define WLC_E_PROXD_ERROR 6 /* used by both initiator and target */
651 #define WLC_E_PROXD_COLLECT_START 7 /* used by: target & initiator */
652 #define WLC_E_PROXD_COLLECT_STOP 8 /* used by: target */
653 #define WLC_E_PROXD_COLLECT_COMPLETED 9 /* used by: initiator completed */
654 #define WLC_E_PROXD_COLLECT_ERROR 10 /* used by both initiator and target */
655 #define WLC_E_PROXD_NAN_EVENT 11 /* used by both initiator and target */
656 #define WLC_E_PROXD_TS_RESULTS 12 /* used by: initiator completed */
658 /* proxd_event data */
659 typedef struct ftm_sample
{
660 uint32 value
; /* RTT in ns */
661 int8 rssi
; /* RSSI */
664 typedef struct ts_sample
{
671 typedef BWL_PRE_PACKED_STRUCT
struct proxd_event_data
{
672 uint16 ver
; /* version */
673 uint16 mode
; /* mode: target/initiator */
674 uint16 method
; /* method: rssi/TOF/AOA */
675 uint8 err_code
; /* error classification */
676 uint8 TOF_type
; /* one way or two way TOF */
677 uint8 OFDM_frame_type
; /* legacy or VHT */
678 uint8 bandwidth
; /* Bandwidth is 20, 40,80, MHZ */
679 struct ether_addr peer_mac
; /* (e.g for tgt:initiator's */
680 uint32 distance
; /* dst to tgt, units meter */
681 uint32 meanrtt
; /* mean delta */
682 uint32 modertt
; /* Mode delta */
683 uint32 medianrtt
; /* median RTT */
684 uint32 sdrtt
; /* Standard deviation of RTT */
685 int32 gdcalcresult
; /* Software or Hardware Kind of redundant, but if */
686 /* frame type is VHT, then we should do it by hardware */
687 int16 avg_rssi
; /* avg rssi accroos the ftm frames */
688 int16 validfrmcnt
; /* Firmware's valid frame counts */
689 int32 peer_router_info
; /* Peer router information if available in TLV, */
690 /* We will add this field later */
691 int32 var1
; /* average of group delay */
692 int32 var2
; /* average of threshold crossing */
693 int32 var3
; /* difference between group delay and threshold crossing */
694 /* raw Fine Time Measurements (ftm) data */
695 uint16 ftm_unit
; /* ftm cnt resolution in picoseconds , 6250ps - default */
696 uint16 ftm_cnt
; /* num of rtd measurments/length in the ftm buffer */
697 ftm_sample_t ftm_buff
[1]; /* 1 ... ftm_cnt */
698 } BWL_POST_PACKED_STRUCT wl_proxd_event_data_t
;
700 typedef BWL_PRE_PACKED_STRUCT
struct proxd_event_ts_results
{
701 uint16 ver
; /* version */
702 uint16 mode
; /* mode: target/initiator */
703 uint16 method
; /* method: rssi/TOF/AOA */
704 uint8 err_code
; /* error classification */
705 uint8 TOF_type
; /* one way or two way TOF */
706 uint16 ts_cnt
; /* number of timestamp measurements */
707 ts_sample_t ts_buff
[1]; /* Timestamps */
708 } BWL_POST_PACKED_STRUCT wl_proxd_event_ts_results_t
;
710 /* Video Traffic Interference Monitor Event */
711 #define INTFER_EVENT_VERSION 1
712 #define INTFER_STREAM_TYPE_NONTCP 1
713 #define INTFER_STREAM_TYPE_TCP 2
714 #define WLINTFER_STATS_NSMPLS 4
715 typedef struct wl_intfer_event
{
716 uint16 version
; /* version */
717 uint16 status
; /* status */
718 uint8 txfail_histo
[WLINTFER_STATS_NSMPLS
]; /* txfail histo */
721 #define RRM_EVENT_VERSION 0
722 typedef struct wl_rrm_event
{
725 int16 cat
; /* Category */
727 char payload
[1]; /* Measurement payload */
730 /* WLC_E_PSTA_PRIMARY_INTF_IND event data */
731 typedef struct wl_psta_primary_intf_event
{
732 struct ether_addr prim_ea
; /* primary intf ether addr */
733 } wl_psta_primary_intf_event_t
;
735 /* WLC_E_DPSTA_INTF_IND event data */
739 } wl_dpsta_intf_type
;
741 typedef struct wl_dpsta_intf_event
{
742 wl_dpsta_intf_type intf_type
; /* dwds/psta intf register */
743 } wl_dpsta_intf_event_t
;
745 /* ********** NAN protocol events/subevents ********** */
746 #ifndef NAN_EVENT_BUFFER_SIZE
747 #define NAN_EVENT_BUFFER_SIZE 512 /* max size */
748 #endif /* NAN_EVENT_BUFFER_SIZE */
749 /* NAN Events sent by firmware */
752 * If you make changes to this enum, dont forget to update the mask (if need be).
754 typedef enum wl_nan_events
{
755 WL_NAN_EVENT_START
= 1, /* NAN cluster started */
756 WL_NAN_EVENT_JOIN
= 2, /* To be deprecated */
757 WL_NAN_EVENT_ROLE
= 3, /* Role changed */
758 WL_NAN_EVENT_SCAN_COMPLETE
= 4, /* To be deprecated */
759 WL_NAN_EVENT_DISCOVERY_RESULT
= 5, /* Subscribe Received */
760 WL_NAN_EVENT_REPLIED
= 6, /* Publish Sent */
761 WL_NAN_EVENT_TERMINATED
= 7, /* sub / pub is terminated */
762 WL_NAN_EVENT_RECEIVE
= 8, /* Follow up Received */
763 WL_NAN_EVENT_STATUS_CHG
= 9, /* change in nan_mac status */
764 WL_NAN_EVENT_MERGE
= 10, /* Merged to a NAN cluster */
765 WL_NAN_EVENT_STOP
= 11, /* To be deprecated */
766 WL_NAN_EVENT_P2P
= 12, /* Unused */
767 WL_NAN_EVENT_WINDOW_BEGIN_P2P
= 13, /* Unused */
768 WL_NAN_EVENT_WINDOW_BEGIN_MESH
= 14, /* Unused */
769 WL_NAN_EVENT_WINDOW_BEGIN_IBSS
= 15, /* Unused */
770 WL_NAN_EVENT_WINDOW_BEGIN_RANGING
= 16, /* Unused */
771 WL_NAN_EVENT_POST_DISC
= 17, /* Event for post discovery data */
772 WL_NAN_EVENT_DATA_IF_ADD
= 18, /* Unused */
773 WL_NAN_EVENT_DATA_PEER_ADD
= 19, /* Event for peer add */
775 WL_NAN_EVENT_PEER_DATAPATH_IND
= 20, /* Incoming DP req */
776 WL_NAN_EVENT_DATAPATH_ESTB
= 21, /* DP Established */
777 WL_NAN_EVENT_SDF_RX
= 22, /* SDF payload */
778 WL_NAN_EVENT_DATAPATH_END
= 23, /* DP Terminate recvd */
779 WL_NAN_EVENT_BCN_RX
= 24, /* received beacon payload */
780 WL_NAN_EVENT_PEER_DATAPATH_RESP
= 25, /* Peer's DP response */
781 WL_NAN_EVENT_PEER_DATAPATH_CONF
= 26, /* Peer's DP confirm */
782 WL_NAN_EVENT_RNG_REQ_IND
= 27, /* Range Request */
783 WL_NAN_EVENT_RNG_RPT_IND
= 28, /* Range Report */
784 WL_NAN_EVENT_RNG_TERM_IND
= 29, /* Range Termination */
785 WL_NAN_EVENT_PEER_DATAPATH_SEC_INST
= 30, /* Peer's DP sec install */
786 WL_NAN_EVENT_TXS
= 31, /* for tx status of follow-up and SDFs */
787 WL_NAN_EVENT_DW_START
= 32, /* dw start */
788 WL_NAN_EVENT_DW_END
= 33, /* dw end */
789 WL_NAN_EVENT_CHAN_BOUNDARY
= 34, /* channel switch event */
790 WL_NAN_EVENT_MR_CHANGED
= 35, /* AMR or IMR changed event during DW */
791 WL_NAN_EVENT_RNG_RESP_IND
= 36, /* Range Response Rx */
792 WL_NAN_EVENT_PEER_SCHED_UPD_NOTIF
= 37, /* Peer's schedule update notification */
793 WL_NAN_EVENT_PEER_SCHED_REQ
= 38, /* Peer's schedule request */
794 WL_NAN_EVENT_PEER_SCHED_RESP
= 39, /* Peer's schedule response */
795 WL_NAN_EVENT_PEER_SCHED_CONF
= 40, /* Peer's schedule confirm */
796 WL_NAN_EVENT_SENT_DATAPATH_END
= 41, /* Sent DP terminate frame */
797 WL_NAN_EVENT_SLOT_START
= 42, /* SLOT_START event */
798 WL_NAN_EVENT_SLOT_END
= 43, /* SLOT_END event */
799 WL_NAN_EVENT_HOST_ASSIST_REQ
= 44, /* Requesting host assist */
800 WL_NAN_EVENT_RX_MGMT_FRM
= 45, /* NAN management frame received */
802 WL_NAN_EVENT_INVALID
/* delimiter for max value */
805 #define NAN_EV_MASK(ev) (1 << (ev - 1))
806 #define IS_NAN_EVT_ON(var, evt) ((var & (1 << (evt-1))) != 0)
808 #define NAN_EV_MASK_SET(var, evt) \
809 ((evt < WL_NAN_EVMASK_EXTN_LEN * 8) ? \
810 ((*((uint8 *)var + ((evt - 1)/8))) |= (1 << ((evt - 1) %8))) : 0)
811 #define IS_NAN_EVENT_ON(var, evt) \
812 ((evt < WL_NAN_EVMASK_EXTN_LEN * 8) && \
813 (((*((uint8 *)var + ((evt - 1)/8))) & (1 << ((evt - 1) %8))) != 0))
815 /* ******************* end of NAN section *************** */
817 typedef enum wl_scan_events
{
822 /* WLC_E_ULP event data */
823 #define WL_ULP_EVENT_VERSION 1
824 #define WL_ULP_DISABLE_CONSOLE 1 /* Disable console message on ULP entry */
825 #define WL_ULP_UCODE_DOWNLOAD 2 /* Download ULP ucode file */
827 typedef struct wl_ulp_event
{
829 uint16 ulp_dongle_action
;
832 /* TCP keepalive event data */
833 typedef BWL_PRE_PACKED_STRUCT
struct wl_event_tko
{
834 uint8 index
; /* TCP connection index, 0 to max-1 */
835 uint8 pad
[3]; /* 4-byte struct alignment */
836 } BWL_POST_PACKED_STRUCT wl_event_tko_t
;
839 uint8 radar_type
; /* one of RADAR_TYPE_XXX */
840 uint16 min_pw
; /* minimum pulse-width (usec * 20) */
841 uint16 max_pw
; /* maximum pulse-width (usec * 20) */
842 uint16 min_pri
; /* minimum pulse repetition interval (usec) */
843 uint16 max_pri
; /* maximum pulse repetition interval (usec) */
844 uint16 subband
; /* subband/frequency */
845 } radar_detected_event_info_t
;
846 typedef struct wl_event_radar_detect_data
{
849 uint16 current_chanspec
; /* chanspec on which the radar is recieved */
850 uint16 target_chanspec
; /* Target chanspec after detection of radar on current_chanspec */
851 radar_detected_event_info_t radar_info
[2];
852 } wl_event_radar_detect_data_t
;
854 #define WL_EVENT_MODESW_VER_1 1
855 #define WL_EVENT_MODESW_VER_CURRENT WL_EVENT_MODESW_VER_1
857 #define WL_E_MODESW_FLAG_MASK_DEVICE 0x01u /* mask of device: belongs to local or peer */
858 #define WL_E_MODESW_FLAG_MASK_FROM 0x02u /* mask of origin: firmware or user */
859 #define WL_E_MODESW_FLAG_MASK_STATE 0x0Cu /* mask of state: modesw progress state */
861 #define WL_E_MODESW_FLAG_DEVICE_LOCAL 0x00u /* flag - device: info is about self/local */
862 #define WL_E_MODESW_FLAG_DEVICE_PEER 0x01u /* flag - device: info is about peer */
864 #define WL_E_MODESW_FLAG_FROM_FIRMWARE 0x00u /* flag - from: request is from firmware */
865 #define WL_E_MODESW_FLAG_FROM_USER 0x02u /* flag - from: request is from user/iov */
867 #define WL_E_MODESW_FLAG_STATE_REQUESTED 0x00u /* flag - state: mode switch request */
868 #define WL_E_MODESW_FLAG_STATE_INITIATED 0x04u /* flag - state: switch initiated */
869 #define WL_E_MODESW_FLAG_STATE_COMPLETE 0x08u /* flag - state: switch completed/success */
870 #define WL_E_MODESW_FLAG_STATE_FAILURE 0x0Cu /* flag - state: failed to switch */
872 /* Get sizeof *X including variable data's length where X is pointer to wl_event_mode_switch_t */
873 #define WL_E_MODESW_SIZE(X) (sizeof(*(X)) + (X)->length)
875 /* Get variable data's length where X is pointer to wl_event_mode_switch_t */
876 #define WL_E_MODESW_DATA_SIZE(X) (((X)->length > sizeof(*(X))) ? ((X)->length - sizeof(*(X))) : 0)
878 #define WL_E_MODESW_REASON_UNKNOWN 0u /* reason: UNKNOWN */
879 #define WL_E_MODESW_REASON_ACSD 1u /* reason: ACSD (based on events from FW */
880 #define WL_E_MODESW_REASON_OBSS_DBS 2u /* reason: OBSS DBS (eg. on interference) */
881 #define WL_E_MODESW_REASON_DFS 3u /* reason: DFS (eg. on subband radar) */
882 #define WL_E_MODESW_REASON_DYN160 4u /* reason: DYN160 (160/2x2 - 80/4x4) */
884 /* event structure for WLC_E_MODE_SWITCH */
887 uint16 length
; /* size including 'data' field */
890 uint32 flags
; /* bit 0: peer(/local==0);
891 * bit 1: user(/firmware==0);
892 * bits 3,2: 00==requested, 01==initiated,
893 * 10==complete, 11==failure;
896 uint16 reason
; /* value 0: unknown, 1: ACSD, 2: OBSS_DBS,
897 * 3: DFS, 4: DYN160, rest: reserved
899 uint16 data_offset
; /* offset to 'data' from beginning of this struct.
900 * fields may be added between data_offset and data
902 /* ADD NEW FIELDS HERE */
903 uint8 data
[]; /* reason specific data; could be empty */
904 } wl_event_mode_switch_t
;
906 /* when reason in WLC_E_MODE_SWITCH is DYN160, data will carry the following structure */
908 uint16 trigger
; /* value 0: MU to SU, 1: SU to MU, 2: metric_dyn160, 3:re-/assoc,
909 * 4: disassoc, 5: rssi, 6: traffic, 7: interference,
912 struct ether_addr sta_addr
; /* causal STA's MAC address when known */
913 uint16 metric_160_80
; /* latest dyn160 metric */
914 uint8 nss
; /* NSS of the STA */
915 uint8 bw
; /* BW of the STA */
916 int8 rssi
; /* RSSI of the STA */
917 uint8 traffic
; /* internal metric of traffic */
918 } wl_event_mode_switch_dyn160
;
920 #define WL_EVENT_FBT_VER_1 1
922 #define WL_E_FBT_TYPE_FBT_OTD_AUTH 1
923 #define WL_E_FBT_TYPE_FBT_OTA_AUTH 2
925 /* event structure for WLC_E_FBT */
928 uint16 length
; /* size including 'data' field */
929 uint16 type
; /* value 0: unknown, 1: FBT OTD Auth Req */
930 uint16 data_offset
; /* offset to 'data' from beginning of this struct.
931 * fields may be added between data_offset and data
933 /* ADD NEW FIELDS HERE */
934 uint8 data
[]; /* type specific data; could be empty */
937 /* TWT Setup Completion is designed to notify the user of TWT Setup process
938 * status. When 'status' field is value of BCME_OK, the user must check the
939 * 'setup_cmd' field value in 'wl_twt_sdesc_t' structure that at the end of
940 * the event data to see the response from the TWT Responding STA; when
941 * 'status' field is value of BCME_ERROR or non BCME_OK, user must not use
942 * anything from 'wl_twt_sdesc_t' structure as it is the TWT Requesting STA's
946 #define WL_TWT_SETUP_CPLT_VER 0
948 /* TWT Setup Completion event data */
949 typedef struct wl_twt_setup_cplt
{
951 uint16 length
; /* the byte count of fields from 'dialog' onwards */
952 uint8 dialog
; /* the dialog token user supplied to the TWT setup API */
955 /* wl_twt_sdesc_t desc; - defined in wlioctl.h */
956 } wl_twt_setup_cplt_t
;
958 #define WL_INVALID_IE_EVENT_VERSION 0
960 /* Invalid IE Event data */
961 typedef struct wl_invalid_ie_event
{
963 uint16 len
; /* Length of the invalid IE copy */
964 uint16 type
; /* Type/subtype of the frame which contains the invalid IE */
965 uint16 error
; /* error code of the wrong IE, defined in ie_error_code_t */
966 uint8 ie
[]; /* Variable length buffer for the invalid IE copy */
967 } wl_invalid_ie_event_t
;
969 /* Fixed header portion of Invalid IE Event */
970 typedef struct wl_invalid_ie_event_hdr
{
972 uint16 len
; /* Length of the invalid IE copy */
973 uint16 type
; /* Type/subtype of the frame which contains the invalid IE */
974 uint16 error
; /* error code of the wrong IE, defined in ie_error_code_t */
975 /* var length IE data follows */
976 } wl_invalid_ie_event_hdr_t
;
978 typedef enum ie_error_code
{
979 IE_ERROR_OUT_OF_RANGE
= 0x01
982 /* This marks the end of a packed structure section. */
983 #include <packed_section_end.h>
985 /* reason of channel switch */
987 CHANSW_DFS
= 10, /* channel switch due to DFS module */
988 CHANSW_HOMECH_REQ
= 14, /* channel switch due to HOME Channel Request */
989 CHANSW_STA
= 15, /* channel switch due to STA */
990 CHANSW_SOFTAP
= 16, /* channel switch due to SodtAP */
991 CHANSW_AIBSS
= 17, /* channel switch due to AIBSS */
992 CHANSW_NAN
= 18, /* channel switch due to NAN */
993 CHANSW_NAN_DISC
= 19, /* channel switch due to NAN Disc */
994 CHANSW_NAN_SCHED
= 20, /* channel switch due to NAN Sched */
995 CHANSW_AWDL_AW
= 21, /* channel switch due to AWDL aw */
996 CHANSW_AWDL_SYNC
= 22, /* channel switch due to AWDL sync */
997 CHANSW_AWDL_CAL
= 23, /* channel switch due to AWDL Cal */
998 CHANSW_AWDL_PSF
= 24, /* channel switch due to AWDL PSF */
999 CHANSW_AWDL_OOB_AF
= 25, /* channel switch due to AWDL OOB action frame */
1000 CHANSW_TDLS
= 26, /* channel switch due to TDLS */
1001 CHANSW_PROXD
= 27, /* channel switch due to PROXD */
1002 CHANSW_SLOTTED_BSS
= 28, /* channel switch due to slotted bss */
1003 CHANSW_SLOTTED_CMN_SYNC
= 29, /* channel switch due to Common Sync Layer */
1004 CHANSW_SLOTTED_BSS_CAL
= 30, /* channel switch due to Cal request from slotted bss */
1005 CHANSW_MAX_NUMBER
= 31 /* max channel switch reason */
1006 } wl_chansw_reason_t
;
1008 #define CHANSW_REASON(reason) (1 << reason)
1010 #define EVENT_AGGR_DATA_HDR_LEN 8
1012 typedef struct event_aggr_data
{
1013 uint16 num_events
; /* No of events aggregated */
1014 uint16 len
; /* length of the aggregated events, excludes padding */
1015 uint8 pad
[4]; /* Padding to make aggr event packet header aligned
1016 * on 64-bit boundary, for a 64-bit host system.
1018 uint8 data
[]; /* Aggregate buffer containing Events */
1019 } event_aggr_data_t
;
1021 /* WLC_E_TVPM_MITIGATION event structure version */
1022 #define WL_TVPM_MITIGATION_VERSION 1
1024 /* TVPM mitigation on/off status bits */
1025 #define WL_TVPM_MITIGATION_TXDC 0x1
1026 #define WL_TVPM_MITIGATION_TXPOWER 0x2
1027 #define WL_TVPM_MITIGATION_TXCHAINS 0x4
1029 /* Event structure for WLC_E_TVPM_MITIGATION */
1030 typedef struct wl_event_tvpm_mitigation
{
1031 uint16 version
; /* structure version */
1032 uint16 length
; /* length of this structure */
1033 uint32 timestamp_ms
; /* millisecond timestamp */
1034 uint8 slice
; /* slice number */
1036 uint16 on_off
; /* mitigation status bits */
1037 } wl_event_tvpm_mitigation_t
;
1039 /* Event structures for sub health checks of PHY */
1041 #define WL_PHY_HC_DESENSE_STATS_VER (1)
1042 typedef struct wl_hc_desense_stats
{
1045 int8 allowed_weakest_rssi
; /* based on weakest link RSSI */
1046 uint8 ofdm_desense
; /* Desense requested for OFDM */
1047 uint8 bphy_desense
; /* Desense requested for bphy */
1048 int8 glitch_upd_wait
; /* wait post ACI mitigation */
1049 } wl_hc_desense_stats_v1_t
;
1051 #define WL_PHY_HC_TEMP_STATS_VER (1)
1052 typedef struct wl_hc_temp_stats
{
1055 int16 curtemp
; /* Temperature */
1056 uint8 temp_disthresh
; /* Threshold to reduce tx chain */
1057 uint8 temp_enthresh
; /* Threshold to increase tx chains */
1058 uint tempsense_period
; /* Temperature check period */
1059 bool heatedup
; /* 1: temp throttling on */
1060 uint8 bitmap
; /* Indicating rx and tx chains */
1062 } wl_hc_temp_stats_v1_t
;
1064 #define WL_PHY_HC_TEMP_STATS_VER_2 (2)
1068 int16 curtemp
; /* Temperature */
1070 } wl_hc_temp_stats_v2_t
;
1072 #define WL_PHY_HC_VCOCAL_STATS_VER (1)
1073 typedef struct wl_hc_vcocal_stats
{
1076 int16 curtemp
; /* Temperature */
1077 /* Ring buffer - Maintains history of previous 16 wake/sleep cycles */
1078 uint16 vcocal_status_wake
;
1079 uint16 vcocal_status_sleep
;
1080 uint16 plllock_status_wake
;
1081 uint16 plllock_status_sleep
;
1084 uint16 cc_secondcap
;
1086 } wl_hc_vcocal_stats_v1_t
;
1088 #define WL_PHY_HC_TXPWR_STATS_VER (1)
1089 typedef struct wl_hc_tx_stats
{
1092 int8 tgt_pwr
[MAX_PHY_CORE_NUM
]; /* Target pwr (qdBm) */
1093 int8 estPwr
[MAX_PHY_CORE_NUM
]; /* Rate corrected (qdBm) */
1094 int8 estPwr_adj
[MAX_PHY_CORE_NUM
]; /* Max power (qdBm) */
1095 uint8 baseindex
[MAX_PHY_CORE_NUM
]; /* Tx base index */
1096 int16 temp
; /* Temperature */
1097 uint16 TxCtrlWrd
[3]; /* 6 PHY ctrl bytes */
1098 int8 min_txpower
; /* min tx power per ant */
1100 } wl_hc_txpwr_stats_v1_t
;
1102 #define WL_PHY_HC_TXPWR_STATS_VER_2 (2)
1106 int8 tgt_pwr
[MAX_PHY_CORE_NUM
]; /* Target pwr (qdBm) */
1107 uint8 estPwr
[MAX_PHY_CORE_NUM
]; /* Rate corrected (qdBm) */
1108 uint8 estPwr_adj
[MAX_PHY_CORE_NUM
]; /* Max power (qdBm) */
1109 uint8 baseindex
[MAX_PHY_CORE_NUM
]; /* Tx base index */
1110 int16 temp
; /* Temperature */
1111 uint16 TxCtrlWrd
[3]; /* 6 PHY ctrl bytes */
1112 int8 min_txpower
; /* min tx power per ant */
1114 } wl_hc_txpwr_stats_v2_t
;
1116 typedef enum wl_mbo_event_type
{
1117 WL_MBO_E_CELLULAR_NW_SWITCH
= 1,
1118 WL_MBO_E_BTM_RCVD
= 2,
1119 /* ADD before this */
1120 WL_MBO_E_LAST
= 3 /* highest val + 1 for range checking */
1121 } wl_mbo_event_type_t
;
1123 /* WLC_E_MBO event structure version */
1124 #define WL_MBO_EVT_VER 1
1126 struct wl_event_mbo
{
1127 uint16 version
; /* structure version */
1128 uint16 length
; /* length of the rest of the structure from type */
1129 wl_mbo_event_type_t type
; /* Event type */
1130 uint8 data
[]; /* Variable length data */
1133 /* WLC_E_MBO_CELLULAR_NW_SWITCH event structure version */
1134 #define WL_MBO_CELLULAR_NW_SWITCH_VER 1
1136 /* WLC_E_MBO_CELLULAR_NW_SWITCH event data */
1137 struct wl_event_mbo_cell_nw_switch
{
1138 uint16 version
; /* structure version */
1139 uint16 length
; /* length of the rest of the structure from reason */
1140 /* Reason of switch as per MBO Tech spec */
1144 /* delay after which re-association can be tried to current BSS (seconds) */
1145 uint16 reassoc_delay
;
1146 /* How long current association will be there (milli seconds).
1147 * This is zero if not known or value is overflowing.
1149 uint32 assoc_time_remain
;
1152 /* WLC_E_MBO_BTM_RCVD event structure version */
1153 #define WL_BTM_EVENT_DATA_VER_1 1
1154 /* Specific btm event type data */
1155 struct wl_btm_event_type_data
{
1158 uint8 transition_reason
; /* transition reason code */
1159 uint8 pad
[3]; /* pad */
1162 /* WLC_E_PRUNE event structure version */
1163 #define WL_BSSID_PRUNE_EVT_VER_1 1
1164 /* MBO-OCE params */
1165 struct wl_bssid_prune_evt_info
{
1169 uint32 time_remaining
; /* Time remaining */
1170 struct ether_addr BSSID
;
1172 uint8 reason
; /* Reason code */
1175 /* WLC_E_HWA Event structure */
1176 typedef struct wl_event_hwa
{
1177 uint16 version
; /* structure version */
1178 uint16 length
; /* length of structure */
1179 uint32 sub_type
; /* Sub event type */
1180 uint8 data
[0]; /* variable length data */
1183 #define WL_HWA_EVENT_VER 1
1185 typedef enum wl_event_hwa_subtype
{
1186 WL_HWA_EVENT_SUBTYPE_ERROR
= 1,
1187 WL_HWA_EVENT_SUBTYPE_LAST
= 2
1188 } wl_event_hwa_subtype_t
;
1190 /* WLC_E_ADPS status */
1192 WL_E_STATUS_ADPS_DEAUTH
= 0,
1193 WL_E_STATUS_ADPS_MAX
1196 /* WLC_E_ADPS event data */
1197 #define WL_EVENT_ADPS_VER_1 1
1199 /* WLC_E_ADPS event type */
1200 #define WL_E_TYPE_ADPS_BAD_AP 1
1202 typedef struct wl_event_adps_bad_ap
{
1205 struct ether_addr ea
; /* bssid */
1206 } wl_event_adps_bad_ap_t
;
1208 typedef struct wl_event_adps
{
1209 uint16 version
; /* structure version */
1210 uint16 length
; /* length of structure */
1211 uint32 type
; /* event type */
1212 uint8 data
[]; /* variable length data */
1213 } wl_event_adps_v1_t
;
1215 typedef wl_event_adps_v1_t wl_event_adps_t
;
1216 #endif /* _BCMEVENT_H_ */