Encapsulated PRD codebase with PRDF namespace

RTC: 51223
Change-Id: Ie074cb409083d7b04edeba75d39977eb90082d05
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/2196
Reviewed-by: Zane Shelley <zshelle@us.ibm.com>
Tested-by: Jenkins Server
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/2436
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 65 insertions, 47 deletions

diff --git a/src/include/usr/diag/prdf/common/prdf_service_codes.H b/src/include/usr/diag/prdf/common/prdf_service_codes.H
index 616d9d7fd..aca34a49a 100755
--- a/src/include/usr/diag/prdf/common/prdf_service_codes.H
+++ b/src/include/usr/diag/prdf/common/prdf_service_codes.H
@@ -21,21 +21,21 @@
 /*                                                                        */
 /* IBM_PROLOG_END_TAG                                                     */
 
-/**
-  @file prdf_service_codes.H
-  @brief File contains file IDs and reason codes
-*/
-
-// NOTE: the change log is at the bottom of the file
-
 #ifndef prdf_services_codes_H
 #define prdf_services_codes_H
 
+/**
+ * @file prdf_service_codes.H
+ * @brief File contains file IDs and reason codes
+ */
+
 #ifdef __HOSTBOOT_MODULE
 
 #include <hbotcompid.H>
-#define PRDF_COMP_ID HBPRDF_COMP_ID     //FIXME: will need to make a change in hbotcompid.H later
-#define PRDF_COMP_NAME HBPRDF_COMP_NAME //FIXME
+
+// FIXME: Will need to make a change in hbotcompid.H later
+#define PRDF_COMP_ID   HBPRDF_COMP_ID
+#define PRDF_COMP_NAME HBPRDF_COMP_NAME
 
 #else
 
@@ -43,69 +43,87 @@
 
 #endif
 
