/*
 * Copyright 2017 Advanced Micro Devices, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#include "vega12_thermal.h"
#include "vega12_hwmgr.h"
#include "vega12_smumgr.h"
#include "vega12_ppsmc.h"
#include "vega12_inc.h"
#include "pp_soc15.h"
#include "pp_debug.h"

static int vega12_get_current_rpm(struct pp_hwmgr *hwmgr, uint32_t *current_rpm)
{
        PP_ASSERT_WITH_CODE(!smum_send_msg_to_smc(hwmgr,
                                PPSMC_MSG_GetCurrentRpm),
                        "Attempt to get current RPM from SMC Failed!",
                        return -1);
        PP_ASSERT_WITH_CODE(!vega12_read_arg_from_smc(hwmgr,
                        current_rpm),
                        "Attempt to read current RPM from SMC Failed!",
                        return -1);
        return 0;
}

int vega12_fan_ctrl_get_fan_speed_info(struct pp_hwmgr *hwmgr,
                struct phm_fan_speed_info *fan_speed_info)
{
        memset(fan_speed_info, 0, sizeof(*fan_speed_info));
        fan_speed_info->supports_percent_read = false;
        fan_speed_info->supports_percent_write = false;
        fan_speed_info->supports_rpm_read = true;
        fan_speed_info->supports_rpm_write = true;

        return 0;
}

int vega12_fan_ctrl_get_fan_speed_rpm(struct pp_hwmgr *hwmgr, uint32_t *speed)
{
        *speed = 0;

        return vega12_get_current_rpm(hwmgr, speed);
}

/**
 * @fn vega12_enable_fan_control_feature
 * @brief Enables the SMC Fan Control Feature.
 *
 * @param    hwmgr - the address of the powerplay hardware manager.
 * @return   0 on success. -1 otherwise.
 */
static int vega12_enable_fan_control_feature(struct pp_hwmgr *hwmgr)
{
#if 0
        struct vega12_hwmgr *data = (struct vega12_hwmgr *)(hwmgr->backend);

        if (data->smu_features[GNLD_FAN_CONTROL].supported) {
                PP_ASSERT_WITH_CODE(!vega12_enable_smc_features(
                                hwmgr, true,
                                data->smu_features[GNLD_FAN_CONTROL].
                                smu_feature_bitmap),
                                "Attempt to Enable FAN CONTROL feature Failed!",
                                return -1);
                data->smu_features[GNLD_FAN_CONTROL].enabled = true;
        }
#endif
        return 0;
}

static int vega12_disable_fan_control_feature(struct pp_hwmgr *hwmgr)
{
#if 0
        struct vega12_hwmgr *data = (struct vega12_hwmgr *)(hwmgr->backend);

        if (data->smu_features[GNLD_FAN_CONTROL].supported) {
                PP_ASSERT_WITH_CODE(!vega12_enable_smc_features(
                                hwmgr, false,
                                data->smu_features[GNLD_FAN_CONTROL].
                                smu_feature_bitmap),
                                "Attempt to Enable FAN CONTROL feature Failed!",
                                return -1);
                data->smu_features[GNLD_FAN_CONTROL].enabled = false;
        }
#endif
        return 0;
}

int vega12_fan_ctrl_start_smc_fan_control(struct pp_hwmgr *hwmgr)
{
        struct vega12_hwmgr *data = (struct vega12_hwmgr *)(hwmgr->backend);

        if (data->smu_features[GNLD_FAN_CONTROL].supported)
                PP_ASSERT_WITH_CODE(
                                !vega12_enable_fan_control_feature(hwmgr),
                                "Attempt to Enable SMC FAN CONTROL Feature Failed!",
                                return -1);

        return 0;
}


int vega12_fan_ctrl_stop_smc_fan_control(struct pp_hwmgr *hwmgr)
{
        struct vega12_hwmgr *data = (struct vega12_hwmgr *)(hwmgr->backend);

        if (data->smu_features[GNLD_FAN_CONTROL].supported)
                PP_ASSERT_WITH_CODE(!vega12_disable_fan_control_feature(hwmgr),
                                "Attempt to Disable SMC FAN CONTROL Feature Failed!",
                                return -1);

        return 0;
}

/**
* Reset Fan Speed to default.
* @param    hwmgr  the address of the powerplay hardware manager.
* @exception Always succeeds.
*/
int vega12_fan_ctrl_reset_fan_speed_to_default(struct pp_hwmgr *hwmgr)
{
        return vega12_fan_ctrl_start_smc_fan_control(hwmgr);
}

/**
* Reads the remote temperature from the SIslands thermal controller.
*
* @param    hwmgr The address of the hardware manager.
*/
int vega12_thermal_get_temperature(struct pp_hwmgr *hwmgr)
{
        int temp = 0;
        uint32_t reg;

        reg = soc15_get_register_offset(THM_HWID, 0,
                        mmCG_MULT_THERMAL_STATUS_BASE_IDX,  mmCG_MULT_THERMAL_STATUS);

        temp = cgs_read_register(hwmgr->device, reg);

        temp = (temp & CG_MULT_THERMAL_STATUS__CTF_TEMP_MASK) >>
                        CG_MULT_THERMAL_STATUS__CTF_TEMP__SHIFT;

        temp = temp & 0x1ff;

        temp *= PP_TEMPERATURE_UNITS_PER_CENTIGRADES;
        return temp;
}

