threshold: fix up documentation per sensor.value
The Sensor.Value has a list of "recognized hierarchies" which is
similarly replicated in all of the Threshold interfaces. The lists
in the Threshold objects were incomplete, so update them.
Also, make trivial whitespace / formatting changes to ensure linewrap
is at the appropriate (80) columns.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I6bd76ca423e1ea3c2e0c7ce59e10dce1125eb6d1
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
index 1c8b4bc..59a8ad5 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
@@ -9,6 +9,9 @@
current
power
energy
+ utilization
+ airflow
+ pressure
Additionally, any object implementing Sensor.Threshold.Critical must also
implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
index 4987414..fbb6d78 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
@@ -11,7 +11,9 @@
current
power
energy
-
+ utilization
+ airflow
+ pressure
Additionally, any object implementing Sensor.Threshold.HardShutdown must
also implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
index 0c6c9e9..2d510f1 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
@@ -1,8 +1,8 @@
description: >
Implement to provide performance loss class sensor thresholds. Objects
- implementing Sensor.Threshold.PerformanceLoss must be instantiated in the correct
- hierarchy within the sensors namespace. The following sensor hierarchies
- are recognized:
+ implementing Sensor.Threshold.PerformanceLoss must be instantiated in the
+ correct hierarchy within the sensors namespace. The following sensor
+ hierarchies are recognized:
temperature
fan_tach
voltage
@@ -10,10 +10,12 @@
current
power
energy
+ utilization
+ airflow
+ pressure
-
- Additionally, any object implementing Sensor.Threshold.PerformanceLoss must also
- implement Sensor.Value.
+ Additionally, any object implementing Sensor.Threshold.PerformanceLoss must
+ also implement Sensor.Value.
properties:
- name: PerformanceLossHigh
@@ -34,16 +36,18 @@
True if the sensor value has exceeded the defined bound.
False if the sensor value has not exceeded the defined bound.
- PerformanceLossAlarmHigh may be set to False to clear an alarm condition.
- The behavior of setting PerformanceLossAlarmHigh to True is undefined.
+ PerformanceLossAlarmHigh may be set to False to clear an alarm
+ condition. The behavior of setting PerformanceLossAlarmHigh to True
+ is undefined.
- name: PerformanceLossAlarmLow
type: boolean
description: >
True if the sensor value has exceeded the defined bound.
False if the sensor value has not exceeded the defined bound.
- PerformanceLossAlarmLow may be set to False to clear an alarm condition.
- The behavior of setting PerformanceLossAlarmLow to True is undefined.
+ PerformanceLossAlarmLow may be set to False to clear an alarm
+ condition. The behavior of setting PerformanceLossAlarmLow to True is
+ undefined.
signals:
- name: PerformanceLossHighAlarmAsserted
description: >
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
index 52b0f54..7a518d9 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
@@ -10,7 +10,9 @@
current
power
energy
-
+ utilization
+ airflow
+ pressure
Additionally, any object implementing Sensor.Threshold.SoftShutdown must
also implement Sensor.Value.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
index 4182eca..6310306 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
@@ -9,7 +9,9 @@
current
power
energy
-
+ utilization
+ airflow
+ pressure
Additionally, any object implementing Sensor.Threshold.Warning must also
implement Sensor.Value.
@@ -43,7 +45,6 @@
WarningAlarmLow may be set to False to clear an alarm condition.
The behavior of setting WarningAlarmLow to True is undefined.
-
signals:
- name: WarningHighAlarmAsserted
description: >