Fix MD040 warnings

The following warnings are generated by using markdownlint analysis:
```
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
```
Refer

Fix MD040 warnings

The following warnings are generated by using markdownlint analysis:
```
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
```
Refer to markdown-lint [1] to fix MD040
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/040-fenced-code-language.md

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I456b41fe5f368798cd1d1e78cd83d29b5bb7e236

show more ...

regs: Document usage of new compatible intf

Update the phosphor-regulators configuration file documentation.
Explain how the new xyz.openbmc_project.Inventory.Decorator.Compatible
D-Bus interface is

regs: Document usage of new compatible intf

Update the phosphor-regulators configuration file documentation.
Explain how the new xyz.openbmc_project.Inventory.Decorator.Compatible
D-Bus interface is used to find the config file name.

The C++ changes to use the new D-Bus interface will be done in a
subsequent commit.

Change-Id: If93272a5b69c9e5bd877a4ebf461b2439aa42b2e
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>

show more ...

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

Change-Id: I53dc3bb17d5dcbb9b33fa3d0db62138f37cc8c0b
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

regulators: Allow empty expected VPD value

Modify the compare_vpd action to support specifying an empty string or
empty byte vector as the expected keyword value.

The VPD service was modified in a

regulators: Allow empty expected VPD value

Modify the compare_vpd action to support specifying an empty string or
empty byte vector as the expected keyword value.

The VPD service was modified in a previous commit to return an empty
keyword value if the VPD interface or keyword does not exist on the
specified D-Bus object path. Thus, the actual keyword value may be
empty.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: If48ab6423c40e5b24d6cff72264dc2efe750c85f

show more ...

regulators: Fix JSON documentation error

Remove the non-existent "detect_phase_fault" action from the JSON
configuration file documentation.

This action existed in early versions of the phase fault

regulators: Fix JSON documentation error

Remove the non-existent "detect_phase_fault" action from the JSON
configuration file documentation.

This action existed in early versions of the phase fault detection
design, but it no longer exists.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I7e1b76bbd690cdf04a1856360395ec111171e6d3

show more ...

regulators: Document phase fault detection

Three new JSON objects are being added to support phase fault detection:
* phase_fault_detection
* i2c_capture_bytes
* log_phase_fault

Add new markdown fi

regulators: Document phase fault detection

Three new JSON objects are being added to support phase fault detection:
* phase_fault_detection
* i2c_capture_bytes
* log_phase_fault

Add new markdown files to document these new objects. Also update
existing documentation to include phase fault detection.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I1b3342970640e5942bd5dc5249dae5fb26115324

show more ...

regulators: Support a string or vector for VPD

Add a 'byte_values' alternative to the 'value' entry in the compare VPD
action. This is to support VPD values that are not strings, such as
'HW', a ne

regulators: Support a string or vector for VPD

Add a 'byte_values' alternative to the 'value' entry in the compare VPD
action. This is to support VPD values that are not strings, such as
'HW', a new IBM keyword that describes the version of a piece of
hardware.

To support this, the VPD class now treats all VPD keyword values as
vectors of uint8_ts, including in its data cache. If a compare VPD
action in the JSON contains a string value, it will be converted to the
vector before the CompareVPDAction class is created.

Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: I3fcabf896f4885feae1b07ee2c3da5929cf8bfa4

show more ...

regulators: Update sensor monitoring documentation

Update the documentation for the pmbus_read_sensor action:
* Improve description of the D-Bus sensor object paths.
* Document how peak/valley senso

regulators: Update sensor monitoring documentation

Update the documentation for the pmbus_read_sensor action:
* Improve description of the D-Bus sensor object paths.
* Document how peak/valley sensors are set and when they are cleared.
* Use the simpler term 'Sensor Type' instead of 'Sensor Value Type' to
match the same change in the code.

Update the internal design documentation:
* Update list of interfaces implemented by D-Bus sensors.
* Describe what the D-Bus Value, Functional, and Available properties
will be set to in various scenarios.
* Add brief description of Services class hierarchy.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I895bf980300a81bcfbaef975edd41aa7d1d81331

show more ...

regulators: Add inventory_path to JSON chassis obj

Add the property "inventory_path" to the "chassis" object in the JSON
configuration file.

This property will be used to create the required D-Bus

regulators: Add inventory_path to JSON chassis obj

Add the property "inventory_path" to the "chassis" object in the JSON
configuration file.

This property will be used to create the required D-Bus association
between a voltage regulator sensor and the chassis that contains it.
This association is required by the Redfish support.

Long term, this new property will be required. That is how it is
documented in the updated version of chassis.md.

However, it will be temporarily optional in the JSON schema and the C++
configuration file parser. This temporary measure will be removed once
all known JSON configuration files have been updated to specify the new
property.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I45f5e8ec86be7672a33099c94c35328862ffe11b

show more ...

regulators: Improve docs for compare_vpd

Improve the documentation for the compare_vpd JSON action:
* Explain what "VPD" is
* Provide an example use case

Signed-off-by: Shawn McCarney <shawnmm@us.i

regulators: Improve docs for compare_vpd

