docs/control/README.md: Fix MD051 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/README.md:7:3 MD051/link-fragments Link fragments should be valid [Co

docs/control/README.md: Fix MD051 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/README.md:7:3 MD051/link-fragments Link fragments should be valid [Context: "[Example](#example)"]
```

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

show more ...

docs/control/README.md: Fix MD034 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/README.md:243:1 MD034/no-bare-urls Bare URL used [Context: "https://g

docs/control/README.md: Fix MD034 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/README.md:243:1 MD034/no-bare-urls Bare URL used [Context: "https://github.com/openbmc/pho..."]
```
Refer to markdown-lint [1] to fix MD034
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/034-no-bare-urls.md

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

show more ...

docs/control/fanctl/README.md: Fix MD026 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/fanctl/README.md:60:12 MD026/no-trailing-punctuation Trailing

docs/control/fanctl/README.md: Fix MD026 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/fanctl/README.md:60:12 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
```
Refer to markdown-lint [1] to fix MD026
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/026-no-trailing-punctuation.md

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

show more ...

docs/control/events.md: Fix MD029 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/events.md:301:1 MD029/ol-prefix Ordered list item prefix [Expected: 1

docs/control/events.md: Fix MD029 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/control/events.md:301:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
docs/control/events.md:329:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
docs/control/events.md:366:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
docs/control/events.md:393:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
```
Refer to markdown-lint [1] to fix MD029
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/029-ol-prefix.md

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

show more ...

README.md: Fix MD037 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/monitor/sensors.md:11:23 MD037/no-space-in-emphasis Spaces inside emphasis markers [Contex

README.md: Fix MD037 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/monitor/sensors.md:11:23 MD037/no-space-in-emphasis Spaces inside emphasis markers [Context: "_ ("]
docs/monitor/sensors.md:11:66 MD037/no-space-in-emphasis Spaces inside emphasis markers [Context: ") _"]
docs/monitor/sensors.md:13:23 MD037/no-space-in-emphasis Spaces inside emphasis markers [Context: "_ ("]
docs/monitor/sensors.md:13:66 MD037/no-space-in-emphasis Spaces inside emphasis markers [Context: ") _"]
```
Refer to markdown-lint [1] to fix MD037
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/037-no-space-in-emphasis.md

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

show more ...

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: Ie866ac8c3d8e33d2c8811f7c6a5965d6dad1f88a

show more ...

Fix MD033 warnings

The following warnings are generated by using markdownlint analysis:
```
MD033/no-inline-html Inline HTML [Element: code]
MD033/no-inline-html Inline HTML [Element: pre]
MD033/no-

Fix MD033 warnings

The following warnings are generated by using markdownlint analysis:
```
MD033/no-inline-html Inline HTML [Element: code]
MD033/no-inline-html Inline HTML [Element: pre]
MD033/no-inline-html Inline HTML [Element: b]
MD033/no-inline-html Inline HTML [Element: i]
```
Refer to markdown-lint [1] to fix MD033
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/033-no-inline-html.md

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

show more ...

docs/presence/rpolicy.md: Fix MD033 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/presence/rpolicy.md:37:6 MD033/no-inline-html Inline HTML [Element: code]
d

docs/presence/rpolicy.md: Fix MD033 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/presence/rpolicy.md:37:6 MD033/no-inline-html Inline HTML [Element: code]
docs/presence/rpolicy.md:37:1 MD033/no-inline-html Inline HTML [Element: pre]
docs/presence/rpolicy.md:50:5 MD033/no-inline-html Inline HTML [Element: b]
docs/presence/rpolicy.md:50:8 MD033/no-inline-html Inline HTML [Element: i]
```
Refer to markdown-lint [1] to fix MD033
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/033-no-inline-html.md

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

show more ...

docs/presence/rpolicy.md: Fix MD040 warnings

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

docs/presence/rpolicy.md: 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: Ic2ddba30a55a328af2528afc56a2147c7ceb6f59

show more ...

docs/presence/README.md: Fix MD040 warnings

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

docs/presence/README.md: 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: Icb601fbd199f536600d35322b7aca19371be00a4

show more ...

control: json: Correct hysteresis definitions

The action target_from_group_max has been implementing the reversed
definitions of positive hysteresis and negative hysteresis. The positive
hysteresis

control: json: Correct hysteresis definitions

The action target_from_group_max has been implementing the reversed
definitions of positive hysteresis and negative hysteresis. The positive
hysteresis should be for the value increasing case and vice versa. This
commit corrects that in source code and events.md.

Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Change-Id: I1b84884d16d5f20d0fdcd9033188ffd31e91f907

show more ...

control: manager: Services with no managed objs

When a D-Bus object used in events is under a service that has the
"org.freedesktop.DBus.ObjectManager", the control::json::Manager will
try to get al

control: manager: Services with no managed objs

When a D-Bus object used in events is under a service that has the
"org.freedesktop.DBus.ObjectManager", the control::json::Manager will
try to get all the managed objects under the service and add to cache.
However, in case when the results from the GetManagedObjects are empty,
it omits the attempt to directly read the object from D-Bus using the
configured information.

This patch handles this situation and allows services that have the
ObjectManager interface but empty managed objects can be read.

Example: Objects under xyz.openbmc_project.State.Host service.

root@mtmitchell-dcscm:~# busctl call xyz.openbmc_project.State.Host \
/xyz/openbmc_project/state/host0 org.freedesktop.DBus.ObjectManager \
GetManagedObjects

a{oa{sa{sv}}} 0

Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Change-Id: I5eca78fdfbc8a26fb7effb861440dc3cf28959d0

show more ...

monitor: Add fan_frus_with_nonfunc_rotors cause

Create a new power off rule to power off when a specific number of fan
FRUs have nonfunctional rotors. With this rule failing rotors can be
treated d

monitor: Add fan_frus_with_nonfunc_rotors cause

Create a new power off rule to power off when a specific number of fan
FRUs have nonfunctional rotors. With this rule failing rotors can be
treated differently when they are spread across fans FRUS than when they
are within the same fan FRU.

For example, if both rotors of a 2 rotor fan fail the system can stay
up, but if 2 rotors in separate fans fail then the system could be made
to power off.

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

show more ...

control: Add optional delay to count_state_floor

Add an optional delay field to the count_state_floor action that takes a
value in seconds. When set to a nonzero value, the action will then
require

control: Add optional delay to count_state_floor

Add an optional delay field to the count_state_floor action that takes a
value in seconds. When set to a nonzero value, the action will then
require the count condition to be satisfied for that amount of time
before setting the floor. This can be used to prevent the floor from
jumping when there is just short change to a property value, for example
if a sensor set to not functional for a short amount of time.

For example:

{
"name": "count_state_floor",
"count": 1,
"state": false,
"delay": 5,
"floor": 18000
}

This says that the floor won't be set to 18000 until at least 1 group
member has its property value set to false for a continuous 5 seconds.

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

show more ...

Use generic interface to look for configs

IBM has specific interface IBMCompatibleSystem to look for the
compatible system location under which the configs are placed. The
Entity Manager schema for

Use generic interface to look for configs

IBM has specific interface IBMCompatibleSystem to look for the
compatible system location under which the configs are placed. The
Entity Manager schema for the property under this interface and the
interface name itself can't be generic for other meta systems.
To find a more common interface, this should be the one that is probed
together with chassis and has its property value corresponding to
system's name.

This commit proposes the use of the property Names under the interface
xyz.openbmc_project.Inventory.Decorator.Compatible [1]. The property
can be configured in chassis's Entity Manager json configuration with
a list of one or more compatible system strings. The usage of this
interface was mentioned in document [2].

[1] https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/\
yaml/xyz/openbmc_project/Inventory/Decorator/Compatible.interface.yaml
[2] https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/\
yaml/xyz/openbmc_project/Software/README.md#compatibility

Tested in Ampere's Mt.Mitchell platform.

1. Configure the interface in Motherboard's Entity Manager config:
"xyz.openbmc_project.Inventory.Decorator.Compatible": {
"Names": ["com.ampere.Hardware.Chassis.Model.MtMitchell"]
}
2. Configs are already placed under
/usr/share/phosphor-fan-presence/<daemon>/\
com.ampere.Hardware.Chassis.Model.MtMitchell/
3. When Entity Manager config is probed:
$ busctl call -j xyz.openbmc_project.ObjectMapper \
/xyz/openbmc_project/object_mapper xyz.openbmc_project.ObjectMapper \
GetSubTreePaths sias / 0 1
xyz.openbmc_project.Inventory.Decorator.Compatible
{
"type": "a{sa{sas}}",
"data": [
[
"/xyz/openbmc_project/inventory/system/board/\
Mt_Mitchell_Motherboard" : {
"xyz.openbmc_project.EntityManager" : [
...
"xyz.openbmc_project.Inventory.Decorator.Compatible
]
}
]
]
}

$ busctl get-property xyz.openbmc_project.EntityManager \
/xyz/openbmc_project/inventory/system/board/Mt_Mitchell_Motherboard \
xyz.openbmc_project.Inventory.Decorator.Compatible Names
as 1 "com.ampere.Hardware.Chassis.Model.MtMitchell"
4. When phosphor-fan's daemon starts, it can successfully find
configs under the folder "com.ampere.Hardware.Chassis.Model.MtMitchell"

Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Change-Id: I55107f1c2a78e78ba7cea650b8eaeaf4fd615d2b

show more ...

monitor: Support a separate upper deviation

Add an optional 'upper_deviation' field to the fan monitor config and if
supplied it will be used for the allowed deviation when the fan value is
over the

monitor: Support a separate upper deviation

Add an optional 'upper_deviation' field to the fan monitor config and if
supplied it will be used for the allowed deviation when the fan value is
over the target. If not supplied it will work as today and the single
deviation value will be used for both the upper and lower bounds.

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

show more ...

control: mapped_floor: Add conditions

Add the concept of a condition to the mapped_floor action such that it
will only run if the condition is met. If the condition isn't met, the
run() function wi

control: mapped_floor: Add conditions

Add the concept of a condition to the mapped_floor action such that it
will only run if the condition is met. If the condition isn't met, the
run() function will just exit immediately.

A condition is created by placing the following in the JSON:

* condition_group
- The name of the group that has the property the condition
will use. For now, it must be a single member group.
* condition_value
- The value the property has to be to meet the condition.
* condition_op
- Either 'equal' or 'not_equal', where the property has to
either be equal to or not equal to the condition value.

For example, the following says the single member of the 'cpu 0' group
must have its Model property be equal to "1234" for the action to run:

{
"groups": [{
"name": "cpu 0",
"interface": "xyz.openbmc_project.Inventory.Decorator.Asset",
"property": { "name": "Model" }
}
...
],
...
"name": "mapped_floor",
"key_group": "ambient temp",
"condition_group": "cpu 0",
"condition_value": "1234",
"condition_op": "equal",
...
}

If a condition is present but isn't met, the action will remove its
floor hold if it has one to support the case of the condition property
changing values.

Change-Id: I3ede20efd334e2c5292a441c089534420959c7bc
Signed-off-by: Matt Spinler <spinler@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: Ia2f5cffe35ac3175d6663d9b4e173d16e985bf4c
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

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: I961ec77b2617da3e097e64e0d8e8980bb7e5b426
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

pres: Add way to bind fan eeprom driver after plug

Some fans have EEPROMs on them that are read by other BMC code so the
contents can be added to the BMC inventory. Since fans can usually be
hotplu

pres: Add way to bind fan eeprom driver after plug

Some fans have EEPROMs on them that are read by other BMC code so the
contents can be added to the BMC inventory. Since fans can usually be
hotplugged, this means those EEPROMs need to be read after a fan is
plugged, and there was previously no method to trigger that.

This commit adds functionality to phosphor-fan-presence-tach to bind the
EEPROM driver to the new device after a fan with an EEPROM is plugged.
This triggers a udev event which triggers EEPROM reads if the platform
is configured to do so.

This is done with a new optional JSON section in the config.json, which
looks like:
"eeprom": {
"bus_address": "31-0050",
"driver_name": "at24",
"bind_delay_ms": 1000
}

The 'bus_address' field is the device's I2C bus and address string as it
is represented in the I2C subsystem in sysfs. The 'driver_name' field
is the name of the device driver that manages that device. The
'bind_delay_ms' field allows there to be a defined amount of time
between when the device is plugged and when the driver is bound, in case
a certain amount of time is required for the device to come online after
it receives power.

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

show more ...

monitor: Support target_path option in configuration file

The target path containing the interface
xyz.openbmc_project.control.FanPwm or
xyz.openbmc_project.control.FanSpeed can be different between

monitor: Support target_path option in configuration file

The target path containing the interface
xyz.openbmc_project.control.FanPwm or
xyz.openbmc_project.control.FanSpeed can be different between
phosphor-hwmon and dbus-sensor.

In phosphor-hwmon, it is "/xyz/openbmc_project/sensors/fan_tach/".
In dbus-sensor, it is "/xyz/openbmc_project/control/fanpwm/".

This commit supports making this path configurable via "target_path"
as a full object path.
By default, it is the same as the fan tach object path.

Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Change-Id: I2658a462dd49a98ad77d684f2927e6ccae21cd15

show more ...

control: Support target_path option in configuration file

The target path containing the interface
xyz.openbmc_project.control.FanPwm or
xyz.openbmc_project.control.FanSpeed can be different between

control: Support target_path option in configuration file

The target path containing the interface
xyz.openbmc_project.control.FanPwm or
xyz.openbmc_project.control.FanSpeed can be different between
phosphor-hwmon and dbus-sensor.

In phosphor-hwmon, it is "/xyz/openbmc_project/sensors/fan_tach/".
In dbus-sensor, it is "/xyz/openbmc_project/control/fanpwm/"

This commit supports making this path configurable via "target_path".
By default, it is "/xyz/openbmc_project/sensors/fan_tach/".

Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Change-Id: Id799986ff69455b7c7054070ed2ab3b2e2500a6c

show more ...

control: Json action to set zone's target from group

This commit adds an action to fan control json format, supporting
setting target of Zone to a value corresponding to the maximum
value from group

control: Json action to set zone's target from group

This commit adds an action to fan control json format, supporting
setting target of Zone to a value corresponding to the maximum
value from group member properties. The mapping is according to
the map. If there are more than one group using this action, the
maximum speed derived from the mapping of all groups will be set
to target.

For example:
{
"name": "target_from_group_max",
"groups": [
{
"name": "zone0_ambient",
"interface": "xyz.openbmc_project.Sensor.Value",
"property": { "name": "Value" }
}
],
"neg_hysteresis": 1,
"pos_hysteresis": 0,
"map": [
{ "value": 10.0, "target": 38.0 },
...
]
}

The above JSON will cause the action to read the property specified
in the group "zone0_ambient" from all members of the group. The
change in the group's members value will be checked against
"neg_hysteresis" and "pos_hysteresis" to decide if it is worth
taking action. "neg_hysteresis" is for the increasing case and
"pos_hysteresis" is for the decreasing case. The maximum property
value of the group will be mapped to the "map" to get the output
"target". The updated "target" value of each group will be stored
in a static map with a key. The maximum value from the static map
will be used to set to the Zone's target.

Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Change-Id: I7b99a6e82ab2faaf40d290ab6f9cb27781e12952

show more ...

control:docs: Add a section on debug

Describe how fanctl dump and fanctl query_dump can be used to help with
debug.

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

control:docs: Add a section on debug

Describe how fanctl dump and fanctl query_dump can be used to help with
debug.

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

show more ...

control:docs:events: Document modifiers

Modifiers can be used by certain actions to modify the result in a
configurable manner.

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

control:docs:events: Document modifiers

Modifiers can be used by certain actions to modify the result in a
configurable manner.

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

show more ...