doc: clarify locking and async of OPAL_SENSOR_READ

Message ID 20170629055358.1255-1-stewart@linux.vnet.ibm.com
State Accepted
Headers show

Commit Message

Stewart Smith June 29, 2017, 5:53 a.m.
Reported-by: Robert Lippert <rlippert@google.com>
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
---
 doc/opal-api/opal-sensor-read-88.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

Comments

Stewart Smith Oct. 16, 2017, 8:04 a.m. | #1
Stewart Smith <stewart@linux.vnet.ibm.com> writes:
> Reported-by: Robert Lippert <rlippert@google.com>
> Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>

Merged to master as of 77dbac105a99c705b830410bd991a5fcd6d1ff4f

Patch

diff --git a/doc/opal-api/opal-sensor-read-88.rst b/doc/opal-api/opal-sensor-read-88.rst
index 932f5726a1d9..6bfc41492bda 100644
--- a/doc/opal-api/opal-sensor-read-88.rst
+++ b/doc/opal-api/opal-sensor-read-88.rst
@@ -11,6 +11,9 @@  service processor for example.  In this case, the call will return
 OPAL_ASYNC_COMPLETION and the token parameter will be used to wait for
 the completion of the request.
 
+The OPAL API doesn't enforce alimit on the number of sensor calls that can
+be in flight.
+
 
 Parameters
 ----------
@@ -32,7 +35,9 @@  OPAL_PARAMETER
 OPAL_UNSUPPORTED
   platform does not support reading sensors.
 
-In case of communication with the FSP on IBM systems:
+Some sensors may have to be read asynchronously (e.g. because OPAL must
+communicate with a service processor). One example is sensors provided
+by the FSP on IBM FSP systems.
 
 OPAL_ASYNC_COMPLETION
   a request was sent and an async completion will