Migrate headers to support platform specializations

  Add plat_target.H, fapi2_target.H
  Add plat_error_scope.H, fapi2_error_scope.H
  Update documentation to reflect platform support
  Wrap buffer print() API to remove from platforms
  Move target operators to platform specific files
  Move target states to target_states.H
  Add plat_hw_access, fapi2_hw_access.H
  Make op mode and pib error platform specific

Change-Id: If376f656b2b8a8f207332d42494dd3ce099790c6
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/16970
Reviewed-by: Matt K. Light <mklight@us.ibm.com>
Reviewed-by: Thi N. Tran <thi@us.ibm.com>
Reviewed-by: Brian Silver <bsilver@us.ibm.com>
Tested-by: Brian Silver <bsilver@us.ibm.com>

1 files changed, 19 insertions, 7 deletions

diff --git a/src/import/hwpf/fapi2/docs/topics/README.md b/src/import/hwpf/fapi2/docs/topics/README.md
index ee7a9f07a..650f1d4b7 100755
--- a/src/import/hwpf/fapi2/docs/topics/README.md
+++ b/src/import/hwpf/fapi2/docs/topics/README.md
@@ -28,7 +28,8 @@ which I'm sure you can steal if needed.
 Target is defined as a template of <TargetType, Value> where
 Value is defined per platform. Smaller platforms will want an integer
 type here, say uint64_t. Larger platforms may want to change this to
-a pointer to an underlying platform specific targeting object.
+a pointer to an underlying platform specific targeting object. This change
+can be made in plat_target.H
 
 The target traversing functions will need to be implemented per-platform.
 
@@ -37,6 +38,16 @@ The target traversing functions will need to be implemented per-platform.
 All of the hardware access functions are assumed to need implementation
 per platform.
 
+plat_hw_access.H is used for platform definitions. Macros or other
+platform definitions related to hw access can go in here.
+
+fapi2_hw_access.H is the common hw access definitions and templates. It
+includes plat_hw_access.H and so definitions in plat_hw_access.H can
+be used in fapi2 common code.
+
+hw_access.H is for platform specializations of the templates in
+fapi2_hw_access.H.
+
 Please use template specialization for target types which need special
 treatment. The API documented here are generic, but they can be made
 very specific for a target type or composite type.
@@ -64,14 +75,15 @@ for XBUS and ABUS
 ### fapi2::ReturnCode and error_scope.H
 
 For smaller platforms, a fapi::ReturnCode is nothing but a uint64_t. For
-larger platforms fapi2::ReturnCode inherits from a (TBD) FFDC object.
-
-There should be nothing to do for error_scope.H
+larger platforms fapi2::ReturnCode inherits from an FFDC object.
 
-### fapi2::FirstFailureData (FFDC (work in progress))
+This difference is contained in
+return_code.H, and noted with the preprocessor macro FAPI2_NO_FFDC.
+Define FAPI2_NO_FFDC to get the simple representation of fapi2::ReturnCode,
+and undefine it to get the FFDC class included.
 
-The platform specific FFDC object will need to be implemented, but the
-tooling to generate the FFDC functions used in FAPI_ASSERT will be provided.
+error_scope.H refers to platform specific macros which can be defined
+in plat_error_scope.H.
 
 ### Attributes