Improve the documentation for the compare_vpd JSON action:
* Explain what "VPD" is
* Provide an example use case

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Iafb3e47293c678a2ea6923438253e2c60f35e8e2

show more ...

regulators: Clear cached hardware data during boot

Clear cached data about hardware devices when the system is powering on
(booting).

While the system was powered off, hardware devices containing v

regulators: Clear cached hardware data during boot

Clear cached data about hardware devices when the system is powering on
(booting).

While the system was powered off, hardware devices containing voltage
regulators could have been added, removed, or replaced. Cached hardware
data might now be invalid.

Tested:
* Ran automated test cases
* Verified that cached data is cleared without errors during boot
* When config file was found and loaded
* When no config file was found

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ief45fe32ddcb122847d201e89ca1267526a87e3c

show more ...

regulators: Document config file name options

Document the options for naming the regulators JSON configuration file.
A config file can have the default file name, or it can have a file name
based o

regulators: Document config file name options

Document the options for naming the regulators JSON configuration file.
A config file can have the default file name, or it can have a file name
based on the values of the IBMCompatibleSystem D-Bus interface provided
by Entity Manager.

Rename the example config file to the default file name.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I8398d8c90e85731ab05c6aeaff3a5ea6e91114f8

show more ...

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

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

show more ...

regulators: Create high level design document

Create a high level design document for the phosphor-regulators
application. Summarize the high level algorithms and key C++ classes.

The low level de

regulators: Create high level design document

Create a high level design document for the phosphor-regulators
application. Summarize the high level algorithms and key C++ classes.

The low level design is documented in doxygen comments in the source
files.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I4f57063b2d4516da06a1f063ef83bb7ca92788bf

show more ...

regulators: Discuss firmware update in README

Update the phosphor-regulators README.md file to discuss the impacts of
installing new firmware on the BMC.

Explain that installing new firmware does n

regulators: Discuss firmware update in README

Update the phosphor-regulators README.md file to discuss the impacts of
installing new firmware on the BMC.

Explain that installing new firmware does not affect the
/etc/phosphor-regulators directory. This means that a config file in
that directory will continue to override the standard config file after
a firmware update.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ic4419b5759d93cd796b693941874f696bffa6285

show more ...

regulators: Create README in application directory

Create a README file in the phosphor-regulators directory. The file
summarizes the features of the application. It also contains a link to
the co

regulators: Create README in application directory

Create a README file in the phosphor-regulators directory. The file
summarizes the features of the application. It also contains a link to
the config file documentation.

Also made minor updates to the config file README.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Idf04501234237d84e6a0350fd93de3f9d3a7c431

show more ...

Modify README.md for folders change under phosphor-regulators and link.

Rename validate-regulators-config to validate-regulators-config.py and
create schema folder that includes the config_schema.js

Modify README.md for folders change under phosphor-regulators and link.

Rename validate-regulators-config to validate-regulators-config.py and
create schema folder that includes the config_schema.json file that
validate-regulators-config.py needs.

Signed-off-by: Bob King <Bob_King@wistron.com>
Change-Id: Ib09e1bee6f13361a787ab82f7937d02a80cb41c4

show more ...

Update sensor-architecture.md link

sensor-architecture.md is moving under architecture/ as part of
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/26251/

26251 should merge before this is merge

Update sensor-architecture.md link

sensor-architecture.md is moving under architecture/ as part of
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/26251/

26251 should merge before this is merged.

Change-Id: I0e2b6cd45642c12ffb389be830cf89ae552d1ebd
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

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 M

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

show more ...

Document logic actions in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the logic-related actions.

Signed-off-by: Shaw

Document logic actions in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the logic-related actions.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Icef0c1687ef4bb402c6a478d208ff4dc3c0ef67b

show more ...

Document PMBus actions in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the PMBus-specific actions.

Signed-off-by: Sha

Document PMBus actions in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the PMBus-specific actions.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Iec1b8de2b27b8e0ee26cd6ce8204907c6d89a12f

show more ...

Document I2C actions in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the I2C-specific actions.

Signed-off-by: Shawn M

Document I2C actions in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the I2C-specific actions.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I702b4b37717159f61334c61183e5b1978d5a8d7a

show more ...

Document rule and action in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the JSON action and rule objects.

Signed-off

Document rule and action in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the JSON action and rule objects.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Idc534ce59928822a6d1d88dadf1b80fdaca32ea9

show more ...

Document operations in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the JSON objects that perform the high
level regul

Document operations in regulator config file

Created documentation for the phosphor-regulators config file. This
commit contains documentation for the JSON objects that perform the high
level regulator operations, such as modifying the regulator
configuration or reading all regulator sensors.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I08a8291e0df0f33b7725cf42a98c6d05d0cd59bb

show more ...

Document hardware objects in regulator config file

Added documentation for the phosphor-regulators config file. This
commit contains documentation for the JSON objects that represent the
hardware i

Document hardware objects in regulator config file

Added documentation for the phosphor-regulators config file. This
commit contains documentation for the JSON objects that represent the
hardware in the system.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ida8f7e5ce375a7cc7453eb3576aa9b09f4da50ed

show more ...