Document utility actions in regulator config file
Created documentation for the phosphor-regulators config file. This
commit contains documentation for some utility actions.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I4f2fab3557bffb6320d3a6f8e656bcf078ceedee
diff --git a/phosphor-regulators/docs/config_file/compare_presence.md b/phosphor-regulators/docs/config_file/compare_presence.md
new file mode 100644
index 0000000..67ed1ac
--- /dev/null
+++ b/phosphor-regulators/docs/config_file/compare_presence.md
@@ -0,0 +1,30 @@
+# compare_presence
+
+## Description
+Compares a hardware component's presence to an expected value. The hardware
+component must be a Field-Replaceable Unit (FRU).
+
+This action can be used for [presence_detection](presence_detection.md) of a
+[device](device.md). It can also be used in an [if](if.md) condition to
+execute actions based on FRU presence.
+
+## Properties
+| Name | Required | Type | Description |
+| :--- | :------: | :--- | :---------- |
+| fru | yes | string | Field-Replaceable Unit. Specify the D-Bus inventory path of the FRU. |
+| value | yes | boolean (true or false) | Expected presence value. |
+
+## Return Value
+Returns true if the actual presence value equals the expected value, otherwise
+returns false.
+
+## Example
+```
+{
+ "comments": [ "Check if CPU3 is present" ],
+ "compare_presence": {
+ "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
new file mode 100644
index 0000000..79fd662
--- /dev/null
+++ b/phosphor-regulators/docs/config_file/compare_vpd.md
@@ -0,0 +1,33 @@
+# compare_vpd
+
+## Description
+Compares a VPD (Vital Product Data) keyword value to an expected value.
+
+The following keywords are currently supported:
+* CCIN
+* Manufacturer
+* Model
+* PartNumber
+
+## 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. |
+| keyword | yes | string | VPD keyword. Specify one of the following: "CCIN", "Manufacturer", "Model", "PartNumber". |
+| value | yes | string | Expected value. |
+
+## Return Value
+Returns true if the keyword value equals the expected value, otherwise returns
+false.
+
+## Example
+```
+{
+ "comments": [ "Check if disk backplane has CCIN value 2D35" ],
+ "compare_vpd": {
+ "fru": "/system/chassis/disk_backplane",
+ "keyword": "CCIN",
+ "value": "2D35"
+ }
+}
+```
diff --git a/phosphor-regulators/docs/config_file/run_rule.md b/phosphor-regulators/docs/config_file/run_rule.md
new file mode 100644
index 0000000..c218e4d
--- /dev/null
+++ b/phosphor-regulators/docs/config_file/run_rule.md
@@ -0,0 +1,20 @@
+# run_rule
+
+## Description
+Runs the specified rule.
+
+Note: Make sure that two rules do not run each other recursively (rule "A" runs
+rule "B" which runs rule "A").
+
+## Property Value
+String containing the unique ID of the [rule](rule.md) to run.
+
+## Return Value
+Return value of the rule that was run.
+
+## Example
+```
+{
+ "run_rule": "set_voltage_rule"
+}
+```
diff --git a/phosphor-regulators/docs/config_file/set_device.md b/phosphor-regulators/docs/config_file/set_device.md
new file mode 100644
index 0000000..1522a64
--- /dev/null
+++ b/phosphor-regulators/docs/config_file/set_device.md
@@ -0,0 +1,26 @@
+# set_device
+
+## Description
+Sets the hardware device that will be used by subsequent actions.
+
+Many actions read from or write to a device. Initially this is the
+[device](device.md) that contains the regulator operation being performed, such
+as [configuration](configuration.md) or
+[sensor_monitoring](sensor_monitoring.md).
+
+Use "set_device" if you need to change the hardware device used by actions.
+For example, you need to check a bit in an I/O expander before setting the
+output voltage of a regulator.
+
+## Property Value
+String containing the unique ID of the [device](device.md).
+
+## Return Value
+true
+
+## Example
+```
+{
+ "set_device": "io_expander2"
+}
+```