nRF70 Offloaded raw TX API

File containing API's for the Offloaded raw TX feature. More...

Data Structures
struct	nrf_wifi_off_raw_tx_stats
	This structure defines the Offloaded raw tx debug statistics. More...
struct	nrf_wifi_off_raw_tx_conf
	Configuration parameters for offloaded raw TX Parameters which can be used to configure the offloaded raw TX operation. More...

Macros
#define	NRF_WIFI_OFF_RAW_TX_FRAME_SIZE_MIN   26
#define	NRF_WIFI_OFF_RAW_TX_FRAME_SIZE_MAX   600
#define	NRF_WIFI_COUNTRY_CODE_LEN   2

Enumerations
enum	nrf_wifi_off_raw_tx_rate {   RATE_1M , RATE_2M , RATE_5_5M , RATE_11M ,   RATE_6M , RATE_9M , RATE_12M , RATE_18M ,   RATE_24M , RATE_36M , RATE_48M , RATE_54M ,   RATE_MCS0 , RATE_MCS1 , RATE_MCS2 , RATE_MCS3 ,   RATE_MCS4 , RATE_MCS5 , RATE_MCS6 , RATE_MCS7 ,   RATE_MAX }
	Transmission rates Rate to be used for transmitting a packet. More...
enum	nrf_wifi_off_raw_tx_he_gi { HE_GI_800NS , HE_GI_1600NS , HE_GI_3200NS , HE_GI_MAX }
	HE guard interval value Value of the guard interval to be used between symbols when transmitting using HE. More...
enum	nrf_wifi_off_raw_tx_he_ltf { HE_LTF_3200NS , HE_LTF_6400NS , HE_LTF_12800NS , HE_LTF_MAX }
	HE long training field duration Value of the long training field duration to be used when transmitting using HE. More...
enum	nrf_wifi_off_raw_tx_tput_mode {   TPUT_MODE_LEGACY , TPUT_MODE_HT , TPUT_MODE_VHT , TPUT_MODE_HE_SU ,   TPUT_MODE_HE_ER_SU , TPUT_MODE_HE_TB , TPUT_MODE_MAX }
	Throughput mode Throughput mode to be used for transmitting the packet. More...

Functions
int	nrf70_off_raw_tx_init (uint8_t *mac_addr, unsigned char *country_code)
	Initialize the nRF70 for operating in the offloaded raw TX mode.
void	nrf70_off_raw_tx_deinit (void)
	Initialize the nRF70 for operating in the offloaded raw TX mode.
int	nrf70_off_raw_tx_conf_update (struct nrf_wifi_off_raw_tx_conf *conf)
	Update the configured offloaded raw TX parameters.
int	nrf70_off_raw_tx_start (struct nrf_wifi_off_raw_tx_conf *conf)
	Start the offloaded raw TX.
int	nrf70_off_raw_tx_stop (void)
	Stop the offloaded raw TX.
int	nrf70_off_raw_tx_mac_addr_get (uint8_t *mac_addr)
	Get the MAC address of the nRF70 device.
int	nrf70_off_raw_tx_stats (struct nrf_wifi_off_raw_tx_stats *off_raw_tx_stats)
	Get statistics of the offloaded raw TX.

Detailed Description

File containing API's for the Offloaded raw TX feature.

Macro Definition Documentation

NRF_WIFI_COUNTRY_CODE_LEN

#define NRF_WIFI_COUNTRY_CODE_LEN   2

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

NRF_WIFI_OFF_RAW_TX_FRAME_SIZE_MAX

#define NRF_WIFI_OFF_RAW_TX_FRAME_SIZE_MAX   600

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

NRF_WIFI_OFF_RAW_TX_FRAME_SIZE_MIN

#define NRF_WIFI_OFF_RAW_TX_FRAME_SIZE_MIN   26

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Enumeration Type Documentation

nrf_wifi_off_raw_tx_he_gi

enum nrf_wifi_off_raw_tx_he_gi

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

• HE guard interval value Value of the guard interval to be used between symbols when transmitting using HE.

Enumerator
HE_GI_800NS	800 ns
HE_GI_1600NS	1600 ns
HE_GI_3200NS	3200 ns
HE_GI_MAX	Invalid value.

nrf_wifi_off_raw_tx_he_ltf

enum nrf_wifi_off_raw_tx_he_ltf

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

• HE long training field duration Value of the long training field duration to be used when transmitting using HE.

Enumerator
HE_LTF_3200NS	3.2us
HE_LTF_6400NS	6.4us
HE_LTF_12800NS	12.8us
HE_LTF_MAX	Invalid value.

nrf_wifi_off_raw_tx_rate

enum nrf_wifi_off_raw_tx_rate

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

• Transmission rates Rate to be used for transmitting a packet.

