summaryrefslogtreecommitdiffstats
path: root/src/include
diff options
context:
space:
mode:
authorMike Jones <mjjones@us.ibm.com>2011-09-06 08:52:17 -0500
committerMIKE J. JONES <mjjones@us.ibm.com>2011-09-07 08:52:29 -0500
commitdd8d92217c8cebd6aa5408ad7fd4fa50ea248c84 (patch)
treee407bbb12cc5e6e12546154e6ac9cbe8a4ccc99c /src/include
parent11ea7375f50c8e426e85ebdb4c2d9b67b8ecbb27 (diff)
downloadblackbird-hostboot-dd8d92217c8cebd6aa5408ad7fd4fa50ea248c84.tar.gz
blackbird-hostboot-dd8d92217c8cebd6aa5408ad7fd4fa50ea248c84.zip
HWPF: Initial Support for Target::getString (ecmd string)
Change-Id: Ifef0e05d780fa3ff0a29ce289a684a37495be943 Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/324 Tested-by: Jenkins Server Reviewed-by: MIKE J. JONES <mjjones@us.ibm.com>
Diffstat (limited to 'src/include')
-rw-r--r--src/include/usr/hwpf/fapi/fapiTarget.H20
1 files changed, 13 insertions, 7 deletions
diff --git a/src/include/usr/hwpf/fapi/fapiTarget.H b/src/include/usr/hwpf/fapi/fapiTarget.H
index 093854155..1ee28236d 100644
--- a/src/include/usr/hwpf/fapi/fapiTarget.H
+++ b/src/include/usr/hwpf/fapi/fapiTarget.H
@@ -33,7 +33,8 @@
* ------ -------------- ---------- ----------- ----------------------------
* mjjones 04/13/2011 Created. Based on Hlava prototype
* mjjones 06/29/2011 Removed incorrect MSB from 2 enums
- * mjjones 07/05/2011. Removed const from handle
+ * mjjones 07/05/2011 Removed const from handle
+ * mjjones 08/29/2011 Updated toString function
*/
#ifndef FAPITARGET_H_
@@ -67,6 +68,11 @@ enum TargetType
typedef uint32_t TargetTypes_t;
/**
+ * @brief ECMD constants
+ */
+const uint32_t MAX_ECMD_STRING_LEN = 64;
+
+/**
* @class Target
*
* This class provides a generic Target of a Hardware Procedure Operation.
@@ -172,15 +178,15 @@ public:
/**
* @brief Convert a target to an ecmd-format target string
*
- * @note Implemented by platform code
+ * This is used in order to trace the target in the common SCAN trace
*
- * @return A pointer to a c-string. If the object cannot be converted to a
- * valid ecmd string, a NULL pointer is returned.
+ * @note Implemented by platform code
*
- * IMPORTANT: It is the caller's responsibility to free the returned string
- * when done with it by calling "free(char*)".
+ * @param[out] o_ecmdString. Reference to a character array of length
+ * MAX_ECMD_STRING_LEN. This is filled in with the
+ * null terminated ECMD string.
*/
- const char * toString() const;
+ void toString(char (&o_ecmdString)[MAX_ECMD_STRING_LEN]) const;
private:
OpenPOWER on IntegriCloud