blob: e7e102f86241de4e09b618f699ec8b87c00b4ea6 [file] [log] [blame]
George Liu616a0712021-02-18 10:50:24 +08001#include "config.h"
2
3#include "json-config.hpp"
4#include "ledlayout.hpp"
5
6#include <nlohmann/json.hpp>
George Liue9fb5c62021-07-01 14:05:32 +08007#include <phosphor-logging/lg2.hpp>
George Liu616a0712021-02-18 10:50:24 +08008#include <sdbusplus/bus.hpp>
9#include <sdeventplus/event.hpp>
10
11#include <filesystem>
12#include <fstream>
13#include <iostream>
14
15namespace fs = std::filesystem;
16
17using Json = nlohmann::json;
George Liu616a0712021-02-18 10:50:24 +080018
19// Priority for a particular LED needs to stay SAME across all groups
20// phosphor::led::Layout::Action can only be one of `Blink` and `On`
Patrick Williamsf2044032022-03-17 05:12:30 -050021using PriorityMap =
22 std::unordered_map<std::string, phosphor::led::Layout::Action>;
George Liu616a0712021-02-18 10:50:24 +080023
George Liu25255212023-07-18 10:14:03 +080024static constexpr auto ledGroups = "/xyz/openbmc_project/led/groups";
25
George Liu616a0712021-02-18 10:50:24 +080026/** @brief Parse LED JSON file and output Json object
27 *
28 * @param[in] path - path of LED JSON file
29 *
30 * @return const Json - Json object
31 */
Patrick Williams73ff9ad2022-03-16 16:27:21 -050032Json readJson(const fs::path& path)
George Liu616a0712021-02-18 10:50:24 +080033{
George Liu616a0712021-02-18 10:50:24 +080034 if (!fs::exists(path) || fs::is_empty(path))
35 {
George Liue9fb5c62021-07-01 14:05:32 +080036 lg2::error("Incorrect File Path or empty file, FILE_PATH = {PATH}",
37 "PATH", path);
George Liu616a0712021-02-18 10:50:24 +080038 throw std::runtime_error("Incorrect File Path or empty file");
39 }
40
41 try
42 {
43 std::ifstream jsonFile(path);
44 return Json::parse(jsonFile);
45 }
46 catch (const std::exception& e)
47 {
George Liue9fb5c62021-07-01 14:05:32 +080048 lg2::error(
49 "Failed to parse config file, ERROR = {ERROR}, FILE_PATH = {PATH}",
50 "ERROR", e, "PATH", path);
George Liu616a0712021-02-18 10:50:24 +080051 throw std::runtime_error("Failed to parse config file");
52 }
53}
54
55/** @brief Returns action enum based on string
56 *
57 * @param[in] action - action string
58 *
59 * @return Action - action enum (On/Blink)
60 */
61phosphor::led::Layout::Action getAction(const std::string& action)
62{
63 assert(action == "On" || action == "Blink");
64
Patrick Williamsed80e882022-03-17 05:03:51 -050065 return action == "Blink" ? phosphor::led::Layout::Action::Blink
66 : phosphor::led::Layout::Action::On;
George Liu616a0712021-02-18 10:50:24 +080067}
68
69/** @brief Validate the Priority of an LED is same across ALL groups
70 *
71 * @param[in] name - led name member of each group
72 * @param[in] priority - member priority of each group
Patrick Williamsf2044032022-03-17 05:12:30 -050073 * @param[out] priorityMap - std::unordered_map, key:name, value:priority
George Liu616a0712021-02-18 10:50:24 +080074 *
75 * @return
76 */
77void validatePriority(const std::string& name,
78 const phosphor::led::Layout::Action& priority,
79 PriorityMap& priorityMap)
80{
George Liu616a0712021-02-18 10:50:24 +080081 auto iter = priorityMap.find(name);
82 if (iter == priorityMap.end())
83 {
84 priorityMap.emplace(name, priority);
85 return;
86 }
87
88 if (iter->second != priority)
89 {
George Liue9fb5c62021-07-01 14:05:32 +080090 lg2::error(
91 "Priority of LED is not same across all, Name = {NAME}, Old Priority = {OLD_PRIO}, New Priority = {NEW_PRIO}",
92 "NAME", name, "OLD_PRIO", int(iter->second), "NEW_PRIO",
93 int(priority));
George Liu616a0712021-02-18 10:50:24 +080094
95 throw std::runtime_error(
96 "Priority of at least one LED is not same across groups");
97 }
98}
99
Patrick Williams73ff9ad2022-03-16 16:27:21 -0500100/** @brief Load JSON config and return led map (JSON version 1)
George Liu616a0712021-02-18 10:50:24 +0800101 *
Patrick Williams158b2c12022-03-17 05:57:44 -0500102 * @return phosphor::led::GroupMap
George Liu616a0712021-02-18 10:50:24 +0800103 */
Patrick Williams158b2c12022-03-17 05:57:44 -0500104const phosphor::led::GroupMap loadJsonConfigV1(const Json& json)
George Liu616a0712021-02-18 10:50:24 +0800105{
Patrick Williams158b2c12022-03-17 05:57:44 -0500106 phosphor::led::GroupMap ledMap{};
George Liu616a0712021-02-18 10:50:24 +0800107 PriorityMap priorityMap{};
108
109 // define the default JSON as empty
110 const Json empty{};
George Liu616a0712021-02-18 10:50:24 +0800111 auto leds = json.value("leds", empty);
112
113 for (const auto& entry : leds)
114 {
George Liu25255212023-07-18 10:14:03 +0800115 fs::path tmpPath(std::string{ledGroups});
George Liu616a0712021-02-18 10:50:24 +0800116 tmpPath /= entry.value("group", "");
117 auto objpath = tmpPath.string();
118 auto members = entry.value("members", empty);
119
Patrick Williams158b2c12022-03-17 05:57:44 -0500120 phosphor::led::ActionSet ledActions{};
George Liu616a0712021-02-18 10:50:24 +0800121 for (const auto& member : members)
122 {
123 auto name = member.value("Name", "");
124 auto action = getAction(member.value("Action", ""));
125 uint8_t dutyOn = member.value("DutyOn", 50);
126 uint16_t period = member.value("Period", 0);
127
128 // Since only have Blink/On and default priority is Blink
129 auto priority = getAction(member.value("Priority", "Blink"));
130
131 // Same LEDs can be part of multiple groups. However, their
132 // priorities across groups need to match.
133 validatePriority(name, priority, priorityMap);
134
135 phosphor::led::Layout::LedAction ledAction{name, action, dutyOn,
136 period, priority};
137 ledActions.emplace(ledAction);
138 }
139
Patrick Williamsf2044032022-03-17 05:12:30 -0500140 // Generated an std::unordered_map of LedGroupNames to std::set of LEDs
George Liu616a0712021-02-18 10:50:24 +0800141 // containing the name and properties.
142 ledMap.emplace(objpath, ledActions);
143 }
144
145 return ledMap;
146}
147
Patrick Williams73ff9ad2022-03-16 16:27:21 -0500148/** @brief Load JSON config and return led map
149 *
Patrick Williams158b2c12022-03-17 05:57:44 -0500150 * @return phosphor::led::GroupMap
Patrick Williams73ff9ad2022-03-16 16:27:21 -0500151 */
Patrick Williams158b2c12022-03-17 05:57:44 -0500152const phosphor::led::GroupMap loadJsonConfig(const fs::path& path)
Patrick Williams73ff9ad2022-03-16 16:27:21 -0500153{
154 auto json = readJson(path);
155
156 auto version = json.value("version", 1);
157 switch (version)
158 {
159 case 1:
160 return loadJsonConfigV1(json);
161
162 default:
163 lg2::error("Unsupported JSON Version: {VERSION}", "VERSION",
164 version);
165 throw std::runtime_error("Unsupported version");
166 }
167
Patrick Williams158b2c12022-03-17 05:57:44 -0500168 return phosphor::led::GroupMap{};
Patrick Williams73ff9ad2022-03-16 16:27:21 -0500169}
170
George Liu616a0712021-02-18 10:50:24 +0800171/** @brief Get led map from LED groups JSON config
172 *
Patrick Williams7217c032022-03-16 16:26:09 -0500173 * @param[in] config - Path to the JSON config.
Patrick Williams158b2c12022-03-17 05:57:44 -0500174 * @return phosphor::led::GroupMap
Patrick Williams7217c032022-03-16 16:26:09 -0500175 *
176 * @note if config is an empty string, daemon will interrogate dbus for
177 * compatible strings.
George Liu616a0712021-02-18 10:50:24 +0800178 */
Patrick Williams158b2c12022-03-17 05:57:44 -0500179const phosphor::led::GroupMap getSystemLedMap(fs::path config)
George Liu616a0712021-02-18 10:50:24 +0800180{
Patrick Williams7217c032022-03-16 16:26:09 -0500181 if (config.empty())
George Liu616a0712021-02-18 10:50:24 +0800182 {
Patrick Williams7217c032022-03-16 16:26:09 -0500183 config = phosphor::led::getJsonConfig();
George Liu616a0712021-02-18 10:50:24 +0800184 }
185
Patrick Williams7217c032022-03-16 16:26:09 -0500186 return loadJsonConfig(config);
George Liu616a0712021-02-18 10:50:24 +0800187}