Bootloader - Error handling - Add terminate function

As a first step to providing Bootloader error handling add support
for a terminate function.

Change-Id: Id4f8f130376d1396cd4feb796d1a3a908558225b
RTC:135746
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/32390
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>
Reviewed-by: Corey V. Swenson <cswenson@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

5 files changed, 137 insertions, 4 deletions

diff --git a/src/include/bootloader/bootloader.H b/src/include/bootloader/bootloader.H
index ebcc4e1de..26f7f84df 100644
--- a/src/include/bootloader/bootloader.H
+++ b/src/include/bootloader/bootloader.H
@@ -36,6 +36,8 @@
 #include <pnor_const.H>
 #include <pnor_utils.H>
 #include <common/ffs_hb.H>
+#include <kernel/terminate.H>
+#include <kernel/hbterminatetypes.H>
 
 extern "C" void task_end_stub();
 extern "C" void enterHBB(uint64_t i_hbb_hrmor, uint64_t i_hbb_offset);
@@ -105,6 +107,42 @@ namespace Bootloader{
                            uint32_t i_size,
                            MMIOLoadStoreSizes i_ld_st_size);
 
+    /**
+     * @brief Handle setting up to terminate Bootloader
+     *
+     * @param[in] i_moduleID    ID for module where terminate is occurring
+     * @param[in] i_reasoncode  Reason code for why terminating
+     * @param[in] i_word7       Data for SRC word 7 / @userdata2[0:31]
+     *                             (optional, default is 0)
+     * @param[in] i_word8       Data for SRC word 8 / @userdata2[32:63]
+     *                             (optional, default is 0)
+     * @param[in] i_executeTI   Flag for calling terminateExecuteTI
+     *                             (optional, default is true)
+     * @param[in] i_failAddr    Address associated with termination
+     *                             (SRC word 6 / @userdata1[32:63],
+     *                              optional, default is 0)
+     */
+    inline void bl_terminate(uint8_t  i_moduleID,
+                             uint16_t i_reasoncode,
+                             uint32_t i_word7 = 0,
+                             uint32_t i_word8 = 0,
+                             bool     i_executeTI = true,
+                             uint64_t i_failAddr = 0)
+    {
+        termWriteSRC(TI_BOOTLOADER,
+                     i_reasoncode,
+                     i_failAddr);
+
+        termModifySRC(i_moduleID,
+                      i_word7,
+                      i_word8);
+
+        if(i_executeTI)
+        {
+            terminateExecuteTI();
+        }
+    }
+
     /** @enum HbbLengths
      *  @brief List of HBB lengths.
      *
diff --git a/src/include/bootloader/hbblreasoncodes.H b/src/include/bootloader/hbblreasoncodes.H
new file mode 100644
index 000000000..502b74bcf
--- /dev/null
+++ b/src/include/bootloader/hbblreasoncodes.H
@@ -0,0 +1,75 @@
+/* IBM_PROLOG_BEGIN_TAG                                                   */
+/* This is an automatically generated prolog.                             */
+/*                                                                        */
+/* $Source: src/include/bootloader/hbblreasoncodes.H $                    */
+/*                                                                        */
+/* OpenPOWER HostBoot Project                                             */
+/*                                                                        */
+/* Contributors Listed Below - COPYRIGHT 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                                                     */
+#ifndef __HBBLREASONCODES_H
+#define __HBBLREASONCODES_H
+
+
+#include <usr/hbotcompid.H>
+
+
+
+namespace Bootloader
+{
+
+/**
+* @enum hbblModuleId
+*
+* @brief Module Ids used in created errorlogs.  Indicates which
+*      functions an error log was created in.
+*
+*/
+    enum hbblModuleId
+    {
+        MOD_BOOTLOADER_INVALID   = 0x00, /**< Zero is an invalid module id */
+        MOD_BOOTLOADER_TERMINATE = 0x01, /**< bl_terminate.C : save SRC */
+        MOD_BOOTLOADER_MAIN      = 0x02, /**< bootloader.C : main */
+        MOD_PNORACC_READTOC      = 0x03, /**< bl_pnorAccess.C : read TOC */
+        MOD_PNORACC_GETHBBSECT   = 0x04, /**< bl_pnorAccess.C : get HBB sect */
+
+    };
+
+/**
+ * @enum hbblReasonCode
+ *
+ * @brief Reasoncodes used to describe what errors are being indicated.
+ *
+ */
+    enum hbblReasonCode
+    {
+        RC_ASSERT            = HBBL_COMP_ID | 0x01, /**< Assert */
+        RC_SHUTDOWN          = HBBL_COMP_ID | 0x02, /**< Shutdown */
+        RC_UNHANDLED_EX      = HBBL_COMP_ID | 0x03, /**< Unhandled Exception */
+        RC_REMOVE_ECC_FAIL   = HBBL_COMP_ID | 0x04, /**< Remove ECC Failed */
+        RC_CHK_NULL_BUFFER   = HBBL_COMP_ID | 0x05, /**< Check for NULL Buffr */
+        RC_HDR_CHECKSUM_ERR  = HBBL_COMP_ID | 0x06, /**< Hdr Checksum Error */
+        RC_CHECK_HEADER_ERR  = HBBL_COMP_ID | 0x07, /**< Check Header Error */
+        RC_PARSE_ENTRIES_ERR = HBBL_COMP_ID | 0x08, /**< Parse Entries Error */
+        RC_NO_HBB_IN_TOC     = HBBL_COMP_ID | 0x09, /**< No HBB Sect in TOC */
+    };
+
+};  // end Bootloader
+
+
+#endif
diff --git a/src/include/kernel/hbterminatetypes.H b/src/include/kernel/hbterminatetypes.H
index 660358de1..42bb16788 100644
--- a/src/include/kernel/hbterminatetypes.H
+++ b/src/include/kernel/hbterminatetypes.H
@@ -5,7 +5,7 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* Contributors Listed Below - COPYRIGHT 2012,2014                        */
+/* Contributors Listed Below - COPYRIGHT 2012,2016                        */
 /* [+] International Business Machines Corp.                              */
 /*                                                                        */
 /*                                                                        */
