summaryrefslogtreecommitdiffstats
path: root/import/chips/p9/procedures/hwp/nest/p9_sbe_scominit.H
diff options
context:
space:
mode:
Diffstat (limited to 'import/chips/p9/procedures/hwp/nest/p9_sbe_scominit.H')
-rw-r--r--import/chips/p9/procedures/hwp/nest/p9_sbe_scominit.H94
1 files changed, 37 insertions, 57 deletions
diff --git a/import/chips/p9/procedures/hwp/nest/p9_sbe_scominit.H b/import/chips/p9/procedures/hwp/nest/p9_sbe_scominit.H
index 99714ae2..4129098e 100644
--- a/import/chips/p9/procedures/hwp/nest/p9_sbe_scominit.H
+++ b/import/chips/p9/procedures/hwp/nest/p9_sbe_scominit.H
@@ -22,77 +22,57 @@
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
-//------------------------------------------------------------------------------
-/// @file p9_sbe_scominit.H
///
-/// @brief This procedure contains SCOM based initialization required for
-/// fabric configuration & HBI operation
-/// *!
-/// *! o Set fabric node/chip ID configuration for all configured
-/// *! chiplets to chip specific values
-/// *! o Establish ADU XSCOM BAR for HBI operation
-//------------------------------------------------------------------------------
-// *HWP HW Owner : Girisankar Paulraj <gpaulraj@in.ibm.com>
-// *HWP HW Backup Owner : Joe McGill <jmcgill@us.ibm.com>
-// *HWP FW Owner : Thi N. Tran <thi@us.ibm.com>
-// *HWP Team : Nest
-// *HWP Level : 2
-// *HWP Consumed by : SBE
-//------------------------------------------------------------------------------
+/// @file p9_sbe_scominit.H
+/// @brief Peform SCOM initialization required for fabric & HBI operation (FAPI2)
+///
+/// @author Joe McGill <jmcgill@us.ibm.com>
+/// @author Christy Graves <clgraves@us.ibm.com>
+///
+//
+// *HWP HWP Owner : Joe McGill <jmcgill@us.ibm.com>
+// *HWP FW Owner : Thi N. Tran <thi@us.ibm.com>
+// *HWP Team : Nest
+// *HWP Level : 2
+// *HWP Consumed by : SBE
+//
#ifndef _P9_SBE_SCOMINIT_H_
#define _P9_SBE_SCOMINIT_H_
-
+//------------------------------------------------------------------------------
+// Includes
+//------------------------------------------------------------------------------
#include <fapi2.H>
-namespace p9SbeScominit
-{
-enum P9_SBE_SCOMINIT_Public_Constants
-{
- FIR_RESET_VALUE = 0x0000000000000000ull,
- FIRMASK_RESET_VALUE = 0xFFFFFFFFFFFFFFFFull,
- FIRACT_RESET_VALUE = 0xFFFFFFFFFFFFFFFFull
-};
-}
-
-typedef fapi2::ReturnCode (*p9_sbe_scominit_FP_t)(const
- fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&);
-
-/// @brief This function does ADU BAR and XSCOM BAR base setup,
-/// Set Fabric node/chip ID for all configured chiplets in nest
-/// area and Clearing/setting up FIR register
-///
-/// @param[in] i_target Reference to TARGET_TYPE_PROC_CHIP target
-/// @return FAPI2_RC_SUCCESS if success, else error code.
-extern "C"
-{
- fapi2::ReturnCode p9_sbe_scominit(const
- fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target);
-}
-
-// This structure contains the following parameter
-// i_chip_id --> current chiplet Fabric chip id
-// i_group_id --> current chiplet Fabric group id
-// i_system_id --> current chiplet Fabric system id
-struct i_id_struct
-{
- //// Constructors and destructors ////
+//------------------------------------------------------------------------------
+// Structure definitions
+//------------------------------------------------------------------------------
- public :
+/// function pointer typedef definition for HWP call support
+typedef fapi2::ReturnCode (*p9_sbe_scominit_FP_t)(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>&);
- //## auto_generated
- i_id_struct();
- //// Attributes ////
+//------------------------------------------------------------------------------
+// Function prototypes
+//------------------------------------------------------------------------------
- uint8_t iv_chip_id;
+extern "C"
+{
- uint8_t iv_group_id;
+///
+/// @brief Set fabric topology IDs for all configured chipets (outside of EC/EP),
+/// performs BAR setup needed for HBI (XSCOM/LPC), configures selected FIRs in
+/// preparation for fabric init
+/// an init command (ttype=pbop.init_all) from the Alter Display Unit (ADU)
+///
+/// @param[in] i_target Reference to processor chip target
+/// @return fapi::ReturnCode. FAPI2_RC_SUCCESS if success, else error code.
+///
+ fapi2::ReturnCode p9_sbe_scominit(const fapi2::Target<fapi2::TARGET_TYPE_PROC_CHIP>& i_target);
- uint32_t iv_system_id;
-};
+} // extern "C"
#endif
OpenPOWER on IntegriCloud