Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Macros | Typedefs | Enumerations | Functions
whd_events.h File Reference

Header for Event detection. More...

#include "whd.h"

Go to the source code of this file.

Data Structures

struct  whd_event_eth_hdr
 Structure to store ethernet header fields in event packets. More...
 
struct  whd_event_ether_header
 Structure to store ethernet destination, source and ethertype in event packets. More...
 
struct  whd_event_msg
 Structure to store fields after ethernet header in event message. More...
 
struct  whd_event
 Event structure used by driver msgs. More...
 

Macros

#define WLC_E_NONE   (0x7FFFFFFE)
 Indicates the end of the event array list. More...
 
#define WLC_E_SET_SSID   0
 Indicates status of set SSID. More...
 
#define WLC_E_AUTH   3
 802.11 AUTH request event occurs when STA tries to get authenticated with the AP More...
 
#define WLC_E_DEAUTH   5
 802.11 DEAUTH request event occurs when the the SOFTAP is stopped to deuthenticate the connected stations More...
 
#define WLC_E_DEAUTH_IND   6
 802.11 DEAUTH indication event occurs when the STA gets deauthenticated by the AP More...
 
#define WLC_E_ASSOC   7
 802.11 ASSOC request event occurs when STA joins the AP More...
 
#define WLC_E_ASSOC_IND   8
 802.11 ASSOC indication occurs when a station joins the SOFTAP that is started More...
 
#define WLC_E_REASSOC   9
 802.11 REASSOC request event when the STA again gets associated with the AP More...
 
#define WLC_E_REASSOC_IND   10
 802.11 REASSOC indication occurs when a station again reassociates with the SOFTAP More...
 
#define WLC_E_DISASSOC   11
 802.11 DISASSOC request occurs when the STA the tries to leave the AP More...
 
#define WLC_E_DISASSOC_IND   12
 802.11 DISASSOC indication occurs when the connected station gets disassociates from SOFTAP, also when STA gets diassociated by the AP More...
 
#define WLC_E_LINK   16
 generic link indication More...
 
#define WLC_E_PROBREQ_MSG   44
 Indicates probe request received for the SOFTAP started. More...
 
#define WLC_E_PSK_SUP   46
 WPA Handshake fail during association. More...
 
#define WLC_E_ACTION_FRAME   59
 Indicates Action frame Rx. More...
 
#define WLC_E_ACTION_FRAME_COMPLETE   60
 Indicates Action frame Tx complete. More...
 
#define WLC_E_ESCAN_RESULT   69
 escan result event occurs when we scan for the networks More...
 
#define WLC_E_STATUS_SUCCESS   0
 operation was successful More...
 
#define WLC_E_STATUS_FAIL   1
 operation failed More...
 
#define WLC_E_STATUS_TIMEOUT   2
 operation timed out More...
 
#define WLC_E_STATUS_NO_NETWORKS   3
 failed due to no matching network found More...
 
#define WLC_E_STATUS_ABORT   4
 operation was aborted More...
 
#define WLC_E_STATUS_NO_ACK   5
 protocol failure: packet not ack'd More...
 
#define WLC_E_STATUS_UNSOLICITED   6
 AUTH or ASSOC packet was unsolicited. More...
 
#define WLC_E_STATUS_ATTEMPT   7
 attempt to assoc to an auto auth configuration More...
 
#define WLC_E_STATUS_PARTIAL   8
 scan results are incomplete More...
 
#define WLC_E_STATUS_NEWSCAN   9
 scan aborted by another scan More...
 
#define WLC_E_STATUS_NEWASSOC   10
 scan aborted due to assoc in progress More...
 
#define WLC_E_STATUS_11HQUIET   11
 802.11h quiet period started More...
 
#define WLC_E_STATUS_SUPPRESS   12
 user disabled scanning (WLC_SET_SCANSUPPRESS) More...
 
#define WLC_E_STATUS_NOCHANS   13
 no allowable channels to scan More...
 
