root/drivers/net/wireless/realtek/rtw88/phy.h
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
/* Copyright(c) 2018-2019  Realtek Corporation
 */

#ifndef __RTW_PHY_H_
#define __RTW_PHY_H_

#include "debug.h"

extern const u8 rtw_cck_rates[];
extern const u8 rtw_ofdm_rates[];
extern const u8 rtw_ht_1s_rates[];
extern const u8 rtw_ht_2s_rates[];
extern const u8 rtw_vht_1s_rates[];
extern const u8 rtw_vht_2s_rates[];
extern const u8 rtw_ht_3s_rates[];
extern const u8 rtw_ht_4s_rates[];
extern const u8 rtw_vht_3s_rates[];
extern const u8 rtw_vht_4s_rates[];
extern const u8 * const rtw_rate_section[];
extern const u8 rtw_rate_size[];

void rtw_phy_init(struct rtw_dev *rtwdev);
void rtw_phy_dynamic_mechanism(struct rtw_dev *rtwdev);
u8 rtw_phy_rf_power_2_rssi(s8 *rf_power, u8 path_num);
u32 rtw_phy_read_rf(struct rtw_dev *rtwdev, enum rtw_rf_path rf_path,
                    u32 addr, u32 mask);
u32 rtw_phy_read_rf_sipi(struct rtw_dev *rtwdev, enum rtw_rf_path rf_path,
                         u32 addr, u32 mask);
bool rtw_phy_write_rf_reg_sipi(struct rtw_dev *rtwdev, enum rtw_rf_path rf_path,
                               u32 addr, u32 mask, u32 data);
bool rtw_phy_write_rf_reg(struct rtw_dev *rtwdev, enum rtw_rf_path rf_path,
                          u32 addr, u32 mask, u32 data);
bool rtw_phy_write_rf_reg_mix(struct rtw_dev *rtwdev, enum rtw_rf_path rf_path,
                              u32 addr, u32 mask, u32 data);
void rtw_phy_setup_phy_cond(struct rtw_dev *rtwdev, u32 pkg);
void rtw_parse_tbl_phy_cond(struct rtw_dev *rtwdev, const struct rtw_table *tbl);
void rtw_parse_tbl_bb_pg(struct rtw_dev *rtwdev, const struct rtw_table *tbl);
void rtw_parse_tbl_txpwr_lmt(struct rtw_dev *rtwdev, const struct rtw_table *tbl);
void rtw_phy_cfg_mac(struct rtw_dev *rtwdev, const struct rtw_table *tbl,
                     u32 addr, u32 data);
void rtw_phy_cfg_agc(struct rtw_dev *rtwdev, const struct rtw_table *tbl,
                     u32 addr, u32 data);
void rtw_phy_cfg_bb(struct rtw_dev *rtwdev, const struct rtw_table *tbl,
                    u32 addr, u32 data);
void rtw_phy_cfg_rf(struct rtw_dev *rtwdev, const struct rtw_table *tbl,
                    u32 addr, u32 data);
void rtw_phy_init_tx_power(struct rtw_dev *rtwdev);
void rtw_phy_load_tables(struct rtw_dev *rtwdev);
u8 rtw_phy_get_tx_power_index(struct rtw_dev *rtwdev, u8 rf_path, u8 rate,
                              enum rtw_bandwidth bw, u8 channel, u8 regd);
void rtw_phy_set_tx_power_level(struct rtw_dev *rtwdev, u8 channel);
void rtw_phy_tx_power_by_rate_config(struct rtw_hal *hal);
void rtw_phy_tx_power_limit_config(struct rtw_hal *hal);
void rtw_phy_pwrtrack_avg(struct rtw_dev *rtwdev, u8 thermal, u8 path);
bool rtw_phy_pwrtrack_thermal_changed(struct rtw_dev *rtwdev, u8 thermal,
                                      u8 path);
u8 rtw_phy_pwrtrack_get_delta(struct rtw_dev *rtwdev, u8 path);
s8 rtw_phy_pwrtrack_get_pwridx(struct rtw_dev *rtwdev,
                               struct rtw_swing_table *swing_table,
                               u8 tbl_path, u8 therm_path, u8 delta);
bool rtw_phy_pwrtrack_need_lck(struct rtw_dev *rtwdev);
bool rtw_phy_pwrtrack_need_iqk(struct rtw_dev *rtwdev);
void rtw_phy_config_swing_table(struct rtw_dev *rtwdev,
                                struct rtw_swing_table *swing_table);
void rtw_phy_set_edcca_th(struct rtw_dev *rtwdev, u8 l2h, u8 h2l);
void rtw_phy_adaptivity_set_mode(struct rtw_dev *rtwdev);
void rtw_phy_parsing_cfo(struct rtw_dev *rtwdev,
                         struct rtw_rx_pkt_stat *pkt_stat);
void rtw_phy_tx_path_diversity(struct rtw_dev *rtwdev);