@@ -29,7 +29,7 @@
 #define __KERNEL_HBTERMINATETYPES_H
 #include <stdint.h>
 
-/** @struct HB_T_SRC_DataAreaw
+/** @struct HB_T_SRC_DataArea
  *  @brief Defines the data space recreating an SRC needed for a TI from kernel
  *  space
  */
@@ -107,6 +107,7 @@ enum hb_terminate_source
     TI_CRIT_ASSERT =   0x0002,
     TI_SHUTDOWN =      0x0003,
     TI_UNHANDLED_EX =  0x0004,
+    TI_BOOTLOADER =    0x0005,
 };
 
 
diff --git a/src/include/kernel/terminate.H b/src/include/kernel/terminate.H
index b19e2fa39..9d80f988d 100644
--- a/src/include/kernel/terminate.H
+++ b/src/include/kernel/terminate.H
@@ -5,7 +5,9 @@
 /*                                                                        */
 /* OpenPOWER HostBoot Project                                             */
 /*                                                                        */
-/* COPYRIGHT International Business Machines Corp. 2012,2014              */
+/* Contributors Listed Below - COPYRIGHT 2012,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.       */
@@ -53,5 +55,15 @@ void termWriteSRC(uint16_t i_source,
                     uint16_t i_reasoncode,
                     uint64_t i_failAddr = 0);
 
+/** @fn termModifySRC
+ *  Modify an SRC and the TI data area for Bootloader
+ *  @param[in] i_moduleID: moduleID for the failure (used by Bootloader)
+ *  @param[in] i_word7: data to set SRC word 7 / @userdata2[0:31] (optional)
+ *  @param[in] i_word8: data to set SRC word 8 / @userdata2[32:63] (optional)
+ *  @param[out] NONE:
+ */
+void termModifySRC(uint8_t i_moduleID,
+                   uint32_t i_word7 = 0,
+                   uint32_t i_word8 = 0);
 
 #endif
diff --git a/src/include/usr/hbotcompid.H b/src/include/usr/hbotcompid.H
index 278e0af05..7f1c0308e 100644
--- a/src/include/usr/hbotcompid.H
+++ b/src/include/usr/hbotcompid.H
@@ -405,6 +405,14 @@ const char SIO_COMP_NAME[] = "sio";
 const compId_t FAPI2_COMP_ID = 0x3300;
 const char FAPI2_COMP_NAME[] = "fapi2";
 
+/** @name HBBL
+ *  Hostboot Bootloader
+ */
+//@{
+const compId_t HBBL_COMP_ID = 0x3400;
+const char HBBL_COMP_NAME[] = "hbbl";
+//@}
+
 /** @name HDAT
  *  HDAT component
  *  @Note HDAT_COMP_ID=0x9000 matches with what
@@ -415,7 +423,6 @@ const compId_t HDAT_COMP_ID = 0x9000;
 const char HDAT_COMP_NAME[] = "hdat";
 
 
-
 /** @name PRDF
  *  PRDF component
  *  @Note PRDF_COMP_ID=0xE500 matches with what