p9_setup_evid L2 commit

Change-Id: I1ec8f5d5b815b7f153d31a77e7239ff964fde556
Original-Change-Id: I923c0d7da9e825dbbb4a111648fc3457da22d572
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/20613
Tested-by: Jenkins Server
Tested-by: PPE CI
Tested-by: Hostboot CI
Reviewed-by: Jennifer A. Stofer <stofer@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/25672
Tested-by: FSP CI Jenkins
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

3 files changed, 412 insertions, 0 deletions

diff --git a/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.C b/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.C
new file mode 100644
index 000000000..3206d9221
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.C
@@ -0,0 +1,323 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: chips/p9/procedures/hwp/pm/p9_setup_evid.C $                  */
+/*                                                                        */
+/* IBM CONFIDENTIAL                                                       */
+/*                                                                        */
+/* EKB Project                                                            */
+/*                                                                        */
+/* COPYRIGHT 2015,2016                                                    */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
+/*                                                                        */
+/* The source code for this program is not published or otherwise         */
+/* divested of its trade secrets, irrespective of what has been           */
+/* deposited with the U.S. Copyright Office.                              */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+
+///
+/// @file  p9_setup_evid.C
+/// @brief Setup External Voltage IDs
+///
+// *HW Owner    : Sudheendra K Srivathsa <sudheendraks@in.ibm.com>
+// *FW Owner    : Sangeetha T S <sangeet2@in.ibm.com>
+// *Team        : PM
+// *Consumed by : HB
+// *Level       : 2
+///
+/// @verbatim
+///
+/// Procedure Summary:
+///   - Use Attributes to send VDD, VDN and VCS via the AVS bus to VRMs
+///
+/// @endverbatim
+/// @todo (to be considered in L2/L3 development) AVSBus timing parameters
+///  as attributes or not.  They were hardcoded in P8.
+
+//-----------------------------------------------------------------------------
+// Includes
+//-----------------------------------------------------------------------------
+#include <fapi2.H>
+#include <p9_setup_evid.H>
+#include <p9_avsbus_lib.H>
+#include <p9_avsbus_scom.H>
+
+enum P9_SETUP_EVID_CONSTANTS
+{
+// By convention, the Pstate GPE will use bridge 0.  Other entities
+// will use bridge 1
+    BRIDGE_NUMBER = 1,
+
+// Default configuration settings
+    DEFAULT_VDD_BUS_NUMBER = 0,
+    DEFAULT_VDD_RAILSELECT = 0,
+    DEFAULT_VDN_BUS_NUMBER = 1,
+    DEFAULT_VDN_RAILSELECT = 0,
+    DEFAULT_VCS_BUS_NUMBER = 0,
+    DEFAULT_VCS_RAILSELECT = 1,
+
+// Default voltages if mailbox -> attributes are not setup
+    DEFAULT_BOOT_VDD_VOLTAGE_MV = 1000,
+    DEFAULT_BOOT_VCS_VOLTAGE_MV = 1050,
+    DEFAULT_BOOT_VDN_VOLTAGE_MV = 900
+};
+
+//##############################################################################
+// Function to initiate an eVRM voltage change.
+//##############################################################################
+// @todo - RTC item to track how AVS Voltage write is called through function below
+fapi2::ReturnCode
+driveVoltageChange(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&
+                   i_target,
+                   const p9avslib::avsRails i_Rail,
+                   const uint32_t i_Voltage )
+{
+
+    uint32_t l_CmdDataRead = 0;
+    uint32_t l_avsBusNum = 0, l_RailSelect = 0;
+    uint32_t l_o2sBridgeNum = BRIDGE_NUMBER;
+
+    // Hardcoded for now
+    if (i_Rail == p9avslib::VDD)
+    {
+        l_avsBusNum = 0;
+        l_RailSelect = 0;
+    }
+    else if (i_Rail == p9avslib::VDN)
+    {
+        l_avsBusNum = 1;
+        l_RailSelect = 0;
+    }
+    else
+    {
+        //@todo L3 - This need to have a FAPI_ASSERT block with appropriate
+        //error codes used from this procedure's error xml file
+        FAPI_ERR("Invalid AVSBus Rail: i_Rail = %u", i_Rail);
+        //return fapi2::current_err;
+
+    }
+
+    // Drive AVS transaction with a frame value 0xFFFFFFFF (idle frame) to
+    // initialize the AVS slave
+    FAPI_TRY(avsIdleFrame(i_target, l_avsBusNum, l_o2sBridgeNum),
+             "AVS Idle frame transaction failed");
+
+    // Drive write transaction with a target voltage on a particular rail
+    // and wait on o2s_ongoing=0
+    FAPI_TRY(avsVoltageWrite(i_target, l_avsBusNum, l_o2sBridgeNum,
+                             l_RailSelect, i_Voltage),
+             "AVS Voltage write transaction failed");
+
+
+    // *** The following is used for procedure validation testing an will be removed
+    // *** from the final code as will be replaced with a checkStatus() routine.
+
+    // Drive read transaction to return the voltage on the same rail
+    // and wait on o2s_ongoing=0
+    FAPI_TRY(avsVoltageRead(i_target, l_avsBusNum, l_o2sBridgeNum,
+                            l_RailSelect, &l_CmdDataRead),
+             "AVS Voltage read transaction failed");
+
+    // Compare write voltage value with read voltage value
+    if (i_Voltage == l_CmdDataRead)
+    {
+        //PASS
+    }
+    else
+    {
+        //@todo L3 - Update once RTC item for drive Voltage change and
+        // check status routine is completed and L3 FFDC // FAIL
+    }
+
+fapi_try_exit:
+    return fapi2::current_err;
+}
+
+//-----------------------------------------------------------------------------
+// Procedure
+//-----------------------------------------------------------------------------
+
+
+// Substep indicators
+// const uint32_t STEP_SBE_EVID_START              = 0x1;
+// const uint32_t STEP_SBE_EVID_CONFIG             = 0x2;
+// const uint32_t STEP_SBE_EVID_WRITE_VDN          = 0x3;
+// const uint32_t STEP_SBE_EVID_POLL_VDN_STATUS    = 0x4;
+// const uint32_t STEP_SBE_EVID_WRITE_VDD          = 0x5;
+// const uint32_t STEP_SBE_EVID_POLL_VDD_STATUS    = 0x6;
+// const uint32_t STEP_SBE_EVID_WRITE_VCS          = 0x7;
+// const uint32_t STEP_SBE_EVID_POLL_VCS_STATUS    = 0x8;
+// const uint32_t STEP_SBE_EVID_TIMEOUT            = 0x9;
+// const uint32_t STEP_SBE_EVID_BOOT_FREQ          = 0xA;
+// const uint32_t STEP_SBE_EVID_COMPLETE           = 0xB;
+
+
+struct avsbus_attrs_t
+{
+    uint8_t vdd_bus_num;
+    uint8_t vdd_rail_select;
+    uint8_t vdn_bus_num;
+    uint8_t vdn_rail_select;
+    uint8_t vcs_bus_num;
+    uint8_t vcs_rail_select;
+    uint32_t vcs_voltage_mv;
+    uint32_t vdd_voltage_mv;
+    uint32_t vdn_voltage_mv;
+};
+
+
+//@brief Initialize VDD/VCS/VDN bus num, rail select and voltage values
+//@param[i] i_target       Chip target
+//@param[i] attrs    VDD/VCS/VDN attributes
+//@return   Return code void
+fapi2::ReturnCode
+avsInitAttributes(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target,
+                  avsbus_attrs_t* attrs)
+{
+
+    attrs->vdd_bus_num = DEFAULT_VDD_BUS_NUMBER;
+    attrs->vdd_rail_select = DEFAULT_VDD_RAILSELECT;
+    attrs->vdn_bus_num = DEFAULT_VDN_BUS_NUMBER;
+    attrs->vdn_rail_select = DEFAULT_VDN_RAILSELECT;
+    attrs->vcs_bus_num = DEFAULT_VCS_BUS_NUMBER;
+    attrs->vcs_rail_select = DEFAULT_VCS_RAILSELECT;
+
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VDD_AVSBUS_BUSNUM, i_target,
+                           attrs->vdd_bus_num));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VDD_AVSBUS_RAIL,  i_target,
+                           attrs->vdd_rail_select));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VDN_AVSBUS_BUSNUM, i_target,
+                           attrs->vdn_bus_num));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VDN_AVSBUS_RAIL,  i_target,
+                           attrs->vdn_rail_select));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VCS_AVSBUS_BUSNUM, i_target,
+                           attrs->vcs_bus_num));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VCS_AVSBUS_RAIL,  i_target,
+                           attrs->vcs_rail_select));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VCS_BOOT_VOLTAGE, i_target,
+                           attrs->vcs_voltage_mv));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VDD_BOOT_VOLTAGE, i_target,
+                           attrs->vdd_voltage_mv));
+    FAPI_TRY(FAPI_ATTR_GET(fapi2::ATTR_VDN_BOOT_VOLTAGE, i_target,
+                           attrs->vdn_voltage_mv));
+
+    // If attribute values are zero, use the default values (hardcoded)
+
+    // check VDD VID
+    if (attrs->vdd_voltage_mv == 0)
+    {
+        // Default voltage if mailbox value is not set
+
+        // @todo L3 - Eventually, this should replaced with an error point
+        // to indicate that the mailbox -> attributes haven't been setup
+
+        attrs->vdd_voltage_mv  = DEFAULT_BOOT_VDD_VOLTAGE_MV;
+        FAPI_INF("VDD boot voltage not set in attributes. Setting to default of %d mV (%x)",
+                 attrs->vdd_voltage_mv, attrs->vdd_voltage_mv);
+    }
+    else
+    {
+        FAPI_INF("VDD boot voltage = %d mV (%x)",
+                 attrs->vdd_voltage_mv, attrs->vdd_voltage_mv);
+    }
+
+    // check VCS VID
+    if (attrs->vcs_voltage_mv == 0)
+    {
+        // Default voltage if mailbox value is not set
+
+        // @todo L3 - Eventually, this should replaced with an error point
+        // to indicate that the mailbox -> attributes haven't been setup
+
+        attrs->vcs_voltage_mv  = DEFAULT_BOOT_VCS_VOLTAGE_MV;
+        FAPI_INF("VCS boot voltage not set in attributes. Setting to default of %d mV (%x)",
+                 attrs->vcs_voltage_mv, attrs->vcs_voltage_mv);
+    }
+    else
+    {
+        FAPI_INF("VCS boot voltage = %d mV (%x)",
+                 attrs->vcs_voltage_mv, attrs->vcs_voltage_mv);
+    }
+
+    // check VDN VID
+    if (attrs->vdn_voltage_mv == 0)
+    {
+        // Default voltage if mailbox value is not set
+
+        // @todo -L3  Eventually, this should replaced with an error point
+        // to indicate that the mailbox -> attributes haven't been setup
+
+        attrs->vdn_voltage_mv  = DEFAULT_BOOT_VDN_VOLTAGE_MV;
+        FAPI_INF("VDN boot voltage not set in attributes. Setting to default of %d mV (%x)",
+                 attrs->vdn_voltage_mv, attrs->vdn_voltage_mv);
+    }
+    else
+    {
+        FAPI_INF("VDN boot voltage = %d mV (%x)",
+                 attrs->vdn_voltage_mv, attrs->vdn_voltage_mv);
+    }
+
+fapi_try_exit:
+    return fapi2::current_err;
+} // avsInitAttributes
+
+
+fapi2::ReturnCode
+p9_setup_evid(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target)
+{
+
+    // AVSBus configuration variables
+    avsbus_attrs_t attrs;
+
+    // Read attribute -
+    FAPI_TRY(avsInitAttributes(i_target, &attrs));
+
+    // Initialize the buses
+    FAPI_TRY(avsInitExtVoltageControl(i_target,
+                                      p9avslib::AVSBUSVDD, BRIDGE_NUMBER),
+             "Initializing avsBus VDD, bridge %d", BRIDGE_NUMBER);
+    FAPI_TRY(avsInitExtVoltageControl(i_target,
+                                      p9avslib::AVSBUSVDN, BRIDGE_NUMBER),
+             "Initializing avsBus VDN, bridge %d", BRIDGE_NUMBER);
+
+    // Should not be needed, as same AVSBus and different rails
+    // should share same initialization information
+    //FAPI_TRY(avsInitExtVoltageControl(i_target,
+    //         p9avslib::AVSBUSVCS, BRIDGE_NUMBER),
+    //         "Initializing avsBus VCS, bridge %d", BRIDGE_NUMBER);
+
+    // Set Boot VDD Voltage
+    FAPI_TRY(avsVoltageWrite(i_target,
+                             attrs.vdd_bus_num,
+                             BRIDGE_NUMBER,
+                             attrs.vdd_rail_select,
+                             (uint32_t)attrs.vdd_voltage_mv),
+             "Setting VDD voltage via AVSBus %d, Bridge %d",
+             attrs.vdd_bus_num,
+             BRIDGE_NUMBER);
+
+    // Set Boot VDN Voltage
+    FAPI_TRY(avsVoltageWrite(i_target,
+                             attrs.vdn_bus_num,
+                             BRIDGE_NUMBER,
+                             attrs.vdn_rail_select,
+                             (uint32_t)attrs.vdn_voltage_mv),
+             "Setting VDN voltage via AVSBus %d, Bridge %d",
+             attrs.vdn_bus_num,
+             BRIDGE_NUMBER);
+
+    // Set Boot VCS Voltage
+    FAPI_TRY(avsVoltageWrite(i_target,
+                             attrs.vcs_bus_num,
+                             BRIDGE_NUMBER,
+                             attrs.vcs_rail_select,
+                             (uint32_t)attrs.vcs_voltage_mv),
+             "Setting VCS voltage via AVSBus %d, Bridge %d",
+             attrs.vcs_bus_num,
+             BRIDGE_NUMBER);
+
+fapi_try_exit:
+    return fapi2::current_err;
+} // Procedure
diff --git a/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.H b/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.H
new file mode 100644
index 000000000..63e89d702
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.H
@@ -0,0 +1,66 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: chips/p9/procedures/hwp/pm/p9_setup_evid.H $                  */
+/*                                                                        */
+/* IBM CONFIDENTIAL                                                       */
+/*                                                                        */
+/* EKB Project                                                            */
+/*                                                                        */
+/* COPYRIGHT 2015,2016                                                    */
+/* [+] International Business Machines Corp.                              */
+/*                                                                        */
+/*                                                                        */
+/* The source code for this program is not published or otherwise         */
+/* divested of its trade secrets, irrespective of what has been           */
+/* deposited with the U.S. Copyright Office.                              */
+/*                                                                        */
+/* IBM_PROLOG_END_TAG                                                     */
+
+///
+/// @file  p9_setup_evid.H
+/// @brief Setup External Voltage IDs
+///
+/// *HW Owner    : Sudheendra K Srivathsa <sudheendraks@in.ibm.com>
+/// *FW Owner    : Sangeetha T S <sangeet2@in.ibm.com>
+/// *Team        : PM
+/// *Consumed by : HB
+/// *Level       : 2
+///
+
+#ifndef __P9_SETUP_EVID_H__
+#define __P9_SETUP_EVID_H__
+
+#include <fapi2.H>
+
+extern "C"
+{
+
+/// @typedef p9_setup_evid_FP_t
+/// function pointer typedef definition for HWP call support
+    typedef fapi2::ReturnCode (*p9_setup_evid_FP_t) (
+        const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&);
+
+/// @brief Read attributes containing part's boot voltages(VDD,VCS and VDN)
+/// and set these voltage using the AVSBUS interface (VDD, VDN and VCS).
+///
+/// @param [in] i_target TARGET_TYPE_PROC_CHIP
+/// @attr
+/// @attritem  ATTR_VCS_BOOT_VOLTAGE  - 1mV grandularity setting for VCS rail
+/// @attritem  ATTR_VDD_BOOT_VOLTAGE  - 1mV grandularity setting for VDD rail
+/// @attritem  ATTR_VDN_BOOT_VOLTAGE  - 1mV grandularity setting for VDN rail
+/// @attritem  ATTR_VDD_AVSBUS_BUSNUM - AVSBus Number having the VDD VRM
+/// @attritem  ATTR_VDD_AVSBUS_RAIL   - AVSBus Rail number for VDD VRM
+/// @attritem  ATTR_VDN_AVSBUS_BUSNUM - AVSBus Number having the VDN VRM
+/// @attritem  ATTR_VDN_AVSBUS_RAIL   - AVSBus Rail number for VDN VRM
+/// @attritem  ATTR_VCS_AVSBUS_BUSNUM - AVSBus Number having the VCS VRM
+/// @attritem  ATTR_VCS_AVSBUS_RAIL   - AVSBus Rail number for VCS VRM
+///
+/// @retval FAPI_RC_SUCCESS
+    fapi2::ReturnCode
+    p9_setup_evid(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target);
+
+
+} // extern C
+
+#endif  // __P9_SETUP_EVID_H__
diff --git a/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.mk b/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.mk
new file mode 100644
index 000000000..bd6f34079
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/pm/p9_setup_evid.mk
@@ -0,0 +1,23 @@
+# IBM_PROLOG_BEGIN_TAG
+# This is an automatically generated prolog.
+#
+# $Source: chips/p9/procedures/hwp/pm/p9_setup_evid.mk $
+#
+# IBM CONFIDENTIAL
+#
+# EKB Project
+#
+# COPYRIGHT 2015,2016
+# [+] International Business Machines Corp.
+#
+#
+# The source code for this program is not published or otherwise
+# divested of its trade secrets, irrespective of what has been
+# deposited with the U.S. Copyright Office.
+#
+# IBM_PROLOG_END_TAG
+PROCEDURE=p9_setup_evid
+$(call ADD_MODULE_INCDIR,$(PROCEDURE),$(PROJECT_ROOT)/chips/p9/procedures/hwp/lib)
+#$(call ADD_PROCEDURE_INCDIR,$(PROCEDURE),$(PROJECT_ROOT)/chips/p9/procedures/hwp/lib)
+libp9_setup_evid_DEPLIBS += p9_avsbus_lib
+$(call BUILD_PROCEDURE)