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"
#include "plat_pldm_sensor.h"
 
#define VR_MUTEX_LOCK_TIMEOUT_MS 1000
 
extern mp2971_init_arg mp2971_init_args[];
 
enum VR_INDEX_E {
    VR_INDEX_E_1 = 0,
    VR_INDEX_E_2,
    VR_INDEX_E_3,
    VR_INDEX_E_4,
    VR_INDEX_E_5,
    VR_INDEX_E_6,
    VR_INDEX_E_7,
    VR_INDEX_E_8,
    VR_INDEX_E_9,
    VR_INDEX_E_10,
    VR_INDEX_E_11,
    VR_INDEX_E_12,
    VR_INDEX_E_13, // P3V3 OSFP
    VR_INDEX_MAX,
};
 
enum VR_RAIL_E {
    VR_RAIL_E_ASIC_P0V85_MEDHA0_VDD = 0,
    VR_RAIL_E_ASIC_P0V85_MEDHA1_VDD,
    VR_RAIL_E_ASIC_P0V9_OWL_E_TRVDD,
    VR_RAIL_E_ASIC_P0V75_OWL_E_TRVDD,
    VR_RAIL_E_ASIC_P0V75_MAX_M_VDD,
    VR_RAIL_E_ASIC_P0V75_VDDPHY_HBM1357,
    VR_RAIL_E_ASIC_P0V75_OWL_E_VDD,
    VR_RAIL_E_ASIC_P0V4_VDDQL_HBM1357,
    VR_RAIL_E_ASIC_P1V1_VDDQC_HBM1357,
    VR_RAIL_E_ASIC_P1V8_VPP_HBM1357,
    VR_RAIL_E_ASIC_P0V75_MAX_N_VDD,
    VR_RAIL_E_ASIC_P0V8_HAMSA_AVDD_PCIE,
    VR_RAIL_E_ASIC_P1V2_HAMSA_VDDHRXTX_PCIE,
    VR_RAIL_E_ASIC_P0V85_HAMSA_VDD,
    VR_RAIL_E_ASIC_P1V1_VDDQC_HBM0246,
    VR_RAIL_E_ASIC_P1V8_VPP_HBM0246,
    VR_RAIL_E_ASIC_P0V4_VDDQL_HBM0246,
    VR_RAIL_E_ASIC_P0V75_VDDPHY_HBM0246,
    VR_RAIL_E_ASIC_P0V75_OWL_W_VDD,
    VR_RAIL_E_ASIC_P0V75_MAX_S_VDD,
    VR_RAIL_E_ASIC_P0V9_OWL_W_TRVDD,
    VR_RAIL_E_ASIC_P0V75_OWL_W_TRVDD,
    VR_RAIL_E_P3V3_OSFP_VOLT_V,
    VR_RAIL_E_MAX,
};
enum UBC_VR_RAIL_E {
    UBC_VR_RAIL_E_UBC1,
    UBC_VR_RAIL_E_UBC2,
    UBC_VR_RAIL_E_ASIC_P0V85_MEDHA0_VDD,
    UBC_VR_RAIL_E_ASIC_P0V85_MEDHA1_VDD,
    UBC_VR_RAIL_E_ASIC_P0V9_OWL_E_TRVDD,
    UBC_VR_RAIL_E_ASIC_P0V75_OWL_E_TRVDD,
    UBC_VR_RAIL_E_ASIC_P0V75_MAX_M_VDD,
    UBC_VR_RAIL_E_ASIC_P0V75_VDDPHY_HBM1357,
    UBC_VR_RAIL_E_ASIC_P0V75_OWL_E_VDD,
    UBC_VR_RAIL_E_ASIC_P0V4_VDDQL_HBM1357,
    UBC_VR_RAIL_E_ASIC_P1V1_VDDQC_HBM1357,
    UBC_VR_RAIL_E_ASIC_P1V8_VPP_HBM1357,
    UBC_VR_RAIL_E_ASIC_P0V75_MAX_N_VDD,
    UBC_VR_RAIL_E_ASIC_P0V8_HAMSA_AVDD_PCIE,
    UBC_VR_RAIL_E_ASIC_P1V2_HAMSA_VDDHRXTX_PCIE,
    UBC_VR_RAIL_E_ASIC_P0V85_HAMSA_VDD,
    UBC_VR_RAIL_E_ASIC_P1V1_VDDQC_HBM0246,
    UBC_VR_RAIL_E_ASIC_P1V8_VPP_HBM0246,
    UBC_VR_RAIL_E_ASIC_P0V4_VDDQL_HBM0246,
    UBC_VR_RAIL_E_ASIC_P0V75_VDDPHY_HBM0246,
    UBC_VR_RAIL_E_ASIC_P0V75_OWL_W_VDD,
    UBC_VR_RAIL_E_ASIC_P0V75_MAX_S_VDD,
    UBC_VR_RAIL_E_ASIC_P0V9_OWL_W_TRVDD,
    UBC_VR_RAIL_E_ASIC_P0V75_OWL_W_TRVDD,
    UBC_VR_RAIL_E_P3V3_OSFP,
    UBC_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,
};
 
