Add missing parameter to fapi2::delay

Change-Id: Ic334664b4dd260d2dd5ac616ad4b3616f2733ca4
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/21538
Reviewed-by: Matt Derksen <v2cibmd@us.ibm.com>
Tested-by: Jenkins Server
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>

1 files changed, 13 insertions, 1 deletions

diff --git a/src/usr/fapi2/plat_utils.C b/src/usr/fapi2/plat_utils.C
index 6a3fd749d..152491ea9 100644
--- a/src/usr/fapi2/plat_utils.C
+++ b/src/usr/fapi2/plat_utils.C
@@ -968,8 +968,20 @@ void logError(
     return;
 }
 
-ReturnCode delay(uint64_t i_nanoSeconds, uint64_t i_simCycles)
+///
+/// @brief Delay this thread. Hostboot will use the nanoseconds parameter
+/// and make a syscall to nanosleep. While in the syscall, the hostboot
+/// kernel will continue to consume CPU cycles as it looks for a runnable
+/// task.  When the delay time expires, the task becomes runnable and will soon
+/// return from the syscall.  Callers of delay() in the hostboot environment
+/// will likely have to know the mHz clock speed they are running on and
+/// compute a non-zero value for i_nanoSeconds.
+///
+ReturnCode delay(uint64_t i_nanoSeconds,
+                 uint64_t i_simCycles,
+                 bool i_fixed)
 {
+    //Note: i_fixed is deliberately ignored
     nanosleep( 0, i_nanoSeconds );
     return FAPI2_RC_SUCCESS;
 }