plat_hook.h

Go to the documentation of this file.

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef PLAT_HOOK_H
#define PLAT_HOOK_H
 
#include "sensor.h"
 
#define VR_MAX_NUM 11
#define VR_MUTEX_LOCK_TIMEOUT_MS 1000
#define POWER_HISTORY_SIZE 10
#define POWER_CAPPING_HC_DEFAULT 1000
#define POWER_CAPPING_LC_DEFAULT 800
#define POWER_CAPPING_ENABLE 1
#define POWER_CAPPING_DISABLE 0
#define POWER_CAPPING_AVERAGE_TIME_MS_DEFAULT 50 // 50ms
#define POWER_CAPPING_HISTORY_SIZE 10
 
#include "plat_pldm_sensor.h"
 
enum VR_INDEX_E {
    VR_INDEX_E_P3V3 = 0,
    VR_INDEX_E_P0V85,
    VR_INDEX_E_P0V75_CH_N,
    VR_INDEX_E_P0V75_CH_S,
    VR_INDEX_E_P0V75_TRVDD_ZONEA,
    VR_INDEX_E_P0V75_TRVDD_ZONEB,
    VR_INDEX_E_P1V1_VDDC_HBM0_HBM2_HBM4,
    VR_INDEX_E_P0V9_TRVDD_ZONEA,
    VR_INDEX_E_P0V9_TRVDD_ZONEB,
    VR_INDEX_E_P1V1_VDDC_HBM1_HBM3_HBM5,
    VR_INDEX_E_P0V8_VDDA_PCIE,
    VR_INDEX_MAX,
};
 
enum VR_RAIL_E {
    VR_RAIL_E_P3V3 = 0,
    VR_RAIL_E_P0V85_PVDD,
    VR_RAIL_E_P0V75_PVDD_CH_N,
    VR_RAIL_E_P0V75_MAX_PHY_N,
    VR_RAIL_E_P0V75_PVDD_CH_S,
    VR_RAIL_E_P0V75_MAX_PHY_S,
    VR_RAIL_E_P0V75_TRVDD_ZONEA,
    VR_RAIL_E_P1V8_VPP_HBM0_HBM2_HBM4,
    VR_RAIL_E_P0V75_TRVDD_ZONEB,
    VR_RAIL_E_P0V4_VDDQL_HBM0_HBM2_HBM4,
    VR_RAIL_E_P1V1_VDDC_HBM0_HBM2_HBM4,
    VR_RAIL_E_P0V75_VDDPHY_HBM0_HBM2_HBM4,
    VR_RAIL_E_P0V9_TRVDD_ZONEA,
    VR_RAIL_E_P1V8_VPP_HBM1_HBM3_HBM5,
    VR_RAIL_E_P0V9_TRVDD_ZONEB,
    VR_RAIL_E_P0V4_VDDQL_HBM1_HBM3_HBM5,
    VR_RAIL_E_P1V1_VDDC_HBM1_HBM3_HBM5,
    VR_RAIL_E_P0V75_VDDPHY_HBM1_HBM3_HBM5,
    VR_RAIL_E_P0V8_VDDA_PCIE,
    VR_RAIL_E_P1V2_VDDHTX_PCIE,
    VR_RAIL_E_MAX,
};
 
enum VR_STAUS_E {
    VR_STAUS_E_STATUS_BYTE = 0,
    VR_STAUS_E_STATUS_WORD,
    VR_STAUS_E_STATUS_VOUT,
    VR_STAUS_E_STATUS_IOUT,
    VR_STAUS_E_STATUS_INPUT,
    VR_STAUS_E_STATUS_TEMPERATURE,
    VR_STAUS_E_STATUS_CML,
    VR_STAUS_E_MAX,
};
 
enum PLAT_TEMP_INDEX_E {
    TEMP_INDEX_ON_DIE_ATH_0_N_OWL,
    TEMP_INDEX_ON_DIE_ATH_1_S_OWL,
    TEMP_INDEX_TOP_INLET,
    TEMP_INDEX_TOP_OUTLET,
    TEMP_INDEX_BOT_INLET,
    TEMP_INDEX_BOT_OUTLET,
    TEMP_INDEX_MAX,
};
 
enum PLAT_TEMP_INDEX_THRESHOLD_TYPE_E {
    DIE_ATH_0_N_OWL_REMOTE_1_HIGH_LIMIT,
    DIE_ATH_0_N_OWL_REMOTE_1_LOW_LIMIT,
    DIE_ATH_1_S_OWL_REMOTE_1_HIGH_LIMIT,
    DIE_ATH_1_S_OWL_REMOTE_1_LOW_LIMIT,
 