Enumerator
RATE_1M	1 Mbps
RATE_2M	2 Mbps
RATE_5_5M	5.5 Mbps
RATE_11M	11 Mbps
RATE_6M	6 Mbps
RATE_9M	9 Mbps
RATE_12M	12 Mbps
RATE_18M	18 Mbps
RATE_24M	24 Mbps
RATE_36M	36 Mbps
RATE_48M	48 Mbps
RATE_54M	54 Mbps
RATE_MCS0	MCS 0.
RATE_MCS1	MCS 1.
RATE_MCS2	MCS 2.
RATE_MCS3	MCS 3.
RATE_MCS4	MCS 4.
RATE_MCS5	MCS 5.
RATE_MCS6	MCS 6.
RATE_MCS7	MCS 7.
RATE_MAX	Invalid rate.

nrf_wifi_off_raw_tx_tput_mode

enum nrf_wifi_off_raw_tx_tput_mode

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

• Throughput mode Throughput mode to be used for transmitting the packet.

Enumerator
TPUT_MODE_LEGACY	Legacy mode.
TPUT_MODE_HT	High Throughput mode (11n)
TPUT_MODE_VHT	Very high throughput mode (11ac)
TPUT_MODE_HE_SU	HE SU mode.
TPUT_MODE_HE_ER_SU	HE ER SU mode.
TPUT_MODE_HE_TB	HE TB mode.
TPUT_MODE_MAX	Highest throughput mode currently defined.

Function Documentation

nrf70_off_raw_tx_conf_update()

int nrf70_off_raw_tx_conf_update

(

struct nrf_wifi_off_raw_tx_conf *

conf

)

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Update the configured offloaded raw TX parameters.

Parameters

conf	Configuration parameters to be updated for the offloaded raw TX operation.

This function is used to update configured parameters for offloaded raw TX operation. This function should be used to when the parameters need to be updated during an ongoing raw TX operation without having to stop it.

Return values

0	If the operation was successful.
-1	If the operation failed.

nrf70_off_raw_tx_deinit()

void nrf70_off_raw_tx_deinit

(

void

)

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Initialize the nRF70 for operating in the offloaded raw TX mode.

This function is deinitializes the nRF70 device.

nrf70_off_raw_tx_init()

int nrf70_off_raw_tx_init	(	uint8_t *	mac_addr,
		unsigned char *	country_code )

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Initialize the nRF70 for operating in the offloaded raw TX mode.

Parameters

mac_addr	MAC address to be used for the nRF70 device.
country_code	Country code to be set for regularity domain.

This function is initializes the nRF70 device for offloaded raw TX mode by:

• Powering it up,
• Downloading a firmware patch (if any).
• Initializing the firmware to accept further commands

The mac_addr parameter is used to set the MAC address of the nRF70 device. This address can be used to override the MAC addresses programmed in the OTP and the value configured (if any) in CONFIG_WIFI_FIXED_MAC_ADDRESS. The priority order in which the MAC address values for the nRF70 device are used is:

• If mac_addr is provided, the MAC address is set to the value provided.
• If CONFIG_WIFI_FIXED_MAC_ADDRESS is enabled, the MAC address uses the Kconfig value.
• If none of the above are provided, the MAC address is set to the value programmed in the OTP.

Return values

0	If the operation was successful.
-1	If the operation failed.

nrf70_off_raw_tx_mac_addr_get()

int nrf70_off_raw_tx_mac_addr_get

(

uint8_t *

mac_addr

)

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Get the MAC address of the nRF70 device.

Parameters

mac_addr

Buffer to store the MAC address.

This function is used to get the MAC address of the nRF70 device. The MAC address is stored in the buffer pointed by mac_addr. The MAC address is expected to be a 6 byte value.

Return values

0	If the operation was successful.
-1	If the operation failed.

nrf70_off_raw_tx_start()

int nrf70_off_raw_tx_start

(

struct nrf_wifi_off_raw_tx_conf *

conf

)

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Start the offloaded raw TX.

Parameters

conf	Configuration parameters necessary for the offloaded raw TX operation.

This function is used to start offloaded raw TX operation. When this function is invoked the nRF70 device will start transmitting frames as per the configuration specified by conf.

Return values

0	If the operation was successful.
-1	If the operation failed.

nrf70_off_raw_tx_stats()

int nrf70_off_raw_tx_stats

(

struct nrf_wifi_off_raw_tx_stats *

off_raw_tx_stats

)

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Get statistics of the offloaded raw TX.

Parameters

off_raw_tx_stats

Statistics of the offloaded raw TX operation.

This function is used to get statistics of offloaded raw TX operation. When this function is invoked the nRF70 device will show statistics.

Return values

0	If the operation was successful.
-1	If the operation failed.

nrf70_off_raw_tx_stop()

int nrf70_off_raw_tx_stop

(

void

)

#include <zephyr/drivers/wifi/nrfwifi/off_raw_tx/off_raw_tx_api.h>

Stop the offloaded raw TX.

This function is used to stop offloaded raw TX operation. When this function is invoked the nRF70 device will stop transmitting frames.

Return values

0	If the operation was successful.
-1	If the operation failed.