WLAN

Overview

Defines a WLAN module that supports cross-OS migration, component adaptation, and modular assembly and compilation. Driver developers of WLAN vendors can adapt their driver code based on the unified APIs provided by the WLAN module.

Since:

1.0

Version:

1.0

Summary

Files

File Name

Description

hdf_netbuf.h

Declares network data buffers and provides APIs for operating buffer queues.

hdf_wifi_event.h

Declares WLAN driver events.

hdf_wifi_product.h

Declares the data structure of the WLAN module.

net_device.h

Defines WLAN network device interfaces.

wifi_inc.h

Describes the data structure of WLAN features and bus.

wifi_mac80211_ops.h

Declares Media Access Control (MAC) APIs and functions related to control flows.

wifi_module.h

Provides features of the WLAN module and functions to create and delete modules.

wifi_module_config.h

Declares the WLAN module configuration.

Data Structures

Data Structure Name

Description

NetBuf

Records and saves a network data buffer.

NetBufQueue

Indicates the queues for storing network data.

RateInfo

Defines the rate information received or sent over WLAN.

StaBssParameters

Defines parameters related to the WLAN module that works in station mode.

StaFlagUpdate

Defines the update of the Sta flag.

StationInfo

Defines station information.

Auth

Defines authentication information.

Deauth

Defines deauthentication information.

AssocReq

Defines station association request.

AssocResp

Defines station association response.

ReassocReq

Defines station reassociation request.

ReassocResp

Defines station reassociation response.

Disassoc

Defines station disconnection.

Beacon

Defines the update of the Sta flag.

ProbeResp

Defines scanning response.

Ieee80211Mgmt

Defines management frame information.

ScannedBssInfo

Represents the scanned BSS information.

ConnetResult

Defines association results.

HdfWifiProductData

Defines the WLAN module.

EtherHeader

Defines the Ethernet header information of a data frame, including the destination address, source address, and Ethernet type.

IpHeader

Defines the IP header information of a data frame, including the version number, service type, and total length.

UdpHeader

Defines the UDP header information of a data frame, including the source port number and destination port number.

TcpHeader

Defines the TCP header information of a data frame, including the source port number and destination port number.

IpV4Addr

Defines an IPv4 address.

NetDevNotify

Defines a network device notification, including an IP address and the notification type.

IfType

Defines the network port type, for example, the WLAN network port.

IfReq

Defines ioctrl data.

NetDevice

Defines a network device, including the network interface category and name, and network port type.

NetDeviceInterFace

Defines interfaces that need to be implemented externally by network devices, including initializing, opening, and closing a network device.

KeyParams

Describes a key.

Ieee80211Channel

Describes a communication channel.

Ieee80211Rate

Describes the IEEE 802.11 rate.

Ieee80211McsInfo

Describes IEEE 802.11 Modulation and Coding Scheme (MCS) information.

Ieee80211StaHtCap

Describes the IEEE 802.11 high-throughput (HT) capability.

Ieee80211SupportedBand

Describes IEEE 802.11 band information.

Wiphy

Describes a wiphy device.

WifiSsid

Describes an SSID.

ChannelDef

Describes a communication channel.

WirelessDev

Describes a wireless device.

WifiScanRequest

Describes scan request parameters.

CryptoSettings

Describes cryptography settings.

MacAddress

Describes the device MAC address.

WifiConnectParams

Describes parameters for a connection request.

VifParams

Describes virtual API parameters.

StationDelParameters

Describes parameters for canceling a connection.

MacConfigParam

Describes MAC configuration parameters.

Mac80211DisconnectParam

Describes disconnection parameters.

Mac80211Ssids

Describes SSIDs.

Mac80211beaconParam

Describes beacon parameters.

WifiMac80211Ops

Describes MAC-layer control APIs that need to be implemented by the driver.

WifiModuleIface

Defines WLAN module APIs.

WifiModule

Defines the WLAN module.

WifiFeature

Defines a WLAN feature.

WifiFeatureList

Defines the WLAN feature list.

HdfWifiChipData

Defines a WLAN chip.

WifiModuleConfig

Defines the WLAN module configuration.

Macros

Macro Name and Value

Description

MAX_NETBUF_RESEVER_SIZE   68

Defines the reserved field of a network data buffer used to store private information.

MAC_ADDR_SIZE    6

Indicates a 6-byte MAC address.

NET_DEVICE_IFF_RUNNING    IFF_RUNNING

Indicates that the network port is working.

ETHER_TYPE_RARP    0x8035

Indicates Reverse Address Resolution Protocol (RARP).

ETHER_TYPE_PAE    0x888e

Indicates Port Access Entity (PAE).

ETHER_TYPE_IP    0x0800

Indicates Internet Protocol (IP).

ETHER_TYPE_AARP    0x80f3

Indicates AppleTalk Address Resolution Protocol (AARP).

ETHER_TYPE_IPX    0x8137

Indicates Internetwork Packet Exchange (IPX).

ETHER_TYPE_ARP    0x0806

Indicates Address Resolution Protocol (ARP).

ETHER_TYPE_IPV6    0x86dd

Indicates Internet Protocol version 6 (IPv6).

ETHER_TYPE_TDLS    0x890d

Indicates Tunneled Direct Link Setup (TDLS).

ETHER_TYPE_VLAN    0x8100

Indicates Virtual Local Area Network (VLAN).

ETHER_TYPE_WAI    0x88b4

Indicates WLAN Authentication and Privacy Infrastructure (WAPI).

ETHER_LLTD_TYPE    0x88D9

Indicates Link Layer Topology Discovery (LLTD).

ETHER_ONE_X_TYPE    0x888E

Indicates 802.1x network port authentication.

ETHER_TUNNEL_TYPE    0x88bd

Indicates a tunnel protocol.

ETHER_TYPE_PPP_DISC    0x8863

Indicates the point-to-point discovery type.

ETHER_TYPE_PPP_SES    0x8864

Indicates the point-to-point session discovery type.

ETHER_TYPE_6LO    0xa0ed

Indicates IPv6 over Low Power Wireless Personal Area Networks (6LoWPANs).

TCP_PROTOCAL    6

Indicates the Transmission Control Protocol (TCP).

UDP_PROTOCAL    17

Indicates the User Datagram Protocol (UDP).

IP_PRI_SHIFT    5

Indicates the shift in the priority for an IP address.

DHCP_UDP_SRC_PORT    68

Indicates the source port number of DHCP.

DHCP_UDP_DES_PORT    67

Indicates the destination port number of DHCP.

MAX_WIFI_COMPONENT_NAME_LEN   10

Indicates the length of the name of a WLAN module or feature.

Typedefs

Typedef Name

Description

NetDevice

typedef struct NetDevice 

Defines a network device, including the network interface category and name, and network port type.

WifiConnectParams

typedef struct WifiConnectParams 

Describes parameters for a connection request.

Mac80211SetMacParam

typedef struct MacConfigParam 

Describes MAC configuration parameters.

Enumerations

Enumeration Name

Description

{ E_HEAD_BUF, E_DATA_BUF, E_TAIL_BUF, MAX_BUF_NUM }

Enumerates the segments of a network data buffer.

WifiHmacMgmtStatus {   WIFI_HMAC_MGMT_SUCCESS = 0, WIFI_HMAC_MGMT_INVALID = 1, WIFI_HMAC_MGMT_TIMEOUT = 2, WIFI_HMAC_MGMT_REFUSED = 3,   WIFI_HMAC_MGMT_TOMANY_REQ = 4, WIFI_HMAC_MGMT_ALREADY_BSS = 5 }

Enumerates MLME management statuses, indicating whether a device is successfully associated or fails to be associated.

NetIfCategory { LITE_OS, RICH_OS }

Enumerates network interface categories, including lightweight OS and rich OS.

NetIfStatus { NETIF_DOWN, NETIF_UP }

Enumerates network interface states, including online and offline.

NetIfLinkStatus { NETIF_LINK_DOWN, NETIF_LINK_UP }

Enumerates network link layer states, including online and offline.

NetLinkType { ETHERNET_LINK = 1, WIFI_LINK = 801 }

Enumerates data link types, including Ethernet and WLAN.

ProcessingResult { PROCESSING_CONTINUE, PROCESSING_COMPLETE, PROCESSING_ERROR }

Enumerates data processing results, including continuing processing, processing completed, and error.

NetDevTxResult { NETDEV_TX_OK = 0x00, NETDEV_TX_BUSY = 0x10, NETDEV_TX_LOCKED = 0x20 }

Enumerates data sending results, including sending succeeded, other data being sent at the link layer, and data link layer being locked.

Protocol80211IfType {   PROTOCOL_80211_IFTYPE_UNSPECIFIED, PROTOCOL_80211_IFTYPE_ADHOC, PROTOCOL_80211_IFTYPE_STATION, PROTOCOL_80211_IFTYPE_AP,   PROTOCOL_80211_IFTYPE_AP_VLAN, PROTOCOL_80211_IFTYPE_WDS, PROTOCOL_80211_IFTYPE_MONITOR, PROTOCOL_80211_IFTYPE_MESH_POINT,   PROTOCOL_80211_IFTYPE_P2P_CLIENT, PROTOCOL_80211_IFTYPE_P2P_GO, PROTOCOL_80211_IFTYPE_P2P_DEVICE, PROTOCOL_80211_IFTYPE_NUM,   PROTOCOL_80211_IFTYPE_MAX = PROTOCOL_80211_IFTYPE_NUM - 1 }

Enumerates 802.11 network port types, including AP, STA, and P2P.

NetdeviceError { COMMON_ERROR = 1, ADD_LWIP_ERROR }

Enumerates network device errors, including common errors and errors in adding network devices to LwIP.

WifiMainFeatureType {   HDF_WIFI_FEATURE_BASE, HDF_WIFI_FEATURE_AP, HDF_WIFI_FEATURE_STA, HDF_WIFI_FEATURE_P2P,   HDF_WIFI_FEATURE_NAN, HDF_WIFI_FEATURE_RTT, HDF_WIFI_FEATURE_NUM = 10 }

Enumerates feature types of a WLAN module.

WifiBusType { BUS_SDIO, BUS_USB }

Enumerates bus types of a WLAN module.

MacSetType { MAC_BEACON_SET = 0, MAC_BEACON_ADD = 1 }

Enumerates setting types of MAC addresses.

Ieee80211Band { IEEE80211_BAND_2GHZ, IEEE80211_BAND_5GHZ, IEEE80211_NUM_BANDS }

Enumerates frequency bands.

WifiChannelType { WIFI_CHAN_NO_HT, WIFI_CHAN_HT20, WIFI_CHAN_HT40MINUS, WIFI_CHAN_HT40PLUS }

Enumerates channel types.

Functions

Function Name

Description

NetBufQueueInit (struct NetBufQueueq)

static void 

Initializes a network data buffer queue.

NetBufQueueSize (const struct NetBufQueue q)

static uint32

Obtains the size of a network data buffer queue.

NetBufQueueIsEmpty (const struct NetBufQueueq)

static bool 

Checks whether the network data buffer queue is empty.

NetBufQueueEnqueue (struct NetBufQueue q, struct NetBufnb)

void 

Adds a network data buffer to the tail of a queue.

NetBufQueueEnqueueHead (struct NetBufQueue q, struct NetBufnb)

void 

Adds a network data buffer to the header of a queue.

NetBufQueueDequeue (struct NetBufQueue q)

struct NetBuf 

Obtains a network data buffer from the header of a queue and deletes it from the queue.

NetBufQueueDequeueTail (struct NetBufQueue q)

struct NetBuf 

Obtains a network data buffer from the tail of a queue and deletes it from the queue.

NetBufQueueAtHead (const struct NetBufQueue q)