+namespace PRDF
+{
+
 /**
- *  @brief Enum specifying "Module ids" for prdf CODE_FAIL SRCs.
+ *  @brief Enum specifying "Module ids" for PRDF_CODE_FAIL SRCs.
  *         Each module Id corresponds to a particular
  *         method in a class or an individual function.
  */
-enum prdfModId
+enum ModId
 {
-  PRDF_MAIN                     = 0x01,
-  PRDF_HOM_HOM_TYPE             = 0x02,
-  PRDF_HOM_SCOM                 = 0x03,
-  PRDF_HOM_SCAN                 = 0x04,
-  PRDF_SDBUG_INIT               = 0x05,
-  PRDF_PRDRLOADCHIP             = 0x06,
-  PRDF_PRDFRULECHIP             = 0x07,
-  PRDF_EXTENSIBLEDOMAIN         = 0x08,
-  PRDF_ERRLSMARTPTR             = 0x09,
-  PRDF_ASSERT                   = 0x0A,
-  PRDF_RAS_SERVICES             = 0x0B,
-  PRDF_RESTORE_DRAM_REPAIR      = 0x0C,
+    PRDF_MAIN                     = 0x01,
+    PRDF_HOM_HOM_TYPE             = 0x02, // FIXME: May be deprecated
+    PRDF_HOM_SCOM                 = 0x03,
+    PRDF_HOM_SCAN                 = 0x04,
+    PRDF_SDBUG_INIT               = 0x05,
+    PRDF_LOADCHIP                 = 0x06,
+    PRDF_RULECHIP                 = 0x07,
+    PRDF_EXTENSIBLEDOMAIN         = 0x08,
+    PRDF_ERRLSMARTPTR             = 0x09,
+    PRDF_ASSERT                   = 0x0A,
+    PRDF_RAS_SERVICES             = 0x0B,
+    PRDF_RESTORE_DRAM_REPAIR      = 0x0C,
 };
 
-/*********************************************************************************************/
+/******************************************************************************/
 // NOTE!!! PLEASE READ THIS IF YOU ADD A NEW REASON CODE:
 //  Each new Reason code must have Service Tags (for the Serviceablity tools).
 //  The tags need to be in a .C file - the tools won't pick up if in a .H file.
-//  In theory the tags should be right in with the code that generates the Reason Code.
-//  For prdf this is not possible in most instances.
+//  In theory the tags should be right in with the code that generates the
+//  Reason Code. For prdf this is not possible in most instances.
 //  prdf_ras_services.C is the default place holder for the Service tags.
-//  So the Service tags should be either added to a prdf .C file for a unique instance, or in ras services.
-/*********************************************************************************************/
+//  So the Service tags should be either added to a prdf .C file for a unique
+//  instance, or in ras services.
+/******************************************************************************/
 
 /**
- *  @brief Enum specifying Reason Codes (Refcodes), start at 0xE501 (through 0xE5FF)
+ *  @brief Enum specifying Reason Codes (Refcodes), range 0xE501 to 0xE5FF
  */
 enum
 {
-  PRDF_HARDWARE_FAIL            = PRDF_COMP_ID | 0x01,
-  PRDF_FIRST_REASONCODE         = PRDF_COMP_ID | 0x01, //Start of PRD Reason code range
+    PRDF_FIRST_REASONCODE                   = PRDF_COMP_ID | 0x01,
+
+    // PRD thermal error log FIXME: may be depricated in P8
+    PRDF_THERMAL_FAIL                       = PRDF_COMP_ID | 0x03,
 
-  PRDF_THERMAL_FAIL             = PRDF_COMP_ID | 0x03, //PRD Thermal Error Log
+    // Note: Ranges from 0x04 through 0x3f are reserved for when callouts are
+    //       all hardware only.
 
-  //Note: ranges from 0x04 through -0x3f are reserved for when callouts are all hardware only.
-  PRDF_DETECTED_FAIL_HARDWARE   = PRDF_COMP_ID | 0x04,
+    PRDF_DETECTED_FAIL_HARDWARE             = PRDF_COMP_ID | 0x04,
 
-  //Note: ranges from 0x40 through 0x4f are reserved for when callouts are Hardware, but also include Software or Second Level Support.
-  PRDF_DETECTED_FAIL_HARDWARE_PROBABLE  = PRDF_COMP_ID | 0x40,
+    // Note: Ranges from 0x40 through 0x4f are reserved for when callouts are
+    //       hardware, but also include software or second level support.
 
-  //Note: ranges from 0x50 through 0x5f are reserved for when at least one callout is Software High, and also include some hardware callouts.
-  PRDF_DETECTED_FAIL_SOFTWARE_PROBABLE  = PRDF_COMP_ID | 0x50,
+    PRDF_DETECTED_FAIL_HARDWARE_PROBABLE    = PRDF_COMP_ID | 0x40,
 
-  //Note: ranges from 0x60 through 0x6f are reserved for when callouts are all Software and Second Level Support only.
-  PRDF_DETECTED_FAIL_SOFTWARE   = PRDF_COMP_ID | 0x60,
-  PRDF_UNSUPPORTED_SCAN_WRITE   = PRDF_COMP_ID | 0x61,
+    // Note: Ranges from 0x50 through 0x5f are reserved for when at least one
+    //       callout is software High, and also include some hardware callouts.
 
-  //Note: ranges from 0x70 through 0x7f are currently reserved (unused).
+    PRDF_DETECTED_FAIL_SOFTWARE_PROBABLE    = PRDF_COMP_ID | 0x50,
 
-  //Note: ranges from 0x80 through 0xff are reserved for PRD software callouts. When PRD detects a code problem in PRD itself or as a result of interaction with another FSP component. .
-  PRDF_CODE_FAIL                = PRDF_COMP_ID | 0x80, //This is the 'generic' PRD analysis internal code error.
+    // Note: Ranges from 0x60 through 0x6f are reserved for when callouts are
+    //       all software and second level support only.
 
-  PRDF_ECMD_DATA_BUFFER_FAIL    = PRDF_COMP_ID | 0x81, //Error from ecmdDataBuffer
+    PRDF_DETECTED_FAIL_SOFTWARE             = PRDF_COMP_ID | 0x60,
+    PRDF_UNSUPPORTED_SCAN_WRITE             = PRDF_COMP_ID | 0x61,
 
+    // Note: Ranges from 0x70 through 0x7f are currently reserved (unused).
 
-  PRDF_LAST_REASONCODE                = PRDF_COMP_ID | 0xFF  //End of PRD Reason code range, update if range chgs
+    // Note: Ranges from 0x80 through 0xff are reserved for PRD software
+    //       callouts. When PRD detects a code problem in PRD itself or as a
+    //       result of interaction with another FSP component.
+
+    // Generic PRD analysis internal code error. Usually acompanied with a
+    // module ID.
+    PRDF_CODE_FAIL                          = PRDF_COMP_ID | 0x80,
+    // Error from an ecmdDataBuffer
+    PRDF_ECMD_DATA_BUFFER_FAIL              = PRDF_COMP_ID | 0x81,
+
+    PRDF_LAST_REASONCODE                    = PRDF_COMP_ID | 0xFF,
 };
 
-#endif        //prdf_services_codes_H
+} // end namespace PRDF
+
+#endif // prdf_services_codes_H