aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2022-10-29 19:47:04 -0600
committerSimon Glass <sjg@chromium.org>2022-11-07 16:24:30 -0700
commit6ca4d5b96b54bdd6086c084631500e918b37ceb7 (patch)
treec7681034587b516ee0084aff2a7cb1e029b2d498 /include
parentff1f0e414a6eafd76c6e8ec114bebf6df6c49d68 (diff)
downloadu-boot-6ca4d5b96b54bdd6086c084631500e918b37ceb7.zip
u-boot-6ca4d5b96b54bdd6086c084631500e918b37ceb7.tar.gz
u-boot-6ca4d5b96b54bdd6086c084631500e918b37ceb7.tar.bz2
sandbox: Add missing comments for os_alarm()
Add the documentation to avoid a warning with 'make htmldocs'. Fixes: 10107efedd5 ("sandbox: add SIGALRM-based watchdog device") Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'include')
-rw-r--r--include/os.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/os.h b/include/os.h
index 54874f5..0415f0f 100644
--- a/include/os.h
+++ b/include/os.h
@@ -110,6 +110,10 @@ void os_exit(int exit_code) __attribute__((noreturn));
/**
* os_alarm() - access to the OS alarm() system call
+ *
+ * @seconds: number of seconds before the signal is sent
+ * Returns: number of seconds remaining until any previously scheduled alarm was
+ * due to be delivered; 0 if there was no previously scheduled alarm
*/
unsigned int os_alarm(unsigned int seconds);