    DIE_ATH_0_N_OWL_REMOTE_2_HIGH_LIMIT,
    DIE_ATH_0_N_OWL_REMOTE_2_LOW_LIMIT,
    DIE_ATH_1_S_OWL_REMOTE_2_HIGH_LIMIT,
    DIE_ATH_1_S_OWL_REMOTE_2_LOW_LIMIT,
 
    TOP_INLET_LOW_LIMIT,
    TOP_INLET_HIGH_LIMIT,
    TOP_OUTLET_LOW_LIMIT,
    TOP_OUTLET_HIGH_LIMIT,
    BOT_INLET_LOW_LIMIT,
    BOT_INLET_HIGH_LIMIT,
    BOT_OUTLET_LOW_LIMIT,
    BOT_OUTLET_HIGH_LIMIT,
    PLAT_TEMP_INDEX_THRESHOLD_TYPE_MAX,
};
 
enum PLAT_STRAP_INDEX_E {
    STRAP_INDEX_SOC_JTAG_MUX_SEL_0_3,
    STRAP_INDEX_SOC_DFT_TAP_EN_L,
    STRAP_INDEX_SOC_ATPG_MODE_L,
    STRAP_INDEX_SOC_PAD_TRI_N,
    STRAP_INDEX_SOC_CORE_TAP_CTRL_L,
    STRAP_INDEX_SOC_BOOT_SOURCE_0_4,
    STRAP_INDEX_SOC_BOOT_SOURCE_5_6,
    STRAP_INDEX_SOC_BOOT_SOURCE_7,
    STRAP_INDEX_SOC_GPIO2,
    STRAP_INDEX_S_OWL_BOOT_SOURCE_0_7,
    STRAP_INDEX_N_OWL_BOOT_SOURCE_0_7,
    STRAP_INDEX_S_OWL_PAD_TRI_N,
    STRAP_INDEX_S_OWL_ATPG_MODE_L,
    STRAP_INDEX_S_OWL_DFT_TAP_EN_L,
    STRAP_INDEX_S_OWL_CORE_TAP_CTRL_L,
    STRAP_INDEX_N_OWL_PAD_TRI_N,
    STRAP_INDEX_N_OWL_ATPG_MODE_L,
    STRAP_INDEX_N_OWL_DFT_TAP_EN_L,
    STRAP_INDEX_N_OWL_CORE_TAP_CTRL_L,
    STRAP_INDEX_S_OWL_JTAG_MUX_SEL_0_3,
    STRAP_INDEX_N_OWL_JTAG_MUX_SEL_0_3,
    STRAP_INDEX_S_OWL_UART_MUX_SEL_0_2,
    STRAP_INDEX_N_OWL_UART_MUX_SEL_0_2,
    STRAP_INDEX_MAX,
};
 
enum UBC_VR_RAIL_E {
    UBC_VR_RAIL_E_UBC1,
    UBC_VR_RAIL_E_UBC2,
    UBC_VR_RAIL_E_P3V3,
    UBC_VR_RAIL_E_P0V85_PVDD,
    UBC_VR_RAIL_E_P0V75_PVDD_CH_N,
    UBC_VR_RAIL_E_P0V75_MAX_PHY_N,
    UBC_VR_RAIL_E_P0V75_PVDD_CH_S,
    UBC_VR_RAIL_E_P0V75_MAX_PHY_S,
    UBC_VR_RAIL_E_P0V75_TRVDD_ZONEA,
    UBC_VR_RAIL_E_P1V8_VPP_HBM0_HBM2_HBM4,
    UBC_VR_RAIL_E_P0V75_TRVDD_ZONEB,
    UBC_VR_RAIL_E_P0V4_VDDQL_HBM0_HBM2_HBM4,
    UBC_VR_RAIL_E_P1V1_VDDC_HBM0_HBM2_HBM4,
    UBC_VR_RAIL_E_P0V75_VDDPHY_HBM0_HBM2_HBM4,
    UBC_VR_RAIL_E_P0V9_TRVDD_ZONEA,
    UBC_VR_RAIL_E_P1V8_VPP_HBM1_HBM3_HBM5,
    UBC_VR_RAIL_E_P0V9_TRVDD_ZONEB,
    UBC_VR_RAIL_E_P0V4_VDDQL_HBM1_HBM3_HBM5,
    UBC_VR_RAIL_E_P1V1_VDDC_HBM1_HBM3_HBM5,
    UBC_VR_RAIL_E_P0V75_VDDPHY_HBM1_HBM3_HBM5,
    UBC_VR_RAIL_E_P0V8_VDDA_PCIE,
    UBC_VR_RAIL_E_P1V2_VDDHTX_PCIE,
    UBC_VR_RAIL_E_MAX,
};
 
enum POWER_CAPPING_INDEX_E {
    POWER_CAPPING_INDEX_HC = 0,
    POWER_CAPPING_INDEX_LC,
    POWER_CAPPING_INDEX_INTERVAL,
    POWER_CAPPING_INDEX_SWITCH,
    POWER_CAPPING_INDEX_AVERAGE,
    POWER_CAPPING_INDEX_MAX,
};
 
