1.3.2.1 WDRV_PIC32MZW_CTRLDCPT Struct

C

typedef struct _WDRV_PIC32MZW_CTRLDCPT
{
    /* Primary driver handle. */
    DRV_HANDLE handle;
    
    /* Flag indicating if this instance is operating as s station or soft-AP. */
    bool isAP;
    
    /* Variable to store the state of the connection. */
    WDRV_PIC32MZW_CONN_STATE connectedState;
    
    /* Flag indicating if a BSS scan is currently in progress. */
    bool scanInProgress;
    
    /* Current index of the BSS scan results. */
    uint8_t scanIndex;
    
    /* Flag indicating if the scan parameters have been modified. */
    bool scanParamDefault;
    
    /* The number of scan slots per channel. */
    uint8_t scanNumSlots;
    
    /* Number of probe requests to be sent each scan slot. */
    uint8_t scanNumProbes;
    
    /* Time spent on each active channel probing for BSS's. */
    uint16_t scanActiveScanTime;
    
    /* Time spent on each passive channel listening for beacons. */
    uint16_t scanPassiveListenTime;
    
    /* The current power-save mode. */
    WDRV_PIC32MZW_POWERSAVE_MODE powerSaveMode;
    
    /* Power-save PIC/WiFi sync/async correlation mode. */
    WDRV_PIC32MZW_POWERSAVE_PIC_CORRELATION powerSavePICCorrelation;
    
    /* Access semaphore for MAC firmware library. */
    OSAL_SEM_HANDLE_TYPE drvAccessSemaphore;
    
    /* Main event semaphore. */
    OSAL_SEM_HANDLE_TYPE drvEventSemaphore;
    
    /* Bitmap of enabled 2.4GHz channels for scanning. */
    WDRV_PIC32MZW_CHANNEL24_MASK scanChannelMask24;
    
    /* Current operating channel. */
    WDRV_PIC32MZW_CHANNEL_ID opChannel;
    
    /* Association information (STA). */
    WDRV_PIC32MZW_ASSOC_INFO assocInfoSTA;
    
    /* Association information (AP). */
    WDRV_PIC32MZW_ASSOC_INFO assocInfoAP[WDRV_PIC32MZW_NUM_ASSOCS];
    
    /* Regulatory domain name */
    char regDomName[WDRV_PIC32MZW_REGDOMAIN_MAX_NAME_LEN];
    
    /* Length of regulatory domain name */
    uint8_t regDomNameLength;
    
    /* RF and MAC configuration status */
    uint8_t rfMacConfigStatus;
    
    /* Physical MAC address of interface. */
    WDRV_PIC32MZW_MAC_ADDR macAddr;
    
    /* Extended system status which can be queried via WDRV_PIC32MZW_StatusExt. */
    WDRV_PIC32MZW_SYS_STATUS extSysStat;
    
    /* Callback to use for BSS find operations. */
    WDRV_PIC32MZW_BSSFIND_NOTIFY_CALLBACK pfBSSFindNotifyCB;
    
    /* Callback to use for notifying changes in connection state. */
    WDRV_PIC32MZW_BSSCON_NOTIFY_CALLBACK pfConnectNotifyCB;
    
    /* Callback to use for retrieving association RSSI information from the PIC32MZW. */
    WDRV_PIC32MZW_ASSOC_RSSI_CALLBACK pfAssociationRSSICB;
    
    /* Callback to use for retrieving regulatory domain information. */
    WDRV_PIC32MZW_REGDOMAIN_CALLBACK pfRegDomCB;
    
    /* Callback used for retrieving vendor IE information received. */
    WDRV_PIC32MZW_IE_RX_CALLBACK pfVendorIERxCB;
    
    /* Vendor specific IE frame filter mask */
    uint8_t vendorIEMask;
    
    /* Handle to driver TLS module */
    DRV_PIC32MZW1_TLS_HANDLE tlsHandle;
    
    /* Callback to use for notifying WiFi power-save sleep entry and exit.*/
    WDRV_PIC32MZW_PS_NOTIFY_CALLBACK pfPSNotifyCB;
    
} WDRV_PIC32MZW_CTRLDCPT;

Summary

Driver descriptor for the PIC32MZW Control driver.

Description

Structure containing the system level descriptor for the PIC32MZW driver. This structure is initialized by a call to WDRV_PIC32MZW_MACInitialize.

Remarks

None.