diff options
| author | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-12-08 13:27:58 +1100 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-12-08 13:27:58 +1100 |
| commit | 2bcffb9eb7685c0ae561313318aaf1efffabf5d6 (patch) | |
| tree | 34af22d1686c4f60ce182d3cc7922cc435851ffc | |
| parent | 33fada1a6f4b1f5fcf131765f37fcb76c079bfb2 (diff) | |
| download | skiboot-2bcffb9eb7685c0ae561313318aaf1efffabf5d6.zip skiboot-2bcffb9eb7685c0ae561313318aaf1efffabf5d6.tar.gz skiboot-2bcffb9eb7685c0ae561313318aaf1efffabf5d6.tar.bz2 | |
doc/sensors: be explicit about the encoding of sensor ID/handle not being ABI
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
| -rw-r--r-- | doc/device-tree/ibm,opal/sensors.rst | 3 | ||||
| -rw-r--r-- | doc/opal-api/opal-sensor-read-88.rst | 5 |
2 files changed, 5 insertions, 3 deletions
diff --git a/doc/device-tree/ibm,opal/sensors.rst b/doc/device-tree/ibm,opal/sensors.rst index c29b88f..2dbdb8a 100644 --- a/doc/device-tree/ibm,opal/sensors.rst +++ b/doc/device-tree/ibm,opal/sensors.rst @@ -22,7 +22,8 @@ Each node has a minimum set of properties describing the sensor : - a "sensor-data" property giving a unique handler for the OPAL_SENSOR_READ call to be used by Linux to get the value of - a sensor attribute. A sensor handler has the following encoding : :: + a sensor attribute. This value is opaque to the OS but is *currently* + constructed using the following encoding : :: | Attr. |Fam|Res. | Resource | | Number |ily|Class| Id | diff --git a/doc/opal-api/opal-sensor-read-88.rst b/doc/opal-api/opal-sensor-read-88.rst index 22f880e..932f572 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 |