Mistake on this page?
Report an issue in GitHub or email us
Modules | Data Structures | Macros | Typedefs | Functions
WHD Network Interface API

Allows WHD to pass received data to the network stack, to send an ethernet frame to WHD, etc. More...

Modules

 Flags
 
 MIB2 statistics
 

Data Structures

struct  whd_netif_funcs
 Contains functions which allows WHD to pass received data to the network stack, to send an ethernet frame to WHD, etc. More...
 
union  netif_ext_callback_args_t
 Argument supplied to netif_ext_callback_fn. More...
 

Macros

#define netif_is_up(netif)   (((netif)->flags & NETIF_FLAG_UP) ? (u8_t)1 : (u8_t)0)
 Ask if an interface is up. More...
 

Typedefs

typedef u16_t netif_nsc_reason_t
 Extended netif status callback (NSC) reasons flags. More...
 
typedef void(* netif_ext_callback_fn) (struct netif *netif, netif_nsc_reason_t reason, const netif_ext_callback_args_t *args)
 Function used for extended netif status callbacks Note: When parsing reason argument, keep in mind that more reasons may be added in the future! More...
 

Functions

void whd_network_send_ethernet_data (whd_interface_t ifp, whd_buffer_t buffer)
 To send an ethernet frame to WHD (called by the Network Stack) More...
 

Detailed Description

Allows WHD to pass received data to the network stack, to send an ethernet frame to WHD, etc.

Macro Definition Documentation

#define netif_is_up (   netif)    (((netif)->flags & NETIF_FLAG_UP) ? (u8_t)1 : (u8_t)0)

Ask if an interface is up.

Definition at line 470 of file netif.h.

Typedef Documentation

typedef void(* netif_ext_callback_fn) (struct netif *netif, netif_nsc_reason_t reason, const netif_ext_callback_args_t *args)

Function used for extended netif status callbacks Note: When parsing reason argument, keep in mind that more reasons may be added in the future!

Parameters
netifnetif that is affected by change
reasonchange reason
argsdepends on reason, see reason description

Definition at line 653 of file netif.h.

typedef u16_t netif_nsc_reason_t

Extended netif status callback (NSC) reasons flags.

May be extended in the future!

Definition at line 573 of file netif.h.

Function Documentation

void whd_network_send_ethernet_data ( whd_interface_t  ifp,
whd_buffer_t  buffer 
)

To send an ethernet frame to WHD (called by the Network Stack)

This function takes ethernet data from the network stack and queues it for transmission over the wireless network. The function can be called from any thread context as it is thread safe, however it must not be called from interrupt context since it might get blocked while waiting for a lock on the transmit queue.

This function returns immediately after the packet has been queued for transmit, NOT after it has been transmitted. Packet buffers passed to the WHD are released inside the WHD once they have been transmitted.

Parameters
ifpPointer to handle instance of whd interface
bufferHandle of the packet buffer to be sent.
Returns
WHD_SUCCESS or Error code
Important Information for this Arm website

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