static struct NetBuf 

Obtains the network data buffer from the header of a queue, without deleting it from the queue.

NetBufQueueAtTail (const struct NetBufQueue q)

static struct NetBuf 

Obtains the network data buffer from the tail of a queue, without deleting it from the queue.

NetBufQueueClear (struct NetBufQueue q)

void 

Clears a network data buffer queue and releases the network data buffer in the queue.

NetBufQueueConcat (struct NetBufQueueq, struct NetBufQueueadd)

void 

Moves all network data buffers from one queue to another and clears the source queue.

NetBufAlloc (uint32t size)

struct NetBuf 

Applies for a network data buffer.

NetBufFree (struct NetBuf nb)

void 

Releases a network data buffer.

NetBufDevAlloc (const struct NetDevicedev, uint32_t size)

struct NetBuf  

Applies for a network data buffer based on the reserved space and requested size set by a network device.

NetBufPush (struct NetBufnb, uint32_t id, uint32_t len)

void  

Performs operations based on the segment ID of a network data buffer. The function is opposite to that of NetBufPop.

NetBufPop (struct NetBufnb, uint32_t id, uint32_t len)

void  

Performs operations based on the segment ID of a network data buffer. The function is opposite to that of NetBufPush.

NetBufGetAddress (const struct NetBufnb, uint32_t id)

static uint8_t  

Obtains the address of a specified buffer segment in a network data buffer.

NetBufGetRoom (const struct NetBufnb, uint32_t id)

static uint32_t 

Obtains the size of a specified buffer segment space in a network data buffer.

NetBufGetDataLen (const struct NetBuf nb)

static uint32_t 

Obtains the actual data length of the data segment of a network data buffer.

NetBufResizeRoom (struct NetBufnb, uint32_t head, uint32_t tail)

int32_t 

Adjusts the size of a network data buffer space.

NetBufConcat (struct NetBuf nb, struct NetBufcnb)

uint32_t 

Copies data in a network data buffer to another network data buffer.

Pbuf2NetBuf (const struct NetDevice netdev, struct pbuf lwipBuf)

struct NetBuf  

Converts the pbuf structure of Lightweight TCP/IP Stack (lwIP) to a network data buffer.

NetBuf2Pbuf (const struct NetBufnb)

struct pbuf  

Converts a network data buffer to the pbuf structure of Lightweight TCP/IP Stack (lwIP).

HdfWifiEventNewSta (const struct NetDevicenetdev, const uint8_t macAddr, uint8_t addrLen, const struct StationInfoinfo)

int32_t 

Reports a new STA event.

HdfWifiEventDelSta (struct NetDevice netdev, const uint8_t macAddr, uint8_t addrLen)

int32_t 

Reports a station deletion event.

HdfWifiEventInformBssFrame (const struct NetDevice netdev, struct Wiphywiphy, const struct Ieee80211Channelchannel, const struct ScannedBssInfobssInfo)

int32_t 

Reports a scanned BSS event.

HdfWifiEventScanDone (const struct NetDevice netdev, WifiScanStatus status)

int32_t 

Reports a scanning completion event.

HdfWifiEventConnectResult (const struct NetDevicenetdev, const struct ConnetResultresult)

int32_t 

Reports a connection result event.

HdfWifiEventDisconnected (const struct NetDevicenetdev, uint16_t reason, const uint8_t ie, uint32_t len)

int32_t 

Reports a disconnection event.

HdfWifiEventMgmtTxStatus (const struct NetDevicenetdev, const uint8_t buf, size_t len, uint8_t ack)

int32_t 

Reports a transmission management status event.

HdfWifiEventRxMgmt (const struct NetDevicenetdev, int32_t freq, int32_t sigMbm, const uint8_t buf, size_t len)

int32_t 

Reports a receive management status event.

HdfWifiEventCsaChannelSwitch (const struct NetDevicenetdev, int32_t freq)

int32_t 

Reports a CSA channel switching event.

HdfWifiEventTimeoutDisconnected (const struct NetDevice netdev)

int32_t 

Reports a timeout disconnection event.

HdfWifiEventEapolRecv (const char name, void context)

int32_t 

Reports the event of receiving the EAPOL frame and notifies WPA to read the EAPOL frame.

HdfWifiGetProduct (void)

struct HdfWifiProductData 

Obtains the data structure of the WLAN module.

NetDeviceInit (const char ifName, uint32_t len, NetIfCategory ifCategory)

struct NetDevice 

Initializes a network device to obtain its instance.

NetDeviceDeInit (struct NetDevice netDevice)

int32_t 

Deletes a network device.

NetDeviceAdd (struct NetDevicenetDevice, Protocol80211IfType ifType)

int32_t 

Adds a network device to a protocol stack.

NetDeviceDelete (struct NetDevice netDevice)

int32_t 

Deletes a network device from a protocol stack.

NetDeviceGetInstByName (const char name)

struct NetDevice  

Obtains the initialized network device instance by a specified device name.

NetDeviceIsAnyInstRunning (void)

bool 

Checks whether there are working devices among the added network devices.

NetDeviceIsInstRunning (const struct NetDevicenetDevice)

bool 

Checks whether a specified network device is working.

NetDevGetRegisterCount (void)

uint32_t 

Obtains the number of added network devices.

NetDeviceGetCap (void)

uint32_t 

Obtains the maximum number of network devices that can be registered with this system at the same time.

NetDeviceGetInstByIndex (uint32_t index)

struct NetDevice  

Obtains a network device instance based on the index number.

NetIfSetAddr (const struct NetDevicenetDevice, const IpV4AddripAddr, const IpV4AddrnetMask, const IpV4Addrgw)

int32_t 

Sets an IP address, mask, and gateway.

NetIfSetStatus (const struct NetDevicenetDevice, NetIfStatus status)

int32_t 

Notifies the network layer of the network port state.

NetIfSetLinkStatus (const struct NetDevice netDevice, NetIfLinkStatus status)

int32_t 

Notifies the network layer of the data link layer status.

NetIfRx (const struct NetDevicenetDevice, struct NetBufbuff)

int32_t 

Transfers the input data packets from the network side to a protocol stack.

NetIfRxNi (const struct NetDevicenetDevice, struct NetBufbuff)

int32_t 

Transfers data packets from the network side to a protocol stack in an interrupt processing thread.

NetIfDhcpsStart (const struct NetDevicenetDevice, char ip, u16_t ipNum)

int32_t 

Starts the DHCP server.

NetIfDhcpsStop (const struct NetDevicenetDevice)

int32_t 

Stops the DHCP server.

NetIfDhcpStart (const struct NetDevice netDevice)

int32_t 

Starts the DHCP client of a specified network device.

NetIfDhcpStop (const struct NetDevicenetDevice)

int32_t 

Stops the DHCP client of a specified network device.

NetIfDhcpIsBound (const struct NetDevice netDevice)

int32_t 

Obtains the DHCP negotiation status of a specified network device.

Mac80211RegisterOps (struct WifiMac80211Ops *ops) __attribute((weak))

int32_t 

Registers a WifiMac80211Ops object.

Mac80211GetOps (void)

struct WifiMac80211Ops 

Obtains the WifiMac80211Ops object that the driver needs to implement.

WifiModuleCreate (const struct HdfConfigWifiModuleConfig config)

struct WifiModule 

Creates a WifiModule object based on a specified configuration generated by the HCS.

WifiModuleDelete (struct WifiModule module)

void 

Deletes a specified WifiModule object.

DelFeature (struct WifiModulemodule, uint16_t featureType)

int32_t 

Deletes a specified feature from a specified module.

AddFeature (struct WifiModule module, uint16_t featureType, struct WifiFeature *featureData)

int32_t 

Adds a specified feature to a specified module.

Details

Macro Definition Documentation

MAX_NETBUF_RESEVER_SIZE

  1. #define MAX_NETBUF_RESEVER_SIZE 68

Description:

Defines the reserved field of a network data buffer used to store private information.

The length of the reserved field is 68 bytes.

MAX_WIFI_COMPONENT_NAME_LEN

  1. #define MAX_WIFI_COMPONENT_NAME_LEN 10

Description:

Indicates the length of the name of a WLAN module or feature.

The name of a WLAN module or feature cannot contain more than 10 characters; otherwise, the name will be truncated and cannot be identified.

Typedef Documentation

Mac80211SetMacParam

  1. typedefstruct[MacConfigParam]($api-api-SmartVision-Devices-MacConfigParam.md)[Mac80211SetMacParam]($api-api-SmartVision-Devices-WLAN.md#ga85f7d8a3795887f090e0a6439b1df6e1)

Description:

Describes MAC configuration parameters.

NetDevice

  1. typedefstruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)

Description:

Defines a network device, including the network interface category and name, and network port type.

WifiConnectParams

  1. typedefstruct[WifiConnectParams]($api-api-SmartVision-Devices-WifiConnectParams.md)[WifiConnectParams]($api-api-SmartVision-Devices-WifiConnectParams.md)

Description:

Describes parameters for a connection request.

Enumeration Type Documentation

anonymous enum

  1. anonymous enum

Description:

Enumerates the segments of a network data buffer.

The entire network data buffer is divided into three segments: a header, data, and a tail. The header and tail are used to extend both ends of the data segment.

Enumerator

Description

E_HEAD_BUF 

Header buffer segment

E_DATA_BUF 

Data segment

E_TAIL_BUF 

Tail buffer segment

MAX_BUF_NUM 

Maximum number of buffer segments