#define WLC_E_STATUS_CCXFASTRM   14
 scan aborted due to CCX fast roam More...
 
#define WLC_E_STATUS_CS_ABORT   15
 abort channel select More...
 
#define WLC_E_STATUS_ERROR   16
 request failed due to error More...
 
#define WLC_E_STATUS_INVALID   0xff
 Invalid status code to init variables. More...
 
#define WLC_SUP_STATUS_OFFSET   (256)
 Status offset added to the status codes to match the values from firmware. More...
 
#define WHD_MSG_IFNAME_MAX   16
 Max length of Interface name. More...
 

Typedefs

typedef enum sup_auth_status sup_auth_status_t
 Status code for event WLC_E_PSK_SUP. More...
 
typedef struct whd_event_eth_hdr whd_event_eth_hdr_t
 Structure to store ethernet header fields in event packets. More...
 
typedef struct whd_event_ether_header whd_event_ether_header_t
 Structure to store ethernet destination, source and ethertype in event packets. More...
 
typedef struct whd_event whd_event_t
 Event structure used by driver msgs. More...
 
typedef void *(* whd_event_handler_t) (whd_interface_t ifp, const whd_event_header_t *event_header, const uint8_t *event_data, void *handler_user_data)
 Event handler prototype definition. More...
 
typedef void *(* whd_error_handler_t) (whd_driver_t whd_driver, const uint8_t *error_type, const uint8_t *event_data, void *handler_user_data)
 Error handler prototype definition. More...
 

Enumerations

Functions

uint32_t whd_wifi_set_event_handler (whd_interface_t ifp, const uint32_t *event_type, whd_event_handler_t handler_func, void *handler_user_data, uint16_t *event_index)
 Registers a handler to receive event callbacks. More...
 
uint32_t whd_wifi_set_error_handler (whd_interface_t ifp, const uint8_t *error_nums, whd_error_handler_t handler_func, void *handler_user_data, uint16_t *error_index)
 Registers a handler to receive error callbacks. More...
 
uint32_t whd_wifi_deregister_event_handler (whd_interface_t ifp, uint16_t event_index)
 Delete/Deregister the event entry where callback is registered. More...
 
uint32_t whd_wifi_deregister_error_handler (whd_interface_t ifp, uint16_t error_index)
 Delete/Deregister the error entry where callback is registered. More...
 

Detailed Description

Header for Event detection.

Provides constants and prototypes for functions that allow user applications to receive event callbacks and set event handlers

Definition in file whd_events.h.

Macro Definition Documentation

#define WHD_MSG_IFNAME_MAX   16

Max length of Interface name.

Definition at line 119 of file whd_events.h.

#define WLC_E_ACTION_FRAME   59

Indicates Action frame Rx.

Definition at line 52 of file whd_events.h.

#define WLC_E_ACTION_FRAME_COMPLETE   60

Indicates Action frame Tx complete.

Definition at line 53 of file whd_events.h.

#define WLC_E_ASSOC   7

802.11 ASSOC request event occurs when STA joins the AP

Definition at line 41 of file whd_events.h.

#define WLC_E_ASSOC_IND   8

802.11 ASSOC indication occurs when a station joins the SOFTAP that is started

Definition at line 42 of file whd_events.h.

#define WLC_E_AUTH   3

802.11 AUTH request event occurs when STA tries to get authenticated with the AP

Definition at line 38 of file whd_events.h.

#define WLC_E_DEAUTH   5

802.11 DEAUTH request event occurs when the the SOFTAP is stopped to deuthenticate the connected stations

Definition at line 39 of file whd_events.h.

#define WLC_E_DEAUTH_IND   6

802.11 DEAUTH indication event occurs when the STA gets deauthenticated by the AP

Definition at line 40 of file whd_events.h.

#define WLC_E_DISASSOC   11

802.11 DISASSOC request occurs when the STA the tries to leave the AP

Definition at line 45 of file whd_events.h.