struct rtw_txpwr_lmt_cfg_pair {
        u8 regd;
        u8 band;
        u8 bw;
        u8 rs;
        u8 ch;
        s8 txpwr_lmt;
};

struct rtw_phy_pg_cfg_pair {
        u32 band;
        u32 rf_path;
        u32 tx_num;
        u32 addr;
        u32 bitmask;
        u32 data;
};

#define RTW_DECL_TABLE_PHY_COND_CORE(name, cfg, path)   \
const struct rtw_table name ## _tbl = {                 \
        .data = name,                                   \
        .size = ARRAY_SIZE(name),                       \
        .parse = rtw_parse_tbl_phy_cond,                \
        .do_cfg = cfg,                                  \
        .rf_path = path,                                \
}

#define RTW_DECL_TABLE_PHY_COND(name, cfg)              \
        RTW_DECL_TABLE_PHY_COND_CORE(name, cfg, 0)

#define RTW_DECL_TABLE_RF_RADIO(name, path)             \
        RTW_DECL_TABLE_PHY_COND_CORE(name, rtw_phy_cfg_rf, RF_PATH_ ## path)

#define RTW_DECL_TABLE_BB_PG(name)                      \
const struct rtw_table name ## _tbl = {                 \
        .data = name,                                   \
        .size = ARRAY_SIZE(name),                       \
        .parse = rtw_parse_tbl_bb_pg,                   \
}

#define RTW_DECL_TABLE_TXPWR_LMT(name)                  \
const struct rtw_table name ## _tbl = {                 \
        .data = name,                                   \
        .size = ARRAY_SIZE(name),                       \
        .parse = rtw_parse_tbl_txpwr_lmt,               \
}

static inline const struct rtw_rfe_def *rtw_get_rfe_def(struct rtw_dev *rtwdev)
{
        const struct rtw_chip_info *chip = rtwdev->chip;
        struct rtw_efuse *efuse = &rtwdev->efuse;
        const struct rtw_rfe_def *rfe_def = NULL;

        if (chip->rfe_defs_size == 0)
                return NULL;

        if (efuse->rfe_option < chip->rfe_defs_size)
                rfe_def = &chip->rfe_defs[efuse->rfe_option];

        rtw_dbg(rtwdev, RTW_DBG_PHY, "use rfe_def[%d]\n", efuse->rfe_option);
        return rfe_def;
}

static inline int rtw_check_supported_rfe(struct rtw_dev *rtwdev)
{
        const struct rtw_rfe_def *rfe_def = rtw_get_rfe_def(rtwdev);

        if (!rfe_def || !rfe_def->phy_pg_tbl || !rfe_def->txpwr_lmt_tbl) {
                rtw_err(rtwdev, "rfe %d isn't supported\n",
                        rtwdev->efuse.rfe_option);
                return -ENODEV;
        }

        return 0;
}

void rtw_phy_dig_write(struct rtw_dev *rtwdev, u8 igi);
void rtw_phy_dig_reset(struct rtw_dev *rtwdev);
void rtw_phy_dig_set_max_coverage(struct rtw_dev *rtwdev);

struct rtw_power_params {
        u8 pwr_base;
        s8 pwr_offset;
        s8 pwr_limit;
        s8 pwr_remnant;
        s8 pwr_sar;
};

void
rtw_get_tx_power_params(struct rtw_dev *rtwdev, u8 path,
                        u8 rate, u8 bw, u8 ch, u8 regd,
                        struct rtw_power_params *pwr_param);

enum rtw_phy_cck_pd_lv {
        CCK_PD_LV0,
        CCK_PD_LV1,
        CCK_PD_LV2,
        CCK_PD_LV3,
        CCK_PD_LV4,
        CCK_PD_LV_MAX,
};

#define MASKBYTE0               0xff
#define MASKBYTE1               0xff00
#define MASKBYTE2               0xff0000
#define MASKBYTE3               0xff000000
#define MASKHWORD               0xffff0000
#define MASKLWORD               0x0000ffff
#define MASKDWORD               0xffffffff
#define RFREG_MASK              0xfffff

#define MASK7BITS               0x7f
#define MASK12BITS              0xfff
#define MASKH4BITS              0xf0000000
#define MASK20BITS              0xfffff
#define MASK24BITS              0xffffff

#define MASKH3BYTES             0xffffff00
#define MASKL3BYTES             0x00ffffff
#define MASKBYTE2HIGHNIBBLE     0x00f00000
#define MASKBYTE3LOWNIBBLE      0x0f000000
#define MASKL3BYTES             0x00ffffff

#define CCK_FA_AVG_RESET 0xffffffff

#define LSSI_READ_ADDR_MASK     0x7f800000
#define LSSI_READ_EDGE_MASK     0x80000000
#define LSSI_READ_DATA_MASK     0xfffff

#define RRSR_RATE_ORDER_MAX     0xfffff
#define RRSR_RATE_ORDER_CCK_LEN 4

#endif