FFDC collection for buffers, exectue() takes a sev parameter

Change-Id: Iffb9539211b57cf371432ae6a4468577b5a91aad
Reviewed-on: http://gfw160.aus.stglabs.ibm.com:8080/gerrit/16818
Reviewed-by: PRACHI GUPTA <pragupta@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, 21 insertions, 0 deletions

diff --git a/src/import/hwpf/fapi2/docs/topics/Ffdc.md b/src/import/hwpf/fapi2/docs/topics/Ffdc.md
index 85d696b1a..b55f60e0f 100755
--- a/src/import/hwpf/fapi2/docs/topics/Ffdc.md
+++ b/src/import/hwpf/fapi2/docs/topics/Ffdc.md
@@ -124,6 +124,27 @@ And it can be used:
 
 Note the indifference to integral or variable buffers.
 
+### Collecting Buffers as Part of FFDC
+
+To collect a buffer as part of an FFDC collection (as opposed to being
+the FFDC you want to collect) you can add it to the XML:
+
+    <buffer>RAS_STATUS</buffer>
+
+This will generate fapi2::buffer and fapi2::variable_buffer set methods
+for this element:
+
+    fapi2::buffer<uint64_t> data;
+    set_RAS_STATUS(data) ...
+
+Also, you can force the conversion of the buffer to an integral
+type without changing the XML
+
+    <ffdc>RAS_STATUS</ffdc>
+
+    fapi2::buffer<uint64_t> data;
+    set_RAS_STATUS(unt64_t(data)) ...
+
 ## Error Log Generation
 
 FAPI had a function called fapiLogError() which would generate platform