/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/import/chips/p9/procedures/hwp/memory/p9_mss_bulk_pwr_throttles.C $ */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2015,2019                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* 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.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */

///
/// @file p9_mss_bulk_pwr_throttles.C
/// @brief Set the throttle attributes based on a power limit for the dimms on the channel pair
///
// *HWP HWP Owner: Andre A. Marin <aamarin@us.ibm.com>
// *HWP HWP Backup: Louis Stermole <stermole@us.ibm.com>
// *HWP Team: Memory
// *HWP Level: 3
// *HWP Consumed by: FSP:HB

#include <lib/shared/nimbus_defaults.H>
#include <vector>

#include <fapi2.H>
#include <p9_mss_bulk_pwr_throttles.H>
#include <lib/utils/nimbus_find.H>
#include <generic/memory/lib/utils/count_dimm.H>
#include <lib/power_thermal/throttle.H>

using fapi2::TARGET_TYPE_MCS;
using fapi2::TARGET_TYPE_MCA;
using fapi2::TARGET_TYPE_DIMM;
extern "C"
{
    // TK:LRDIMM Update power/thermal/throttling
    ///
    /// @brief Set ATTR_MSS_PORT_MAXPOWER, ATTR_MSS_MEM_THROTTLED_N_COMMANDS_PER_SLOT, ATTR_MSS_MEM_THROTTLED_N_COMMANDS_PER_PORT
    /// @param[in] i_targets vector of MCS's on the same VDDR domain
    /// @param[in] i_throttle_type thermal boolean to determine whether to calculate throttles based on the power regulator or thermal limits
    /// @return fapi2::ReturnCode - FAPI2_RC_SUCCESS iff get is OK
    /// @note Called in p9_mss_bulk_pwr_throttles
    /// @note determines the throttle levels based off of the port's power curve,
    /// sets the slot throttles to the same
    /// @note Enums are POWER for power egulator throttles and THERMAL for thermal throttles
    /// @note equalizes the throttles to the lowest of runtime and the lowest slot-throttle value
    ///
    fapi2::ReturnCode p9_mss_bulk_pwr_throttles( const std::vector< fapi2::Target<TARGET_TYPE_MCS> >& i_targets,
            const mss::throttle_type i_throttle_type)
    {
        FAPI_INF("Start p9_mss_bulk_pwr_throttles for %s type throttling",
                 (( i_throttle_type == mss::throttle_type::THERMAL) ? "THERMAL" : "POWER"));

        std::vector< fapi2::Target<fapi2::TARGET_TYPE_MCA> > l_exceeded_power;

        for ( const auto& l_mcs : i_targets)
        {
            if (mss::count_dimm (l_mcs) == 0)
            {
                continue;
            }

            uint16_t l_slot [mss::PORTS_PER_MCS] = {};
            uint16_t l_port [mss::PORTS_PER_MCS] = {};
            uint32_t l_power [mss::PORTS_PER_MCS] = {};

            for (const auto& l_mca : mss::find_targets<TARGET_TYPE_MCA>(l_mcs))
            {
                fapi2::ReturnCode l_rc = fapi2::FAPI2_RC_SUCCESS;

                //Don't run if there are no dimms on the port
                if (mss::count_dimm(l_mca) == 0)
                {
                    continue;
                }

                const uint8_t l_pos = mss::index(l_mca);

                mss::power_thermal::throttle<> l_pwr_struct(l_mca, l_rc);
                FAPI_TRY(l_rc, "Error constructing mss:power_thermal::throttle object for target %s",
                         mss::c_str(l_mca));

                //Let's do the actual work now
                if ( i_throttle_type == mss::throttle_type::THERMAL)
                {
                    FAPI_TRY (l_pwr_struct.thermal_throttles());
                }
                else
                {
                    FAPI_TRY (l_pwr_struct.power_regulator_throttles());
                }

                l_slot[l_pos] = l_pwr_struct.iv_n_slot;
                l_port[l_pos] = l_pwr_struct.iv_n_port;
                l_power[l_pos] = l_pwr_struct.iv_calc_port_maxpower;

                FAPI_INF("For target %s Calculated power is %d, throttle per slot is %d, throttle per port is %d",
                         mss::c_str(l_mca), l_power[l_pos], l_slot[l_pos], l_port[l_pos]);
            }

            FAPI_TRY(FAPI_ATTR_SET( fapi2::ATTR_MSS_PORT_MAXPOWER, l_mcs, l_power));
            FAPI_TRY(FAPI_ATTR_SET( fapi2::ATTR_MSS_MEM_THROTTLED_N_COMMANDS_PER_SLOT, l_mcs, l_slot));
            FAPI_TRY(FAPI_ATTR_SET( fapi2::ATTR_MSS_MEM_THROTTLED_N_COMMANDS_PER_PORT, l_mcs, l_port));
        }

        // Set all of the throttles to the lowest value per port for performance reasons
        FAPI_TRY(mss::power_thermal::equalize_throttles(i_targets, i_throttle_type, l_exceeded_power));

        // Report any MCA that exceeded the max power limit, and return a failing RC if we have any
        for (const auto& l_mca : l_exceeded_power)
        {
            FAPI_ERR("MCA %s estimated power exceeded the maximum allowed", mss::c_str(l_mca) );
            fapi2::current_err = fapi2::FAPI2_RC_FALSE;
        }

        FAPI_INF("End bulk_pwr_throttles");
        return fapi2::current_err;

    fapi_try_exit:
        FAPI_ERR("Error calculating bulk_pwr_throttles using %s throttling",
                 ((i_throttle_type == mss::throttle_type::POWER) ? "power" : "thermal"));
        return fapi2::current_err;
    }
} //extern C