From a83cf9fe480b835ebb6eed47d01014b76391c2a5 Mon Sep 17 00:00:00 2001 From: Sean Cross Date: Fri, 21 May 2021 16:40:33 +0800 Subject: [PATCH] xous: document some more functions Signed-off-by: Sean Cross --- xous-rs/src/syscall.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/xous-rs/src/syscall.rs b/xous-rs/src/syscall.rs index 1481332a7..265fae7e6 100644 --- a/xous-rs/src/syscall.rs +++ b/xous-rs/src/syscall.rs @@ -1495,7 +1495,7 @@ where }) } -/// Wait for a thread to finish +/// Wait for a thread to finish. This is equivalent to `join_thread` pub fn wait_thread(joiner: crate::arch::WaitHandle) -> SysCallResult { crate::arch::wait_thread(joiner) } @@ -1605,6 +1605,8 @@ pub fn join_thread(tid: TID) -> core::result::Result { }) } +/// Perform a raw syscall and return the result. This will transform +/// `xous::Result::Error(e)` into an `Err(e)`. pub fn rsyscall(call: SysCall) -> SysCallResult { let mut ret = Result::Ok; let args = call.as_args();