plat_user_setting.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_USER_SETTING_H
#define PLAT_USER_SETTING_H
 
#include "sensor.h"
#include "plat_pldm_sensor.h"
#include "plat_cpld.h"
 
#define VR_MUTEX_LOCK_TIMEOUT_MS 1000
#define TEMP_THRESHOLD_USER_SETTINGS_OFFSET 0x8100
#define VR_VOUT_USER_SETTINGS_OFFSET 0x8000
#define ALERT_LEVEL_USER_SETTINGS_OFFSET 0x8200
#define DELAY_PCIE_PERST_USER_SETTINGS_OFFSET 0x8300
#define BOOTSTRAP_USER_SETTINGS_OFFSET 0x8400
#define THERMALTRIP_USER_SETTINGS_OFFSET 0x8500
#define THROTTLE_USER_SETTINGS_OFFSET 0x8600
#define DELAY_ASIC_RST_USER_SETTINGS_OFFSET 0x8700
#define DELAY_MODULE_PG_USER_SETTINGS_OFFSET 0x8800
#define HAMSA_AVDD_PCIE_VOUT_USER_SETTINGS_OFFSET 0x8900
 
#define CPLD_THROTTLE_SWITCH_ADDR 0x25
#define CPLD_THERMALTRIP_SWITCH_ADDR 0x3A
 
#define CLK_BUF_U87_ADDR (0xD8 >> 1)
#define CLK_BUF_U88_ADDR (0xDE >> 1)
 
enum USER_SETTING_OFFSET_E {
    THERMALTRIP,
};
 
enum PLAT_TEMP_INDEX_E {
    TEMP_INDEX_TOP_INLET,
    TEMP_INDEX_BOT_INLET,
    TEMP_INDEX_BOT_OUTLET,
    TEMP_INDEX_ASIC_MEDHA0_SENSOR0,
    TEMP_INDEX_ASIC_MEDHA0_SENSOR1,
    TEMP_INDEX_ASIC_OWL_W,
    TEMP_INDEX_ASIC_OWL_E,
    TEMP_INDEX_ASIC_MEDHA1_SENSOR0,
    TEMP_INDEX_ASIC_MEDHA1_SENSOR1,
    TEMP_INDEX_ASIC_HAMSA_CRM,
    TEMP_INDEX_ASIC_HAMSA_LS,
    TEMP_INDEX_MAX,
};
/*
SENSOR_NUM_ASIC_MEDHA0_SENSOR0_TEMP_C 0x04
SENSOR_NUM_ASIC_MEDHA0_SENSOR1_TEMP_C 0x05
SENSOR_NUM_ASIC_OWL_W_TEMP_C 0x06
SENSOR_NUM_ASIC_OWL_E_TEMP_C 0x07
SENSOR_NUM_ASIC_MEDHA1_SENSOR0_TEMP_C 0x08
SENSOR_NUM_ASIC_MEDHA1_SENSOR1_TEMP_C 0x09
SENSOR_NUM_ASIC_HAMSA_CRM_TEMP_C 0x0A
SENSOR_NUM_ASIC_HAMSA_LS_TEMP_C 0x0B
*/
 
enum PLAT_TEMP_INDEX_THRESHOLD_TYPE_E {
    TOP_INLET_LOW_LIMIT,
    TOP_INLET_HIGH_LIMIT,
    BOT_INLET_LOW_LIMIT,
    BOT_INLET_HIGH_LIMIT,
    BOT_OUTLET_LOW_LIMIT,
    BOT_OUTLET_HIGH_LIMIT,
    ASIC_MEDHA0_SENSOR0_LOW_LIMIT,
    ASIC_MEDHA0_SENSOR0_HIGH_LIMIT,
    ASIC_MEDHA0_SENSOR1_LOW_LIMIT,
    ASIC_MEDHA0_SENSOR1_HIGH_LIMIT,
    ASIC_OWL_W_LOW_LIMIT,
    ASIC_OWL_W_HIGH_LIMIT,
    ASIC_OWL_E_LOW_LIMIT,
    ASIC_OWL_E_HIGH_LIMIT,
    ASIC_MEDHA1_SENSOR0_LOW_LIMIT,
    ASIC_MEDHA1_SENSOR0_HIGH_LIMIT,
    ASIC_MEDHA1_SENSOR1_LOW_LIMIT,
    ASIC_MEDHA1_SENSOR1_HIGH_LIMIT,
    ASIC_HAMSA_CRM_LOW_LIMIT,
    ASIC_HAMSA_CRM_HIGH_LIMIT,
    ASIC_HAMSA_LS_LOW_LIMIT,
    ASIC_HAMSA_LS_HIGH_LIMIT,
    PLAT_TEMP_INDEX_THRESHOLD_TYPE_MAX,
};
 
