Skip to content

Commit 2bcffb9

Browse files
committed
doc/sensors: be explicit about the encoding of sensor ID/handle not being ABI
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
1 parent 33fada1 commit 2bcffb9

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

doc/device-tree/ibm,opal/sensors.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Each node has a minimum set of properties describing the sensor :
2222

2323
- a "sensor-data" property giving a unique handler for the
2424
OPAL_SENSOR_READ call to be used by Linux to get the value of
25-
a sensor attribute. A sensor handler has the following encoding : ::
25+
a sensor attribute. This value is opaque to the OS but is *currently*
26+
constructed using the following encoding : ::
2627

2728
| Attr. |Fam|Res. | Resource |
2829
| Number |ily|Class| Id |

doc/opal-api/opal-sensor-read-88.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ OPAL_SENSOR_READ
22
================
33

44
The OPAL sensor call reads a sensor data using a unique handler to
5-
identity the targeted sensor.
6-
5+
identity the targeted sensor. The `sensor_handler` is provided
6+
via the device tree and is opaque to the OS (although we currently
7+
do use an encoding scheme).
78

89
This call can be asynchronous, when a message needs to be sent to a
910
service processor for example. In this case, the call will return

0 commit comments

Comments
 (0)