summaryrefslogtreecommitdiffstats
path: root/doc/opal-api
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.vnet.ibm.com>2016-12-08 13:27:58 +1100
committerStewart Smith <stewart@linux.vnet.ibm.com>2016-12-08 13:27:58 +1100
commit2bcffb9eb7685c0ae561313318aaf1efffabf5d6 (patch)
tree34af22d1686c4f60ce182d3cc7922cc435851ffc /doc/opal-api
parent33fada1a6f4b1f5fcf131765f37fcb76c079bfb2 (diff)
downloadtalos-skiboot-2bcffb9eb7685c0ae561313318aaf1efffabf5d6.tar.gz
talos-skiboot-2bcffb9eb7685c0ae561313318aaf1efffabf5d6.zip
doc/sensors: be explicit about the encoding of sensor ID/handle not being ABI
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/opal-api')
-rw-r--r--doc/opal-api/opal-sensor-read-88.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/opal-api/opal-sensor-read-88.rst b/doc/opal-api/opal-sensor-read-88.rst
index 22f880ec..932f5726 100644
--- a/doc/opal-api/opal-sensor-read-88.rst
+++ b/doc/opal-api/opal-sensor-read-88.rst
@@ -2,8 +2,9 @@ OPAL_SENSOR_READ
================
The OPAL sensor call reads a sensor data using a unique handler to
-identity the targeted sensor.
-
+identity the targeted sensor. The `sensor_handler` is provided
+via the device tree and is opaque to the OS (although we currently
+do use an encoding scheme).
This call can be asynchronous, when a message needs to be sent to a
service processor for example. In this case, the call will return
OpenPOWER on IntegriCloud