Ieee80211Band

  1. enum[Ieee80211Band]($api-api-SmartVision-Devices-WLAN.md#ga9882f415202cf9acb0f4cdfbc456a88d)

Description:

Enumerates frequency bands.

Enumerator

Description

IEEE80211_BAND_2GHZ 

2.4 GHz

IEEE80211_BAND_5GHZ 

5 GHz

IEEE80211_NUM_BANDS 

Reserved

MacSetType

  1. enum[MacSetType]($api-api-SmartVision-Devices-WLAN.md#ga75cba3dc6ab4c5dc5653b037433b3abf)

Description:

Enumerates setting types of MAC addresses.

Enumerator

Description

MAC_BEACON_SET 

Setting a beacon MAC address

MAC_BEACON_ADD 

Adding a beacon MAC address

NetdeviceError

  1. enum[NetdeviceError]($api-api-SmartVision-Devices-WLAN.md#ga9023c5dc1cc43758cbb468d78af41c2d)

Description:

Enumerates network device errors, including common errors and errors in adding network devices to LwIP.

Enumerator

Description

COMMON_ERROR 

Common errors

ADD_LWIP_ERROR 

Errors in adding network devices to LwIP

NetDevTxResult

  1. enum[NetDevTxResult]($api-api-SmartVision-Devices-WLAN.md#ga9fb4e578a15db1b0087d7b3831591ced)

Description:

Enumerates data sending results, including sending succeeded, other data being sent at the link layer, and data link layer being locked.

Enumerator

Description

NETDEV_TX_OK 

Sending succeeded

NETDEV_TX_BUSY 

Other data being sent at the link layer

NETDEV_TX_LOCKED 

Data link layer being locked

NetIfCategory

  1. enum[NetIfCategory]($api-api-SmartVision-Devices-WLAN.md#ga530241881cd17e03f8ae254ef1d9755e)

Description:

Enumerates network interface categories, including lightweight OS and rich OS.

Enumerator

Description

LITE_OS 

Lightweight OS

RICH_OS 

Rich OS

NetIfLinkStatus

  1. enum[NetIfLinkStatus]($api-api-SmartVision-Devices-WLAN.md#ga7b1187d116fb065d7927ad9f77edd842)

Description:

Enumerates network link layer states, including online and offline.

Enumerator

Description

NETIF_LINK_DOWN 

Data link offline

NETIF_LINK_UP 

Data link online

NetIfStatus

  1. enum[NetIfStatus]($api-api-SmartVision-Devices-WLAN.md#ga0fb482694e5eac3f48c75de1749c8baf)

Description:

Enumerates network interface states, including online and offline.

Enumerator

Description

NETIF_DOWN 

Network interface offline

NETIF_UP 

Network interface online

NetLinkType

  1. enum[NetLinkType]($api-api-SmartVision-Devices-WLAN.md#gad3175955d2e6ef3c4f52da9b509d5b4a)

Description:

Enumerates data link types, including Ethernet and WLAN.

Enumerator

Description

ETHERNET_LINK 

Ethernet

WIFI_LINK 

WLAN

ProcessingResult

  1. enum[ProcessingResult]($api-api-SmartVision-Devices-WLAN.md#ga9c1d6e7df4468671742cb76f72b67af1)

Description:

Enumerates data processing results, including continuing processing, processing completed, and error.

Enumerator

Description

PROCESSING_CONTINUE 

Continuing processing

PROCESSING_COMPLETE 

Processing completed

PROCESSING_ERROR 

Error

Protocol80211IfType

  1. enum[Protocol80211IfType]($api-api-SmartVision-Devices-WLAN.md#gac69954f56fcc99fc8aac68aa157831c7)

Description:

Enumerates 802.11 network port types, including AP, STA, and P2P.

Enumerator

Description

PROTOCOL_80211_IFTYPE_UNSPECIFIED 

Unspecified

PROTOCOL_80211_IFTYPE_ADHOC 

Ad hoc network

PROTOCOL_80211_IFTYPE_STATION 

Workstation

PROTOCOL_80211_IFTYPE_AP 

Access point

PROTOCOL_80211_IFTYPE_AP_VLAN 

Virtual access point

PROTOCOL_80211_IFTYPE_WDS 

Wireless distributed system

PROTOCOL_80211_IFTYPE_MONITOR 

Listening

PROTOCOL_80211_IFTYPE_MESH_POINT 

Mesh network

PROTOCOL_80211_IFTYPE_P2P_CLIENT 

P2P client

PROTOCOL_80211_IFTYPE_P2P_GO 

P2P group owner

PROTOCOL_80211_IFTYPE_P2P_DEVICE 

P2P device

PROTOCOL_80211_IFTYPE_NUM 

Number of network ports

PROTOCOL_80211_IFTYPE_MAX 

Maximum number of 802.11 network port types

WifiBusType

  1. enum[WifiBusType]($api-api-SmartVision-Devices-WLAN.md#ga1c5537e64f05b5e91b951ddeb66d4261)

Description:

Enumerates bus types of a WLAN module.

Enumerator

Description

BUS_SDIO 

Secure Digital Input and Output (SDIO)

BUS_USB 

Universal Serial Bus (USB)

WifiChannelType

  1. enum[WifiChannelType]($api-api-SmartVision-Devices-WLAN.md#ga9d902b330de99c24b2a8c3ba7120af21)

Description:

Enumerates channel types.

Enumerator

Description

WIFI_CHAN_NO_HT 

non-HT channel

WIFI_CHAN_HT20 

20 MHz HT channel

WIFI_CHAN_HT40MINUS 

40 MHz minus HT channel (The channel is formed by two 20 MHz HT channels, one as the main channel and the other as the auxiliary channel. The center frequency of the main channel is lower than that of the auxiliary channel.)

WIFI_CHAN_HT40PLUS 

40 MHz plus HT channel (The channel is formed by two 20 MHz HT channels, one as the main channel and the other as the auxiliary channel. The center frequency of the main channel is higher than that of the auxiliary channel.)

WifiHmacMgmtStatus

  1. enum[WifiHmacMgmtStatus]($api-api-SmartVision-Devices-WLAN.md#gaf3e873b51f0cfa077aca9d33ed7a0960)

Description:

Enumerates MLME management statuses, indicating whether a device is successfully associated or fails to be associated.

Enumerator

Description

WIFI_HMAC_MGMT_SUCCESS 

Association succeeds

WIFI_HMAC_MGMT_INVALID 

Association fails

WIFI_HMAC_MGMT_TIMEOUT 

Association timeout

WIFI_HMAC_MGMT_REFUSED 

Association refused

WIFI_HMAC_MGMT_TOMANY_REQ 

Repeated association request

WIFI_HMAC_MGMT_ALREADY_BSS 

Associated with the BSS

WifiMainFeatureType

  1. enum[WifiMainFeatureType]($api-api-SmartVision-Devices-WLAN.md#gaec03ba36d71cc2d5f3209bc24aa6ee10)

Description:

Enumerates feature types of a WLAN module.

You can query and register a feature or bind a feature to a WLAN module based on the feature type.

Enumerator

Description

HDF_WIFI_FEATURE_BASE 

Base feature

HDF_WIFI_FEATURE_AP 

AP

HDF_WIFI_FEATURE_STA 

Station

HDF_WIFI_FEATURE_P2P 

Peer-to-peer (P2P)

HDF_WIFI_FEATURE_NAN 

Neighbor Awareness Networking (NAN)

HDF_WIFI_FEATURE_RTT 

Round Trip Time (RTT)

HDF_WIFI_FEATURE_NUM 

Maximum number of features

Function Documentation

AddFeature()

  1. int32_tAddFeature(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module,uint16_t featureType,struct[WifiFeature]($api-api-SmartVision-Devices-WifiFeature.md)* featureData )

Description:

Adds a specified feature to a specified module.

Parameters:

Name

Description

moduleIndicates the pointer to the module.
featureTypeIndicates the type of the feature to add.
featureDataIndicates the pointer to the feature to add.

Returns:

Returns 0 if the feature is added successfully; returns a negative value otherwise.

DelFeature()

  1. int32_tDelFeature(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module,uint16_t featureType )

Description:

Deletes a specified feature from a specified module.

Parameters:

Name

Description

moduleIndicates the pointer to the module.
featureTypeIndicates the type of the feature to delete.

Returns:

Returns 0 if the feature is deleted successfully; returns -1 otherwise.

HdfWifiEventConnectResult()

  1. int32_tHdfWifiEventConnectResult(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,conststruct[ConnetResult]($api-api-SmartVision-Devices-ConnetResult.md)* result )

Description:

Reports a connection result event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
resultIndicates the pointer to the connection result. This parameter cannot be null.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventCsaChannelSwitch()

  1. int32_tHdfWifiEventCsaChannelSwitch(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,int32_t freq )

Description:

Reports a CSA channel switching event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
freqIndicates the frequency of the channel.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventDelSta()

  1. int32_tHdfWifiEventDelSta(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,constuint8_t* macAddr,uint8_t addrLen )

Description:

Reports a station deletion event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
macAddrIndicates the pointer to the MAC address of the station. This parameter cannot be null.
addrLenIndicates the length of the MAC address of the station. The length is fixed to six bytes.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventDisconnected()

  1. int32_tHdfWifiEventDisconnected(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,uint16_t reason,constuint8_t* ie,uint32_t len )

Description:

Reports a disconnection event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
reasonIndicates the reason for disconnection.
ieIndicates the pointer to the deauth/disassoc frame IE.
ieLenIndicates the length of the deauth/disassoc IE.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventEapolRecv()

  1. int32_tHdfWifiEventEapolRecv(constchar* name,void* context )

Description:

Reports the event of receiving the EAPOL frame and notifies WPA to read the EAPOL frame.

Parameters:

Name

Description

nameIndicates the pointer to the network port name, for example, wlan0.
contextIndicates the pointer to the context. This parameter is reserved.

Returns:

Returns 0 if the operation is successful; returns -1 otherwise.

HdfWifiEventInformBssFrame()

  1. int32_tHdfWifiEventInformBssFrame(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,struct[Wiphy]($api-api-SmartVision-Devices-Wiphy.md)* wiphy,conststruct[Ieee80211Channel]($api-api-SmartVision-Devices-Ieee80211Channel.md)* channel,conststruct[ScannedBssInfo]($api-api-SmartVision-Devices-ScannedBssInfo.md)* bssInfo )

Description:

Reports a scanned BSS event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
wiphyIndicates the pointer to the physical layer of the wireless network. This parameter cannot be null.
channelIndicates the pointer to the channel information. This parameter cannot be null.
bssInfoIndicates the pointer to the BSS information. This parameter cannot be null.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventMgmtTxStatus()

  1. int32_tHdfWifiEventMgmtTxStatus(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,constuint8_t* buf,size_t len,uint8_t ack )

Description:

Reports a transmission management status event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
bufIndicates the pointer to the transmission management frame. This parameter cannot be null.
lenIndicates the length of the transmission management frame.
ackIndicates whether the transmission management frame is acknowledged.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventNewSta()

  1. int32_tHdfWifiEventNewSta(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,constuint8_t* macAddr,uint8_t addrLen,conststruct[StationInfo]($api-api-SmartVision-Devices-StationInfo.md)* info )

Description:

Reports a new STA event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
macAddrIndicates the pointer to the MAC address of the station. This parameter cannot be null.
addrLenIndicates the length of the MAC address of the station. The length is fixed to six bytes.
infoIndicates the pointer to the station information.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventRxMgmt()

  1. int32_tHdfWifiEventRxMgmt(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,int32_t freq,int32_t sigMbm,constuint8_t* buf,size_t len )

Description:

Reports a receive management status event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
freqIndicates the frequency of receiving management frame.
sigMbmIndicates the signal strength (in dBm).
bufIndicates the pointer to the receive management frame. This parameter cannot be null.
lenIndicates the length of the receive management frame.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventScanDone()

  1. int32_tHdfWifiEventScanDone(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,WifiScanStatus status )

Description:

Reports a scanning completion event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.
statusIndicates the scanning completion status. Value 0 indicates that the scanning is successful, and other values indicate that the scanning fails.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiEventTimeoutDisconnected()

  1. int32_tHdfWifiEventTimeoutDisconnected(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev)

Description:

Reports a timeout disconnection event.

Parameters:

Name

Description

netdevIndicates the pointer to the network device. This parameter cannot be null.

Returns:

Returns 0 if the event is reported successfully; returns -1 otherwise.

HdfWifiGetProduct()

  1. struct[HdfWifiProductData]($api-api-SmartVision-Devices-HdfWifiProductData.md)*HdfWifiGetProduct(void)

Description:

Obtains the data structure of the WLAN module.

Returns:

Returns the pointer to the data structure of the WLAN module. For details, see HdfWifiProductData.

Mac80211GetOps()

  1. struct[WifiMac80211Ops]($api-api-SmartVision-Devices-WifiMac80211Ops.md)*Mac80211GetOps(void)

Description:

Obtains the WifiMac80211Ops object that the driver needs to implement.

Returns:

Returns the pointer to the WifiMac80211Ops object.

Mac80211RegisterOps()

  1. int32_tMac80211RegisterOps(struct[WifiMac80211Ops]($api-api-SmartVision-Devices-WifiMac80211Ops.md)* ops)

Description:

Registers a WifiMac80211Ops object.

Parameters:

Name

Description

opsIndicates the pointer to the WifiMac80211Ops object to register.

Returns:

Returns 0 if the WifiMac80211Ops object is registered successfully; returns a non-zero value otherwise.

NetBuf2Pbuf()

  1. struct pbuf*NetBuf2Pbuf(conststruct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb)

Description:

Converts a network data buffer to the pbuf structure of Lightweight TCP/IP Stack (lwIP).

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.

Returns:

Returns the pointer to the pbuf structure if the operation is successful; returns NULL otherwise.

NetBufAlloc()

  1. struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*NetBufAlloc(uint32_t size)

Description:

Applies for a network data buffer.

Parameters:

Name

Description

sizeIndicates the size of the network data buffer.

Returns:

Returns the pointer to the network data buffer if the operation is successful; returns NULL otherwise.

NetBufConcat()

  1. uint32_tNetBufConcat(struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb,struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* cnb )

Description:

Copies data in a network data buffer to another network data buffer.

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.
cnbIndicates the pointer to the target network data buffer.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetBufDevAlloc()

  1. struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*NetBufDevAlloc(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* dev,uint32_t size )

Description:

Applies for a network data buffer based on the reserved space and requested size set by a network device.

Parameters:

Name

Description

devIndicates the pointer to the network device.
sizeIndicates the size of the network data buffer applied.

Returns:

Returns the pointer to the network data buffer if the operation is successful; returns NULL otherwise.

NetBufFree()

  1. voidNetBufFree(struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb)

Description:

Releases a network data buffer.

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.

NetBufGetAddress()

  1. staticuint8_t*NetBufGetAddress(conststruct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb,uint32_t id )

Description:

Obtains the address of a specified buffer segment in a network data buffer.

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.
idIndicates the buffer segment ID.

Returns:

Returns the address of the specified buffer segment if the operation is successful; returns NULL if the buffer segment ID is invalid.

NetBufGetDataLen()

  1. staticuint32_tNetBufGetDataLen(conststruct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb)

Description:

Obtains the actual data length of the data segment of a network data buffer.

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.

Returns:

Returns the actual data length of the data segment.

NetBufGetRoom()

  1. staticuint32_tNetBufGetRoom(conststruct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb,uint32_t id )

Description:

Obtains the size of a specified buffer segment space in a network data buffer.

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.
idIndicates the buffer segment ID.

Returns:

Returns the size of the specified buffer segment space if the operation is successful; returns NULL if the buffer segment ID is invalid.

NetBufPop()

  1. void*NetBufPop(struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb,uint32_t id,uint32_t len )

Description:

Performs operations based on the segment ID of a network data buffer. The function is opposite to that of NetBufPush.

Description:

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.
idIndicates the buffer segment ID.
lenIndicates the operation length.

Returns:

Returns the start address of the data segment if the operation is successful; returns NULL if the operation length exceeds the space of a specified buffer segment.

NetBufPush()

  1. void*NetBufPush(struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb,uint32_t id,uint32_t len )

Description:

Performs operations based on the segment ID of a network data buffer. The function is opposite to that of NetBufPop.

Description:

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.
idIndicates the buffer segment ID.
lenIndicates the operation length.

Returns:

Returns the start address of the data segment if the operation is successful; returns NULL if the operation length exceeds the space of a specified buffer segment.

NetBufQueueAtHead()

  1. staticstruct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*NetBufQueueAtHead(conststruct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Obtains the network data buffer from the header of a queue, without deleting it from the queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

Returns:

Returns the pointer to the first network data buffer if the queue is not empty; returns NULL otherwise.

NetBufQueueAtTail()

  1. staticstruct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*NetBufQueueAtTail(conststruct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Obtains the network data buffer from the tail of a queue, without deleting it from the queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

Returns:

Returns the pointer to the last network data buffer if the queue is not empty; returns NULL otherwise.

NetBufQueueClear()

  1. voidNetBufQueueClear(struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Clears a network data buffer queue and releases the network data buffer in the queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

NetBufQueueConcat()

  1. voidNetBufQueueConcat(struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q,struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* add )

Description:

Moves all network data buffers from one queue to another and clears the source queue.

Parameters:

Name

Description

qIndicates the pointer to the target network data buffer queue.
addIndicates the pointer to the source network data buffer queue.

NetBufQueueDequeue()

  1. struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*NetBufQueueDequeue(struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Obtains a network data buffer from the header of a queue and deletes it from the queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

Returns:

Returns the pointer to the first network data buffer if the queue is not empty; returns NULL otherwise.

NetBufQueueDequeueTail()

  1. struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*NetBufQueueDequeueTail(struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Obtains a network data buffer from the tail of a queue and deletes it from the queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

Returns:

Returns the pointer to the last network data buffer if the queue is not empty; returns NULL otherwise.

NetBufQueueEnqueue()

  1. voidNetBufQueueEnqueue(struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q,struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb )

Description:

Adds a network data buffer to the tail of a queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.
nbIndicates the pointer to the network data buffer.

NetBufQueueEnqueueHead()

  1. voidNetBufQueueEnqueueHead(struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q,struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb )

Description:

Adds a network data buffer to the header of a queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.
nbIndicates the pointer to the network data buffer.

NetBufQueueInit()

  1. staticvoidNetBufQueueInit(struct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Initializes a network data buffer queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

NetBufQueueIsEmpty()

  1. staticboolNetBufQueueIsEmpty(conststruct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Checks whether the network data buffer queue is empty.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

Returns:

Returns true if the queue is empty; returns false otherwise.

NetBufQueueSize()

  1. staticuint32_tNetBufQueueSize(conststruct[NetBufQueue]($api-api-SmartVision-Devices-NetBufQueue.md)* q)

Description:

Obtains the size of a network data buffer queue.

Parameters:

Name

Description

qIndicates the pointer to the network data buffer queue.

Returns:

Returns the size of the network data buffer queue.

NetBufResizeRoom()

  1. int32_tNetBufResizeRoom(struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* nb,uint32_t head,uint32_t tail )

Description:

Adjusts the size of a network data buffer space.

This function is used to apply for a new network data buffer based on the configured reserved space and the size of the source network data buffer, and copy the actual data to the new network data buffer.

Parameters:

Name

Description

nbIndicates the pointer to the network data buffer.
headIndicates the size of the header buffer segment reserved.
tailIndicates the size of the tail buffer segment reserved.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetDevGetRegisterCount()

  1. uint32_tNetDevGetRegisterCount(void)

Description:

Obtains the number of added network devices.

Returns:

Returns the number of added network devices.

NetDeviceAdd()

  1. int32_tNetDeviceAdd(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice,[Protocol80211IfType]($api-api-SmartVision-Devices-WLAN.md#gac69954f56fcc99fc8aac68aa157831c7) ifType )

Description:

Adds a network device to a protocol stack.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device structure obtained during initialization.
netDeviceIndicates the network port type, as enumerated in Protocol80211IfType.

Returns:

Returns 0 if the operation is successful; returns a negative value representing HDF_STATUS if the operation fails.

NetDeviceDeInit()

  1. int32_tNetDeviceDeInit(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice)

Description:

Deletes a network device.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device structure obtained during initialization.

Returns:

Returns 0 if the operation is successful; returns a negative value representing HDF_STATUS if the operation fails.

NetDeviceDelete()

  1. int32_tNetDeviceDelete(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice)

Description:

Deletes a network device from a protocol stack.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device structure netDevice obtained during initialization.

Returns:

Returns 0 if the operation is successful; returns a negative value representing HDF_STATUS if the operation fails.

NetDeviceGetCap()

  1. uint32_tNetDeviceGetCap(void)

Description:

Obtains the maximum number of network devices that can be registered with this system at the same time.

Returns:

Returns the maximum number of network devices.

NetDeviceGetInstByIndex()

  1. struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*NetDeviceGetInstByIndex(uint32_t index)

Description:

Obtains a network device instance based on the index number.

Parameters:

Name

Description

indexIndicates the index number.

Returns:

Returns the network device structure NetDevice if the operation is successful; returns NULL if the operation fails.

NetDeviceGetInstByName()

  1. struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*NetDeviceGetInstByName(constchar* name)

Description:

Obtains the initialized network device instance by a specified device name.

Parameters:

Name

Description

nameIndicates the pointer to the network device name.

Returns:

Returns the network device structure NetDevice matching the network device name if the operation is successful; returns NULL if the operation fails.

NetDeviceInit()

  1. struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*NetDeviceInit(constchar* ifName,uint32_t len,[NetIfCategory]($api-api-SmartVision-Devices-WLAN.md#ga530241881cd17e03f8ae254ef1d9755e) ifCategory )

Description:

Initializes a network device to obtain its instance.

Parameters:

Name

Description

ifNameIndicates the pointer to the network device name.
lenIndicates the length of the network device name.
ifCategoryIndicates the network port category.

Returns:

Returns the structure NetDevice for the initialized network device if the operation is successful; returns NULL if the operation fails.

NetDeviceIsAnyInstRunning()

  1. boolNetDeviceIsAnyInstRunning(void)

Description:

Checks whether there are working devices among the added network devices.

Returns:

Returns true if the added network devices are working; returns false if none of the added network devices is working.

NetDeviceIsInstRunning()

  1. boolNetDeviceIsInstRunning(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice)

Description:

Checks whether a specified network device is working.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device structure netDevice obtained during initialization.

Returns:

Returns true if the specified network device is working; returns false otherwise.

NetIfDhcpIsBound()

  1. int32_tNetIfDhcpIsBound(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice)

Description:

Obtains the DHCP negotiation status of a specified network device.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device obtained during initialization.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfDhcpsStart()

  1. int32_tNetIfDhcpsStart(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice,char* ip,u16_t ipNum )

Description:

Starts the DHCP server.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device structure netDevice obtained during initialization.
beginIpIndicates the IP address to start.
ipNumIndicates the number of IP addresses.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfDhcpsStop()

  1. int32_tNetIfDhcpsStop(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice)

Description:

Stops the DHCP server.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device structure netDevice obtained during initialization.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfDhcpStart()

  1. int32_tNetIfDhcpStart(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice)

Description:

Starts the DHCP client of a specified network device.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device obtained during initialization.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfDhcpStop()

  1. int32_tNetIfDhcpStop(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice)

Description:

Stops the DHCP client of a specified network device.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device obtained during initialization.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfRx()

  1. int32_tNetIfRx(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice,struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* buff )

Description:

Transfers the input data packets from the network side to a protocol stack.

Parameters:

Name

Description

buffIndicates the network-side data, in Ether format.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfRxNi()

  1. int32_tNetIfRxNi(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice,struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)* buff )

Description:

Transfers data packets from the network side to a protocol stack in an interrupt processing thread.

Parameters:

Name

Description

buffIndicates the network-side data, in Ether format.

Returns:

Returns 0 if the operation is successful; returns a non-zero value HDF_STATUS if the operation fails.

NetIfSetAddr()

  1. int32_tNetIfSetAddr(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice,const[IpV4Addr]($api-api-SmartVision-Devices-IpV4Addr.md)* ipAddr,const[IpV4Addr]($api-api-SmartVision-Devices-IpV4Addr.md)* netMask,const[IpV4Addr]($api-api-SmartVision-Devices-IpV4Addr.md)* gw )

Description:

Sets an IP address, mask, and gateway.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device structure netDevice obtained during initialization.
ipAddrIndicates the IP address to set.
netMaskIndicates the mask to set.
gwIndicates the gateway to set.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfSetLinkStatus()

  1. int32_tNetIfSetLinkStatus(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice,[NetIfLinkStatus]($api-api-SmartVision-Devices-WLAN.md#ga7b1187d116fb065d7927ad9f77edd842) status )

Description:

Notifies the network layer of the data link layer status.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device obtained during initialization.
statusstatus Indicates the data link layer status, as enumerated in NetIfLinkSatus.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

NetIfSetStatus()

  1. int32_tNetIfSetStatus(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netDevice,[NetIfStatus]($api-api-SmartVision-Devices-WLAN.md#ga0fb482694e5eac3f48c75de1749c8baf) status )

Description:

Notifies the network layer of the network port state.

Parameters:

Name

Description

netDeviceIndicates the pointer to the network device obtained during initialization. @paramstatus Indicates the network port state, as enumerated in NetIfSatus.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

Pbuf2NetBuf()

  1. struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*Pbuf2NetBuf(conststruct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)* netdev,struct pbuf * lwipBuf )

Description:

Converts the pbuf structure of Lightweight TCP/IP Stack (lwIP) to a network data buffer.

When a network device is specified, the reserved space of the network device will be added to the size of the converted network data buffer.

Parameters:

Name

Description

netdevIndicates the pointer to the network device.
lwip_bufIndicates the pointer to the data buffer of lwIP.

Returns:

Returns the pointer to the network data buffer if the operation is successful; returns NULL otherwise.

WifiModuleCreate()

  1. struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*WifiModuleCreate(conststructHdfConfigWifiModuleConfig* config)

Description:

Creates a WifiModule object based on a specified configuration generated by the HCS.

Parameters:

Name

Description

configIndicates the pointer to the configuration generated by the HCS.

Returns:

Returns the created WifiModule object.

WifiModuleDelete()

  1. voidWifiModuleDelete(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module)

Description:

Deletes a specified WifiModule object.

Parameters:

Name

Description

moduleIndicates the pointer to the WifiModule object to delete.

Variable Documentation

aborted

  1. uint8_tWifiScanRequest::aborted

Description:

Whether to abort the scan

abortScan

  1. int32_t(*WifiMac80211Ops::abortScan)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Stopping a scan

ackNum

  1. uint32_tTcpHeader::ackNum

Description:

Acknowledgement number

addFeature

  1. int32_t(*WifiModuleIface::addFeature)(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module,uint16_t featureType,struct[WifiFeature]($api-api-SmartVision-Devices-WifiFeature.md)*featureData)

Description:

Adding a feature

addKey

  1. int32_t(*WifiMac80211Ops::addKey)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netdev,uint8_t keyIndex,bool pairwise,constuint8_t*macAddr,struct[KeyParams]($api-api-SmartVision-Devices-KeyParams.md)*params)

Description:

Adding a key with specified parameters

addr [1/2]

  1. uint8_tMacAddress::addr[ETH_ADDR_LEN]

Description:

Device MAC address

addr [2/2]

  1. uint32_tIpV4Addr::addr

Description:

IPv4 address

addrLen

  1. uint8_tNetDevice::addrLen

Description:

MAC address length

addrMask

  1. uint8_tWiphy::addrMask[WLAN_MAC_ADDR_LEN]

Description:

MAC address mask of the wiphy device. If the device supports multiple virtual MAC addresses, the bit whose value is 1 in the mask represents a variable part of the MAC address.

aid [1/2]

  1. uint16_tAssocResp::aid

Description:

Authentication ID

aid [2/2]

  1. uint16_tReassocResp::aid

Description:

Authentication ID

akmSuites

  1. uint32_tCryptoSettings::akmSuites[NL80211_MAX_NR_AKM_SUITES]

Description:

AKM suite data. For details, see NL80211_MAX_NR_AKM_SUITES.

ampduDensity

  1. uint8_tIeee80211StaHtCap::ampduDensity

Description:

Minimum MPDU start spacing

ampduFactor

  1. uint8_tIeee80211StaHtCap::ampduFactor

Description:

Maximum length of an aggregated MAC Protocol Data Unit (A-MPDU)

arry

  1. uint8_tScannedBssInfo::arry[2]

Description:

Reserved

assocReq [1/2]

  1. struct[AssocReq]($api-api-SmartVision-Devices-AssocReq.md)Ieee80211Mgmt::assocReq

Description:

Association request

assocReq [2/2]

  1. struct{...}::assocReq

Description:

Association request

assocReqIes

  1. constuint8_t*StationInfo::assocReqIes

Description:

Information Elements (IEs) in Association Request

assocReqIesLen

  1. uint32_tStationInfo::assocReqIesLen

Description:

IE length in Association Request

assocResp [1/2]

  1. struct[AssocResp]($api-api-SmartVision-Devices-AssocResp.md)Ieee80211Mgmt::assocResp

Description:

Association response

assocResp [2/2]

  1. struct{...}::assocResp

Description:

Association response

aucArry

  1. uint8_tMac80211Ssids::aucArry[MAC80211_SSIDS_AUC_SIZE]

Description:

AuC data array

aucResv

  1. uint8_tWifiConnectParams::aucResv[WIFI_CONNECT_PARM_RESV_SIZE]

Description:

Reserved field

aucRsv [1/2]

  1. uint8_tIeee80211StaHtCap::aucRsv[IEEE80211_STAHTCAP_RESV]

Description:

Reserved field

aucRsv [2/2]

  1. uint8_tWiphy::aucRsv[WIPHY_RSV_SIZE]

Description:

Manual alignment of data structures

aucSsid

  1. uint8_tMac80211Ssids::aucSsid[OAL_IEEE80211_MAX_SSID_LEN]

Description:

SSID array

auth [1/2]

  1. struct{...}::auth

Description:

Authentication Information

auth [2/2]

  1. struct[Auth]($api-api-SmartVision-Devices-Auth.md)Ieee80211Mgmt::auth

Description:

Authentication Information

authAlg

  1. uint16_tAuth::authAlg

Description:

Authentication algorithm

authTransaction

  1. uint16_tAuth::authTransaction

Description:

Authentication transaction

authType

  1. uint8_tWifiConnectParams::authType

Description:

Authorization type

band [1/2]

  1. enum[Ieee80211Band]($api-api-SmartVision-Devices-WLAN.md#ga9882f415202cf9acb0f4cdfbc456a88d) Ieee80211Channel::band

Description:

Frequency band, either 2.4 GHz or 5 GHz

band [2/2]

  1. enum[Ieee80211Band]($api-api-SmartVision-Devices-WLAN.md#ga9882f415202cf9acb0f4cdfbc456a88d) Ieee80211SupportedBand::band

Description:

Band matching this data structure description

bands

  1. struct[Ieee80211SupportedBand]($api-api-SmartVision-Devices-Ieee80211SupportedBand.md)*Wiphy::bands[[IEEE80211_NUM_BANDS]($api-api-SmartVision-Devices-WLAN.md#gga9882f415202cf9acb0f4cdfbc456a88da703cf67d516a80d6dae1b1995017b9a4)]

Description:

Supported bands

beacon [1/2]

  1. struct[Beacon]($api-api-SmartVision-Devices-Beacon.md)Ieee80211Mgmt::beacon

Description:

Beacon frame

beacon [2/2]

  1. struct{...}::beacon

Description:

Beacon frame

beaconData

  1. WifiBeaconData*Mac80211beaconParam::beaconData

Description:

Beacon frame data

beaconFound

  1. int8_tIeee80211Channel::beaconFound

Description:

When a beacon frame is found in this channel

beaconInt [1/2]

  1. uint16_tBeacon::beaconInt

Description:

Beacon interval

beaconInt [2/2]

  1. uint16_tProbeResp::beaconInt

Description:

Beacon interval

beaconInterval

  1. uint16_tStaBssParameters::beaconInterval

Description:

Beacon interval

beaconLossCount

  1. uint32_tStationInfo::beaconLossCount

Description:

Number of beacon loss events triggered

bitrate

  1. uint16_tIeee80211Rate::bitrate

Description:

Bit rate, in 100 kbit/s

bitrates

  1. struct[Ieee80211Rate]($api-api-SmartVision-Devices-Ieee80211Rate.md)*Ieee80211SupportedBand::bitrates

Description:

An array of supported bit rates

bssid [1/3]

  1. uint8_tIeee80211Mgmt::bssid[6]

Description:

BSS ID

bssid [2/3]

  1. uint8_tConnetResult::bssid[ETH_ADDR_LEN]

Description:

MAC address of the AP associated with the station

bssid [3/3]

  1. uint8_t*WifiConnectParams::bssid

Description:

AP basic service set identifier (BSSID). If this parameter is not specified, the AP BSSID is automatically obtained from the scan result.

bssParam

  1. struct[StaBssParameters]($api-api-SmartVision-Devices-StaBssParameters.md)StationInfo::bssParam

Description:

Current BSS parameters

bufs

  1. structBufFieldNetBuf::bufs[[MAX_BUF_NUM]($api-api-SmartVision-Devices-WLAN.md#ggae4d5251432e1a9e6803c0240cc492e18aeef2a730ef9f722cfbac0b24998f8e19)]

Description:

Defines buffer segments used to record the offset address (based on the memory buffer address) and length of each buffer segment, including the header buffer segment, data segment, and tail buffer segment. For details, see MAX_BUF_NUM.

cap

  1. uint16_tIeee80211StaHtCap::cap

Description:

HT capability table provided in 802.11n

capabInfo [1/6]

  1. uint16_tAssocReq::capabInfo

Description:

WLAN capability information

capabInfo [2/6]

  1. uint16_tAssocResp::capabInfo

Description:

WLAN capability information

capabInfo [3/6]

  1. uint16_tReassocReq::capabInfo

Description:

WLAN capability information

capabInfo [4/6]

  1. uint16_tReassocResp::capabInfo

Description:

WLAN capability information

capabInfo [5/6]

  1. uint16_tBeacon::capabInfo

Description:

WLAN capability information

capabInfo [6/6]

  1. uint16_tProbeResp::capabInfo

Description:

WLAN capability information

centerFreq

  1. uint16_tIeee80211Channel::centerFreq

Description:

Center frequency

centerFreq1

  1. int32_tChannelDef::centerFreq1

Description:

Center frequency 1

centerFreq2

  1. int32_tChannelDef::centerFreq2

Description:

Center frequency 2

chan

  1. struct[Ieee80211Channel]($api-api-SmartVision-Devices-Ieee80211Channel.md)*ChannelDef::chan

Description:

Channel information

changeBeacon

  1. int32_t(*WifiMac80211Ops::changeBeacon)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,[Mac80211beaconParam]($api-api-SmartVision-Devices-Mac80211beaconParam.md)*param)

Description:

Setting the beacon frame based on specified parameters

changeMtu

  1. int32_t(*NetDeviceInterFace::changeMtu)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,int32_t newMtu)

Description:

Changes the maximum number of transmission units.

changeVirtualIntf

  1. int32_t(*WifiMac80211Ops::changeVirtualIntf)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,uint8_t iftype,uint32_t*flags,struct[VifParams]($api-api-SmartVision-Devices-VifParams.md)*params)

Description:

Changing virtual APIs

channel

  1. struct[Ieee80211Channel]($api-api-SmartVision-Devices-Ieee80211Channel.md)*WifiConnectParams::channel

Description:

Connection channel. If this parameter is not specified, the connection channel is automatically obtained from the scan result.

channels [1/2]

  1. struct[Ieee80211Channel]($api-api-SmartVision-Devices-Ieee80211Channel.md)*WifiScanRequest::channels[MAX_SCAN_CHANNELS]

Description:

Channels to scan for. For details, see MAX_SCAN_CHANNELS.

channels [2/2]

  1. struct[Ieee80211Channel]($api-api-SmartVision-Devices-Ieee80211Channel.md)*Ieee80211SupportedBand::channels

Description:

An array of supported channels

check [1/3]

  1. uint16_tIpHeader::check

Description:

Header check

check [2/3]

  1. uint16_tUdpHeader::check

Description:

Header check

check [3/3]

  1. uint16_tTcpHeader::check

Description:

Checksum

chip

  1. struct[HdfWifiChipData]($api-api-SmartVision-Devices-HdfWifiChipData.md)*WifiFeature::chip

Description:

Chip

cipher

  1. uint32_tKeyParams::cipher

Description:

Cipher suite

cipherGroup

  1. uint32_tCryptoSettings::cipherGroup

Description:

Cipher group

ciphersPairwise

  1. uint32_tCryptoSettings::ciphersPairwise[NL80211_MAX_NR_CIPHER_SUITES]

Description:

Unicast cipher suite. For details, see NL80211_MAX_NR_CIPHER_SUITES.

cipherSuites

  1. constuint32_t*Wiphy::cipherSuites

Description:

Supported cipher suites

connect

  1. int32_t(*WifiMac80211Ops::connect)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,[WifiConnectParams]($api-api-SmartVision-Devices-WifiConnectParams.md)*param)

Description:

Starting a connection based on the specified parameters

connectedTime

  1. uint32_tStationInfo::connectedTime

Description:

Duration (in seconds) since the last station connection

connectStatus

  1. uint16_tConnetResult::connectStatus

Description:

Connection status

controlPort

  1. int8_tCryptoSettings::controlPort

Description:

Whether the user space control port is authorized. The value true indicates that the user space control port is unauthorized.

controlPortEthertype

  1. uint16_tCryptoSettings::controlPortEthertype

Description:

Data can be transmitted over an unauthenticated port.

controlPortNoEncrypt

  1. int8_tCryptoSettings::controlPortNoEncrypt

Description:

Whether to encrypt frames transmitted over the control port. The value 1 indicates that the frames are not encrypted.

crypto

  1. struct[CryptoSettings]($api-api-SmartVision-Devices-CryptoSettings.md)WifiConnectParams::crypto

Description:

Cryptography information

currentAp

  1. uint8_tReassocReq::currentAp[6]

Description:

Current AP

dAddr

  1. uint32_tIpHeader::dAddr

Description:

Destination address

dataLen

  1. uint32_tNetBuf::dataLen

Description:

Actual data length of the network data buffer

deauth [1/2]

  1. struct[Deauth]($api-api-SmartVision-Devices-Deauth.md)Ieee80211Mgmt::deauth

Description:

Deauthentication Information

deauth [2/2]

  1. struct{...}::deauth

Description:

Deauthentication Information

deinit

  1. int32_t(*HdfWifiChipData::deinit)(struct[HdfWifiChipData]($api-api-SmartVision-Devices-HdfWifiChipData.md)*chipData)

Description:

Function for deinitializing the chip

deInit [1/3]

  1. void(*NetDeviceInterFace::deInit)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Deinitializes a network device to be delete.

deInit [2/3]

  1. int32_t(*WifiFeature::deInit)(struct[WifiFeature]($api-api-SmartVision-Devices-WifiFeature.md)*feature)

Description:

Function for deinitializing the feature

deInit [3/3]

  1. int32_t(*WifiModuleIface::deInit)(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module)

Description:

Deinitializing a WLAN module

delFeature

  1. int32_t(*WifiModuleIface::delFeature)(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module,uint16_t featureType)

Description:

Deleting a feature

delKey

  1. int32_t(*WifiMac80211Ops::delKey)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netdev,uint8_t keyIndex,bool pairwise,constuint8_t*macAddr)

Description:

Deleting a key based on a specified MAC address

delStation

  1. int32_t(*WifiMac80211Ops::delStation)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,constuint8_t*macAddr)

Description:

Deleting a station with a specified MAC address

dest

  1. uint16_tUdpHeader::dest

Description:

Destination port number

dev [1/2]

  1. void*NetBuf::dev

Description:

Network device that receives the network data

dev [2/2]

  1. struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*WifiScanRequest::dev

Description:

A specified network device to scan for

device

  1. struct[HdfDeviceObject](HdfDeviceObject.md)*HdfWifiProductData::device

Description:

Structure of the Device Object

disassoc [1/2]

  1. struct{...}::disassoc

Description:

Disconnected

disassoc [2/2]

  1. struct[Disassoc]($api-api-SmartVision-Devices-Disassoc.md)Ieee80211Mgmt::disassoc

Description:

Disconnected

disconnect

  1. int32_t(*WifiMac80211Ops::disconnect)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,uint16_t reasonCode)

Description:

Canceling a connection

dlist [1/2]

  1. struct[DListHead](DListHead.md)NetBuf::dlist

Description:

Doubly linked list. Generally, multiple network data buffers are linked by using a doubly linked list.

dlist [2/2]

  1. struct[DListHead](DListHead.md)NetBufQueue::dlist

Description:

Doubly linked list. Generally, multiple network data buffers are linked by using a doubly linked list.

dPort

  1. uint16_tTcpHeader::dPort

Description:

Destination port number

dstAddr

  1. uint8_tIeee80211Mgmt::dstAddr[6]

Description:

Destination MAC address

dtimPeriod [1/2]

  1. uint8_tStaBssParameters::dtimPeriod

Description:

Delivery Traffic Indication Message (DTIM) period of BSS

dtimPeriod [2/2]

  1. int32_tMac80211beaconParam::dtimPeriod

Description:

Delivery Traffic Indication Message (DTIM) interval

duration

  1. uint16_tIeee80211Mgmt::duration

Description:

Duration

etherDhost

  1. uint8_tEtherHeader::etherDhost[[MAC_ADDR_SIZE]($api-api-SmartVision-Devices-WLAN.md#gae01dbae885bc8abecb82bd865515c081)]

Description:

Destination address MAC_ADDR_SIZE

etherShost

  1. uint8_tEtherHeader::etherShost[[MAC_ADDR_SIZE]($api-api-SmartVision-Devices-WLAN.md#gae01dbae885bc8abecb82bd865515c081)]

Description:

Source address MAC_ADDR_SIZE

etherType

  1. uint16_tEtherHeader::etherType

Description:

Ethernet type, such as 0x8035 (RARP), 0x888e (EAPOL), PAE/802.1x, 0x0800 (IP), 0x86dd (IPV6), and 0x0806 (ARP)

fake

  1. uint32_tIfReq::fake

Description:

magic field

fe

  1. struct[WifiFeature]($api-api-SmartVision-Devices-WifiFeature.md)*WifiFeatureList::fe[[HDF_WIFI_FEATURE_NUM]($api-api-SmartVision-Devices-WLAN.md#ggaec03ba36d71cc2d5f3209bc24aa6ee10a28ff5971d579c1754e03a5f79a0c9e6f)]

Description:

An array of WLAN features

feList

  1. struct[WifiFeatureList]($api-api-SmartVision-Devices-WifiFeatureList.md)*WifiModule::feList

Description:

WLAN features

filled

  1. uint32_tStationInfo::filled

Description:

Flag values of relevant structures

flags [1/7]

  1. uint8_tRateInfo::flags

Description:

Flag field, used to indicate a specific rate transmission type of 802.11n

flags [2/7]

  1. uint8_tStaBssParameters::flags

Description:

Flag, used to indicate a specific rate transmission type of 802.11n

flags [3/7]

  1. uint32_tIeee80211Channel::flags

Description:

WLAN channel flag

flags [4/7]

  1. uint32_tIeee80211Rate::flags

Description:

Rate flag

flags [5/7]

  1. uint32_tWiphy::flags

Description:

Wiphy device attributes

flags [6/7]

  1. uint8_tTcpHeader::flags

Description:

Flags

flags [7/7]

  1. uint32_tNetDevice::flags

Description:

Network port status

fragInfo

  1. uint16_tIpHeader::fragInfo

Description:

Fragmentation information

fragThreshold

  1. uint32_tWiphy::fragThreshold

Description:

Fragment threshold

frameControl

  1. uint16_tIeee80211Mgmt::frameControl

Description:

Frame control field

freq [1/2]

  1. int16_tScannedBssInfo::freq

Description:

Center frequency of the channel where the BSS is located

freq [2/2]

  1. uint16_tConnetResult::freq

Description:

Frequency of the AP

funType

  1. [IfType]($api-api-SmartVision-Devices-IfType.md)NetDevice::funType

Description:

Network port type

generation

  1. int32_tStationInfo::generation

Description:

Generation number

getModule

  1. struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*(*WifiModuleIface::getModule)(void)

Description:

Obtaining a WLAN module

getStats

  1. structNetDevStats*(*NetDeviceInterFace::getStats)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Obtains the statistics.

hardHeaderLen

  1. uint16_tNetDevice::hardHeaderLen

Description:

Header length

hiddenSsid

  1. uint8_tMac80211beaconParam::hiddenSsid

Description:

Whether to hide the SSID

hslConfig

  1. conststructHdfConfigWifiModuleConfig*WifiModuleConfig::hslConfig

Description:

Configuration of each feature of the WLAN module

htCap

  1. struct[Ieee80211StaHtCap]($api-api-SmartVision-Devices-Ieee80211StaHtCap.md)Ieee80211SupportedBand::htCap

Description:

HT capability

htSupported

  1. uint8_tIeee80211StaHtCap::htSupported

Description:

Whether the station supports HT

hwValue [1/2]

  1. uint16_tIeee80211Channel::hwValue

Description:

Hardware information

hwValue [2/2]

  1. uint16_tIeee80211Rate::hwValue

Description:

Hardware information

hwValueShort

  1. uint16_tIeee80211Rate::hwValueShort

Description:

Hardware information specified when a short preamble is used

id

  1. uint16_tIpHeader::id

Description:

Each data packet sent by the host

ie [1/2]

  1. uint8_t*WifiScanRequest::ie

Description:

IEEE 802.11 buffer

ie [2/2]

  1. uint8_t*WifiConnectParams::ie

Description:

IEEE 802.11 information required for the connection

ieee80211Ptr

  1. struct[WirelessDev]($api-api-SmartVision-Devices-WirelessDev.md)*NetDevice::ieee80211Ptr

Description:

Pointer to a wireless device

ieLen [1/2]

  1. uint32_tWifiScanRequest::ieLen

Description:

IEEE 802.11 buffer length

ieLen [2/2]

  1. uint32_tWifiConnectParams::ieLen

Description:

IEEE 802.11 length

iface

  1. struct[WifiModuleIface]($api-api-SmartVision-Devices-WifiModuleIface.md)*WifiModule::iface

Description:

APIs

ifrData

  1. uint8_t*IfReq::ifrData

Description:

Data pointer

iftype

  1. uint8_tWirelessDev::iftype

Description:

API type

inactiveTime

  1. uint32_tStationInfo::inactiveTime

Description:

Duration (in milliseconds) since the last station activity

init [1/4]

  1. int32_t(*HdfWifiChipData::init)(struct[HdfWifiChipData]($api-api-SmartVision-Devices-HdfWifiChipData.md)*chipData,conststructHdfConfigWifiChip*chipConfig)

Description:

Function for initializing the chip

init [2/4]

  1. int32_t(*NetDeviceInterFace::init)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Initializes a network device to be added.

init [3/4]

  1. int32_t(*WifiFeature::init)(struct[WifiFeature]($api-api-SmartVision-Devices-WifiFeature.md)*feature)

Description:

Function for initializing the feature

init [4/4]

  1. int32_t(*WifiModuleIface::init)(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module)

Description:

Initializing a WLAN module

interfaceModes

  1. uint16_tWiphy::interfaceModes

Description:

Bitmask of an API type that is valid for the wiphy device

interval

  1. int32_tMac80211beaconParam::interval

Description:

Beacon interval

ioctl

  1. int32_t(*NetDeviceInterFace::ioctl)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,[IfReq]($api-api-SmartVision-Devices-IfReq.md)*req,int32_t cmd)

Description:

Used for the control command word.

ipAddr

  1. uint32_tNetDevNotify::ipAddr

Description:

IP address

key [1/2]

  1. uint8_t*KeyParams::key

Description:

Key content

key [2/2]

  1. constuint8_t*WifiConnectParams::key

Description:

Wired Equivalent Privacy (WEP) key used for Shared Key Authentication (SKA)

keyIdx

  1. uint8_tWifiConnectParams::keyIdx

Description:

Index of the WEP key used for SKA

keyLen [1/2]

  1. int32_tKeyParams::keyLen

Description:

Key length

keyLen [2/2]

  1. uint8_tWifiConnectParams::keyLen

Description:

Key length

lastRxTime

  1. uint32_tNetDevice::lastRxTime

Description:

Last time when data is received

legacy

  1. uint16_tRateInfo::legacy

Description:

100 kbit/s bit rate defined in 802.11a/b/g

len [1/2]

  1. uint32_tNetBuf::len

Description:

Length of the memory buffer

len [2/2]

  1. uint16_tUdpHeader::len

Description:

Length of a data packet

LinkLayerType

  1. [NetLinkType]($api-api-SmartVision-Devices-WLAN.md#gad3175955d2e6ef3c4f52da9b509d5b4a) NetDevice::LinkLayerType

Description:

Data link layer type

listenInterval [1/2]

  1. uint16_tAssocReq::listenInterval

Description:

Scan interval

listenInterval [2/2]

  1. uint16_tReassocReq::listenInterval

Description:

Scan interval

llid

  1. uint16_tStationInfo::llid

Description:

Local mesh ID

lock

  1. structSpinlockNetBufQueue::lock

Description:

Queue operation lock

mac [1/2]

  1. uint8_tMacConfigParam::mac[WLAN_MAC_ADDR_LEN]

Description:

MAC address. For details about its length, see WLAN_MAC_ADDR_LEN.

mac [2/2]

  1. constuint8_t*StationDelParameters::mac

Description:

MAC address of the station to which the connection is to be canceled

macAddr [1/3]

  1. charNetDevice::macAddr[[MAC_ADDR_SIZE]($api-api-SmartVision-Devices-WLAN.md#gae01dbae885bc8abecb82bd865515c081)]

Description:

MAC address MAC_ADDR_SIZE

macAddr [2/3]

  1. uint8_tMac80211DisconnectParam::macAddr[WLAN_MAC_ADDR_LEN]

Description:

Device MAC address

macAddr [3/3]

  1. uint8_t*VifParams::macAddr

Description:

MAC address

mask

  1. uint32_tStaFlagUpdate::mask

Description:

Flag mask

maxAntennaGain

  1. int32_tIeee80211Channel::maxAntennaGain

Description:

Maximum antenna gain, in dBi

maxPower

  1. int32_tIeee80211Channel::maxPower

Description:

Maximum transmit power, in dBm

maxScanIeLen

  1. uint16_tWiphy::maxScanIeLen

Description:

Maximum SSID length

maxScanSsids

  1. uint8_tWiphy::maxScanSsids

Description:

Maximum number of scanned service set identifiers (SSIDs)

mcs [1/2]

  1. uint8_tRateInfo::mcs

Description:

Modulation and Coding Scheme (MCS) index of the HT/VHT/HE rate

mcs [2/2]

  1. struct[Ieee80211McsInfo]($api-api-SmartVision-Devices-Ieee80211McsInfo.md)Ieee80211StaHtCap::mcs

Description:

MCS rate

mem

  1. uint8_t*NetBuf::mem

Description:

Memory buffer address

mfp

  1. uint8_tWifiConnectParams::mfp

Description:

Whether to enable Management Frame Protection (MFP)

mgmt

  1. struct[Ieee80211Mgmt]($api-api-SmartVision-Devices-Ieee80211Mgmt.md)*ScannedBssInfo::mgmt

Description:

Start address of the management frame

mgmtLen

  1. uint32_tScannedBssInfo::mgmtLen

Description:

Management frame length

mlPriv

  1. void*NetDevice::mlPriv

Description:

Private structure for the driver

module

  1. struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*HdfWifiProductData::module

Description:

Structure of the WLAN module

moduleConfig

  1. struct[WifiModuleConfig]($api-api-SmartVision-Devices-WifiModuleConfig.md)WifiModule::moduleConfig

Description:

Module configurations

modulePrivate

  1. void*WifiModule::modulePrivate

Description:

Private data

mtu

  1. uint32_tNetDevice::mtu

Description:

Maximum transmission unit

n_akmSuites

  1. int32_tCryptoSettings::n_akmSuites

Description:

Number of authentication and key management (AKM) suites

n_ciphersPairwise

  1. int32_tCryptoSettings::n_ciphersPairwise

Description:

Number of unicast ciphers supported by the access point (AP)

name [1/3]

  1. charNetDevice::name[IFNAMSIZ]

Description:

Network device name IFNAMSIZ

name [2/3]

  1. charWifiFeature::name[[MAX_WIFI_COMPONENT_NAME_LEN]($api-api-SmartVision-Devices-WLAN.md#gaf460a45a5e365279ca6bc5b3e8750542)]

Description:

Feature name, which can contain a maximum of 10 characters

name [3/3]

  1. charHdfWifiChipData::name[[MAX_WIFI_COMPONENT_NAME_LEN]($api-api-SmartVision-Devices-WLAN.md#gaf460a45a5e365279ca6bc5b3e8750542)]

Description:

Chip name

nBitrates

  1. int32_tIeee80211SupportedBand::nBitrates

Description:

Length of the array of supported bit rates

nChannels [1/2]

  1. int32_tIeee80211SupportedBand::nChannels

Description:

Length of the array of supported channels

nChannels [2/2]

  1. uint32_tWifiScanRequest::nChannels

Description:

Number of channels to scan for

nCipherSuites

  1. int32_tWiphy::nCipherSuites

Description:

Number of supported cipher suites

neededHeadRoom

  1. uint16_tNetDevice::neededHeadRoom

Description:

Length reserved for the header in netbuffNetBuf

neededTailRoom

  1. uint16_tNetDevice::neededTailRoom

Description:

Length reserved for the tail in netbuffNetBuf

netdev

  1. struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*WirelessDev::netdev

Description:

Network device

netDeviceIf

  1. struct[NetDeviceInterFace]($api-api-SmartVision-Devices-NetDeviceInterFace.md)*NetDevice::netDeviceIf

Description:

Network device interface

netifCateg

  1. [NetIfCategory]($api-api-SmartVision-Devices-WLAN.md#ga530241881cd17e03f8ae254ef1d9755e) NetDevice::netifCateg

Description:

Network interface category NetIfCategory

netifNotify

  1. uint32_t(*NetDeviceInterFace::netifNotify)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,[NetDevNotify]($api-api-SmartVision-Devices-NetDevNotify.md)*notify)

Description:

Notifies the network port status.

notifyType

  1. uint32_tNetDevNotify::notifyType

Description:

Notification type (reserved)

nss

  1. uint8_tRateInfo::nss

Description:

Number of streams (for VHT and HE only)

nSsids

  1. uint32_tWifiScanRequest::nSsids

Description:

Number of SSIDs to scan for

offset [1/2]

  1. int64_tStationInfo::offset

Description:

Time offset of station

offset [2/2]

  1. uint8_tTcpHeader::offset

Description:

Header length

open

  1. int32_t(*NetDeviceInterFace::open)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Opens the data link layer.

operationType

  1. uint8_tMac80211beaconParam::operationType

Description:

Operation type

ops

  1. struct[WifiMac80211Ops]($api-api-SmartVision-Devices-WifiMac80211Ops.md)*HdfWifiChipData::ops

Description:

Chip MAC address

origFlags

  1. uint32_tIeee80211Channel::origFlags

Description:

Channel flags

origMag

  1. int32_tIeee80211Channel::origMag

Description:

Reserved field

origMpwr

  1. int32_tIeee80211Channel::origMpwr

Description:

Reserved field

owner

  1. struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*NetDevice::owner

Description:

Network device

p2pMode

  1. uint8_tMacConfigParam::p2pMode

Description:

Whether the peer-to-peer (P2P) mode is used.

permAddr

  1. uint8_tWiphy::permAddr[WLAN_MAC_ADDR_LEN]

Description:

Permanent MAC address of the wiphy device. For its length, see WLAN_MAC_ADDR_LEN.

plid

  1. uint16_tStationInfo::plid

Description:

Peer mesh ID

plinkState

  1. uint8_tStationInfo::plinkState

Description:

Mesh peer state

prefixSsidScanFlag

  1. uint8_tWifiScanRequest::prefixSsidScanFlag

Description:

Reserved field

presetChandef

  1. struct[ChannelDef]($api-api-SmartVision-Devices-ChannelDef.md)WirelessDev::presetChandef

Description:

Channel information

priv

  1. uint8_tWiphy::priv[WIPHY_PRIV_SIZE]

Description:

Reserved field

privacy

  1. uint8_tWifiConnectParams::privacy

Description:

Whether to use a privacy-enabled AP

probeResp [1/2]

  1. struct{...}::probeResp

Description:

Probe response frame

probeResp [2/2]

  1. struct[ProbeResp]($api-api-SmartVision-Devices-ProbeResp.md)Ieee80211Mgmt::probeResp

Description:

Probe response frame

product_name

  1. charHdfWifiProductData::product_name[[MAX_WIFI_COMPONENT_NAME_LEN]($api-api-SmartVision-Devices-WLAN.md#gaf460a45a5e365279ca6bc5b3e8750542)]

Description:

WLAN module name, which contains a maximum of 10 bytes

protocol

  1. uint8_tIpHeader::protocol

Description:

Protocol, such as 1 (ICMP), 2 (IGMP), 6 (TCP), 17 (UDP), and 89 (OSPF)

qmap

  1. uint32_tNetBuf::qmap

Description:

Queue mappings of the network data buffer

reasonCode [1/4]

  1. uint16_tDeauth::reasonCode

Description:

Deauthentication cause code

reasonCode [2/4]

  1. uint16_tDisassoc::reasonCode

Description:

Cause code

reasonCode [3/4]

  1. uint16_tStationDelParameters::reasonCode

Description:

Cause of the cancellation

reasonCode [4/4]

  1. uint16_tMac80211DisconnectParam::reasonCode

Description:

Disconnection reason code

reassocReq [1/2]

  1. struct{...}::reassocReq

Description:

Re-authentication

reassocReq [2/2]

  1. struct[ReassocReq]($api-api-SmartVision-Devices-ReassocReq.md)Ieee80211Mgmt::reassocReq

Description:

Re-authentication

reassocResp [1/2]

  1. struct[ReassocResp]($api-api-SmartVision-Devices-ReassocResp.md)Ieee80211Mgmt::reassocResp

Description:

Re-authentication response

reassocResp [2/2]

  1. struct{...}::reassocResp

Description:

Re-authentication response

reqIe

  1. uint8_t*ConnetResult::reqIe

Description:

Association request IE

reqIeLen

  1. uint32_tConnetResult::reqIeLen

Description:

Length of the association request IE

reserved

  1. uint8_tIeee80211McsInfo::reserved[IEEE80211_MACINFO_RESV]

Description:

Reserved field

resv [1/4]

  1. uint8_tIeee80211Channel::resv[IEEE80211_CHANNEL_RESV]

Description:

Reserved field

resv [2/4]

  1. uint8_tWifiScanRequest::resv[SCAN_REQUEST_RESV_SIZE]

Description:

Reserved field

resv [3/4]

  1. uint8_tWirelessDev::resv[WIRELESS_DEV_RESV_SIZE]

Description:

Reserved field

resv [4/4]

  1. uint8_tRateInfo::resv

Description:

Reserved

resv1

  1. uint8_tStationInfo::resv1

Description:

Reserved

rspIe

  1. uint8_t*ConnetResult::rspIe

Description:

Association response IE

rspIeLen

  1. uint32_tConnetResult::rspIeLen

Description:

Length of the association response IE

rsv [1/2]

  1. uint8_tIeee80211Rate::rsv[IEEE80211_RATE_RESV]

Description:

Reserved field

rsv [2/2]

  1. uint8_tNetBuf::rsv[[MAX_NETBUF_RESEVER_SIZE]($api-api-SmartVision-Devices-WLAN.md#ga794c035a19a38acc000146a8f9a4ec80)]

Description:

Reserved field. For details, see MAX_NETBUF_RESEVER_SIZE.

rtsThreshold

  1. uint32_tWiphy::rtsThreshold

Description:

Request To Send (RTS) threshold

rxBytes [1/2]

  1. uint64_tStationInfo::rxBytes

Description:

Received bytes

rxBytes [2/2]

  1. uint32_tNetDevStats::rxBytes

Description:

Total number of received bits

rxDropped

  1. uint32_tNetDevStats::rxDropped

Description:

Packets that are dropped after being received

rxDroppedMisc

  1. uint32_tStationInfo::rxDroppedMisc

Description:

Number of receive failures

rxErrors

  1. uint32_tNetDevStats::rxErrors

Description:

Number of received error packets

rxHighest

  1. uint16_tIeee80211McsInfo::rxHighest

Description:

Maximum rate for receiving data

rxMask

  1. uint8_tIeee80211McsInfo::rxMask[IEEE80211_HT_MCS_MASK_LEN]

Description:

Mask for receiving data

rxPackets [1/2]

  1. uint32_tStationInfo::rxPackets

Description:

Received data packets

rxPackets [2/2]

  1. uint32_tNetDevStats::rxPackets

Description:

Total number of received packets

rxRate

  1. struct[RateInfo]($api-api-SmartVision-Devices-RateInfo.md)StationInfo::rxRate

Description:

Receive rate

sAddr

  1. uint32_tIpHeader::sAddr

Description:

Source address

selectQueue

  1. uint16_t(*NetDeviceInterFace::selectQueue)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,struct[NetBuf]($api-api-SmartVision-Devices-NetBuf.md)*netBuff)

Description:

Selects a priority queue.

seq

  1. uint8_t*KeyParams::seq

Description:

Content of a Temporal Key Integrity Protocol (TKIP) or Counter Mode Cipher Block Chaining Message Authentication Code Protocol (CCMP) key

seqCtrl

  1. uint16_tIeee80211Mgmt::seqCtrl

Description:

Sequence control

seqLen

  1. int32_tKeyParams::seqLen

Description:

Length of a TKIP or CCMP key

seqNum

  1. uint32_tTcpHeader::seqNum

Description:

Sequence number

set

  1. uint32_tStaFlagUpdate::set

Description:

Flag value

setChannel

  1. int32_t(*WifiMac80211Ops::setChannel)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Setting the channel

setDefaultKey

  1. int32_t(*WifiMac80211Ops::setDefaultKey)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netdev,uint8_t keyIndex,bool unicast,bool multicas)

Description:

Setting the default key

setMacAddr [1/2]

  1. int32_t(*WifiMac80211Ops::setMacAddr)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,[Mac80211SetMacParam]($api-api-SmartVision-Devices-WLAN.md#ga85f7d8a3795887f090e0a6439b1df6e1) *param)

Description:

Setting the MAC address

setMacAddr [2/2]

  1. int32_t(*NetDeviceInterFace::setMacAddr)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,void*addr)

Description:

Sets the MAC address.

setMeshId

  1. int32_t(*WifiMac80211Ops::setMeshId)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,constchar*meshId,uint32_t meshIdLen)

Description:

Setting the mesh ID

setNetIfStatus

  1. void(*NetDeviceInterFace::setNetIfStatus)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,[NetIfStatus]($api-api-SmartVision-Devices-WLAN.md#ga0fb482694e5eac3f48c75de1749c8baf) status)

Description:

Sets the network port status.

setSsid

  1. int32_t(*WifiMac80211Ops::setSsid)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,constuint8_t*ssid,uint32_t ssidLen)

Description:

Setting the SSID

signal [1/2]

  1. int8_tStationInfo::signal

Description:

Signal strength

signal [2/2]

  1. int32_tScannedBssInfo::signal

Description:

Signal strength

signalAvg

  1. int8_tStationInfo::signalAvg

Description:

Average signal strength

signalType

  1. uint8_tWiphy::signalType

Description:

Signal type

size

  1. uint32_tNetBufQueue::size

Description:

Number of network data buffers in the queue

source

  1. uint16_tUdpHeader::source

Description:

Source port number

specialEtherTypeProcess

  1. [ProcessingResult]($api-api-SmartVision-Devices-WLAN.md#ga9c1d6e7df4468671742cb76f72b67af1)(* NetDeviceInterFace::specialEtherTypeProcess) (const struct [NetDevice]($api-api-SmartVision-Devices-NetDevice.md) *netDev, struct [NetBuf]($api-api-SmartVision-Devices-NetBuf.md) *buff)

Description:

Performs private processing without involving network-layer data.

specialProcPriv

  1. void*NetDevice::specialProcPriv

Description:

Private structure for data processing

sPort

  1. uint16_tTcpHeader::sPort

Description:

Source port number

srcAddr

  1. uint8_tIeee80211Mgmt::srcAddr[6]

Description:

Source MAC address

ssid [1/2]

  1. uint8_tWifiSsid::ssid[IEEE80211_MAX_SSID_LEN]

Description:

SSID content, which contains a maximum of 32 bytes

ssid [2/2]

  1. uint8_t*WifiConnectParams::ssid

Description:

SSID

ssidLen [1/3]

  1. uint8_tWifiSsid::ssidLen

Description:

SSID length

ssidLen [2/3]

  1. uint32_tWifiConnectParams::ssidLen

Description:

SSID length

ssidLen [3/3]

  1. uint8_tMac80211Ssids::ssidLen

Description:

SSID length

ssids

  1. struct[WifiSsid]($api-api-SmartVision-Devices-WifiSsid.md)*WifiScanRequest::ssids

Description:

SSIDs to scan for

staFlags

  1. struct[StaFlagUpdate]($api-api-SmartVision-Devices-StaFlagUpdate.md)StationInfo::staFlags

Description:

Station flag masks and values

startAp

  1. int32_t(*WifiMac80211Ops::startAp)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Starting an AP

startScan

  1. int32_t(*WifiMac80211Ops::startScan)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev,struct[WifiScanRequest]($api-api-SmartVision-Devices-WifiScanRequest.md)*param)

Description:

Starting a scan based on the specified parameters

state

  1. charHdfWifiProductData::state

Description:

WLAN module state

stats

  1. structNetDevStatsNetDevice::stats

Description:

Network statistics

statusCode [1/4]

  1. uint16_tAuth::statusCode

Description:

Authentication status code

statusCode [2/4]

  1. uint16_tAssocResp::statusCode

Description:

Status code

statusCode [3/4]

  1. uint16_tReassocResp::statusCode

Description:

Status code

statusCode [4/4]

  1. uint16_tConnetResult::statusCode

Description:

16-bit status code defined in the IEEE protocol

stop

  1. int32_t(*NetDeviceInterFace::stop)(struct[NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Closes the data link layer.

stopAp

  1. int32_t(*WifiMac80211Ops::stopAp)([NetDevice]($api-api-SmartVision-Devices-NetDevice.md)*netDev)

Description:

Stopping an AP

subtype

  1. uint8_tStationDelParameters::subtype

Description:

Cancellation type

timestamp [1/2]

  1. uint64_tBeacon::timestamp

Description:

Timestamp

timestamp [2/2]

  1. uint64_tProbeResp::timestamp

Description:

Timestamp

tos

  1. uint8_tIpHeader::tos

Description:

Service type

totLen

  1. uint16_tIpHeader::totLen

Description:

Total length of an IP data packet

ttl

  1. uint8_tIpHeader::ttl

Description:

Generation time

txBytes [1/2]

  1. uint64_tStationInfo::txBytes

Description:

Transmitted bytes

txBytes [2/2]

  1. uint32_tNetDevStats::txBytes

Description:

Total number of transmitted bits

txDropped

  1. uint32_tNetDevStats::txDropped

Description:

Packets dropped before transmission

txErrors

  1. uint32_tNetDevStats::txErrors

Description:

Transmitted error packets

txFailed

  1. uint32_tStationInfo::txFailed

Description:

Number of failed transmissions

txPackets [1/2]

  1. uint32_tStationInfo::txPackets

Description:

Transmitted data packets

txPackets [2/2]

  1. uint32_tNetDevStats::txPackets

Description:

Total number of transmitted packets

txParams

  1. uint8_tIeee80211McsInfo::txParams

Description:

Parameters for sending data

txPetries

  1. uint32_tStationInfo::txPetries

Description:

Number of retransmissions

txRate

  1. struct[RateInfo]($api-api-SmartVision-Devices-RateInfo.md)StationInfo::txRate

Description:

Transmission rate

type

  1. uint16_tHdfWifiChipData::type

Description:

Chip type

updateModule

  1. int32_t(*WifiModuleIface::updateModule)(struct[WifiModule]($api-api-SmartVision-Devices-WifiModule.md)*module)

Description:

Updating a WLAN module based on a specified configuration.

urgent

  1. uint16_tTcpHeader::urgent

Description:

Urgent pointer

use4Addr

  1. int32_tVifParams::use4Addr

Description:

Whether to use a frame containing four addresses

variable [1/7]

  1. uint8_tAuth::variable[0]

Description:

Algorithm challenge information stored in a flexible array

variable [2/7]

  1. uint8_tAssocReq::variable[0]

Description:

SSID and rate information stored in a flexible array

variable [3/7]

  1. uint8_tAssocResp::variable[0]

Description:

Rate information stored in a flexible array

variable [4/7]

  1. uint8_tReassocReq::variable[0]

Description:

SSID and rate information stored in a flexible array

variable [5/7]

  1. uint8_tReassocResp::variable[0]

Description:

Rate information stored in a flexible array

variable [6/7]

  1. uint8_tBeacon::variable[0]

Description:

SSID and rate information

variable [7/7]

  1. uint8_tProbeResp::variable[0]

Description:

SSID and rate information

versionAndHl

  1. uint8_tIpHeader::versionAndHl

Description:

Version and header length

watchdogTime

  1. int32_tNetDevice::watchdogTime

Description:

Watchdog duration

wdev

  1. struct[WirelessDev]($api-api-SmartVision-Devices-WirelessDev.md)*WifiScanRequest::wdev

Description:

A specified wireless device to scan for

width

  1. enum[WifiChannelType]($api-api-SmartVision-Devices-WLAN.md#ga9d902b330de99c24b2a8c3ba7120af21) ChannelDef::width

Description:

Bandwidth

window

  1. uint16_tTcpHeader::window

Description:

Window size

wiphy [1/2]

  1. struct[Wiphy]($api-api-SmartVision-Devices-Wiphy.md)*WirelessDev::wiphy

Description:

Wiphy device

wiphy [2/2]

  1. struct[Wiphy]($api-api-SmartVision-Devices-Wiphy.md)*WifiScanRequest::wiphy

Description:

A specified wiphy device to scan for

wlanType

  1. [Protocol80211IfType]($api-api-SmartVision-Devices-WLAN.md#gac69954f56fcc99fc8aac68aa157831c7) IfType::wlanType

Description:

WLAN network port type: AP or STA

wpaVersions

  1. uint32_tCryptoSettings::wpaVersions

Description:

WPA version

xmit

  1. [NetDevTxResult]($api-api-SmartVision-Devices-WLAN.md#ga9fb4e578a15db1b0087d7b3831591ced)(* NetDeviceInterFace::xmit) (struct [NetDevice]($api-api-SmartVision-Devices-NetDevice.md) *netDev, struct [NetBuf]($api-api-SmartVision-Devices-NetBuf.md) *netBuff)

Description:

Sends data.