typedef struct vr_mapping_status {
    uint8_t index;
    uint16_t pmbus_reg;
    uint8_t *vr_status_name;
} vr_mapping_status;
 
typedef struct _vr_pre_proc_arg {
    void *mutex;
    uint8_t vr_page;
} vr_pre_proc_arg;
 
typedef struct vr_mapping_sensor {
    uint8_t index;
    uint8_t sensor_id;
    uint8_t *sensor_name;
    int peak_value;
} vr_mapping_sensor;
 
enum PLAT_STRAP_INDEX_E {
    STRAP_INDEX_HAMSA_TEST_STRAP_R = 0,
    STRAP_INDEX_HAMSA_LS_STRAP_0,
    STRAP_INDEX_HAMSA_LS_STRAP_1,
    STRAP_INDEX_HAMSA_CRM_STRAP_0,
    STRAP_INDEX_HAMSA_CRM_STRAP_1,
    STRAP_INDEX_HAMSA_MFIO12,
    STRAP_INDEX_HAMSA_MFIO13,
    STRAP_INDEX_HAMSA_MFIO14,
    STRAP_INDEX_HAMSA_MFIO7,
    STRAP_INDEX_HAMSA_MFIO9,
    STRAP_INDEX_HAMSA_MFIO11,
    STRAP_INDEX_HAMSA_MFIO17,
    STRAP_INDEX_HAMSA_MFIO18,
    STRAP_INDEX_HAMSA_CORE_TAP_CTRL_L,
    STRAP_INDEX_HAMSA_TRI_L,
    STRAP_INDEX_HAMSA_ATPG_MODE_L,
    STRAP_INDEX_HAMSA_DFT_TAP_EN_L,
    STRAP_INDEX_FM_JTAG_HAMSA_JTCE_0_3,
    STRAP_INDEX_MEDHA0_TEST_STRAP,
    STRAP_INDEX_MEDHA0_CRM_STRAP_0,
    STRAP_INDEX_MEDHA0_CRM_STRAP_1,
    STRAP_INDEX_MEDHA0_CHIP_STRAP_0,
    STRAP_INDEX_MEDHA0_CHIP_STRAP_1,
    STRAP_INDEX_MEDHA0_CORE_TAP_CTRL_PLD_L,
    STRAP_INDEX_MEDHA0_TRI_L,
    STRAP_INDEX_MEDHA0_ATPG_MODE_L,
    STRAP_INDEX_MEDHA0_DFT_TAP_EN_PLD_L,
    STRAP_INDEX_MEDHA1_TEST_STRAP,
    STRAP_INDEX_MEDHA1_CRM_STRAP_0,
    STRAP_INDEX_MEDHA1_CRM_STRAP_1,
    STRAP_INDEX_MEDHA1_CHIP_STRAP_0,
    STRAP_INDEX_MEDHA1_CHIP_STRAP_1,
    STRAP_INDEX_MEDHA1_CORE_TAP_CTRL_PLD_L,
    STRAP_INDEX_MEDHA1_TRI_L,
    STRAP_INDEX_MEDHA1_ATPG_MODE_L,
    STRAP_INDEX_MEDHA1_DFT_TAP_EN_PLD_L,
    STRAP_INDEX_MEDHA0_MFIO_12,
    STRAP_INDEX_MEDHA0_MFIO_13,
    STRAP_INDEX_MEDHA0_MFIO_14,
    STRAP_INDEX_MEDHA1_MFIO_12,
    STRAP_INDEX_MEDHA1_MFIO_13,
    STRAP_INDEX_MEDHA1_MFIO_14,
    STRAP_INDEX_FM_JTAG_MEDHA0_JTCE_0_2,
    STRAP_INDEX_FM_JTAG_MEDHA1_JTCE_0_2,
    STRAP_INDEX_PLD_OWL_E_DFT_TAP_EN_L,
    STRAP_INDEX_PLD_OWL_E_CORE_TAP_CTRL_L,
    STRAP_INDEX_PLD_OWL_E_PAD_TRI_L,
    STRAP_INDEX_PLD_OWL_E_ATPG_MODE_L,
    STRAP_INDEX_PLD_OWL_W_DFT_TAP_EN_L,
    STRAP_INDEX_PLD_OWL_W_CORE_TAP_CTRL_L,
    STRAP_INDEX_PLD_OWL_W_PAD_TRI_L,
    STRAP_INDEX_PLD_OWL_W_ATPG_MODE_L,
    STRAP_INDEX_OWL_E_JTAG_MUX_PLD_SEL_0_3,
    STRAP_INDEX_OWL_W_JTAG_MUX_PLD_SEL_0_3,
    STRAP_INDEX_OWL_E_UART_MUX_PLD_SEL_0_2,
    STRAP_INDEX_OWL_W_UART_MUX_PLD_SEL_0_2,
    STRAP_INDEX_OWL_E_DVT_ENABLE,
    STRAP_INDEX_OWL_W_DVT_ENABLE,
    STRAP_INDEX_OWL_E_BOOT_SOURCE_0_7,
    STRAP_INDEX_OWL_W_BOOT_SOURCE_0_7,
    STRAP_INDEX_EXCEPT_EVB_MAX,
    STRAP_INDEX_HAMSA_MFIO6 = STRAP_INDEX_EXCEPT_EVB_MAX,
    STRAP_INDEX_HAMSA_MFIO8,
    STRAP_INDEX_HAMSA_MFIO10,
    STRAP_INDEX_MEDHA0_MFIO6,
    STRAP_INDEX_MEDHA0_MFIO8,
    STRAP_INDEX_MEDHA0_MFIO10,
    STRAP_INDEX_MEDHA1_MFIO6,
    STRAP_INDEX_MEDHA1_MFIO8,
    STRAP_INDEX_MEDHA1_MFIO10,
    STRAP_INDEX_MAX,
};
 
