1 /* 2 * Broadcom Event protocol definitions 3 * 4 * Dependencies: bcmeth.h 5 * 6 * Copyright (C) 1999-2017, Broadcom Corporation 7 * 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: 13 * 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. 21 * 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. 25 * 26 * 27 * <<Broadcom-WL-IPTag/Open:>> 28 * 29 * $Id: bcmevent.h 700076 2017-05-17 14:42:22Z $ 30 * 31 */ 32 33 /* 34 * Broadcom Ethernet Events protocol defines 35 * 36 */ 37 38 #ifndef _BCMEVENT_H_ 39 #define _BCMEVENT_H_ 40 41 #include <typedefs.h> 42 /* #include <ethernet.h> -- TODO: req., excluded to overwhelming coupling (break up ethernet.h) */ 43 #include <bcmeth.h> 44 #if defined(DNGL_EVENT_SUPPORT) 45 #include <dnglevent.h> 46 #endif 47 48 /* This marks the start of a packed structure section. */ 49 #include <packed_section_start.h> 50 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 */ 53 54 /* flags */ 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 */ 60 61 /* these fields are stored in network order */ 62 63 /* version 1 */ 64 typedef BWL_PRE_PACKED_STRUCT struct 65 { 66 uint16 version; 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; 76 77 /* the current version */ 78 typedef BWL_PRE_PACKED_STRUCT struct 79 { 80 uint16 version; 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; 92 93 /* used by driver msgs */ 94 typedef BWL_PRE_PACKED_STRUCT struct bcm_event { 95 struct ether_header eth; 96 bcmeth_hdr_t bcm_hdr; 97 wl_event_msg_t event; 98 /* data portion follows */ 99 } BWL_POST_PACKED_STRUCT bcm_event_t; 100 101 /* 102 * used by host event 103 * note: if additional event types are added, it should go with is_wlc_event_frame() as well. 104 */ 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; 109 #endif 110 111 /* add new event here */ 112 } bcm_event_msg_u_t; 113 114 #define BCM_MSG_LEN (sizeof(bcm_event_t) - sizeof(bcmeth_hdr_t) - sizeof(struct ether_header)) 115 116 /* Event messages */ 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 */ 159 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 192 */ 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) 228 */ 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 280 * tx/rxchain 281 */ 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_LAST 172 /* highest val + 1 for range checking */ 288 #if (WLC_E_LAST > 172) 289 #error "WLC_E_LAST: Invalid value for last event; must be <= 172." 290 #endif /* WLC_E_LAST */ 291 292 /* define an API for getting the string name of an event */ 293 extern const char *bcmevent_get_name(uint event_type); 294 extern void wl_event_to_host_order(wl_event_msg_t * evt); 295 extern void wl_event_to_network_order(wl_event_msg_t * evt); 296 297 /* validate if the event is proper and if valid copy event header to event */ 298 extern int is_wlc_event_frame(void *pktdata, uint pktlen, uint16 exp_usr_subtype, 299 bcm_event_msg_u_t *out_event); 300 301 /* conversion between host and network order for events */ 302 void wl_event_to_host_order(wl_event_msg_t * evt); 303 void wl_event_to_network_order(wl_event_msg_t * evt); 304 305 306 /* Event status codes */ 307 #define WLC_E_STATUS_SUCCESS 0 /* operation was successful */ 308 #define WLC_E_STATUS_FAIL 1 /* operation failed */ 309 #define WLC_E_STATUS_TIMEOUT 2 /* operation timed out */ 310 #define WLC_E_STATUS_NO_NETWORKS 3 /* failed due to no matching network found */ 311 #define WLC_E_STATUS_ABORT 4 /* operation was aborted */ 312 #define WLC_E_STATUS_NO_ACK 5 /* protocol failure: packet not ack'd */ 313 #define WLC_E_STATUS_UNSOLICITED 6 /* AUTH or ASSOC packet was unsolicited */ 314 #define WLC_E_STATUS_ATTEMPT 7 /* attempt to assoc to an auto auth configuration */ 315 #define WLC_E_STATUS_PARTIAL 8 /* scan results are incomplete */ 316 #define WLC_E_STATUS_NEWSCAN 9 /* scan aborted by another scan */ 317 #define WLC_E_STATUS_NEWASSOC 10 /* scan aborted due to assoc in progress */ 318 #define WLC_E_STATUS_11HQUIET 11 /* 802.11h quiet period started */ 319 #define WLC_E_STATUS_SUPPRESS 12 /* user disabled scanning (WLC_SET_SCANSUPPRESS) */ 320 #define WLC_E_STATUS_NOCHANS 13 /* no allowable channels to scan */ 321 #define WLC_E_STATUS_CS_ABORT 15 /* abort channel select */ 322 #define WLC_E_STATUS_ERROR 16 /* request failed due to error */ 323 #define WLC_E_STATUS_INVALID 0xff /* Invalid status code to init variables. */ 324 325 /* 4-way handshake event type */ 326 #define WLC_E_PSK_AUTH_SUB_EAPOL_START 1 /* EAPOL start */ 327 #define WLC_E_PSK_AUTH_SUB_EAPOL_DONE 2 /* EAPOL end */ 328 /* GTK event type */ 329 #define WLC_E_PSK_AUTH_SUB_GTK_DONE 3 /* GTK end */ 330 331 /* 4-way handshake event status code */ 332 #define WLC_E_STATUS_PSK_AUTH_WPA_TIMOUT 1 /* operation timed out */ 333 #define WLC_E_STATUS_PSK_AUTH_MIC_WPA_ERR 2 /* MIC error */ 334 #define WLC_E_STATUS_PSK_AUTH_IE_MISMATCH_ERR 3 /* IE Missmatch error */ 335 #define WLC_E_STATUS_PSK_AUTH_REPLAY_COUNT_ERR 4 336 #define WLC_E_STATUS_PSK_AUTH_PEER_BLACKISTED 5 /* Blaclisted peer */ 337 #define WLC_E_STATUS_PSK_AUTH_GTK_REKEY_FAIL 6 /* GTK event status code */ 338 339 /* SDB transition status code */ 340 #define WLC_E_STATUS_SDB_START 1 341 #define WLC_E_STATUS_SDB_COMPLETE 2 342 /* Slice-swap status code */ 343 #define WLC_E_STATUS_SLICE_SWAP_START 3 344 #define WLC_E_STATUS_SLICE_SWAP_COMPLETE 4 345 346 347 /* SDB transition reason code */ 348 #define WLC_E_REASON_HOST_DIRECT 0 349 #define WLC_E_REASON_INFRA_ASSOC 1 350 #define WLC_E_REASON_INFRA_ROAM 2 351 #define WLC_E_REASON_INFRA_DISASSOC 3 352 #define WLC_E_REASON_NO_MODE_CHANGE_NEEDED 4 353 #define WLC_E_REASON_AWDL_ENABLE 5 354 #define WLC_E_REASON_AWDL_DISABLE 6 355 356 /* WLC_E_SDB_TRANSITION event data */ 357 #define WL_MAX_BSSCFG 4 358 #define WL_EVENT_SDB_TRANSITION_VER 1 359 typedef struct wl_event_sdb_data { 360 uint8 wlunit; /* Core index */ 361 uint8 is_iftype; /* Interface Type(Station, SoftAP, P2P_GO, P2P_GC */ 362 uint16 chanspec; /* Interface Channel/Chanspec */ 363 char ssidbuf[(4 * 32) + 1]; /* SSID_FMT_BUF_LEN: ((4 * DOT11_MAX_SSID_LEN) + 1) */ 364 } wl_event_sdb_data_t; 365 366 typedef struct wl_event_sdb_trans { 367 uint8 version; /* Event Data Version */ 368 uint8 rsdb_mode; 369 uint8 enable_bsscfg; 370 uint8 reserved; 371 struct wl_event_sdb_data values[WL_MAX_BSSCFG]; 372 } wl_event_sdb_trans_t; 373 374 /* roam reason codes */ 375 #define WLC_E_REASON_INITIAL_ASSOC 0 /* initial assoc */ 376 #define WLC_E_REASON_LOW_RSSI 1 /* roamed due to low RSSI */ 377 #define WLC_E_REASON_DEAUTH 2 /* roamed due to DEAUTH indication */ 378 #define WLC_E_REASON_DISASSOC 3 /* roamed due to DISASSOC indication */ 379 #define WLC_E_REASON_BCNS_LOST 4 /* roamed due to lost beacons */ 380 381 #define WLC_E_REASON_FAST_ROAM_FAILED 5 /* roamed due to fast roam failure */ 382 #define WLC_E_REASON_DIRECTED_ROAM 6 /* roamed due to request by AP */ 383 #define WLC_E_REASON_TSPEC_REJECTED 7 /* roamed due to TSPEC rejection */ 384 #define WLC_E_REASON_BETTER_AP 8 /* roamed due to finding better AP */ 385 #define WLC_E_REASON_MINTXRATE 9 /* roamed because at mintxrate for too long */ 386 #define WLC_E_REASON_TXFAIL 10 /* We can hear AP, but AP can't hear us */ 387 /* retained for precommit auto-merging errors; remove once all branches are synced */ 388 #define WLC_E_REASON_REQUESTED_ROAM 11 389 #define WLC_E_REASON_BSSTRANS_REQ 11 /* roamed due to BSS Transition request by AP */ 390 #define WLC_E_REASON_LOW_RSSI_CU 12 /* roamed due to low RSSI and Channel Usage */ 391 #define WLC_E_REASON_RADAR_DETECTED 13 /* roamed due to radar detection by STA */ 392 393 /* prune reason codes */ 394 #define WLC_E_PRUNE_ENCR_MISMATCH 1 /* encryption mismatch */ 395 #define WLC_E_PRUNE_BCAST_BSSID 2 /* AP uses a broadcast BSSID */ 396 #define WLC_E_PRUNE_MAC_DENY 3 /* STA's MAC addr is in AP's MAC deny list */ 397 #define WLC_E_PRUNE_MAC_NA 4 /* STA's MAC addr is not in AP's MAC allow list */ 398 #define WLC_E_PRUNE_REG_PASSV 5 /* AP not allowed due to regulatory restriction */ 399 #define WLC_E_PRUNE_SPCT_MGMT 6 /* AP does not support STA locale spectrum mgmt */ 400 #define WLC_E_PRUNE_RADAR 7 /* AP is on a radar channel of STA locale */ 401 #define WLC_E_RSN_MISMATCH 8 /* STA does not support AP's RSN */ 402 #define WLC_E_PRUNE_NO_COMMON_RATES 9 /* No rates in common with AP */ 403 #define WLC_E_PRUNE_BASIC_RATES 10 /* STA does not support all basic rates of BSS */ 404 #define WLC_E_PRUNE_CIPHER_NA 12 /* BSS's cipher not supported */ 405 #define WLC_E_PRUNE_KNOWN_STA 13 /* AP is already known to us as a STA */ 406 #define WLC_E_PRUNE_WDS_PEER 15 /* AP is already known to us as a WDS peer */ 407 #define WLC_E_PRUNE_QBSS_LOAD 16 /* QBSS LOAD - AAC is too low */ 408 #define WLC_E_PRUNE_HOME_AP 17 /* prune home AP */ 409 #define WLC_E_PRUNE_AUTH_RESP_MAC 20 /* suppress auth resp by MAC filter */ 410 411 /* WPA failure reason codes carried in the WLC_E_PSK_SUP event */ 412 #define WLC_E_SUP_OTHER 0 /* Other reason */ 413 #define WLC_E_SUP_DECRYPT_KEY_DATA 1 /* Decryption of key data failed */ 414 #define WLC_E_SUP_BAD_UCAST_WEP128 2 /* Illegal use of ucast WEP128 */ 415 #define WLC_E_SUP_BAD_UCAST_WEP40 3 /* Illegal use of ucast WEP40 */ 416 #define WLC_E_SUP_UNSUP_KEY_LEN 4 /* Unsupported key length */ 417 #define WLC_E_SUP_PW_KEY_CIPHER 5 /* Unicast cipher mismatch in pairwise key */ 418 #define WLC_E_SUP_MSG3_TOO_MANY_IE 6 /* WPA IE contains > 1 RSN IE in key msg 3 */ 419 #define WLC_E_SUP_MSG3_IE_MISMATCH 7 /* WPA IE mismatch in key message 3 */ 420 #define WLC_E_SUP_NO_INSTALL_FLAG 8 /* INSTALL flag unset in 4-way msg */ 421 #define WLC_E_SUP_MSG3_NO_GTK 9 /* encapsulated GTK missing from msg 3 */ 422 #define WLC_E_SUP_GRP_KEY_CIPHER 10 /* Multicast cipher mismatch in group key */ 423 #define WLC_E_SUP_GRP_MSG1_NO_GTK 11 /* encapsulated GTK missing from group msg 1 */ 424 #define WLC_E_SUP_GTK_DECRYPT_FAIL 12 /* GTK decrypt failure */ 425 #define WLC_E_SUP_SEND_FAIL 13 /* message send failure */ 426 #define WLC_E_SUP_DEAUTH 14 /* received FC_DEAUTH */ 427 #define WLC_E_SUP_WPA_PSK_TMO 15 /* WPA PSK 4-way handshake timeout */ 428 #define WLC_E_SUP_WPA_PSK_M1_TMO 16 /* WPA PSK 4-way handshake M1 timeout */ 429 #define WLC_E_SUP_WPA_PSK_M3_TMO 17 /* WPA PSK 4-way handshake M3 timeout */ 430 431 432 /* Ucode reason codes carried in the WLC_E_MACDBG event */ 433 #define WLC_E_MACDBG_LIST_PSM 0 /* Dump list update for PSM registers */ 434 #define WLC_E_MACDBG_LIST_PSMX 1 /* Dump list update for PSMx registers */ 435 #define WLC_E_MACDBG_REGALL 2 /* Dump all registers */ 436 437 /* Event data for events that include frames received over the air */ 438 /* WLC_E_PROBRESP_MSG 439 * WLC_E_P2P_PROBREQ_MSG 440 * WLC_E_ACTION_FRAME_RX 441 */ 442 typedef BWL_PRE_PACKED_STRUCT struct wl_event_rx_frame_data { 443 uint16 version; 444 uint16 channel; /* Matches chanspec_t format from bcmwifi_channels.h */ 445 int32 rssi; 446 uint32 mactime; 447 uint32 rate; 448 } BWL_POST_PACKED_STRUCT wl_event_rx_frame_data_t; 449 450 #define BCM_RX_FRAME_DATA_VERSION 1 451 452 /* WLC_E_IF event data */ 453 typedef struct wl_event_data_if { 454 uint8 ifidx; /* RTE virtual device index (for dongle) */ 455 uint8 opcode; /* see I/F opcode */ 456 uint8 reserved; /* bit mask (WLC_E_IF_FLAGS_XXX ) */ 457 uint8 bssidx; /* bsscfg index */ 458 uint8 role; /* see I/F role */ 459 } wl_event_data_if_t; 460 461 /* WLC_E_NATOE event data */ 462 typedef struct wl_event_data_natoe { 463 uint32 natoe_active; 464 uint32 sta_ip; 465 uint16 start_port; 466 uint16 end_port; 467 } wl_event_data_natoe_t; 468 469 /* opcode in WLC_E_IF event */ 470 #define WLC_E_IF_ADD 1 /* bsscfg add */ 471 #define WLC_E_IF_DEL 2 /* bsscfg delete */ 472 #define WLC_E_IF_CHANGE 3 /* bsscfg role change */ 473 474 /* I/F role code in WLC_E_IF event */ 475 #define WLC_E_IF_ROLE_STA 0 /* Infra STA */ 476 #define WLC_E_IF_ROLE_AP 1 /* Access Point */ 477 #define WLC_E_IF_ROLE_WDS 2 /* WDS link */ 478 #define WLC_E_IF_ROLE_P2P_GO 3 /* P2P Group Owner */ 479 #define WLC_E_IF_ROLE_P2P_CLIENT 4 /* P2P Client */ 480 #define WLC_E_IF_ROLE_IBSS 8 /* IBSS */ 481 #define WLC_E_IF_ROLE_NAN 9 /* NAN */ 482 483 /* WLC_E_RSSI event data */ 484 typedef struct wl_event_data_rssi { 485 int32 rssi; 486 int32 snr; 487 int32 noise; 488 } wl_event_data_rssi_t; 489 490 /* WLC_E_IF flag */ 491 #define WLC_E_IF_FLAGS_BSSCFG_NOIF 0x1 /* no host I/F creation needed */ 492 493 /* Reason codes for LINK */ 494 #define WLC_E_LINK_BCN_LOSS 1 /* Link down because of beacon loss */ 495 #define WLC_E_LINK_DISASSOC 2 /* Link down because of disassoc */ 496 #define WLC_E_LINK_ASSOC_REC 3 /* Link down because assoc recreate failed */ 497 #define WLC_E_LINK_BSSCFG_DIS 4 /* Link down due to bsscfg down */ 498 499 500 /* WLC_E_NDIS_LINK event data */ 501 typedef BWL_PRE_PACKED_STRUCT struct ndis_link_parms { 502 struct ether_addr peer_mac; /* 6 bytes */ 503 uint16 chanspec; /* 2 bytes */ 504 uint32 link_speed; /* current datarate in units of 500 Kbit/s */ 505 uint32 max_link_speed; /* max possible datarate for link in units of 500 Kbit/s */ 506 int32 rssi; /* average rssi */ 507 } BWL_POST_PACKED_STRUCT ndis_link_parms_t; 508 509 /* reason codes for WLC_E_OVERLAY_REQ event */ 510 #define WLC_E_OVL_DOWNLOAD 0 /* overlay download request */ 511 #define WLC_E_OVL_UPDATE_IND 1 /* device indication of host overlay update */ 512 513 /* reason codes for WLC_E_TDLS_PEER_EVENT event */ 514 #define WLC_E_TDLS_PEER_DISCOVERED 0 /* peer is ready to establish TDLS */ 515 #define WLC_E_TDLS_PEER_CONNECTED 1 516 #define WLC_E_TDLS_PEER_DISCONNECTED 2 517 518 /* reason codes for WLC_E_RMC_EVENT event */ 519 #define WLC_E_REASON_RMC_NONE 0 520 #define WLC_E_REASON_RMC_AR_LOST 1 521 #define WLC_E_REASON_RMC_AR_NO_ACK 2 522 523 #ifdef WLTDLS 524 /* TDLS Action Category code */ 525 #define TDLS_AF_CATEGORY 12 526 /* Wi-Fi Display (WFD) Vendor Specific Category */ 527 /* used for WFD Tunneled Probe Request and Response */ 528 #define TDLS_VENDOR_SPECIFIC 127 529 /* TDLS Action Field Values */ 530 #define TDLS_ACTION_SETUP_REQ 0 531 #define TDLS_ACTION_SETUP_RESP 1 532 #define TDLS_ACTION_SETUP_CONFIRM 2 533 #define TDLS_ACTION_TEARDOWN 3 534 #define WLAN_TDLS_SET_PROBE_WFD_IE 11 535 #define WLAN_TDLS_SET_SETUP_WFD_IE 12 536 #define WLAN_TDLS_SET_WFD_ENABLED 13 537 #define WLAN_TDLS_SET_WFD_DISABLED 14 538 #endif 539 540 /* WLC_E_RANGING_EVENT subtypes */ 541 #define WLC_E_RANGING_RESULTS 0 542 543 544 /* GAS event data */ 545 typedef BWL_PRE_PACKED_STRUCT struct wl_event_gas { 546 uint16 channel; /* channel of GAS protocol */ 547 uint8 dialog_token; /* GAS dialog token */ 548 uint8 fragment_id; /* fragment id */ 549 uint16 status_code; /* status code on GAS completion */ 550 uint16 data_len; /* length of data to follow */ 551 uint8 data[1]; /* variable length specified by data_len */ 552 } BWL_POST_PACKED_STRUCT wl_event_gas_t; 553 554 /* service discovery TLV */ 555 typedef BWL_PRE_PACKED_STRUCT struct wl_sd_tlv { 556 uint16 length; /* length of response_data */ 557 uint8 protocol; /* service protocol type */ 558 uint8 transaction_id; /* service transaction id */ 559 uint8 status_code; /* status code */ 560 uint8 data[1]; /* response data */ 561 } BWL_POST_PACKED_STRUCT wl_sd_tlv_t; 562 563 /* service discovery event data */ 564 typedef BWL_PRE_PACKED_STRUCT struct wl_event_sd { 565 uint16 channel; /* channel */ 566 uint8 count; /* number of tlvs */ 567 wl_sd_tlv_t tlv[1]; /* service discovery TLV */ 568 } BWL_POST_PACKED_STRUCT wl_event_sd_t; 569 570 /* WLC_E_PKT_FILTER event sub-classification codes */ 571 #define WLC_E_PKT_FILTER_TIMEOUT 1 /* Matching packet not received in last timeout seconds */ 572 573 /* Note: proxd has a new API (ver 3.0) deprecates the following */ 574 575 /* Reason codes for WLC_E_PROXD */ 576 #define WLC_E_PROXD_FOUND 1 /* Found a proximity device */ 577 #define WLC_E_PROXD_GONE 2 /* Lost a proximity device */ 578 #define WLC_E_PROXD_START 3 /* used by: target */ 579 #define WLC_E_PROXD_STOP 4 /* used by: target */ 580 #define WLC_E_PROXD_COMPLETED 5 /* used by: initiator completed */ 581 #define WLC_E_PROXD_ERROR 6 /* used by both initiator and target */ 582 #define WLC_E_PROXD_COLLECT_START 7 /* used by: target & initiator */ 583 #define WLC_E_PROXD_COLLECT_STOP 8 /* used by: target */ 584 #define WLC_E_PROXD_COLLECT_COMPLETED 9 /* used by: initiator completed */ 585 #define WLC_E_PROXD_COLLECT_ERROR 10 /* used by both initiator and target */ 586 #define WLC_E_PROXD_NAN_EVENT 11 /* used by both initiator and target */ 587 #define WLC_E_PROXD_TS_RESULTS 12 /* used by: initiator completed */ 588 589 /* proxd_event data */ 590 typedef struct ftm_sample { 591 uint32 value; /* RTT in ns */ 592 int8 rssi; /* RSSI */ 593 } ftm_sample_t; 594 595 typedef struct ts_sample { 596 uint32 t1; 597 uint32 t2; 598 uint32 t3; 599 uint32 t4; 600 } ts_sample_t; 601 602 typedef BWL_PRE_PACKED_STRUCT struct proxd_event_data { 603 uint16 ver; /* version */ 604 uint16 mode; /* mode: target/initiator */ 605 uint16 method; /* method: rssi/TOF/AOA */ 606 uint8 err_code; /* error classification */ 607 uint8 TOF_type; /* one way or two way TOF */ 608 uint8 OFDM_frame_type; /* legacy or VHT */ 609 uint8 bandwidth; /* Bandwidth is 20, 40,80, MHZ */ 610 struct ether_addr peer_mac; /* (e.g for tgt:initiator's */ 611 uint32 distance; /* dst to tgt, units meter */ 612 uint32 meanrtt; /* mean delta */ 613 uint32 modertt; /* Mode delta */ 614 uint32 medianrtt; /* median RTT */ 615 uint32 sdrtt; /* Standard deviation of RTT */ 616 int32 gdcalcresult; /* Software or Hardware Kind of redundant, but if */ 617 /* frame type is VHT, then we should do it by hardware */ 618 int16 avg_rssi; /* avg rssi accroos the ftm frames */ 619 int16 validfrmcnt; /* Firmware's valid frame counts */ 620 int32 peer_router_info; /* Peer router information if available in TLV, */ 621 /* We will add this field later */ 622 int32 var1; /* average of group delay */ 623 int32 var2; /* average of threshold crossing */ 624 int32 var3; /* difference between group delay and threshold crossing */ 625 /* raw Fine Time Measurements (ftm) data */ 626 uint16 ftm_unit; /* ftm cnt resolution in picoseconds , 6250ps - default */ 627 uint16 ftm_cnt; /* num of rtd measurments/length in the ftm buffer */ 628 ftm_sample_t ftm_buff[1]; /* 1 ... ftm_cnt */ 629 } BWL_POST_PACKED_STRUCT wl_proxd_event_data_t; 630 631 typedef BWL_PRE_PACKED_STRUCT struct proxd_event_ts_results { 632 uint16 ver; /* version */ 633 uint16 mode; /* mode: target/initiator */ 634 uint16 method; /* method: rssi/TOF/AOA */ 635 uint8 err_code; /* error classification */ 636 uint8 TOF_type; /* one way or two way TOF */ 637 uint16 ts_cnt; /* number of timestamp measurements */ 638 ts_sample_t ts_buff[1]; /* Timestamps */ 639 } BWL_POST_PACKED_STRUCT wl_proxd_event_ts_results_t; 640 641 642 /* Video Traffic Interference Monitor Event */ 643 #define INTFER_EVENT_VERSION 1 644 #define INTFER_STREAM_TYPE_NONTCP 1 645 #define INTFER_STREAM_TYPE_TCP 2 646 #define WLINTFER_STATS_NSMPLS 4 647 typedef struct wl_intfer_event { 648 uint16 version; /* version */ 649 uint16 status; /* status */ 650 uint8 txfail_histo[WLINTFER_STATS_NSMPLS]; /* txfail histo */ 651 } wl_intfer_event_t; 652 653 #define RRM_EVENT_VERSION 0 654 typedef struct wl_rrm_event { 655 int16 version; 656 int16 len; 657 int16 cat; /* Category */ 658 int16 subevent; 659 char payload[1]; /* Measurement payload */ 660 } wl_rrm_event_t; 661 662 663 /* WLC_E_PSTA_PRIMARY_INTF_IND event data */ 664 typedef struct wl_psta_primary_intf_event { 665 struct ether_addr prim_ea; /* primary intf ether addr */ 666 } wl_psta_primary_intf_event_t; 667 668 /* WLC_E_DPSTA_INTF_IND event data */ 669 typedef enum { 670 WL_INTF_PSTA = 1, 671 WL_INTF_DWDS = 2 672 } wl_dpsta_intf_type; 673 674 typedef struct wl_dpsta_intf_event { 675 wl_dpsta_intf_type intf_type; /* dwds/psta intf register */ 676 } wl_dpsta_intf_event_t; 677 678 /* ********** NAN protocol events/subevents ********** */ 679 #define NAN_EVENT_BUFFER_SIZE 512 /* max size */ 680 /* NAN Events sent by firmware */ 681 682 /* 683 * If you make changes to this enum, dont forget to update the mask (if need be). 684 */ 685 typedef enum wl_nan_events { 686 WL_NAN_EVENT_START = 1, /* NAN cluster started */ 687 WL_NAN_EVENT_JOIN = 2, /* To be deprecated */ 688 WL_NAN_EVENT_ROLE = 3, /* Role changed */ 689 WL_NAN_EVENT_SCAN_COMPLETE = 4, /* To be deprecated */ 690 WL_NAN_EVENT_DISCOVERY_RESULT = 5, /* Subscribe Received */ 691 WL_NAN_EVENT_REPLIED = 6, /* Publish Sent */ 692 WL_NAN_EVENT_TERMINATED = 7, /* sub / pub is terminated */ 693 WL_NAN_EVENT_RECEIVE = 8, /* Follow up Received */ 694 WL_NAN_EVENT_STATUS_CHG = 9, /* change in nan_mac status */ 695 WL_NAN_EVENT_MERGE = 10, /* Merged to a NAN cluster */ 696 WL_NAN_EVENT_STOP = 11, /* To be deprecated */ 697 WL_NAN_EVENT_P2P = 12, /* Unused */ 698 WL_NAN_EVENT_WINDOW_BEGIN_P2P = 13, /* Unused */ 699 WL_NAN_EVENT_WINDOW_BEGIN_MESH = 14, /* Unused */ 700 WL_NAN_EVENT_WINDOW_BEGIN_IBSS = 15, /* Unused */ 701 WL_NAN_EVENT_WINDOW_BEGIN_RANGING = 16, /* Unused */ 702 WL_NAN_EVENT_POST_DISC = 17, /* Event for post discovery data */ 703 WL_NAN_EVENT_DATA_IF_ADD = 18, /* Unused */ 704 WL_NAN_EVENT_DATA_PEER_ADD = 19, /* Event for peer add */ 705 /* nan 2.0 */ 706 /* Will be removed after source code is committed. */ 707 WL_NAN_EVENT_DATA_IND = 20, 708 WL_NAN_EVENT_PEER_DATAPATH_IND = 20, /* Incoming DP req */ 709 /* Will be removed after source code is committed. */ 710 WL_NAN_EVENT_DATA_CONF = 21, 711 WL_NAN_EVENT_DATAPATH_ESTB = 21, /* DP Established */ 712 WL_NAN_EVENT_SDF_RX = 22, /* SDF payload */ 713 WL_NAN_EVENT_DATAPATH_END = 23, /* DP Terminate recvd */ 714 /* Below event needs to be removed after source code is committed. */ 715 WL_NAN_EVENT_DATA_END = 23, 716 WL_NAN_EVENT_BCN_RX = 24, /* received beacon payload */ 717 WL_NAN_EVENT_PEER_DATAPATH_RESP = 25, /* Peer's DP response */ 718 WL_NAN_EVENT_PEER_DATAPATH_CONF = 26, /* Peer's DP confirm */ 719 WL_NAN_EVENT_RNG_REQ_IND = 27, /* Range Request */ 720 WL_NAN_EVENT_RNG_RPT_IND = 28, /* Range Report */ 721 WL_NAN_EVENT_RNG_TERM_IND = 29, /* Range Termination */ 722 WL_NAN_EVENT_PEER_DATAPATH_SEC_INST = 30, /* Peer's DP sec install */ 723 WL_NAN_EVENT_TXS = 31, /* for tx status of follow-up and SDFs */ 724 WL_NAN_EVENT_INVALID /* delimiter for max value */ 725 } nan_app_events_e; 726 727 #define NAN_EV_MASK(ev) \ 728 (1 << (ev - 1)) 729 #define IS_NAN_EVT_ON(var, evt) ((var & (1 << (evt-1))) != 0) 730 /* ******************* end of NAN section *************** */ 731 732 /* WLC_E_ULP event data */ 733 #define WL_ULP_EVENT_VERSION 1 734 #define WL_ULP_DISABLE_CONSOLE 1 /* Disable console message on ULP entry */ 735 #define WL_ULP_UCODE_DOWNLOAD 2 /* Download ULP ucode file */ 736 737 typedef struct wl_ulp_event { 738 uint16 version; 739 uint16 ulp_dongle_action; 740 } wl_ulp_event_t; 741 742 /* TCP keepalive event data */ 743 typedef BWL_PRE_PACKED_STRUCT struct wl_event_tko { 744 uint8 index; /* TCP connection index, 0 to max-1 */ 745 uint8 pad[3]; /* 4-byte struct alignment */ 746 } BWL_POST_PACKED_STRUCT wl_event_tko_t; 747 748 typedef struct { 749 uint8 radar_type; /* one of RADAR_TYPE_XXX */ 750 uint16 min_pw; /* minimum pulse-width (usec * 20) */ 751 uint16 max_pw; /* maximum pulse-width (usec * 20) */ 752 uint16 min_pri; /* minimum pulse repetition interval (usec) */ 753 uint16 max_pri; /* maximum pulse repetition interval (usec) */ 754 uint16 subband; /* subband/frequency */ 755 } radar_detected_event_info_t; 756 757 typedef struct wl_event_radar_detect_data { 758 uint32 version; 759 uint16 current_chanspec; /* chanspec on which the radar is recieved */ 760 uint16 target_chanspec; /* Target chanspec after detection of radar on current_chanspec */ 761 radar_detected_event_info_t radar_info[2]; 762 } wl_event_radar_detect_data_t; 763 764 765 #define WL_EVENT_MODESW_VER_1 1 766 #define WL_EVENT_MODESW_VER_CURRENT WL_EVENT_MODESW_VER_1 767 768 #define WL_E_MODESW_FLAG_MASK_DEVICE 0x01u /* mask of device: belongs to local or peer */ 769 #define WL_E_MODESW_FLAG_MASK_FROM 0x02u /* mask of origin: firmware or user */ 770 #define WL_E_MODESW_FLAG_MASK_STATE 0x0Cu /* mask of state: modesw progress state */ 771 772 #define WL_E_MODESW_FLAG_DEVICE_LOCAL 0x00u /* flag - device: info is about self/local */ 773 #define WL_E_MODESW_FLAG_DEVICE_PEER 0x01u /* flag - device: info is about peer */ 774 775 #define WL_E_MODESW_FLAG_FROM_FIRMWARE 0x00u /* flag - from: request is from firmware */ 776 #define WL_E_MODESW_FLAG_FROM_USER 0x02u /* flag - from: request is from user/iov */ 777 778 #define WL_E_MODESW_FLAG_STATE_REQUESTED 0x00u /* flag - state: mode switch request */ 779 #define WL_E_MODESW_FLAG_STATE_INITIATED 0x04u /* flag - state: switch initiated */ 780 #define WL_E_MODESW_FLAG_STATE_COMPLETE 0x08u /* flag - state: switch completed/success */ 781 #define WL_E_MODESW_FLAG_STATE_FAILURE 0x0Cu /* flag - state: failed to switch */ 782 783 /* Get sizeof *X including variable data's length where X is pointer to wl_event_mode_switch_t */ 784 #define WL_E_MODESW_SIZE(X) (sizeof(*(X)) + (X)->length) 785 786 /* Get variable data's length where X is pointer to wl_event_mode_switch_t */ 787 #define WL_E_MODESW_DATA_SIZE(X) (((X)->length > sizeof(*(X))) ? ((X)->length - sizeof(*(X))) : 0) 788 789 #define WL_E_MODESW_REASON_UNKNOWN 0u /* reason: UNKNOWN */ 790 #define WL_E_MODESW_REASON_ACSD 1u /* reason: ACSD (based on events from FW */ 791 #define WL_E_MODESW_REASON_OBSS_DBS 2u /* reason: OBSS DBS (eg. on interference) */ 792 #define WL_E_MODESW_REASON_DFS 3u /* reason: DFS (eg. on subband radar) */ 793 #define WL_E_MODESW_REASON_DYN160 4u /* reason: DYN160 (160/2x2 - 80/4x4) */ 794 795 /* event structure for WLC_E_MODE_SWITCH */ 796 typedef struct { 797 uint16 version; 798 uint16 length; /* size including 'data' field */ 799 uint16 opmode_from; 800 uint16 opmode_to; 801 uint32 flags; /* bit 0: peer(/local==0); 802 * bit 1: user(/firmware==0); 803 * bits 3,2: 00==requested, 01==initiated, 804 * 10==complete, 11==failure; 805 * rest: reserved 806 */ 807 uint16 reason; /* value 0: unknown, 1: ACSD, 2: OBSS_DBS, 808 * 3: DFS, 4: DYN160, rest: reserved 809 */ 810 uint16 data_offset; /* offset to 'data' from beginning of this struct. 811 * fields may be added between data_offset and data 812 */ 813 /* ADD NEW FIELDS HERE */ 814 uint8 data[]; /* reason specific data; could be empty */ 815 } wl_event_mode_switch_t; 816 817 /* when reason in WLC_E_MODE_SWITCH is DYN160, data will carry the following structure */ 818 typedef struct { 819 uint16 trigger; /* value 0: MU to SU, 1: SU to MU, 2: metric_dyn160, 3:re-/assoc, 820 * 4: disassoc, 5: rssi, 6: traffic, 7: interference, 821 * 8: chanim_stats 822 */ 823 struct ether_addr sta_addr; /* causal STA's MAC address when known */ 824 uint16 metric_160_80; /* latest dyn160 metric */ 825 uint8 nss; /* NSS of the STA */ 826 uint8 bw; /* BW of the STA */ 827 int8 rssi; /* RSSI of the STA */ 828 uint8 traffic; /* internal metric of traffic */ 829 } wl_event_mode_switch_dyn160; 830 831 #define WL_EVENT_FBT_VER_1 1 832 833 #define WL_E_FBT_TYPE_FBT_OTD_AUTH 1 834 #define WL_E_FBT_TYPE_FBT_OTA_AUTH 2 835 836 /* event structure for WLC_E_FBT */ 837 typedef struct { 838 uint16 version; 839 uint16 length; /* size including 'data' field */ 840 uint16 type; /* value 0: unknown, 1: FBT OTD Auth Req */ 841 uint16 data_offset; /* offset to 'data' from beginning of this struct. 842 * fields may be added between data_offset and data 843 */ 844 /* ADD NEW FIELDS HERE */ 845 uint8 data[]; /* type specific data; could be empty */ 846 } wl_event_fbt_t; 847 848 /* TWT Setup Completion is designed to notify the user of TWT Setup process 849 * status. When 'status' field is value of BCME_OK, the user must check the 850 * 'setup_cmd' field value in 'wl_twt_sdesc_t' structure that at the end of 851 * the event data to see the response from the TWT Responding STA; when 852 * 'status' field is value of BCME_ERROR or non BCME_OK, user must not use 853 * anything from 'wl_twt_sdesc_t' structure as it is the TWT Requesting STA's 854 * own TWT parameter. 855 */ 856 857 #define WL_TWT_SETUP_CPLT_VER 0 858 859 /* TWT Setup Completion event data */ 860 typedef struct wl_twt_setup_cplt { 861 uint16 version; 862 uint16 length; /* the byte count of fields from 'dialog' onwards */ 863 uint8 dialog; /* the dialog token user supplied to the TWT setup API */ 864 uint8 pad[3]; 865 int32 status; 866 /* wl_twt_sdesc_t desc; - defined in wlioctl.h */ 867 } wl_twt_setup_cplt_t; 868 869 #define WL_INVALID_IE_EVENT_VERSION 0 870 871 /* Invalid IE Event data */ 872 typedef struct wl_invalid_ie_event { 873 uint16 version; 874 uint16 len; /* Length of the invalid IE copy */ 875 uint16 type; /* Type/subtype of the frame which contains the invalid IE */ 876 uint16 error; /* error code of the wrong IE, defined in ie_error_code_t */ 877 uint8 ie[]; /* Variable length buffer for the invalid IE copy */ 878 } wl_invalid_ie_event_t; 879 880 /* Fixed header portion of Invalid IE Event */ 881 typedef struct wl_invalid_ie_event_hdr { 882 uint16 version; 883 uint16 len; /* Length of the invalid IE copy */ 884 uint16 type; /* Type/subtype of the frame which contains the invalid IE */ 885 uint16 error; /* error code of the wrong IE, defined in ie_error_code_t */ 886 /* var length IE data follows */ 887 } wl_invalid_ie_event_hdr_t; 888 889 typedef enum ie_error_code { 890 IE_ERROR_OUT_OF_RANGE = 0x01 891 } ie_error_code_t; 892 893 /* This marks the end of a packed structure section. */ 894 #include <packed_section_end.h> 895 896 /* reason of channel switch */ 897 typedef enum { 898 CHANSW_DFS = 10, /* channel switch due to DFS module */ 899 CHANSW_HOMECH_REQ = 14, /* channel switch due to HOME Channel Request */ 900 CHANSW_STA = 15, /* channel switch due to STA */ 901 CHANSW_SOFTAP = 16, /* channel switch due to SodtAP */ 902 CHANSW_AIBSS = 17, /* channel switch due to AIBSS */ 903 CHANSW_NAN = 18, /* channel switch due to NAN */ 904 CHANSW_NAN_DISC = 19, /* channel switch due to NAN Disc */ 905 CHANSW_NAN_SCHED = 20, /* channel switch due to NAN Sched */ 906 CHANSW_AWDL_AW = 21, /* channel switch due to AWDL aw */ 907 CHANSW_AWDL_SYNC = 22, /* channel switch due to AWDL sync */ 908 CHANSW_AWDL_CAL = 23, /* channel switch due to AWDL Cal */ 909 CHANSW_AWDL_PSF = 24, /* channel switch due to AWDL PSF */ 910 CHANSW_AWDL_OOB_AF = 25, /* channel switch due to AWDL OOB action frame */ 911 CHANSW_TDLS = 26, /* channel switch due to TDLS */ 912 CHANSW_PROXD = 27, /* channel switch due to PROXD */ 913 CHANSW_MAX_NUMBER = 28 /* max channel switch reason */ 914 } wl_chansw_reason_t; 915 916 #define CHANSW_REASON(reason) (1 << reason) 917 918 #define EVENT_AGGR_DATA_HDR_LEN 8 919 920 typedef struct event_aggr_data { 921 uint16 num_events; /* No of events aggregated */ 922 uint16 len; /* length of the aggregated events, excludes padding */ 923 uint8 pad[4]; /* Padding to make aggr event packet header aligned 924 * on 64-bit boundary, for a 64-bit host system. 925 */ 926 uint8 data[]; /* Aggregate buffer containing Events */ 927 } event_aggr_data_t; 928 929 930 /* WLC_E_TVPM_MITIGATION event structure version */ 931 #define WL_TVPM_MITIGATION_VERSION 1 932 933 /* TVPM mitigation on/off status bits */ 934 #define WL_TVPM_MITIGATION_TXDC 0x1 935 #define WL_TVPM_MITIGATION_TXPOWER 0x2 936 #define WL_TVPM_MITIGATION_TXCHAINS 0x4 937 938 /* Event structure for WLC_E_TVPM_MITIGATION */ 939 typedef struct wl_event_tvpm_mitigation { 940 uint16 version; /* structure version */ 941 uint16 length; /* length of this structure */ 942 uint32 timestamp_ms; /* millisecond timestamp */ 943 uint8 slice; /* slice number */ 944 uint8 pad; 945 uint16 on_off; /* mitigation status bits */ 946 } wl_event_tvpm_mitigation_t; 947 948 #endif /* _BCMEVENT_H_ */ 949