enum CLOCK_BUFF_COMPONENT { CLK_BUF_U87, CLK_BUF_U88, CLOCK_BUFF_COMPONENT_MAX };
 
typedef struct clock_compnt_mapping {
    uint8_t clock_name_index;
    uint8_t addr;
    uint8_t bus;
} clock_compnt_mapping;
 
typedef struct temp_mapping_sensor {
    uint8_t index;
    uint8_t sensor_id;
    uint8_t *sensor_name;
} temp_mapping_sensor;
 
extern temp_mapping_sensor temp_index_table[TEMP_INDEX_MAX];
 
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;
 
typedef struct thermaltrip_user_settings_struct {
    uint8_t thermaltrip_user_setting_value;
} thermaltrip_user_settings_struct;
 
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;
 
bool set_thermaltrip_user_settings(bool thermaltrip_enable, bool is_perm);
bool get_temp_sensor_rail_name(uint8_t rail, uint8_t **name);
bool get_temp_sensor_rail_enum(uint8_t *name, uint8_t *num);
bool plat_get_temp_status(uint8_t rail, uint8_t *temp_status);
bool get_temp_sensor_rail_name(uint8_t rail, uint8_t **name);
bool get_temp_threshold_type_enum(uint8_t *name, uint8_t *num);
bool get_temp_index_threshold_type_name(uint8_t type, uint8_t **name);
bool get_plat_temp_threshold(uint8_t temp_index_threshold_type, int32_t *millidegree_celsius);
bool set_plat_temp_threshold(uint8_t temp_index_threshold_type, uint32_t *millidegree_celsius,
                 bool is_default, bool is_perm);
bool plat_clear_temp_status(uint8_t rail);
void user_settings_init(void);
bool temp_threshold_user_settings_init(void);
bool temp_threshold_default_settings_init(void);
void set_uart_power_event_is_enable(bool is_enable);
int power_level_send_event(bool is_assert, int ubc1_current, int ubc2_current);
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_alert_level_info(bool *is_assert, int32_t *default_value, int32_t *setting_value);
int get_user_settings_alert_level_from_eeprom(void *user_settings, uint8_t data_length);
bool get_user_settings_delay_pcie_perst_from_eeprom(void *user_settings, uint8_t data_length);
bool get_user_settings_delay_asic_rst_from_eeprom(void *user_settings, uint8_t data_length);
bool get_user_settings_delay_module_pg_from_eeprom(void *user_settings, uint8_t data_length);
bool get_user_settings_thermaltrip_from_eeprom(void *thermaltrip_user_settings,
                           uint8_t data_length);
bool get_user_settings_throttle_from_eeprom(void *user_settings, uint8_t data_length);
bool set_user_settings_hamsa_avdd_pcie_to_eeprom(void *user_settings, uint8_t data_length);
bool get_user_settings_hamsa_avdd_pcie_from_eeprom(void *user_settings, uint8_t data_length);
bool perm_config_clear();
bool get_average_power(uint8_t rail, uint32_t *milliwatt);
bool post_vr_read(sensor_cfg *cfg, void *args, int *const reading);
bool ubc_vr_rail_name_get(uint8_t rail, uint8_t **name);
bool ubc_vr_rail_enum_get(uint8_t *name, uint8_t *num);
void pwr_level_mutex_init(void);
bool set_user_settings_delay_pcie_perst_to_eeprom(void *user_settings, uint8_t data_length,
                          uint8_t user_settings_offset);
bool set_user_settings_delay_asic_rst_to_eeprom(void *user_settings, uint8_t data_length);
bool set_user_settings_delay_module_pg_to_eeprom(void *user_settings, uint8_t data_length);
void set_clock_u87_u88_lphcsl_amp_ctrl_to_1v();
#endif