enum STRAP_TYPE_E {
    STRAP_TYPE_CPLD = 0,
    STRAP_TYPE_IOEXP_PCA6416A,
    STRAP_TYPE_IOEXP_TCA6424A,
    STRAP_TYPE_MAX,
};
 
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;
typedef struct vr_vout_user_settings {
    uint16_t vout[VR_RAIL_E_MAX];
} vr_vout_user_settings;
typedef struct bootstrap_mapping_register {
    uint8_t index;
    uint8_t type;
    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;
} bootstrap_mapping_register;
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;
extern vr_vout_user_settings user_settings;
extern vr_vout_range_user_settings_struct vout_range_user_settings;
extern vr_mapping_sensor vr_rail_table[];
extern bootstrap_mapping_register bootstrap_table[];
bool pre_vr_read(sensor_cfg *cfg, void *args);
bool post_vr_read(sensor_cfg *cfg, void *args, int *const reading);
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_status_name_get(uint8_t rail, uint8_t **name);
bool vr_rail_enum_get(uint8_t *name, uint8_t *num);
bool vr_status_enum_get(uint8_t *name, uint8_t *num);
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 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 vr_rail_voltage_peak_get(uint8_t *name, int *peak_value);
bool vr_rail_voltage_peak_clear(uint8_t rail_index);
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 vr_vout_user_settings_get(void *user_settings);
void user_settings_init(void);
bool vr_vout_range_user_settings_init(void);
bool vr_vout_default_settings_init(void);
bool vr_vout_user_settings_init(void);
bool temp_threshold_user_settings_get(void *temp_threshold_user_settings);
bool plat_get_temp_threshold(uint8_t temp_index_threshold_type, uint32_t *millidegree_celsius);
bool bootstrap_default_settings_init(void);
bool bootstrap_user_settings_init(void);
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 strap_name_get(uint8_t rail, uint8_t **name);
bool strap_enum_get(uint8_t *name, uint8_t *num);
bool get_bootstrap_change_drive_level(int rail, int *drive_level);
bool find_bootstrap_by_rail(uint8_t rail, bootstrap_mapping_register *result);
bool post_common_sensor_read(sensor_cfg *cfg, void *args, int *const reading);
bool voltage_command_setting_get(uint8_t rail, uint16_t *vout);
bool post_sensor_reading_hook_func(uint8_t sensor_number);
bool post_ubc_read(sensor_cfg *cfg, void *args, int *reading);
bool bootstrap_user_settings_set(void *bootstrap_user_settings);
bool vr_vout_user_settings_set(void *user_settings_value);
bool set_bootstrap_table_val_to_ioexp(void);
bool set_bootstrap_val_to_device(uint8_t strap, uint8_t val);
uint8_t get_strap_index_max();
#endif