nrfxlib API 0.1.0
Loading...
Searching...
No Matches
host_rpu_sys_if.h File Reference
#include "host_rpu_common_if.h"
#include "lmac_if_common.h"
#include "pack_def.h"

Go to the source code of this file.

Data Structures

struct  chan_params
 
  • This structure specifies the parameters required to configure a specific channel.
More...
 
struct  rpu_conf_rx_radio_test_params
 This structure specifies the parameters required to start or stop the RX (receive) operation in radiotest mode. More...
 
struct  umac_rx_dbg_params
 This structure specifies the UMAC (Upper MAC) RX (receive) debug parameters specifically designed for debugging purpose. More...
 
struct  umac_tx_dbg_params
 This structure specifies the UMAC TX (transmit) debug parameters used for debugging purposes. More...
 
struct  umac_cmd_evnt_dbg_params
 This structure specifies the UMAC command and event debug parameters used for debugging purpose. More...
 
struct  nrf_wifi_interface_stats
 This structure specifies the UMAC interface debug parameters used for debugging purpose. More...
 
struct  rpu_umac_stats
 This structure defines the UMAC debug statistics. It contains the necessary parameters and fields used to gather and present debugging statistics within the UMAC layer. More...
 
struct  rpu_lmac_stats
 This structure defines the LMAC debug parameters. More...
 
struct  rpu_phy_stats
 This structure defines the PHY (Physical Layer) debug statistics. More...
 
struct  nrf_wifi_sys_head
 The UMAC header structure for system commands and events defines the format used to transmit and receive system-level commands and events. More...
 
struct  nrf_wifi_data_config_params
 This structure specifies the configuration parameters used for configuring data-related settings. More...
 
struct  nrf_wifi_sys_params
 This structure specifies the parameters that need to be provided for the command NRF_WIFI_CMD_INIT. The NRF_WIFI_CMD_INIT command is typically used to initialize the Wi-Fi module and prepare it for further communication. More...
 
struct  nrf_wifi_tx_pwr_ctrl_params
 This structure defines the parameters used to control the transmit (TX) power. More...
 
struct  nrf_wifi_board_params
 This structure defines board dependent parameters like PCB loss. More...
 
struct  nrf_wifi_cmd_sys_init
 This structure defines the command responsible for initializing the UMAC. After the host driver brings up, the host sends NRF_WIFI_CMD_INIT to the RPU. The RPU then performs the initialization and responds with NRF_WIFI_EVENT_INIT_DONE once the initialization is completed. More...
 
struct  nrf_wifi_cmd_sys_deinit
 This structure defines the command used to de-initialize the RPU. More...
 
struct  nrf_wifi_cmd_he_gi_ltf_config
 This structure defines the command used to configure High-Efficiency Guard Interval(HE-GI) and High-Efficiency Long Training Field (HE-LTF). More...
 
struct  rpu_conf_params
 This structure describes different Physical Layer (PHY) configuration parameters used in RF test and Radio test scenarios. These parameters are specific to testing and evaluating the performance of the radio hardware. More...
 
struct  nrf_wifi_cmd_mode_params
 This structure defines the command used to configure the RPU with different PHY configuration parameters specifically designed for RF test and Radio test scenarios. The command is intended to set up the RPU for testing and evaluating the performance of the radio hardware. More...
 
struct  nrf_wifi_radio_test_init_info
 This structure represents the parameters required to initialize a radio test. More...
 
struct  nrf_wifi_cmd_radio_test_init
 This structure defines the command used to initialize a radio test. More...
 
struct  nrf_wifi_cmd_rx
 This structure defines the command used to enable or disable the reception (Rx). It allows controlling the radio hardware's receive functionality to start or stop listening for incoming data frames. More...
 
struct  nrf_wifi_cmd_get_stats
 This structure defines the command used to retrieve statistics from the RPU. More...
 
struct  nrf_wifi_cmd_set_channel
 This structure represents the channel parameters to configure specific channel. More...
 
struct  nrf_wifi_cmd_raw_config_mode
 This structure defines the command used to configure promiscuous mode/Monitor mode/Packet injector mode. More...
 
