HWPF: Add support for reporting ADU locked error

This allows platforms to report that a SCOM error was due to ADU locked.
The FSP HWPs that do ADU operations (proc_adu_getmem_coherent and
proc_adu_putmem_coherent) need to look for this error so that they can
retry appropriately.

Change-Id: I8caa7efaf98131cc5ec2e8c36c069f86e329cf05
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/982
Tested-by: Jenkins Server
Reviewed-by: Brian H. Horton <brianh@linux.ibm.com>
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 19 insertions, 2 deletions

diff --git a/src/include/usr/hwpf/fapi/fapiReturnCodes.H b/src/include/usr/hwpf/fapi/fapiReturnCodes.H
index 4c18346f5..21d7f328c 100644
--- a/src/include/usr/hwpf/fapi/fapiReturnCodes.H
+++ b/src/include/usr/hwpf/fapi/fapiReturnCodes.H
@@ -40,6 +40,7 @@
  *                          mjjones     11/10/2011  Use ecmdDataBufferBase
  *                          mjjones     01/13/2012  Name enumeration
  *                          mjjones     04/16/2012  Add FAPI_RC_INVALID_CHIP_EC_FEATURE_GET
+ *                          mjjones     05/02/2012  Add FAPI_RC_PLAT_ERR_ADU_LOCKED
  */
 
 #ifndef FAPIRETURNCODES_H_
@@ -60,18 +61,34 @@ enum ReturnCodes
 {
     FAPI_RC_SUCCESS = 0,
 
+    //--------------------------------------------------------------------------
     // Flag bits indicating which code generated the error If no flag set then
     // it is generated by HWP
+    //--------------------------------------------------------------------------
     FAPI_RC_FAPI_MASK = 0x04000000, // FAPI generated error
     FAPI_RC_PLAT_MASK = 0x02000000, // PLAT generated error
     FAPI_RC_ECMD_MASK = ECMD_ERR_ECMD, // ECMD generated error (0x01000000)
 
+    //--------------------------------------------------------------------------
     // FAPI generated return codes
+    //--------------------------------------------------------------------------
+
+    // Initfile requested an attribute with an invalid attribute ID
     FAPI_RC_INVALID_ATTR_GET            = FAPI_RC_FAPI_MASK | 0x01,
+
+    // HWP requested a chip EC feature with an invalid attribute ID
     FAPI_RC_INVALID_CHIP_EC_FEATURE_GET = FAPI_RC_FAPI_MASK | 0x02,
 
-    // PLAT generated return codes
-    FAPI_RC_PLAT_ERR_SEE_DATA = FAPI_RC_PLAT_MASK | 0x01,
+    //--------------------------------------------------------------------------
+    // PLAT generated return codes. Additional details may be contained in
+    // ReturnCode platData (this can only be looked at by PLAT code)
+    //--------------------------------------------------------------------------
+
+    // Generic platform error
+    FAPI_RC_PLAT_ERR_SEE_DATA   = FAPI_RC_PLAT_MASK | 0x01,
+
+    // Operation to AlterDisplay unit failed because it is locked
+    FAPI_RC_PLAT_ERR_ADU_LOCKED = FAPI_RC_PLAT_MASK | 0x02,
 };
 
 }