summaryrefslogtreecommitdiffstats
path: root/src/include/usr/hwpf/fapi/fapiUtil.H
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/usr/hwpf/fapi/fapiUtil.H')
-rw-r--r--src/include/usr/hwpf/fapi/fapiUtil.H43
1 files changed, 23 insertions, 20 deletions
diff --git a/src/include/usr/hwpf/fapi/fapiUtil.H b/src/include/usr/hwpf/fapi/fapiUtil.H
index e3033dc9a..51a8a6dcc 100644
--- a/src/include/usr/hwpf/fapi/fapiUtil.H
+++ b/src/include/usr/hwpf/fapi/fapiUtil.H
@@ -40,6 +40,9 @@
* mjjones 10/13/2011 Added extern "C" to functions
* camvanng 10/14/2011 Added fapiLoadInitFile &
* fapiUnloadInitFile
+ * camvanng 11/15/2011 Pass target to fapiLoadInitFile
+ * and doxygen changes;
+ * needed by cronus
*/
#ifndef FAPIUTIL_H_
@@ -98,20 +101,20 @@ fapi::ReturnCode fapiDelay(uint64_t i_nanoSeconds, uint64_t i_simCycles);
*
* @note Implemented by platform code
*
- * @param[io] Reference to ReturnCode (Any references to data and error
+ * @param[in,out] io_rc Reference to ReturnCode (Any references to data and error
* target are removed and rc value is set to success after
* function ends.)
*
- * Example usage:
- * fapi::ReturnCode l_rc;
- * FAPI_EXEC_HWP(l_rc, function1, i_target);
- * if (!l_rc)
- * {
- * fapiLogError(l_rc);
- * }
+ * Example usage: <br>
+ * fapi::ReturnCode l_rc; <br>
+ * FAPI_EXEC_HWP(l_rc, function1, i_target); <br>
+ * if (!l_rc) <br>
+ * { <br>
+ * fapiLogError(l_rc); <br>
+ * } <br>
*
- * FAPI_EXEC_HWP(l_rc, function2, i_target)
- * return rc;
+ * FAPI_EXEC_HWP(l_rc, function2, i_target) <br>
+ * return rc; <br>
*/
void fapiLogError(fapi::ReturnCode & io_rc);
@@ -125,7 +128,7 @@ bool platIsScanTraceEnabled();
/** @brief Alter the state of scand tracing.
* The implementation of this function is specific to the platform.
*
- * @param[in] True to enable or false to disable scan trace.
+ * @param[in] i_enable True to enable or false to disable scan trace.
* @return void
*/
void platSetScanTrace(bool i_enable);
@@ -138,15 +141,15 @@ void platSetScanTrace(bool i_enable);
* responsible for allocating any memory needed to load
* the initfile.
*
- * @param[in] the .if filename: <initfile>.if
- * @param[out] address in memory where initfile is loaded
- * @param[out] size of memory allocated for initfile
+ * @param[in] i_Target reference to the target
+ * @param[in] i_file the .if filename: \<initfile\>.if
+ * @param[out] o_addr address in memory where initfile is loaded
+ * @param[out] o_size size of memory allocated for initfile
*
* @return ReturnCode. Zero on success, else platform specified error.
*/
-
-fapi::ReturnCode fapiLoadInitFile(const char * i_file, const char *& o_addr,
- size_t & o_size);
+fapi::ReturnCode fapiLoadInitFile(const fapi::Target & i_Target,
+ const char * i_file, const char *& o_addr, size_t & o_size);
/** @brief Unload the initfile
*
@@ -155,10 +158,10 @@ fapi::ReturnCode fapiLoadInitFile(const char * i_file, const char *& o_addr,
* @note Implemented by platform code. Platform code is
* responsible for deleting any allocated memory.
*
- * @param[in] the .if filename: <initfile>.if
- * @param[in,out] address in memory where initfile is loaded
+ * @param[in] i_file the .if filename: \<initfile\>.if
+ * @param[in,out] io_addr address in memory where initfile is loaded
* set to NULL on exit
- * @param[in,out] size of memory allocated for initfile
+ * @param[in,out] io_size size of memory allocated for initfile
* set to 0 on exit
*
* @return ReturnCode. Zero on success, else platform specified error.
OpenPOWER on IntegriCloud