struct  nrf_wifi_cmd_raw_config_filter
 This structure defines the command used to configure filters and capture length in promiscuous and monitor modes. More...
 
struct  nrf_wifi_raw_tx_pkt
 This structure defines the raw tx parameters used in packet injector mode. More...
 
struct  nrf_wifi_cmd_raw_tx
 This structure defines the command used to configure packet injector mode. More...
 
struct  nrf_wifi_event_set_channel
 This structure defines an event that indicates set channel command done. More...
 
struct  nrf_wifi_event_raw_config_mode
 This structure defines an event that indicates set raw config mode command done. More...
 
struct  nrf_wifi_event_raw_config_filter
 This structure defines an event that indicates set raw config filter command done. More...
 
struct  nrf_wifi_event_raw_tx_done
 This structure defines an event that indicates the Raw tx done. More...
 
struct  nrf_wifi_cmd_clear_stats
 This structure defines the command used to clear or reset statistics. More...
 
struct  nrf_wifi_cmd_pwr
 This structure represents the command used to obtain power monitor information specific to different data types. More...
 
struct  coex_wlan_switch_ctrl
 Structure for coexistence (coex) switch configuration. More...
 
struct  nrf_wifi_cmd_srcoex
 The structure represents the command used to configure the Wi-Fi side shared switch for SR coexistence. More...
 
struct  rpu_cmd_coex_config_info
 The structure defines the parameters used to configure the coexistence hardware. More...
 
struct  nrf_wifi_cmd_coex_config
 This structure defines the command used to configure the coexistence hardware. More...
 
struct  rpu_evnt_coex_config_info
 This structure describes the coexistence configuration data received in the NRF_WIFI_EVENT_COEX_CONFIG event. More...
 
struct  nrf_wifi_event_coex_config
 This structure defines the event used to represent coexistence configuration. More...
 
struct  nrf_wifi_cmd_fix_tx_rate
 This structure defines the command used to fix the transmission (Tx) data rate. The command allows setting a specific data rate for data transmission, ensuring that the system uses the designated rate instead of dynamically adapting to changing channel conditions. More...
 
struct  rpu_cmd_rftest_info
 This structure describes rf test command information. More...
 
struct  nrf_wifi_cmd_rftest
 This structure defines the command used for RF (Radio Frequency) testing. RF test commands are specifically designed to configure and control the radio hardware for conducting tests and evaluating its performance in various scenarios. More...
 
struct  rpu_evnt_rftest_info
 This structure describes rf test event information. More...
 
struct  nrf_wifi_event_rftest
 This structure describes the event generated during RF (Radio Frequency) testing. More...
 
struct  nrf_wifi_event_pwr_data
 This structure represents the power data event generated in response to the NRF_WIFI_CMD_PWR command. More...
 
struct  rpu_fw_stats
 This structure is a comprehensive combination of all the firmware statistics that the RPU (Radio Processing Unit) can provide. More...
 
struct  nrf_wifi_umac_event_stats
 This structure represents the event that provides RPU statistics in response to the command NRF_WIFI_CMD_GET_STATS in a wireless communication system. More...
 
struct  nrf_wifi_umac_event_err_status
 This structure defines an event that indicates the error status values that may occur during a radio test. It serves as a response to the radio test commands. More...
 
struct  nrf_wifi_event_init_done
 This structure represents the UMAC initialization done event. The event is sent by the RPU (Radio Processing Unit) in response to the NRF_WIFI_CMD_INIT command, indicating that the RPU initialization process has been completed successfully. More...
 
struct  pool_data_to_host
 structure for UMAC memory pool information. More...
 
struct  umac_int_stats
 This structure represents the event that provides UMAC (Upper MAC) internal memory statistics in response to the NRF_WIFI_CMD_UMAC_INT_STATS command. More...
 
struct  nrf_wifi_event_deinit_done
 This structure represents the event that indicates the completion of UMAC deinitialization. The RPU sends this event as a response to the NRF_WIFI_CMD_DEINIT command, signaling that the UMAC has been successfully deinitialized. More...
 
struct  nrf_wifi_cmd_reset_stats
 This structure describes the command for reset of interface statistics. More...
 

Macros

#define USE_PROTECTION_NONE   0
 