#define WLC_E_DISASSOC_IND   12

802.11 DISASSOC indication occurs when the connected station gets disassociates from SOFTAP, also when STA gets diassociated by the AP

Definition at line 46 of file whd_events.h.

#define WLC_E_ESCAN_RESULT   69

escan result event occurs when we scan for the networks

Definition at line 54 of file whd_events.h.

#define WLC_E_LINK   16

generic link indication

Definition at line 49 of file whd_events.h.

#define WLC_E_NONE   (0x7FFFFFFE)

Indicates the end of the event array list.

Definition at line 35 of file whd_events.h.

#define WLC_E_PROBREQ_MSG   44

Indicates probe request received for the SOFTAP started.

Definition at line 50 of file whd_events.h.

#define WLC_E_PSK_SUP   46

WPA Handshake fail during association.

Definition at line 51 of file whd_events.h.

#define WLC_E_REASSOC   9

802.11 REASSOC request event when the STA again gets associated with the AP

Definition at line 43 of file whd_events.h.

#define WLC_E_REASSOC_IND   10

802.11 REASSOC indication occurs when a station again reassociates with the SOFTAP

Definition at line 44 of file whd_events.h.

#define WLC_E_SET_SSID   0

Indicates status of set SSID.

This event occurs when STA tries to join the AP

Definition at line 37 of file whd_events.h.

#define WLC_E_STATUS_11HQUIET   11

802.11h quiet period started

Definition at line 68 of file whd_events.h.

#define WLC_E_STATUS_ABORT   4

operation was aborted

Definition at line 61 of file whd_events.h.

#define WLC_E_STATUS_ATTEMPT   7

attempt to assoc to an auto auth configuration

Definition at line 64 of file whd_events.h.

#define WLC_E_STATUS_CCXFASTRM   14

scan aborted due to CCX fast roam

Definition at line 71 of file whd_events.h.

#define WLC_E_STATUS_CS_ABORT   15

abort channel select

Definition at line 72 of file whd_events.h.

#define WLC_E_STATUS_ERROR   16

request failed due to error

Definition at line 73 of file whd_events.h.

#define WLC_E_STATUS_FAIL   1

operation failed

Definition at line 58 of file whd_events.h.

#define WLC_E_STATUS_INVALID   0xff

Invalid status code to init variables.

Definition at line 74 of file whd_events.h.

#define WLC_E_STATUS_NEWASSOC   10

scan aborted due to assoc in progress

Definition at line 67 of file whd_events.h.

#define WLC_E_STATUS_NEWSCAN   9

scan aborted by another scan

Definition at line 66 of file whd_events.h.

#define WLC_E_STATUS_NO_ACK   5

protocol failure: packet not ack'd

Definition at line 62 of file whd_events.h.

#define WLC_E_STATUS_NO_NETWORKS   3

failed due to no matching network found

Definition at line 60 of file whd_events.h.

#define WLC_E_STATUS_NOCHANS   13

no allowable channels to scan

Definition at line 70 of file whd_events.h.

#define WLC_E_STATUS_PARTIAL   8

scan results are incomplete

Definition at line 65 of file whd_events.h.

#define WLC_E_STATUS_SUCCESS   0

operation was successful

Definition at line 57 of file whd_events.h.

#define WLC_E_STATUS_SUPPRESS   12

user disabled scanning (WLC_SET_SCANSUPPRESS)

Definition at line 69 of file whd_events.h.

#define WLC_E_STATUS_TIMEOUT   2

operation timed out

Definition at line 59 of file whd_events.h.

#define WLC_E_STATUS_UNSOLICITED   6

AUTH or ASSOC packet was unsolicited.

Definition at line 63 of file whd_events.h.

#define WLC_SUP_STATUS_OFFSET   (256)

Status offset added to the status codes to match the values from firmware.

Definition at line 76 of file whd_events.h.

Typedef Documentation

Status code for event WLC_E_PSK_SUP.

