Morse Micro IoT SDK  2.10.4
mmwlan_tx_metadata Struct Reference

Detailed Description

Metadata for TX packets.

This structure should be initialized using MMWLAN_TX_METADATA_INIT for sensible default values, particularly for forward compatibility with new releases that may add new fields to the struct. For example:

enum mmwlan_status status;
// HERE: initialize metadata
status = mmwlan_tx_pkt(pkt, &metadata);
enum mmwlan_status mmwlan_tx_pkt(struct mmpkt *pkt, const struct mmwlan_tx_metadata *metadata)
Transmit the given packet.
#define MMWLAN_TX_METADATA_INIT
Initializer for mmwlan_tx_metadata.
Definition: mmwlan.h:2832
mmwlan_status
Enumeration of status return codes.
Definition: mmwlan.h:51
Metadata for TX packets.
Definition: mmwlan.h:2807

Definition at line 2806 of file mmwlan.h.

#include <mmwlan.h>

Data Fields

uint8_t tid
 Traffic ID (TID) to use. More...
 
enum mmwlan_vif vif
 VIF to transmit on. More...
 
const uint8_t * ra
 Optional Receiver Address (RA). More...
 

Field Documentation

◆ ra

const uint8_t* mmwlan_tx_metadata::ra

Optional Receiver Address (RA).

May be NULL, in which case the Receiver Address will be derived from the Destination Address (DA), if possible.

Definition at line 2826 of file mmwlan.h.

◆ tid

uint8_t mmwlan_tx_metadata::tid

Traffic ID (TID) to use.

Must be less than or equal to MMWLAN_MAX_QOS_TID.

See also
MMWLAN_TX_DEFAULT_QOS_TID

Definition at line 2812 of file mmwlan.h.

◆ vif

enum mmwlan_vif mmwlan_tx_metadata::vif

VIF to transmit on.

If MMWLAN_VIF_UNSPECIFIED then the transmit function will attempt to infer the VIF.

If the specified VIF is not active, or MMWLAN_VIF_UNSPECIFIED is given and a VIF could not be automatically inferred, this will result in transmit failure with error code MMWLAN_VIF_ERROR.

Definition at line 2822 of file mmwlan.h.


The documentation for this struct was generated from the following file: