PPE-HWP: [Level 1] Cache + Core Hcode Procedures with API and Attribute defined

Patch 6 Update:
  FW owner email address fix

Patch 5 Update:
  target types fixed, all compiles now.
    (Will rework them when multicast target is ready in Fapi2)
  add @brief to function doxygen
  add FW Owners to all headers
  typo fixes
  Items not fixed with this update or this level 1 release but commented:
    1) still need a solution for document attributes in doxygen headers.
    2) All traces in procedures including entry/exit are going to be
       finalized in future releases as the function body development
       reaches next maturity. There will be more discussion
       in-term/inter-term on how to do tracing overall on these procs,
       dont want to block this release because of it.

Patch 3 Update:
  addressed comments from Patch 2 review.
  merged p9_hcd_cache/core_sp_runtime_scom, p9_hcd_cache/core_host_runtime_scom
  into p9_hcd_cache/core_ras_runtime_scom based on P9_IPL_Flow.doc(v55)

Patch 2 Update:
  renamed proc_* to p9_* for all procedure filenames per comment in Patch 1

Note:
1) Due to ongoing interface discussion and resolution, some of these procedures
   are not yet ready for building under Cronus. Regular Fapi2 build is ready.
   If you see some of Fapi2 Target Types in these procedures are not in Fapi2,
   that is because they are currently in discussion of addition to Fapi2.
2) There are ongoing function body development in the code, which are all
   "#if 0" out in this level 1 release. The effective code in all files are
   only the API prototypes. Please focus your review only to the interfaces.
3) cache/core runinit is for SGPE and CME at runtime only, not for IPL or SBE.
4) 	common_pro_epi_log and common_poweronoff are subroutine support
   (not in IPL_Flow)

Change-Id: I46f07bb3e7cf050256c123e7f16982ccead2ceda
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/17193
Reviewed-by: Reshmi Nair <reshminair@in.ibm.com>
Reviewed-by: Sangeetha T S <sangeet2@in.ibm.com>
Reviewed-by: Gregory S. Still <stillgs@us.ibm.com>
Reviewed-by: Brian Silver <bsilver@us.ibm.com>
Tested-by: Brian Silver <bsilver@us.ibm.com>
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/36087
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>

2 files changed, 139 insertions, 0 deletions

diff --git a/src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.C b/src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.C
new file mode 100644
index 000000000..3d8861fde
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.C
@@ -0,0 +1,71 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.C $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
+/* [+] 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_common_poweronoff.C
+/// @brief common procedure for power on/off
+///
+/// *HWP HWP Owner   : David Du      <daviddu@us.ibm.com>
+/// *HWP FW Owner    : Reshmi Nair   <resnair5@in.ibm.com>
+/// *HWP Team        : PM
+/// *HWP Consumed by : SBE:SGPE:CME
+/// *HWP Level       : 1
+///
+/// Procedure Summary:
+///
+
+//------------------------------------------------------------------------------
+// Includes
+//------------------------------------------------------------------------------
+#include <fapi2.H>
+//#include <common_scom_addresses.H>
+//will be replaced with real scom address header file
+#include "p9_common_poweronoff.H"
+
+//------------------------------------------------------------------------------
+// Constant Definitions:
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+// Procedure:
+//------------------------------------------------------------------------------
+
+extern "C"
+{
+
+    fapi2::ReturnCode
+    p9_common_poweronoff(
+        const fapi2::Target < fapi2::TARGET_TYPE_EQ |
+        fapi2::TARGET_TYPE_CORE > & i_target,
+        int i_operation)
+    {
+        return fapi2::FAPI2_RC_SUCCESS;
+
+
+    } // Procedure
+
+
+} // extern C
+
+
diff --git a/src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.H b/src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.H
new file mode 100644
index 000000000..260c80a7d
--- /dev/null
+++ b/src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.H
@@ -0,0 +1,68 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/import/chips/p9/procedures/hwp/lib/p9_common_poweronoff.H $ */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2017                        */
+/* [+] 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_common_poweronoff.H
+/// @brief common procedure for power on/off
+///
+/// *HWP HWP Owner   : David Du      <daviddu@us.ibm.com>
+/// *HWP FW Owner    : Reshmi Nair   <resnair5@in.ibm.com>
+/// *HWP Team        : PM
+/// *HWP Consumed by : SBE:SGPE:CME
+/// *HWP Level       : 1
+///
+
+#ifndef __P9_COMMON_POWERONOFF_H__
+#define __P9_COMMON_POWERONOFF_H__
+
+extern "C"
+{
+
+/// @typedef p9_common_proweronoff_FP_t
+/// function pointer typedef definition for HWP call support
+    typedef fapi2::ReturnCode (*p9_common_proweronoff_FP_t) (
+        const fapi2::Target < fapi2::TARGET_TYPE_EQ |
+        fapi2::TARGET_TYPE_CORE > &,
+        int);
+
+
+/// @brief common procedure for power on/off
+///
+/// @param [in] i_target    TARGET_TYPE_EQ|TARGET_TYPE_CORE target
+/// @param [in] i_operation ENUM(ON,OFF)
+///
+/// @attr
+/// @attritem ATTR_PFET_TIMING - EX target, uint32
+///
+/// @retval FAPI_RC_SUCCESS
+    fapi2::ReturnCode
+    p9_common_proweronoff(
+        const fapi2::Target < fapi2::TARGET_TYPE_EQ |
+        fapi2::TARGET_TYPE_CORE > & i_target,
+        int i_operation);
+
+
+} // extern C
+
+#endif  // __P9_COMMON_POWERONOFF_H__