blob: a425da38b9b1844e5e9f48b6d467e48a48c1737b [file] [log] [blame]
George Liu456c9a22020-01-13 11:36:22 +08001#pragma once
2
George Liu6492f522020-06-16 10:34:05 +08003#include "libpldmresponder/pdr_utils.hpp"
4
George Liuc453e162022-12-21 17:16:23 +08005#include <libpldm/platform.h>
6
Riya Dixit49cfb132023-03-02 04:26:53 -06007#include <phosphor-logging/lg2.hpp>
8
9PHOSPHOR_LOG2_USING;
10
George Liu456c9a22020-01-13 11:36:22 +080011namespace pldm
12{
George Liu456c9a22020-01-13 11:36:22 +080013namespace responder
14{
George Liu456c9a22020-01-13 11:36:22 +080015namespace pdr_numeric_effecter
16{
George Liu456c9a22020-01-13 11:36:22 +080017using Json = nlohmann::json;
18
19static const Json empty{};
20
21/** @brief Parse PDR JSON file and generate numeric effecter PDR structure
22 *
23 * @param[in] json - the JSON Object with the numeric effecter PDR
24 * @param[out] handler - the Parser of PLDM command handler
25 * @param[out] repo - pdr::RepoInterface
26 *
27 */
George Liu36e81352020-07-01 14:40:30 +080028template <class DBusInterface, class Handler>
29void generateNumericEffecterPDR(const DBusInterface& dBusIntf, const Json& json,
30 Handler& handler,
George Liu456c9a22020-01-13 11:36:22 +080031 pdr_utils::RepoInterface& repo)
32{
33 static const std::vector<Json> emptyList{};
34 auto entries = json.value("entries", emptyList);
35 for (const auto& e : entries)
36 {
37 std::vector<uint8_t> entry{};
38 entry.resize(sizeof(pldm_numeric_effecter_value_pdr));
39
40 pldm_numeric_effecter_value_pdr* pdr =
41 reinterpret_cast<pldm_numeric_effecter_value_pdr*>(entry.data());
Manojkiran Edabcf91ac2021-03-14 13:50:48 +053042 if (!pdr)
43 {
Riya Dixit49cfb132023-03-02 04:26:53 -060044 error("Failed to get numeric effecter PDR.");
Manojkiran Edabcf91ac2021-03-14 13:50:48 +053045 continue;
46 }
George Liu456c9a22020-01-13 11:36:22 +080047 pdr->hdr.record_handle = 0;
48 pdr->hdr.version = 1;
49 pdr->hdr.type = PLDM_NUMERIC_EFFECTER_PDR;
50 pdr->hdr.record_change_num = 0;
Patrick Williams6da4f912023-05-10 07:50:53 -050051 pdr->hdr.length = sizeof(pldm_numeric_effecter_value_pdr) -
52 sizeof(pldm_pdr_hdr);
George Liu456c9a22020-01-13 11:36:22 +080053
54 pdr->terminus_handle = e.value("terminus_handle", 0);
George Liuc4ea6a92020-07-14 15:48:44 +080055
56 try
57 {
58 std::string entity_path = e.value("entity_path", "");
59 auto& associatedEntityMap = handler.getAssociateEntityMap();
Sagar Srinivas06f9b292024-03-31 11:35:28 -050060 if (entity_path != "" && associatedEntityMap.contains(entity_path))
George Liuc4ea6a92020-07-14 15:48:44 +080061 {
62 pdr->entity_type =
63 associatedEntityMap.at(entity_path).entity_type;
64 pdr->entity_instance =
65 associatedEntityMap.at(entity_path).entity_instance_num;
66 pdr->container_id =
67 associatedEntityMap.at(entity_path).entity_container_id;
68 }
69 else
70 {
71 pdr->entity_type = e.value("type", 0);
72 pdr->entity_instance = e.value("instance", 0);
73 pdr->container_id = e.value("container", 0);
Pavithra Barithaya5f213472022-08-29 02:20:19 -050074
75 // do not create the PDR when the FRU or the entity path is not
76 // present
77 if (!pdr->entity_type)
78 {
Pavithra Barithaya5f213472022-08-29 02:20:19 -050079 continue;
80 }
George Liuc4ea6a92020-07-14 15:48:44 +080081 }
82 }
Kamalkumar Patel58cbcaf2023-10-06 03:48:25 -050083 catch (const std::exception&)
George Liuc4ea6a92020-07-14 15:48:44 +080084 {
85 pdr->entity_type = e.value("type", 0);
86 pdr->entity_instance = e.value("instance", 0);
87 pdr->container_id = e.value("container", 0);
88 }
89
George Liu456c9a22020-01-13 11:36:22 +080090 pdr->effecter_semantic_id = e.value("effecter_semantic_id", 0);
91 pdr->effecter_init = e.value("effecter_init", PLDM_NO_INIT);
92 pdr->effecter_auxiliary_names = e.value("effecter_init", false);
93 pdr->base_unit = e.value("base_unit", 0);
94 pdr->unit_modifier = e.value("unit_modifier", 0);
95 pdr->rate_unit = e.value("rate_unit", 0);
96 pdr->base_oem_unit_handle = e.value("base_oem_unit_handle", 0);
97 pdr->aux_unit = e.value("aux_unit", 0);
98 pdr->aux_unit_modifier = e.value("aux_unit_modifier", 0);
99 pdr->aux_oem_unit_handle = e.value("aux_oem_unit_handle", 0);
100 pdr->aux_rate_unit = e.value("aux_rate_unit", 0);
101 pdr->is_linear = e.value("is_linear", true);
Patrick Williams6da4f912023-05-10 07:50:53 -0500102 pdr->effecter_data_size = e.value("effecter_data_size",
103 PLDM_EFFECTER_DATA_SIZE_UINT8);
George Liu456c9a22020-01-13 11:36:22 +0800104 pdr->resolution = e.value("effecter_resolution_init", 1.00);
105 pdr->offset = e.value("offset", 0.00);
106 pdr->accuracy = e.value("accuracy", 0);
107 pdr->plus_tolerance = e.value("plus_tolerance", 0);
108 pdr->minus_tolerance = e.value("minus_tolerance", 0);
Patrick Williams6da4f912023-05-10 07:50:53 -0500109 pdr->state_transition_interval = e.value("state_transition_interval",
110 0.00);
George Liu456c9a22020-01-13 11:36:22 +0800111 pdr->transition_interval = e.value("transition_interval", 0.00);
112 switch (pdr->effecter_data_size)
113 {
114 case PLDM_EFFECTER_DATA_SIZE_UINT8:
Manojkiran Edafc0ce972022-06-25 09:38:28 +0530115 pdr->max_settable.value_u8 = e.value("max_settable", 0);
116 pdr->min_settable.value_u8 = e.value("min_settable", 0);
George Liu456c9a22020-01-13 11:36:22 +0800117 break;
118 case PLDM_EFFECTER_DATA_SIZE_SINT8:
Manojkiran Edafc0ce972022-06-25 09:38:28 +0530119 pdr->max_settable.value_s8 = e.value("max_settable", 0);
120 pdr->min_settable.value_s8 = e.value("min_settable", 0);
George Liu456c9a22020-01-13 11:36:22 +0800121 break;
122 case PLDM_EFFECTER_DATA_SIZE_UINT16:
Manojkiran Edafc0ce972022-06-25 09:38:28 +0530123 pdr->max_settable.value_u16 = e.value("max_settable", 0);
124 pdr->min_settable.value_u16 = e.value("min_settable", 0);
George Liu456c9a22020-01-13 11:36:22 +0800125 break;
126 case PLDM_EFFECTER_DATA_SIZE_SINT16:
Manojkiran Edafc0ce972022-06-25 09:38:28 +0530127 pdr->max_settable.value_s16 = e.value("max_settable", 0);
128 pdr->min_settable.value_s16 = e.value("min_settable", 0);
George Liu456c9a22020-01-13 11:36:22 +0800129 break;
130 case PLDM_EFFECTER_DATA_SIZE_UINT32:
Manojkiran Edafc0ce972022-06-25 09:38:28 +0530131 pdr->max_settable.value_u32 = e.value("max_settable", 0);
132 pdr->min_settable.value_u32 = e.value("min_settable", 0);
George Liu456c9a22020-01-13 11:36:22 +0800133 break;
134 case PLDM_EFFECTER_DATA_SIZE_SINT32:
Manojkiran Edafc0ce972022-06-25 09:38:28 +0530135 pdr->max_settable.value_s32 = e.value("max_settable", 0);
136 pdr->min_settable.value_s32 = e.value("min_settable", 0);
George Liu456c9a22020-01-13 11:36:22 +0800137 break;
138 default:
139 break;
140 }
141
Patrick Williams6da4f912023-05-10 07:50:53 -0500142 pdr->range_field_format = e.value("range_field_format",
143 PLDM_RANGE_FIELD_FORMAT_UINT8);
George Liu456c9a22020-01-13 11:36:22 +0800144 pdr->range_field_support.byte = e.value("range_field_support", 0);
145 switch (pdr->range_field_format)
146 {
147 case PLDM_RANGE_FIELD_FORMAT_UINT8:
148 pdr->nominal_value.value_u8 = e.value("nominal_value", 0);
149 pdr->normal_max.value_u8 = e.value("normal_max", 0);
150 pdr->normal_min.value_u8 = e.value("normal_min", 0);
151 pdr->rated_max.value_u8 = e.value("rated_max", 0);
152 pdr->rated_min.value_u8 = e.value("rated_min", 0);
153 break;
154 case PLDM_RANGE_FIELD_FORMAT_SINT8:
155 pdr->nominal_value.value_s8 = e.value("nominal_value", 0);
156 pdr->normal_max.value_s8 = e.value("normal_max", 0);
157 pdr->normal_min.value_s8 = e.value("normal_min", 0);
158 pdr->rated_max.value_s8 = e.value("rated_max", 0);
159 pdr->rated_min.value_s8 = e.value("rated_min", 0);
160 break;
161 case PLDM_RANGE_FIELD_FORMAT_UINT16:
162 pdr->nominal_value.value_u16 = e.value("nominal_value", 0);
163 pdr->normal_max.value_u16 = e.value("normal_max", 0);
164 pdr->normal_min.value_u16 = e.value("normal_min", 0);
165 pdr->rated_max.value_u16 = e.value("rated_max", 0);
166 pdr->rated_min.value_u16 = e.value("rated_min", 0);
167 break;
168 case PLDM_RANGE_FIELD_FORMAT_SINT16:
169 pdr->nominal_value.value_s16 = e.value("nominal_value", 0);
170 pdr->normal_max.value_s16 = e.value("normal_max", 0);
171 pdr->normal_min.value_s16 = e.value("normal_min", 0);
172 pdr->rated_max.value_s16 = e.value("rated_max", 0);
173 pdr->rated_min.value_s16 = e.value("rated_min", 0);
174 break;
175 case PLDM_RANGE_FIELD_FORMAT_UINT32:
176 pdr->nominal_value.value_u32 = e.value("nominal_value", 0);
177 pdr->normal_max.value_u32 = e.value("normal_max", 0);
178 pdr->normal_min.value_u32 = e.value("normal_min", 0);
179 pdr->rated_max.value_u32 = e.value("rated_max", 0);
180 pdr->rated_min.value_u32 = e.value("rated_min", 0);
181 break;
182 case PLDM_RANGE_FIELD_FORMAT_SINT32:
183 pdr->nominal_value.value_s32 = e.value("nominal_value", 0);
184 pdr->normal_max.value_s32 = e.value("normal_max", 0);
185 pdr->normal_min.value_s32 = e.value("normal_min", 0);
186 pdr->rated_max.value_s32 = e.value("rated_max", 0);
187 pdr->rated_min.value_s32 = e.value("rated_min", 0);
188 break;
189 case PLDM_RANGE_FIELD_FORMAT_REAL32:
190 pdr->nominal_value.value_f32 = e.value("nominal_value", 0);
191 pdr->normal_max.value_f32 = e.value("normal_max", 0);
192 pdr->normal_min.value_f32 = e.value("normal_min", 0);
193 pdr->rated_max.value_f32 = e.value("rated_max", 0);
194 pdr->rated_min.value_f32 = e.value("rated_min", 0);
195 break;
196 default:
197 break;
198 }
199
200 auto dbusEntry = e.value("dbus", empty);
201 auto objectPath = dbusEntry.value("path", "");
202 auto interface = dbusEntry.value("interface", "");
203 auto propertyName = dbusEntry.value("property_name", "");
204 auto propertyType = dbusEntry.value("property_type", "");
George Liu36e81352020-07-01 14:40:30 +0800205
Brad Bishop5079ac42021-08-19 18:35:06 -0400206 pldm::responder::pdr_utils::DbusMappings dbusMappings{};
207 pldm::responder::pdr_utils::DbusValMaps dbusValMaps{};
George Liu821ebc42021-01-26 14:36:11 +0800208 pldm::utils::DBusMapping dbusMapping{};
George Liu36e81352020-07-01 14:40:30 +0800209 try
210 {
Patrick Williams6da4f912023-05-10 07:50:53 -0500211 auto service = dBusIntf.getService(objectPath.c_str(),
212 interface.c_str());
George Liu821ebc42021-01-26 14:36:11 +0800213
214 dbusMapping = pldm::utils::DBusMapping{objectPath, interface,
215 propertyName, propertyType};
George Liu36e81352020-07-01 14:40:30 +0800216 }
217 catch (const std::exception& e)
218 {
Riya Dixit49cfb132023-03-02 04:26:53 -0600219 error(
Riya Dixit89644442024-03-31 05:39:59 -0500220 "D-Bus object path does not exist for effecter ID '{EFFECTER_ID}', error - {ERROR}",
221 "EFFECTER_ID", static_cast<uint16_t>(pdr->effecter_id), "ERROR",
222 e);
George Liu36e81352020-07-01 14:40:30 +0800223 }
George Liu456c9a22020-01-13 11:36:22 +0800224 dbusMappings.emplace_back(std::move(dbusMapping));
Manojkiran Eda3daf7a12024-04-17 20:33:44 +0530225 pdr->effecter_id = handler.getNextEffecterId();
George Liu456c9a22020-01-13 11:36:22 +0800226 handler.addDbusObjMaps(
227 pdr->effecter_id,
228 std::make_tuple(std::move(dbusMappings), std::move(dbusValMaps)));
229
230 pdr_utils::PdrEntry pdrEntry{};
231 pdrEntry.data = entry.data();
232 pdrEntry.size = sizeof(pldm_numeric_effecter_value_pdr);
233 repo.addRecord(pdrEntry);
234 }
235}
236
237} // namespace pdr_numeric_effecter
238} // namespace responder
239} // namespace pldm