opal-prd/hostboot-interface: Add API comment regarding nanosleep ranges

Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
open-power · Sep 28, 2017 · ec5fa99 · ec5fa99
1 parent 0e07517
commit ec5fa99
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/external/opal-prd/hostboot-interface.h b/external/opal-prd/hostboot-interface.h
@@ -165,6 +165,10 @@ struct host_interfaces {
 
 	/**
 	 * @brief Delay/sleep for at least the time given
+	 *
+	 * The sleep time must be normalised; i_nano_seconds should be between
+	 * 0 and 999999999.
+	 *
 	 * @param[in] seconds
 	 * @param[in] nano seconds
 	 * @platform FSP,OpenPOWER