typedef struct power_capping_mapping_sensor {
    uint8_t index;
    uint8_t *sensor_name;
    uint16_t change_setting_value;
} power_capping_mapping_sensor;
 
typedef struct power_capping_user_settings_struct {
    uint16_t user_setting_value[POWER_CAPPING_INDEX_MAX];
} power_capping_user_settings_struct;
 
extern power_capping_user_settings_struct power_capping_user_settings;
 
typedef struct vr_vout_range_user_settings_struct {
    uint16_t default_vout_max[STRAP_INDEX_MAX];
    uint16_t default_vout_min[STRAP_INDEX_MAX];
    uint16_t change_vout_max[STRAP_INDEX_MAX];
    uint16_t change_vout_min[STRAP_INDEX_MAX];
} vr_vout_range_user_settings_struct;
 
extern vr_vout_range_user_settings_struct vout_range_user_settings;
 
typedef struct bootstrap_user_settings_struct {
    uint16_t user_setting_value[STRAP_INDEX_MAX];
} bootstrap_user_settings_struct;
 
extern bootstrap_user_settings_struct bootstrap_user_settings;
 
typedef struct thermaltrip_user_settings_struct {
    uint8_t thermaltrip_user_setting_value;
} thermaltrip_user_settings_struct;
 
extern thermaltrip_user_settings_struct thermaltrip_user_settings;
 
typedef struct throttle_user_settings_struct {
    uint8_t throttle_user_setting_value;
} throttle_user_settings_struct;
 
extern throttle_user_settings_struct throttle_user_settings;
 
typedef struct vr_mapping_sensor {
    uint8_t index;
    uint8_t sensor_id;
    uint8_t *sensor_name;
    int peak_value;
} vr_mapping_sensor;
 
typedef struct vr_vout_user_settings {
    uint16_t vout[VR_RAIL_E_MAX];
} vr_vout_user_settings;
 
extern vr_vout_user_settings user_settings;
 
typedef struct vr_mapping_status {
    uint8_t index;
    uint16_t pmbus_reg;
    uint8_t *vr_status_name;
} vr_mapping_status;
 
extern vr_mapping_sensor vr_rail_table[];
 
typedef struct _vr_pre_proc_arg {
    void *mutex;
    uint8_t vr_page;
} vr_pre_proc_arg;
 
typedef struct temp_mapping_sensor {
    uint8_t index;
    uint8_t sensor_id;
    uint8_t *sensor_name;
} temp_mapping_sensor;
 
typedef struct power_sequence {
    uint8_t index;
    uint8_t cpld_offsets;
    uint8_t *power_rail_name;
    uint8_t value;
} power_sequence;
 
extern power_sequence power_sequence_on_table[];
extern power_sequence power_sequence_off_table[];
extern size_t power_sequence_on_table_size;
extern size_t power_sequence_off_table_size;
 
extern vr_pre_proc_arg vr_pre_read_args[];
extern mp2971_init_arg mp2971_init_args[];
extern isl69259_init_arg isl69259_init_args[];
extern mpc12109_init_arg mpc12109_init_args[];
 
typedef struct temp_threshold_user_settings_struct {
    uint32_t temperature_reg_val[PLAT_TEMP_INDEX_THRESHOLD_TYPE_MAX];
} temp_threshold_user_settings_struct;
 
extern temp_threshold_user_settings_struct temp_threshold_user_settings;
 
typedef struct temp_threshold_mapping_sensor {
    uint8_t temp_index_threshold_type; //PLAT_TEMP_INDEX_THRESHOLD_TYPE_E
    uint8_t temp_threshold_type;
    uint8_t sensor_id;
    uint8_t *temp_threshold_name;
} temp_threshold_mapping_sensor;
 
extern temp_threshold_mapping_sensor temp_threshold_table[];
 
typedef struct bootstrap_mapping_register {
    uint8_t index;
    uint8_t cpld_offsets;
    uint8_t *strap_name;
    uint8_t bit_offset;
    uint8_t bit_count;
    uint8_t default_setting_value;
    uint8_t change_setting_value;
    bool reverse;
    uint8_t *strap_name_comment;
} bootstrap_mapping_register;
 
typedef struct ubc_vr_power_mapping_sensor {
    uint8_t index;
    uint8_t sensor_id;
    uint8_t *sensor_name;
    uint32_t power_history[POWER_HISTORY_SIZE];
} ubc_vr_power_mapping_sensor;
 
bool get_temp_index_threshold_type(uint8_t temp_threshold_type, uint8_t sensor_id,
                   uint8_t *temp_index_threshold_type);