/**
* Set the requested temperature range for high and low alert signals
*
* @param    hwmgr The address of the hardware manager.
* @param    range Temperature range to be programmed for
*           high and low alert signals
* @exception PP_Result_BadInput if the input data is not valid.
*/
static int vega12_thermal_set_temperature_range(struct pp_hwmgr *hwmgr,
                struct PP_TemperatureRange *range)
{
        int low = VEGA12_THERMAL_MINIMUM_ALERT_TEMP *
                        PP_TEMPERATURE_UNITS_PER_CENTIGRADES;
        int high = VEGA12_THERMAL_MAXIMUM_ALERT_TEMP *
                        PP_TEMPERATURE_UNITS_PER_CENTIGRADES;
        uint32_t val, reg;

        if (low < range->min)
                low = range->min;
        if (high > range->max)
                high = range->max;

        if (low > high)
                return -EINVAL;

        reg = soc15_get_register_offset(THM_HWID, 0,
                        mmTHM_THERMAL_INT_CTRL_BASE_IDX, mmTHM_THERMAL_INT_CTRL);

        val = cgs_read_register(hwmgr->device, reg);

        val = CGS_REG_SET_FIELD(val, THM_THERMAL_INT_CTRL, MAX_IH_CREDIT, 5);
        val = CGS_REG_SET_FIELD(val, THM_THERMAL_INT_CTRL, THERM_IH_HW_ENA, 1);
        val = CGS_REG_SET_FIELD(val, THM_THERMAL_INT_CTRL, DIG_THERM_INTH, (high / PP_TEMPERATURE_UNITS_PER_CENTIGRADES));
        val = CGS_REG_SET_FIELD(val, THM_THERMAL_INT_CTRL, DIG_THERM_INTL, (low / PP_TEMPERATURE_UNITS_PER_CENTIGRADES));
        val = val & (~THM_THERMAL_INT_CTRL__THERM_TRIGGER_MASK_MASK);

        cgs_write_register(hwmgr->device, reg, val);

        return 0;
}

/**
* Enable thermal alerts on the RV770 thermal controller.
*
* @param    hwmgr The address of the hardware manager.
*/
static int vega12_thermal_enable_alert(struct pp_hwmgr *hwmgr)
{
        uint32_t val = 0;
        uint32_t reg;

        val |= (1 << THM_THERMAL_INT_ENA__THERM_INTH_CLR__SHIFT);
        val |= (1 << THM_THERMAL_INT_ENA__THERM_INTL_CLR__SHIFT);
        val |= (1 << THM_THERMAL_INT_ENA__THERM_TRIGGER_CLR__SHIFT);

        reg = soc15_get_register_offset(THM_HWID, 0, mmTHM_THERMAL_INT_ENA_BASE_IDX, mmTHM_THERMAL_INT_ENA);
        cgs_write_register(hwmgr->device, reg, val);

        return 0;
}

/**
* Disable thermal alerts on the RV770 thermal controller.
* @param    hwmgr The address of the hardware manager.
*/
int vega12_thermal_disable_alert(struct pp_hwmgr *hwmgr)
{
        uint32_t reg;

        reg = soc15_get_register_offset(THM_HWID, 0, mmTHM_THERMAL_INT_ENA_BASE_IDX, mmTHM_THERMAL_INT_ENA);
        cgs_write_register(hwmgr->device, reg, 0);

        return 0;
}

/**
* Uninitialize the thermal controller.
* Currently just disables alerts.
* @param    hwmgr The address of the hardware manager.
*/
int vega12_thermal_stop_thermal_controller(struct pp_hwmgr *hwmgr)
{
        int result = vega12_thermal_disable_alert(hwmgr);

        return result;
}

/**
* Set up the fan table to control the fan using the SMC.
* @param    hwmgr  the address of the powerplay hardware manager.
* @param    pInput the pointer to input data
* @param    pOutput the pointer to output data
* @param    pStorage the pointer to temporary storage
* @param    Result the last failure code
* @return   result from set temperature range routine
*/
int vega12_thermal_setup_fan_table(struct pp_hwmgr *hwmgr)
{
        int ret;
        struct vega12_hwmgr *data = (struct vega12_hwmgr *)(hwmgr->backend);
        PPTable_t *table = &(data->smc_state_table.pp_table);

        ret = smum_send_msg_to_smc_with_parameter(hwmgr,
                                PPSMC_MSG_SetFanTemperatureTarget,
                                (uint32_t)table->FanTargetTemperature);

        return ret;
}

/**
* Start the fan control on the SMC.
* @param    hwmgr  the address of the powerplay hardware manager.
* @param    pInput the pointer to input data
* @param    pOutput the pointer to output data
* @param    pStorage the pointer to temporary storage
* @param    Result the last failure code
* @return   result from set temperature range routine
*/
int vega12_thermal_start_smc_fan_control(struct pp_hwmgr *hwmgr)
{
        /* If the fantable setup has failed we could have disabled
         * PHM_PlatformCaps_MicrocodeFanControl even after
         * this function was included in the table.
         * Make sure that we still think controlling the fan is OK.
         */
        if (PP_CAP(PHM_PlatformCaps_MicrocodeFanControl))
                vega12_fan_ctrl_start_smc_fan_control(hwmgr);

        return 0;
}


int vega12_start_thermal_controller(struct pp_hwmgr *hwmgr,
                                struct PP_TemperatureRange *range)
{
        int ret = 0;

        if (range == NULL)
                return -EINVAL;

        ret = vega12_thermal_set_temperature_range(hwmgr, range);
        if (ret)
                return -EINVAL;

        vega12_thermal_enable_alert(hwmgr);
        /* We should restrict performance levels to low before we halt the SMC.
         * On the other hand we are still in boot state when we do this
         * so it would be pointless.
         * If this assumption changes we have to revisit this table.
         */
        ret = vega12_thermal_setup_fan_table(hwmgr);
        if (ret)
                return -EINVAL;

        vega12_thermal_start_smc_fan_control(hwmgr);

        return 0;
};