-Basic supplicant authentication states

  • WLC_SUP_DISCONNECTED
    • WLC_SUP_CONNECTING
    • WLC_SUP_IDREQUIRED
    • WLC_SUP_AUTHENTICATING
    • WLC_SUP_AUTHENTICATED
    • WLC_SUP_KEYXCHANGE
    • WLC_SUP_KEYED
    • WLC_SUP_TIMEOUT
    • WLC_SUP_LAST_BASIC_STATE -Extended supplicant authentication states
    • WLC_SUP_KEYXCHANGE_WAIT_M1
    • WLC_SUP_KEYXCHANGE_PREP_M2
    • WLC_SUP_KEYXCHANGE_WAIT_M3
    • WLC_SUP_KEYXCHANGE_PREP_M4
    • WLC_SUP_KEYXCHANGE_WAIT_G1
    • WLC_SUP_KEYXCHANGE_PREP_G2

Structure to store ethernet header fields in event packets.

Structure to store ethernet destination, source and ethertype in event packets.

typedef struct whd_event whd_event_t

Event structure used by driver msgs.

Enumeration Type Documentation

Status code for event WLC_E_PSK_SUP.

-Basic supplicant authentication states

  • WLC_SUP_DISCONNECTED
    • WLC_SUP_CONNECTING
    • WLC_SUP_IDREQUIRED
    • WLC_SUP_AUTHENTICATING
    • WLC_SUP_AUTHENTICATED
    • WLC_SUP_KEYXCHANGE
    • WLC_SUP_KEYED
    • WLC_SUP_TIMEOUT
    • WLC_SUP_LAST_BASIC_STATE -Extended supplicant authentication states
    • WLC_SUP_KEYXCHANGE_WAIT_M1
    • WLC_SUP_KEYXCHANGE_PREP_M2
    • WLC_SUP_KEYXCHANGE_WAIT_M3
    • WLC_SUP_KEYXCHANGE_PREP_M4
    • WLC_SUP_KEYXCHANGE_WAIT_G1
    • WLC_SUP_KEYXCHANGE_PREP_G2
Enumerator
WLC_SUP_DISCONNECTED 

Status offset added to the status codes to match the values from firmware.

Disconnected

WLC_SUP_CONNECTING 

Status offset added to the status codes to match the values from firmware.

Connecting

WLC_SUP_IDREQUIRED 

Status offset added to the status codes to match the values from firmware.

ID Required

WLC_SUP_AUTHENTICATING 

Status offset added to the status codes to match the values from firmware.

Authenticating

WLC_SUP_AUTHENTICATED 

Status offset added to the status codes to match the values from firmware.

Authenticated

WLC_SUP_KEYXCHANGE 

Status offset added to the status codes to match the values from firmware.

Key Exchange

WLC_SUP_KEYED 

Status offset added to the status codes to match the values from firmware.

Key Exchanged

WLC_SUP_TIMEOUT 

Status offset added to the status codes to match the values from firmware.

Timeout

WLC_SUP_LAST_BASIC_STATE 

Status offset added to the status codes to match the values from firmware.

Last Basic State

WLC_SUP_KEYXCHANGE_WAIT_M1 

Waiting to receive handshake msg M1.

WLC_SUP_KEYXCHANGE_PREP_M2 

Preparing to send handshake msg M2.

WLC_SUP_KEYXCHANGE_WAIT_M3 

Waiting to receive handshake msg M3.

WLC_SUP_KEYXCHANGE_PREP_M4 

Status offset added to the status codes to match the values from firmware.

Preparing to send handshake msg M4

WLC_SUP_KEYXCHANGE_WAIT_G1 

Status offset added to the status codes to match the values from firmware.

Waiting to receive handshake msg G1

WLC_SUP_KEYXCHANGE_PREP_G2 

Status offset added to the status codes to match the values from firmware.

Preparing to send handshake msg G2

Definition at line 100 of file whd_events.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.