同步操作将从 OpenHarmony/docs 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
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
typedef struct NetDevice Defines a network device, including the network interface category and name, and network port type. |
|
typedef struct WifiConnectParams |
|
typedef struct MacConfigParam |
NetBufQueueInit (struct NetBufQueue *q) |
|
NetBufQueueSize (const struct NetBufQueue *q) |
|
NetBufQueueIsEmpty (const struct NetBufQueue *q) |
|
NetBufQueueEnqueue (struct NetBufQueue *q, struct NetBuf *nb) |
|
NetBufQueueEnqueueHead (struct NetBufQueue *q, struct NetBuf *nb) |
|
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) |
Clears a network data buffer queue and releases the network data buffer in the queue. |
NetBufQueueConcat (struct NetBufQueue *q, struct NetBufQueue *add) |
Moves all network data buffers from one queue to another and clears the source queue. |
NetBufAlloc (uint32_t size) |
struct NetBuf * |
NetBufFree (struct NetBuf *nb) |
|
NetBufDevAlloc (const struct NetDevice *dev, 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 NetBuf *nb, uint32_t id, uint32_t len) |
Performs operations based on the segment ID of a network data buffer. The function is opposite to that of NetBufPop. |
Performs operations based on the segment ID of a network data buffer. The function is opposite to that of NetBufPush. |
|
NetBufGetAddress (const struct NetBuf *nb, uint32_t id) |
Obtains the address of a specified buffer segment in a network data buffer. |
NetBufGetRoom (const struct NetBuf *nb, uint32_t id) |
Obtains the size of a specified buffer segment space in a network data buffer. |
NetBufGetDataLen (const struct NetBuf *nb) |
Obtains the actual data length of the data segment of a network data buffer. |
NetBufResizeRoom (struct NetBuf *nb, uint32_t head, uint32_t tail) |
|
NetBufConcat (struct NetBuf *nb, struct NetBuf *cnb) |
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 NetBuf *nb) |
Converts a network data buffer to the pbuf structure of Lightweight TCP/IP Stack (lwIP). |
HdfWifiEventNewSta (const struct NetDevice *netdev, const uint8_t *macAddr, uint8_t addrLen, const struct StationInfo *info) |
|
HdfWifiEventDelSta (struct NetDevice *netdev, const uint8_t *macAddr, uint8_t addrLen) |
|
HdfWifiEventInformBssFrame (const struct NetDevice *netdev, struct Wiphy *wiphy, const struct Ieee80211Channel *channel, const struct ScannedBssInfo *bssInfo) |
|
HdfWifiEventScanDone (const struct NetDevice *netdev, WifiScanStatus status) |
|
HdfWifiEventConnectResult (const struct NetDevice *netdev, const struct ConnetResult *result) |
|
HdfWifiEventDisconnected (const struct NetDevice *netdev, uint16_t reason, const uint8_t *ie, uint32_t len) |
|
HdfWifiEventMgmtTxStatus (const struct NetDevice *netdev, const uint8_t *buf, size_t len, uint8_t ack) |
|
HdfWifiEventRxMgmt (const struct NetDevice *netdev, int32_t freq, int32_t sigMbm, const uint8_t *buf, size_t len) |
|
HdfWifiEventCsaChannelSwitch (const struct NetDevice *netdev, int32_t freq) |
|
HdfWifiEventTimeoutDisconnected (const struct NetDevice *netdev) |
|
HdfWifiEventEapolRecv (const char *name, void *context) |
Reports the event of receiving the EAPOL frame and notifies WPA to read the EAPOL frame. |
HdfWifiGetProduct (void) |
struct HdfWifiProductData * |
NetDeviceInit (const char *ifName, uint32_t len, NetIfCategory ifCategory) |
struct NetDevice * |
NetDeviceDeInit (struct NetDevice *netDevice) |
|
NetDeviceAdd (struct NetDevice *netDevice, Protocol80211IfType ifType) |
|
NetDeviceDelete (struct NetDevice *netDevice) |
|
NetDeviceGetInstByName (const char *name) |
struct NetDevice * Obtains the initialized network device instance by a specified device name. |
NetDeviceIsAnyInstRunning (void) |
Checks whether there are working devices among the added network devices. |
NetDeviceIsInstRunning (const struct NetDevice *netDevice) |
|
NetDevGetRegisterCount (void) |
|
NetDeviceGetCap (void) |
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 NetDevice *netDevice, const IpV4Addr *ipAddr, const IpV4Addr *netMask, const IpV4Addr *gw) |
|
NetIfSetStatus (const struct NetDevice *netDevice, NetIfStatus status) |
|
NetIfSetLinkStatus (const struct NetDevice *netDevice, NetIfLinkStatus status) |
|
NetIfRx (const struct NetDevice *netDevice, struct NetBuf *buff) |
Transfers the input data packets from the network side to a protocol stack. |
NetIfRxNi (const struct NetDevice *netDevice, struct NetBuf *buff) |
Transfers data packets from the network side to a protocol stack in an interrupt processing thread. |
NetIfDhcpsStart (const struct NetDevice *netDevice, char *ip, u16_t ipNum) |
|
NetIfDhcpsStop (const struct NetDevice *netDevice) |
|
NetIfDhcpStart (const struct NetDevice *netDevice) |
|
NetIfDhcpStop (const struct NetDevice *netDevice) |
|
NetIfDhcpIsBound (const struct NetDevice *netDevice) |
Obtains the DHCP negotiation status of a specified network device. |
Mac80211RegisterOps (struct WifiMac80211Ops *ops) __attribute__((weak)) |
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) |
Deletes a specified WifiModule object. |
DelFeature (struct WifiModule *module, uint16_t featureType) |
|
AddFeature (struct WifiModule *module, uint16_t featureType, struct WifiFeature *featureData) |
#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.
#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 struct [MacConfigParam](MacConfigParam.md) [Mac80211SetMacParam](WLAN.md#ga85f7d8a3795887f090e0a6439b1df6e1)
Description:
Describes MAC configuration parameters.
typedef struct [NetDevice](NetDevice.md) [NetDevice](NetDevice.md)
Description:
Defines a network device, including the network interface category and name, and network port type.
typedef struct [WifiConnectParams](WifiConnectParams.md) [WifiConnectParams](WifiConnectParams.md)
Description:
Describes parameters for a connection request.
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.
E_HEAD_BUF | |
E_DATA_BUF | |
E_TAIL_BUF | |
MAX_BUF_NUM |
enum [Ieee80211Band](WLAN.md#ga9882f415202cf9acb0f4cdfbc456a88d)
Description:
Enumerates frequency bands.
IEEE80211_BAND_2GHZ | |
IEEE80211_BAND_5GHZ | |
IEEE80211_NUM_BANDS |
enum [MacSetType](WLAN.md#ga75cba3dc6ab4c5dc5653b037433b3abf)
Description:
Enumerates setting types of MAC addresses.
MAC_BEACON_SET | |
MAC_BEACON_ADD |
enum [NetdeviceError](WLAN.md#ga9023c5dc1cc43758cbb468d78af41c2d)
Description:
Enumerates network device errors, including common errors and errors in adding network devices to LwIP.
COMMON_ERROR | |
ADD_LWIP_ERROR |
enum [NetDevTxResult](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.
NETDEV_TX_OK | |
NETDEV_TX_BUSY | |
NETDEV_TX_LOCKED |
enum [NetIfCategory](WLAN.md#ga530241881cd17e03f8ae254ef1d9755e)
Description:
Enumerates network interface categories, including lightweight OS and rich OS.
LITE_OS | |
RICH_OS |
enum [NetIfLinkStatus](WLAN.md#ga7b1187d116fb065d7927ad9f77edd842)
Description:
Enumerates network link layer states, including online and offline.
NETIF_LINK_DOWN | |
NETIF_LINK_UP |
enum [NetIfStatus](WLAN.md#ga0fb482694e5eac3f48c75de1749c8baf)
Description:
Enumerates network interface states, including online and offline.
NETIF_DOWN | |
NETIF_UP |
enum [NetLinkType](WLAN.md#gad3175955d2e6ef3c4f52da9b509d5b4a)
Description:
Enumerates data link types, including Ethernet and WLAN.
ETHERNET_LINK | |
WIFI_LINK |
enum [ProcessingResult](WLAN.md#ga9c1d6e7df4468671742cb76f72b67af1)
Description:
Enumerates data processing results, including continuing processing, processing completed, and error.
PROCESSING_CONTINUE | |
PROCESSING_COMPLETE | |
PROCESSING_ERROR |
enum [Protocol80211IfType](WLAN.md#gac69954f56fcc99fc8aac68aa157831c7)
Description:
Enumerates 802.11 network port types, including AP, STA, and P2P.
enum [WifiBusType](WLAN.md#ga1c5537e64f05b5e91b951ddeb66d4261)
Description:
Enumerates bus types of a WLAN module.
BUS_SDIO | |
BUS_USB |
enum [WifiChannelType](WLAN.md#ga9d902b330de99c24b2a8c3ba7120af21)
Description:
Enumerates channel types.
enum [WifiHmacMgmtStatus](WLAN.md#gaf3e873b51f0cfa077aca9d33ed7a0960)
Description:
Enumerates MLME management statuses, indicating whether a device is successfully associated or fails to be associated.
WIFI_HMAC_MGMT_SUCCESS | |
WIFI_HMAC_MGMT_INVALID | |
WIFI_HMAC_MGMT_TIMEOUT | |
WIFI_HMAC_MGMT_REFUSED | |
WIFI_HMAC_MGMT_TOMANY_REQ | |
WIFI_HMAC_MGMT_ALREADY_BSS |
enum [WifiMainFeatureType](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.
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 |
int32_t AddFeature (struct [WifiModule](WifiModule.md) * module, uint16_t featureType, struct [WifiFeature](WifiFeature.md) * featureData )
Description:
Adds a specified feature to a specified module.
Parameters:
module | Indicates the pointer to the module. |
featureType | Indicates the type of the feature to add. |
featureData | Indicates the pointer to the feature to add. |
Returns:
Returns 0 if the feature is added successfully; returns a negative value otherwise.
int32_t DelFeature (struct [WifiModule](WifiModule.md) * module, uint16_t featureType )
Description:
Deletes a specified feature from a specified module.
Parameters:
module | Indicates the pointer to the module. |
featureType | Indicates the type of the feature to delete. |
Returns:
Returns 0 if the feature is deleted successfully; returns -1 otherwise.
int32_t HdfWifiEventConnectResult (const struct [NetDevice](NetDevice.md) * netdev, const struct [ConnetResult](ConnetResult.md) * result )
Description:
Reports a connection result event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
result | Indicates the pointer to the connection result. This parameter cannot be null. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventCsaChannelSwitch (const struct [NetDevice](NetDevice.md) * netdev, int32_t freq )
Description:
Reports a CSA channel switching event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
freq | Indicates the frequency of the channel. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventDelSta (struct [NetDevice](NetDevice.md) * netdev, const uint8_t * macAddr, uint8_t addrLen )
Description:
Reports a station deletion event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
macAddr | Indicates the pointer to the MAC address of the station. This parameter cannot be null. |
addrLen | Indicates 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.
int32_t HdfWifiEventDisconnected (const struct [NetDevice](NetDevice.md) * netdev, uint16_t reason, const uint8_t * ie, uint32_t len )
Description:
Reports a disconnection event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
reason | Indicates the reason for disconnection. |
ie | Indicates the pointer to the deauth/disassoc frame IE. |
ieLen | Indicates the length of the deauth/disassoc IE. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventEapolRecv (const char * name, void * context )
Description:
Reports the event of receiving the EAPOL frame and notifies WPA to read the EAPOL frame.
Parameters:
name | Indicates the pointer to the network port name, for example, wlan0. |
context | Indicates the pointer to the context. This parameter is reserved. |
Returns:
Returns 0 if the operation is successful; returns -1 otherwise.
int32_t HdfWifiEventInformBssFrame (const struct [NetDevice](NetDevice.md) * netdev, struct [Wiphy](Wiphy.md) * wiphy, const struct [Ieee80211Channel](Ieee80211Channel.md) * channel, const struct [ScannedBssInfo](ScannedBssInfo.md) * bssInfo )
Description:
Reports a scanned BSS event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
wiphy | Indicates the pointer to the physical layer of the wireless network. This parameter cannot be null. |
channel | Indicates the pointer to the channel information. This parameter cannot be null. |
bssInfo | Indicates the pointer to the BSS information. This parameter cannot be null. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventMgmtTxStatus (const struct [NetDevice](NetDevice.md) * netdev, const uint8_t * buf, size_t len, uint8_t ack )
Description:
Reports a transmission management status event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
buf | Indicates the pointer to the transmission management frame. This parameter cannot be null. |
len | Indicates the length of the transmission management frame. |
ack | Indicates whether the transmission management frame is acknowledged. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventNewSta (const struct [NetDevice](NetDevice.md) * netdev, const uint8_t * macAddr, uint8_t addrLen, const struct [StationInfo](StationInfo.md) * info )
Description:
Reports a new STA event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
macAddr | Indicates the pointer to the MAC address of the station. This parameter cannot be null. |
addrLen | Indicates the length of the MAC address of the station. The length is fixed to six bytes. |
info | Indicates the pointer to the station information. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventRxMgmt (const struct [NetDevice](NetDevice.md) * netdev, int32_t freq, int32_t sigMbm, const uint8_t * buf, size_t len )
Description:
Reports a receive management status event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
freq | Indicates the frequency of receiving management frame. |
sigMbm | Indicates the signal strength (in dBm). |
buf | Indicates the pointer to the receive management frame. This parameter cannot be null. |
len | Indicates the length of the receive management frame. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventScanDone (const struct [NetDevice](NetDevice.md) * netdev, WifiScanStatus status )
Description:
Reports a scanning completion event.
Parameters:
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
int32_t HdfWifiEventTimeoutDisconnected (const struct [NetDevice](NetDevice.md) * netdev)
Description:
Reports a timeout disconnection event.
Parameters:
netdev | Indicates the pointer to the network device. This parameter cannot be null. |
Returns:
Returns 0 if the event is reported successfully; returns -1 otherwise.
struct [HdfWifiProductData](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.
struct [WifiMac80211Ops](WifiMac80211Ops.md)* Mac80211GetOps (void )
Description:
Obtains the WifiMac80211Ops object that the driver needs to implement.
Returns:
Returns the pointer to the WifiMac80211Ops object.
int32_t Mac80211RegisterOps (struct [WifiMac80211Ops](WifiMac80211Ops.md) * ops)
Description:
Registers a WifiMac80211Ops object.
Parameters:
ops | Indicates the pointer to the WifiMac80211Ops object to register. |
Returns:
Returns 0 if the WifiMac80211Ops object is registered successfully; returns a non-zero value otherwise.
struct pbuf* NetBuf2Pbuf (const struct [NetBuf](NetBuf.md) * nb)
Description:
Converts a network data buffer to the pbuf structure of Lightweight TCP/IP Stack (lwIP).
Parameters:
nb | Indicates the pointer to the network data buffer. |
Returns:
Returns the pointer to the pbuf structure if the operation is successful; returns NULL otherwise.
struct [NetBuf](NetBuf.md)* NetBufAlloc (uint32_t size)
Description:
Applies for a network data buffer.
Parameters:
size | Indicates the size of the network data buffer. |
Returns:
Returns the pointer to the network data buffer if the operation is successful; returns NULL otherwise.
uint32_t NetBufConcat (struct [NetBuf](NetBuf.md) * nb, struct [NetBuf](NetBuf.md) * cnb )
Description:
Copies data in a network data buffer to another network data buffer.
Parameters:
nb | Indicates the pointer to the network data buffer. |
cnb | Indicates the pointer to the target network data buffer. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
struct [NetBuf](NetBuf.md)* NetBufDevAlloc (const struct [NetDevice](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:
dev | Indicates the pointer to the network device. |
size | Indicates 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.
void NetBufFree (struct [NetBuf](NetBuf.md) * nb)
Description:
Releases a network data buffer.
Parameters:
nb | Indicates the pointer to the network data buffer. |
static uint8_t* NetBufGetAddress (const struct [NetBuf](NetBuf.md) * nb, uint32_t id )
Description:
Obtains the address of a specified buffer segment in a network data buffer.
Parameters:
nb | Indicates the pointer to the network data buffer. |
id | Indicates 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.
static uint32_t NetBufGetDataLen (const struct [NetBuf](NetBuf.md) * nb)
Description:
Obtains the actual data length of the data segment of a network data buffer.
Parameters:
nb | Indicates the pointer to the network data buffer. |
Returns:
Returns the actual data length of the data segment.
static uint32_t NetBufGetRoom (const struct [NetBuf](NetBuf.md) * nb, uint32_t id )
Description:
Obtains the size of a specified buffer segment space in a network data buffer.
Parameters:
nb | Indicates the pointer to the network data buffer. |
id | Indicates 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.
void* NetBufPop (struct [NetBuf](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:
nb | Indicates the pointer to the network data buffer. |
id | Indicates the buffer segment ID. |
len | Indicates 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.
void* NetBufPush (struct [NetBuf](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:
nb | Indicates the pointer to the network data buffer. |
id | Indicates the buffer segment ID. |
len | Indicates 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.
static struct [NetBuf](NetBuf.md)* NetBufQueueAtHead (const struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Obtains the network data buffer from the header of a queue, without deleting it from the queue.
Parameters:
q | Indicates 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.
static struct [NetBuf](NetBuf.md)* NetBufQueueAtTail (const struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Obtains the network data buffer from the tail of a queue, without deleting it from the queue.
Parameters:
q | Indicates 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.
void NetBufQueueClear (struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Clears a network data buffer queue and releases the network data buffer in the queue.
Parameters:
q | Indicates the pointer to the network data buffer queue. |
void NetBufQueueConcat (struct [NetBufQueue](NetBufQueue.md) * q, struct [NetBufQueue](NetBufQueue.md) * add )
Description:
Moves all network data buffers from one queue to another and clears the source queue.
Parameters:
q | Indicates the pointer to the target network data buffer queue. |
add | Indicates the pointer to the source network data buffer queue. |
struct [NetBuf](NetBuf.md)* NetBufQueueDequeue (struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Obtains a network data buffer from the header of a queue and deletes it from the queue.
Parameters:
q | Indicates 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.
struct [NetBuf](NetBuf.md)* NetBufQueueDequeueTail (struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Obtains a network data buffer from the tail of a queue and deletes it from the queue.
Parameters:
q | Indicates 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.
void NetBufQueueEnqueue (struct [NetBufQueue](NetBufQueue.md) * q, struct [NetBuf](NetBuf.md) * nb )
Description:
Adds a network data buffer to the tail of a queue.
Parameters:
q | Indicates the pointer to the network data buffer queue. |
nb | Indicates the pointer to the network data buffer. |
void NetBufQueueEnqueueHead (struct [NetBufQueue](NetBufQueue.md) * q, struct [NetBuf](NetBuf.md) * nb )
Description:
Adds a network data buffer to the header of a queue.
Parameters:
q | Indicates the pointer to the network data buffer queue. |
nb | Indicates the pointer to the network data buffer. |
static void NetBufQueueInit (struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Initializes a network data buffer queue.
Parameters:
q | Indicates the pointer to the network data buffer queue. |
static bool NetBufQueueIsEmpty (const struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Checks whether the network data buffer queue is empty.
Parameters:
q | Indicates the pointer to the network data buffer queue. |
Returns:
Returns true if the queue is empty; returns false otherwise.
static uint32_t NetBufQueueSize (const struct [NetBufQueue](NetBufQueue.md) * q)
Description:
Obtains the size of a network data buffer queue.
Parameters:
q | Indicates the pointer to the network data buffer queue. |
Returns:
Returns the size of the network data buffer queue.
int32_t NetBufResizeRoom (struct [NetBuf](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:
nb | Indicates the pointer to the network data buffer. |
head | Indicates the size of the header buffer segment reserved. |
tail | Indicates the size of the tail buffer segment reserved. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
uint32_t NetDevGetRegisterCount (void )
Description:
Obtains the number of added network devices.
Returns:
Returns the number of added network devices.
int32_t NetDeviceAdd (struct [NetDevice](NetDevice.md) * netDevice, [Protocol80211IfType](WLAN.md#gac69954f56fcc99fc8aac68aa157831c7) ifType )
Description:
Adds a network device to a protocol stack.
Parameters:
netDevice | Indicates the pointer to the network device structure obtained during initialization. |
netDevice | Indicates 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.
int32_t NetDeviceDeInit (struct [NetDevice](NetDevice.md) * netDevice)
Description:
Deletes a network device.
Parameters:
netDevice | Indicates 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.
int32_t NetDeviceDelete (struct [NetDevice](NetDevice.md) * netDevice)
Description:
Deletes a network device from a protocol stack.
Parameters:
netDevice | Indicates 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.
uint32_t NetDeviceGetCap (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.
struct [NetDevice](NetDevice.md)* NetDeviceGetInstByIndex (uint32_t index)
Description:
Obtains a network device instance based on the index number.
Parameters:
index | Indicates the index number. |
Returns:
Returns the network device structure NetDevice if the operation is successful; returns NULL if the operation fails.
struct [NetDevice](NetDevice.md)* NetDeviceGetInstByName (const char * name)
Description:
Obtains the initialized network device instance by a specified device name.
Parameters:
name | Indicates 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.
struct [NetDevice](NetDevice.md)* NetDeviceInit (const char * ifName, uint32_t len, [NetIfCategory](WLAN.md#ga530241881cd17e03f8ae254ef1d9755e) ifCategory )
Description:
Initializes a network device to obtain its instance.
Parameters:
ifName | Indicates the pointer to the network device name. |
len | Indicates the length of the network device name. |
ifCategory | Indicates 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.
bool NetDeviceIsAnyInstRunning (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.
bool NetDeviceIsInstRunning (const struct [NetDevice](NetDevice.md) * netDevice)
Description:
Checks whether a specified network device is working.
Parameters:
netDevice | Indicates the pointer to the network device structure netDevice obtained during initialization. |
Returns:
Returns true if the specified network device is working; returns false otherwise.
int32_t NetIfDhcpIsBound (const struct [NetDevice](NetDevice.md) * netDevice)
Description:
Obtains the DHCP negotiation status of a specified network device.
Parameters:
netDevice | Indicates the pointer to the network device obtained during initialization. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
int32_t NetIfDhcpsStart (const struct [NetDevice](NetDevice.md) * netDevice, char * ip, u16_t ipNum )
Description:
Starts the DHCP server.
Parameters:
netDevice | Indicates the pointer to the network device structure netDevice obtained during initialization. |
beginIp | Indicates the IP address to start. |
ipNum | Indicates the number of IP addresses. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
int32_t NetIfDhcpsStop (const struct [NetDevice](NetDevice.md) * netDevice)
Description:
Stops the DHCP server.
Parameters:
netDevice | Indicates 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.
int32_t NetIfDhcpStart (const struct [NetDevice](NetDevice.md) * netDevice)
Description:
Starts the DHCP client of a specified network device.
Parameters:
netDevice | Indicates the pointer to the network device obtained during initialization. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
int32_t NetIfDhcpStop (const struct [NetDevice](NetDevice.md) * netDevice)
Description:
Stops the DHCP client of a specified network device.
Parameters:
netDevice | Indicates the pointer to the network device obtained during initialization. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
int32_t NetIfRx (const struct [NetDevice](NetDevice.md) * netDevice, struct [NetBuf](NetBuf.md) * buff )
Description:
Transfers the input data packets from the network side to a protocol stack.
Parameters:
buff | Indicates the network-side data, in Ether format. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
int32_t NetIfRxNi (const struct [NetDevice](NetDevice.md) * netDevice, struct [NetBuf](NetBuf.md) * buff )
Description:
Transfers data packets from the network side to a protocol stack in an interrupt processing thread.
Parameters:
buff | Indicates 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.
int32_t NetIfSetAddr (const struct [NetDevice](NetDevice.md) * netDevice, const [IpV4Addr](IpV4Addr.md) * ipAddr, const [IpV4Addr](IpV4Addr.md) * netMask, const [IpV4Addr](IpV4Addr.md) * gw )
Description:
Sets an IP address, mask, and gateway.
Parameters:
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
int32_t NetIfSetLinkStatus (const struct [NetDevice](NetDevice.md) * netDevice, [NetIfLinkStatus](WLAN.md#ga7b1187d116fb065d7927ad9f77edd842) status )
Description:
Notifies the network layer of the data link layer status.
Parameters:
netDevice | Indicates the pointer to the network device obtained during initialization. |
status | status Indicates the data link layer status, as enumerated in NetIfLinkSatus. |
Returns:
Returns 0 if the operation is successful; returns a non-zero value otherwise.
int32_t NetIfSetStatus (const struct [NetDevice](NetDevice.md) * netDevice, [NetIfStatus](WLAN.md#ga0fb482694e5eac3f48c75de1749c8baf) status )
Description:
Notifies the network layer of the network port state.
Parameters:
netDevice | Indicates 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.
struct [NetBuf](NetBuf.md)* Pbuf2NetBuf (const struct [NetDevice](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:
netdev | Indicates the pointer to the network device. |
lwip_buf | Indicates 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.
struct [WifiModule](WifiModule.md)* WifiModuleCreate (const struct HdfConfigWifiModuleConfig * config)
Description:
Creates a WifiModule object based on a specified configuration generated by the HCS.
Parameters:
config | Indicates the pointer to the configuration generated by the HCS. |
Returns:
Returns the created WifiModule object.
void WifiModuleDelete (struct [WifiModule](WifiModule.md) * module)
Description:
Deletes a specified WifiModule object.
Parameters:
module | Indicates the pointer to the WifiModule object to delete. |
uint8_t WifiScanRequest::aborted
Description:
Whether to abort the scan
int32_t(* WifiMac80211Ops::abortScan) ([NetDevice](NetDevice.md) *netDev)
Description:
Stopping a scan
uint32_t TcpHeader::ackNum
Description:
Acknowledgement number
int32_t(* WifiModuleIface::addFeature) (struct [WifiModule](WifiModule.md) *module, uint16_t featureType, struct [WifiFeature](WifiFeature.md) *featureData)
Description:
Adding a feature
int32_t(* WifiMac80211Ops::addKey) (struct [NetDevice](NetDevice.md) *netdev, uint8_t keyIndex, bool pairwise, const uint8_t *macAddr, struct [KeyParams](KeyParams.md) *params)
Description:
Adding a key with specified parameters
uint8_t MacAddress::addr[ETH_ADDR_LEN]
Description:
Device MAC address
uint32_t IpV4Addr::addr
Description:
IPv4 address
uint8_t NetDevice::addrLen
Description:
MAC address length
uint8_t Wiphy::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.
uint16_t AssocResp::aid
Description:
Authentication ID
uint16_t ReassocResp::aid
Description:
Authentication ID
uint32_t CryptoSettings::akmSuites[NL80211_MAX_NR_AKM_SUITES]
Description:
AKM suite data. For details, see NL80211_MAX_NR_AKM_SUITES.
uint8_t Ieee80211StaHtCap::ampduDensity
Description:
Minimum MPDU start spacing
uint8_t Ieee80211StaHtCap::ampduFactor
Description:
Maximum length of an aggregated MAC Protocol Data Unit (A-MPDU)
uint8_t ScannedBssInfo::arry[2]
Description:
Reserved
struct [AssocReq](AssocReq.md) Ieee80211Mgmt::assocReq
Description:
Association request
struct { ... } ::assocReq
Description:
Association request
const uint8_t* StationInfo::assocReqIes
Description:
Information Elements (IEs) in Association Request
uint32_t StationInfo::assocReqIesLen
Description:
IE length in Association Request
struct [AssocResp](AssocResp.md) Ieee80211Mgmt::assocResp
Description:
Association response
struct { ... } ::assocResp
Description:
Association response
uint8_t Mac80211Ssids::aucArry[MAC80211_SSIDS_AUC_SIZE]
Description:
AuC data array
uint8_t WifiConnectParams::aucResv[WIFI_CONNECT_PARM_RESV_SIZE]
Description:
Reserved field
uint8_t Ieee80211StaHtCap::aucRsv[IEEE80211_STAHTCAP_RESV]
Description:
Reserved field
uint8_t Wiphy::aucRsv[WIPHY_RSV_SIZE]
Description:
Manual alignment of data structures
uint8_t Mac80211Ssids::aucSsid[OAL_IEEE80211_MAX_SSID_LEN]
Description:
SSID array
struct { ... } ::auth
Description:
Authentication Information
struct [Auth](Auth.md) Ieee80211Mgmt::auth
Description:
Authentication Information
uint16_t Auth::authAlg
Description:
Authentication algorithm
uint16_t Auth::authTransaction
Description:
Authentication transaction
uint8_t WifiConnectParams::authType
Description:
Authorization type
enum [Ieee80211Band](WLAN.md#ga9882f415202cf9acb0f4cdfbc456a88d) Ieee80211Channel::band
Description:
Frequency band, either 2.4 GHz or 5 GHz
enum [Ieee80211Band](WLAN.md#ga9882f415202cf9acb0f4cdfbc456a88d) Ieee80211SupportedBand::band
Description:
Band matching this data structure description
struct [Ieee80211SupportedBand](Ieee80211SupportedBand.md)* Wiphy::bands[[IEEE80211_NUM_BANDS](WLAN.md#gga9882f415202cf9acb0f4cdfbc456a88da703cf67d516a80d6dae1b1995017b9a4)]
Description:
Supported bands
struct [Beacon](Beacon.md) Ieee80211Mgmt::beacon
Description:
Beacon frame
struct { ... } ::beacon
Description:
Beacon frame
WifiBeaconData* Mac80211beaconParam::beaconData
Description:
Beacon frame data
int8_t Ieee80211Channel::beaconFound
Description:
When a beacon frame is found in this channel
uint16_t Beacon::beaconInt
Description:
Beacon interval
uint16_t ProbeResp::beaconInt
Description:
Beacon interval
uint16_t StaBssParameters::beaconInterval
Description:
Beacon interval
uint32_t StationInfo::beaconLossCount
Description:
Number of beacon loss events triggered
uint16_t Ieee80211Rate::bitrate
Description:
Bit rate, in 100 kbit/s
struct [Ieee80211Rate](Ieee80211Rate.md)* Ieee80211SupportedBand::bitrates
Description:
An array of supported bit rates
uint8_t Ieee80211Mgmt::bssid[6]
Description:
BSS ID
uint8_t ConnetResult::bssid[ETH_ADDR_LEN]
Description:
MAC address of the AP associated with the station
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.
struct [StaBssParameters](StaBssParameters.md) StationInfo::bssParam
Description:
Current BSS parameters
struct BufField NetBuf::bufs[[MAX_BUF_NUM](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.
uint16_t Ieee80211StaHtCap::cap
Description:
HT capability table provided in 802.11n
uint16_t AssocReq::capabInfo
Description:
WLAN capability information
uint16_t AssocResp::capabInfo
Description:
WLAN capability information
uint16_t ReassocReq::capabInfo
Description:
WLAN capability information
uint16_t ReassocResp::capabInfo
Description:
WLAN capability information
uint16_t Beacon::capabInfo
Description:
WLAN capability information
uint16_t ProbeResp::capabInfo
Description:
WLAN capability information
uint16_t Ieee80211Channel::centerFreq
Description:
Center frequency
int32_t ChannelDef::centerFreq1
Description:
Center frequency 1
int32_t ChannelDef::centerFreq2
Description:
Center frequency 2
struct [Ieee80211Channel](Ieee80211Channel.md)* ChannelDef::chan
Description:
Channel information
int32_t(* WifiMac80211Ops::changeBeacon) ([NetDevice](NetDevice.md) *netDev, [Mac80211beaconParam](Mac80211beaconParam.md) *param)
Description:
Setting the beacon frame based on specified parameters
int32_t(* NetDeviceInterFace::changeMtu) (struct [NetDevice](NetDevice.md) *netDev, int32_t newMtu)
Description:
Changes the maximum number of transmission units.
int32_t(* WifiMac80211Ops::changeVirtualIntf) ([NetDevice](NetDevice.md) *netDev, uint8_t iftype, uint32_t *flags, struct [VifParams](VifParams.md) *params)
Description:
Changing virtual APIs
struct [Ieee80211Channel](Ieee80211Channel.md)* WifiConnectParams::channel
Description:
Connection channel. If this parameter is not specified, the connection channel is automatically obtained from the scan result.
struct [Ieee80211Channel](Ieee80211Channel.md)* WifiScanRequest::channels[MAX_SCAN_CHANNELS]
Description:
Channels to scan for. For details, see MAX_SCAN_CHANNELS.
struct [Ieee80211Channel](Ieee80211Channel.md)* Ieee80211SupportedBand::channels
Description:
An array of supported channels
uint16_t IpHeader::check
Description:
Header check
uint16_t UdpHeader::check
Description:
Header check
uint16_t TcpHeader::check
Description:
Checksum
struct [HdfWifiChipData](HdfWifiChipData.md)* WifiFeature::chip
Description:
Chip
uint32_t KeyParams::cipher
Description:
Cipher suite
uint32_t CryptoSettings::cipherGroup
Description:
Cipher group
uint32_t CryptoSettings::ciphersPairwise[NL80211_MAX_NR_CIPHER_SUITES]
Description:
Unicast cipher suite. For details, see NL80211_MAX_NR_CIPHER_SUITES.
const uint32_t* Wiphy::cipherSuites
Description:
Supported cipher suites
int32_t(* WifiMac80211Ops::connect) ([NetDevice](NetDevice.md) *netDev, [WifiConnectParams](WifiConnectParams.md) *param)
Description:
Starting a connection based on the specified parameters
uint32_t StationInfo::connectedTime
Description:
Duration (in seconds) since the last station connection
uint16_t ConnetResult::connectStatus
Description:
Connection status
int8_t CryptoSettings::controlPort
Description:
Whether the user space control port is authorized. The value true indicates that the user space control port is unauthorized.
uint16_t CryptoSettings::controlPortEthertype
Description:
Data can be transmitted over an unauthenticated port.
int8_t CryptoSettings::controlPortNoEncrypt
Description:
Whether to encrypt frames transmitted over the control port. The value 1 indicates that the frames are not encrypted.
struct [CryptoSettings](CryptoSettings.md) WifiConnectParams::crypto
Description:
Cryptography information
uint8_t ReassocReq::currentAp[6]
Description:
Current AP
uint32_t IpHeader::dAddr
Description:
Destination address
uint32_t NetBuf::dataLen
Description:
Actual data length of the network data buffer
struct [Deauth](Deauth.md) Ieee80211Mgmt::deauth
Description:
Deauthentication Information
struct { ... } ::deauth
Description:
Deauthentication Information
int32_t(* HdfWifiChipData::deinit) (struct [HdfWifiChipData](HdfWifiChipData.md) *chipData)
Description:
Function for deinitializing the chip
void(* NetDeviceInterFace::deInit) (struct [NetDevice](NetDevice.md) *netDev)
Description:
Deinitializes a network device to be delete.
int32_t(* WifiFeature::deInit) (struct [WifiFeature](WifiFeature.md) *feature)
Description:
Function for deinitializing the feature
int32_t(* WifiModuleIface::deInit) (struct [WifiModule](WifiModule.md) *module)
Description:
Deinitializing a WLAN module
int32_t(* WifiModuleIface::delFeature) (struct [WifiModule](WifiModule.md) *module, uint16_t featureType)
Description:
Deleting a feature
int32_t(* WifiMac80211Ops::delKey) (struct [NetDevice](NetDevice.md) *netdev, uint8_t keyIndex, bool pairwise, const uint8_t *macAddr)
Description:
Deleting a key based on a specified MAC address
int32_t(* WifiMac80211Ops::delStation) ([NetDevice](NetDevice.md) *netDev, const uint8_t *macAddr)
Description:
Deleting a station with a specified MAC address
uint16_t UdpHeader::dest
Description:
Destination port number
void* NetBuf::dev
Description:
Network device that receives the network data
struct [NetDevice](NetDevice.md)* WifiScanRequest::dev
Description:
A specified network device to scan for
struct [HdfDeviceObject](HdfDeviceObject.md)* HdfWifiProductData::device
Description:
Structure of the Device Object
struct { ... } ::disassoc
Description:
Disconnected
struct [Disassoc](Disassoc.md) Ieee80211Mgmt::disassoc
Description:
Disconnected
int32_t(* WifiMac80211Ops::disconnect) ([NetDevice](NetDevice.md) *netDev, uint16_t reasonCode)
Description:
Canceling a connection
struct [DListHead](DListHead.md) NetBuf::dlist
Description:
Doubly linked list. Generally, multiple network data buffers are linked by using a doubly linked list.
struct [DListHead](DListHead.md) NetBufQueue::dlist
Description:
Doubly linked list. Generally, multiple network data buffers are linked by using a doubly linked list.
uint16_t TcpHeader::dPort
Description:
Destination port number
uint8_t Ieee80211Mgmt::dstAddr[6]
Description:
Destination MAC address
uint8_t StaBssParameters::dtimPeriod
Description:
Delivery Traffic Indication Message (DTIM) period of BSS
int32_t Mac80211beaconParam::dtimPeriod
Description:
Delivery Traffic Indication Message (DTIM) interval
uint16_t Ieee80211Mgmt::duration
Description:
Duration
uint8_t EtherHeader::etherDhost[[MAC_ADDR_SIZE](WLAN.md#gae01dbae885bc8abecb82bd865515c081)]
Description:
Destination address MAC_ADDR_SIZE
uint8_t EtherHeader::etherShost[[MAC_ADDR_SIZE](WLAN.md#gae01dbae885bc8abecb82bd865515c081)]
Description:
Source address MAC_ADDR_SIZE
uint16_t EtherHeader::etherType
Description:
Ethernet type, such as 0x8035 (RARP), 0x888e (EAPOL), PAE/802.1x, 0x0800 (IP), 0x86dd (IPV6), and 0x0806 (ARP)
uint32_t IfReq::fake
Description:
magic field
struct [WifiFeature](WifiFeature.md)* WifiFeatureList::fe[[HDF_WIFI_FEATURE_NUM](WLAN.md#ggaec03ba36d71cc2d5f3209bc24aa6ee10a28ff5971d579c1754e03a5f79a0c9e6f)]
Description:
An array of WLAN features
struct [WifiFeatureList](WifiFeatureList.md)* WifiModule::feList
Description:
WLAN features
uint32_t StationInfo::filled
Description:
Flag values of relevant structures
uint8_t RateInfo::flags
Description:
Flag field, used to indicate a specific rate transmission type of 802.11n
uint8_t StaBssParameters::flags
Description:
Flag, used to indicate a specific rate transmission type of 802.11n
uint32_t Ieee80211Channel::flags
Description:
WLAN channel flag
uint32_t Ieee80211Rate::flags
Description:
Rate flag
uint32_t Wiphy::flags
Description:
Wiphy device attributes
uint8_t TcpHeader::flags
Description:
Flags
uint32_t NetDevice::flags
Description:
Network port status
uint16_t IpHeader::fragInfo
Description:
Fragmentation information
uint32_t Wiphy::fragThreshold
Description:
Fragment threshold
uint16_t Ieee80211Mgmt::frameControl
Description:
Frame control field
int16_t ScannedBssInfo::freq
Description:
Center frequency of the channel where the BSS is located
uint16_t ConnetResult::freq
Description:
Frequency of the AP
[IfType](IfType.md) NetDevice::funType
Description:
Network port type
int32_t StationInfo::generation
Description:
Generation number
struct [WifiModule](WifiModule.md)*(* WifiModuleIface::getModule) (void)
Description:
Obtaining a WLAN module
struct NetDevStats*(* NetDeviceInterFace::getStats) (struct [NetDevice](NetDevice.md) *netDev)
Description:
Obtains the statistics.
uint16_t NetDevice::hardHeaderLen
Description:
Header length
uint8_t Mac80211beaconParam::hiddenSsid
Description:
Whether to hide the SSID
const struct HdfConfigWifiModuleConfig* WifiModuleConfig::hslConfig
Description:
Configuration of each feature of the WLAN module
struct [Ieee80211StaHtCap](Ieee80211StaHtCap.md) Ieee80211SupportedBand::htCap
Description:
HT capability
uint8_t Ieee80211StaHtCap::htSupported
Description:
Whether the station supports HT
uint16_t Ieee80211Channel::hwValue
Description:
Hardware information
uint16_t Ieee80211Rate::hwValue
Description:
Hardware information
uint16_t Ieee80211Rate::hwValueShort
Description:
Hardware information specified when a short preamble is used
uint16_t IpHeader::id
Description:
Each data packet sent by the host
uint8_t* WifiScanRequest::ie
Description:
IEEE 802.11 buffer
uint8_t* WifiConnectParams::ie
Description:
IEEE 802.11 information required for the connection
struct [WirelessDev](WirelessDev.md)* NetDevice::ieee80211Ptr
Description:
Pointer to a wireless device
uint32_t WifiScanRequest::ieLen
Description:
IEEE 802.11 buffer length
uint32_t WifiConnectParams::ieLen
Description:
IEEE 802.11 length
struct [WifiModuleIface](WifiModuleIface.md)* WifiModule::iface
Description:
APIs
uint8_t* IfReq::ifrData
Description:
Data pointer
uint8_t WirelessDev::iftype
Description:
API type
uint32_t StationInfo::inactiveTime
Description:
Duration (in milliseconds) since the last station activity
int32_t(* HdfWifiChipData::init) (struct [HdfWifiChipData](HdfWifiChipData.md) *chipData, const struct HdfConfigWifiChip *chipConfig)
Description:
Function for initializing the chip
int32_t(* NetDeviceInterFace::init) (struct [NetDevice](NetDevice.md) *netDev)
Description:
Initializes a network device to be added.
int32_t(* WifiFeature::init) (struct [WifiFeature](WifiFeature.md) *feature)
Description:
Function for initializing the feature
int32_t(* WifiModuleIface::init) (struct [WifiModule](WifiModule.md) *module)
Description:
Initializing a WLAN module
uint16_t Wiphy::interfaceModes
Description:
Bitmask of an API type that is valid for the wiphy device
int32_t Mac80211beaconParam::interval
Description:
Beacon interval
int32_t(* NetDeviceInterFace::ioctl) (struct [NetDevice](NetDevice.md) *netDev, [IfReq](IfReq.md) *req, int32_t cmd)
Description:
Used for the control command word.
uint32_t NetDevNotify::ipAddr
Description:
IP address
uint8_t* KeyParams::key
Description:
Key content
const uint8_t* WifiConnectParams::key
Description:
Wired Equivalent Privacy (WEP) key used for Shared Key Authentication (SKA)
uint8_t WifiConnectParams::keyIdx
Description:
Index of the WEP key used for SKA
int32_t KeyParams::keyLen
Description:
Key length
uint8_t WifiConnectParams::keyLen
Description:
Key length
uint32_t NetDevice::lastRxTime
Description:
Last time when data is received
uint16_t RateInfo::legacy
Description:
100 kbit/s bit rate defined in 802.11a/b/g
uint32_t NetBuf::len
Description:
Length of the memory buffer
uint16_t UdpHeader::len
Description:
Length of a data packet
[NetLinkType](WLAN.md#gad3175955d2e6ef3c4f52da9b509d5b4a) NetDevice::LinkLayerType
Description:
Data link layer type
uint16_t AssocReq::listenInterval
Description:
Scan interval
uint16_t ReassocReq::listenInterval
Description:
Scan interval
uint16_t StationInfo::llid
Description:
Local mesh ID
struct Spinlock NetBufQueue::lock
Description:
Queue operation lock
uint8_t MacConfigParam::mac[WLAN_MAC_ADDR_LEN]
Description:
MAC address. For details about its length, see WLAN_MAC_ADDR_LEN.
const uint8_t* StationDelParameters::mac
Description:
MAC address of the station to which the connection is to be canceled
char NetDevice::macAddr[[MAC_ADDR_SIZE](WLAN.md#gae01dbae885bc8abecb82bd865515c081)]
Description:
MAC address MAC_ADDR_SIZE
uint8_t Mac80211DisconnectParam::macAddr[WLAN_MAC_ADDR_LEN]
Description:
Device MAC address
uint8_t* VifParams::macAddr
Description:
MAC address
uint32_t StaFlagUpdate::mask
Description:
Flag mask
int32_t Ieee80211Channel::maxAntennaGain
Description:
Maximum antenna gain, in dBi
int32_t Ieee80211Channel::maxPower
Description:
Maximum transmit power, in dBm
uint16_t Wiphy::maxScanIeLen
Description:
Maximum SSID length
uint8_t Wiphy::maxScanSsids
Description:
Maximum number of scanned service set identifiers (SSIDs)
uint8_t RateInfo::mcs
Description:
Modulation and Coding Scheme (MCS) index of the HT/VHT/HE rate
struct [Ieee80211McsInfo](Ieee80211McsInfo.md) Ieee80211StaHtCap::mcs
Description:
MCS rate
uint8_t* NetBuf::mem
Description:
Memory buffer address
uint8_t WifiConnectParams::mfp
Description:
Whether to enable Management Frame Protection (MFP)
struct [Ieee80211Mgmt](Ieee80211Mgmt.md)* ScannedBssInfo::mgmt
Description:
Start address of the management frame
uint32_t ScannedBssInfo::mgmtLen
Description:
Management frame length
void* NetDevice::mlPriv
Description:
Private structure for the driver
struct [WifiModule](WifiModule.md)* HdfWifiProductData::module
Description:
Structure of the WLAN module
struct [WifiModuleConfig](WifiModuleConfig.md) WifiModule::moduleConfig
Description:
Module configurations
void* WifiModule::modulePrivate
Description:
Private data
uint32_t NetDevice::mtu
Description:
Maximum transmission unit
int32_t CryptoSettings::n_akmSuites
Description:
Number of authentication and key management (AKM) suites
int32_t CryptoSettings::n_ciphersPairwise
Description:
Number of unicast ciphers supported by the access point (AP)
char NetDevice::name[IFNAMSIZ]
Description:
Network device name IFNAMSIZ
char WifiFeature::name[[MAX_WIFI_COMPONENT_NAME_LEN](WLAN.md#gaf460a45a5e365279ca6bc5b3e8750542)]
Description:
Feature name, which can contain a maximum of 10 characters
char HdfWifiChipData::name[[MAX_WIFI_COMPONENT_NAME_LEN](WLAN.md#gaf460a45a5e365279ca6bc5b3e8750542)]
Description:
Chip name
int32_t Ieee80211SupportedBand::nBitrates
Description:
Length of the array of supported bit rates
int32_t Ieee80211SupportedBand::nChannels
Description:
Length of the array of supported channels
uint32_t WifiScanRequest::nChannels
Description:
Number of channels to scan for
int32_t Wiphy::nCipherSuites
Description:
Number of supported cipher suites
uint16_t NetDevice::neededHeadRoom
Description:
Length reserved for the header in netbuffNetBuf
uint16_t NetDevice::neededTailRoom
Description:
Length reserved for the tail in netbuffNetBuf
struct [NetDevice](NetDevice.md)* WirelessDev::netdev
Description:
Network device
struct [NetDeviceInterFace](NetDeviceInterFace.md)* NetDevice::netDeviceIf
Description:
Network device interface
[NetIfCategory](WLAN.md#ga530241881cd17e03f8ae254ef1d9755e) NetDevice::netifCateg
Description:
Network interface category NetIfCategory
uint32_t(* NetDeviceInterFace::netifNotify) (struct [NetDevice](NetDevice.md) *netDev, [NetDevNotify](NetDevNotify.md) *notify)
Description:
Notifies the network port status.
uint32_t NetDevNotify::notifyType
Description:
Notification type (reserved)
uint8_t RateInfo::nss
Description:
Number of streams (for VHT and HE only)
uint32_t WifiScanRequest::nSsids
Description:
Number of SSIDs to scan for
int64_t StationInfo::offset
Description:
Time offset of station
uint8_t TcpHeader::offset
Description:
Header length
int32_t(* NetDeviceInterFace::open) (struct [NetDevice](NetDevice.md) *netDev)
Description:
Opens the data link layer.
uint8_t Mac80211beaconParam::operationType
Description:
Operation type
struct [WifiMac80211Ops](WifiMac80211Ops.md)* HdfWifiChipData::ops
Description:
Chip MAC address
uint32_t Ieee80211Channel::origFlags
Description:
Channel flags
int32_t Ieee80211Channel::origMag
Description:
Reserved field
int32_t Ieee80211Channel::origMpwr
Description:
Reserved field
struct [NetDevice](NetDevice.md)* NetDevice::owner
Description:
Network device
uint8_t MacConfigParam::p2pMode
Description:
Whether the peer-to-peer (P2P) mode is used.
uint8_t Wiphy::permAddr[WLAN_MAC_ADDR_LEN]
Description:
Permanent MAC address of the wiphy device. For its length, see WLAN_MAC_ADDR_LEN.
uint16_t StationInfo::plid
Description:
Peer mesh ID
uint8_t StationInfo::plinkState
Description:
Mesh peer state
uint8_t WifiScanRequest::prefixSsidScanFlag
Description:
Reserved field
struct [ChannelDef](ChannelDef.md) WirelessDev::presetChandef
Description:
Channel information
uint8_t Wiphy::priv[WIPHY_PRIV_SIZE]
Description:
Reserved field
uint8_t WifiConnectParams::privacy
Description:
Whether to use a privacy-enabled AP
struct { ... } ::probeResp
Description:
Probe response frame
struct [ProbeResp](ProbeResp.md) Ieee80211Mgmt::probeResp
Description:
Probe response frame
char HdfWifiProductData::product_name[[MAX_WIFI_COMPONENT_NAME_LEN](WLAN.md#gaf460a45a5e365279ca6bc5b3e8750542)]
Description:
WLAN module name, which contains a maximum of 10 bytes
uint8_t IpHeader::protocol
Description:
Protocol, such as 1 (ICMP), 2 (IGMP), 6 (TCP), 17 (UDP), and 89 (OSPF)
uint32_t NetBuf::qmap
Description:
Queue mappings of the network data buffer
uint16_t Deauth::reasonCode
Description:
Deauthentication cause code
uint16_t Disassoc::reasonCode
Description:
Cause code
uint16_t StationDelParameters::reasonCode
Description:
Cause of the cancellation
uint16_t Mac80211DisconnectParam::reasonCode
Description:
Disconnection reason code
struct { ... } ::reassocReq
Description:
Re-authentication
struct [ReassocReq](ReassocReq.md) Ieee80211Mgmt::reassocReq
Description:
Re-authentication
struct [ReassocResp](ReassocResp.md) Ieee80211Mgmt::reassocResp
Description:
Re-authentication response
struct { ... } ::reassocResp
Description:
Re-authentication response
uint8_t* ConnetResult::reqIe
Description:
Association request IE
uint32_t ConnetResult::reqIeLen
Description:
Length of the association request IE
uint8_t Ieee80211McsInfo::reserved[IEEE80211_MACINFO_RESV]
Description:
Reserved field
uint8_t Ieee80211Channel::resv[IEEE80211_CHANNEL_RESV]
Description:
Reserved field
uint8_t WifiScanRequest::resv[SCAN_REQUEST_RESV_SIZE]
Description:
Reserved field
uint8_t WirelessDev::resv[WIRELESS_DEV_RESV_SIZE]
Description:
Reserved field
uint8_t RateInfo::resv
Description:
Reserved
uint8_t StationInfo::resv1
Description:
Reserved
uint8_t* ConnetResult::rspIe
Description:
Association response IE
uint32_t ConnetResult::rspIeLen
Description:
Length of the association response IE
uint8_t Ieee80211Rate::rsv[IEEE80211_RATE_RESV]
Description:
Reserved field
uint8_t NetBuf::rsv[[MAX_NETBUF_RESEVER_SIZE](WLAN.md#ga794c035a19a38acc000146a8f9a4ec80)]
Description:
Reserved field. For details, see MAX_NETBUF_RESEVER_SIZE.
uint32_t Wiphy::rtsThreshold
Description:
Request To Send (RTS) threshold
uint64_t StationInfo::rxBytes
Description:
Received bytes
uint32_t NetDevStats::rxBytes
Description:
Total number of received bits
uint32_t NetDevStats::rxDropped
Description:
Packets that are dropped after being received
uint32_t StationInfo::rxDroppedMisc
Description:
Number of receive failures
uint32_t NetDevStats::rxErrors
Description:
Number of received error packets
uint16_t Ieee80211McsInfo::rxHighest
Description:
Maximum rate for receiving data
uint8_t Ieee80211McsInfo::rxMask[IEEE80211_HT_MCS_MASK_LEN]
Description:
Mask for receiving data
uint32_t StationInfo::rxPackets
Description:
Received data packets
uint32_t NetDevStats::rxPackets
Description:
Total number of received packets
struct [RateInfo](RateInfo.md) StationInfo::rxRate
Description:
Receive rate
uint32_t IpHeader::sAddr
Description:
Source address
uint16_t(* NetDeviceInterFace::selectQueue) (struct [NetDevice](NetDevice.md) *netDev, struct [NetBuf](NetBuf.md) *netBuff)
Description:
Selects a priority queue.
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
uint16_t Ieee80211Mgmt::seqCtrl
Description:
Sequence control
int32_t KeyParams::seqLen
Description:
Length of a TKIP or CCMP key
uint32_t TcpHeader::seqNum
Description:
Sequence number
uint32_t StaFlagUpdate::set
Description:
Flag value
int32_t(* WifiMac80211Ops::setChannel) ([NetDevice](NetDevice.md) *netDev)
Description:
Setting the channel
int32_t(* WifiMac80211Ops::setDefaultKey) (struct [NetDevice](NetDevice.md) *netdev, uint8_t keyIndex, bool unicast, bool multicas)
Description:
Setting the default key
int32_t(* WifiMac80211Ops::setMacAddr) ([NetDevice](NetDevice.md) *netDev, [Mac80211SetMacParam](WLAN.md#ga85f7d8a3795887f090e0a6439b1df6e1) *param)
Description:
Setting the MAC address
int32_t(* NetDeviceInterFace::setMacAddr) (struct [NetDevice](NetDevice.md) *netDev, void *addr)
Description:
Sets the MAC address.
int32_t(* WifiMac80211Ops::setMeshId) ([NetDevice](NetDevice.md) *netDev, const char *meshId, uint32_t meshIdLen)
Description:
Setting the mesh ID
void(* NetDeviceInterFace::setNetIfStatus) (struct [NetDevice](NetDevice.md) *netDev, [NetIfStatus](WLAN.md#ga0fb482694e5eac3f48c75de1749c8baf) status)
Description:
Sets the network port status.
int32_t(* WifiMac80211Ops::setSsid) ([NetDevice](NetDevice.md) *netDev, const uint8_t *ssid, uint32_t ssidLen)
Description:
Setting the SSID
int8_t StationInfo::signal
Description:
Signal strength
int32_t ScannedBssInfo::signal
Description:
Signal strength
int8_t StationInfo::signalAvg
Description:
Average signal strength
uint8_t Wiphy::signalType
Description:
Signal type
uint32_t NetBufQueue::size
Description:
Number of network data buffers in the queue
uint16_t UdpHeader::source
Description:
Source port number
[ProcessingResult](WLAN.md#ga9c1d6e7df4468671742cb76f72b67af1)(* NetDeviceInterFace::specialEtherTypeProcess) (const struct [NetDevice](NetDevice.md) *netDev, struct [NetBuf](NetBuf.md) *buff)
Description:
Performs private processing without involving network-layer data.
void* NetDevice::specialProcPriv
Description:
Private structure for data processing
uint16_t TcpHeader::sPort
Description:
Source port number
uint8_t Ieee80211Mgmt::srcAddr[6]
Description:
Source MAC address
uint8_t WifiSsid::ssid[IEEE80211_MAX_SSID_LEN]
Description:
SSID content, which contains a maximum of 32 bytes
uint8_t* WifiConnectParams::ssid
Description:
SSID
uint8_t WifiSsid::ssidLen
Description:
SSID length
uint32_t WifiConnectParams::ssidLen
Description:
SSID length
uint8_t Mac80211Ssids::ssidLen
Description:
SSID length
struct [WifiSsid](WifiSsid.md)* WifiScanRequest::ssids
Description:
SSIDs to scan for
struct [StaFlagUpdate](StaFlagUpdate.md) StationInfo::staFlags
Description:
Station flag masks and values
int32_t(* WifiMac80211Ops::startAp) ([NetDevice](NetDevice.md) *netDev)
Description:
Starting an AP
int32_t(* WifiMac80211Ops::startScan) ([NetDevice](NetDevice.md) *netDev, struct [WifiScanRequest](WifiScanRequest.md) *param)
Description:
Starting a scan based on the specified parameters
char HdfWifiProductData::state
Description:
WLAN module state
struct NetDevStats NetDevice::stats
Description:
Network statistics
uint16_t Auth::statusCode
Description:
Authentication status code
uint16_t AssocResp::statusCode
Description:
Status code
uint16_t ReassocResp::statusCode
Description:
Status code
uint16_t ConnetResult::statusCode
Description:
16-bit status code defined in the IEEE protocol
int32_t(* NetDeviceInterFace::stop) (struct [NetDevice](NetDevice.md) *netDev)
Description:
Closes the data link layer.
int32_t(* WifiMac80211Ops::stopAp) ([NetDevice](NetDevice.md) *netDev)
Description:
Stopping an AP
uint8_t StationDelParameters::subtype
Description:
Cancellation type
uint64_t Beacon::timestamp
Description:
Timestamp
uint64_t ProbeResp::timestamp
Description:
Timestamp
uint8_t IpHeader::tos
Description:
Service type
uint16_t IpHeader::totLen
Description:
Total length of an IP data packet
uint8_t IpHeader::ttl
Description:
Generation time
uint64_t StationInfo::txBytes
Description:
Transmitted bytes
uint32_t NetDevStats::txBytes
Description:
Total number of transmitted bits
uint32_t NetDevStats::txDropped
Description:
Packets dropped before transmission
uint32_t NetDevStats::txErrors
Description:
Transmitted error packets
uint32_t StationInfo::txFailed
Description:
Number of failed transmissions
uint32_t StationInfo::txPackets
Description:
Transmitted data packets
uint32_t NetDevStats::txPackets
Description:
Total number of transmitted packets
uint8_t Ieee80211McsInfo::txParams
Description:
Parameters for sending data
uint32_t StationInfo::txPetries
Description:
Number of retransmissions
struct [RateInfo](RateInfo.md) StationInfo::txRate
Description:
Transmission rate
uint16_t HdfWifiChipData::type
Description:
Chip type
int32_t(* WifiModuleIface::updateModule) (struct [WifiModule](WifiModule.md) *module)
Description:
Updating a WLAN module based on a specified configuration.
uint16_t TcpHeader::urgent
Description:
Urgent pointer
int32_t VifParams::use4Addr
Description:
Whether to use a frame containing four addresses
uint8_t Auth::variable[0]
Description:
Algorithm challenge information stored in a flexible array
uint8_t AssocReq::variable[0]
Description:
SSID and rate information stored in a flexible array
uint8_t AssocResp::variable[0]
Description:
Rate information stored in a flexible array
uint8_t ReassocReq::variable[0]
Description:
SSID and rate information stored in a flexible array
uint8_t ReassocResp::variable[0]
Description:
Rate information stored in a flexible array
uint8_t Beacon::variable[0]
Description:
SSID and rate information
uint8_t ProbeResp::variable[0]
Description:
SSID and rate information
uint8_t IpHeader::versionAndHl
Description:
Version and header length
int32_t NetDevice::watchdogTime
Description:
Watchdog duration
struct [WirelessDev](WirelessDev.md)* WifiScanRequest::wdev
Description:
A specified wireless device to scan for
enum [WifiChannelType](WLAN.md#ga9d902b330de99c24b2a8c3ba7120af21) ChannelDef::width
Description:
Bandwidth
uint16_t TcpHeader::window
Description:
Window size
struct [Wiphy](Wiphy.md)* WirelessDev::wiphy
Description:
Wiphy device
struct [Wiphy](Wiphy.md)* WifiScanRequest::wiphy
Description:
A specified wiphy device to scan for
[Protocol80211IfType](WLAN.md#gac69954f56fcc99fc8aac68aa157831c7) IfType::wlanType
Description:
WLAN network port type: AP or STA
uint32_t CryptoSettings::wpaVersions
Description:
WPA version
[NetDevTxResult](WLAN.md#ga9fb4e578a15db1b0087d7b3831591ced)(* NetDeviceInterFace::xmit) (struct [NetDevice](NetDevice.md) *netDev, struct [NetBuf](NetBuf.md) *netBuff)
Description:
Sends data.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。