HDAT changes for Witherspoon

Change-Id: I942362604938fe4f7511e21da9246236a939c176
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/30905
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

1 files changed, 396 insertions, 0 deletions

diff --git a/src/usr/hdat/hdatutil.H b/src/usr/hdat/hdatutil.H
new file mode 100755
index 000000000..6ded4f426
--- /dev/null
+++ b/src/usr/hdat/hdatutil.H
@@ -0,0 +1,396 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/usr/hdat/hdatutil.H $                                     */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 2015,2016                        */
+/* [+] 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 hdatutil.H
+ *
+ * @brief This file contains various utility functions used internally by the
+ *        hypervisor data area component.
+ */
+
+#ifndef HDATUTIL_H
+#define HDATUTIL_H
+
+/*----------------------------------------------------------------------------*/
+/* Includes                                                                   */
+/*----------------------------------------------------------------------------*/
+#include <errl/errlentry.H>
+#include <errl/errlmanager.H>
+#include <hdat/hdat_reasoncodes.H>
+#include <trace/interface.H>
+#include <targeting/common/targetservice.H>
+#include <targeting/common/utilFilter.H>
+#include <hdat/hdat.H>
+#include "hdatvpd.H"
+#include "hdatbldda.H"
+#include<vpd/mvpdenums.H>
+#include<vpd/pvpdenums.H>
+#include<vpd/cvpdenums.H>
+#include<vpd/spdenums.H>
+#include <devicefw/driverif.H>
+#include <targeting/common/predicates/predicatectm.H>
+
+/*----------------------------------------------------------------------------*/
+/* Constants                                                                  */
+/*----------------------------------------------------------------------------*/
+const uint16_t HDAT_VERSION1 = 1;
+const uint16_t HDAT_VERSION2 = 2;
+const uint16_t HDAT_VERSION3 = 3;
+#define DBG_MRK "D>"
+
+//initialize the trac buffers
+#define HDAT_ENTER()  \
+        TRACFCOMP(g_trac_hdat,ENTER_MRK"[%s]",__FUNCTION__);
+
+#define HDAT_EXIT()   \
+    TRACFCOMP(g_trac_hdat,EXIT_MRK"[%s]",__FUNCTION__);
+
+#define STRINGIFY(x) #x
+#define TOSTRING(x) STRINGIFY(x)
+
+#define AT " [ " __FILE__ " ]:[ " TOSTRING(__LINE__) " ]: "
+
+#define HDAT_ERR( _fmt_, _args_...) \
+        TRACFCOMP( g_trac_hdat,ERR_MRK AT _fmt_, ##_args_ );
+
+#define HDAT_DBG( _fmt_, _args_...)  \
+        TRACFCOMP( g_trac_hdat,DBG_MRK _fmt_, ##_args_ );
+
+#define HDAT_INF( _fmt_, _args_...)  \
+        TRACFCOMP( g_trac_hdat,DBG_MRK _fmt_, ##_args_ );
+
+namespace HDAT
+{
+
+extern trace_desc_t* g_trac_hdat;
+
+
+/**
+ * @brief Create/Build an Error log and add HADT component trace
+ * if the log exists then FFDC will be added to the existing log and
+ * trace will be collected
+ *
+ * @param[in,out] io_err    Error handle to use or NULL to create new handle
+ * @param[in]     i_modid   Module ID
+ * @param[in]     i_rc      Return Code
+ * @param[in]     i_data1   User data word 1
+ * @param[in]     i_data2   User data word 2
+ * @param[in]     i_data3   User data word 3
+ * @param[in]     i_data4   User data word 4
+ * @param[in]     i_sev     Error severity
+ * @param[in]     i_version Data Version identifier for errorlog user details
+ * @param[in]     i_commit  true if the log should be committed inside
+ *                          the function
+ * @param[in]     i_callout Default is true to add software callout info
+ */
+void hdatBldErrLog(errlHndl_t &   io_err,
+                   const uint8_t  i_modid,
+                   const uint16_t i_rc,
+                   const uint32_t i_data1 = 0,
+                   const uint32_t i_data2 = 0,
+                   const uint32_t i_data3 = 0,
+                   const uint32_t i_data4 = 0,
+                   const ERRORLOG::errlSeverity_t i_sev =
+                   ERRORLOG::ERRL_SEV_UNRECOVERABLE,
+                   const uint16_t i_version =
+                   HDAT_VERSION1,
+                   const bool i_commit = false,
+                   bool i_callout = true);
+
+/**
+ * @brief Check whether the supplied Target is functional
+ *
+ * @param[in] i_pTarget - Target pointer
+ *
+ * @return bool - Functional state of Target.
+ *                functional(TRUE) or not(FALSE).  If an invalid target is
+ *                supplied then the interface will commit and will return false.
+ *
+ */
+bool isFunctional( const TARGETING::Target* i_Target);
+
+/**
+ * @brief  Get the EC Id and Chip Level for the target
+ *
+ * @param[in] i_pTarget
+ *      Input target pointer. Must not be NULL (otherwise call will return an
+ *      error log).  Must be a valid target from the system blueprint.
+ *
+ * @param[out] o_ecLevel - value of EC level for the target
+ * @param[out] o_chipId  - value of Chip id for the target
+ *
+ * @return errlHndl_t Error log handle indicating the status of the operation
+ *      @retval NULL for Success, non NULL for Failure
+ *
+ */
+errlHndl_t hdatGetIdEc(const TARGETING::Target *i_pTarget, uint32_t &o_ecLevel,
+                           uint32_t &o_chipId);
+
+/**
+ * @brief Get the Hardware Card ID
+ *
+ * @param[in] i_pTarget
+ *      Input target pointer. Must not be NULL (otherwise call will return an
+ *      error log).  Must be a valid target from the system blueprint.
+ *
+ * @param[out] o_cardId - Hardware Card ID
+ *
+ * @return errlHndl_t Error log handle indicating the status of the operation
+ *      @retval NULL for Success, non NULL for Failure
+ *
+ */
+errlHndl_t hdatGetHwCardId(const TARGETING::Target *i_pTarget,
+                                                        uint32_t &o_cardId);
+
+/**
+ * @brief This routine populates the MTM and Serial number attributes
+                           of system Target
+ *
+ * @pre None
+ *
+ * @post None
+ *
+ * @param None
+ *
+ * @return None
+ */
+void hdatPopulateMTMAndSerialNumber();
+
+/**
+ * @brief This routine gets suffix of location code
+ *
+ * @pre None
+ *
+ * @post None
+ *
+ * @param i_pFruTarget    - input parameter - System target
+ *        o_LocCodeSuffix - output parameter - Location Code suffix
+ *
+ * @return None
+ */
+void hdatGetLocationCode(TARGETING::Target *i_pFruTarget,
+                                             char *i_locCodePrefix,
+                                             char *o_locCode);
+
+/**
+ * @brief This routine gets prefix of location code
+ *
+ * @pre None
+ *
+ * @post None
+ *
+ * @param i_pnodeTarget  - input parameter - Node target
+ *        o_locCode      - output parameter - Location Code Prefix
+ *
+ * @return None
+ */
+void hdatGetLocationCodePrefix(char *o_locCode);
+
+/**
+ * @brief  Get the ascii keyword for a TARGET
+ *
+ * @param[in] i_Target input target pointer
+ *
+ * @param[out]o_kwdSize: keyword size
+ * @param[out]o_kwd: key word array
+ *
+ * @param[in] i_vpdtype: enum vpdType to select the appropriate device address
+ * @param[in] i_fetchVpd: relevant structure to be read to fetch the VPD
+ * @param[in] i_num: number of elements in the structure
+ *
+ * @return errlHndl_t NULL on success
+ */
+errlHndl_t hdatGetAsciiKwd(
+                           TARGETING::Target * i_target,
+                           uint32_t &o_kwdSize,
+                           char* &o_kwd,
+                           vpdType i_vpdtype,
+                           struct vpdData i_fetchVpd[],
+                           uint32_t i_num,size_t theSize[]);
+
+/**
+ * @brief  Get the ascii keyword for proc
+ *
+ * @param[in] i_target input target pointer
+ * @param[out]o_kwdSize: keyword size
+ * @param[out]o_kwd: key word array
+ * @param[in] i_fetchVpd: relevant structure to be read to fetch the VPD
+ * @param[in] i_num: number of elements in the structure
+ *
+ * @return errlHndl_t NULL on success
+ *
+ */
+errlHndl_t hdatGetAsciiKwdForMvpd(
+                       TARGETING::Target * i_target,
+                       uint32_t &o_kwdSize,
+                       char* &o_kwd,
+                       struct vpdData i_fetchVpd[],
+                       uint32_t i_num,size_t theSize[]);
+
+/**
+ * @brief  Get the ascii keyword for backplane
+ *
+ * @param[out]o_kwdSize: keyword size
+ * @param[out]o_kwd: key word array
+ * @param[in] i_fetchVpd: relevant structure to be read to fetch the VPD
+ * @param[in] i_num: number of elements in the structure
+ *
+ * @return errlHndl_t NULL on success
+ *
+ */
+errlHndl_t hdatGetAsciiKwdForPvpd(
+                       TARGETING::Target * i_target,
+                       uint32_t &o_kwdSize,
+                       char* &o_kwd,
+                       struct vpdData i_fetchVpd[],
+                       size_t i_num,size_t theSize[]);
+/**
+ * @brief  Get the ascii keyword for membuf
+ *
+ * @param[in] i_pTarget input target pointer
+ *
+ * @param[out]o_kwdSize: keyword size
+ * @param[out]o_kwd: key word array
+ * @param[in] i_fetchVpd: Vpd record-keyword table
+ * @return errlHndl_t NULL on success
+ *
+ */
+errlHndl_t hdatGetAsciiKwdForCvpd(
+                           TARGETING::Target * i_target,
+                           uint32_t &o_kwdSize,
+                           char* &o_kwd,
+                           struct vpdData i_fetchVpd[],
+                           size_t i_num,size_t theSize[]);
+/**
+ * @brief  Get the ascii keyword for  dimm
+ *
+ * @param[in] i_pTarget input target pointer
+ *
+ * @param[out]o_kwdSize: keyword size
+ * @param[out]o_kwd: key word array
+ * @return errlHndl_t NULL on success
+ *
+ */
+errlHndl_t hdatGetAsciiKwdForSpd(
+                           TARGETING::Target * i_target,
+                           size_t&o_kwdSize,
+                           char* &o_kwd);
+/**
+ * @brief Get the Max Cec nde count
+ *
+ *
+ * @return - Number of nodes present
+ *
+ */
+uint32_t hdatGetMaxCecNodes();
+
+
+/**
+ * @brief This routine is a debug routine that prints out the headers associated
+ *        with an HDIF data structure.
+ *
+ * @pre None
+ *
+ * @post Output is directed to standard out
+ *
+ * @param[in] i_hdif   - Pointer to data of type hdatHDIF_t
+ * @param[in] i_data   - Pointer to data of type hdatHDIFDataHdr_t
+ * @param[in] i_dataArray - Pointer to data of type hdatHDIFDataArray_t
+ * @param[in] i_child     - Pointer to data of type hdatHDIFChildHdr_t
+ *
+ */
+
+void hdatPrintHdrs(const hdatHDIF_t *i_hdif,
+                     const hdatHDIFDataHdr_t *i_data,
+                     const hdatHDIFDataArray_t *i_dataArray,
+                     const hdatHDIFChildHdr_t *i_child);
+
+/**
+ * @brief This routine is a debug routine that prints out the ASCII keyword VPD
+ *
+ * @pre None
+ *
+ * @post Output is directed to standard out
+ *
+ * @param[in] i_kwd    - Pointer to the ASCII keyword VPD
+ * @param[in] i_kwdLen - Length of the ASCII keyword VPD
+ *
+ */
+
+void hdatPrintKwd(const char *i_kwd,
+                     int32_t i_kwdLen);
+
+/**
+ * @brief This routine return the target list for the given data area.
+ *
+ * @pre None
+ *
+ * @post Output is directed to standard out
+ *
+ * @param[in] i_dataArea - area that indicates different VPD type
+ * @param[out] o_targList - target list
+ *
+ */
+void hdatGetTarget (const hdatSpiraDataAreas i_dataArea,
+                        TARGETING::TargetHandleList &o_targList);
+/**
+ * @brief  Format the ascii keyword based on the HDAT specifiction format
+ *
+ * @param[in] i_fetchVpd: relevant structure to be read to fetch the VPD
+ * @param[in] i_num: number of elements in the structure
+ * @param[in] theSize: Size of the each keyword data value
+ * @param[in] i_kwd: keyword data array
+ * @param[in] i_kwdSize: keyword data size
+ * @param[out] o_kwd: format keyword data array
+ * @param[out] o_kwdSize: format keyword data size
+ * @param[in] i_Keywords : keyword string array
+ *
+ * @return errlHndl_t NULL on success
+ *
+ */
+
+errlHndl_t hdatformatAsciiKwd(const struct vpdData i_fetchVpd[],
+        const size_t &i_num, const size_t theSize[], char* &i_kwd,
+        const uint32_t &i_kwdSize, char* &o_fmtKwd, uint32_t &o_fmtkwdSize,
+        const HdatKeywordInfo i_Keywords[]) ;
+
+
+/**
+ * @brief  Get the Full vpd of the target from eeprom
+ *
+ * @param[in]    i_pTarget    input target pointer
+ * @param[in/out]io_dataSize: VPD data size
+ * @param[out]   o_data:      VPD data
+ * @return errlHndl_t NULL on success
+ *
+ */
+errlHndl_t hdatGetFullEepromVpd ( TARGETING::Target * i_target,
+                           size_t &io_dataSize,
+                           char* &o_data);
+
+};// end namespace
+
+#endif // HDATUTILITY_H