blob: 58236da2ecc0264a012c655fa770ae8089c0a90f [file] [log] [blame]
George Liuadbe1722020-05-09 19:20:19 +08001#pragma once
2
George Liuadbe1722020-05-09 19:20:19 +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 Liuadbe1722020-05-09 19:20:19 +080011namespace pldm
12{
George Liuadbe1722020-05-09 19:20:19 +080013namespace responder
14{
George Liuadbe1722020-05-09 19:20:19 +080015namespace pdr_state_sensor
16{
George Liuadbe1722020-05-09 19:20:19 +080017using Json = nlohmann::json;
18
19static const Json empty{};
20
21/** @brief Parse PDR JSON file and generate state sensor PDR structure
22 *
23 * @param[in] json - the JSON Object with the state sensor PDR
24 * @param[out] handler - the Parser of PLDM command handler
25 * @param[out] repo - pdr::RepoInterface
26 *
27 */
28template <class DBusInterface, class Handler>
29void generateStateSensorPDR(const DBusInterface& dBusIntf, const Json& json,
30 Handler& handler, pdr_utils::RepoInterface& repo)
31{
32 static const std::vector<Json> emptyList{};
33 auto entries = json.value("entries", emptyList);
34 for (const auto& e : entries)
35 {
36 size_t pdrSize = 0;
37 auto sensors = e.value("sensors", emptyList);
38 for (const auto& sensor : sensors)
39 {
40 auto set = sensor.value("set", empty);
41 auto statesSize = set.value("size", 0);
42 if (!statesSize)
43 {
Riya Dixit49cfb132023-03-02 04:26:53 -060044 error(
Riya Dixit89644442024-03-31 05:39:59 -050045 "Malformed PDR JSON return pdrEntry; no state set info for state sensor pdr '{STATE_SENSOR_PDR}'",
Riya Dixit1e5c81e2024-05-03 07:54:00 -050046 "STATE_SENSOR_PDR", PLDM_STATE_SENSOR_PDR);
George Liuadbe1722020-05-09 19:20:19 +080047 throw InternalFailure();
48 }
49 pdrSize += sizeof(state_sensor_possible_states) -
50 sizeof(bitfield8_t) + (sizeof(bitfield8_t) * statesSize);
51 }
52 pdrSize += sizeof(pldm_state_sensor_pdr) - sizeof(uint8_t);
53
54 std::vector<uint8_t> entry{};
55 entry.resize(pdrSize);
56
57 pldm_state_sensor_pdr* pdr =
58 reinterpret_cast<pldm_state_sensor_pdr*>(entry.data());
Manojkiran Edabcf91ac2021-03-14 13:50:48 +053059 if (!pdr)
60 {
Riya Dixit49cfb132023-03-02 04:26:53 -060061 error("Failed to get state sensor PDR.");
Manojkiran Edabcf91ac2021-03-14 13:50:48 +053062 continue;
63 }
George Liuadbe1722020-05-09 19:20:19 +080064 pdr->hdr.record_handle = 0;
65 pdr->hdr.version = 1;
66 pdr->hdr.type = PLDM_STATE_SENSOR_PDR;
67 pdr->hdr.record_change_num = 0;
68 pdr->hdr.length = pdrSize - sizeof(pldm_pdr_hdr);
69
70 HTOLE32(pdr->hdr.record_handle);
71 HTOLE16(pdr->hdr.record_change_num);
72 HTOLE16(pdr->hdr.length);
73
Manojkiran Edacc5f1582021-09-29 17:03:06 +053074 pdr->terminus_handle = TERMINUS_HANDLE;
George Liuc4ea6a92020-07-14 15:48:44 +080075
76 try
77 {
78 std::string entity_path = e.value("entity_path", "");
79 auto& associatedEntityMap = handler.getAssociateEntityMap();
Sagar Srinivas06f9b292024-03-31 11:35:28 -050080 if (entity_path != "" && associatedEntityMap.contains(entity_path))
George Liuc4ea6a92020-07-14 15:48:44 +080081 {
82 pdr->entity_type =
83 associatedEntityMap.at(entity_path).entity_type;
84 pdr->entity_instance =
85 associatedEntityMap.at(entity_path).entity_instance_num;
86 pdr->container_id =
87 associatedEntityMap.at(entity_path).entity_container_id;
88 }
89 else
90 {
91 pdr->entity_type = e.value("type", 0);
92 pdr->entity_instance = e.value("instance", 0);
93 pdr->container_id = e.value("container", 0);
Pavithra Barithaya5f213472022-08-29 02:20:19 -050094
95 // do not create the PDR when the FRU or the entity path is not
96 // present
97 if (!pdr->entity_type)
98 {
Pavithra Barithaya5f213472022-08-29 02:20:19 -050099 continue;
100 }
George Liuc4ea6a92020-07-14 15:48:44 +0800101 }
102 }
Kamalkumar Patel58cbcaf2023-10-06 03:48:25 -0500103 catch (const std::exception&)
George Liuc4ea6a92020-07-14 15:48:44 +0800104 {
105 pdr->entity_type = e.value("type", 0);
106 pdr->entity_instance = e.value("instance", 0);
107 pdr->container_id = e.value("container", 0);
108 }
109
George Liuadbe1722020-05-09 19:20:19 +0800110 pdr->sensor_init = PLDM_NO_INIT;
111 pdr->sensor_auxiliary_names_pdr = false;
112 if (sensors.size() > 8)
113 {
114 throw std::runtime_error("sensor size must be less than 8");
115 }
116 pdr->composite_sensor_count = sensors.size();
117
118 HTOLE16(pdr->terminus_handle);
George Liuadbe1722020-05-09 19:20:19 +0800119 HTOLE16(pdr->entity_type);
120 HTOLE16(pdr->entity_instance);
121 HTOLE16(pdr->container_id);
122
Brad Bishop5079ac42021-08-19 18:35:06 -0400123 pldm::responder::pdr_utils::DbusMappings dbusMappings{};
124 pldm::responder::pdr_utils::DbusValMaps dbusValMaps{};
Patrick Williams6da4f912023-05-10 07:50:53 -0500125 uint8_t* start = entry.data() + sizeof(pldm_state_sensor_pdr) -
126 sizeof(uint8_t);
George Liuadbe1722020-05-09 19:20:19 +0800127 for (const auto& sensor : sensors)
128 {
129 auto set = sensor.value("set", empty);
130 state_sensor_possible_states* possibleStates =
131 reinterpret_cast<state_sensor_possible_states*>(start);
132 possibleStates->state_set_id = set.value("id", 0);
133 HTOLE16(possibleStates->state_set_id);
134 possibleStates->possible_states_size = set.value("size", 0);
135
136 start += sizeof(possibleStates->state_set_id) +
137 sizeof(possibleStates->possible_states_size);
138 static const std::vector<uint8_t> emptyStates{};
Brad Bishop5079ac42021-08-19 18:35:06 -0400139 pldm::responder::pdr_utils::PossibleValues stateValues;
George Liuadbe1722020-05-09 19:20:19 +0800140 auto states = set.value("states", emptyStates);
141 for (const auto& state : states)
142 {
143 auto index = state / 8;
144 auto bit = state - (index * 8);
145 bitfield8_t* bf = reinterpret_cast<bitfield8_t*>(start + index);
146 bf->byte |= 1 << bit;
147 stateValues.emplace_back(state);
148 }
149 start += possibleStates->possible_states_size;
150 auto dbusEntry = sensor.value("dbus", empty);
151 auto objectPath = dbusEntry.value("path", "");
152 auto interface = dbusEntry.value("interface", "");
153 auto propertyName = dbusEntry.value("property_name", "");
154 auto propertyType = dbusEntry.value("property_type", "");
155
Brad Bishop5079ac42021-08-19 18:35:06 -0400156 pldm::responder::pdr_utils::StatestoDbusVal dbusIdToValMap{};
George Liu821ebc42021-01-26 14:36:11 +0800157 pldm::utils::DBusMapping dbusMapping{};
George Liuadbe1722020-05-09 19:20:19 +0800158 try
159 {
Patrick Williams6da4f912023-05-10 07:50:53 -0500160 auto service = dBusIntf.getService(objectPath.c_str(),
161 interface.c_str());
George Liu821ebc42021-01-26 14:36:11 +0800162
163 dbusMapping = pldm::utils::DBusMapping{
164 objectPath, interface, propertyName, propertyType};
Brad Bishop5079ac42021-08-19 18:35:06 -0400165 dbusIdToValMap = pldm::responder::pdr_utils::populateMapping(
George Liu821ebc42021-01-26 14:36:11 +0800166 propertyType, dbusEntry["property_values"], stateValues);
George Liuadbe1722020-05-09 19:20:19 +0800167 }
168 catch (const std::exception& e)
169 {
Riya Dixit49cfb132023-03-02 04:26:53 -0600170 error(
Riya Dixit89644442024-03-31 05:39:59 -0500171 "Failed to create sensor PDR, D-Bus object '{PATH}' returned error - {ERROR}",
Manojkiran Eda819bb6f2024-02-21 11:28:03 +0530172 "PATH", objectPath, "ERROR", e);
Manojkiran Eda3daf7a12024-04-17 20:33:44 +0530173 break;
George Liuadbe1722020-05-09 19:20:19 +0800174 }
George Liuadbe1722020-05-09 19:20:19 +0800175 dbusMappings.emplace_back(std::move(dbusMapping));
George Liu821ebc42021-01-26 14:36:11 +0800176 dbusValMaps.emplace_back(std::move(dbusIdToValMap));
George Liuadbe1722020-05-09 19:20:19 +0800177 }
178
Manojkiran Eda3daf7a12024-04-17 20:33:44 +0530179 if (!(dbusMappings.empty() && dbusValMaps.empty()))
180 {
181 pdr->sensor_id = handler.getNextSensorId();
182 HTOLE16(pdr->sensor_id);
183 handler.addDbusObjMaps(
184 pdr->sensor_id,
185 std::make_tuple(std::move(dbusMappings),
186 std::move(dbusValMaps)),
187 pldm::responder::pdr_utils::TypeId::PLDM_SENSOR_ID);
188 pldm::responder::pdr_utils::PdrEntry pdrEntry{};
189 pdrEntry.data = entry.data();
190 pdrEntry.size = pdrSize;
191 repo.addRecord(pdrEntry);
192 }
George Liuadbe1722020-05-09 19:20:19 +0800193 }
194}
195
196} // namespace pdr_state_sensor
197} // namespace responder
198} // namespace pldm