regulators: Update inventory paths in docs/example
Updated the JSON configuration file documentation and example to clarify
that inventory paths are relative.
JSON configuration file documentation changes:
* Described how inventory paths are relative to the root
/xyz/openbmc_project/inventory.
* Removed leading slashes from the example inventory paths.
Example JSON configuration file changes:
* Remove leading slashes from the inventory paths.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Iec602f76e663c120b40017f3d12fb526b93c0ce5
diff --git a/phosphor-regulators/docs/config_file/compare_presence.md b/phosphor-regulators/docs/config_file/compare_presence.md
index 67ed1ac..a440b41 100644
--- a/phosphor-regulators/docs/config_file/compare_presence.md
+++ b/phosphor-regulators/docs/config_file/compare_presence.md
@@ -11,7 +11,7 @@
## Properties
| Name | Required | Type | Description |
| :--- | :------: | :--- | :---------- |
-| fru | yes | string | Field-Replaceable Unit. Specify the D-Bus inventory path of the FRU. |
+| fru | yes | string | Field-Replaceable Unit. Specify the relative D-Bus inventory path of the FRU. Full inventory paths begin with the root "/xyz/openbmc_project/inventory". Specify the relative path below the root, such as "system/chassis/motherboard/cpu3". |
| value | yes | boolean (true or false) | Expected presence value. |
## Return Value
@@ -23,7 +23,7 @@
{
"comments": [ "Check if CPU3 is present" ],
"compare_presence": {
- "fru": "/system/chassis/motherboard/cpu3",
+ "fru": "system/chassis/motherboard/cpu3",
"value": true
}
}
diff --git a/phosphor-regulators/docs/config_file/compare_vpd.md b/phosphor-regulators/docs/config_file/compare_vpd.md
index 79fd662..e87ef87 100644
--- a/phosphor-regulators/docs/config_file/compare_vpd.md
+++ b/phosphor-regulators/docs/config_file/compare_vpd.md
@@ -12,7 +12,7 @@
## Properties
| Name | Required | Type | Description |
| :--- | :------: | :--- | :---------- |
-| fru | yes | string | Field-Replaceable Unit (FRU) that contains the VPD. Specify the D-Bus inventory path of the FRU. |
+| fru | yes | string | Field-Replaceable Unit (FRU) that contains the VPD. Specify the relative D-Bus inventory path of the FRU. Full inventory paths begin with the root "/xyz/openbmc_project/inventory". Specify the relative path below the root, such as "system/chassis/disk_backplane". |
| keyword | yes | string | VPD keyword. Specify one of the following: "CCIN", "Manufacturer", "Model", "PartNumber". |
| value | yes | string | Expected value. |
@@ -25,7 +25,7 @@
{
"comments": [ "Check if disk backplane has CCIN value 2D35" ],
"compare_vpd": {
- "fru": "/system/chassis/disk_backplane",
+ "fru": "system/chassis/disk_backplane",
"keyword": "CCIN",
"value": "2D35"
}
diff --git a/phosphor-regulators/docs/config_file/device.md b/phosphor-regulators/docs/config_file/device.md
index f01c37d..28180d0 100644
--- a/phosphor-regulators/docs/config_file/device.md
+++ b/phosphor-regulators/docs/config_file/device.md
@@ -14,7 +14,7 @@
| comments | no | array of strings | One or more comment lines describing this device. |
| id | yes | string | Unique ID for this device. Can only contain letters (A-Z, a-z), numbers (0-9), and underscore (\_). |
| is_regulator | yes | boolean (true or false) | Indicates whether this device is a voltage regulator (phase controller). |
-| fru | yes | string | Field-Replaceable Unit (FRU) for this device. Specify the D-Bus inventory path of the FRU. If the device itself is not a FRU, specify the FRU that contains it. |
+| fru | yes | string | Field-Replaceable Unit (FRU) for this device. If the device itself is not a FRU, specify the FRU that contains it. Specify the relative D-Bus inventory path of the FRU. Full inventory paths begin with the root "/xyz/openbmc_project/inventory". Specify the relative path below the root, such as "system/chassis/motherboard/regulator2". |
| i2c_interface | yes | [i2c_interface](i2c_interface.md) | I2C interface to this device. |
| presence_detection | no | [presence_detection](presence_detection.md) | Specifies how to detect whether this device is present. If this property is not specified, the device is assumed to always be present. |
| configuration | no | [configuration](configuration.md) | Specifies configuration changes that should be applied to this device. These changes usually override hardware default settings. The configuration changes are applied during the boot before regulators are enabled. |
@@ -26,7 +26,7 @@
"comments": [ "IR35221 regulator producing the Vdd rail" ],
"id": "vdd_regulator",
"is_regulator": true,
- "fru": "/system/chassis/motherboard/regulator2",
+ "fru": "system/chassis/motherboard/regulator2",
"i2c_interface": {
"bus": 1,
"address": "0x70"
diff --git a/phosphor-regulators/docs/config_file/presence_detection.md b/phosphor-regulators/docs/config_file/presence_detection.md
index 293cb3c..138ff9c 100644
--- a/phosphor-regulators/docs/config_file/presence_detection.md
+++ b/phosphor-regulators/docs/config_file/presence_detection.md
@@ -53,7 +53,7 @@
"actions": [
{
"compare_presence": {
- "fru": "/system/chassis/motherboard/cpu3",
+ "fru": "system/chassis/motherboard/cpu3",
"value": true
}
}
diff --git a/phosphor-regulators/examples/config_file.json b/phosphor-regulators/examples/config_file.json
index 701322d..f18237e 100644
--- a/phosphor-regulators/examples/config_file.json
+++ b/phosphor-regulators/examples/config_file.json
@@ -57,7 +57,7 @@
"comments": [ "IR35221 regulator producing the Vdd rail" ],
"id": "vdd_regulator",
"is_regulator": true,
- "fru": "/system/chassis/motherboard/regulator1",
+ "fru": "system/chassis/motherboard/regulator1",
"i2c_interface": {
"bus": 1,
"address": "0x70"
@@ -81,7 +81,7 @@
"comments": [ "IR35221 regulator producing the Vio rail" ],
"id": "vio_regulator",
"is_regulator": true,
- "fru": "/system/chassis/motherboard/regulator2",
+ "fru": "system/chassis/motherboard/regulator2",
"i2c_interface": {
"bus": 1,
"address": "0x71"