#define USE_PROTECTION_RTS   1
 
#define USE_PROTECTION_CTS2SELF   2
 
#define USE_SHORT_PREAMBLE   0
 
#define DONT_USE_SHORT_PREAMBLE   1
 
#define MARK_RATE_AS_MCS_INDEX   0x80
 
#define MARK_RATE_AS_RATE   0x00
 
#define ENABLE_GREEN_FIELD   0x01
 
#define ENABLE_CHNL_WIDTH_40MHZ   0x02
 
#define ENABLE_SGI   0x04
 
#define ENABLE_11N_FORMAT   0x08
 
#define ENABLE_VHT_FORMAT   0x10
 
#define ENABLE_CHNL_WIDTH_80MHZ   0x20
 
#define MAX_TX_AGG_SIZE   16
 
#define MAX_RX_BUFS_PER_EVNT   64
 
#define MAX_MGMT_BUFS   16
 
#define MAX_RF_CALIB_DATA   900
 
#define NRF_WIFI_ETH_ADDR_LEN   6
 
#define PHY_THRESHOLD_NORMAL   (-65)
 
#define PHY_THRESHOLD_PROD_MODE   (-93)
 
#define MAX_TX_STREAMS   1
 
#define MAX_RX_STREAMS   1
 
#define MAX_NUM_VIFS   2
 
#define MAX_NUM_STAS   2
 
#define MAX_NUM_APS   1
 
#define NRF_WIFI_COUNTRY_CODE_LEN   2
 
#define NRF_WIFI_FEATURE_DISABLE   0
 
#define NRF_WIFI_FEATURE_ENABLE   1
 
#define TWT_EXTEND_SP_EDCA   0x1
 
#define DISABLE_DFS_CHANNELS   0x2
 
#define NRF_WIFI_HE_GI_800NS   0
 
#define NRF_WIFI_HE_GI_1600NS   1
 
#define NRF_WIFI_HE_GI_3200NS   2
 
#define NRF_WIFI_HE_LTF_3200NS   0
 
#define NRF_WIFI_HE_LTF_6400NS   1
 
#define NRF_WIFI_HE_LTF_12800NS   2
 
#define NRF_WIFI_DISABLE   0
 
#define NRF_WIFI_ENABLE   1
 

Enumerations

enum  rpu_op_mode {
  RPU_OP_MODE_RADIO_TEST , RPU_OP_MODE_FCM , RPU_OP_MODE_REG , RPU_OP_MODE_DBG ,
  RPU_OP_MODE_MAX
}
 This enum provides a list of different operating modes. More...
 
enum  rpu_stats_type {
  RPU_STATS_TYPE_ALL , RPU_STATS_TYPE_HOST , RPU_STATS_TYPE_UMAC , RPU_STATS_TYPE_LMAC ,
  RPU_STATS_TYPE_PHY , RPU_STATS_TYPE_MAX
}
 This enum defines various types of statistics. More...
 
enum  rpu_tput_mode {
  RPU_TPUT_MODE_LEGACY , RPU_TPUT_MODE_HT , RPU_TPUT_MODE_VHT , RPU_TPUT_MODE_HE_SU ,
  RPU_TPUT_MODE_HE_ER_SU , RPU_TPUT_MODE_HE_TB , RPU_TPUT_MODE_MAX
}
 
  • Throughput mode Throughput mode to be used for transmitting the packet.
More...
 
enum  nrf_wifi_sys_commands {
  NRF_WIFI_CMD_INIT , NRF_WIFI_CMD_TX , NRF_WIFI_CMD_IF_TYPE , NRF_WIFI_CMD_MODE ,
  NRF_WIFI_CMD_GET_STATS , NRF_WIFI_CMD_CLEAR_STATS , NRF_WIFI_CMD_RX , NRF_WIFI_CMD_PWR ,
  NRF_WIFI_CMD_DEINIT , NRF_WIFI_CMD_SRCOEX , NRF_WIFI_CMD_RF_TEST , NRF_WIFI_CMD_HE_GI_LTF_CONFIG ,
  NRF_WIFI_CMD_UMAC_INT_STATS , NRF_WIFI_CMD_RADIO_TEST_INIT , NRF_WIFI_CMD_RT_REQ_SET_REG , NRF_WIFI_CMD_TX_FIX_DATA_RATE ,
  NRF_WIFI_CMD_CHANNEL , NRF_WIFI_CMD_RAW_CONFIG_MODE , NRF_WIFI_CMD_RAW_CONFIG_FILTER , NRF_WIFI_CMD_RAW_TX_PKT ,
  NRF_WIFI_CMD_RESET_STATISTICS
}
 
  • System commands.
More...
 
enum  nrf_wifi_sys_events {
  NRF_WIFI_EVENT_PWR_DATA , NRF_WIFI_EVENT_INIT_DONE , NRF_WIFI_EVENT_STATS , NRF_WIFI_EVENT_DEINIT_DONE ,
  NRF_WIFI_EVENT_RF_TEST , NRF_WIFI_EVENT_COEX_CONFIG , NRF_WIFI_EVENT_INT_UMAC_STATS , NRF_WIFI_EVENT_RADIOCMD_STATUS ,
  NRF_WIFI_EVENT_CHANNEL_SET_DONE , NRF_WIFI_EVENT_MODE_SET_DONE , NRF_WIFI_EVENT_FILTER_SET_DONE , NRF_WIFI_EVENT_RAW_TX_DONE
}
 
  • Events from the RPU.
More...
 
enum  rpu_ch_bw { RPU_CH_BW_20 , RPU_CH_BW_40 , RPU_CH_BW_MAX }
 
  • Channel Bandwidth types.
More...
 
enum  max_rx_ampdu_size { MAX_RX_AMPDU_SIZE_8KB , MAX_RX_AMPDU_SIZE_16KB , MAX_RX_AMPDU_SIZE_32KB , MAX_RX_AMPDU_SIZE_64KB }
 The maximum Rx (receive) A-MPDU size in KB. More...
 
enum  op_band { BAND_ALL , BAND_24G }
 This enum defines different types of operating bands. More...
 
enum  data_retrieve_mechanism { PS_POLL_FRAME , QOS_NULL_FRAME , AUTOMATIC }
 This enum specifies the type of frames used to retrieve buffered data from the AP in power save mode. More...
 
enum  rpu_pkt_preamble { RPU_PKT_PREAMBLE_SHORT , RPU_PKT_PREAMBLE_LONG , RPU_PKT_PREAMBLE_MIXED , RPU_PKT_PREAMBLE_MAX }
 This enum represents the different types of preambles used. Preambles are sequences of known symbols transmitted before the actual data transmission to enable synchronization, channel estimation, and frame detection at the receiver. More...
 
enum  wifi_operation_modes {
  NRF_WIFI_STA_MODE = 0x1 , NRF_WIFI_MONITOR_MODE = 0x2 , NRF_WIFI_TX_INJECTION_MODE = 0x4 , NRF_WIFI_PROMISCUOUS_MODE = 0x8 ,
  NRF_WIFI_AP_MODE = 0x10 , NRF_WIFI_STA_AP_MODE = 0x20 , WIFI_MODE_LIMIT_CHK = 0x2f
}
 This enum represents different types of operation modes. More...
 
enum  wifi_packet_filter { NRF_WIFI_PACKET_FILTER_ALL = 0x1 , NRF_WIFI_PACKET_FILTER_MGMT = 0x2 , NRF_WIFI_PACKET_FILTER_DATA = 0x4 , NRF_WIFI_PACKET_FILTER_CTRL = 0x8 }
 This enum represents different types of filters used. More...
 
enum  UMAC_QUEUE_NUM {
  UMAC_AC_BK = 0 , UMAC_AC_BE , UMAC_AC_VI , UMAC_AC_VO ,
  UMAC_AC_BCN , UMAC_AC_MAX_CNT
}
 This enum represents the queues used to segregate the TX frames depending on their QoS categories. A separate queue is used for Beacon frames / frames transmitted during DTIM intervals. More...
 
enum  nrf_wifi_radio_test_err_status { NRF_WIFI_UMAC_CMD_SUCCESS = 1 , NRF_WIFI_UMAC_INVALID_CHNL }
 This enum defines various error status values that may occur during a radio test. More...