1 /* 2 * Broadcom Event protocol definitions 3 * 4 * Dependencies: bcmeth.h 5 * 6 * Copyright (C) 2020, Broadcom. 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 * 23 * <<Broadcom-WL-IPTag/Dual:>> 24 * 25 */ 26 27 /* 28 * Broadcom Ethernet Events protocol defines 29 * 30 */ 31 32 #ifndef _BCMEVENT_H_ 33 #define _BCMEVENT_H_ 34 35 #include <typedefs.h> 36 /* #include <ethernet.h> -- TODO: req., excluded to overwhelming coupling (break up ethernet.h) */ 37 #include <bcmeth.h> 38 #if defined(HEALTH_CHECK) || defined(DNGL_EVENT_SUPPORT) 39 #include <dnglevent.h> 40 #endif /* HEALTH_CHECK || DNGL_EVENT_SUPPORT */ 41 42 /* This marks the start of a packed structure section. */ 43 #include <packed_section_start.h> 44 45 #define BCM_EVENT_MSG_VERSION 2 /* wl_event_msg_t struct version */ 46 #define BCM_MSG_IFNAME_MAX 16 /* max length of interface name */ 47 48 /* flags */ 49 #define WLC_EVENT_MSG_LINK 0x01 /* link is up */ 50 #define WLC_EVENT_MSG_FLUSHTXQ 0x02 /* flush tx queue on MIC error */ 51 #define WLC_EVENT_MSG_GROUP 0x04 /* group MIC error */ 52 #define WLC_EVENT_MSG_UNKBSS 0x08 /* unknown source bsscfg */ 53 #define WLC_EVENT_MSG_UNKIF 0x10 /* unknown source OS i/f */ 54 55 /* these fields are stored in network order */ 56 57 /* version 1 */ 58 typedef BWL_PRE_PACKED_STRUCT struct 59 { 60 uint16 version; 61 uint16 flags; /* see flags below */ 62 uint32 event_type; /* Message (see below) */ 63 uint32 status; /* Status code (see below) */ 64 uint32 reason; /* Reason code (if applicable) */ 65 uint32 auth_type; /* WLC_E_AUTH */ 66 uint32 datalen; /* data buf */ 67 struct ether_addr addr; /* Station address (if applicable) */ 68 char ifname[BCM_MSG_IFNAME_MAX]; /* name of the packet incoming interface */ 69 } BWL_POST_PACKED_STRUCT wl_event_msg_v1_t; 70 71 /* the current version */ 72 typedef BWL_PRE_PACKED_STRUCT struct 73 { 74 uint16 version; 75 uint16 flags; /* see flags below */ 76 uint32 event_type; /* Message (see below) */ 77 uint32 status; /* Status code (see below) */ 78 uint32 reason; /* Reason code (if applicable) */ 79 uint32 auth_type; /* WLC_E_AUTH */ 80 uint32 datalen; /* data buf */ 81 struct ether_addr addr; /* Station address (if applicable) */ 82 char ifname[BCM_MSG_IFNAME_MAX]; /* name of the packet incoming interface */ 83 uint8 ifidx; /* destination OS i/f index */ 84 uint8 bsscfgidx; /* source bsscfg index */ 85 } BWL_POST_PACKED_STRUCT wl_event_msg_t; 86 87 /* used by driver msgs */ 88 typedef BWL_PRE_PACKED_STRUCT struct bcm_event { 89 struct ether_header eth; 90 bcmeth_hdr_t bcm_hdr; 91 wl_event_msg_t event; 92 /* data portion follows */ 93 } BWL_POST_PACKED_STRUCT bcm_event_t; 94 95 /* 96 * used by host event 97 * note: if additional event types are added, it should go with is_wlc_event_frame() as well. 98 */ 99 typedef union bcm_event_msg_u { 100 wl_event_msg_t event; 101 #if defined(HEALTH_CHECK) || defined(DNGL_EVENT_SUPPORT) 102 bcm_dngl_event_msg_t dngl_event; 103 #endif /* HEALTH_CHECK || DNGL_EVENT_SUPPORT */ 104 105 /* add new event here */ 106 } bcm_event_msg_u_t; 107 108 #define BCM_MSG_LEN (sizeof(bcm_event_t) - sizeof(bcmeth_hdr_t) - sizeof(struct ether_header)) 109 110 /* Event messages */ 111 #define WLC_E_SET_SSID 0 /* indicates status of set SSID */ 112 #define WLC_E_JOIN 1 /* differentiates join IBSS from found (WLC_E_START) IBSS */ 113 #define WLC_E_START 2 /* STA founded an IBSS or AP started a BSS */ 114 #define WLC_E_AUTH 3 /* 802.11 AUTH request */ 115 #define WLC_E_AUTH_IND 4 /* 802.11 AUTH indication */ 116 #define WLC_E_DEAUTH 5 /* 802.11 DEAUTH request */ 117 #define WLC_E_DEAUTH_IND 6 /* 802.11 DEAUTH indication */ 118 #define WLC_E_ASSOC 7 /* 802.11 ASSOC request */ 119 #define WLC_E_ASSOC_IND 8 /* 802.11 ASSOC indication */ 120 #define WLC_E_REASSOC 9 /* 802.11 REASSOC request */ 121 #define WLC_E_REASSOC_IND 10 /* 802.11 REASSOC indication */ 122 #define WLC_E_DISASSOC 11 /* 802.11 DISASSOC request */ 123 #define WLC_E_DISASSOC_IND 12 /* 802.11 DISASSOC indication */ 124 #define WLC_E_QUIET_START 13 /* 802.11h Quiet period started */ 125 #define WLC_E_QUIET_END 14 /* 802.11h Quiet period ended */ 126 #define WLC_E_BEACON_RX 15 /* BEACONS received/lost indication */ 127 #define WLC_E_LINK 16 /* generic link indication */ 128 #define WLC_E_MIC_ERROR 17 /* TKIP MIC error occurred */ 129 #define WLC_E_NDIS_LINK 18 /* NDIS style link indication */ 130 #define WLC_E_ROAM 19 /* roam complete: indicate status & reason */ 131 #define WLC_E_TXFAIL 20 /* change in dot11FailedCount (txfail) */ 132 #define WLC_E_PMKID_CACHE 21 /* WPA2 pmkid cache indication */ 133 #define WLC_E_RETROGRADE_TSF 22 /* current AP's TSF value went backward */ 134 #define WLC_E_PRUNE 23 /* AP was pruned from join list for reason */ 135 #define WLC_E_AUTOAUTH 24 /* report AutoAuth table entry match for join attempt */ 136 #define WLC_E_EAPOL_MSG 25 /* Event encapsulating an EAPOL message */ 137 #define WLC_E_SCAN_COMPLETE 26 /* Scan results are ready or scan was aborted */ 138 #define WLC_E_ADDTS_IND 27 /* indicate to host addts fail/success */ 139 #define WLC_E_DELTS_IND 28 /* indicate to host delts fail/success */ 140 #define WLC_E_BCNSENT_IND 29 /* indicate to host of beacon transmit */ 141 #define WLC_E_BCNRX_MSG 30 /* Send the received beacon up to the host */ 142 #define WLC_E_BCNLOST_MSG 31 /* indicate to host loss of beacon */ 143 #define WLC_E_ROAM_PREP 32 /* before attempting to roam association */ 144 #define WLC_E_PFN_NET_FOUND 33 /* PFN network found event */ 145 #define WLC_E_PFN_NET_LOST 34 /* PFN network lost event */ 146 #define WLC_E_RESET_COMPLETE 35 147 #define WLC_E_JOIN_START 36 148 #define WLC_E_ROAM_START 37 /* roam attempt started: indicate reason */ 149 #define WLC_E_ASSOC_START 38 150 #define WLC_E_IBSS_ASSOC 39 151 #define WLC_E_RADIO 40 152 #define WLC_E_PSM_WATCHDOG 41 /* PSM microcode watchdog fired */ 153 154 #define WLC_E_PROBREQ_MSG 44 /* probe request received */ 155 #define WLC_E_SCAN_CONFIRM_IND 45 156 #define WLC_E_PSK_SUP 46 /* WPA Handshake fail */ 157 #define WLC_E_COUNTRY_CODE_CHANGED 47 158 #define WLC_E_EXCEEDED_MEDIUM_TIME 48 /* WMMAC excedded medium time */ 159 #define WLC_E_ICV_ERROR 49 /* WEP ICV error occurred */ 160 #define WLC_E_UNICAST_DECODE_ERROR 50 /* Unsupported unicast encrypted frame */ 161 #define WLC_E_MULTICAST_DECODE_ERROR 51 /* Unsupported multicast encrypted frame */ 162 #define WLC_E_TRACE 52 163 #define WLC_E_IF 54 /* I/F change (for dongle host notification) */ 164 #define WLC_E_P2P_DISC_LISTEN_COMPLETE 55 /* listen state expires */ 165 #define WLC_E_RSSI 56 /* indicate RSSI change based on configured levels */ 166 #define WLC_E_PFN_BEST_BATCHING 57 /* PFN best network batching event */ 167 #define WLC_E_EXTLOG_MSG 58 168 #define WLC_E_ACTION_FRAME 59 /* Action frame Rx */ 169 #define WLC_E_ACTION_FRAME_COMPLETE 60 /* Action frame Tx complete */ 170 #define WLC_E_PRE_ASSOC_IND 61 /* assoc request received */ 171 #define WLC_E_PRE_REASSOC_IND 62 /* re-assoc request received */ 172 #ifdef CSI_SUPPORT 173 #define WLC_E_CSI 63 174 #else 175 #define WLC_E_CHANNEL_ADOPTED 63 /* channel adopted (obsoleted) */ 176 #endif /* CSI_SUPPORT */ 177 #define WLC_E_AP_STARTED 64 /* AP started */ 178 #define WLC_E_DFS_AP_STOP 65 /* AP stopped due to DFS */ 179 #define WLC_E_DFS_AP_RESUME 66 /* AP resumed due to DFS */ 180 #define WLC_E_WAI_STA_EVENT 67 /* WAI stations event */ 181 #define WLC_E_WAI_MSG 68 /* event encapsulating an WAI message */ 182 #define WLC_E_ESCAN_RESULT 69 /* escan result event */ 183 #define WLC_E_ACTION_FRAME_OFF_CHAN_COMPLETE 70 /* action frame off channel complete */ 184 #define WLC_E_PROBRESP_MSG 71 /* probe response received */ 185 #define WLC_E_P2P_PROBREQ_MSG 72 /* P2P Probe request received */ 186 #define WLC_E_DCS_REQUEST 73 187 /* will enable this after proptxstatus code is merged back to ToT */ 188 #define WLC_E_FIFO_CREDIT_MAP 74 /* credits for D11 FIFOs. [AC0,AC1,AC2,AC3,BC_MC,ATIM] */ 189 #define WLC_E_ACTION_FRAME_RX 75 /* Received action frame event WITH 190 * wl_event_rx_frame_data_t header 191 */ 192 #define WLC_E_WAKE_EVENT 76 /* Wake Event timer fired, used for wake WLAN test mode */ 193 #define WLC_E_RM_COMPLETE 77 /* Radio measurement complete */ 194 #define WLC_E_HTSFSYNC 78 /* Synchronize TSF with the host */ 195 #define WLC_E_OVERLAY_REQ 79 /* request an overlay IOCTL/iovar from the host */ 196 #define WLC_E_CSA_COMPLETE_IND 80 /* 802.11 CHANNEL SWITCH ACTION completed */ 197 #define WLC_E_EXCESS_PM_WAKE_EVENT 81 /* excess PM Wake Event to inform host */ 198 #define WLC_E_PFN_SCAN_NONE 82 /* no PFN networks around */ 199 /* PFN BSSID network found event, conflict/share with WLC_E_PFN_SCAN_NONE */ 200 #define WLC_E_PFN_BSSID_NET_FOUND 82 201 #define WLC_E_PFN_SCAN_ALLGONE 83 /* last found PFN network gets lost */ 202 /* PFN BSSID network lost event, conflict/share with WLC_E_PFN_SCAN_ALLGONE */ 203 #define WLC_E_PFN_BSSID_NET_LOST 83 204 #define WLC_E_GTK_PLUMBED 84 205 #define WLC_E_ASSOC_IND_NDIS 85 /* 802.11 ASSOC indication for NDIS only */ 206 #define WLC_E_REASSOC_IND_NDIS 86 /* 802.11 REASSOC indication for NDIS only */ 207 #define WLC_E_ASSOC_REQ_IE 87 208 #define WLC_E_ASSOC_RESP_IE 88 209 #define WLC_E_ASSOC_RECREATED 89 /* association recreated on resume */ 210 #define WLC_E_ACTION_FRAME_RX_NDIS 90 /* rx action frame event for NDIS only */ 211 #define WLC_E_AUTH_REQ 91 /* authentication request received */ 212 #define WLC_E_TDLS_PEER_EVENT 92 /* discovered peer, connected/disconnected peer */ 213 #define WLC_E_SPEEDY_RECREATE_FAIL 93 /* fast assoc recreation failed */ 214 #define WLC_E_NATIVE 94 /* port-specific event and payload (e.g. NDIS) */ 215 #define WLC_E_PKTDELAY_IND 95 /* event for tx pkt delay suddently jump */ 216 217 #ifdef WLAWDL 218 #define WLC_E_AWDL_AW 96 /* AWDL AW period starts */ 219 #define WLC_E_AWDL_ROLE 97 /* AWDL Master/Slave/NE master role event */ 220 #define WLC_E_AWDL_EVENT 98 /* Generic AWDL event */ 221 #endif /* WLAWDL */ 222 223 #define WLC_E_PSTA_PRIMARY_INTF_IND 99 /* psta primary interface indication */ 224 #define WLC_E_NAN 100 /* NAN event - Reserved for future */ 225 #define WLC_E_BEACON_FRAME_RX 101 226 #define WLC_E_SERVICE_FOUND 102 /* desired service found */ 227 #define WLC_E_GAS_FRAGMENT_RX 103 /* GAS fragment received */ 228 #define WLC_E_GAS_COMPLETE 104 /* GAS sessions all complete */ 229 #define WLC_E_P2PO_ADD_DEVICE 105 /* New device found by p2p offload */ 230 #define WLC_E_P2PO_DEL_DEVICE 106 /* device has been removed by p2p offload */ 231 #define WLC_E_WNM_STA_SLEEP 107 /* WNM event to notify STA enter sleep mode */ 232 #define WLC_E_TXFAIL_THRESH 108 /* Indication of MAC tx failures (exhaustion of 233 * 802.11 retries) exceeding threshold(s) 234 */ 235 #define WLC_E_PROXD 109 /* Proximity Detection event */ 236 #define WLC_E_IBSS_COALESCE 110 /* IBSS Coalescing */ 237 #define WLC_E_AIBSS_TXFAIL 110 /* TXFAIL event for AIBSS, re using event 110 */ 238 #define WLC_E_BSS_LOAD 114 /* Inform host of beacon bss load */ 239 #define WLC_E_MIMO_PWR_SAVE 115 /* Inform host MIMO PWR SAVE learning events */ 240 #define WLC_E_LEAKY_AP_STATS 116 /* Inform host leaky Ap stats events */ 241 #define WLC_E_ALLOW_CREDIT_BORROW 117 /* Allow or disallow wlfc credit borrowing in DHD */ 242 #define WLC_E_MSCH 120 /* Multiple channel scheduler event */ 243 #define WLC_E_CSA_START_IND 121 244 #define WLC_E_CSA_DONE_IND 122 245 #define WLC_E_CSA_FAILURE_IND 123 246 #define WLC_E_CCA_CHAN_QUAL 124 /* CCA based channel quality report */ 247 #define WLC_E_BSSID 125 /* to report change in BSSID while roaming */ 248 #define WLC_E_TX_STAT_ERROR 126 /* tx error indication */ 249 #define WLC_E_BCMC_CREDIT_SUPPORT 127 /* credit check for BCMC supported */ 250 #define WLC_E_PEER_TIMEOUT 128 /* silently drop a STA because of inactivity */ 251 #define WLC_E_BT_WIFI_HANDOVER_REQ 130 /* Handover Request Initiated */ 252 #define WLC_E_SPW_TXINHIBIT 131 /* Southpaw TxInhibit notification */ 253 #define WLC_E_FBT_AUTH_REQ_IND 132 /* FBT Authentication Request Indication */ 254 #define WLC_E_RSSI_LQM 133 /* Enhancement addition for WLC_E_RSSI */ 255 #define WLC_E_PFN_GSCAN_FULL_RESULT 134 /* Full probe/beacon (IEs etc) results */ 256 #define WLC_E_PFN_SWC 135 /* Significant change in rssi of bssids being tracked */ 257 #define WLC_E_AUTHORIZED 136 /* a STA been authroized for traffic */ 258 #define WLC_E_PROBREQ_MSG_RX 137 /* probe req with wl_event_rx_frame_data_t header */ 259 #define WLC_E_PFN_SCAN_COMPLETE 138 /* PFN completed scan of network list */ 260 #define WLC_E_RMC_EVENT 139 /* RMC Event */ 261 #define WLC_E_DPSTA_INTF_IND 140 /* DPSTA interface indication */ 262 #define WLC_E_RRM 141 /* RRM Event */ 263 #define WLC_E_PFN_SSID_EXT 142 /* SSID EXT event */ 264 #define WLC_E_ROAM_EXP_EVENT 143 /* Expanded roam event */ 265 #define WLC_E_ULP 146 /* ULP entered indication */ 266 #define WLC_E_MACDBG 147 /* Ucode debugging event */ 267 #define WLC_E_RESERVED 148 /* reserved */ 268 #define WLC_E_PRE_ASSOC_RSEP_IND 149 /* assoc resp received */ 269 #define WLC_E_PSK_AUTH 150 /* PSK AUTH WPA2-PSK 4 WAY Handshake failure */ 270 #define WLC_E_TKO 151 /* TCP keepalive offload */ 271 #define WLC_E_SDB_TRANSITION 152 /* SDB mode-switch event */ 272 #define WLC_E_NATOE_NFCT 153 /* natoe event */ 273 #define WLC_E_TEMP_THROTTLE 154 /* Temperature throttling control event */ 274 #define WLC_E_LINK_QUALITY 155 /* Link quality measurement complete */ 275 #define WLC_E_BSSTRANS_RESP 156 /* BSS Transition Response received */ 276 #define WLC_E_TWT_SETUP 157 /* TWT Setup Complete event */ 277 #define WLC_E_HE_TWT_SETUP 157 /* TODO:Remove after merging TWT changes to trunk */ 278 #define WLC_E_NAN_CRITICAL 158 /* NAN Critical Event */ 279 #define WLC_E_NAN_NON_CRITICAL 159 /* NAN Non-Critical Event */ 280 #define WLC_E_RADAR_DETECTED 160 /* Radar Detected event */ 281 #define WLC_E_RANGING_EVENT 161 /* Ranging event */ 282 #define WLC_E_INVALID_IE 162 /* Received invalid IE */ 283 #define WLC_E_MODE_SWITCH 163 /* Mode switch event */ 284 #define WLC_E_PKT_FILTER 164 /* Packet filter event */ 285 #define WLC_E_DMA_TXFLUSH_COMPLETE 165 /* TxFlush done before changing tx/rxchain */ 286 #define WLC_E_FBT 166 /* FBT event */ 287 #define WLC_E_PFN_SCAN_BACKOFF 167 /* PFN SCAN Backoff event */ 288 #define WLC_E_PFN_BSSID_SCAN_BACKOFF 168 /* PFN BSSID SCAN BAckoff event */ 289 #define WLC_E_AGGR_EVENT 169 /* Aggregated event */ 290 #define WLC_E_TVPM_MITIGATION 171 /* Change in mitigation applied by TVPM */ 291 #define WLC_E_SCAN_START 172 /* Deprecated */ 292 #define WLC_E_SCAN 172 /* Scan event */ 293 #define WLC_E_MBO 173 /* MBO event */ 294 #define WLC_E_PHY_CAL 174 /* Phy calibration start indication to host */ 295 #define WLC_E_RPSNOA 175 /* Radio power save start/end indication to host */ 296 #define WLC_E_ADPS 176 /* ADPS event */ 297 #define WLC_E_SLOTTED_BSS_PEER_OP 177 /* Per peer SCB delete */ 298 #define WLC_E_GTK_KEYROT_NO_CHANSW 179 /* Avoid Chanswitch while GTK key rotation */ 299 #define WLC_E_ONBODY_STATUS_CHANGE 180 /* Indication of onbody status change */ 300 #define WLC_E_BCNRECV_ABORTED 181 /* Fake AP bcnrecv aborted roam event */ 301 #define WLC_E_PMK_INFO 182 /* PMK,PMKID information event */ 302 #define WLC_E_BSSTRANS 183 /* BSS Transition request / Response */ 303 #define WLC_E_WA_LQM 184 /* link quality monitoring */ 304 #define WLC_E_ACTION_FRAME_OFF_CHAN_DWELL_COMPLETE 185 /* action frame off channel 305 * dwell time complete 306 */ 307 #define WLC_E_WSEC 186 /* wsec keymgmt event */ 308 #define WLC_E_OBSS_DETECTION 187 /* OBSS HW event */ 309 #define WLC_E_AP_BCN_MUTE 188 /* Beacon mute mitigation event */ 310 #define WLC_E_SC_CHAN_QUAL 189 /* Event to indicate the SC chanel quality */ 311 #define WLC_E_DYNSAR 190 /* Dynamic SAR indicate optimize on/off */ 312 #define WLC_E_ROAM_CACHE_UPDATE 191 /* Roam cache update indication */ 313 #define WLC_E_AP_BCN_DRIFT 192 /* Beacon Drift event */ 314 #define WLC_E_PFN_SCAN_ALLGONE_EXT 193 /* last found PFN network gets lost. */ 315 #define WLC_E_AUTH_START 194 /* notify upper layer to start auth */ 316 #define WLC_E_TWT_TEARDOWN 195 /* TWT Teardown Complete Event */ 317 #define WLC_E_TWT_INFO_FRM 196 /* TWT Info Event Notification */ 318 #define WLC_E_LAST 197 /* highest val + 1 for range checking */ 319 #if (WLC_E_LAST > 197) 320 #error "WLC_E_LAST: Invalid value for last event; must be <= 197." 321 #endif /* WLC_E_LAST */ 322 323 /* define an API for getting the string name of an event */ 324 extern const char *bcmevent_get_name(uint event_type); 325 extern void wl_event_to_host_order(wl_event_msg_t * evt); 326 extern void wl_event_to_network_order(wl_event_msg_t * evt); 327 328 /* validate if the event is proper and if valid copy event header to event */ 329 extern int is_wlc_event_frame(void *pktdata, uint pktlen, uint16 exp_usr_subtype, 330 bcm_event_msg_u_t *out_event); 331 332 /* conversion between host and network order for events */ 333 void wl_event_to_host_order(wl_event_msg_t * evt); 334 void wl_event_to_network_order(wl_event_msg_t * evt); 335 336 #define WLC_ROAM_EVENT_V1 0x1u 337 338 /* tlv ids for roam event */ 339 #define WLC_ROAM_NO_NETWORKS_TLV_ID 1 340 341 /* No Networks reasons */ 342 #define WLC_E_REASON_NO_NETWORKS 0x0u /* value 0 means no networks found */ 343 #define WLC_E_REASON_NO_NETWORKS_BY_SCORE 0x01u /* bit 1 indicates filtered by score */ 344 345 /* bit mask field indicating fail reason */ 346 typedef uint32 wlc_roam_fail_reason_t; 347 348 typedef struct wlc_roam_event_header { 349 uint16 version; /* version */ 350 uint16 length; /* total length */ 351 } wlc_roam_event_header_t; 352 353 typedef struct wlc_roam_event { 354 wlc_roam_event_header_t header; 355 uint8 xtlvs[]; /* data */ 356 } wl_roam_event_t; 357 358 #define WLC_ROAM_PREP_EVENT_V1 0x1u 359 #define WLC_ROAM_START_EVENT_V1 0x1u 360 361 typedef struct wlc_roam_start_event { 362 uint16 version; /* version */ 363 uint16 length; /* total length */ 364 int16 rssi; /* current bss rssi */ 365 int8 pad[2]; /* padding */ 366 uint8 xtlvs[]; /* optional xtlvs */ 367 } wlc_roam_start_event_t; 368 369 typedef struct wlc_roam_prep_event { 370 uint16 version; /* version */ 371 uint16 length; /* total length */ 372 int16 rssi; /* target bss rssi */ 373 int8 pad[2]; /* padding */ 374 uint8 xtlvs[]; /* optional xtlvs */ 375 } wlc_roam_prep_event_t; 376 377 #define WLC_ROAM_CACHE_UPDATE_EVENT_V1 0x1u 378 379 /* WLC_E_ROAM_CACHE_UPDATE event data prototype */ 380 typedef struct wlc_roam_cache_update_event { 381 uint16 version; /* version */ 382 uint16 length; /* total length */ 383 uint8 xtlvs[]; /* optional xtlvs */ 384 } wlc_roam_cache_update_event_t; 385 386 typedef enum wlc_roam_cache_update_reason { 387 WLC_ROAM_CACHE_UPDATE_NEW_ROAM_CACHE = 1, /* new roam cache */ 388 WLC_ROAM_CACHE_UPDATE_JOIN = 2, /* join bss */ 389 WLC_ROAM_CACHE_UPDATE_RSSI_DELTA = 3, /* rssi delta */ 390 WLC_ROAM_CACHE_UPDATE_MOTION_RSSI_DELTA = 4, /* motion rssi delta */ 391 WLC_ROAM_CACHE_UPDATE_CHANNEL_MISS = 5, /* channel missed */ 392 WLC_ROAM_CACHE_UPDATE_START_SPLIT_SCAN = 6, /* start split scan */ 393 WLC_ROAM_CACHE_UPDATE_START_FULL_SCAN = 7, /* start full scan */ 394 WLC_ROAM_CACHE_UPDATE_INIT_ASSOC = 8, /* init before assoc */ 395 WLC_ROAM_CACHE_UPDATE_FULL_SCAN_FAILED = 9, /* full scan failed */ 396 WLC_ROAM_CACHE_UPDATE_NO_AP_FOUND = 10, /* no ap found */ 397 WLC_ROAM_CACHE_UPDATE_MISSING_AP = 11, /* cached ap not found */ 398 WLC_ROAM_CACHE_UPDATE_START_PART_SCAN = 12, /* RCC */ 399 WLC_ROAM_CACHE_UPDATE_RCC_MODE = 13, /* RCC */ 400 WLC_ROAM_CACHE_UPDATE_RCC_CHANNELS = 14, /* RCC */ 401 WLC_ROAM_CACHE_UPDATE_START_LP_FULL_SCAN = 15 /* start low power full scan */ 402 } wlc_roam_cache_update_reason_t; 403 404 /* 405 * Please do not insert/delete events in the middle causing renumbering. 406 * It is a problem for host-device compatibility, especially with ROMmed chips. 407 */ 408 409 /* Translate between internal and exported status codes */ 410 /* Event status codes */ 411 #define WLC_E_STATUS_SUCCESS 0 /* operation was successful */ 412 #define WLC_E_STATUS_FAIL 1 /* operation failed */ 413 #define WLC_E_STATUS_TIMEOUT 2 /* operation timed out */ 414 #define WLC_E_STATUS_NO_NETWORKS 3 /* failed due to no matching network found */ 415 #define WLC_E_STATUS_ABORT 4 /* operation was aborted */ 416 #define WLC_E_STATUS_NO_ACK 5 /* protocol failure: packet not ack'd */ 417 #define WLC_E_STATUS_UNSOLICITED 6 /* AUTH or ASSOC packet was unsolicited */ 418 #define WLC_E_STATUS_ATTEMPT 7 /* attempt to assoc to an auto auth configuration */ 419 #define WLC_E_STATUS_PARTIAL 8 /* scan results are incomplete */ 420 #define WLC_E_STATUS_NEWSCAN 9 /* scan aborted by another scan */ 421 #define WLC_E_STATUS_NEWASSOC 10 /* scan aborted due to assoc in progress */ 422 #define WLC_E_STATUS_11HQUIET 11 /* 802.11h quiet period started */ 423 #define WLC_E_STATUS_SUPPRESS 12 /* user disabled scanning (WLC_SET_SCANSUPPRESS) */ 424 #define WLC_E_STATUS_NOCHANS 13 /* no allowable channels to scan */ 425 #ifdef BCMCCX 426 #define WLC_E_STATUS_CCXFASTRM 14 /* scan aborted due to CCX fast roam */ 427 #endif /* BCMCCX */ 428 #define WLC_E_STATUS_CS_ABORT 15 /* abort channel select */ 429 #define WLC_E_STATUS_ERROR 16 /* request failed due to error */ 430 #define WLC_E_STATUS_SLOTTED_PEER_ADD 17 /* Slotted scb for peer addition status */ 431 #define WLC_E_STATUS_SLOTTED_PEER_DEL 18 /* Slotted scb for peer deletion status */ 432 #define WLC_E_STATUS_RXBCN 19 /* Rx Beacon event for FAKEAP feature */ 433 #define WLC_E_STATUS_RXBCN_ABORT 20 /* Rx Beacon abort event for FAKEAP feature */ 434 #define WLC_E_STATUS_LOWPOWER_ON_LOWSPAN 21 /* LOWPOWER scan request during LOWSPAN */ 435 #define WLC_E_STATUS_INVALID 0xff /* Invalid status code to init variables. */ 436 437 /* 4-way handshake event type */ 438 #define WLC_E_PSK_AUTH_SUB_EAPOL_START 1 /* EAPOL start */ 439 #define WLC_E_PSK_AUTH_SUB_EAPOL_DONE 2 /* EAPOL end */ 440 /* GTK event type */ 441 #define WLC_E_PSK_AUTH_SUB_GTK_DONE 3 /* GTK end */ 442 443 /* 4-way handshake event status code */ 444 #define WLC_E_STATUS_PSK_AUTH_WPA_TIMOUT 1 /* operation timed out */ 445 #define WLC_E_STATUS_PSK_AUTH_MIC_WPA_ERR 2 /* MIC error */ 446 #define WLC_E_STATUS_PSK_AUTH_IE_MISMATCH_ERR 3 /* IE Missmatch error */ 447 #define WLC_E_STATUS_PSK_AUTH_REPLAY_COUNT_ERR 4 448 #define WLC_E_STATUS_PSK_AUTH_PEER_BLACKISTED 5 /* Blaclisted peer */ 449 #define WLC_E_STATUS_PSK_AUTH_GTK_REKEY_FAIL 6 /* GTK event status code */ 450 451 /* SDB transition status code */ 452 #define WLC_E_STATUS_SDB_START 1 453 #define WLC_E_STATUS_SDB_COMPLETE 2 454 /* Slice-swap status code */ 455 #define WLC_E_STATUS_SLICE_SWAP_START 3 456 #define WLC_E_STATUS_SLICE_SWAP_COMPLETE 4 457 458 /* SDB transition reason code */ 459 #define WLC_E_REASON_HOST_DIRECT 0 460 #define WLC_E_REASON_INFRA_ASSOC 1 461 #define WLC_E_REASON_INFRA_ROAM 2 462 #define WLC_E_REASON_INFRA_DISASSOC 3 463 #define WLC_E_REASON_NO_MODE_CHANGE_NEEDED 4 464 465 #ifdef WLAWDL 466 #define WLC_E_REASON_AWDL_ENABLE 5 467 #define WLC_E_REASON_AWDL_DISABLE 6 468 #endif /* WLAWDL */ 469 470 /* TX STAT ERROR REASON CODE */ 471 #define WLC_E_REASON_TXBACKOFF_NOT_DECREMENTED 0x1 472 473 /* WLC_E_SDB_TRANSITION event data */ 474 #define WL_MAX_BSSCFG 4 475 #define WL_EVENT_SDB_TRANSITION_VER 1 476 typedef struct wl_event_sdb_data { 477 uint8 wlunit; /* Core index */ 478 uint8 is_iftype; /* Interface Type(Station, SoftAP, P2P_GO, P2P_GC */ 479 uint16 chanspec; /* Interface Channel/Chanspec */ 480 char ssidbuf[(4 * 32) + 1]; /* SSID_FMT_BUF_LEN: ((4 * DOT11_MAX_SSID_LEN) + 1) */ 481 } wl_event_sdb_data_t; 482 483 typedef struct wl_event_sdb_trans { 484 uint8 version; /* Event Data Version */ 485 uint8 rsdb_mode; 486 uint8 enable_bsscfg; 487 uint8 reserved; 488 struct wl_event_sdb_data values[WL_MAX_BSSCFG]; 489 } wl_event_sdb_trans_t; 490 491 /* reason codes for WLC_E_GTK_KEYROT_NO_CHANSW event */ 492 #define WLC_E_GTKKEYROT_SCANDELAY 0 /* Delay scan while gtk in progress */ 493 494 #ifdef WLAWDL 495 #define WLC_E_GTKKEYROT_SKIPCHANSW_AWDL 1 /* Avoid chansw by awdl while gtk in progress */ 496 #endif /* WLAWDL */ 497 498 #define WLC_E_GTKKEYROT_SKIPCHANSW_P2P 2 /* Avoid chansw by p2p while gtk in progress */ 499 500 /* roam reason codes */ 501 #define WLC_E_REASON_INITIAL_ASSOC 0 /* initial assoc */ 502 #define WLC_E_REASON_LOW_RSSI 1 /* roamed due to low RSSI */ 503 #define WLC_E_REASON_DEAUTH 2 /* roamed due to DEAUTH indication */ 504 #define WLC_E_REASON_DISASSOC 3 /* roamed due to DISASSOC indication */ 505 #define WLC_E_REASON_BCNS_LOST 4 /* roamed due to lost beacons */ 506 507 /* Roam codes (5-7) used primarily by CCX */ 508 #define WLC_E_REASON_FAST_ROAM_FAILED 5 /* roamed due to fast roam failure */ 509 #define WLC_E_REASON_DIRECTED_ROAM 6 /* roamed due to request by AP */ 510 #define WLC_E_REASON_TSPEC_REJECTED 7 /* roamed due to TSPEC rejection */ 511 #define WLC_E_REASON_BETTER_AP 8 /* roamed due to finding better AP */ 512 #define WLC_E_REASON_MINTXRATE 9 /* roamed because at mintxrate for too long */ 513 #define WLC_E_REASON_TXFAIL 10 /* We can hear AP, but AP can't hear us */ 514 #define WLC_E_REASON_BSSTRANS_REQ 11 /* roamed due to BSS Transition request by AP */ 515 #define WLC_E_REASON_LOW_RSSI_CU 12 /* roamed due to low RSSI and Channel Usage */ 516 #define WLC_E_REASON_RADAR_DETECTED 13 /* roamed due to radar detection by STA */ 517 #define WLC_E_REASON_CSA 14 /* roamed due to CSA from AP */ 518 #define WLC_E_REASON_ESTM_LOW 15 /* roamed due to ESTM low tput */ 519 #define WLC_E_REASON_SILENT_ROAM 16 /* roamed due to Silent roam */ 520 #define WLC_E_REASON_INACTIVITY 17 /* full roam scan due to inactivity */ 521 #define WLC_E_REASON_ROAM_SCAN_TIMEOUT 18 /* roam scan timer timeout */ 522 #define WLC_E_REASON_REASSOC 19 /* roamed due to reassoc iovar */ 523 #define WLC_E_REASON_LAST 20 /* NOTE: increment this as you add reasons above */ 524 525 /* prune reason codes */ 526 #define WLC_E_PRUNE_ENCR_MISMATCH 1 /* encryption mismatch */ 527 #define WLC_E_PRUNE_BCAST_BSSID 2 /* AP uses a broadcast BSSID */ 528 #define WLC_E_PRUNE_MAC_DENY 3 /* STA's MAC addr is in AP's MAC deny list */ 529 #define WLC_E_PRUNE_MAC_NA 4 /* STA's MAC addr is not in AP's MAC allow list */ 530 #define WLC_E_PRUNE_REG_PASSV 5 /* AP not allowed due to regulatory restriction */ 531 #define WLC_E_PRUNE_SPCT_MGMT 6 /* AP does not support STA locale spectrum mgmt */ 532 #define WLC_E_PRUNE_RADAR 7 /* AP is on a radar channel of STA locale */ 533 #define WLC_E_RSN_MISMATCH 8 /* STA does not support AP's RSN */ 534 #define WLC_E_PRUNE_NO_COMMON_RATES 9 /* No rates in common with AP */ 535 #define WLC_E_PRUNE_BASIC_RATES 10 /* STA does not support all basic rates of BSS */ 536 #ifdef BCMCCX 537 #define WLC_E_PRUNE_CCXFAST_PREVAP 11 /* CCX FAST ROAM: prune previous AP */ 538 #endif /* def BCMCCX */ 539 #define WLC_E_PRUNE_CIPHER_NA 12 /* BSS's cipher not supported */ 540 #define WLC_E_PRUNE_KNOWN_STA 13 /* AP is already known to us as a STA */ 541 #ifdef BCMCCX 542 #define WLC_E_PRUNE_CCXFAST_DROAM 14 /* CCX FAST ROAM: prune unqualified AP */ 543 #endif /* def BCMCCX */ 544 #define WLC_E_PRUNE_WDS_PEER 15 /* AP is already known to us as a WDS peer */ 545 #define WLC_E_PRUNE_QBSS_LOAD 16 /* QBSS LOAD - AAC is too low */ 546 #define WLC_E_PRUNE_HOME_AP 17 /* prune home AP */ 547 #ifdef BCMCCX 548 #define WLC_E_PRUNE_AP_BLOCKED 18 /* prune blocked AP */ 549 #define WLC_E_PRUNE_NO_DIAG_SUPPORT 19 /* prune due to diagnostic mode not supported */ 550 #endif /* BCMCCX */ 551 #define WLC_E_PRUNE_AUTH_RESP_MAC 20 /* suppress auth resp by MAC filter */ 552 #define WLC_E_PRUNE_ASSOC_RETRY_DELAY 21 /* MBO assoc retry delay */ 553 #define WLC_E_PRUNE_RSSI_ASSOC_REJ 22 /* OCE RSSI-based assoc rejection */ 554 #define WLC_E_PRUNE_MAC_AVOID 23 /* AP's MAC addr is in STA's MAC avoid list */ 555 #define WLC_E_PRUNE_TRANSITION_DISABLE 24 /* AP's Transition Disable Policy */ 556 557 /* WPA failure reason codes carried in the WLC_E_PSK_SUP event */ 558 #define WLC_E_SUP_OTHER 0 /* Other reason */ 559 #define WLC_E_SUP_DECRYPT_KEY_DATA 1 /* Decryption of key data failed */ 560 #define WLC_E_SUP_BAD_UCAST_WEP128 2 /* Illegal use of ucast WEP128 */ 561 #define WLC_E_SUP_BAD_UCAST_WEP40 3 /* Illegal use of ucast WEP40 */ 562 #define WLC_E_SUP_UNSUP_KEY_LEN 4 /* Unsupported key length */ 563 #define WLC_E_SUP_PW_KEY_CIPHER 5 /* Unicast cipher mismatch in pairwise key */ 564 #define WLC_E_SUP_MSG3_TOO_MANY_IE 6 /* WPA IE contains > 1 RSN IE in key msg 3 */ 565 #define WLC_E_SUP_MSG3_IE_MISMATCH 7 /* WPA IE mismatch in key message 3 */ 566 #define WLC_E_SUP_NO_INSTALL_FLAG 8 /* INSTALL flag unset in 4-way msg */ 567 #define WLC_E_SUP_MSG3_NO_GTK 9 /* encapsulated GTK missing from msg 3 */ 568 #define WLC_E_SUP_GRP_KEY_CIPHER 10 /* Multicast cipher mismatch in group key */ 569 #define WLC_E_SUP_GRP_MSG1_NO_GTK 11 /* encapsulated GTK missing from group msg 1 */ 570 #define WLC_E_SUP_GTK_DECRYPT_FAIL 12 /* GTK decrypt failure */ 571 #define WLC_E_SUP_SEND_FAIL 13 /* message send failure */ 572 #define WLC_E_SUP_DEAUTH 14 /* received FC_DEAUTH */ 573 #define WLC_E_SUP_WPA_PSK_TMO 15 /* WPA PSK 4-way handshake timeout */ 574 #define WLC_E_SUP_WPA_PSK_M1_TMO 16 /* WPA PSK 4-way handshake M1 timeout */ 575 #define WLC_E_SUP_WPA_PSK_M3_TMO 17 /* WPA PSK 4-way handshake M3 timeout */ 576 #define WLC_E_SUP_GTK_UPDATE_FAIL 18 /* GTK update failure */ 577 #define WLC_E_SUP_TK_UPDATE_FAIL 19 /* TK update failure */ 578 #define WLC_E_SUP_KEY_INSTALL_FAIL 20 /* Buffered key install failure */ 579 #define WLC_E_SUP_PTK_UPDATE 21 /* PTK update */ 580 #define WLC_E_SUP_MSG1_PMKID_MISMATCH 22 /* MSG1 PMKID not matched to PMKSA cache list */ 581 582 /* event msg for WLC_E_SUP_PTK_UPDATE */ 583 typedef struct wlc_sup_ptk_update { 584 uint16 version; /* 0x0001 */ 585 uint16 length; /* length of data that follows */ 586 uint32 tsf_low; /* tsf at which ptk updated by internal supplicant */ 587 uint32 tsf_high; 588 uint8 key_id; /* always 0 for PTK update */ 589 uint8 tid; /* tid for the PN below - PTK refresh is per key */ 590 uint16 pn_low; 591 uint32 pn_high; /* local highest PN of any tid of the key when M4 was sent */ 592 } wlc_sup_ptk_update_t; 593 594 /* sub event of WLC_E_WSEC */ 595 typedef enum { 596 WLC_WSEC_EVENT_PTK_PN_SYNC_ERROR = 0x01 597 } wl_wsec_event_type_t; 598 599 /* sub event msg - WLC_WSEC_EVENT_PTK_PN_SYNC_ERROR */ 600 struct wlc_wsec_ptk_pn_sync_error_v1 { 601 uint32 tsf_low; /* tsf at which PN sync error happened */ 602 uint32 tsf_high; 603 uint8 key_id; /* always 0 for PTK update */ 604 uint8 tid; /* tid for the PN below - PTK refresh is per key */ 605 uint16 PAD1; 606 uint16 rx_seqn; /* d11 seq number */ 607 uint16 pn_low; 608 uint32 pn_high; /* local PN window start for the tid */ 609 uint16 key_idx; /* key idx in the keymgmt */ 610 uint16 rx_pn_low; 611 uint32 rx_pn_high; /* Rx PN window start for the tid */ 612 uint32 span_time; /* time elapsed since replay */ 613 uint32 span_pkts; /* pkt count since replay */ 614 }; 615 616 typedef struct wlc_wsec_ptk_pn_sync_error_v1 wlc_wsec_ptk_pn_sync_error_t; 617 618 /* WLC_E_WSEC event msg */ 619 typedef struct wlc_wsec_event { 620 uint16 version; /* 0x0001 */ 621 uint16 length; /* length of data that follows */ 622 uint16 type; /* wsec_event_type_t */ 623 uint16 PAD1; 624 union { 625 wlc_wsec_ptk_pn_sync_error_t pn_sync_err; 626 } data; 627 } wlc_wsec_event_t; 628 629 /* Ucode reason codes carried in the WLC_E_MACDBG event */ 630 #define WLC_E_MACDBG_LIST_PSM 0 /* Dump list update for PSM registers */ 631 #define WLC_E_MACDBG_LIST_PSMX 1 /* Dump list update for PSMx registers */ 632 #define WLC_E_MACDBG_REGALL 2 /* Dump all registers */ 633 634 /* Event data for events that include frames received over the air */ 635 /* WLC_E_PROBRESP_MSG 636 * WLC_E_P2P_PROBREQ_MSG 637 * WLC_E_ACTION_FRAME_RX 638 */ 639 640 #ifdef WLAWDL 641 #define WLC_E_AWDL_SCAN_START 1 /* Scan start indication to host */ 642 #define WLC_E_AWDL_SCAN_DONE 0 /* Scan Done indication to host */ 643 #endif /* WLAWDL */ 644 645 #define MAX_PHY_CORE_NUM 4u 646 647 #define BCM_RX_FRAME_DATA_VERSION_2 2u 648 649 typedef BWL_PRE_PACKED_STRUCT struct wl_event_rx_frame_data_v2 { 650 uint16 version; 651 uint16 len; 652 uint16 channel; /* Matches chanspec_t format from bcmwifi_channels.h */ 653 uint16 pad; 654 int32 rssi; 655 uint32 mactime; 656 uint32 rate; 657 int8 per_core_rssi[MAX_PHY_CORE_NUM]; 658 } BWL_POST_PACKED_STRUCT wl_event_rx_frame_data_v2_t; 659 660 typedef BWL_PRE_PACKED_STRUCT struct wl_event_rx_frame_data_v1 { 661 uint16 version; 662 uint16 channel; /* Matches chanspec_t format from bcmwifi_channels.h */ 663 int32 rssi; 664 uint32 mactime; 665 uint32 rate; 666 } BWL_POST_PACKED_STRUCT wl_event_rx_frame_data_v1_t; 667 668 #define BCM_RX_FRAME_DATA_VERSION_1 1u 669 670 #ifndef WL_EVENT_RX_FRAME_DATA_ALIAS 671 #define BCM_RX_FRAME_DATA_VERSION BCM_RX_FRAME_DATA_VERSION_1 672 typedef wl_event_rx_frame_data_v1_t wl_event_rx_frame_data_t; 673 #endif 674 675 /* WLC_E_IF event data */ 676 typedef struct wl_event_data_if { 677 uint8 ifidx; /* RTE virtual device index (for dongle) */ 678 uint8 opcode; /* see I/F opcode */ 679 uint8 reserved; /* bit mask (WLC_E_IF_FLAGS_XXX ) */ 680 uint8 bssidx; /* bsscfg index */ 681 uint8 role; /* see I/F role */ 682 } wl_event_data_if_t; 683 684 /* WLC_E_NATOE event data */ 685 typedef struct wl_event_data_natoe { 686 uint32 natoe_active; 687 uint32 sta_ip; 688 uint16 start_port; 689 uint16 end_port; 690 } wl_event_data_natoe_t; 691 692 /* opcode in WLC_E_IF event */ 693 #define WLC_E_IF_ADD 1 /* bsscfg add */ 694 #define WLC_E_IF_DEL 2 /* bsscfg delete */ 695 #define WLC_E_IF_CHANGE 3 /* bsscfg role change */ 696 697 /* I/F role code in WLC_E_IF event */ 698 #define WLC_E_IF_ROLE_STA 0 /* Infra STA */ 699 #define WLC_E_IF_ROLE_AP 1 /* Access Point */ 700 #define WLC_E_IF_ROLE_WDS 2 /* WDS link */ 701 #define WLC_E_IF_ROLE_P2P_GO 3 /* P2P Group Owner */ 702 #define WLC_E_IF_ROLE_P2P_CLIENT 4 /* P2P Client */ 703 704 #ifdef WLAWDL 705 #define WLC_E_IF_ROLE_AWDL 7 /* AWDL */ 706 #endif /* WLAWDL */ 707 708 #define WLC_E_IF_ROLE_IBSS 8 /* IBSS */ 709 #define WLC_E_IF_ROLE_NAN 9 /* NAN */ 710 711 #define WLC_E_IF_ROLE_MESH 10u /* identifies the role as MESH */ 712 713 /* WLC_E_RSSI event data */ 714 typedef struct wl_event_data_rssi { 715 int32 rssi; 716 int32 snr; 717 int32 noise; 718 } wl_event_data_rssi_t; 719 720 #define WL_EVENT_WA_LQM_VER 0 /* initial version */ 721 722 #define WL_EVENT_WA_LQM_BASIC 0 /* event sub-types */ 723 typedef struct { /* payload of subevent in xtlv */ 724 int32 rssi; 725 int32 snr; 726 uint32 tx_rate; 727 uint32 rx_rate; 728 } wl_event_wa_lqm_basic_t; 729 730 typedef struct wl_event_wa_lqm { 731 uint16 ver; /* version */ 732 uint16 len; /* total length structure */ 733 uint8 subevent[]; /* sub-event data in bcm_xtlv_t format */ 734 } wl_event_wa_lqm_t; 735 736 /* WLC_E_IF flag */ 737 #define WLC_E_IF_FLAGS_BSSCFG_NOIF 0x1 /* no host I/F creation needed */ 738 739 /* Reason codes for LINK */ 740 /* Reason codes for LINK */ 741 #define WLC_E_LINK_BCN_LOSS 1 /* Link down because of beacon loss */ 742 #define WLC_E_LINK_DISASSOC 2 /* Link down because of disassoc */ 743 #define WLC_E_LINK_ASSOC_REC 3 /* Link down because assoc recreate failed */ 744 #define WLC_E_LINK_BSSCFG_DIS 4 /* Link down due to bsscfg down */ 745 #define WLC_E_LINK_ASSOC_FAIL 5 /* Link down due to assoc to new AP during roam */ 746 #define WLC_E_LINK_REASSOC_ROAM_FAIL 6 /* Link down due to reassoc roaming failed */ 747 #define WLC_E_LINK_LOWRSSI_ROAM_FAIL 7 /* Link down due to Low rssi roaming failed */ 748 #define WLC_E_LINK_NO_FIRST_BCN_RX 8 /* Link down due to 1st beacon rx failure */ 749 750 /* WLC_E_NDIS_LINK event data */ 751 typedef BWL_PRE_PACKED_STRUCT struct ndis_link_parms { 752 struct ether_addr peer_mac; /* 6 bytes */ 753 uint16 chanspec; /* 2 bytes */ 754 uint32 link_speed; /* current datarate in units of 500 Kbit/s */ 755 uint32 max_link_speed; /* max possible datarate for link in units of 500 Kbit/s */ 756 int32 rssi; /* average rssi */ 757 } BWL_POST_PACKED_STRUCT ndis_link_parms_t; 758 759 /* reason codes for WLC_E_OVERLAY_REQ event */ 760 #define WLC_E_OVL_DOWNLOAD 0 /* overlay download request */ 761 #define WLC_E_OVL_UPDATE_IND 1 /* device indication of host overlay update */ 762 763 /* reason codes for WLC_E_TDLS_PEER_EVENT event */ 764 #define WLC_E_TDLS_PEER_DISCOVERED 0 /* peer is ready to establish TDLS */ 765 #define WLC_E_TDLS_PEER_CONNECTED 1 766 #define WLC_E_TDLS_PEER_DISCONNECTED 2 767 768 /* reason codes for WLC_E_RMC_EVENT event */ 769 #define WLC_E_REASON_RMC_NONE 0 770 #define WLC_E_REASON_RMC_AR_LOST 1 771 #define WLC_E_REASON_RMC_AR_NO_ACK 2 772 773 #ifdef WLTDLS 774 /* TDLS Action Category code */ 775 #define TDLS_AF_CATEGORY 12 776 /* Wi-Fi Display (WFD) Vendor Specific Category */ 777 /* used for WFD Tunneled Probe Request and Response */ 778 #define TDLS_VENDOR_SPECIFIC 127 779 /* TDLS Action Field Values */ 780 #define TDLS_ACTION_SETUP_REQ 0 781 #define TDLS_ACTION_SETUP_RESP 1 782 #define TDLS_ACTION_SETUP_CONFIRM 2 783 #define TDLS_ACTION_TEARDOWN 3 784 #define WLAN_TDLS_SET_PROBE_WFD_IE 11 785 #define WLAN_TDLS_SET_SETUP_WFD_IE 12 786 #define WLAN_TDLS_SET_WFD_ENABLED 13 787 #define WLAN_TDLS_SET_WFD_DISABLED 14 788 #endif 789 790 /* WLC_E_RANGING_EVENT subtypes */ 791 #define WLC_E_RANGING_RESULTS 0 792 793 #define PHY_CAL_EVT_VERSION 1 794 typedef struct wlc_phy_cal_info { 795 uint16 version; /* structure version */ 796 uint16 length; /* length of the rest of the structure */ 797 uint16 chanspec; 798 uint8 start; 799 uint8 phase; 800 int16 temp; 801 uint8 reason; 802 uint8 slice; 803 } wlc_phy_cal_info_t; 804 805 #ifdef WLAWDL 806 /* WLC_E_AWDL_EVENT subtypes */ 807 #define WLC_E_AWDL_SCAN_STATUS 0 808 #define WLC_E_AWDL_RX_ACT_FRAME 1 809 #define WLC_E_AWDL_RX_PRB_RESP 2 810 #define WLC_E_AWDL_PHYCAL_STATUS 3 811 #define WLC_E_AWDL_WOWL_NULLPKT 4 812 #define WLC_E_AWDL_OOB_AF_STATUS 5 813 /* WLC_E_AWDL_RANGING_RESULTS will be removed and only WLC_E_AWDL_UNUSED will be here 814 * Keeping both of them to avoid compilation errot on trunk 815 * It will be removed after wlc_ranging merge from IGUANA 816 */ 817 #define WLC_E_AWDL_RANGING_RESULTS 6 818 #define WLC_E_AWDL_UNUSED 6 819 #define WLC_E_AWDL_SUB_PEER_STATE 7 820 #define WLC_E_AWDL_SUB_INTERFACE_STATE 8 821 #define WLC_E_AWDL_UCAST_AF_TXSTATUS 9 822 #define WLC_E_AWDL_NAN_CLUSTER_MERGE 10 823 #define WLC_E_AWDL_NAN_RX_BEACON 11 824 #define WLC_E_AWDL_SD_DISCOVERY_RESULT 12 825 #define WLC_E_AWDL_SD_REPLIED 13 826 #define WLC_E_AWDL_SD_TERMINATED 14 827 #define WLC_E_AWDL_SD_RECEIVE 15 828 #define WLC_E_AWDL_SD_VNDR_IE 16 829 #define WLC_E_AWDL_SD_DEVICE_STATE_IE 17 830 #define WLC_E_AWDL_DFSP_NOTIF 18 831 #define WLC_E_AWDL_DFSP_SUSPECT 19 832 #define WLC_E_AWDL_DFSP_RESUME 20 833 834 /* WLC_E_AWDL_SCAN_STATUS status values */ 835 #define WLC_E_AWDL_SCAN_START 1 /* Scan start indication to host */ 836 #define WLC_E_AWDL_SCAN_DONE 0 /* Scan Done indication to host */ 837 #define WLC_E_AWDL_PHYCAL_START 1 /* Phy calibration start indication to host */ 838 #define WLC_E_AWDL_PHYCAL_DONE 0 /* Phy calibration done indication to host */ 839 840 typedef BWL_PRE_PACKED_STRUCT struct { 841 uint8 subscribe_id; /* local subscribe instance id */ 842 uint8 publish_id; /* publiser's insance id */ 843 struct ether_addr addr; /* publsher's address */ 844 uint8 service_info_len; /* length of the service specific information in data[] */ 845 uint8 data[1]; /* service specific info */ 846 } BWL_PRE_PACKED_STRUCT awdl_sd_discovery_result_t; 847 848 typedef BWL_PRE_PACKED_STRUCT struct { 849 uint8 instance_id; 850 struct ether_addr addr; /* publsher's address */ 851 } BWL_PRE_PACKED_STRUCT awdl_sd_replied_event_t; 852 853 #define AWDL_SD_TERM_REASON_TIMEOUT 1 854 #define AWDL_SD_TERM_REASON_USERREQ 2 855 #define AWDL_SD_TERM_REASON_FAIL 3 856 typedef BWL_PRE_PACKED_STRUCT struct { 857 uint8 instance_id; /* publish instance id */ 858 uint8 reason; /* 1=timeout, 2=user request, 3=failure */ 859 } BWL_PRE_PACKED_STRUCT awdl_sd_term_event_t; 860 861 typedef BWL_PRE_PACKED_STRUCT struct { 862 uint8 instance_id; /* local publish/subscribe instance id */ 863 uint8 sender_instance_id; 864 struct ether_addr addr; /* sender's address */ 865 uint8 service_info_len; /* length of the service specific information in data[] */ 866 uint8 data[1]; /* service specific info */ 867 } BWL_PRE_PACKED_STRUCT awdl_sd_receive_t; 868 869 typedef BWL_PRE_PACKED_STRUCT struct { 870 struct ether_addr addr; /* sender's address */ 871 uint16 len; /* length of data[] */ 872 uint8 data[1]; /* vndr specific info */ 873 } BWL_PRE_PACKED_STRUCT awdl_sd_vndr_ie_event_t; 874 875 #endif /* WLAWDL */ 876 877 /* GAS event data */ 878 typedef BWL_PRE_PACKED_STRUCT struct wl_event_gas { 879 uint16 channel; /* channel of GAS protocol */ 880 uint8 dialog_token; /* GAS dialog token */ 881 uint8 fragment_id; /* fragment id */ 882 uint16 status_code; /* status code on GAS completion */ 883 uint16 data_len; /* length of data to follow */ 884 uint8 data[1]; /* variable length specified by data_len */ 885 } BWL_POST_PACKED_STRUCT wl_event_gas_t; 886 887 /* service discovery TLV */ 888 typedef BWL_PRE_PACKED_STRUCT struct wl_sd_tlv { 889 uint16 length; /* length of response_data */ 890 uint8 protocol; /* service protocol type */ 891 uint8 transaction_id; /* service transaction id */ 892 uint8 status_code; /* status code */ 893 uint8 data[1]; /* response data */ 894 } BWL_POST_PACKED_STRUCT wl_sd_tlv_t; 895 896 /* service discovery event data */ 897 typedef BWL_PRE_PACKED_STRUCT struct wl_event_sd { 898 uint16 channel; /* channel */ 899 uint8 count; /* number of tlvs */ 900 wl_sd_tlv_t tlv[1]; /* service discovery TLV */ 901 } BWL_POST_PACKED_STRUCT wl_event_sd_t; 902 903 /* WLC_E_PKT_FILTER event sub-classification codes */ 904 #define WLC_E_PKT_FILTER_TIMEOUT 1 /* Matching packet not received in last timeout seconds */ 905 906 /* Note: proxd has a new API (ver 3.0) deprecates the following */ 907 908 /* Reason codes for WLC_E_PROXD */ 909 #define WLC_E_PROXD_FOUND 1 /* Found a proximity device */ 910 #define WLC_E_PROXD_GONE 2 /* Lost a proximity device */ 911 #define WLC_E_PROXD_START 3 /* used by: target */ 912 #define WLC_E_PROXD_STOP 4 /* used by: target */ 913 #define WLC_E_PROXD_COMPLETED 5 /* used by: initiator completed */ 914 #define WLC_E_PROXD_ERROR 6 /* used by both initiator and target */ 915 #define WLC_E_PROXD_COLLECT_START 7 /* used by: target & initiator */ 916 #define WLC_E_PROXD_COLLECT_STOP 8 /* used by: target */ 917 #define WLC_E_PROXD_COLLECT_COMPLETED 9 /* used by: initiator completed */ 918 #define WLC_E_PROXD_COLLECT_ERROR 10 /* used by both initiator and target */ 919 #define WLC_E_PROXD_NAN_EVENT 11 /* used by both initiator and target */ 920 #define WLC_E_PROXD_TS_RESULTS 12 /* used by: initiator completed */ 921 922 /* proxd_event data */ 923 typedef struct ftm_sample { 924 uint32 value; /* RTT in ns */ 925 int8 rssi; /* RSSI */ 926 } ftm_sample_t; 927 928 typedef struct ts_sample { 929 uint32 t1; 930 uint32 t2; 931 uint32 t3; 932 uint32 t4; 933 } ts_sample_t; 934 935 typedef BWL_PRE_PACKED_STRUCT struct proxd_event_data { 936 uint16 ver; /* version */ 937 uint16 mode; /* mode: target/initiator */ 938 uint16 method; /* method: rssi/TOF/AOA */ 939 uint8 err_code; /* error classification */ 940 uint8 TOF_type; /* one way or two way TOF */ 941 uint8 OFDM_frame_type; /* legacy or VHT */ 942 uint8 bandwidth; /* Bandwidth is 20, 40,80, MHZ */ 943 struct ether_addr peer_mac; /* (e.g for tgt:initiator's */ 944 uint32 distance; /* dst to tgt, units meter */ 945 uint32 meanrtt; /* mean delta */ 946 uint32 modertt; /* Mode delta */ 947 uint32 medianrtt; /* median RTT */ 948 uint32 sdrtt; /* Standard deviation of RTT */ 949 int32 gdcalcresult; /* Software or Hardware Kind of redundant, but if */ 950 /* frame type is VHT, then we should do it by hardware */ 951 int16 avg_rssi; /* avg rssi accroos the ftm frames */ 952 int16 validfrmcnt; /* Firmware's valid frame counts */ 953 int32 peer_router_info; /* Peer router information if available in TLV, */ 954 /* We will add this field later */ 955 int32 var1; /* average of group delay */ 956 int32 var2; /* average of threshold crossing */ 957 int32 var3; /* difference between group delay and threshold crossing */ 958 /* raw Fine Time Measurements (ftm) data */ 959 uint16 ftm_unit; /* ftm cnt resolution in picoseconds , 6250ps - default */ 960 uint16 ftm_cnt; /* num of rtd measurments/length in the ftm buffer */ 961 ftm_sample_t ftm_buff[1]; /* 1 ... ftm_cnt */ 962 } BWL_POST_PACKED_STRUCT wl_proxd_event_data_t; 963 964 typedef BWL_PRE_PACKED_STRUCT struct proxd_event_ts_results { 965 uint16 ver; /* version */ 966 uint16 mode; /* mode: target/initiator */ 967 uint16 method; /* method: rssi/TOF/AOA */ 968 uint8 err_code; /* error classification */ 969 uint8 TOF_type; /* one way or two way TOF */ 970 uint16 ts_cnt; /* number of timestamp measurements */ 971 ts_sample_t ts_buff[1]; /* Timestamps */ 972 } BWL_POST_PACKED_STRUCT wl_proxd_event_ts_results_t; 973 974 #ifdef WLAWDL 975 /* WLC_E_AWDL_AW event data */ 976 typedef BWL_PRE_PACKED_STRUCT struct awdl_aws_event_data { 977 uint32 fw_time; /* firmware PMU time */ 978 struct ether_addr current_master; /* Current master Mac addr */ 979 uint16 aw_counter; /* AW seq# */ 980 uint8 aw_ext_count; /* AW extension count */ 981 uint8 aw_role; /* AW role */ 982 uint8 flags; /* AW event flag */ 983 uint16 aw_chan; 984 uint8 infra_rssi; /* rssi on the infra channel */ 985 uint32 infra_rxbcn_count; /* number of beacons received */ 986 struct ether_addr top_master; /* Top master */ 987 } BWL_POST_PACKED_STRUCT awdl_aws_event_data_t; 988 989 /* For awdl_aws_event_data_t.flags */ 990 #define AWDL_AW_LAST_EXT 0x01 991 992 /* WLC_E_AWDL_OOB_AF_STATUS event data */ 993 typedef BWL_PRE_PACKED_STRUCT struct awdl_oob_af_status_data { 994 uint32 tx_time_diff; 995 uint16 pkt_tag; 996 uint8 tx_chan; 997 } BWL_POST_PACKED_STRUCT awdl_oob_af_status_data_t; 998 #endif /* WLAWDL */ 999 1000 /* Video Traffic Interference Monitor Event */ 1001 #define INTFER_EVENT_VERSION 1 1002 #define INTFER_STREAM_TYPE_NONTCP 1 1003 #define INTFER_STREAM_TYPE_TCP 2 1004 #define WLINTFER_STATS_NSMPLS 4 1005 typedef struct wl_intfer_event { 1006 uint16 version; /* version */ 1007 uint16 status; /* status */ 1008 uint8 txfail_histo[WLINTFER_STATS_NSMPLS]; /* txfail histo */ 1009 } wl_intfer_event_t; 1010 1011 #define RRM_EVENT_VERSION 0 1012 typedef struct wl_rrm_event { 1013 int16 version; 1014 int16 len; 1015 int16 cat; /* Category */ 1016 int16 subevent; 1017 char payload[1]; /* Measurement payload */ 1018 } wl_rrm_event_t; 1019 1020 /* WLC_E_PSTA_PRIMARY_INTF_IND event data */ 1021 typedef struct wl_psta_primary_intf_event { 1022 struct ether_addr prim_ea; /* primary intf ether addr */ 1023 } wl_psta_primary_intf_event_t; 1024 1025 /* WLC_E_DPSTA_INTF_IND event data */ 1026 typedef enum { 1027 WL_INTF_PSTA = 1, 1028 WL_INTF_DWDS = 2 1029 } wl_dpsta_intf_type; 1030 1031 typedef struct wl_dpsta_intf_event { 1032 wl_dpsta_intf_type intf_type; /* dwds/psta intf register */ 1033 } wl_dpsta_intf_event_t; 1034 1035 /* ********** NAN protocol events/subevents ********** */ 1036 #ifndef NAN_EVENT_BUFFER_SIZE 1037 #define NAN_EVENT_BUFFER_SIZE 512 /* max size */ 1038 #endif /* NAN_EVENT_BUFFER_SIZE */ 1039 /* NAN Events sent by firmware */ 1040 1041 /* 1042 * If you make changes to this enum, dont forget to update the mask (if need be). 1043 */ 1044 typedef enum wl_nan_events { 1045 WL_NAN_EVENT_START = 1, /* NAN cluster started */ 1046 WL_NAN_EVENT_JOIN = 2, /* To be deprecated */ 1047 WL_NAN_EVENT_ROLE = 3, /* Role changed */ 1048 WL_NAN_EVENT_SCAN_COMPLETE = 4, /* To be deprecated */ 1049 WL_NAN_EVENT_DISCOVERY_RESULT = 5, /* Subscribe Received */ 1050 WL_NAN_EVENT_REPLIED = 6, /* Publish Sent */ 1051 WL_NAN_EVENT_TERMINATED = 7, /* sub / pub is terminated */ 1052 WL_NAN_EVENT_RECEIVE = 8, /* Follow up Received */ 1053 WL_NAN_EVENT_STATUS_CHG = 9, /* change in nan_mac status */ 1054 WL_NAN_EVENT_MERGE = 10, /* Merged to a NAN cluster */ 1055 WL_NAN_EVENT_STOP = 11, /* To be deprecated */ 1056 WL_NAN_EVENT_P2P = 12, /* Unused */ 1057 WL_NAN_EVENT_WINDOW_BEGIN_P2P = 13, /* Unused */ 1058 WL_NAN_EVENT_WINDOW_BEGIN_MESH = 14, /* Unused */ 1059 WL_NAN_EVENT_WINDOW_BEGIN_IBSS = 15, /* Unused */ 1060 WL_NAN_EVENT_WINDOW_BEGIN_RANGING = 16, /* Unused */ 1061 WL_NAN_EVENT_POST_DISC = 17, /* Event for post discovery data */ 1062 WL_NAN_EVENT_DATA_IF_ADD = 18, /* Unused */ 1063 WL_NAN_EVENT_DATA_PEER_ADD = 19, /* Event for peer add */ 1064 /* nan 2.0 */ 1065 WL_NAN_EVENT_PEER_DATAPATH_IND = 20, /* Incoming DP req */ 1066 WL_NAN_EVENT_DATAPATH_ESTB = 21, /* DP Established */ 1067 WL_NAN_EVENT_SDF_RX = 22, /* SDF payload */ 1068 WL_NAN_EVENT_DATAPATH_END = 23, /* DP Terminate recvd */ 1069 WL_NAN_EVENT_BCN_RX = 24, /* received beacon payload */ 1070 WL_NAN_EVENT_PEER_DATAPATH_RESP = 25, /* Peer's DP response */ 1071 WL_NAN_EVENT_PEER_DATAPATH_CONF = 26, /* Peer's DP confirm */ 1072 WL_NAN_EVENT_RNG_REQ_IND = 27, /* Range Request */ 1073 WL_NAN_EVENT_RNG_RPT_IND = 28, /* Range Report */ 1074 WL_NAN_EVENT_RNG_TERM_IND = 29, /* Range Termination */ 1075 WL_NAN_EVENT_PEER_DATAPATH_SEC_INST = 30, /* Peer's DP sec install */ 1076 WL_NAN_EVENT_TXS = 31, /* for tx status of follow-up and SDFs */ 1077 WL_NAN_EVENT_DW_START = 32, /* dw start */ 1078 WL_NAN_EVENT_DW_END = 33, /* dw end */ 1079 WL_NAN_EVENT_CHAN_BOUNDARY = 34, /* channel switch event */ 1080 WL_NAN_EVENT_MR_CHANGED = 35, /* AMR or IMR changed event during DW */ 1081 WL_NAN_EVENT_RNG_RESP_IND = 36, /* Range Response Rx */ 1082 WL_NAN_EVENT_PEER_SCHED_UPD_NOTIF = 37, /* Peer's schedule update notification */ 1083 WL_NAN_EVENT_PEER_SCHED_REQ = 38, /* Peer's schedule request */ 1084 WL_NAN_EVENT_PEER_SCHED_RESP = 39, /* Peer's schedule response */ 1085 WL_NAN_EVENT_PEER_SCHED_CONF = 40, /* Peer's schedule confirm */ 1086 WL_NAN_EVENT_SENT_DATAPATH_END = 41, /* Sent DP terminate frame */ 1087 WL_NAN_EVENT_SLOT_START = 42, /* SLOT_START event */ 1088 WL_NAN_EVENT_SLOT_END = 43, /* SLOT_END event */ 1089 WL_NAN_EVENT_HOST_ASSIST_REQ = 44, /* Requesting host assist */ 1090 WL_NAN_EVENT_RX_MGMT_FRM = 45, /* NAN management frame received */ 1091 WL_NAN_EVENT_DISC_CACHE_TIMEOUT = 46, /* Disc cache timeout */ 1092 WL_NAN_EVENT_OOB_AF_TXS = 47, /* OOB AF transmit status */ 1093 WL_NAN_EVENT_OOB_AF_RX = 48, /* OOB AF receive event */ 1094 1095 /* keep WL_NAN_EVENT_INVALID as the last element */ 1096 WL_NAN_EVENT_INVALID /* delimiter for max value */ 1097 } nan_app_events_e; 1098 1099 /* remove after precommit */ 1100 #define NAN_EV_MASK(ev) (1 << (ev - 1)) 1101 #define IS_NAN_EVT_ON(var, evt) ((var & (1 << (evt-1))) != 0) 1102 1103 #define NAN_EV_MASK_SET(var, evt) \ 1104 (((uint32)evt < WL_NAN_EVMASK_EXTN_LEN * 8) ? \ 1105 ((*((uint8 *)var + ((evt - 1)/8))) |= (1 << ((evt - 1) %8))) : 0) 1106 #define IS_NAN_EVENT_ON(var, evt) \ 1107 (((uint32)evt < WL_NAN_EVMASK_EXTN_LEN * 8) && \ 1108 (((*((uint8 *)var + ((evt - 1)/8))) & (1 << ((evt - 1) %8))) != 0)) 1109 1110 /* ******************* end of NAN section *************** */ 1111 1112 typedef enum wl_scan_events { 1113 WL_SCAN_START = 1, 1114 WL_SCAN_END = 2 1115 } wl_scan_events; 1116 1117 /* WLC_E_ULP event data */ 1118 #define WL_ULP_EVENT_VERSION 1 1119 #define WL_ULP_DISABLE_CONSOLE 1 /* Disable console message on ULP entry */ 1120 #define WL_ULP_UCODE_DOWNLOAD 2 /* Download ULP ucode file */ 1121 1122 typedef struct wl_ulp_event { 1123 uint16 version; 1124 uint16 ulp_dongle_action; 1125 } wl_ulp_event_t; 1126 1127 /* TCP keepalive event data */ 1128 typedef BWL_PRE_PACKED_STRUCT struct wl_event_tko { 1129 uint8 index; /* TCP connection index, 0 to max-1 */ 1130 uint8 pad[3]; /* 4-byte struct alignment */ 1131 } BWL_POST_PACKED_STRUCT wl_event_tko_t; 1132 1133 typedef struct { 1134 uint8 radar_type; /* one of RADAR_TYPE_XXX */ 1135 uint16 min_pw; /* minimum pulse-width (usec * 20) */ 1136 uint16 max_pw; /* maximum pulse-width (usec * 20) */ 1137 uint16 min_pri; /* minimum pulse repetition interval (usec) */ 1138 uint16 max_pri; /* maximum pulse repetition interval (usec) */ 1139 uint16 subband; /* subband/frequency */ 1140 } radar_detected_event_info_t; 1141 typedef struct wl_event_radar_detect_data { 1142 1143 uint32 version; 1144 uint16 current_chanspec; /* chanspec on which the radar is recieved */ 1145 uint16 target_chanspec; /* Target chanspec after detection of radar on current_chanspec */ 1146 radar_detected_event_info_t radar_info[2]; 1147 } wl_event_radar_detect_data_t; 1148 1149 #define WL_EVENT_MODESW_VER_1 1 1150 #define WL_EVENT_MODESW_VER_CURRENT WL_EVENT_MODESW_VER_1 1151 1152 #define WL_E_MODESW_FLAG_MASK_DEVICE 0x01u /* mask of device: belongs to local or peer */ 1153 #define WL_E_MODESW_FLAG_MASK_FROM 0x02u /* mask of origin: firmware or user */ 1154 #define WL_E_MODESW_FLAG_MASK_STATE 0x0Cu /* mask of state: modesw progress state */ 1155 1156 #define WL_E_MODESW_FLAG_DEVICE_LOCAL 0x00u /* flag - device: info is about self/local */ 1157 #define WL_E_MODESW_FLAG_DEVICE_PEER 0x01u /* flag - device: info is about peer */ 1158 1159 #define WL_E_MODESW_FLAG_FROM_FIRMWARE 0x00u /* flag - from: request is from firmware */ 1160 #define WL_E_MODESW_FLAG_FROM_USER 0x02u /* flag - from: request is from user/iov */ 1161 1162 #define WL_E_MODESW_FLAG_STATE_REQUESTED 0x00u /* flag - state: mode switch request */ 1163 #define WL_E_MODESW_FLAG_STATE_INITIATED 0x04u /* flag - state: switch initiated */ 1164 #define WL_E_MODESW_FLAG_STATE_COMPLETE 0x08u /* flag - state: switch completed/success */ 1165 #define WL_E_MODESW_FLAG_STATE_FAILURE 0x0Cu /* flag - state: failed to switch */ 1166 1167 /* Get sizeof *X including variable data's length where X is pointer to wl_event_mode_switch_t */ 1168 #define WL_E_MODESW_SIZE(X) (sizeof(*(X)) + (X)->length) 1169 1170 /* Get variable data's length where X is pointer to wl_event_mode_switch_t */ 1171 #define WL_E_MODESW_DATA_SIZE(X) (((X)->length > sizeof(*(X))) ? ((X)->length - sizeof(*(X))) : 0) 1172 1173 #define WL_E_MODESW_REASON_UNKNOWN 0u /* reason: UNKNOWN */ 1174 #define WL_E_MODESW_REASON_ACSD 1u /* reason: ACSD (based on events from FW */ 1175 #define WL_E_MODESW_REASON_OBSS_DBS 2u /* reason: OBSS DBS (eg. on interference) */ 1176 #define WL_E_MODESW_REASON_DFS 3u /* reason: DFS (eg. on subband radar) */ 1177 #define WL_E_MODESW_REASON_DYN160 4u /* reason: DYN160 (160/2x2 - 80/4x4) */ 1178 1179 /* event structure for WLC_E_MODE_SWITCH */ 1180 typedef struct { 1181 uint16 version; 1182 uint16 length; /* size including 'data' field */ 1183 uint16 opmode_from; 1184 uint16 opmode_to; 1185 uint32 flags; /* bit 0: peer(/local==0); 1186 * bit 1: user(/firmware==0); 1187 * bits 3,2: 00==requested, 01==initiated, 1188 * 10==complete, 11==failure; 1189 * rest: reserved 1190 */ 1191 uint16 reason; /* value 0: unknown, 1: ACSD, 2: OBSS_DBS, 1192 * 3: DFS, 4: DYN160, rest: reserved 1193 */ 1194 uint16 data_offset; /* offset to 'data' from beginning of this struct. 1195 * fields may be added between data_offset and data 1196 */ 1197 /* ADD NEW FIELDS HERE */ 1198 uint8 data[]; /* reason specific data; could be empty */ 1199 } wl_event_mode_switch_t; 1200 1201 /* when reason in WLC_E_MODE_SWITCH is DYN160, data will carry the following structure */ 1202 typedef struct { 1203 uint16 trigger; /* value 0: MU to SU, 1: SU to MU, 2: metric_dyn160, 3:re-/assoc, 1204 * 4: disassoc, 5: rssi, 6: traffic, 7: interference, 1205 * 8: chanim_stats 1206 */ 1207 struct ether_addr sta_addr; /* causal STA's MAC address when known */ 1208 uint16 metric_160_80; /* latest dyn160 metric */ 1209 uint8 nss; /* NSS of the STA */ 1210 uint8 bw; /* BW of the STA */ 1211 int8 rssi; /* RSSI of the STA */ 1212 uint8 traffic; /* internal metric of traffic */ 1213 } wl_event_mode_switch_dyn160; 1214 1215 #define WL_EVENT_FBT_VER_1 1 1216 1217 #define WL_E_FBT_TYPE_FBT_OTD_AUTH 1 1218 #define WL_E_FBT_TYPE_FBT_OTA_AUTH 2 1219 1220 /* event structure for WLC_E_FBT */ 1221 typedef struct { 1222 uint16 version; 1223 uint16 length; /* size including 'data' field */ 1224 uint16 type; /* value 0: unknown, 1: FBT OTD Auth Req */ 1225 uint16 data_offset; /* offset to 'data' from beginning of this struct. 1226 * fields may be added between data_offset and data 1227 */ 1228 /* ADD NEW FIELDS HERE */ 1229 uint8 data[]; /* type specific data; could be empty */ 1230 } wl_event_fbt_t; 1231 1232 /* TWT Setup Completion is designed to notify the user of TWT Setup process 1233 * status. When 'status' field is value of BCME_OK, the user must check the 1234 * 'setup_cmd' field value in 'wl_twt_sdesc_t' structure that at the end of 1235 * the event data to see the response from the TWT Responding STA; when 1236 * 'status' field is value of BCME_ERROR or non BCME_OK, user must not use 1237 * anything from 'wl_twt_sdesc_t' structure as it is the TWT Requesting STA's 1238 * own TWT parameter. 1239 */ 1240 1241 #define WL_TWT_SETUP_CPLT_VER 0u 1242 1243 /* TWT Setup Reason code */ 1244 typedef enum wl_twt_setup_rc { 1245 WL_TWT_SETUP_RC_ACCEPT = 0, /* TWT Setup Accepted */ 1246 WL_TWT_SETUP_RC_REJECT = 1, /* TWT Setup Rejected */ 1247 WL_TWT_SETUP_RC_TIMEOUT = 2, /* TWT Setup Time-out */ 1248 WL_TWT_SETUP_RC_IE = 3, /* TWT Setup IE Validation failed */ 1249 WL_TWT_SETUP_RC_PARAMS = 4, /* TWT Setup IE Params invalid */ 1250 WL_TWT_SETUP_RC_ERROR = 5, /* Generic Error cases */ 1251 } wl_twt_setup_rc_t; 1252 1253 /* TWT Setup Completion event data */ 1254 typedef struct wl_twt_setup_cplt { 1255 uint16 version; 1256 uint16 length; /* the byte count of fields from 'dialog' onwards */ 1257 uint8 dialog; /* Setup frame dialog token */ 1258 uint8 reason_code; /* see WL_TWT_SETUP_RC_XXXX */ 1259 uint8 pad[2]; 1260 int32 status; 1261 /* wl_twt_sdesc_t desc; - defined in wlioctl.h */ 1262 } wl_twt_setup_cplt_t; 1263 1264 #define WL_TWT_TEARDOWN_CPLT_VER 0u 1265 1266 /* TWT teardown Reason code */ 1267 typedef enum wl_twt_td_rc { 1268 WL_TWT_TD_RC_SUCCESS = 0, /* Teardown complete Successful */ 1269 WL_TWT_TD_RC_HOST = 1, /* Teardown triggered by Host */ 1270 WL_TWT_TD_RC_PEER = 2, /* Peer initiated teardown */ 1271 WL_TWT_TD_RC_MCHAN = 3, /* Teardown due to MCHAN Active */ 1272 WL_TWT_TD_RC_MCNX = 4, /* Teardown due to MultiConnection */ 1273 WL_TWT_TD_RC_SETUP_FAIL = 5, /* Setup fail midway. Teardown all connections */ 1274 WL_TWT_TD_RC_SCHED = 6, /* Teardown by TWT Scheduler */ 1275 WL_TWT_TD_RC_CSA = 7, /* Teardown due to CSA */ 1276 WL_TWT_TD_RC_BTCX = 8, /* Teardown due to BTCX */ 1277 WL_TWT_TD_RC_ERROR = 9, /* Generic Error cases */ 1278 } wl_twt_td_rc_t; 1279 1280 /* TWT Teardown complete event data */ 1281 typedef struct wl_twt_teardown_cplt { 1282 uint16 version; 1283 uint16 length; /* the byte count of fields from 'reason_code' onwards */ 1284 uint8 reason_code; /* WL_TWT_TD_RC_XXXX */ 1285 uint8 pad[3]; 1286 int32 status; 1287 /* wl_twt_teardesc_t; - defined in wlioctl.h */ 1288 } wl_twt_teardown_cplt_t; 1289 1290 #define WL_TWT_INFO_CPLT_VER 0u 1291 1292 /* TWT Info Reason code */ 1293 typedef enum wl_twt_info_rc { 1294 WL_TWT_INFO_RC_HOST = 0, /* Host initiated Info complete */ 1295 WL_TWT_INFO_RC_PEER = 1, /* Peer initiated TWT Info */ 1296 WL_TWT_INFO_RC_ERROR = 2, /* generic error conditions */ 1297 } wl_twt_info_rc_t; 1298 1299 /* TWT Info complete event data */ 1300 typedef struct wl_twt_info_cplt { 1301 uint16 version; 1302 uint16 length; /* the byte count of fields from 'reason_code' onwards */ 1303 uint8 reason_code; /* WL_TWT_INFO_RC_XXXX */ 1304 uint8 pad[3]; 1305 int32 status; 1306 /* wl_twt_infodesc_t; - defined in wlioctl.h */ 1307 } wl_twt_info_cplt_t; 1308 1309 #define WL_INVALID_IE_EVENT_VERSION 0 1310 1311 /* Invalid IE Event data */ 1312 typedef struct wl_invalid_ie_event { 1313 uint16 version; 1314 uint16 len; /* Length of the invalid IE copy */ 1315 uint16 type; /* Type/subtype of the frame which contains the invalid IE */ 1316 uint16 error; /* error code of the wrong IE, defined in ie_error_code_t */ 1317 uint8 ie[]; /* Variable length buffer for the invalid IE copy */ 1318 } wl_invalid_ie_event_t; 1319 1320 /* Fixed header portion of Invalid IE Event */ 1321 typedef struct wl_invalid_ie_event_hdr { 1322 uint16 version; 1323 uint16 len; /* Length of the invalid IE copy */ 1324 uint16 type; /* Type/subtype of the frame which contains the invalid IE */ 1325 uint16 error; /* error code of the wrong IE, defined in ie_error_code_t */ 1326 /* var length IE data follows */ 1327 } wl_invalid_ie_event_hdr_t; 1328 1329 typedef enum ie_error_code { 1330 IE_ERROR_OUT_OF_RANGE = 0x01 1331 } ie_error_code_t; 1332 1333 /* This marks the end of a packed structure section. */ 1334 #include <packed_section_end.h> 1335 1336 /* reason of channel switch */ 1337 typedef enum { 1338 CHANSW_DFS = 10, /* channel switch due to DFS module */ 1339 CHANSW_HOMECH_REQ = 14, /* channel switch due to HOME Channel Request */ 1340 CHANSW_STA = 15, /* channel switch due to STA */ 1341 CHANSW_SOFTAP = 16, /* channel switch due to SodtAP */ 1342 CHANSW_AIBSS = 17, /* channel switch due to AIBSS */ 1343 CHANSW_NAN = 18, /* channel switch due to NAN */ 1344 CHANSW_NAN_DISC = 19, /* channel switch due to NAN Disc */ 1345 CHANSW_NAN_SCHED = 20, /* channel switch due to NAN Sched */ 1346 1347 #ifdef WLAWDL 1348 CHANSW_AWDL_AW = 21, /* channel switch due to AWDL aw */ 1349 CHANSW_AWDL_SYNC = 22, /* channel switch due to AWDL sync */ 1350 CHANSW_AWDL_CAL = 23, /* channel switch due to AWDL Cal */ 1351 CHANSW_AWDL_PSF = 24, /* channel switch due to AWDL PSF */ 1352 CHANSW_AWDL_OOB_AF = 25, /* channel switch due to AWDL OOB action frame */ 1353 #endif /* WLAWDL */ 1354 1355 CHANSW_TDLS = 26, /* channel switch due to TDLS */ 1356 CHANSW_PROXD = 27, /* channel switch due to PROXD */ 1357 CHANSW_SLOTTED_BSS = 28, /* channel switch due to slotted bss */ 1358 CHANSW_SLOTTED_CMN_SYNC = 29, /* channel switch due to Common Sync Layer */ 1359 CHANSW_SLOTTED_BSS_CAL = 30, /* channel switch due to Cal request from slotted bss */ 1360 CHANSW_MAX_NUMBER = 31 /* max channel switch reason */ 1361 } wl_chansw_reason_t; 1362 1363 #define CHANSW_REASON(reason) (1 << reason) 1364 1365 #define EVENT_AGGR_DATA_HDR_LEN 8 1366 1367 typedef struct event_aggr_data { 1368 uint16 num_events; /* No of events aggregated */ 1369 uint16 len; /* length of the aggregated events, excludes padding */ 1370 uint8 pad[4]; /* Padding to make aggr event packet header aligned 1371 * on 64-bit boundary, for a 64-bit host system. 1372 */ 1373 uint8 data[]; /* Aggregate buffer containing Events */ 1374 } event_aggr_data_t; 1375 1376 /* WLC_E_TVPM_MITIGATION event structure version */ 1377 #define WL_TVPM_MITIGATION_VERSION 1 1378 1379 /* TVPM mitigation on/off status bits */ 1380 #define WL_TVPM_MITIGATION_TXDC 0x1 1381 #define WL_TVPM_MITIGATION_TXPOWER 0x2 1382 #define WL_TVPM_MITIGATION_TXCHAINS 0x4 1383 1384 /* Event structure for WLC_E_TVPM_MITIGATION */ 1385 typedef struct wl_event_tvpm_mitigation { 1386 uint16 version; /* structure version */ 1387 uint16 length; /* length of this structure */ 1388 uint32 timestamp_ms; /* millisecond timestamp */ 1389 uint8 slice; /* slice number */ 1390 uint8 pad; 1391 uint16 on_off; /* mitigation status bits */ 1392 } wl_event_tvpm_mitigation_t; 1393 1394 /* Event structures for sub health checks of PHY */ 1395 1396 #define WL_PHY_HC_DESENSE_STATS_VER (1) 1397 typedef struct wl_hc_desense_stats { 1398 uint16 version; 1399 uint16 chanspec; 1400 int8 allowed_weakest_rssi; /* based on weakest link RSSI */ 1401 uint8 ofdm_desense; /* Desense requested for OFDM */ 1402 uint8 bphy_desense; /* Desense requested for bphy */ 1403 int8 glitch_upd_wait; /* wait post ACI mitigation */ 1404 } wl_hc_desense_stats_v1_t; 1405 1406 #define WL_PHY_HC_TEMP_STATS_VER (1) 1407 typedef struct wl_hc_temp_stats { 1408 uint16 version; 1409 uint16 chanspec; 1410 int16 curtemp; /* Temperature */ 1411 uint8 temp_disthresh; /* Threshold to reduce tx chain */ 1412 uint8 temp_enthresh; /* Threshold to increase tx chains */ 1413 uint tempsense_period; /* Temperature check period */ 1414 bool heatedup; /* 1: temp throttling on */ 1415 uint8 bitmap; /* Indicating rx and tx chains */ 1416 uint8 pad[2]; 1417 } wl_hc_temp_stats_v1_t; 1418 1419 #define WL_PHY_HC_TEMP_STATS_VER_2 (2) 1420 typedef struct { 1421 uint16 version; 1422 uint16 chanspec; 1423 int16 curtemp; /* Temperature */ 1424 uint8 pad[2]; 1425 } wl_hc_temp_stats_v2_t; 1426 1427 #define WL_PHY_HC_VCOCAL_STATS_VER (1) 1428 typedef struct wl_hc_vcocal_stats { 1429 uint16 version; 1430 uint16 chanspec; 1431 int16 curtemp; /* Temperature */ 1432 /* Ring buffer - Maintains history of previous 16 wake/sleep cycles */ 1433 uint16 vcocal_status_wake; 1434 uint16 vcocal_status_sleep; 1435 uint16 plllock_status_wake; 1436 uint16 plllock_status_sleep; 1437 /* Cal Codes */ 1438 uint16 cc_maincap; 1439 uint16 cc_secondcap; 1440 uint16 cc_auxcap; 1441 } wl_hc_vcocal_stats_v1_t; 1442 1443 #define WL_PHY_HC_TXPWR_STATS_VER (1) 1444 typedef struct wl_hc_tx_stats { 1445 uint16 version; 1446 uint16 chanspec; 1447 int8 tgt_pwr[MAX_PHY_CORE_NUM]; /* Target pwr (qdBm) */ 1448 int8 estPwr[MAX_PHY_CORE_NUM]; /* Rate corrected (qdBm) */ 1449 int8 estPwr_adj[MAX_PHY_CORE_NUM]; /* Max power (qdBm) */ 1450 uint8 baseindex[MAX_PHY_CORE_NUM]; /* Tx base index */ 1451 int16 temp; /* Temperature */ 1452 uint16 TxCtrlWrd[3]; /* 6 PHY ctrl bytes */ 1453 int8 min_txpower; /* min tx power per ant */ 1454 uint8 pad[3]; 1455 } wl_hc_txpwr_stats_v1_t; 1456 1457 #define WL_PHY_HC_TXPWR_STATS_VER_2 (2) 1458 typedef struct { 1459 uint16 version; 1460 uint16 chanspec; 1461 int8 tgt_pwr[MAX_PHY_CORE_NUM]; /* Target pwr (qdBm) */ 1462 uint8 estPwr[MAX_PHY_CORE_NUM]; /* Rate corrected (qdBm) */ 1463 uint8 estPwr_adj[MAX_PHY_CORE_NUM]; /* Max power (qdBm) */ 1464 uint8 baseindex[MAX_PHY_CORE_NUM]; /* Tx base index */ 1465 int16 temp; /* Temperature */ 1466 uint16 TxCtrlWrd[3]; /* 6 PHY ctrl bytes */ 1467 int8 min_txpower; /* min tx power per ant */ 1468 uint8 pad[3]; 1469 } wl_hc_txpwr_stats_v2_t; 1470 1471 typedef enum wl_mbo_event_type { 1472 WL_MBO_E_CELLULAR_NW_SWITCH = 1, 1473 WL_MBO_E_BTM_RCVD = 2, 1474 /* ADD before this */ 1475 WL_MBO_E_LAST = 3 /* highest val + 1 for range checking */ 1476 } wl_mbo_event_type_t; 1477 1478 /* WLC_E_MBO event structure version */ 1479 #define WL_MBO_EVT_VER 1 1480 1481 struct wl_event_mbo { 1482 uint16 version; /* structure version */ 1483 uint16 length; /* length of the rest of the structure from type */ 1484 wl_mbo_event_type_t type; /* Event type */ 1485 uint8 data[]; /* Variable length data */ 1486 }; 1487 1488 /* WLC_E_MBO_CELLULAR_NW_SWITCH event structure version */ 1489 #define WL_MBO_CELLULAR_NW_SWITCH_VER 1 1490 1491 /* WLC_E_MBO_CELLULAR_NW_SWITCH event data */ 1492 struct wl_event_mbo_cell_nw_switch { 1493 uint16 version; /* structure version */ 1494 uint16 length; /* length of the rest of the structure from reason */ 1495 /* Reason of switch as per MBO Tech spec */ 1496 uint8 reason; 1497 /* pad */ 1498 uint8 pad; 1499 /* delay after which re-association can be tried to current BSS (seconds) */ 1500 uint16 reassoc_delay; 1501 /* How long current association will be there (milli seconds). 1502 * This is zero if not known or value is overflowing. 1503 */ 1504 uint32 assoc_time_remain; 1505 }; 1506 1507 /* WLC_E_MBO_BTM_RCVD event structure version */ 1508 #define WL_BTM_EVENT_DATA_VER_1 1 1509 /* Specific btm event type data */ 1510 struct wl_btm_event_type_data { 1511 uint16 version; 1512 uint16 len; 1513 uint8 transition_reason; /* transition reason code */ 1514 uint8 pad[3]; /* pad */ 1515 }; 1516 1517 /* WLC_E_PRUNE event structure version */ 1518 #define WL_BSSID_PRUNE_EVT_VER_1 1 1519 /* MBO-OCE params */ 1520 struct wl_bssid_prune_evt_info { 1521 uint16 version; 1522 uint16 len; 1523 uint8 SSID[32]; 1524 uint32 time_remaining; /* Time remaining */ 1525 struct ether_addr BSSID; 1526 uint8 SSID_len; 1527 uint8 reason; /* Reason code */ 1528 int8 rssi_threshold; /* RSSI threshold */ 1529 uint8 pad[3]; /* pad */ 1530 }; 1531 1532 /* WLC_E_ADPS status */ 1533 enum { 1534 WL_E_STATUS_ADPS_DEAUTH = 0, 1535 WL_E_STATUS_ADPS_MAX 1536 }; 1537 1538 /* WLC_E_ADPS event data */ 1539 #define WL_EVENT_ADPS_VER_1 1 1540 1541 /* WLC_E_ADPS event type */ 1542 #define WL_E_TYPE_ADPS_BAD_AP 1 1543 1544 typedef struct wl_event_adps_bad_ap { 1545 uint32 status; 1546 uint32 reason; 1547 struct ether_addr ea; /* bssid */ 1548 } wl_event_adps_bad_ap_t; 1549 1550 typedef struct wl_event_adps { 1551 uint16 version; /* structure version */ 1552 uint16 length; /* length of structure */ 1553 uint32 type; /* event type */ 1554 uint8 data[]; /* variable length data */ 1555 } wl_event_adps_v1_t; 1556 1557 typedef wl_event_adps_v1_t wl_event_adps_t; 1558 1559 #define WLC_USER_E_KEY_UPDATE 1 /* Key add/remove */ 1560 #define WLC_USER_E_FORCE_FLUSH 2 /* SDC force flush */ 1561 1562 /* OBSS HW event data */ 1563 typedef struct wlc_obss_hw_event_data { 1564 uint16 available_chanspec; /* Contains band, channel and BW info */ 1565 } wlc_obss_hw_event_data_t; 1566 1567 /* status when WLC_E_OBSS_DETECTION */ 1568 #define WLC_OBSS_BW_UPDATED 1 /* Sent when BW is update at SW */ 1569 #define WLC_OBSS_BW_AVAILABLE 2 /* Sent When a change in BW is detected / noticed */ 1570 1571 /* WLC_E_DYNSAR event structure version */ 1572 #define WL_DYNSAR_VERSION 1 1573 1574 /* bits used in status field */ 1575 #define WL_STATUS_DYNSAR_PWR_OPT (1 << 0) /* power optimized */ 1576 #define WL_STATUS_DYNSAR_FAILSAFE (1 << 1) /* radio is using failsafe cap values */ 1577 #define WL_STATUS_DYNSAR_NOMUTE_OPT (1 << 2) /* ack mute */ 1578 1579 /* Event structure for WLC_E_DYNSAR */ 1580 typedef struct wl_event_dynsar { 1581 uint16 version; /* structure version */ 1582 uint16 length; /* length of this structure */ 1583 uint32 timestamp_ms; /* millisecond timestamp */ 1584 uint8 opt; /* optimization power offset */ 1585 uint8 slice; /* slice number */ 1586 uint8 status; /* WL_STATUS_DYNSAR_XXX, to indicate which optimization 1587 * is being applied 1588 */ 1589 uint8 pad; 1590 } wl_event_dynsar_t; 1591 1592 /* status when WLC_E_AP_BCN_MUTE event is sent */ 1593 #define BCN_MUTE_MITI_ACTIVE 1u /* Mitigation is activated when probe response received 1594 * but Beacon is not received 1595 */ 1596 #define BCN_MUTE_MITI_END 2u /* Sent when beacon is received */ 1597 #define BCN_MUTE_MITI_TIMEOUT 3u /* Mitigation period is reached */ 1598 1599 /* bcn_mute_miti event data */ 1600 #define WLC_BCN_MUTE_MITI_EVENT_DATA_VER_1 1u 1601 typedef struct wlc_bcn_mute_miti_event_data_v1 { 1602 uint16 version; /* Structure version number */ 1603 uint16 length; /* Length of the whole struct */ 1604 uint16 uatbtt_count; /* Number of UATBTT during mitigation */ 1605 uint8 PAD[2]; /* Pad to fit to 32 bit alignment */ 1606 } wlc_bcn_mute_miti_event_data_v1_t; 1607 1608 /* bcn_drift event data */ 1609 #define WLC_BCN_DRIFT_EVENT_DATA_VER_1 (1u) 1610 typedef struct wlc_bcn_drift_event_data_v1 { 1611 uint16 version; /* Structure version number */ 1612 uint16 length; /* Length of the whole struct */ 1613 int16 drift; /* in ms */ 1614 int16 jitter; /* in ms */ 1615 } wlc_bcn_drift_event_data_v1_t; 1616 1617 #endif /* _BCMEVENT_H_ */ 1618