diff mbox series

doc: clarify OPAL_RTC_READ return values

Message ID 20181212042152.6543-1-stewart@linux.ibm.com
State Accepted
Headers show
Series doc: clarify OPAL_RTC_READ return values | expand

Checks

Context Check Description
snowpatch_ozlabs/apply_patch success master/apply_patch Successfully applied
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot success Test snowpatch/job/snowpatch-skiboot on branch master

Commit Message

Stewart Smith Dec. 12, 2018, 4:21 a.m. UTC
It's a quirky call. There was some discussion ages ago surrounding the
fact that we barely document what it returns and when. So, umm... make
it slightly less terrible, but still terrible.

Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 doc/opal-api/opal-rtc-read-3.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Stewart Smith Feb. 5, 2019, 5:26 a.m. UTC | #1
Stewart Smith <stewart@linux.ibm.com> writes:
> It's a quirky call. There was some discussion ages ago surrounding the
> fact that we barely document what it returns and when. So, umm... make
> it slightly less terrible, but still terrible.
>
> Signed-off-by: Stewart Smith <stewart@linux.ibm.com>

Merged to master as of c2c426ef668be5056ab272b188134f5ee54b8c2b
diff mbox series

Patch

diff --git a/doc/opal-api/opal-rtc-read-3.rst b/doc/opal-api/opal-rtc-read-3.rst
index cb2387658fd5..f56cb2c96c5a 100644
--- a/doc/opal-api/opal-rtc-read-3.rst
+++ b/doc/opal-api/opal-rtc-read-3.rst
@@ -62,6 +62,10 @@  OPAL_PARAMETER
 
 OPAL_INTERNAL_ERROR
   something went wrong, Possibly reported in error log.
+  This can be a transient error
 
 OPAL_BUSY_EVENT
   request is in flight
+
+OPAL_BUSY
+  request may be in flight