Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-led-manager / refs/heads/master
commit3197f3a0228483b235c8a2fa8c6227ad6c8edf50[log] [tgz]
authorIgor Kononenko <i.kononenko.e@gmail.com>Wed Sep 18 15:08:54 2024 +0300
committerIgor Kononenko <i.kononenko.e@gmail.com>Wed Sep 18 15:22:06 2024 +0300
tree55d66b4a3c9a408f06ebbedc5df1f187cbf347d3
parentf2669fabb9a9e4803fdd1d2648b9897f9e7c4fb8 [diff]
yaml: update default led.yaml config

The default led.yaml configuration having old definition for a led
priority.
Running `scripts/parse_led.py` goes failure:
```bash
ValueError: Invalid Configuration for LED [heartbeat] in Group
[bmc_booted]: no group priority or led priority defined
```

The change adds `Priority: "On"` for each Leds across all led groups.

Tested:
* run `scripts/parse_led.py -i . -o .`
* the `parse_led.py` generates `led-gen.hpp` properly

Change-Id: Icabb4bc6127a468102387e576e8ce9a54ea07693
Signed-off-by: Igor Kononenko <i.kononenko.e@gmail.com>
1 file changed
tree: 55d66b4a3c9a408f06ebbedc5df1f187cbf347d3
  1. configs/
  2. example/
  3. fault-monitor/
  4. manager/
  5. scripts/
  6. subprojects/
  7. test/
  8. .clang-format
  9. .clang-tidy
  10. .gitignore
  11. .linter-ignore
  12. .prettierrc.yaml
  13. .shellcheck
  14. led.yaml
  15. LICENSE
  16. meson.build
  17. meson.options
  18. OWNERS
  19. pyproject.toml
  20. README.md
  21. utils.cpp
  22. utils.hpp
README.md

phosphor-led-manager

This project manages LED groups on dbus. Sometimes many LEDs must be driven together to indicate some system state.

For example, there can be multiple identify LEDs. When the user wants to identify the system, they should all light up together.

Configuration

The configuration can happen via json or yaml.

Configuration: LED Priority

Each LED can have "Priority" as "Blink", "Off" or "On". If this property is defined, it should be defined on each instance of the LED in the config.

When multiple LED groups are asserted and contain the same LED, "Priority" determines the state of the LED.

For example, Group 1 says LED1 should be "Blink", and Group 2 says it should be "On". LED1 will then have the state declared in "Priority".

Configuration: LED Group Priority

Using LED Priority is fine for simple configurations, but when group state needs to always be consistent, Group Priority can be used to enforce the consistent representation.

The Group Priority is optional and a higher priority means that when 2 groups are asserted, the one with highest Priority will be represented consistently. Meaning all its LEDs will have the state as per the configuration.

Configuration Example with Group Priorities (JSON)

Here we prioritize the locating group above the fault group since locating may be required to fix the fault.

So independent of the order that these groups are asserted, if both are asserted, "sys_id" should be in "Blink" state.

The "unrelated" group will have the default group priority of 0.

{
  "leds": [
    {
      "group": "enclosure_identify",
      "Priority": 2,
      "members": [
        {
          "Name": "sys_id",
          "Action": "Blink"
        },
        {
          "Name": "rear_id",
          "Action": "Blink"
        }
      ]
    },
    {
      "group": "fault",
      "Priority": 1,
      "members": [
        {
          "Name": "sys_id",
          "Action": "On"
        },
        {
          "Name": "fault",
          "Action": "On"
        }
      ]
    },
    {
      "group": "unrelated",
      "members": [
        {
          "Name": "rear_id",
          "Action": "On"
        }
      ]
    }
  ]
}

Configuration Example (JSON)

This is our configuration file. It describes 2 LEDs for the 'enclosure_identify' group, with their respective states and duty cycles.

{
  "leds": [
    {
      "group": "enclosure_identify",
      "members": [
        {
          "Name": "pca955x_front_sys_id0",
          "Action": "On",
          "DutyOn": 50,
          "Period": 0,
          "Priority": "Blink"
        },
        {
          "Name": "led_rear_enc_id0",
          "Action": "On",
          "DutyOn": 50,
          "Period": 0,
          "Priority": "Blink"
        }
      ]
    }
  ]
}

Then start the program with

~# ./phosphor-led-manager --config example.json

Dbus interface

When starting the program, our LED group shows up on dbus. Usually there will be many more groups.

$ busctl tree xyz.openbmc_project.LED.GroupManager
`- /xyz
  `- /xyz/openbmc_project
    `- /xyz/openbmc_project/led
      `- /xyz/openbmc_project/led/groups
        `- /xyz/openbmc_project/led/groups/enclosure_identify


$ busctl introspect xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/enclosure_identify
NAME                                TYPE      SIGNATURE RESULT/VALUE FLAGS
...
xyz.openbmc_project.Led.Group       interface -         -            -
.Asserted                           property  b         false        emits-change writable

In the above output, the usual org.freedesktop.* interfaces have been removed to keep it readable.

We can now drive the entire group by setting it's 'Asserted' property on dbus.

$ busctl set-property \
xyz.openbmc_project.LED.GroupManager \
/xyz/openbmc_project/led/groups/enclosure_identify \
xyz.openbmc_project.Led.Group Asserted b true

The program can then use the xyz.openbmc_project.Led.Physical dbus interface exposed by phosphor-led-sysfs to set each LED state.

How to Build

meson setup build
cd build
ninja