Wi-Fi Driver Data Types

WDRV_PIC32MZW_ASSOC_HANDLE

Description:

An ‘opaque’ type (implemented as a pointer). Application code should never set this directly and should instead only store values returned from the Wi-Fi driver for later use in subsequent calls (to the Wi-Fi driver).

WDRV_PIC32MZW_AUTH_TYPE

Description:

Defines various authentication types for use in connecting-to or hosting Wi-Fi networks.

Definitions:

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_AUTH_TYPE_’:

WDRV_PIC32MZW_AUTH_MOD_MASK

Description:

Defines modifiers (optional settings) for a configured WDRV_PIC32MZW_AUTH_TYPE. Not all modifiers are relevant to all authentication types.

Definitions:

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_AUTH_MOD_’:

WDRV_PIC32MZW_CHANNEL_ID

Description:

Defines the supported Wi-Fi channels on the PIC322MZW1.

Definitions:

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_CID_’:

WDRV_PIC32MZW_CHANNEL24_MASK

Description:

A bitmap identifying the legal channels for the current regulatory region. This type also contains definitions for specific regulatory regions such as North America, Europe, Asia for convenience when using the regulatory APIs.

Definitions:

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_CM_24G’:

WDRV_PIC32MZW_CONN_STATE

Description:

Defines the possible Wi-Fi connection states of the driver.

Definitions:

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_CONN_STATE_’:

WDRV_PIC32MZW_POWERSAVE_MODE

Description:

This enumeration defines the various WiFi power save modes supported by WiFi.

Definitions

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_POWERSAVE_’:

WDRV_PIC32MZW_POWERSAVE_CORRELATION

Description:

This enumeration defines the correlation between WiFi and PIC sleep modes.

Definitions

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_POWERSAVE_PIC_’:

WDRV_PIC32MZW_POWERSAVE_CONFIG
{
    WDRV_PIC32MZW_POWERSAVE_MODE powerSaveMode;
	WDRV_PIC32MZW_POWERSAVE_CORRELATION picCorrelation;
	bool saveContextEnabled;
	bool BcastTrafficEnabled;
}

Description:

The configuration structure contains information related to powersave mode, correlation with the pic state, listen interval, configuring DTIM monitoring etc.

Fields:

WDRV_PIC32MZW_MAC_ADDR
{
	uint8_t addr[WDRV_PIC32MZW_MAC_ADDR_LEN];
	bool valid;
}

Description:

Defines a Wi-Fi network name (Service Set Identifier) – this is used to identify a specific Wi-Fi network to connect to, or to specify the name of a the network being hosted when the device is in SoftAP mode.

Fields:

WDRV_PIC32MZW_SSID
{
	uint8_t name[WDRV_PIC32MZW_MAX_SSID_LEN];
	uint8_t length;
} 

Description:

Defines a Wi-Fi network name (Service Set Identifier) – this is used to identify a specific Wi-Fi network to connect to, or to specify the name of a the network being hosted when the device is in SoftAP mode.

Fields:

WDRV_PIC32MZW_BSS_CONTEXT
{
	WDRV_PIC32MZW_SSID ssid;
	WDRV_PIC32MZW_MAC_ADDR bssid;
	WDRV_PIC32MZW_CHANNEL_ID channel;
	Bool cloaked;
}

Description:

Context structure containing information related to Basic Service Sets (BSS). The BSS context is used to identify a network to connect to, or to define the parameters for the device if in softAP mode.

Fields:

WDRV_PIC32MZW_BSS_INFO
{
	WDRV_PIC32MZW_BSS_CONTEXT ctx;
	int8_t rssi;
	WDRV_PIC32MZW_SEC_MASK secCapabilities;
	WDRV_PIC32MZW_AUTH_TYPE authTypeRecommended;
}

Description:

A structure containing information related to a discovered network (Basic Service Set). This is typically used to inspect a network’s capabilities prior to association/connection.

Fields:

WDRV_PIC32MZW_AUTH_CONTEXT
{
	WDRV_PIC32MZW_AUTH_TYPE authType;
	WDRV_PIC32MZW_AUTH_MOD_MASK authMod;
	authInfo;
}

Description:

Context structure containing information related to the authentication requirements of the Wi-Fi network (typically used in conjunction with the WDRV_PIC32MZW_BSS_CONTEXT).

Fields:

WEP

WPA/WPA2/WPA3 Personal

WDRV_PIC32MZW_REGDOMAIN_SELECT

Description:

Defines the set of regulatory configurations to return to the application when querying via the WDRV_PIC32MZW_RegDomainGet API.

Definitions:

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_REGDOMAIN_SELECT _’:

WDRV_PIC32MZW_REGDOMAIN_INFO
{
	uint8_t regDomainLen;
    uint8_t regDomain[WDRV_PIC32MZW_REGDOMAIN_MAX_NAME_LEN];
    struct
    {
        uint16_t major;
        uint16_t minor;
    } version;
}

Description:

Specifies the country code length, country code associated with the regulatory domain, major and minor values of RF PHY version.

Fields:

WDRV_PIC32MZW_SEC_MASK

Description:

Defines the various security suites supported by a network.

Definitions:

Please note: the following definitions are all prefixed with ‘WDRV_PIC32MZW_SEC_BIT_’: