phy_rf_params.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _PHY_RF_PARAMS_H_
#define _PHY_RF_PARAMS_H_
#include "pack_def.h"
 
#define NRF_WIFI_RF_PARAMS_SIZE 200
#define NRF_WIFI_RF_PARAMS_CONF_SIZE 42
#define NUM_PCB_LOSS_OFFSET 4
 
#ifdef CONFIG_NRF700X_RADIO_TEST
#define NRF_WIFI_DEF_RF_PARAMS "007077003F032424001000002800323500000C0008087D8105010071630300EED501001F6F00003B350100F52E0000E35E0000B7B6000066EFFEFFB5F60000896200007A840200E28FFCFF080808080408120100000000A1A10178000000080050003B020726181818181A120A140E0600"
#define MAX_TX_PWR_SYS_TEST 30
#define MAX_TX_PWR_RADIO_TEST 24
#else
#define NRF_WIFI_DEF_RF_PARAMS "007077003F032424001000002800323500000CF008087D8105010071630300EED501001F6F00003B350100F52E0000E35E0000B7B6000066EFFEFFB5F60000896200007A840200E28FFCFF080808080408120100000000A1A10178000000080050003B020726181818181A120A140E0600"
#endif
 
 
#define NRF_WIFI_PHY_CALIB_FLAG_RXDC 1
#define NRF_WIFI_PHY_CALIB_FLAG_TXDC 2
#define NRF_WIFI_PHY_CALIB_FLAG_TXPOW 0
#define NRF_WIFI_PHY_CALIB_FLAG_TXIQ 8
#define NRF_WIFI_PHY_CALIB_FLAG_RXIQ 16
#define NRF_WIFI_PHY_CALIB_FLAG_DPD 32
#define NRF_WIFI_PHY_CALIB_FLAG_ENHANCED_TXDC 64
 
#define NRF_WIFI_PHY_SCAN_CALIB_FLAG_RXDC (1<<16)
#define NRF_WIFI_PHY_SCAN_CALIB_FLAG_TXDC (2<<16)
#define NRF_WIFI_PHY_SCAN_CALIB_FLAG_TXPOW (0<<16)
#define NRF_WIFI_PHY_SCAN_CALIB_FLAG_TXIQ (0<<16)
#define NRF_WIFI_PHY_SCAN_CALIB_FLAG_RXIQ (0<<16)
#define NRF_WIFI_PHY_SCAN_CALIB_FLAG_DPD (0<<16)
 
#define NRF_WIFI_DEF_PHY_CALIB (NRF_WIFI_PHY_CALIB_FLAG_RXDC |\
                                NRF_WIFI_PHY_CALIB_FLAG_TXDC |\
                                NRF_WIFI_PHY_CALIB_FLAG_RXIQ |\
                                NRF_WIFI_PHY_CALIB_FLAG_TXIQ |\
                                NRF_WIFI_PHY_CALIB_FLAG_TXPOW |\
                                NRF_WIFI_PHY_CALIB_FLAG_DPD |\
                                NRF_WIFI_PHY_CALIB_FLAG_ENHANCED_TXDC |\
                                NRF_WIFI_PHY_SCAN_CALIB_FLAG_RXDC |\
                                NRF_WIFI_PHY_SCAN_CALIB_FLAG_TXDC |\
                                NRF_WIFI_PHY_SCAN_CALIB_FLAG_RXIQ |\
                                NRF_WIFI_PHY_SCAN_CALIB_FLAG_TXIQ |\
                                NRF_WIFI_PHY_SCAN_CALIB_FLAG_TXPOW |\
                                NRF_WIFI_PHY_SCAN_CALIB_FLAG_DPD)
 
/* Temperature based calibration params */
#define NRF_WIFI_DEF_PHY_TEMP_CALIB (NRF_WIFI_PHY_CALIB_FLAG_RXDC |\
                                     NRF_WIFI_PHY_CALIB_FLAG_TXDC |\
                                     NRF_WIFI_PHY_CALIB_FLAG_RXIQ |\
                                     NRF_WIFI_PHY_CALIB_FLAG_TXIQ |\
                                     NRF_WIFI_PHY_CALIB_FLAG_TXPOW |\
                                     NRF_WIFI_PHY_CALIB_FLAG_DPD)
 
 
#define NRF_WIFI_TEMP_CALIB_PERIOD (1024 * 1024) /* micro seconds */
#define NRF_WIFI_TEMP_CALIB_THRESHOLD (40)
#define NRF_WIFI_TEMP_CALIB_ENABLE 1
 
/* Battery voltage changes base calibrations and voltage thresholds */
#define NRF_WIFI_DEF_PHY_VBAT_CALIB (NRF_WIFI_PHY_CALIB_FLAG_DPD)
#define NRF_WIFI_VBAT_VERYLOW (8) /* Corresponds to (2.5+8*0.07)=3.06V */
#define NRF_WIFI_VBAT_LOW (12)  /* Correspond to (2.5+12*0.07)=3.34V */
#define NRF_WIFI_VBAT_HIGH (14) /* Correspond to (2.5+14*0.07)=3.48V */
 
#define QFN_PACKAGE_INFO 0x5146
#define CSP_PACKAGE_INFO 0x4345
 
/* Package independent params */
 
#define PD_ADJUST_VAL 0
 
#define RX_GAIN_OFFSET_LB_CHAN 0
#define RX_GAIN_OFFSET_HB_LOW_CHAN 0
#define RX_GAIN_OFFSET_HB_MID_CHAN 0
#define RX_GAIN_OFFSET_HB_HIGH_CHAN 0
 
#define SYSTEM_OFFSET_LB 3
#define SYSTEM_OFFSET_HB_CHAN_LOW 3
#define SYSTEM_OFFSET_HB_CHAN_MID 3
#define SYSTEM_OFFSET_HB_CHAN_HIGH 3
 
#define QFN_XO_VAL 0x2A
 
#define QFN_MAX_TX_PWR_DSSS 0x54
#define QFN_MAX_TX_PWR_LB_MCS7 0x40
#define QFN_MAX_TX_PWR_LB_MCS0 0x40
 
#define QFN_MAX_TX_PWR_HB_LOW_CHAN_MCS7 0x34
#define QFN_MAX_TX_PWR_HB_MID_CHAN_MCS7 0x34
#define QFN_MAX_TX_PWR_HB_HIGH_CHAN_MCS7 0x30
 
#define QFN_MAX_TX_PWR_HB_LOW_CHAN_MCS0 0x38
#define QFN_MAX_TX_PWR_HB_MID_CHAN_MCS0 0x34
#define QFN_MAX_TX_PWR_HB_HIGH_CHAN_MCS0 0x30
 
#define QFN_MAX_CHIP_TEMP 0x43
 
#define QFN_MIN_CHIP_TEMP 0x07
 
#define QFN_LB_MAX_PWR_BKF_HI_TEMP 0xFC
#define QFN_LB_MAX_PWR_BKF_LOW_TEMP 0x00
#define QFN_HB_MAX_PWR_BKF_HI_TEMP 0xF8
#define QFN_HB_MAX_PWR_BKF_LOW_TEMP 0xFC
 
#define QFN_LB_VBT_LT_VLOW 0xFC
#define QFN_HB_VBT_LT_VLOW 0xF8
 
#define QFN_LB_VBT_LT_LOW 0x00
#define QFN_HB_VBT_LT_LOW 0xFC
 
 
#define CSP_XO_VAL 0x2A
 
#define CSP_MAX_TX_PWR_DSSS 0x48
#define CSP_MAX_TX_PWR_LB_MCS7 0x44
#define CSP_MAX_TX_PWR_LB_MCS0 0x44
 
#define CSP_MAX_TX_PWR_HB_LOW_CHAN_MCS7 0x3C
#define CSP_MAX_TX_PWR_HB_MID_CHAN_MCS7 0x3C
#define CSP_MAX_TX_PWR_HB_HIGH_CHAN_MCS7 0x3C
 
#define CSP_MAX_TX_PWR_HB_LOW_CHAN_MCS0 0x3C
#define CSP_MAX_TX_PWR_HB_MID_CHAN_MCS0 0x3C
#define CSP_MAX_TX_PWR_HB_HIGH_CHAN_MCS0 0x3C
 
#define CSP_MAX_CHIP_TEMP 0x43
 
#define CSP_MIN_CHIP_TEMP 0x07
 
#define CSP_LB_MAX_PWR_BKF_HI_TEMP 0xEC
#define CSP_LB_MAX_PWR_BKF_LOW_TEMP 0x00
#define CSP_HB_MAX_PWR_BKF_HI_TEMP 0xFC
#define CSP_HB_MAX_PWR_BKF_LOW_TEMP 0xF4
 
#define CSP_LB_VBT_LT_VLOW 0xFC
#define CSP_HB_VBT_LT_VLOW 0xEC
 
#define CSP_LB_VBT_LT_LOW 0x00
#define CSP_HB_VBT_LT_LOW 0xF8
 
 
struct nrf_wifi_xo_freq_offset {
        unsigned char xo_freq_offset;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_pd_adst_val {
        signed char pd_adjt_lb_chan;
        signed char pd_adjt_hb_low_chan;
        signed char pd_adjt_hb_mid_chan;
        signed char pd_adjt_hb_high_chan;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_tx_pwr_systm_offset {
        signed char syst_off_lb_chan;
        signed char syst_off_hb_low_chan;
        signed char syst_off_hb_mid_chan;
        signed char syst_off_hb_high_chan;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_tx_pwr_ceil {
        signed char max_dsss_pwr;
        signed char max_lb_mcs7_pwr;
        signed char max_lb_mcs0_pwr;
        signed char max_hb_low_chan_mcs7_pwr;
        signed char max_hb_mid_chan_mcs7_pwr;
        signed char max_hb_high_chan_mcs7_pwr;
        signed char max_hb_low_chan_mcs0_pwr;
        signed char max_hb_mid_chan_mcs0_pwr;
        signed char max_hb_high_chan_mcs0_pwr;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_rx_gain_offset {
        signed char rx_gain_lb_chan;
        signed char rx_gain_hb_low_chan;
        signed char rx_gain_hb_mid_chan;
        signed char rx_gain_hb_high_chan;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_temp_volt_depend_params {
        signed char max_chip_temp;
        signed char min_chip_temp;
        signed char lb_max_pwr_bkf_hi_temp;
        signed char lb_max_pwr_bkf_low_temp;
        signed char hb_max_pwr_bkf_hi_temp;
        signed char hb_max_pwr_bkf_low_temp;
        signed char lb_vbt_lt_vlow;
        signed char hb_vbt_lt_vlow;
        signed char lb_vbt_lt_low;
        signed char hb_vbt_lt_low;
        signed char reserved[4];
} __NRF_WIFI_PKD;
 
struct nrf_wifi_phy_rf_params {
        unsigned char reserved[6];
        struct nrf_wifi_xo_freq_offset xo_offset;
        struct nrf_wifi_pd_adst_val pd_adjust_val;
        struct nrf_wifi_tx_pwr_systm_offset syst_tx_pwr_offset;
        struct nrf_wifi_tx_pwr_ceil max_pwr_ceil;
        struct nrf_wifi_rx_gain_offset rx_gain_offset;
        struct nrf_wifi_temp_volt_depend_params temp_volt_backoff;
        unsigned char phy_params[NRF_WIFI_RF_PARAMS_SIZE - NRF_WIFI_RF_PARAMS_CONF_SIZE];
} __NRF_WIFI_PKD;
 
enum RF_PARAMS_OFFSETS {
        NRF_WIFI_XO_FREQ_BYTE_OFFSET = 6,
        NRF_WIFI_PD_ADST_VAL_BYTE_OFFSET = 7,
        NRF_WIFI_TX_PWR_SYSTM_BYTE_OFFSET = 11,
        NRF_WIFI_TX_PWR_CEIL_BYTE_OFFSET = 15,
        NRF_WIFI_RX_GAIN_BYTE_OFFSET = 24,
        NRF_WIFI_VT_DEPEND_PARAMS_BYTE_OFFSET = 28
};
 
enum MAX_POWER_OFFSETS {
        NRF_WIFI_MAX_OP_PWR_DSSS_OFST,
        NRF_WIFI_MAX_OP_PWR_2PT4GHZ_OFDM_MCS7,
        NRF_WIFI_MAX_OP_PWR_2PT4GHZ_OFDM_MCS0,
        NRF_WIFI_MAX_OP_PWR_5GHZ_LB_MCS7,
        NRF_WIFI_MAX_OP_PWR_5GHZ_MID_MCS7,
        NRF_WIFI_MAX_OP_PWR_5GHZ_HI_MCS7,
        NRF_WIFI_MAX_OP_PWR_5GHZ_LB_MCS0,
        NRF_WIFI_MAX_OP_PWR_5GHZ_MID_MCS0,
        NRF_WIFI_MAX_OP_PWR_5GHZ_HI_MCS0
};
 
enum PCB_LOSS_BYTE_OFFSETS {
        PCB_LOSS_BYTE_2G_OFST = 185,
        PCB_LOSS_BYTE_5G_BAND1_OFST,
        PCB_LOSS_BYTE_5G_BAND2_OFST,
        PCB_LOSS_BYTE_5G_BAND3_OFST
};
 
enum ANT_GAIN_OFFSETS {
        ANT_GAIN_2G_OFST = 181,
        ANT_GAIN_5G_BAND1_OFST,
        ANT_GAIN_5G_BAND2_OFST,
        ANT_GAIN_5G_BAND3_OFST,
        NUM_ANT_GAIN = 4
};
 
enum EDGE_BACKOFF_OFFSETS {
        BAND_2G_LW_ED_BKF_DSSS_OFST = 155,
        BAND_2G_LW_ED_BKF_HT_OFST,
        BAND_2G_LW_ED_BKF_HE_OFST,
        BAND_2G_UW_ED_BKF_DSSS_OFST,
        BAND_2G_UW_ED_BKF_HT_OFST,
        BAND_2G_UW_ED_BKF_HE_OFST,
        BAND_UNII_1_LW_ED_BKF_HT_OFST,
        BAND_UNII_1_LW_ED_BKF_HE_OFST,
        BAND_UNII_1_UW_ED_BKF_HT_OFST,
        BAND_UNII_1_UW_ED_BKF_HE_OFST,
        BAND_UNII_2A_LW_ED_BKF_HT_OFST,
        BAND_UNII_2A_LW_ED_BKF_HE_OFST,
        BAND_UNII_2A_UW_ED_BKF_HT_OFST,
        BAND_UNII_2A_UW_ED_BKF_HE_OFST,
        BAND_UNII_2C_LW_ED_BKF_HT_OFST,
        BAND_UNII_2C_LW_ED_BKF_HE_OFST,
        BAND_UNII_2C_UW_ED_BKF_HT_OFST,
        BAND_UNII_2C_UW_ED_BKF_HE_OFST,
        BAND_UNII_3_LW_ED_BKF_HT_OFST,
        BAND_UNII_3_LW_ED_BKF_HE_OFST,
        BAND_UNII_3_UW_ED_BKF_HT_OFST,
        BAND_UNII_3_UW_ED_BKF_HE_OFST,
        BAND_UNII_4_LW_ED_BKF_HT_OFST,
        BAND_UNII_4_LW_ED_BKF_HE_OFST,
        BAND_UNII_4_UW_ED_BKF_HT_OFST,
        BAND_UNII_4_UW_ED_BKF_HE_OFST,
        NUM_EDGE_BACKOFF = 26
};
 
#ifdef CONFIG_NRF700X_RADIO_TEST
 
#define MAX_CAPTURE_LEN 16383
#define MIN_CAPTURE_LEN 0
#define RX_CAPTURE_TIMEOUT_CONST 11
#define CAPTURE_DURATION_IN_SEC 600
 
enum nrf_wifi_rf_test {
        NRF_WIFI_RF_TEST_RX_ADC_CAP,
        NRF_WIFI_RF_TEST_RX_STAT_PKT_CAP,
        NRF_WIFI_RF_TEST_RX_DYN_PKT_CAP,
        NRF_WIFI_RF_TEST_TX_TONE,
        NRF_WIFI_RF_TEST_DPD,
        NRF_WIFI_RF_TEST_RF_RSSI,
        NRF_WIFI_RF_TEST_SLEEP,
        NRF_WIFI_RF_TEST_GET_TEMPERATURE,
        NRF_WIFI_RF_TEST_XO_CALIB,
        NRF_WIFI_RF_TEST_XO_TUNE,
        NRF_WIFI_RF_TEST_MAX,
};
 
enum nrf_wifi_rf_test_event {
        NRF_WIFI_RF_TEST_EVENT_RX_ADC_CAP,
        NRF_WIFI_RF_TEST_EVENT_RX_STAT_PKT_CAP,
        NRF_WIFI_RF_TEST_EVENT_RX_DYN_PKT_CAP,
        NRF_WIFI_RF_TEST_EVENT_TX_TONE_START,
        NRF_WIFI_RF_TEST_EVENT_DPD_ENABLE,
        NRF_WIFI_RF_TEST_EVENT_RF_RSSI,
        NRF_WIFI_RF_TEST_EVENT_SLEEP,
        NRF_WIFI_RF_TEST_EVENT_TEMP_MEAS,
        NRF_WIFI_RF_TEST_EVENT_XO_CALIB,
        NRF_WIFI_RF_TEST_EVENT_MAX,
};
 
/* Holds the RX capture related info */
struct nrf_wifi_rf_test_capture_params {
        unsigned char test;
 
        /* Number of samples to be captured. */
        unsigned short int cap_len;
 
        /* Capture timeout in seconds. */
        unsigned short int cap_time;
 
        /* Capture status codes:
         *0: Capture successful after WLAN packet detection
         *1: Capture failed after WLAN packet detection
         *2: Capture timedout as no WLAN packets are detected
         */
        unsigned char capture_status;
 
        /* LNA Gain to be configured. It is a 3 bit value. The mapping is,
         * '0' = 24dB
         * '1' = 18dB
         * '2' = 12dB
         * '3' = 0dB
         * '4' = -12dB
         */
        unsigned char lna_gain;
 
        /* Baseband Gain to be configured. It is a 5 bit value.
         * It supports 64dB range.The increment happens lineraly 2dB/step
         */
        unsigned char bb_gain;
} __NRF_WIFI_PKD;
 
/* Struct to hold the events from RF test SW. */
struct nrf_wifi_rf_test_capture_meas {
        unsigned char test;
 
        /* Mean of I samples. Format: Q.11 */
        signed short mean_I;
 
        /* Mean of Q samples. Format: Q.11 */
        signed short mean_Q;
 
        /* RMS of I samples */
        unsigned int rms_I;
 
        /* RMS of Q samples */
        unsigned int rms_Q;
} __NRF_WIFI_PKD;
 
/* Holds the transmit related info */
struct nrf_wifi_rf_test_tx_params {
        unsigned char test;
 
        /* Desired tone frequency in MHz in steps of 1 MHz from -10 MHz to +10 MHz. */
        signed char tone_freq;
 
        /* Desired TX power in the range -16 dBm to +24 dBm.
         * in steps of 2 dBm
         */
        signed char tx_pow;
 
        /* Set 1 for staring tone transmission. */
        unsigned char enabled;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_rf_test_dpd_params {
        unsigned char test;
        unsigned char enabled;
 
} __NRF_WIFI_PKD;
 
struct nrf_wifi_temperature_params {
        unsigned char test;
 
        signed int temperature;
 
        unsigned int readTemperatureStatus;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_rf_get_rf_rssi {
        unsigned char test;
        unsigned char lna_gain;
        unsigned char bb_gain;
        unsigned char agc_status_val;
} __NRF_WIFI_PKD;
 
struct nrf_wifi_rf_test_xo_calib {
        unsigned char test;
 
        /* XO value in the range between 0 to 127 */
        unsigned char xo_val;
 
} __NRF_WIFI_PKD;
 
struct nrf_wifi_rf_get_xo_value {
        unsigned char test;
 
        /* Optimal XO value computed. */
        unsigned char xo_value;
} __NRF_WIFI_PKD;
 
#endif /* CONFIG_NRF700X_RADIO_TEST */
 
struct nrf_wifi_tx_pwr_ceil_params {
        unsigned char max_pwr_2g_dsss;
        unsigned char max_pwr_2g_mcs0;
        unsigned char max_pwr_2g_mcs7;
 
#ifndef CONFIG_NRF70_2_4G_ONLY
        unsigned char max_pwr_5g_low_mcs0;
        unsigned char max_pwr_5g_low_mcs7;
        unsigned char max_pwr_5g_mid_mcs0;
        unsigned char max_pwr_5g_mid_mcs7;
        unsigned char max_pwr_5g_high_mcs0;
        unsigned char max_pwr_5g_high_mcs7;
#endif /* CONFIG_NRF70_2_4G_ONLY */
} __NRF_WIFI_PKD;
 
/* FT Prog version info */
enum ft_prog_ver {
        FT_PROG_VER1 = 1,
        FT_PROG_VER2 = 2,
        FT_PROG_VER3 = 3
};
 
/* FT Prog version dependent back off values
 * from Max transmit power
 */
#define FT_PROG_VER1_2G_DSSS_TXCEIL_BKOFF 0
#define FT_PROG_VER1_2G_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER1_5G_LOW_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER1_5G_MID_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER1_5G_HIGH_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER2_2G_DSSS_TXCEIL_BKOFF 0
#define FT_PROG_VER2_2G_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER2_5G_LOW_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER2_5G_MID_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER2_5G_HIGH_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER3_2G_DSSS_TXCEIL_BKOFF 0
#define FT_PROG_VER3_2G_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER3_5G_LOW_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER3_5G_MID_OFDM_TXCEIL_BKOFF 0
#define FT_PROG_VER3_5G_HIGH_OFDM_TXCEIL_BKOFF 0
 
#endif