diff options
author | Stephen Cprek <smcprek@us.ibm.com> | 2013-10-03 17:07:20 -0500 |
---|---|---|
committer | A. Patrick Williams III <iawillia@us.ibm.com> | 2013-10-10 13:08:56 -0500 |
commit | c9343d971c4410c80ff92bd554d61740cd39b8dd (patch) | |
tree | 3d1cfe2c369e7b0a664019d305e6cfd41b0a8523 /src/include/usr | |
parent | cb4b721956f9a0a347db3b838608ffc0b08fd7e5 (diff) | |
download | talos-hostboot-c9343d971c4410c80ff92bd554d61740cd39b8dd.tar.gz talos-hostboot-c9343d971c4410c80ff92bd554d61740cd39b8dd.zip |
Added common header file for reason code
Change-Id: Ifea8a00b9a36817e0b42054dfb9ce13dad8f15a6
RTC: 76269
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/6478
Tested-by: Jenkins Server
Reviewed-by: Brian H. Horton <brianh@linux.ibm.com>
Reviewed-by: Andrew J. Geissler <andrewg@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>
Diffstat (limited to 'src/include/usr')
-rw-r--r-- | src/include/usr/errl/errlreasoncodes.H | 63 | ||||
-rw-r--r-- | src/include/usr/example/example.H | 49 | ||||
-rw-r--r-- | src/include/usr/example/examplerc.H | 55 |
3 files changed, 33 insertions, 134 deletions
diff --git a/src/include/usr/errl/errlreasoncodes.H b/src/include/usr/errl/errlreasoncodes.H index 04f4c3d19..4e3de79db 100644 --- a/src/include/usr/errl/errlreasoncodes.H +++ b/src/include/usr/errl/errlreasoncodes.H @@ -32,39 +32,42 @@ #include <hbotcompid.H> -// Module IDs for ERRL component -enum errlModuleId +namespace ERRORLOG { - ERRL_FIRST_MODULE_ID = 0x00, - ERRL_USERDATA_TEST_MOD_ID = 0x01, - ERRL_TEST_MOD_ID = 0x02, - //........ - ERRL_LAST_MODULE_ID = 0xFF -}; + // Module IDs for ERRL component + enum errlModuleId + { + ERRL_FIRST_MODULE_ID = 0x00, + ERRL_USERDATA_TEST_MOD_ID = 0x01, + ERRL_TEST_MOD_ID = 0x02, + //........ + ERRL_LAST_MODULE_ID = 0xFF + }; -// Reason codes for ERRL component -enum errlReasonCode -{ - ERRL_FIRST_ERR = ERRL_COMP_ID | 0x01, - ERRL_TEST_STRING_UD = ERRL_COMP_ID | 0x02, - ERRL_TEST_REASON_CODE = ERRL_COMP_ID | 0x03, - ERRL_TEST_ATTRIBUTE_UD = ERRL_COMP_ID | 0x04, - ERRL_TEST_LOGREGISTER_UD = ERRL_COMP_ID | 0x05, - ERRL_TEST_CALLOUT_UD = ERRL_COMP_ID | 0x06, - //........ - ERRL_LAST_ERR = ERRL_COMP_ID | 0xFF -}; + // Reason codes for ERRL component + enum errlReasonCode + { + ERRL_FIRST_ERR = ERRL_COMP_ID | 0x01, + ERRL_TEST_STRING_UD = ERRL_COMP_ID | 0x02, + ERRL_TEST_REASON_CODE = ERRL_COMP_ID | 0x03, + ERRL_TEST_ATTRIBUTE_UD = ERRL_COMP_ID | 0x04, + ERRL_TEST_LOGREGISTER_UD = ERRL_COMP_ID | 0x05, + ERRL_TEST_CALLOUT_UD = ERRL_COMP_ID | 0x06, + //........ + ERRL_LAST_ERR = ERRL_COMP_ID | 0xFF + }; -// Identifiers for ERRL user data sections. -enum errlUserDetailDataSubsection -{ - ERRL_UDT_NOFORMAT = 0x00, - ERRL_UDT_STRING = 0x01, - ERRL_UDT_TARGET = 0x02, - ERRL_UDT_BACKTRACE = 0x03, - ERRL_UDT_ATTRIBUTE = 0x04, - ERRL_UDT_LOGREGISTER = 0x05, - ERRL_UDT_CALLOUT = 0x06, + // Identifiers for ERRL user data sections. + enum errlUserDetailDataSubsection + { + ERRL_UDT_NOFORMAT = 0x00, + ERRL_UDT_STRING = 0x01, + ERRL_UDT_TARGET = 0x02, + ERRL_UDT_BACKTRACE = 0x03, + ERRL_UDT_ATTRIBUTE = 0x04, + ERRL_UDT_LOGREGISTER = 0x05, + ERRL_UDT_CALLOUT = 0x06, + }; }; #endif diff --git a/src/include/usr/example/example.H b/src/include/usr/example/example.H deleted file mode 100644 index 9f1a535f3..000000000 --- a/src/include/usr/example/example.H +++ /dev/null @@ -1,49 +0,0 @@ -// IBM_PROLOG_BEGIN_TAG -// This is an automatically generated prolog. -// -// $Source: src/include/usr/example/example.H $ -// -// IBM CONFIDENTIAL -// -// COPYRIGHT International Business Machines Corp. 2011 -// -// p1 -// -// Object Code Only (OCO) source materials -// Licensed Internal Code Source Materials -// IBM HostBoot Licensed Internal Code -// -// The source code for this program is not published or other- -// wise divested of its trade secrets, irrespective of what has -// been deposited with the U.S. Copyright Office. -// -// Origin: 30 -// -// IBM_PROLOG_END -// This file is where you export all external module interfaces (i.e. -// interfaces required by other modules) - -#ifndef __EXAMPLE_EXAMPLE_H -#define __EXAMPLE_EXAMPLE_H - - - /** - * @brief Example Function - * - * Some more details on the example function. - * - * @return 0 on success, otherwise a failure code. - * - */ -uint64_t example1_function(); - -/** - * @brief Example of creating an error log function - * - * @return void - * - */ -void example2_create_errorlog_function(); - - -#endif diff --git a/src/include/usr/example/examplerc.H b/src/include/usr/example/examplerc.H deleted file mode 100644 index 65bdb6288..000000000 --- a/src/include/usr/example/examplerc.H +++ /dev/null @@ -1,55 +0,0 @@ -// IBM_PROLOG_BEGIN_TAG -// This is an automatically generated prolog. -// -// $Source: src/include/usr/example/examplerc.H $ -// -// IBM CONFIDENTIAL -// -// COPYRIGHT International Business Machines Corp. 2011 -// -// p1 -// -// Object Code Only (OCO) source materials -// Licensed Internal Code Source Materials -// IBM HostBoot Licensed Internal Code -// -// The source code for this program is not published or other- -// wise divested of its trade secrets, irrespective of what has -// been deposited with the U.S. Copyright Office. -// -// Origin: 30 -// -// IBM_PROLOG_END -// This file is an example how you create a reason code to pass in an -// error log creation - -#ifndef __EXAMPLE_RC_H -#define __EXAMPLE_RC_H - -#include <hbotcompid.H> - -// The definitions in this file is an example that shows how to define -// reason codes. Each Host Boot component should have a service code -// file (<component>reasoncodes.H) that defines its module IDs and -// unique reason codes. -// See errlreasoncodes.H for example of this file for ERRL component. - -// Below is an example of defining reason codes -enum myModuleId -{ - MY_MODULE_ID_1 = 0x00, - //........ - MY_LAST_MODULE_ID = 0xFF -}; - -// This enum definition should be in an .H file in your component area. -// MY_COMPONENT_ID is your component name defined in hbotcompid.H file -// included above. -enum myReasonCode -{ - MY_REASON_CODE_1 = MY_COMP_ID | 0x01, - //........ - ERRL_LAST_REASON_CODE = MY_COMP_ID | 0xFF -}; - -#endif |