bool plat_get_vout_range(uint8_t rail, uint16_t *vout_max_millivolt, uint16_t *vout_min_millivolt);
bool plat_set_vout_range_min(uint8_t rail, uint16_t *millivolt);
bool plat_set_vout_range_max(uint8_t rail, uint16_t *millivolt);
bool temp_sensor_rail_name_get(uint8_t rail, uint8_t **name);
bool temp_sensor_rail_enum_get(uint8_t *name, uint8_t *num);
bool plat_get_temp_status(uint8_t rail, uint8_t *temp_status);
bool plat_clear_temp_status(uint8_t rail);
bool pre_vr_read(sensor_cfg *cfg, void *args);
bool post_vr_read(sensor_cfg *cfg, void *args, int *const reading);
bool perm_config_clear();
bool is_mb_dc_on();
void *vr_mutex_get(enum VR_INDEX_E vr_index);
void vr_mutex_init(void);
bool vr_rail_name_get(uint8_t rail, uint8_t **name);
bool vr_rail_enum_get(uint8_t *name, uint8_t *num);
int power_level_send_event(bool is_assert, int ubc1_current, int ubc2_current);
bool post_ubc_read(sensor_cfg *cfg, void *args, int *reading);
bool post_all_sensor_read(sensor_cfg *cfg, void *args, int *reading);
void set_uart_power_event_is_enable(bool is_enable);
void pwr_level_mutex_init(void);
void set_alert_level_to_default_or_user_setting(bool is_default, int32_t user_setting);
int set_user_settings_alert_level_to_eeprom(void *user_settings, uint8_t data_length);
int get_user_settings_alert_level_from_eeprom(void *user_settings, uint8_t data_length);
int get_alert_level_info(bool *is_assert, int32_t *default_value, int32_t *setting_value);
bool set_user_settings_soc_pcie_perst_to_eeprom(void *user_settings, uint8_t data_length);
bool get_user_settings_soc_pcie_perst_from_eeprom(void *user_settings, uint8_t data_length);
bool vr_rail_voltage_peak_get(uint8_t *name, int *peak_value);
bool vr_rail_voltage_peak_clear(uint8_t rail_index);
bool vr_vout_user_settings_get(void *user_settings);
void user_settings_init(void);
bool temp_index_threshold_type_name_get(uint8_t type, uint8_t **name);
bool temp_threshold_type_enum_get(uint8_t *name, uint8_t *num);
bool plat_get_temp_threshold(uint8_t temp_index_threshold_type, uint32_t *millidegree_celsius);
bool plat_set_temp_threshold(uint8_t temp_index_threshold_type, uint32_t *millidegree_celsius,
                 bool is_default, bool is_perm);
bool plat_get_vout_command(uint8_t rail, uint16_t *millivolt);
bool plat_set_vout_command(uint8_t rail, uint16_t *millivolt, bool is_default, bool is_perm);
bool plat_get_vr_status(uint8_t rail, uint8_t vr_status_rail, uint16_t *vr_status);
bool plat_clear_vr_status(uint8_t rail);
bool vr_status_name_get(uint8_t rail, uint8_t **name);
bool vr_status_enum_get(uint8_t *name, uint8_t *num);
bool vr_vout_default_settings_init(void);
bool vr_vout_user_settings_init(void);
bool get_user_settings_thermaltrip_from_eeprom(void *user_settings, uint8_t data_length);
bool set_thermaltrip_user_settings(bool thermaltrip_enable, bool is_perm);
bool get_user_settings_throttle_from_eeprom(void *user_settings, uint8_t data_length);
bool set_throttle_user_settings(uint8_t *throttle_status_reg, bool is_perm);
bool strap_name_get(uint8_t rail, uint8_t **name);
bool strap_enum_get(uint8_t *name, uint8_t *num);
void init_temp_alert_mode(void);
bool find_bootstrap_by_rail(uint8_t rail, bootstrap_mapping_register *result);
bool set_bootstrap_table_and_user_settings(uint8_t rail, uint8_t *change_setting_value,
                       uint8_t drive_index_level, bool is_perm,
                       bool is_default);
bool get_bootstrap_change_drive_level(int rail, int *drive_level);
void init_temp_limit(void);
bool ubc_vr_rail_name_get(uint8_t rail, uint8_t **name);
bool ubc_vr_rail_enum_get(uint8_t *name, uint8_t *num);
bool get_average_power(uint8_t rail, uint32_t *milliwatt);
bool voltage_command_setting_get(uint8_t rail, uint16_t *vout);
bool power_capping_rail_name_get(uint8_t rail, uint8_t **name);
bool power_capping_rail_enum_get(uint8_t *name, uint8_t *num);
bool plat_set_power_capping_command(uint8_t rail, uint16_t *set_value, bool is_perm);
bool plat_get_power_capping_command(uint8_t rail, uint16_t *set_value);
 
#endif