| commit | 638d148769f64f86425d6b404e7438e348f5839f | [log] [tgz] |
|---|---|---|
| author | Alexander Hansen <alexander.hansen@9elements.com> | Wed Aug 21 17:39:57 2024 +0200 |
| committer | Alexander Hansen <alexander.hansen@9elements.com> | Thu Aug 22 14:42:59 2024 +0200 |
| tree | 0e1bb7cc97d1bc6e2057e06d72f09810c43e9520 | |
| parent | eb1f46a82bfc3822b59ede7b92832c0ee40f8f86 [diff] |
config: error on invalid configuration Since the default led priority is no longer 'Blink', the priority now has to be explicitly defined when using either group priority or led priority. If a configuration does not define the priority, the configuration is invalid and in the yaml case, phosphor-led-manager should fail to build, in the json case, the process should exit due to the configuration error. The config validation has been extracted into it's own file and made separate from json config parsing. So every config will go through the same validation even if its been created via yaml. Change-Id: Ifda65942b0768d6c0d3b25076f7a1236b46b3d9f Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>
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.
The configuration can happen via json or yaml.
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".
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.
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.
$ cat example.json
{
"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"
}
]
}
]
}
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
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.
meson setup build
cd build
ninja