xref: /openbmc/bmcweb/features/redfish/lib/sensors.hpp (revision b2ba30728fc644b206af43b3f807098b5fa470b6)
108777fb0SLewanczyk, Dawid /*
208777fb0SLewanczyk, Dawid // Copyright (c) 2018 Intel Corporation
308777fb0SLewanczyk, Dawid //
408777fb0SLewanczyk, Dawid // Licensed under the Apache License, Version 2.0 (the "License");
508777fb0SLewanczyk, Dawid // you may not use this file except in compliance with the License.
608777fb0SLewanczyk, Dawid // You may obtain a copy of the License at
708777fb0SLewanczyk, Dawid //
808777fb0SLewanczyk, Dawid //      http://www.apache.org/licenses/LICENSE-2.0
908777fb0SLewanczyk, Dawid //
1008777fb0SLewanczyk, Dawid // Unless required by applicable law or agreed to in writing, software
1108777fb0SLewanczyk, Dawid // distributed under the License is distributed on an "AS IS" BASIS,
1208777fb0SLewanczyk, Dawid // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1308777fb0SLewanczyk, Dawid // See the License for the specific language governing permissions and
1408777fb0SLewanczyk, Dawid // limitations under the License.
1508777fb0SLewanczyk, Dawid */
1608777fb0SLewanczyk, Dawid #pragma once
1708777fb0SLewanczyk, Dawid 
183ccb3adbSEd Tanous #include "app.hpp"
193ccb3adbSEd Tanous #include "dbus_singleton.hpp"
207a1dbc48SGeorge Liu #include "dbus_utility.hpp"
210ec8b83dSEd Tanous #include "generated/enums/sensor.hpp"
223ccb3adbSEd Tanous #include "query.hpp"
233ccb3adbSEd Tanous #include "registries/privilege_registry.hpp"
2450ebd4afSEd Tanous #include "str_utility.hpp"
253ccb3adbSEd Tanous #include "utils/dbus_utils.hpp"
263ccb3adbSEd Tanous #include "utils/json_utils.hpp"
273ccb3adbSEd Tanous #include "utils/query_param.hpp"
280ec8b83dSEd Tanous 
2911ba3979SEd Tanous #include <boost/algorithm/string/classification.hpp>
301d7c0054SEd Tanous #include <boost/algorithm/string/find.hpp>
311d7c0054SEd Tanous #include <boost/algorithm/string/predicate.hpp>
32c71d6125SEd Tanous #include <boost/algorithm/string/replace.hpp>
3308777fb0SLewanczyk, Dawid #include <boost/range/algorithm/replace_copy_if.hpp>
34e99073f5SGeorge Liu #include <boost/system/error_code.hpp>
351e1e598dSJonathan Doman #include <sdbusplus/asio/property.hpp>
3686d89ed7SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp>
371214b7e7SGunnar Mills 
387a1dbc48SGeorge Liu #include <array>
391214b7e7SGunnar Mills #include <cmath>
40fe04d49cSNan Zhou #include <iterator>
41fe04d49cSNan Zhou #include <map>
42fe04d49cSNan Zhou #include <set>
437a1dbc48SGeorge Liu #include <string_view>
44b5a76932SEd Tanous #include <utility>
45abf2add6SEd Tanous #include <variant>
4608777fb0SLewanczyk, Dawid 
471abe55efSEd Tanous namespace redfish
481abe55efSEd Tanous {
4908777fb0SLewanczyk, Dawid 
50a0ec28b6SAdrian Ambrożewicz namespace sensors
51a0ec28b6SAdrian Ambrożewicz {
52a0ec28b6SAdrian Ambrożewicz namespace node
53a0ec28b6SAdrian Ambrożewicz {
54a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view power = "Power";
55a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view sensors = "Sensors";
56a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view thermal = "Thermal";
57a0ec28b6SAdrian Ambrożewicz } // namespace node
58a0ec28b6SAdrian Ambrożewicz 
5902da7c5aSEd Tanous // clang-format off
60a0ec28b6SAdrian Ambrożewicz namespace dbus
61a0ec28b6SAdrian Ambrożewicz {
62cf9e417dSEd Tanous constexpr auto powerPaths = std::to_array<std::string_view>({
6302da7c5aSEd Tanous     "/xyz/openbmc_project/sensors/voltage",
6402da7c5aSEd Tanous     "/xyz/openbmc_project/sensors/power"
6502da7c5aSEd Tanous });
66c2bf7f99SWludzik, Jozef 
67cf9e417dSEd Tanous constexpr auto sensorPaths = std::to_array<std::string_view>({
6802da7c5aSEd Tanous     "/xyz/openbmc_project/sensors/power",
69a0ec28b6SAdrian Ambrożewicz     "/xyz/openbmc_project/sensors/current",
707088690cSBasheer Ahmed Muddebihal     "/xyz/openbmc_project/sensors/airflow",
715deabed9SGunnar Mills     "/xyz/openbmc_project/sensors/humidity",
72e8204933SGeorge Liu #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
73e8204933SGeorge Liu     "/xyz/openbmc_project/sensors/voltage",
74e8204933SGeorge Liu     "/xyz/openbmc_project/sensors/fan_tach",
75e8204933SGeorge Liu     "/xyz/openbmc_project/sensors/temperature",
76e8204933SGeorge Liu     "/xyz/openbmc_project/sensors/fan_pwm",
77e8204933SGeorge Liu     "/xyz/openbmc_project/sensors/altitude",
78e8204933SGeorge Liu     "/xyz/openbmc_project/sensors/energy",
79e8204933SGeorge Liu #endif
8002da7c5aSEd Tanous     "/xyz/openbmc_project/sensors/utilization"
8102da7c5aSEd Tanous });
8202da7c5aSEd Tanous 
83cf9e417dSEd Tanous constexpr auto thermalPaths = std::to_array<std::string_view>({
8402da7c5aSEd Tanous     "/xyz/openbmc_project/sensors/fan_tach",
85a0ec28b6SAdrian Ambrożewicz     "/xyz/openbmc_project/sensors/temperature",
8602da7c5aSEd Tanous     "/xyz/openbmc_project/sensors/fan_pwm"
8702da7c5aSEd Tanous });
8802da7c5aSEd Tanous 
89c2bf7f99SWludzik, Jozef } // namespace dbus
9002da7c5aSEd Tanous // clang-format on
9102da7c5aSEd Tanous 
92cf9e417dSEd Tanous using sensorPair =
93cf9e417dSEd Tanous     std::pair<std::string_view, std::span<const std::string_view>>;
9402da7c5aSEd Tanous static constexpr std::array<sensorPair, 3> paths = {
95cf9e417dSEd Tanous     {{node::power, dbus::powerPaths},
96cf9e417dSEd Tanous      {node::sensors, dbus::sensorPaths},
97cf9e417dSEd Tanous      {node::thermal, dbus::thermalPaths}}};
98c2bf7f99SWludzik, Jozef 
990ec8b83dSEd Tanous inline sensor::ReadingType toReadingType(std::string_view sensorType)
100c2bf7f99SWludzik, Jozef {
101c2bf7f99SWludzik, Jozef     if (sensorType == "voltage")
102c2bf7f99SWludzik, Jozef     {
1030ec8b83dSEd Tanous         return sensor::ReadingType::Voltage;
104c2bf7f99SWludzik, Jozef     }
105c2bf7f99SWludzik, Jozef     if (sensorType == "power")
106c2bf7f99SWludzik, Jozef     {
1070ec8b83dSEd Tanous         return sensor::ReadingType::Power;
108c2bf7f99SWludzik, Jozef     }
109c2bf7f99SWludzik, Jozef     if (sensorType == "current")
110c2bf7f99SWludzik, Jozef     {
1110ec8b83dSEd Tanous         return sensor::ReadingType::Current;
112c2bf7f99SWludzik, Jozef     }
113c2bf7f99SWludzik, Jozef     if (sensorType == "fan_tach")
114c2bf7f99SWludzik, Jozef     {
1150ec8b83dSEd Tanous         return sensor::ReadingType::Rotational;
116c2bf7f99SWludzik, Jozef     }
117c2bf7f99SWludzik, Jozef     if (sensorType == "temperature")
118c2bf7f99SWludzik, Jozef     {
1190ec8b83dSEd Tanous         return sensor::ReadingType::Temperature;
120c2bf7f99SWludzik, Jozef     }
121c2bf7f99SWludzik, Jozef     if (sensorType == "fan_pwm" || sensorType == "utilization")
122c2bf7f99SWludzik, Jozef     {
1230ec8b83dSEd Tanous         return sensor::ReadingType::Percent;
124c2bf7f99SWludzik, Jozef     }
1255deabed9SGunnar Mills     if (sensorType == "humidity")
1265deabed9SGunnar Mills     {
1270ec8b83dSEd Tanous         return sensor::ReadingType::Humidity;
1285deabed9SGunnar Mills     }
129c2bf7f99SWludzik, Jozef     if (sensorType == "altitude")
130c2bf7f99SWludzik, Jozef     {
1310ec8b83dSEd Tanous         return sensor::ReadingType::Altitude;
132c2bf7f99SWludzik, Jozef     }
133c2bf7f99SWludzik, Jozef     if (sensorType == "airflow")
134c2bf7f99SWludzik, Jozef     {
1350ec8b83dSEd Tanous         return sensor::ReadingType::AirFlow;
136c2bf7f99SWludzik, Jozef     }
137c2bf7f99SWludzik, Jozef     if (sensorType == "energy")
138c2bf7f99SWludzik, Jozef     {
1390ec8b83dSEd Tanous         return sensor::ReadingType::EnergyJoules;
140c2bf7f99SWludzik, Jozef     }
1410ec8b83dSEd Tanous     return sensor::ReadingType::Invalid;
142c2bf7f99SWludzik, Jozef }
143c2bf7f99SWludzik, Jozef 
1441d7c0054SEd Tanous inline std::string_view toReadingUnits(std::string_view sensorType)
145c2bf7f99SWludzik, Jozef {
146c2bf7f99SWludzik, Jozef     if (sensorType == "voltage")
147c2bf7f99SWludzik, Jozef     {
148c2bf7f99SWludzik, Jozef         return "V";
149c2bf7f99SWludzik, Jozef     }
150c2bf7f99SWludzik, Jozef     if (sensorType == "power")
151c2bf7f99SWludzik, Jozef     {
152c2bf7f99SWludzik, Jozef         return "W";
153c2bf7f99SWludzik, Jozef     }
154c2bf7f99SWludzik, Jozef     if (sensorType == "current")
155c2bf7f99SWludzik, Jozef     {
156c2bf7f99SWludzik, Jozef         return "A";
157c2bf7f99SWludzik, Jozef     }
158c2bf7f99SWludzik, Jozef     if (sensorType == "fan_tach")
159c2bf7f99SWludzik, Jozef     {
160c2bf7f99SWludzik, Jozef         return "RPM";
161c2bf7f99SWludzik, Jozef     }
162c2bf7f99SWludzik, Jozef     if (sensorType == "temperature")
163c2bf7f99SWludzik, Jozef     {
164c2bf7f99SWludzik, Jozef         return "Cel";
165c2bf7f99SWludzik, Jozef     }
1665deabed9SGunnar Mills     if (sensorType == "fan_pwm" || sensorType == "utilization" ||
1675deabed9SGunnar Mills         sensorType == "humidity")
168c2bf7f99SWludzik, Jozef     {
169c2bf7f99SWludzik, Jozef         return "%";
170c2bf7f99SWludzik, Jozef     }
171c2bf7f99SWludzik, Jozef     if (sensorType == "altitude")
172c2bf7f99SWludzik, Jozef     {
173c2bf7f99SWludzik, Jozef         return "m";
174c2bf7f99SWludzik, Jozef     }
175c2bf7f99SWludzik, Jozef     if (sensorType == "airflow")
176c2bf7f99SWludzik, Jozef     {
177c2bf7f99SWludzik, Jozef         return "cft_i/min";
178c2bf7f99SWludzik, Jozef     }
179c2bf7f99SWludzik, Jozef     if (sensorType == "energy")
180c2bf7f99SWludzik, Jozef     {
181c2bf7f99SWludzik, Jozef         return "J";
182c2bf7f99SWludzik, Jozef     }
183c2bf7f99SWludzik, Jozef     return "";
184a0ec28b6SAdrian Ambrożewicz }
185a0ec28b6SAdrian Ambrożewicz } // namespace sensors
186a0ec28b6SAdrian Ambrożewicz 
18708777fb0SLewanczyk, Dawid /**
188588c3f0dSKowalski, Kamil  * SensorsAsyncResp
18908777fb0SLewanczyk, Dawid  * Gathers data needed for response processing after async calls are done
19008777fb0SLewanczyk, Dawid  */
1911abe55efSEd Tanous class SensorsAsyncResp
1921abe55efSEd Tanous {
19308777fb0SLewanczyk, Dawid   public:
194a0ec28b6SAdrian Ambrożewicz     using DataCompleteCb = std::function<void(
195a0ec28b6SAdrian Ambrożewicz         const boost::beast::http::status status,
196fe04d49cSNan Zhou         const std::map<std::string, std::string>& uriToDbus)>;
197a0ec28b6SAdrian Ambrożewicz 
198a0ec28b6SAdrian Ambrożewicz     struct SensorData
199a0ec28b6SAdrian Ambrożewicz     {
200a0ec28b6SAdrian Ambrożewicz         const std::string name;
201a0ec28b6SAdrian Ambrożewicz         std::string uri;
202a0ec28b6SAdrian Ambrożewicz         const std::string dbusPath;
203a0ec28b6SAdrian Ambrożewicz     };
204a0ec28b6SAdrian Ambrożewicz 
2058a592810SEd Tanous     SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
2068d1b46d7Szhanghch05                      const std::string& chassisIdIn,
207cf9e417dSEd Tanous                      std::span<const std::string_view> typesIn,
20802da7c5aSEd Tanous                      std::string_view subNode) :
2098a592810SEd Tanous         asyncResp(asyncRespIn),
210928fefb9SNan Zhou         chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
211928fefb9SNan Zhou         efficientExpand(false)
2121214b7e7SGunnar Mills     {}
21308777fb0SLewanczyk, Dawid 
214a0ec28b6SAdrian Ambrożewicz     // Store extra data about sensor mapping and return it in callback
2158a592810SEd Tanous     SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
2168d1b46d7Szhanghch05                      const std::string& chassisIdIn,
217cf9e417dSEd Tanous                      std::span<const std::string_view> typesIn,
21802da7c5aSEd Tanous                      std::string_view subNode,
219a0ec28b6SAdrian Ambrożewicz                      DataCompleteCb&& creationComplete) :
2208a592810SEd Tanous         asyncResp(asyncRespIn),
221928fefb9SNan Zhou         chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
222928fefb9SNan Zhou         efficientExpand(false), metadata{std::vector<SensorData>()},
223a0ec28b6SAdrian Ambrożewicz         dataComplete{std::move(creationComplete)}
224a0ec28b6SAdrian Ambrożewicz     {}
225a0ec28b6SAdrian Ambrożewicz 
226928fefb9SNan Zhou     // sensor collections expand
2278a592810SEd Tanous     SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
228928fefb9SNan Zhou                      const std::string& chassisIdIn,
229cf9e417dSEd Tanous                      std::span<const std::string_view> typesIn,
2308a592810SEd Tanous                      const std::string_view& subNode, bool efficientExpandIn) :
2318a592810SEd Tanous         asyncResp(asyncRespIn),
232928fefb9SNan Zhou         chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
2338a592810SEd Tanous         efficientExpand(efficientExpandIn)
234928fefb9SNan Zhou     {}
235928fefb9SNan Zhou 
2361abe55efSEd Tanous     ~SensorsAsyncResp()
2371abe55efSEd Tanous     {
2388d1b46d7Szhanghch05         if (asyncResp->res.result() ==
2398d1b46d7Szhanghch05             boost::beast::http::status::internal_server_error)
2401abe55efSEd Tanous         {
2411abe55efSEd Tanous             // Reset the json object to clear out any data that made it in
2421abe55efSEd Tanous             // before the error happened todo(ed) handle error condition with
2431abe55efSEd Tanous             // proper code
2448d1b46d7Szhanghch05             asyncResp->res.jsonValue = nlohmann::json::object();
24508777fb0SLewanczyk, Dawid         }
246a0ec28b6SAdrian Ambrożewicz 
247a0ec28b6SAdrian Ambrożewicz         if (dataComplete && metadata)
248a0ec28b6SAdrian Ambrożewicz         {
249fe04d49cSNan Zhou             std::map<std::string, std::string> map;
2508d1b46d7Szhanghch05             if (asyncResp->res.result() == boost::beast::http::status::ok)
251a0ec28b6SAdrian Ambrożewicz             {
252a0ec28b6SAdrian Ambrożewicz                 for (auto& sensor : *metadata)
253a0ec28b6SAdrian Ambrożewicz                 {
254c1d019a6SEd Tanous                     map.emplace(sensor.uri, sensor.dbusPath);
255a0ec28b6SAdrian Ambrożewicz                 }
256a0ec28b6SAdrian Ambrożewicz             }
2578d1b46d7Szhanghch05             dataComplete(asyncResp->res.result(), map);
258a0ec28b6SAdrian Ambrożewicz         }
25908777fb0SLewanczyk, Dawid     }
260588c3f0dSKowalski, Kamil 
261ecd6a3a2SEd Tanous     SensorsAsyncResp(const SensorsAsyncResp&) = delete;
262ecd6a3a2SEd Tanous     SensorsAsyncResp(SensorsAsyncResp&&) = delete;
263ecd6a3a2SEd Tanous     SensorsAsyncResp& operator=(const SensorsAsyncResp&) = delete;
264ecd6a3a2SEd Tanous     SensorsAsyncResp& operator=(SensorsAsyncResp&&) = delete;
265ecd6a3a2SEd Tanous 
266a0ec28b6SAdrian Ambrożewicz     void addMetadata(const nlohmann::json& sensorObject,
267c1d019a6SEd Tanous                      const std::string& dbusPath)
268a0ec28b6SAdrian Ambrożewicz     {
269a0ec28b6SAdrian Ambrożewicz         if (metadata)
270a0ec28b6SAdrian Ambrożewicz         {
271c1d019a6SEd Tanous             metadata->emplace_back(SensorData{
272c1d019a6SEd Tanous                 sensorObject["Name"], sensorObject["@odata.id"], dbusPath});
273a0ec28b6SAdrian Ambrożewicz         }
274a0ec28b6SAdrian Ambrożewicz     }
275a0ec28b6SAdrian Ambrożewicz 
276a0ec28b6SAdrian Ambrożewicz     void updateUri(const std::string& name, const std::string& uri)
277a0ec28b6SAdrian Ambrożewicz     {
278a0ec28b6SAdrian Ambrożewicz         if (metadata)
279a0ec28b6SAdrian Ambrożewicz         {
280a0ec28b6SAdrian Ambrożewicz             for (auto& sensor : *metadata)
281a0ec28b6SAdrian Ambrożewicz             {
282a0ec28b6SAdrian Ambrożewicz                 if (sensor.name == name)
283a0ec28b6SAdrian Ambrożewicz                 {
284a0ec28b6SAdrian Ambrożewicz                     sensor.uri = uri;
285a0ec28b6SAdrian Ambrożewicz                 }
286a0ec28b6SAdrian Ambrożewicz             }
287a0ec28b6SAdrian Ambrożewicz         }
288a0ec28b6SAdrian Ambrożewicz     }
289a0ec28b6SAdrian Ambrożewicz 
2908d1b46d7Szhanghch05     const std::shared_ptr<bmcweb::AsyncResp> asyncResp;
291a0ec28b6SAdrian Ambrożewicz     const std::string chassisId;
292cf9e417dSEd Tanous     const std::span<const std::string_view> types;
293a0ec28b6SAdrian Ambrożewicz     const std::string chassisSubNode;
294928fefb9SNan Zhou     const bool efficientExpand;
295a0ec28b6SAdrian Ambrożewicz 
296a0ec28b6SAdrian Ambrożewicz   private:
297a0ec28b6SAdrian Ambrożewicz     std::optional<std::vector<SensorData>> metadata;
298a0ec28b6SAdrian Ambrożewicz     DataCompleteCb dataComplete;
29908777fb0SLewanczyk, Dawid };
30008777fb0SLewanczyk, Dawid 
30108777fb0SLewanczyk, Dawid /**
302d500549bSAnthony Wilson  * Possible states for physical inventory leds
303d500549bSAnthony Wilson  */
304d500549bSAnthony Wilson enum class LedState
305d500549bSAnthony Wilson {
306d500549bSAnthony Wilson     OFF,
307d500549bSAnthony Wilson     ON,
308d500549bSAnthony Wilson     BLINK,
309d500549bSAnthony Wilson     UNKNOWN
310d500549bSAnthony Wilson };
311d500549bSAnthony Wilson 
312d500549bSAnthony Wilson /**
313adc4f0dbSShawn McCarney  * D-Bus inventory item associated with one or more sensors.
314adc4f0dbSShawn McCarney  */
315adc4f0dbSShawn McCarney class InventoryItem
316adc4f0dbSShawn McCarney {
317adc4f0dbSShawn McCarney   public:
3184e23a444SEd Tanous     explicit InventoryItem(const std::string& objPath) : objectPath(objPath)
319adc4f0dbSShawn McCarney     {
320adc4f0dbSShawn McCarney         // Set inventory item name to last node of object path
32128aa8de5SGeorge Liu         sdbusplus::message::object_path path(objectPath);
32228aa8de5SGeorge Liu         name = path.filename();
32328aa8de5SGeorge Liu         if (name.empty())
324adc4f0dbSShawn McCarney         {
32528aa8de5SGeorge Liu             BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath;
326adc4f0dbSShawn McCarney         }
327adc4f0dbSShawn McCarney     }
328adc4f0dbSShawn McCarney 
329adc4f0dbSShawn McCarney     std::string objectPath;
330adc4f0dbSShawn McCarney     std::string name;
331e05aec50SEd Tanous     bool isPresent = true;
332e05aec50SEd Tanous     bool isFunctional = true;
333e05aec50SEd Tanous     bool isPowerSupply = false;
334e05aec50SEd Tanous     int powerSupplyEfficiencyPercent = -1;
335adc4f0dbSShawn McCarney     std::string manufacturer;
336adc4f0dbSShawn McCarney     std::string model;
337adc4f0dbSShawn McCarney     std::string partNumber;
338adc4f0dbSShawn McCarney     std::string serialNumber;
339adc4f0dbSShawn McCarney     std::set<std::string> sensors;
340d500549bSAnthony Wilson     std::string ledObjectPath;
341e05aec50SEd Tanous     LedState ledState = LedState::UNKNOWN;
342adc4f0dbSShawn McCarney };
343adc4f0dbSShawn McCarney 
344adc4f0dbSShawn McCarney /**
345413961deSRichard Marian Thomaiyar  * @brief Get objects with connection necessary for sensors
346588c3f0dSKowalski, Kamil  * @param SensorsAsyncResp Pointer to object holding response data
34708777fb0SLewanczyk, Dawid  * @param sensorNames Sensors retrieved from chassis
34808777fb0SLewanczyk, Dawid  * @param callback Callback for processing gathered connections
34908777fb0SLewanczyk, Dawid  */
35008777fb0SLewanczyk, Dawid template <typename Callback>
351413961deSRichard Marian Thomaiyar void getObjectsWithConnection(
35281ce609eSEd Tanous     const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
353fe04d49cSNan Zhou     const std::shared_ptr<std::set<std::string>>& sensorNames,
3541abe55efSEd Tanous     Callback&& callback)
3551abe55efSEd Tanous {
356413961deSRichard Marian Thomaiyar     BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter";
35703b5bae3SJames Feist     const std::string path = "/xyz/openbmc_project/sensors";
358e99073f5SGeorge Liu     constexpr std::array<std::string_view, 1> interfaces = {
35908777fb0SLewanczyk, Dawid         "xyz.openbmc_project.Sensor.Value"};
36008777fb0SLewanczyk, Dawid 
361e99073f5SGeorge Liu     // Make call to ObjectMapper to find all sensors objects
362e99073f5SGeorge Liu     dbus::utility::getSubTree(
363e99073f5SGeorge Liu         path, 2, interfaces,
364002d39b4SEd Tanous         [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
365e99073f5SGeorge Liu          sensorNames](const boost::system::error_code& ec,
366002d39b4SEd Tanous                       const dbus::utility::MapperGetSubTreeResponse& subtree) {
367e99073f5SGeorge Liu         // Response handler for parsing objects subtree
368413961deSRichard Marian Thomaiyar         BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter";
3691abe55efSEd Tanous         if (ec)
3701abe55efSEd Tanous         {
3718d1b46d7Szhanghch05             messages::internalError(sensorsAsyncResp->asyncResp->res);
372413961deSRichard Marian Thomaiyar             BMCWEB_LOG_ERROR
373413961deSRichard Marian Thomaiyar                 << "getObjectsWithConnection resp_handler: Dbus error " << ec;
37408777fb0SLewanczyk, Dawid             return;
37508777fb0SLewanczyk, Dawid         }
37608777fb0SLewanczyk, Dawid 
37755c7b7a2SEd Tanous         BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees";
37808777fb0SLewanczyk, Dawid 
37908777fb0SLewanczyk, Dawid         // Make unique list of connections only for requested sensor types and
38008777fb0SLewanczyk, Dawid         // found in the chassis
381fe04d49cSNan Zhou         std::set<std::string> connections;
382413961deSRichard Marian Thomaiyar         std::set<std::pair<std::string, std::string>> objectsWithConnection;
38308777fb0SLewanczyk, Dawid 
38449c53ac9SJohnathan Mantey         BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size();
38549c53ac9SJohnathan Mantey         for (const std::string& tsensor : *sensorNames)
3861abe55efSEd Tanous         {
38755c7b7a2SEd Tanous             BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor;
38808777fb0SLewanczyk, Dawid         }
38908777fb0SLewanczyk, Dawid 
39008777fb0SLewanczyk, Dawid         for (const std::pair<
39108777fb0SLewanczyk, Dawid                  std::string,
39208777fb0SLewanczyk, Dawid                  std::vector<std::pair<std::string, std::vector<std::string>>>>&
3931abe55efSEd Tanous                  object : subtree)
3941abe55efSEd Tanous         {
39549c53ac9SJohnathan Mantey             if (sensorNames->find(object.first) != sensorNames->end())
3961abe55efSEd Tanous             {
39749c53ac9SJohnathan Mantey                 for (const std::pair<std::string, std::vector<std::string>>&
3981abe55efSEd Tanous                          objData : object.second)
3991abe55efSEd Tanous                 {
40049c53ac9SJohnathan Mantey                     BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first;
40108777fb0SLewanczyk, Dawid                     connections.insert(objData.first);
402de629b6eSShawn McCarney                     objectsWithConnection.insert(
403de629b6eSShawn McCarney                         std::make_pair(object.first, objData.first));
40408777fb0SLewanczyk, Dawid                 }
40508777fb0SLewanczyk, Dawid             }
40608777fb0SLewanczyk, Dawid         }
40755c7b7a2SEd Tanous         BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections";
408413961deSRichard Marian Thomaiyar         callback(std::move(connections), std::move(objectsWithConnection));
409413961deSRichard Marian Thomaiyar         BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit";
410e99073f5SGeorge Liu         });
411413961deSRichard Marian Thomaiyar     BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit";
412413961deSRichard Marian Thomaiyar }
413413961deSRichard Marian Thomaiyar 
414413961deSRichard Marian Thomaiyar /**
415413961deSRichard Marian Thomaiyar  * @brief Create connections necessary for sensors
416413961deSRichard Marian Thomaiyar  * @param SensorsAsyncResp Pointer to object holding response data
417413961deSRichard Marian Thomaiyar  * @param sensorNames Sensors retrieved from chassis
418413961deSRichard Marian Thomaiyar  * @param callback Callback for processing gathered connections
419413961deSRichard Marian Thomaiyar  */
420413961deSRichard Marian Thomaiyar template <typename Callback>
421fe04d49cSNan Zhou void getConnections(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
422fe04d49cSNan Zhou                     const std::shared_ptr<std::set<std::string>> sensorNames,
423413961deSRichard Marian Thomaiyar                     Callback&& callback)
424413961deSRichard Marian Thomaiyar {
425413961deSRichard Marian Thomaiyar     auto objectsWithConnectionCb =
426fe04d49cSNan Zhou         [callback](const std::set<std::string>& connections,
427413961deSRichard Marian Thomaiyar                    const std::set<std::pair<std::string, std::string>>&
4283174e4dfSEd Tanous                    /*objectsWithConnection*/) { callback(connections); };
42981ce609eSEd Tanous     getObjectsWithConnection(sensorsAsyncResp, sensorNames,
430413961deSRichard Marian Thomaiyar                              std::move(objectsWithConnectionCb));
43108777fb0SLewanczyk, Dawid }
43208777fb0SLewanczyk, Dawid 
43308777fb0SLewanczyk, Dawid /**
43449c53ac9SJohnathan Mantey  * @brief Shrinks the list of sensors for processing
43549c53ac9SJohnathan Mantey  * @param SensorsAysncResp  The class holding the Redfish response
43649c53ac9SJohnathan Mantey  * @param allSensors  A list of all the sensors associated to the
43749c53ac9SJohnathan Mantey  * chassis element (i.e. baseboard, front panel, etc...)
43849c53ac9SJohnathan Mantey  * @param activeSensors A list that is a reduction of the incoming
43949c53ac9SJohnathan Mantey  * allSensors list.  Eliminate Thermal sensors when a Power request is
44049c53ac9SJohnathan Mantey  * made, and eliminate Power sensors when a Thermal request is made.
44149c53ac9SJohnathan Mantey  */
44223a21a1cSEd Tanous inline void reduceSensorList(
4437f1cc26dSEd Tanous     crow::Response& res, std::string_view chassisSubNode,
444cf9e417dSEd Tanous     std::span<const std::string_view> sensorTypes,
44549c53ac9SJohnathan Mantey     const std::vector<std::string>* allSensors,
446fe04d49cSNan Zhou     const std::shared_ptr<std::set<std::string>>& activeSensors)
44749c53ac9SJohnathan Mantey {
44849c53ac9SJohnathan Mantey     if ((allSensors == nullptr) || (activeSensors == nullptr))
44949c53ac9SJohnathan Mantey     {
4507f1cc26dSEd Tanous         messages::resourceNotFound(res, chassisSubNode,
4517f1cc26dSEd Tanous                                    chassisSubNode == sensors::node::thermal
452a0ec28b6SAdrian Ambrożewicz                                        ? "Temperatures"
45349c53ac9SJohnathan Mantey                                        : "Voltages");
45449c53ac9SJohnathan Mantey 
45549c53ac9SJohnathan Mantey         return;
45649c53ac9SJohnathan Mantey     }
45749c53ac9SJohnathan Mantey     if (allSensors->empty())
45849c53ac9SJohnathan Mantey     {
45949c53ac9SJohnathan Mantey         // Nothing to do, the activeSensors object is also empty
46049c53ac9SJohnathan Mantey         return;
46149c53ac9SJohnathan Mantey     }
46249c53ac9SJohnathan Mantey 
4637f1cc26dSEd Tanous     for (std::string_view type : sensorTypes)
46449c53ac9SJohnathan Mantey     {
46549c53ac9SJohnathan Mantey         for (const std::string& sensor : *allSensors)
46649c53ac9SJohnathan Mantey         {
46711ba3979SEd Tanous             if (sensor.starts_with(type))
46849c53ac9SJohnathan Mantey             {
46949c53ac9SJohnathan Mantey                 activeSensors->emplace(sensor);
47049c53ac9SJohnathan Mantey             }
47149c53ac9SJohnathan Mantey         }
47249c53ac9SJohnathan Mantey     }
47349c53ac9SJohnathan Mantey }
47449c53ac9SJohnathan Mantey 
4757f1cc26dSEd Tanous /*
4767f1cc26dSEd Tanous  *Populates the top level collection for a given subnode.  Populates
4777f1cc26dSEd Tanous  *SensorCollection, Power, or Thermal schemas.
4787f1cc26dSEd Tanous  *
4797f1cc26dSEd Tanous  * */
4807f1cc26dSEd Tanous inline void populateChassisNode(nlohmann::json& jsonValue,
4817f1cc26dSEd Tanous                                 std::string_view chassisSubNode)
4827f1cc26dSEd Tanous {
4837f1cc26dSEd Tanous     if (chassisSubNode == sensors::node::power)
4847f1cc26dSEd Tanous     {
4857f1cc26dSEd Tanous         jsonValue["@odata.type"] = "#Power.v1_5_2.Power";
4867f1cc26dSEd Tanous     }
4877f1cc26dSEd Tanous     else if (chassisSubNode == sensors::node::thermal)
4887f1cc26dSEd Tanous     {
4897f1cc26dSEd Tanous         jsonValue["@odata.type"] = "#Thermal.v1_4_0.Thermal";
4907f1cc26dSEd Tanous         jsonValue["Fans"] = nlohmann::json::array();
4917f1cc26dSEd Tanous         jsonValue["Temperatures"] = nlohmann::json::array();
4927f1cc26dSEd Tanous     }
4937f1cc26dSEd Tanous     else if (chassisSubNode == sensors::node::sensors)
4947f1cc26dSEd Tanous     {
4957f1cc26dSEd Tanous         jsonValue["@odata.type"] = "#SensorCollection.SensorCollection";
4967f1cc26dSEd Tanous         jsonValue["Description"] = "Collection of Sensors for this Chassis";
4977f1cc26dSEd Tanous         jsonValue["Members"] = nlohmann::json::array();
4987f1cc26dSEd Tanous         jsonValue["Members@odata.count"] = 0;
4997f1cc26dSEd Tanous     }
5007f1cc26dSEd Tanous 
5017f1cc26dSEd Tanous     if (chassisSubNode != sensors::node::sensors)
5027f1cc26dSEd Tanous     {
5037f1cc26dSEd Tanous         jsonValue["Id"] = chassisSubNode;
5047f1cc26dSEd Tanous     }
5057f1cc26dSEd Tanous     jsonValue["Name"] = chassisSubNode;
5067f1cc26dSEd Tanous }
5077f1cc26dSEd Tanous 
50849c53ac9SJohnathan Mantey /**
50908777fb0SLewanczyk, Dawid  * @brief Retrieves requested chassis sensors and redundancy data from DBus .
510588c3f0dSKowalski, Kamil  * @param SensorsAsyncResp   Pointer to object holding response data
51108777fb0SLewanczyk, Dawid  * @param callback  Callback for next step in gathered sensor processing
51208777fb0SLewanczyk, Dawid  */
51308777fb0SLewanczyk, Dawid template <typename Callback>
5147f1cc26dSEd Tanous void getChassis(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
5157f1cc26dSEd Tanous                 std::string_view chassisId, std::string_view chassisSubNode,
516cf9e417dSEd Tanous                 std::span<const std::string_view> sensorTypes,
517cf9e417dSEd Tanous                 Callback&& callback)
5181abe55efSEd Tanous {
51955c7b7a2SEd Tanous     BMCWEB_LOG_DEBUG << "getChassis enter";
5207a1dbc48SGeorge Liu     constexpr std::array<std::string_view, 2> interfaces = {
52149c53ac9SJohnathan Mantey         "xyz.openbmc_project.Inventory.Item.Board",
522adc4f0dbSShawn McCarney         "xyz.openbmc_project.Inventory.Item.Chassis"};
5237a1dbc48SGeorge Liu 
5247a1dbc48SGeorge Liu     // Get the Chassis Collection
5257a1dbc48SGeorge Liu     dbus::utility::getSubTreePaths(
5267a1dbc48SGeorge Liu         "/xyz/openbmc_project/inventory", 0, interfaces,
5277f1cc26dSEd Tanous         [callback{std::forward<Callback>(callback)}, asyncResp,
5287f1cc26dSEd Tanous          chassisIdStr{std::string(chassisId)},
5297f1cc26dSEd Tanous          chassisSubNode{std::string(chassisSubNode)}, sensorTypes](
5307a1dbc48SGeorge Liu             const boost::system::error_code& ec,
531002d39b4SEd Tanous             const dbus::utility::MapperGetSubTreePathsResponse& chassisPaths) {
53255c7b7a2SEd Tanous         BMCWEB_LOG_DEBUG << "getChassis respHandler enter";
5331abe55efSEd Tanous         if (ec)
5341abe55efSEd Tanous         {
53555c7b7a2SEd Tanous             BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec;
5367f1cc26dSEd Tanous             messages::internalError(asyncResp->res);
53708777fb0SLewanczyk, Dawid             return;
53808777fb0SLewanczyk, Dawid         }
53949c53ac9SJohnathan Mantey         const std::string* chassisPath = nullptr;
54049c53ac9SJohnathan Mantey         for (const std::string& chassis : chassisPaths)
5411abe55efSEd Tanous         {
54228aa8de5SGeorge Liu             sdbusplus::message::object_path path(chassis);
543f8fe53e7SEd Tanous             std::string chassisName = path.filename();
54428aa8de5SGeorge Liu             if (chassisName.empty())
5451abe55efSEd Tanous             {
54649c53ac9SJohnathan Mantey                 BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis;
547daf36e2eSEd Tanous                 continue;
548daf36e2eSEd Tanous             }
5497f1cc26dSEd Tanous             if (chassisName == chassisIdStr)
5501abe55efSEd Tanous             {
55149c53ac9SJohnathan Mantey                 chassisPath = &chassis;
55249c53ac9SJohnathan Mantey                 break;
553daf36e2eSEd Tanous             }
55449c53ac9SJohnathan Mantey         }
55549c53ac9SJohnathan Mantey         if (chassisPath == nullptr)
5561abe55efSEd Tanous         {
5577f1cc26dSEd Tanous             messages::resourceNotFound(asyncResp->res, "Chassis", chassisIdStr);
55849c53ac9SJohnathan Mantey             return;
5591abe55efSEd Tanous         }
5607f1cc26dSEd Tanous         populateChassisNode(asyncResp->res.jsonValue, chassisSubNode);
56108777fb0SLewanczyk, Dawid 
562eddfc437SWilly Tu         asyncResp->res.jsonValue["@odata.id"] = crow::utility::urlFromPieces(
563eddfc437SWilly Tu             "redfish", "v1", "Chassis", chassisIdStr, chassisSubNode);
56495a3ecadSAnthony Wilson 
5658fb49dd6SShawn McCarney         // Get the list of all sensors for this Chassis element
5668fb49dd6SShawn McCarney         std::string sensorPath = *chassisPath + "/all_sensors";
5676c3e9451SGeorge Liu         dbus::utility::getAssociationEndPoints(
5686c3e9451SGeorge Liu             sensorPath,
5697f1cc26dSEd Tanous             [asyncResp, chassisSubNode, sensorTypes,
570f94c4ecfSEd Tanous              callback{std::forward<const Callback>(callback)}](
571271584abSEd Tanous                 const boost::system::error_code& e,
5726c3e9451SGeorge Liu                 const dbus::utility::MapperEndPoints& nodeSensorList) {
573271584abSEd Tanous             if (e)
57449c53ac9SJohnathan Mantey             {
575271584abSEd Tanous                 if (e.value() != EBADR)
57649c53ac9SJohnathan Mantey                 {
5777f1cc26dSEd Tanous                     messages::internalError(asyncResp->res);
57849c53ac9SJohnathan Mantey                     return;
57949c53ac9SJohnathan Mantey                 }
58049c53ac9SJohnathan Mantey             }
581fe04d49cSNan Zhou             const std::shared_ptr<std::set<std::string>> culledSensorList =
582fe04d49cSNan Zhou                 std::make_shared<std::set<std::string>>();
5837f1cc26dSEd Tanous             reduceSensorList(asyncResp->res, chassisSubNode, sensorTypes,
5847f1cc26dSEd Tanous                              &nodeSensorList, culledSensorList);
5857f1cc26dSEd Tanous             BMCWEB_LOG_DEBUG << "Finishing with " << culledSensorList->size();
58649c53ac9SJohnathan Mantey             callback(culledSensorList);
5871e1e598dSJonathan Doman             });
5887a1dbc48SGeorge Liu         });
58955c7b7a2SEd Tanous     BMCWEB_LOG_DEBUG << "getChassis exit";
59008777fb0SLewanczyk, Dawid }
59108777fb0SLewanczyk, Dawid 
59208777fb0SLewanczyk, Dawid /**
593adc4f0dbSShawn McCarney  * @brief Returns the Redfish State value for the specified inventory item.
594adc4f0dbSShawn McCarney  * @param inventoryItem D-Bus inventory item associated with a sensor.
595adc4f0dbSShawn McCarney  * @return State value for inventory item.
59634dd179eSJames Feist  */
59723a21a1cSEd Tanous inline std::string getState(const InventoryItem* inventoryItem)
598adc4f0dbSShawn McCarney {
599adc4f0dbSShawn McCarney     if ((inventoryItem != nullptr) && !(inventoryItem->isPresent))
600adc4f0dbSShawn McCarney     {
601adc4f0dbSShawn McCarney         return "Absent";
602adc4f0dbSShawn McCarney     }
60334dd179eSJames Feist 
604adc4f0dbSShawn McCarney     return "Enabled";
605adc4f0dbSShawn McCarney }
606adc4f0dbSShawn McCarney 
607adc4f0dbSShawn McCarney /**
608adc4f0dbSShawn McCarney  * @brief Returns the Redfish Health value for the specified sensor.
609adc4f0dbSShawn McCarney  * @param sensorJson Sensor JSON object.
6101d7c0054SEd Tanous  * @param valuesDict Map of all sensor DBus values.
611adc4f0dbSShawn McCarney  * @param inventoryItem D-Bus inventory item associated with the sensor.  Will
612adc4f0dbSShawn McCarney  * be nullptr if no associated inventory item was found.
613adc4f0dbSShawn McCarney  * @return Health value for sensor.
614adc4f0dbSShawn McCarney  */
6151d7c0054SEd Tanous inline std::string getHealth(nlohmann::json& sensorJson,
6161d7c0054SEd Tanous                              const dbus::utility::DBusPropertiesMap& valuesDict,
617adc4f0dbSShawn McCarney                              const InventoryItem* inventoryItem)
61834dd179eSJames Feist {
619adc4f0dbSShawn McCarney     // Get current health value (if any) in the sensor JSON object.  Some JSON
620adc4f0dbSShawn McCarney     // objects contain multiple sensors (such as PowerSupplies).  We want to set
621adc4f0dbSShawn McCarney     // the overall health to be the most severe of any of the sensors.
622adc4f0dbSShawn McCarney     std::string currentHealth;
623adc4f0dbSShawn McCarney     auto statusIt = sensorJson.find("Status");
624adc4f0dbSShawn McCarney     if (statusIt != sensorJson.end())
625adc4f0dbSShawn McCarney     {
626adc4f0dbSShawn McCarney         auto healthIt = statusIt->find("Health");
627adc4f0dbSShawn McCarney         if (healthIt != statusIt->end())
628adc4f0dbSShawn McCarney         {
629adc4f0dbSShawn McCarney             std::string* health = healthIt->get_ptr<std::string*>();
630adc4f0dbSShawn McCarney             if (health != nullptr)
631adc4f0dbSShawn McCarney             {
632adc4f0dbSShawn McCarney                 currentHealth = *health;
633adc4f0dbSShawn McCarney             }
634adc4f0dbSShawn McCarney         }
635adc4f0dbSShawn McCarney     }
636adc4f0dbSShawn McCarney 
637adc4f0dbSShawn McCarney     // If current health in JSON object is already Critical, return that.  This
638adc4f0dbSShawn McCarney     // should override the sensor health, which might be less severe.
639adc4f0dbSShawn McCarney     if (currentHealth == "Critical")
640adc4f0dbSShawn McCarney     {
641adc4f0dbSShawn McCarney         return "Critical";
642adc4f0dbSShawn McCarney     }
643adc4f0dbSShawn McCarney 
644c1343bf6SKrzysztof Grobelny     const bool* criticalAlarmHigh = nullptr;
645c1343bf6SKrzysztof Grobelny     const bool* criticalAlarmLow = nullptr;
646c1343bf6SKrzysztof Grobelny     const bool* warningAlarmHigh = nullptr;
647c1343bf6SKrzysztof Grobelny     const bool* warningAlarmLow = nullptr;
648711ac7a9SEd Tanous 
649c1343bf6SKrzysztof Grobelny     const bool success = sdbusplus::unpackPropertiesNoThrow(
650c1343bf6SKrzysztof Grobelny         dbus_utils::UnpackErrorPrinter(), valuesDict, "CriticalAlarmHigh",
651c1343bf6SKrzysztof Grobelny         criticalAlarmHigh, "CriticalAlarmLow", criticalAlarmLow,
652c1343bf6SKrzysztof Grobelny         "WarningAlarmHigh", warningAlarmHigh, "WarningAlarmLow",
653c1343bf6SKrzysztof Grobelny         warningAlarmLow);
654c1343bf6SKrzysztof Grobelny 
655c1343bf6SKrzysztof Grobelny     if (success)
65634dd179eSJames Feist     {
657c1343bf6SKrzysztof Grobelny         // Check if sensor has critical threshold alarm
658c1343bf6SKrzysztof Grobelny         if ((criticalAlarmHigh != nullptr && *criticalAlarmHigh) ||
659c1343bf6SKrzysztof Grobelny             (criticalAlarmLow != nullptr && *criticalAlarmLow))
66034dd179eSJames Feist         {
66134dd179eSJames Feist             return "Critical";
66234dd179eSJames Feist         }
66334dd179eSJames Feist     }
66434dd179eSJames Feist 
665adc4f0dbSShawn McCarney     // Check if associated inventory item is not functional
666adc4f0dbSShawn McCarney     if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional))
667adc4f0dbSShawn McCarney     {
668adc4f0dbSShawn McCarney         return "Critical";
669adc4f0dbSShawn McCarney     }
670adc4f0dbSShawn McCarney 
671adc4f0dbSShawn McCarney     // If current health in JSON object is already Warning, return that. This
672adc4f0dbSShawn McCarney     // should override the sensor status, which might be less severe.
673adc4f0dbSShawn McCarney     if (currentHealth == "Warning")
674adc4f0dbSShawn McCarney     {
675adc4f0dbSShawn McCarney         return "Warning";
676adc4f0dbSShawn McCarney     }
677adc4f0dbSShawn McCarney 
678c1343bf6SKrzysztof Grobelny     if (success)
679c1343bf6SKrzysztof Grobelny     {
680adc4f0dbSShawn McCarney         // Check if sensor has warning threshold alarm
681c1343bf6SKrzysztof Grobelny         if ((warningAlarmHigh != nullptr && *warningAlarmHigh) ||
682c1343bf6SKrzysztof Grobelny             (warningAlarmLow != nullptr && *warningAlarmLow))
68334dd179eSJames Feist         {
684ebe4d91eSEd Tanous             return "Warning";
68534dd179eSJames Feist         }
68634dd179eSJames Feist     }
687adc4f0dbSShawn McCarney 
68834dd179eSJames Feist     return "OK";
68934dd179eSJames Feist }
69034dd179eSJames Feist 
69123a21a1cSEd Tanous inline void setLedState(nlohmann::json& sensorJson,
692d500549bSAnthony Wilson                         const InventoryItem* inventoryItem)
693d500549bSAnthony Wilson {
694d500549bSAnthony Wilson     if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty())
695d500549bSAnthony Wilson     {
696d500549bSAnthony Wilson         switch (inventoryItem->ledState)
697d500549bSAnthony Wilson         {
698d500549bSAnthony Wilson             case LedState::OFF:
699d500549bSAnthony Wilson                 sensorJson["IndicatorLED"] = "Off";
700d500549bSAnthony Wilson                 break;
701d500549bSAnthony Wilson             case LedState::ON:
702d500549bSAnthony Wilson                 sensorJson["IndicatorLED"] = "Lit";
703d500549bSAnthony Wilson                 break;
704d500549bSAnthony Wilson             case LedState::BLINK:
705d500549bSAnthony Wilson                 sensorJson["IndicatorLED"] = "Blinking";
706d500549bSAnthony Wilson                 break;
70723a21a1cSEd Tanous             case LedState::UNKNOWN:
708d500549bSAnthony Wilson                 break;
709d500549bSAnthony Wilson         }
710d500549bSAnthony Wilson     }
711d500549bSAnthony Wilson }
712d500549bSAnthony Wilson 
71334dd179eSJames Feist /**
71408777fb0SLewanczyk, Dawid  * @brief Builds a json sensor representation of a sensor.
71508777fb0SLewanczyk, Dawid  * @param sensorName  The name of the sensor to be built
716274fad5aSGunnar Mills  * @param sensorType  The type (temperature, fan_tach, etc) of the sensor to
71708777fb0SLewanczyk, Dawid  * build
7181d7c0054SEd Tanous  * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor
7191d7c0054SEd Tanous  * @param propertiesDict A dictionary of the properties to build the sensor
7201d7c0054SEd Tanous  * from.
7211d7c0054SEd Tanous  * @param sensorJson  The json object to fill
722adc4f0dbSShawn McCarney  * @param inventoryItem D-Bus inventory item associated with the sensor.  Will
723adc4f0dbSShawn McCarney  * be nullptr if no associated inventory item was found.
72408777fb0SLewanczyk, Dawid  */
7251d7c0054SEd Tanous inline void objectPropertiesToJson(
7261d7c0054SEd Tanous     std::string_view sensorName, std::string_view sensorType,
7271d7c0054SEd Tanous     std::string_view chassisSubNode,
7281d7c0054SEd Tanous     const dbus::utility::DBusPropertiesMap& propertiesDict,
72981ce609eSEd Tanous     nlohmann::json& sensorJson, InventoryItem* inventoryItem)
7301abe55efSEd Tanous {
7311d7c0054SEd Tanous     if (chassisSubNode == sensors::node::sensors)
732adc4f0dbSShawn McCarney     {
733c71d6125SEd Tanous         std::string subNodeEscaped(sensorType);
734c1d019a6SEd Tanous         subNodeEscaped.erase(
735c1d019a6SEd Tanous             std::remove(subNodeEscaped.begin(), subNodeEscaped.end(), '_'),
736c1d019a6SEd Tanous             subNodeEscaped.end());
737c1d019a6SEd Tanous 
738c1d019a6SEd Tanous         // For sensors in SensorCollection we set Id instead of MemberId,
739c1d019a6SEd Tanous         // including power sensors.
740c1d019a6SEd Tanous         subNodeEscaped += '_';
741c1d019a6SEd Tanous         subNodeEscaped += sensorName;
742c1d019a6SEd Tanous         sensorJson["Id"] = std::move(subNodeEscaped);
743c1d019a6SEd Tanous 
7441d7c0054SEd Tanous         std::string sensorNameEs(sensorName);
7451d7c0054SEd Tanous         std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
7461d7c0054SEd Tanous         sensorJson["Name"] = std::move(sensorNameEs);
74795a3ecadSAnthony Wilson     }
74895a3ecadSAnthony Wilson     else if (sensorType != "power")
74995a3ecadSAnthony Wilson     {
75095a3ecadSAnthony Wilson         // Set MemberId and Name for non-power sensors.  For PowerSupplies and
75195a3ecadSAnthony Wilson         // PowerControl, those properties have more general values because
75295a3ecadSAnthony Wilson         // multiple sensors can be stored in the same JSON object.
7531d7c0054SEd Tanous         std::string sensorNameEs(sensorName);
7541d7c0054SEd Tanous         std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
7551d7c0054SEd Tanous         sensorJson["Name"] = std::move(sensorNameEs);
756adc4f0dbSShawn McCarney     }
757e742b6ccSEd Tanous 
75881ce609eSEd Tanous     sensorJson["Status"]["State"] = getState(inventoryItem);
75989492a15SPatrick Williams     sensorJson["Status"]["Health"] = getHealth(sensorJson, propertiesDict,
76089492a15SPatrick Williams                                                inventoryItem);
76108777fb0SLewanczyk, Dawid 
76208777fb0SLewanczyk, Dawid     // Parameter to set to override the type we get from dbus, and force it to
76308777fb0SLewanczyk, Dawid     // int, regardless of what is available.  This is used for schemas like fan,
76408777fb0SLewanczyk, Dawid     // that require integers, not floats.
76508777fb0SLewanczyk, Dawid     bool forceToInt = false;
76608777fb0SLewanczyk, Dawid 
7673929aca1SAnthony Wilson     nlohmann::json::json_pointer unit("/Reading");
7681d7c0054SEd Tanous     if (chassisSubNode == sensors::node::sensors)
76995a3ecadSAnthony Wilson     {
7702a4ba195SShounak Mitra         sensorJson["@odata.type"] = "#Sensor.v1_2_0.Sensor";
771c2bf7f99SWludzik, Jozef 
7720ec8b83dSEd Tanous         sensor::ReadingType readingType = sensors::toReadingType(sensorType);
7730ec8b83dSEd Tanous         if (readingType == sensor::ReadingType::Invalid)
77495a3ecadSAnthony Wilson         {
775c2bf7f99SWludzik, Jozef             BMCWEB_LOG_ERROR << "Redfish cannot map reading type for "
776c2bf7f99SWludzik, Jozef                              << sensorType;
77795a3ecadSAnthony Wilson         }
778c2bf7f99SWludzik, Jozef         else
77995a3ecadSAnthony Wilson         {
780c2bf7f99SWludzik, Jozef             sensorJson["ReadingType"] = readingType;
78195a3ecadSAnthony Wilson         }
782c2bf7f99SWludzik, Jozef 
7831d7c0054SEd Tanous         std::string_view readingUnits = sensors::toReadingUnits(sensorType);
784c2bf7f99SWludzik, Jozef         if (readingUnits.empty())
785f8ede15eSAdrian Ambrożewicz         {
786c2bf7f99SWludzik, Jozef             BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for "
787c2bf7f99SWludzik, Jozef                              << sensorType;
788c2bf7f99SWludzik, Jozef         }
789c2bf7f99SWludzik, Jozef         else
790c2bf7f99SWludzik, Jozef         {
791c2bf7f99SWludzik, Jozef             sensorJson["ReadingUnits"] = readingUnits;
792f8ede15eSAdrian Ambrożewicz         }
79395a3ecadSAnthony Wilson     }
79495a3ecadSAnthony Wilson     else if (sensorType == "temperature")
7951abe55efSEd Tanous     {
7963929aca1SAnthony Wilson         unit = "/ReadingCelsius"_json_pointer;
79781ce609eSEd Tanous         sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature";
79808777fb0SLewanczyk, Dawid         // TODO(ed) Documentation says that path should be type fan_tach,
79908777fb0SLewanczyk, Dawid         // implementation seems to implement fan
8001abe55efSEd Tanous     }
8011abe55efSEd Tanous     else if (sensorType == "fan" || sensorType == "fan_tach")
8021abe55efSEd Tanous     {
8033929aca1SAnthony Wilson         unit = "/Reading"_json_pointer;
80481ce609eSEd Tanous         sensorJson["ReadingUnits"] = "RPM";
80581ce609eSEd Tanous         sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
80681ce609eSEd Tanous         setLedState(sensorJson, inventoryItem);
80708777fb0SLewanczyk, Dawid         forceToInt = true;
8081abe55efSEd Tanous     }
8096f6d0d32SEd Tanous     else if (sensorType == "fan_pwm")
8106f6d0d32SEd Tanous     {
8113929aca1SAnthony Wilson         unit = "/Reading"_json_pointer;
81281ce609eSEd Tanous         sensorJson["ReadingUnits"] = "Percent";
81381ce609eSEd Tanous         sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
81481ce609eSEd Tanous         setLedState(sensorJson, inventoryItem);
8156f6d0d32SEd Tanous         forceToInt = true;
8166f6d0d32SEd Tanous     }
8171abe55efSEd Tanous     else if (sensorType == "voltage")
8181abe55efSEd Tanous     {
8193929aca1SAnthony Wilson         unit = "/ReadingVolts"_json_pointer;
82081ce609eSEd Tanous         sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage";
8211abe55efSEd Tanous     }
8222474adfaSEd Tanous     else if (sensorType == "power")
8232474adfaSEd Tanous     {
8241d7c0054SEd Tanous         if (boost::iequals(sensorName, "total_power"))
825028f7ebcSEddie James         {
82681ce609eSEd Tanous             sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl";
8277ab06f49SGunnar Mills             // Put multiple "sensors" into a single PowerControl, so have
8287ab06f49SGunnar Mills             // generic names for MemberId and Name. Follows Redfish mockup.
82981ce609eSEd Tanous             sensorJson["MemberId"] = "0";
83081ce609eSEd Tanous             sensorJson["Name"] = "Chassis Power Control";
8313929aca1SAnthony Wilson             unit = "/PowerConsumedWatts"_json_pointer;
832028f7ebcSEddie James         }
8331d7c0054SEd Tanous         else if (boost::ifind_first(sensorName, "input").empty())
83449c53ac9SJohnathan Mantey         {
8353929aca1SAnthony Wilson             unit = "/PowerInputWatts"_json_pointer;
83649c53ac9SJohnathan Mantey         }
83749c53ac9SJohnathan Mantey         else
83849c53ac9SJohnathan Mantey         {
8393929aca1SAnthony Wilson             unit = "/PowerOutputWatts"_json_pointer;
84049c53ac9SJohnathan Mantey         }
8412474adfaSEd Tanous     }
8421abe55efSEd Tanous     else
8431abe55efSEd Tanous     {
84455c7b7a2SEd Tanous         BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName;
84508777fb0SLewanczyk, Dawid         return;
84608777fb0SLewanczyk, Dawid     }
84708777fb0SLewanczyk, Dawid     // Map of dbus interface name, dbus property name and redfish property_name
8483929aca1SAnthony Wilson     std::vector<
8493929aca1SAnthony Wilson         std::tuple<const char*, const char*, nlohmann::json::json_pointer>>
8503929aca1SAnthony Wilson         properties;
85108777fb0SLewanczyk, Dawid     properties.reserve(7);
85208777fb0SLewanczyk, Dawid 
85308777fb0SLewanczyk, Dawid     properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit);
854de629b6eSShawn McCarney 
8551d7c0054SEd Tanous     if (chassisSubNode == sensors::node::sensors)
8563929aca1SAnthony Wilson     {
8573929aca1SAnthony Wilson         properties.emplace_back(
8583929aca1SAnthony Wilson             "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh",
8593929aca1SAnthony Wilson             "/Thresholds/UpperCaution/Reading"_json_pointer);
8603929aca1SAnthony Wilson         properties.emplace_back(
8613929aca1SAnthony Wilson             "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow",
8623929aca1SAnthony Wilson             "/Thresholds/LowerCaution/Reading"_json_pointer);
8633929aca1SAnthony Wilson         properties.emplace_back(
8643929aca1SAnthony Wilson             "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh",
8653929aca1SAnthony Wilson             "/Thresholds/UpperCritical/Reading"_json_pointer);
8663929aca1SAnthony Wilson         properties.emplace_back(
8673929aca1SAnthony Wilson             "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow",
8683929aca1SAnthony Wilson             "/Thresholds/LowerCritical/Reading"_json_pointer);
8693929aca1SAnthony Wilson     }
8703929aca1SAnthony Wilson     else if (sensorType != "power")
871de629b6eSShawn McCarney     {
87208777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
8733929aca1SAnthony Wilson                                 "WarningHigh",
8743929aca1SAnthony Wilson                                 "/UpperThresholdNonCritical"_json_pointer);
87508777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
8763929aca1SAnthony Wilson                                 "WarningLow",
8773929aca1SAnthony Wilson                                 "/LowerThresholdNonCritical"_json_pointer);
87808777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
8793929aca1SAnthony Wilson                                 "CriticalHigh",
8803929aca1SAnthony Wilson                                 "/UpperThresholdCritical"_json_pointer);
88108777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
8823929aca1SAnthony Wilson                                 "CriticalLow",
8833929aca1SAnthony Wilson                                 "/LowerThresholdCritical"_json_pointer);
884de629b6eSShawn McCarney     }
88508777fb0SLewanczyk, Dawid 
8862474adfaSEd Tanous     // TODO Need to get UpperThresholdFatal and LowerThresholdFatal
8872474adfaSEd Tanous 
8881d7c0054SEd Tanous     if (chassisSubNode == sensors::node::sensors)
88995a3ecadSAnthony Wilson     {
89095a3ecadSAnthony Wilson         properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
8913929aca1SAnthony Wilson                                 "/ReadingRangeMin"_json_pointer);
89295a3ecadSAnthony Wilson         properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
8933929aca1SAnthony Wilson                                 "/ReadingRangeMax"_json_pointer);
89451c35a8fSGeorge Liu         properties.emplace_back("xyz.openbmc_project.Sensor.Accuracy",
89551c35a8fSGeorge Liu                                 "Accuracy", "/Accuracy"_json_pointer);
89695a3ecadSAnthony Wilson     }
89795a3ecadSAnthony Wilson     else if (sensorType == "temperature")
8981abe55efSEd Tanous     {
89908777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
9003929aca1SAnthony Wilson                                 "/MinReadingRangeTemp"_json_pointer);
90108777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
9023929aca1SAnthony Wilson                                 "/MaxReadingRangeTemp"_json_pointer);
9031abe55efSEd Tanous     }
904adc4f0dbSShawn McCarney     else if (sensorType != "power")
9051abe55efSEd Tanous     {
90608777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
9073929aca1SAnthony Wilson                                 "/MinReadingRange"_json_pointer);
90808777fb0SLewanczyk, Dawid         properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
9093929aca1SAnthony Wilson                                 "/MaxReadingRange"_json_pointer);
91008777fb0SLewanczyk, Dawid     }
91108777fb0SLewanczyk, Dawid 
9123929aca1SAnthony Wilson     for (const std::tuple<const char*, const char*,
9133929aca1SAnthony Wilson                           nlohmann::json::json_pointer>& p : properties)
9141abe55efSEd Tanous     {
9151d7c0054SEd Tanous         for (const auto& [valueName, valueVariant] : propertiesDict)
916711ac7a9SEd Tanous         {
917711ac7a9SEd Tanous             if (valueName != std::get<1>(p))
918711ac7a9SEd Tanous             {
919711ac7a9SEd Tanous                 continue;
920711ac7a9SEd Tanous             }
9213929aca1SAnthony Wilson 
9223929aca1SAnthony Wilson             // The property we want to set may be nested json, so use
9233929aca1SAnthony Wilson             // a json_pointer for easy indexing into the json structure.
9243929aca1SAnthony Wilson             const nlohmann::json::json_pointer& key = std::get<2>(p);
9253929aca1SAnthony Wilson 
926abf2add6SEd Tanous             const double* doubleValue = std::get_if<double>(&valueVariant);
92740e4f380SEd Tanous             if (doubleValue == nullptr)
9281abe55efSEd Tanous             {
92940e4f380SEd Tanous                 BMCWEB_LOG_ERROR << "Got value interface that wasn't double";
9306f6d0d32SEd Tanous                 continue;
93108777fb0SLewanczyk, Dawid             }
9326f6d0d32SEd Tanous             if (forceToInt)
9336f6d0d32SEd Tanous             {
93440e4f380SEd Tanous                 sensorJson[key] = static_cast<int64_t>(*doubleValue);
9356f6d0d32SEd Tanous             }
9366f6d0d32SEd Tanous             else
9376f6d0d32SEd Tanous             {
93840e4f380SEd Tanous                 sensorJson[key] = *doubleValue;
93908777fb0SLewanczyk, Dawid             }
94008777fb0SLewanczyk, Dawid         }
94108777fb0SLewanczyk, Dawid     }
94208777fb0SLewanczyk, Dawid }
94308777fb0SLewanczyk, Dawid 
9441d7c0054SEd Tanous /**
9451d7c0054SEd Tanous  * @brief Builds a json sensor representation of a sensor.
9461d7c0054SEd Tanous  * @param sensorName  The name of the sensor to be built
9471d7c0054SEd Tanous  * @param sensorType  The type (temperature, fan_tach, etc) of the sensor to
9481d7c0054SEd Tanous  * build
9491d7c0054SEd Tanous  * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor
9501d7c0054SEd Tanous  * @param interfacesDict  A dictionary of the interfaces and properties of said
9511d7c0054SEd Tanous  * interfaces to be built from
9521d7c0054SEd Tanous  * @param sensorJson  The json object to fill
9531d7c0054SEd Tanous  * @param inventoryItem D-Bus inventory item associated with the sensor.  Will
9541d7c0054SEd Tanous  * be nullptr if no associated inventory item was found.
9551d7c0054SEd Tanous  */
9561d7c0054SEd Tanous inline void objectInterfacesToJson(
9571d7c0054SEd Tanous     const std::string& sensorName, const std::string& sensorType,
9581d7c0054SEd Tanous     const std::string& chassisSubNode,
9591d7c0054SEd Tanous     const dbus::utility::DBusInteracesMap& interfacesDict,
9601d7c0054SEd Tanous     nlohmann::json& sensorJson, InventoryItem* inventoryItem)
9611d7c0054SEd Tanous {
9621d7c0054SEd Tanous     for (const auto& [interface, valuesDict] : interfacesDict)
9631d7c0054SEd Tanous     {
9641d7c0054SEd Tanous         objectPropertiesToJson(sensorName, sensorType, chassisSubNode,
9651d7c0054SEd Tanous                                valuesDict, sensorJson, inventoryItem);
9661d7c0054SEd Tanous     }
967c1d019a6SEd Tanous     BMCWEB_LOG_DEBUG << "Added sensor " << sensorName;
9681d7c0054SEd Tanous }
9691d7c0054SEd Tanous 
970b5a76932SEd Tanous inline void populateFanRedundancy(
971b5a76932SEd Tanous     const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
9728bd25ccdSJames Feist {
973e99073f5SGeorge Liu     constexpr std::array<std::string_view, 1> interfaces = {
974e99073f5SGeorge Liu         "xyz.openbmc_project.Control.FanRedundancy"};
975e99073f5SGeorge Liu     dbus::utility::getSubTree(
976e99073f5SGeorge Liu         "/xyz/openbmc_project/control", 2, interfaces,
977b9d36b47SEd Tanous         [sensorsAsyncResp](
978e99073f5SGeorge Liu             const boost::system::error_code& ec,
979b9d36b47SEd Tanous             const dbus::utility::MapperGetSubTreeResponse& resp) {
9808bd25ccdSJames Feist         if (ec)
9818bd25ccdSJames Feist         {
9828bd25ccdSJames Feist             return; // don't have to have this interface
9838bd25ccdSJames Feist         }
9846c3e9451SGeorge Liu         for (const std::pair<std::string, dbus::utility::MapperServiceMap>&
985e278c18fSEd Tanous                  pathPair : resp)
9868bd25ccdSJames Feist         {
987e278c18fSEd Tanous             const std::string& path = pathPair.first;
9886c3e9451SGeorge Liu             const dbus::utility::MapperServiceMap& objDict = pathPair.second;
9898bd25ccdSJames Feist             if (objDict.empty())
9908bd25ccdSJames Feist             {
9918bd25ccdSJames Feist                 continue; // this should be impossible
9928bd25ccdSJames Feist             }
9938bd25ccdSJames Feist 
9948bd25ccdSJames Feist             const std::string& owner = objDict.begin()->first;
9956c3e9451SGeorge Liu             dbus::utility::getAssociationEndPoints(
9966c3e9451SGeorge Liu                 path + "/chassis",
9976c3e9451SGeorge Liu                 [path, owner, sensorsAsyncResp](
9986c3e9451SGeorge Liu                     const boost::system::error_code& e,
9996c3e9451SGeorge Liu                     const dbus::utility::MapperEndPoints& endpoints) {
1000271584abSEd Tanous                 if (e)
10018bd25ccdSJames Feist                 {
10028bd25ccdSJames Feist                     return; // if they don't have an association we
10038bd25ccdSJames Feist                             // can't tell what chassis is
10048bd25ccdSJames Feist                 }
1005002d39b4SEd Tanous                 auto found =
1006002d39b4SEd Tanous                     std::find_if(endpoints.begin(), endpoints.end(),
10078bd25ccdSJames Feist                                  [sensorsAsyncResp](const std::string& entry) {
1008002d39b4SEd Tanous                     return entry.find(sensorsAsyncResp->chassisId) !=
10098bd25ccdSJames Feist                            std::string::npos;
10108bd25ccdSJames Feist                     });
10118bd25ccdSJames Feist 
10121e1e598dSJonathan Doman                 if (found == endpoints.end())
10138bd25ccdSJames Feist                 {
10148bd25ccdSJames Feist                     return;
10158bd25ccdSJames Feist                 }
101686d89ed7SKrzysztof Grobelny                 sdbusplus::asio::getAllProperties(
101786d89ed7SKrzysztof Grobelny                     *crow::connections::systemBus, owner, path,
101886d89ed7SKrzysztof Grobelny                     "xyz.openbmc_project.Control.FanRedundancy",
10198bd25ccdSJames Feist                     [path, sensorsAsyncResp](
1020271584abSEd Tanous                         const boost::system::error_code& err,
102186d89ed7SKrzysztof Grobelny                         const dbus::utility::DBusPropertiesMap& ret) {
1022271584abSEd Tanous                     if (err)
10238bd25ccdSJames Feist                     {
10248bd25ccdSJames Feist                         return; // don't have to have this
10258bd25ccdSJames Feist                                 // interface
10268bd25ccdSJames Feist                     }
10278bd25ccdSJames Feist 
102886d89ed7SKrzysztof Grobelny                     const uint8_t* allowedFailures = nullptr;
102986d89ed7SKrzysztof Grobelny                     const std::vector<std::string>* collection = nullptr;
103086d89ed7SKrzysztof Grobelny                     const std::string* status = nullptr;
103186d89ed7SKrzysztof Grobelny 
103286d89ed7SKrzysztof Grobelny                     const bool success = sdbusplus::unpackPropertiesNoThrow(
103386d89ed7SKrzysztof Grobelny                         dbus_utils::UnpackErrorPrinter(), ret,
103486d89ed7SKrzysztof Grobelny                         "AllowedFailures", allowedFailures, "Collection",
103586d89ed7SKrzysztof Grobelny                         collection, "Status", status);
103686d89ed7SKrzysztof Grobelny 
103786d89ed7SKrzysztof Grobelny                     if (!success)
103886d89ed7SKrzysztof Grobelny                     {
103986d89ed7SKrzysztof Grobelny                         messages::internalError(
104086d89ed7SKrzysztof Grobelny                             sensorsAsyncResp->asyncResp->res);
104186d89ed7SKrzysztof Grobelny                         return;
104286d89ed7SKrzysztof Grobelny                     }
104386d89ed7SKrzysztof Grobelny 
104486d89ed7SKrzysztof Grobelny                     if (allowedFailures == nullptr || collection == nullptr ||
104586d89ed7SKrzysztof Grobelny                         status == nullptr)
10468bd25ccdSJames Feist                     {
1047002d39b4SEd Tanous                         BMCWEB_LOG_ERROR << "Invalid redundancy interface";
10488bd25ccdSJames Feist                         messages::internalError(
10498d1b46d7Szhanghch05                             sensorsAsyncResp->asyncResp->res);
10508bd25ccdSJames Feist                         return;
10518bd25ccdSJames Feist                     }
10528bd25ccdSJames Feist 
1053002d39b4SEd Tanous                     sdbusplus::message::object_path objectPath(path);
105428aa8de5SGeorge Liu                     std::string name = objectPath.filename();
105528aa8de5SGeorge Liu                     if (name.empty())
10568bd25ccdSJames Feist                     {
10578bd25ccdSJames Feist                         // this should be impossible
10588bd25ccdSJames Feist                         messages::internalError(
10598d1b46d7Szhanghch05                             sensorsAsyncResp->asyncResp->res);
10608bd25ccdSJames Feist                         return;
10618bd25ccdSJames Feist                     }
1062002d39b4SEd Tanous                     std::replace(name.begin(), name.end(), '_', ' ');
10638bd25ccdSJames Feist 
10648bd25ccdSJames Feist                     std::string health;
10658bd25ccdSJames Feist 
106611ba3979SEd Tanous                     if (status->ends_with("Full"))
10678bd25ccdSJames Feist                     {
10688bd25ccdSJames Feist                         health = "OK";
10698bd25ccdSJames Feist                     }
107011ba3979SEd Tanous                     else if (status->ends_with("Degraded"))
10718bd25ccdSJames Feist                     {
10728bd25ccdSJames Feist                         health = "Warning";
10738bd25ccdSJames Feist                     }
10748bd25ccdSJames Feist                     else
10758bd25ccdSJames Feist                     {
10768bd25ccdSJames Feist                         health = "Critical";
10778bd25ccdSJames Feist                     }
10781476687dSEd Tanous                     nlohmann::json::array_t redfishCollection;
10798bd25ccdSJames Feist                     const auto& fanRedfish =
1080002d39b4SEd Tanous                         sensorsAsyncResp->asyncResp->res.jsonValue["Fans"];
10818bd25ccdSJames Feist                     for (const std::string& item : *collection)
10828bd25ccdSJames Feist                     {
10838a592810SEd Tanous                         sdbusplus::message::object_path itemPath(item);
10848a592810SEd Tanous                         std::string itemName = itemPath.filename();
108528aa8de5SGeorge Liu                         if (itemName.empty())
108628aa8de5SGeorge Liu                         {
108728aa8de5SGeorge Liu                             continue;
108828aa8de5SGeorge Liu                         }
10898bd25ccdSJames Feist                         /*
10908bd25ccdSJames Feist                         todo(ed): merge patch that fixes the names
10918bd25ccdSJames Feist                         std::replace(itemName.begin(),
10928bd25ccdSJames Feist                                      itemName.end(), '_', ' ');*/
1093002d39b4SEd Tanous                         auto schemaItem =
1094002d39b4SEd Tanous                             std::find_if(fanRedfish.begin(), fanRedfish.end(),
10958bd25ccdSJames Feist                                          [itemName](const nlohmann::json& fan) {
10963e35c761SGeorge Liu                             return fan["Name"] == itemName;
10978bd25ccdSJames Feist                             });
10988bd25ccdSJames Feist                         if (schemaItem != fanRedfish.end())
10998bd25ccdSJames Feist                         {
11008a592810SEd Tanous                             nlohmann::json::object_t collectionId;
11018a592810SEd Tanous                             collectionId["@odata.id"] =
11021476687dSEd Tanous                                 (*schemaItem)["@odata.id"];
11031476687dSEd Tanous                             redfishCollection.emplace_back(
11048a592810SEd Tanous                                 std::move(collectionId));
11058bd25ccdSJames Feist                         }
11068bd25ccdSJames Feist                         else
11078bd25ccdSJames Feist                         {
1108002d39b4SEd Tanous                             BMCWEB_LOG_ERROR << "failed to find fan in schema";
11098bd25ccdSJames Feist                             messages::internalError(
11108d1b46d7Szhanghch05                                 sensorsAsyncResp->asyncResp->res);
11118bd25ccdSJames Feist                             return;
11128bd25ccdSJames Feist                         }
11138bd25ccdSJames Feist                     }
11148bd25ccdSJames Feist 
111589492a15SPatrick Williams                     size_t minNumNeeded = collection->empty()
111626f6976fSEd Tanous                                               ? 0
111789492a15SPatrick Williams                                               : collection->size() -
111889492a15SPatrick Williams                                                     *allowedFailures;
1119002d39b4SEd Tanous                     nlohmann::json& jResp = sensorsAsyncResp->asyncResp->res
11208bd25ccdSJames Feist                                                 .jsonValue["Redundancy"];
11211476687dSEd Tanous 
11221476687dSEd Tanous                     nlohmann::json::object_t redundancy;
1123eddfc437SWilly Tu                     boost::urls::url url = crow::utility::urlFromPieces(
1124eddfc437SWilly Tu                         "redfish", "v1", "Chassis", sensorsAsyncResp->chassisId,
1125eddfc437SWilly Tu                         sensorsAsyncResp->chassisSubNode);
1126eddfc437SWilly Tu                     url.set_fragment(("/Redundancy"_json_pointer / jResp.size())
1127eddfc437SWilly Tu                                          .to_string());
1128eddfc437SWilly Tu                     redundancy["@odata.id"] = std::move(url);
1129002d39b4SEd Tanous                     redundancy["@odata.type"] = "#Redundancy.v1_3_2.Redundancy";
11301476687dSEd Tanous                     redundancy["MinNumNeeded"] = minNumNeeded;
11311476687dSEd Tanous                     redundancy["Mode"] = "N+m";
11321476687dSEd Tanous                     redundancy["Name"] = name;
11331476687dSEd Tanous                     redundancy["RedundancySet"] = redfishCollection;
11341476687dSEd Tanous                     redundancy["Status"]["Health"] = health;
11351476687dSEd Tanous                     redundancy["Status"]["State"] = "Enabled";
11361476687dSEd Tanous 
1137*b2ba3072SPatrick Williams                     jResp.emplace_back(std::move(redundancy));
113886d89ed7SKrzysztof Grobelny                     });
11391e1e598dSJonathan Doman                 });
11408bd25ccdSJames Feist         }
1141e99073f5SGeorge Liu         });
11428bd25ccdSJames Feist }
11438bd25ccdSJames Feist 
1144b5a76932SEd Tanous inline void
114581ce609eSEd Tanous     sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
114649c53ac9SJohnathan Mantey {
11478d1b46d7Szhanghch05     nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue;
114849c53ac9SJohnathan Mantey     std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"};
114981ce609eSEd Tanous     if (sensorsAsyncResp->chassisSubNode == sensors::node::power)
115049c53ac9SJohnathan Mantey     {
115149c53ac9SJohnathan Mantey         sensorHeaders = {"Voltages", "PowerSupplies"};
115249c53ac9SJohnathan Mantey     }
115349c53ac9SJohnathan Mantey     for (const std::string& sensorGroup : sensorHeaders)
115449c53ac9SJohnathan Mantey     {
115549c53ac9SJohnathan Mantey         nlohmann::json::iterator entry = response.find(sensorGroup);
115649c53ac9SJohnathan Mantey         if (entry != response.end())
115749c53ac9SJohnathan Mantey         {
115849c53ac9SJohnathan Mantey             std::sort(entry->begin(), entry->end(),
115902cad96eSEd Tanous                       [](const nlohmann::json& c1, const nlohmann::json& c2) {
116049c53ac9SJohnathan Mantey                 return c1["Name"] < c2["Name"];
116149c53ac9SJohnathan Mantey             });
116249c53ac9SJohnathan Mantey 
116349c53ac9SJohnathan Mantey             // add the index counts to the end of each entry
116449c53ac9SJohnathan Mantey             size_t count = 0;
116549c53ac9SJohnathan Mantey             for (nlohmann::json& sensorJson : *entry)
116649c53ac9SJohnathan Mantey             {
116749c53ac9SJohnathan Mantey                 nlohmann::json::iterator odata = sensorJson.find("@odata.id");
116849c53ac9SJohnathan Mantey                 if (odata == sensorJson.end())
116949c53ac9SJohnathan Mantey                 {
117049c53ac9SJohnathan Mantey                     continue;
117149c53ac9SJohnathan Mantey                 }
117249c53ac9SJohnathan Mantey                 std::string* value = odata->get_ptr<std::string*>();
117349c53ac9SJohnathan Mantey                 if (value != nullptr)
117449c53ac9SJohnathan Mantey                 {
1175eddfc437SWilly Tu                     *value += "/" + std::to_string(count);
11763e35c761SGeorge Liu                     sensorJson["MemberId"] = std::to_string(count);
117749c53ac9SJohnathan Mantey                     count++;
117881ce609eSEd Tanous                     sensorsAsyncResp->updateUri(sensorJson["Name"], *value);
117949c53ac9SJohnathan Mantey                 }
118049c53ac9SJohnathan Mantey             }
118149c53ac9SJohnathan Mantey         }
118249c53ac9SJohnathan Mantey     }
118349c53ac9SJohnathan Mantey }
118449c53ac9SJohnathan Mantey 
118508777fb0SLewanczyk, Dawid /**
1186adc4f0dbSShawn McCarney  * @brief Finds the inventory item with the specified object path.
1187adc4f0dbSShawn McCarney  * @param inventoryItems D-Bus inventory items associated with sensors.
1188adc4f0dbSShawn McCarney  * @param invItemObjPath D-Bus object path of inventory item.
1189adc4f0dbSShawn McCarney  * @return Inventory item within vector, or nullptr if no match found.
11908fb49dd6SShawn McCarney  */
119123a21a1cSEd Tanous inline InventoryItem* findInventoryItem(
1192b5a76932SEd Tanous     const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
1193adc4f0dbSShawn McCarney     const std::string& invItemObjPath)
11948fb49dd6SShawn McCarney {
1195adc4f0dbSShawn McCarney     for (InventoryItem& inventoryItem : *inventoryItems)
11968fb49dd6SShawn McCarney     {
1197adc4f0dbSShawn McCarney         if (inventoryItem.objectPath == invItemObjPath)
11988fb49dd6SShawn McCarney         {
1199adc4f0dbSShawn McCarney             return &inventoryItem;
12008fb49dd6SShawn McCarney         }
12018fb49dd6SShawn McCarney     }
12028fb49dd6SShawn McCarney     return nullptr;
12038fb49dd6SShawn McCarney }
12048fb49dd6SShawn McCarney 
12058fb49dd6SShawn McCarney /**
1206adc4f0dbSShawn McCarney  * @brief Finds the inventory item associated with the specified sensor.
1207adc4f0dbSShawn McCarney  * @param inventoryItems D-Bus inventory items associated with sensors.
1208adc4f0dbSShawn McCarney  * @param sensorObjPath D-Bus object path of sensor.
1209adc4f0dbSShawn McCarney  * @return Inventory item within vector, or nullptr if no match found.
12108fb49dd6SShawn McCarney  */
121123a21a1cSEd Tanous inline InventoryItem* findInventoryItemForSensor(
1212b5a76932SEd Tanous     const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
1213adc4f0dbSShawn McCarney     const std::string& sensorObjPath)
1214adc4f0dbSShawn McCarney {
1215adc4f0dbSShawn McCarney     for (InventoryItem& inventoryItem : *inventoryItems)
1216adc4f0dbSShawn McCarney     {
1217adc4f0dbSShawn McCarney         if (inventoryItem.sensors.count(sensorObjPath) > 0)
1218adc4f0dbSShawn McCarney         {
1219adc4f0dbSShawn McCarney             return &inventoryItem;
1220adc4f0dbSShawn McCarney         }
1221adc4f0dbSShawn McCarney     }
1222adc4f0dbSShawn McCarney     return nullptr;
1223adc4f0dbSShawn McCarney }
1224adc4f0dbSShawn McCarney 
1225adc4f0dbSShawn McCarney /**
1226d500549bSAnthony Wilson  * @brief Finds the inventory item associated with the specified led path.
1227d500549bSAnthony Wilson  * @param inventoryItems D-Bus inventory items associated with sensors.
1228d500549bSAnthony Wilson  * @param ledObjPath D-Bus object path of led.
1229d500549bSAnthony Wilson  * @return Inventory item within vector, or nullptr if no match found.
1230d500549bSAnthony Wilson  */
1231d500549bSAnthony Wilson inline InventoryItem*
1232d500549bSAnthony Wilson     findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems,
1233d500549bSAnthony Wilson                             const std::string& ledObjPath)
1234d500549bSAnthony Wilson {
1235d500549bSAnthony Wilson     for (InventoryItem& inventoryItem : inventoryItems)
1236d500549bSAnthony Wilson     {
1237d500549bSAnthony Wilson         if (inventoryItem.ledObjectPath == ledObjPath)
1238d500549bSAnthony Wilson         {
1239d500549bSAnthony Wilson             return &inventoryItem;
1240d500549bSAnthony Wilson         }
1241d500549bSAnthony Wilson     }
1242d500549bSAnthony Wilson     return nullptr;
1243d500549bSAnthony Wilson }
1244d500549bSAnthony Wilson 
1245d500549bSAnthony Wilson /**
1246adc4f0dbSShawn McCarney  * @brief Adds inventory item and associated sensor to specified vector.
1247adc4f0dbSShawn McCarney  *
1248adc4f0dbSShawn McCarney  * Adds a new InventoryItem to the vector if necessary.  Searches for an
1249adc4f0dbSShawn McCarney  * existing InventoryItem with the specified object path.  If not found, one is
1250adc4f0dbSShawn McCarney  * added to the vector.
1251adc4f0dbSShawn McCarney  *
1252adc4f0dbSShawn McCarney  * Next, the specified sensor is added to the set of sensors associated with the
1253adc4f0dbSShawn McCarney  * InventoryItem.
1254adc4f0dbSShawn McCarney  *
1255adc4f0dbSShawn McCarney  * @param inventoryItems D-Bus inventory items associated with sensors.
1256adc4f0dbSShawn McCarney  * @param invItemObjPath D-Bus object path of inventory item.
1257adc4f0dbSShawn McCarney  * @param sensorObjPath D-Bus object path of sensor
1258adc4f0dbSShawn McCarney  */
1259b5a76932SEd Tanous inline void addInventoryItem(
1260b5a76932SEd Tanous     const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
1261b5a76932SEd Tanous     const std::string& invItemObjPath, const std::string& sensorObjPath)
1262adc4f0dbSShawn McCarney {
1263adc4f0dbSShawn McCarney     // Look for inventory item in vector
126489492a15SPatrick Williams     InventoryItem* inventoryItem = findInventoryItem(inventoryItems,
126589492a15SPatrick Williams                                                      invItemObjPath);
1266adc4f0dbSShawn McCarney 
1267adc4f0dbSShawn McCarney     // If inventory item doesn't exist in vector, add it
1268adc4f0dbSShawn McCarney     if (inventoryItem == nullptr)
1269adc4f0dbSShawn McCarney     {
1270adc4f0dbSShawn McCarney         inventoryItems->emplace_back(invItemObjPath);
1271adc4f0dbSShawn McCarney         inventoryItem = &(inventoryItems->back());
1272adc4f0dbSShawn McCarney     }
1273adc4f0dbSShawn McCarney 
1274adc4f0dbSShawn McCarney     // Add sensor to set of sensors associated with inventory item
1275adc4f0dbSShawn McCarney     inventoryItem->sensors.emplace(sensorObjPath);
1276adc4f0dbSShawn McCarney }
1277adc4f0dbSShawn McCarney 
1278adc4f0dbSShawn McCarney /**
1279adc4f0dbSShawn McCarney  * @brief Stores D-Bus data in the specified inventory item.
1280adc4f0dbSShawn McCarney  *
1281adc4f0dbSShawn McCarney  * Finds D-Bus data in the specified map of interfaces.  Stores the data in the
1282adc4f0dbSShawn McCarney  * specified InventoryItem.
1283adc4f0dbSShawn McCarney  *
1284adc4f0dbSShawn McCarney  * This data is later used to provide sensor property values in the JSON
1285adc4f0dbSShawn McCarney  * response.
1286adc4f0dbSShawn McCarney  *
1287adc4f0dbSShawn McCarney  * @param inventoryItem Inventory item where data will be stored.
1288adc4f0dbSShawn McCarney  * @param interfacesDict Map containing D-Bus interfaces and their properties
1289adc4f0dbSShawn McCarney  * for the specified inventory item.
1290adc4f0dbSShawn McCarney  */
129123a21a1cSEd Tanous inline void storeInventoryItemData(
1292adc4f0dbSShawn McCarney     InventoryItem& inventoryItem,
1293711ac7a9SEd Tanous     const dbus::utility::DBusInteracesMap& interfacesDict)
12948fb49dd6SShawn McCarney {
1295adc4f0dbSShawn McCarney     // Get properties from Inventory.Item interface
1296711ac7a9SEd Tanous 
12979eb808c1SEd Tanous     for (const auto& [interface, values] : interfacesDict)
12988fb49dd6SShawn McCarney     {
1299711ac7a9SEd Tanous         if (interface == "xyz.openbmc_project.Inventory.Item")
13008fb49dd6SShawn McCarney         {
13019eb808c1SEd Tanous             for (const auto& [name, dbusValue] : values)
1302711ac7a9SEd Tanous             {
1303711ac7a9SEd Tanous                 if (name == "Present")
1304711ac7a9SEd Tanous                 {
1305711ac7a9SEd Tanous                     const bool* value = std::get_if<bool>(&dbusValue);
1306adc4f0dbSShawn McCarney                     if (value != nullptr)
13078fb49dd6SShawn McCarney                     {
1308adc4f0dbSShawn McCarney                         inventoryItem.isPresent = *value;
13098fb49dd6SShawn McCarney                     }
13108fb49dd6SShawn McCarney                 }
13118fb49dd6SShawn McCarney             }
1312711ac7a9SEd Tanous         }
1313adc4f0dbSShawn McCarney         // Check if Inventory.Item.PowerSupply interface is present
1314711ac7a9SEd Tanous 
1315711ac7a9SEd Tanous         if (interface == "xyz.openbmc_project.Inventory.Item.PowerSupply")
13168fb49dd6SShawn McCarney         {
1317adc4f0dbSShawn McCarney             inventoryItem.isPowerSupply = true;
13188fb49dd6SShawn McCarney         }
1319adc4f0dbSShawn McCarney 
1320adc4f0dbSShawn McCarney         // Get properties from Inventory.Decorator.Asset interface
1321711ac7a9SEd Tanous         if (interface == "xyz.openbmc_project.Inventory.Decorator.Asset")
1322adc4f0dbSShawn McCarney         {
13239eb808c1SEd Tanous             for (const auto& [name, dbusValue] : values)
1324711ac7a9SEd Tanous             {
1325711ac7a9SEd Tanous                 if (name == "Manufacturer")
1326adc4f0dbSShawn McCarney                 {
1327adc4f0dbSShawn McCarney                     const std::string* value =
1328711ac7a9SEd Tanous                         std::get_if<std::string>(&dbusValue);
1329adc4f0dbSShawn McCarney                     if (value != nullptr)
1330adc4f0dbSShawn McCarney                     {
1331adc4f0dbSShawn McCarney                         inventoryItem.manufacturer = *value;
1332adc4f0dbSShawn McCarney                     }
1333adc4f0dbSShawn McCarney                 }
1334711ac7a9SEd Tanous                 if (name == "Model")
1335adc4f0dbSShawn McCarney                 {
1336adc4f0dbSShawn McCarney                     const std::string* value =
1337711ac7a9SEd Tanous                         std::get_if<std::string>(&dbusValue);
1338adc4f0dbSShawn McCarney                     if (value != nullptr)
1339adc4f0dbSShawn McCarney                     {
1340adc4f0dbSShawn McCarney                         inventoryItem.model = *value;
1341adc4f0dbSShawn McCarney                     }
1342adc4f0dbSShawn McCarney                 }
1343711ac7a9SEd Tanous                 if (name == "SerialNumber")
1344adc4f0dbSShawn McCarney                 {
1345adc4f0dbSShawn McCarney                     const std::string* value =
1346711ac7a9SEd Tanous                         std::get_if<std::string>(&dbusValue);
1347adc4f0dbSShawn McCarney                     if (value != nullptr)
1348adc4f0dbSShawn McCarney                     {
1349adc4f0dbSShawn McCarney                         inventoryItem.serialNumber = *value;
1350adc4f0dbSShawn McCarney                     }
1351adc4f0dbSShawn McCarney                 }
1352711ac7a9SEd Tanous                 if (name == "PartNumber")
1353711ac7a9SEd Tanous                 {
1354711ac7a9SEd Tanous                     const std::string* value =
1355711ac7a9SEd Tanous                         std::get_if<std::string>(&dbusValue);
1356711ac7a9SEd Tanous                     if (value != nullptr)
1357711ac7a9SEd Tanous                     {
1358711ac7a9SEd Tanous                         inventoryItem.partNumber = *value;
1359711ac7a9SEd Tanous                     }
1360711ac7a9SEd Tanous                 }
1361711ac7a9SEd Tanous             }
1362adc4f0dbSShawn McCarney         }
1363adc4f0dbSShawn McCarney 
1364711ac7a9SEd Tanous         if (interface ==
1365711ac7a9SEd Tanous             "xyz.openbmc_project.State.Decorator.OperationalStatus")
1366adc4f0dbSShawn McCarney         {
13679eb808c1SEd Tanous             for (const auto& [name, dbusValue] : values)
1368adc4f0dbSShawn McCarney             {
1369711ac7a9SEd Tanous                 if (name == "Functional")
1370711ac7a9SEd Tanous                 {
1371711ac7a9SEd Tanous                     const bool* value = std::get_if<bool>(&dbusValue);
1372adc4f0dbSShawn McCarney                     if (value != nullptr)
1373adc4f0dbSShawn McCarney                     {
1374adc4f0dbSShawn McCarney                         inventoryItem.isFunctional = *value;
13758fb49dd6SShawn McCarney                     }
13768fb49dd6SShawn McCarney                 }
13778fb49dd6SShawn McCarney             }
13788fb49dd6SShawn McCarney         }
1379711ac7a9SEd Tanous     }
1380711ac7a9SEd Tanous }
13818fb49dd6SShawn McCarney 
13828fb49dd6SShawn McCarney /**
1383adc4f0dbSShawn McCarney  * @brief Gets D-Bus data for inventory items associated with sensors.
13848fb49dd6SShawn McCarney  *
1385adc4f0dbSShawn McCarney  * Uses the specified connections (services) to obtain D-Bus data for inventory
1386adc4f0dbSShawn McCarney  * items associated with sensors.  Stores the resulting data in the
1387adc4f0dbSShawn McCarney  * inventoryItems vector.
13888fb49dd6SShawn McCarney  *
1389adc4f0dbSShawn McCarney  * This data is later used to provide sensor property values in the JSON
1390adc4f0dbSShawn McCarney  * response.
1391adc4f0dbSShawn McCarney  *
1392adc4f0dbSShawn McCarney  * Finds the inventory item data asynchronously.  Invokes callback when data has
1393adc4f0dbSShawn McCarney  * been obtained.
1394adc4f0dbSShawn McCarney  *
1395adc4f0dbSShawn McCarney  * The callback must have the following signature:
1396adc4f0dbSShawn McCarney  *   @code
1397d500549bSAnthony Wilson  *   callback(void)
1398adc4f0dbSShawn McCarney  *   @endcode
1399adc4f0dbSShawn McCarney  *
1400adc4f0dbSShawn McCarney  * This function is called recursively, obtaining data asynchronously from one
1401adc4f0dbSShawn McCarney  * connection in each call.  This ensures the callback is not invoked until the
1402adc4f0dbSShawn McCarney  * last asynchronous function has completed.
14038fb49dd6SShawn McCarney  *
14048fb49dd6SShawn McCarney  * @param sensorsAsyncResp Pointer to object holding response data.
1405adc4f0dbSShawn McCarney  * @param inventoryItems D-Bus inventory items associated with sensors.
1406adc4f0dbSShawn McCarney  * @param invConnections Connections that provide data for the inventory items.
14078fb49dd6SShawn McCarney  * implements ObjectManager.
1408adc4f0dbSShawn McCarney  * @param callback Callback to invoke when inventory data has been obtained.
1409adc4f0dbSShawn McCarney  * @param invConnectionsIndex Current index in invConnections.  Only specified
1410adc4f0dbSShawn McCarney  * in recursive calls to this function.
14118fb49dd6SShawn McCarney  */
1412adc4f0dbSShawn McCarney template <typename Callback>
1413adc4f0dbSShawn McCarney static void getInventoryItemsData(
14148fb49dd6SShawn McCarney     std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1415adc4f0dbSShawn McCarney     std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1416d0090733SEd Tanous     std::shared_ptr<std::set<std::string>> invConnections, Callback&& callback,
1417d0090733SEd Tanous     size_t invConnectionsIndex = 0)
14188fb49dd6SShawn McCarney {
1419adc4f0dbSShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItemsData enter";
14208fb49dd6SShawn McCarney 
1421adc4f0dbSShawn McCarney     // If no more connections left, call callback
1422adc4f0dbSShawn McCarney     if (invConnectionsIndex >= invConnections->size())
14238fb49dd6SShawn McCarney     {
1424d500549bSAnthony Wilson         callback();
1425adc4f0dbSShawn McCarney         BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
1426adc4f0dbSShawn McCarney         return;
1427adc4f0dbSShawn McCarney     }
1428adc4f0dbSShawn McCarney 
1429adc4f0dbSShawn McCarney     // Get inventory item data from current connection
1430fe04d49cSNan Zhou     auto it = invConnections->begin();
1431fe04d49cSNan Zhou     std::advance(it, invConnectionsIndex);
1432adc4f0dbSShawn McCarney     if (it != invConnections->end())
1433adc4f0dbSShawn McCarney     {
1434adc4f0dbSShawn McCarney         const std::string& invConnection = *it;
1435adc4f0dbSShawn McCarney 
14368fb49dd6SShawn McCarney         // Response handler for GetManagedObjects
1437d0090733SEd Tanous         auto respHandler = [sensorsAsyncResp, inventoryItems, invConnections,
1438d0090733SEd Tanous                             callback{std::forward<Callback>(callback)},
1439d0090733SEd Tanous                             invConnectionsIndex](
14405e7e2dc5SEd Tanous                                const boost::system::error_code& ec,
144102cad96eSEd Tanous                                const dbus::utility::ManagedObjectType& resp) {
1442adc4f0dbSShawn McCarney             BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter";
14438fb49dd6SShawn McCarney             if (ec)
14448fb49dd6SShawn McCarney             {
14458fb49dd6SShawn McCarney                 BMCWEB_LOG_ERROR
1446adc4f0dbSShawn McCarney                     << "getInventoryItemsData respHandler DBus error " << ec;
14478d1b46d7Szhanghch05                 messages::internalError(sensorsAsyncResp->asyncResp->res);
14488fb49dd6SShawn McCarney                 return;
14498fb49dd6SShawn McCarney             }
14508fb49dd6SShawn McCarney 
14518fb49dd6SShawn McCarney             // Loop through returned object paths
14528fb49dd6SShawn McCarney             for (const auto& objDictEntry : resp)
14538fb49dd6SShawn McCarney             {
14548fb49dd6SShawn McCarney                 const std::string& objPath =
14558fb49dd6SShawn McCarney                     static_cast<const std::string&>(objDictEntry.first);
14568fb49dd6SShawn McCarney 
1457adc4f0dbSShawn McCarney                 // If this object path is one of the specified inventory items
145889492a15SPatrick Williams                 InventoryItem* inventoryItem = findInventoryItem(inventoryItems,
145989492a15SPatrick Williams                                                                  objPath);
1460adc4f0dbSShawn McCarney                 if (inventoryItem != nullptr)
14618fb49dd6SShawn McCarney                 {
1462adc4f0dbSShawn McCarney                     // Store inventory data in InventoryItem
1463adc4f0dbSShawn McCarney                     storeInventoryItemData(*inventoryItem, objDictEntry.second);
14648fb49dd6SShawn McCarney                 }
14658fb49dd6SShawn McCarney             }
14668fb49dd6SShawn McCarney 
1467adc4f0dbSShawn McCarney             // Recurse to get inventory item data from next connection
1468adc4f0dbSShawn McCarney             getInventoryItemsData(sensorsAsyncResp, inventoryItems,
1469d0090733SEd Tanous                                   invConnections, std::move(callback),
1470d0090733SEd Tanous                                   invConnectionsIndex + 1);
1471adc4f0dbSShawn McCarney 
1472adc4f0dbSShawn McCarney             BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit";
14738fb49dd6SShawn McCarney         };
14748fb49dd6SShawn McCarney 
14758fb49dd6SShawn McCarney         // Get all object paths and their interfaces for current connection
14768fb49dd6SShawn McCarney         crow::connections::systemBus->async_method_call(
1477d0090733SEd Tanous             std::move(respHandler), invConnection,
1478f8bb0ff3SEd Tanous             "/xyz/openbmc_project/inventory",
14798fb49dd6SShawn McCarney             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
14808fb49dd6SShawn McCarney     }
14818fb49dd6SShawn McCarney 
1482adc4f0dbSShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
14838fb49dd6SShawn McCarney }
14848fb49dd6SShawn McCarney 
14858fb49dd6SShawn McCarney /**
1486adc4f0dbSShawn McCarney  * @brief Gets connections that provide D-Bus data for inventory items.
14878fb49dd6SShawn McCarney  *
1488adc4f0dbSShawn McCarney  * Gets the D-Bus connections (services) that provide data for the inventory
1489adc4f0dbSShawn McCarney  * items that are associated with sensors.
14908fb49dd6SShawn McCarney  *
14918fb49dd6SShawn McCarney  * Finds the connections asynchronously.  Invokes callback when information has
14928fb49dd6SShawn McCarney  * been obtained.
14938fb49dd6SShawn McCarney  *
14948fb49dd6SShawn McCarney  * The callback must have the following signature:
14958fb49dd6SShawn McCarney  *   @code
1496fe04d49cSNan Zhou  *   callback(std::shared_ptr<std::set<std::string>> invConnections)
14978fb49dd6SShawn McCarney  *   @endcode
14988fb49dd6SShawn McCarney  *
14998fb49dd6SShawn McCarney  * @param sensorsAsyncResp Pointer to object holding response data.
1500adc4f0dbSShawn McCarney  * @param inventoryItems D-Bus inventory items associated with sensors.
15018fb49dd6SShawn McCarney  * @param callback Callback to invoke when connections have been obtained.
15028fb49dd6SShawn McCarney  */
15038fb49dd6SShawn McCarney template <typename Callback>
15048fb49dd6SShawn McCarney static void getInventoryItemsConnections(
1505b5a76932SEd Tanous     const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
1506b5a76932SEd Tanous     const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
15078fb49dd6SShawn McCarney     Callback&& callback)
15088fb49dd6SShawn McCarney {
15098fb49dd6SShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter";
15108fb49dd6SShawn McCarney 
15118fb49dd6SShawn McCarney     const std::string path = "/xyz/openbmc_project/inventory";
1512e99073f5SGeorge Liu     constexpr std::array<std::string_view, 4> interfaces = {
15138fb49dd6SShawn McCarney         "xyz.openbmc_project.Inventory.Item",
1514adc4f0dbSShawn McCarney         "xyz.openbmc_project.Inventory.Item.PowerSupply",
1515adc4f0dbSShawn McCarney         "xyz.openbmc_project.Inventory.Decorator.Asset",
15168fb49dd6SShawn McCarney         "xyz.openbmc_project.State.Decorator.OperationalStatus"};
15178fb49dd6SShawn McCarney 
1518e99073f5SGeorge Liu     // Make call to ObjectMapper to find all inventory items
1519e99073f5SGeorge Liu     dbus::utility::getSubTree(
1520e99073f5SGeorge Liu         path, 0, interfaces,
1521002d39b4SEd Tanous         [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1522002d39b4SEd Tanous          inventoryItems](
1523e99073f5SGeorge Liu             const boost::system::error_code& ec,
1524002d39b4SEd Tanous             const dbus::utility::MapperGetSubTreeResponse& subtree) {
1525e99073f5SGeorge Liu         // Response handler for parsing output from GetSubTree
15268fb49dd6SShawn McCarney         BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter";
15278fb49dd6SShawn McCarney         if (ec)
15288fb49dd6SShawn McCarney         {
15298d1b46d7Szhanghch05             messages::internalError(sensorsAsyncResp->asyncResp->res);
15308fb49dd6SShawn McCarney             BMCWEB_LOG_ERROR
15318fb49dd6SShawn McCarney                 << "getInventoryItemsConnections respHandler DBus error " << ec;
15328fb49dd6SShawn McCarney             return;
15338fb49dd6SShawn McCarney         }
15348fb49dd6SShawn McCarney 
15358fb49dd6SShawn McCarney         // Make unique list of connections for desired inventory items
1536fe04d49cSNan Zhou         std::shared_ptr<std::set<std::string>> invConnections =
1537fe04d49cSNan Zhou             std::make_shared<std::set<std::string>>();
15388fb49dd6SShawn McCarney 
15398fb49dd6SShawn McCarney         // Loop through objects from GetSubTree
15408fb49dd6SShawn McCarney         for (const std::pair<
15418fb49dd6SShawn McCarney                  std::string,
15428fb49dd6SShawn McCarney                  std::vector<std::pair<std::string, std::vector<std::string>>>>&
15438fb49dd6SShawn McCarney                  object : subtree)
15448fb49dd6SShawn McCarney         {
1545adc4f0dbSShawn McCarney             // Check if object path is one of the specified inventory items
15468fb49dd6SShawn McCarney             const std::string& objPath = object.first;
1547adc4f0dbSShawn McCarney             if (findInventoryItem(inventoryItems, objPath) != nullptr)
15488fb49dd6SShawn McCarney             {
15498fb49dd6SShawn McCarney                 // Store all connections to inventory item
15508fb49dd6SShawn McCarney                 for (const std::pair<std::string, std::vector<std::string>>&
15518fb49dd6SShawn McCarney                          objData : object.second)
15528fb49dd6SShawn McCarney                 {
15538fb49dd6SShawn McCarney                     const std::string& invConnection = objData.first;
15548fb49dd6SShawn McCarney                     invConnections->insert(invConnection);
15558fb49dd6SShawn McCarney                 }
15568fb49dd6SShawn McCarney             }
15578fb49dd6SShawn McCarney         }
1558d500549bSAnthony Wilson 
15598fb49dd6SShawn McCarney         callback(invConnections);
15608fb49dd6SShawn McCarney         BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit";
1561e99073f5SGeorge Liu         });
15628fb49dd6SShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit";
15638fb49dd6SShawn McCarney }
15648fb49dd6SShawn McCarney 
15658fb49dd6SShawn McCarney /**
1566adc4f0dbSShawn McCarney  * @brief Gets associations from sensors to inventory items.
15678fb49dd6SShawn McCarney  *
15688fb49dd6SShawn McCarney  * Looks for ObjectMapper associations from the specified sensors to related
1569d500549bSAnthony Wilson  * inventory items. Then finds the associations from those inventory items to
1570d500549bSAnthony Wilson  * their LEDs, if any.
15718fb49dd6SShawn McCarney  *
15728fb49dd6SShawn McCarney  * Finds the inventory items asynchronously.  Invokes callback when information
15738fb49dd6SShawn McCarney  * has been obtained.
15748fb49dd6SShawn McCarney  *
15758fb49dd6SShawn McCarney  * The callback must have the following signature:
15768fb49dd6SShawn McCarney  *   @code
1577adc4f0dbSShawn McCarney  *   callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
15788fb49dd6SShawn McCarney  *   @endcode
15798fb49dd6SShawn McCarney  *
15808fb49dd6SShawn McCarney  * @param sensorsAsyncResp Pointer to object holding response data.
15818fb49dd6SShawn McCarney  * @param sensorNames All sensors within the current chassis.
15828fb49dd6SShawn McCarney  * implements ObjectManager.
15838fb49dd6SShawn McCarney  * @param callback Callback to invoke when inventory items have been obtained.
15848fb49dd6SShawn McCarney  */
15858fb49dd6SShawn McCarney template <typename Callback>
1586adc4f0dbSShawn McCarney static void getInventoryItemAssociations(
1587b5a76932SEd Tanous     const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
1588fe04d49cSNan Zhou     const std::shared_ptr<std::set<std::string>>& sensorNames,
15898fb49dd6SShawn McCarney     Callback&& callback)
15908fb49dd6SShawn McCarney {
1591adc4f0dbSShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter";
15928fb49dd6SShawn McCarney 
15938fb49dd6SShawn McCarney     // Response handler for GetManagedObjects
159402cad96eSEd Tanous     auto respHandler =
159502cad96eSEd Tanous         [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
15965e7e2dc5SEd Tanous          sensorNames](const boost::system::error_code& ec,
159702cad96eSEd Tanous                       const dbus::utility::ManagedObjectType& resp) {
1598adc4f0dbSShawn McCarney         BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter";
15998fb49dd6SShawn McCarney         if (ec)
16008fb49dd6SShawn McCarney         {
1601adc4f0dbSShawn McCarney             BMCWEB_LOG_ERROR
1602adc4f0dbSShawn McCarney                 << "getInventoryItemAssociations respHandler DBus error " << ec;
16038d1b46d7Szhanghch05             messages::internalError(sensorsAsyncResp->asyncResp->res);
16048fb49dd6SShawn McCarney             return;
16058fb49dd6SShawn McCarney         }
16068fb49dd6SShawn McCarney 
1607adc4f0dbSShawn McCarney         // Create vector to hold list of inventory items
1608adc4f0dbSShawn McCarney         std::shared_ptr<std::vector<InventoryItem>> inventoryItems =
1609adc4f0dbSShawn McCarney             std::make_shared<std::vector<InventoryItem>>();
1610adc4f0dbSShawn McCarney 
16118fb49dd6SShawn McCarney         // Loop through returned object paths
16128fb49dd6SShawn McCarney         std::string sensorAssocPath;
16138fb49dd6SShawn McCarney         sensorAssocPath.reserve(128); // avoid memory allocations
16148fb49dd6SShawn McCarney         for (const auto& objDictEntry : resp)
16158fb49dd6SShawn McCarney         {
16168fb49dd6SShawn McCarney             const std::string& objPath =
16178fb49dd6SShawn McCarney                 static_cast<const std::string&>(objDictEntry.first);
16188fb49dd6SShawn McCarney 
16198fb49dd6SShawn McCarney             // If path is inventory association for one of the specified sensors
16208fb49dd6SShawn McCarney             for (const std::string& sensorName : *sensorNames)
16218fb49dd6SShawn McCarney             {
16228fb49dd6SShawn McCarney                 sensorAssocPath = sensorName;
16238fb49dd6SShawn McCarney                 sensorAssocPath += "/inventory";
16248fb49dd6SShawn McCarney                 if (objPath == sensorAssocPath)
16258fb49dd6SShawn McCarney                 {
16268fb49dd6SShawn McCarney                     // Get Association interface for object path
1627711ac7a9SEd Tanous                     for (const auto& [interface, values] : objDictEntry.second)
16288fb49dd6SShawn McCarney                     {
1629711ac7a9SEd Tanous                         if (interface == "xyz.openbmc_project.Association")
1630711ac7a9SEd Tanous                         {
1631711ac7a9SEd Tanous                             for (const auto& [valueName, value] : values)
1632711ac7a9SEd Tanous                             {
1633711ac7a9SEd Tanous                                 if (valueName == "endpoints")
16348fb49dd6SShawn McCarney                                 {
16358fb49dd6SShawn McCarney                                     const std::vector<std::string>* endpoints =
16368fb49dd6SShawn McCarney                                         std::get_if<std::vector<std::string>>(
1637711ac7a9SEd Tanous                                             &value);
1638711ac7a9SEd Tanous                                     if ((endpoints != nullptr) &&
1639711ac7a9SEd Tanous                                         !endpoints->empty())
16408fb49dd6SShawn McCarney                                     {
1641adc4f0dbSShawn McCarney                                         // Add inventory item to vector
1642adc4f0dbSShawn McCarney                                         const std::string& invItemPath =
1643adc4f0dbSShawn McCarney                                             endpoints->front();
1644711ac7a9SEd Tanous                                         addInventoryItem(inventoryItems,
1645711ac7a9SEd Tanous                                                          invItemPath,
1646adc4f0dbSShawn McCarney                                                          sensorName);
16478fb49dd6SShawn McCarney                                     }
16488fb49dd6SShawn McCarney                                 }
16498fb49dd6SShawn McCarney                             }
1650711ac7a9SEd Tanous                         }
1651711ac7a9SEd Tanous                     }
16528fb49dd6SShawn McCarney                     break;
16538fb49dd6SShawn McCarney                 }
16548fb49dd6SShawn McCarney             }
16558fb49dd6SShawn McCarney         }
16568fb49dd6SShawn McCarney 
1657d500549bSAnthony Wilson         // Now loop through the returned object paths again, this time to
1658d500549bSAnthony Wilson         // find the leds associated with the inventory items we just found
1659d500549bSAnthony Wilson         std::string inventoryAssocPath;
1660d500549bSAnthony Wilson         inventoryAssocPath.reserve(128); // avoid memory allocations
1661d500549bSAnthony Wilson         for (const auto& objDictEntry : resp)
1662d500549bSAnthony Wilson         {
1663d500549bSAnthony Wilson             const std::string& objPath =
1664d500549bSAnthony Wilson                 static_cast<const std::string&>(objDictEntry.first);
1665d500549bSAnthony Wilson 
1666d500549bSAnthony Wilson             for (InventoryItem& inventoryItem : *inventoryItems)
1667d500549bSAnthony Wilson             {
1668d500549bSAnthony Wilson                 inventoryAssocPath = inventoryItem.objectPath;
1669d500549bSAnthony Wilson                 inventoryAssocPath += "/leds";
1670d500549bSAnthony Wilson                 if (objPath == inventoryAssocPath)
1671d500549bSAnthony Wilson                 {
1672711ac7a9SEd Tanous                     for (const auto& [interface, values] : objDictEntry.second)
1673d500549bSAnthony Wilson                     {
1674711ac7a9SEd Tanous                         if (interface == "xyz.openbmc_project.Association")
1675711ac7a9SEd Tanous                         {
1676711ac7a9SEd Tanous                             for (const auto& [valueName, value] : values)
1677711ac7a9SEd Tanous                             {
1678711ac7a9SEd Tanous                                 if (valueName == "endpoints")
1679d500549bSAnthony Wilson                                 {
1680d500549bSAnthony Wilson                                     const std::vector<std::string>* endpoints =
1681d500549bSAnthony Wilson                                         std::get_if<std::vector<std::string>>(
1682711ac7a9SEd Tanous                                             &value);
1683711ac7a9SEd Tanous                                     if ((endpoints != nullptr) &&
1684711ac7a9SEd Tanous                                         !endpoints->empty())
1685d500549bSAnthony Wilson                                     {
1686711ac7a9SEd Tanous                                         // Add inventory item to vector
1687d500549bSAnthony Wilson                                         // Store LED path in inventory item
1688711ac7a9SEd Tanous                                         const std::string& ledPath =
1689711ac7a9SEd Tanous                                             endpoints->front();
1690d500549bSAnthony Wilson                                         inventoryItem.ledObjectPath = ledPath;
1691d500549bSAnthony Wilson                                     }
1692d500549bSAnthony Wilson                                 }
1693d500549bSAnthony Wilson                             }
1694711ac7a9SEd Tanous                         }
1695711ac7a9SEd Tanous                     }
1696711ac7a9SEd Tanous 
1697d500549bSAnthony Wilson                     break;
1698d500549bSAnthony Wilson                 }
1699d500549bSAnthony Wilson             }
1700d500549bSAnthony Wilson         }
1701adc4f0dbSShawn McCarney         callback(inventoryItems);
1702adc4f0dbSShawn McCarney         BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit";
17038fb49dd6SShawn McCarney     };
17048fb49dd6SShawn McCarney 
17058fb49dd6SShawn McCarney     // Call GetManagedObjects on the ObjectMapper to get all associations
17068fb49dd6SShawn McCarney     crow::connections::systemBus->async_method_call(
1707d0090733SEd Tanous         std::move(respHandler), "xyz.openbmc_project.ObjectMapper", "/",
17088fb49dd6SShawn McCarney         "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
17098fb49dd6SShawn McCarney 
1710adc4f0dbSShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit";
17118fb49dd6SShawn McCarney }
17128fb49dd6SShawn McCarney 
17138fb49dd6SShawn McCarney /**
1714d500549bSAnthony Wilson  * @brief Gets D-Bus data for inventory item leds associated with sensors.
1715d500549bSAnthony Wilson  *
1716d500549bSAnthony Wilson  * Uses the specified connections (services) to obtain D-Bus data for inventory
1717d500549bSAnthony Wilson  * item leds associated with sensors.  Stores the resulting data in the
1718d500549bSAnthony Wilson  * inventoryItems vector.
1719d500549bSAnthony Wilson  *
1720d500549bSAnthony Wilson  * This data is later used to provide sensor property values in the JSON
1721d500549bSAnthony Wilson  * response.
1722d500549bSAnthony Wilson  *
1723d500549bSAnthony Wilson  * Finds the inventory item led data asynchronously.  Invokes callback when data
1724d500549bSAnthony Wilson  * has been obtained.
1725d500549bSAnthony Wilson  *
1726d500549bSAnthony Wilson  * The callback must have the following signature:
1727d500549bSAnthony Wilson  *   @code
172842cbe538SGunnar Mills  *   callback()
1729d500549bSAnthony Wilson  *   @endcode
1730d500549bSAnthony Wilson  *
1731d500549bSAnthony Wilson  * This function is called recursively, obtaining data asynchronously from one
1732d500549bSAnthony Wilson  * connection in each call.  This ensures the callback is not invoked until the
1733d500549bSAnthony Wilson  * last asynchronous function has completed.
1734d500549bSAnthony Wilson  *
1735d500549bSAnthony Wilson  * @param sensorsAsyncResp Pointer to object holding response data.
1736d500549bSAnthony Wilson  * @param inventoryItems D-Bus inventory items associated with sensors.
1737d500549bSAnthony Wilson  * @param ledConnections Connections that provide data for the inventory leds.
1738d500549bSAnthony Wilson  * @param callback Callback to invoke when inventory data has been obtained.
1739d500549bSAnthony Wilson  * @param ledConnectionsIndex Current index in ledConnections.  Only specified
1740d500549bSAnthony Wilson  * in recursive calls to this function.
1741d500549bSAnthony Wilson  */
1742d500549bSAnthony Wilson template <typename Callback>
1743d500549bSAnthony Wilson void getInventoryLedData(
1744d500549bSAnthony Wilson     std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1745d500549bSAnthony Wilson     std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1746fe04d49cSNan Zhou     std::shared_ptr<std::map<std::string, std::string>> ledConnections,
1747d500549bSAnthony Wilson     Callback&& callback, size_t ledConnectionsIndex = 0)
1748d500549bSAnthony Wilson {
1749d500549bSAnthony Wilson     BMCWEB_LOG_DEBUG << "getInventoryLedData enter";
1750d500549bSAnthony Wilson 
1751d500549bSAnthony Wilson     // If no more connections left, call callback
1752d500549bSAnthony Wilson     if (ledConnectionsIndex >= ledConnections->size())
1753d500549bSAnthony Wilson     {
175442cbe538SGunnar Mills         callback();
1755d500549bSAnthony Wilson         BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
1756d500549bSAnthony Wilson         return;
1757d500549bSAnthony Wilson     }
1758d500549bSAnthony Wilson 
1759d500549bSAnthony Wilson     // Get inventory item data from current connection
1760fe04d49cSNan Zhou     auto it = ledConnections->begin();
1761fe04d49cSNan Zhou     std::advance(it, ledConnectionsIndex);
1762d500549bSAnthony Wilson     if (it != ledConnections->end())
1763d500549bSAnthony Wilson     {
1764d500549bSAnthony Wilson         const std::string& ledPath = (*it).first;
1765d500549bSAnthony Wilson         const std::string& ledConnection = (*it).second;
1766d500549bSAnthony Wilson         // Response handler for Get State property
17671e1e598dSJonathan Doman         auto respHandler =
17681e1e598dSJonathan Doman             [sensorsAsyncResp, inventoryItems, ledConnections, ledPath,
1769f94c4ecfSEd Tanous              callback{std::forward<Callback>(callback)}, ledConnectionsIndex](
17705e7e2dc5SEd Tanous                 const boost::system::error_code& ec, const std::string& state) {
1771d500549bSAnthony Wilson             BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter";
1772d500549bSAnthony Wilson             if (ec)
1773d500549bSAnthony Wilson             {
1774d500549bSAnthony Wilson                 BMCWEB_LOG_ERROR
1775d500549bSAnthony Wilson                     << "getInventoryLedData respHandler DBus error " << ec;
17768d1b46d7Szhanghch05                 messages::internalError(sensorsAsyncResp->asyncResp->res);
1777d500549bSAnthony Wilson                 return;
1778d500549bSAnthony Wilson             }
1779d500549bSAnthony Wilson 
17801e1e598dSJonathan Doman             BMCWEB_LOG_DEBUG << "Led state: " << state;
1781d500549bSAnthony Wilson             // Find inventory item with this LED object path
1782d500549bSAnthony Wilson             InventoryItem* inventoryItem =
1783d500549bSAnthony Wilson                 findInventoryItemForLed(*inventoryItems, ledPath);
1784d500549bSAnthony Wilson             if (inventoryItem != nullptr)
1785d500549bSAnthony Wilson             {
1786d500549bSAnthony Wilson                 // Store LED state in InventoryItem
178711ba3979SEd Tanous                 if (state.ends_with("On"))
1788d500549bSAnthony Wilson                 {
1789d500549bSAnthony Wilson                     inventoryItem->ledState = LedState::ON;
1790d500549bSAnthony Wilson                 }
179111ba3979SEd Tanous                 else if (state.ends_with("Blink"))
1792d500549bSAnthony Wilson                 {
1793d500549bSAnthony Wilson                     inventoryItem->ledState = LedState::BLINK;
1794d500549bSAnthony Wilson                 }
179511ba3979SEd Tanous                 else if (state.ends_with("Off"))
1796d500549bSAnthony Wilson                 {
1797d500549bSAnthony Wilson                     inventoryItem->ledState = LedState::OFF;
1798d500549bSAnthony Wilson                 }
1799d500549bSAnthony Wilson                 else
1800d500549bSAnthony Wilson                 {
1801d500549bSAnthony Wilson                     inventoryItem->ledState = LedState::UNKNOWN;
1802d500549bSAnthony Wilson                 }
1803d500549bSAnthony Wilson             }
1804d500549bSAnthony Wilson 
1805d500549bSAnthony Wilson             // Recurse to get LED data from next connection
1806d500549bSAnthony Wilson             getInventoryLedData(sensorsAsyncResp, inventoryItems,
1807d500549bSAnthony Wilson                                 ledConnections, std::move(callback),
1808d500549bSAnthony Wilson                                 ledConnectionsIndex + 1);
1809d500549bSAnthony Wilson 
1810d500549bSAnthony Wilson             BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit";
1811d500549bSAnthony Wilson         };
1812d500549bSAnthony Wilson 
1813d500549bSAnthony Wilson         // Get the State property for the current LED
18141e1e598dSJonathan Doman         sdbusplus::asio::getProperty<std::string>(
18151e1e598dSJonathan Doman             *crow::connections::systemBus, ledConnection, ledPath,
18161e1e598dSJonathan Doman             "xyz.openbmc_project.Led.Physical", "State",
18171e1e598dSJonathan Doman             std::move(respHandler));
1818d500549bSAnthony Wilson     }
1819d500549bSAnthony Wilson 
1820d500549bSAnthony Wilson     BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
1821d500549bSAnthony Wilson }
1822d500549bSAnthony Wilson 
1823d500549bSAnthony Wilson /**
1824d500549bSAnthony Wilson  * @brief Gets LED data for LEDs associated with given inventory items.
1825d500549bSAnthony Wilson  *
1826d500549bSAnthony Wilson  * Gets the D-Bus connections (services) that provide LED data for the LEDs
1827d500549bSAnthony Wilson  * associated with the specified inventory items.  Then gets the LED data from
1828d500549bSAnthony Wilson  * each connection and stores it in the inventory item.
1829d500549bSAnthony Wilson  *
1830d500549bSAnthony Wilson  * This data is later used to provide sensor property values in the JSON
1831d500549bSAnthony Wilson  * response.
1832d500549bSAnthony Wilson  *
1833d500549bSAnthony Wilson  * Finds the LED data asynchronously.  Invokes callback when information has
1834d500549bSAnthony Wilson  * been obtained.
1835d500549bSAnthony Wilson  *
1836d500549bSAnthony Wilson  * The callback must have the following signature:
1837d500549bSAnthony Wilson  *   @code
183842cbe538SGunnar Mills  *   callback()
1839d500549bSAnthony Wilson  *   @endcode
1840d500549bSAnthony Wilson  *
1841d500549bSAnthony Wilson  * @param sensorsAsyncResp Pointer to object holding response data.
1842d500549bSAnthony Wilson  * @param inventoryItems D-Bus inventory items associated with sensors.
1843d500549bSAnthony Wilson  * @param callback Callback to invoke when inventory items have been obtained.
1844d500549bSAnthony Wilson  */
1845d500549bSAnthony Wilson template <typename Callback>
1846d500549bSAnthony Wilson void getInventoryLeds(
1847d500549bSAnthony Wilson     std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1848d500549bSAnthony Wilson     std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1849d500549bSAnthony Wilson     Callback&& callback)
1850d500549bSAnthony Wilson {
1851d500549bSAnthony Wilson     BMCWEB_LOG_DEBUG << "getInventoryLeds enter";
1852d500549bSAnthony Wilson 
1853d500549bSAnthony Wilson     const std::string path = "/xyz/openbmc_project";
1854e99073f5SGeorge Liu     constexpr std::array<std::string_view, 1> interfaces = {
1855d500549bSAnthony Wilson         "xyz.openbmc_project.Led.Physical"};
1856d500549bSAnthony Wilson 
1857e99073f5SGeorge Liu     // Make call to ObjectMapper to find all inventory items
1858e99073f5SGeorge Liu     dbus::utility::getSubTree(
1859e99073f5SGeorge Liu         path, 0, interfaces,
1860002d39b4SEd Tanous         [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1861002d39b4SEd Tanous          inventoryItems](
1862e99073f5SGeorge Liu             const boost::system::error_code& ec,
1863002d39b4SEd Tanous             const dbus::utility::MapperGetSubTreeResponse& subtree) {
1864e99073f5SGeorge Liu         // Response handler for parsing output from GetSubTree
1865d500549bSAnthony Wilson         BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter";
1866d500549bSAnthony Wilson         if (ec)
1867d500549bSAnthony Wilson         {
18688d1b46d7Szhanghch05             messages::internalError(sensorsAsyncResp->asyncResp->res);
1869d500549bSAnthony Wilson             BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error "
1870d500549bSAnthony Wilson                              << ec;
1871d500549bSAnthony Wilson             return;
1872d500549bSAnthony Wilson         }
1873d500549bSAnthony Wilson 
1874d500549bSAnthony Wilson         // Build map of LED object paths to connections
1875fe04d49cSNan Zhou         std::shared_ptr<std::map<std::string, std::string>> ledConnections =
1876fe04d49cSNan Zhou             std::make_shared<std::map<std::string, std::string>>();
1877d500549bSAnthony Wilson 
1878d500549bSAnthony Wilson         // Loop through objects from GetSubTree
1879d500549bSAnthony Wilson         for (const std::pair<
1880d500549bSAnthony Wilson                  std::string,
1881d500549bSAnthony Wilson                  std::vector<std::pair<std::string, std::vector<std::string>>>>&
1882d500549bSAnthony Wilson                  object : subtree)
1883d500549bSAnthony Wilson         {
1884d500549bSAnthony Wilson             // Check if object path is LED for one of the specified inventory
1885d500549bSAnthony Wilson             // items
1886d500549bSAnthony Wilson             const std::string& ledPath = object.first;
1887d500549bSAnthony Wilson             if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr)
1888d500549bSAnthony Wilson             {
1889d500549bSAnthony Wilson                 // Add mapping from ledPath to connection
1890d500549bSAnthony Wilson                 const std::string& connection = object.second.begin()->first;
1891d500549bSAnthony Wilson                 (*ledConnections)[ledPath] = connection;
1892d500549bSAnthony Wilson                 BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> "
1893d500549bSAnthony Wilson                                  << connection;
1894d500549bSAnthony Wilson             }
1895d500549bSAnthony Wilson         }
1896d500549bSAnthony Wilson 
1897d500549bSAnthony Wilson         getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections,
1898d500549bSAnthony Wilson                             std::move(callback));
1899d500549bSAnthony Wilson         BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit";
1900e99073f5SGeorge Liu         });
1901d500549bSAnthony Wilson     BMCWEB_LOG_DEBUG << "getInventoryLeds exit";
1902d500549bSAnthony Wilson }
1903d500549bSAnthony Wilson 
1904d500549bSAnthony Wilson /**
190542cbe538SGunnar Mills  * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent
190642cbe538SGunnar Mills  *
190742cbe538SGunnar Mills  * Uses the specified connections (services) (currently assumes just one) to
190842cbe538SGunnar Mills  * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in
190942cbe538SGunnar Mills  * the inventoryItems vector. Only stores data in Power Supply inventoryItems.
191042cbe538SGunnar Mills  *
191142cbe538SGunnar Mills  * This data is later used to provide sensor property values in the JSON
191242cbe538SGunnar Mills  * response.
191342cbe538SGunnar Mills  *
191442cbe538SGunnar Mills  * Finds the Power Supply Attributes data asynchronously.  Invokes callback
191542cbe538SGunnar Mills  * when data has been obtained.
191642cbe538SGunnar Mills  *
191742cbe538SGunnar Mills  * The callback must have the following signature:
191842cbe538SGunnar Mills  *   @code
191942cbe538SGunnar Mills  *   callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
192042cbe538SGunnar Mills  *   @endcode
192142cbe538SGunnar Mills  *
192242cbe538SGunnar Mills  * @param sensorsAsyncResp Pointer to object holding response data.
192342cbe538SGunnar Mills  * @param inventoryItems D-Bus inventory items associated with sensors.
192442cbe538SGunnar Mills  * @param psAttributesConnections Connections that provide data for the Power
192542cbe538SGunnar Mills  *        Supply Attributes
192642cbe538SGunnar Mills  * @param callback Callback to invoke when data has been obtained.
192742cbe538SGunnar Mills  */
192842cbe538SGunnar Mills template <typename Callback>
192942cbe538SGunnar Mills void getPowerSupplyAttributesData(
1930b5a76932SEd Tanous     const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
193142cbe538SGunnar Mills     std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1932fe04d49cSNan Zhou     const std::map<std::string, std::string>& psAttributesConnections,
193342cbe538SGunnar Mills     Callback&& callback)
193442cbe538SGunnar Mills {
193542cbe538SGunnar Mills     BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter";
193642cbe538SGunnar Mills 
193742cbe538SGunnar Mills     if (psAttributesConnections.empty())
193842cbe538SGunnar Mills     {
193942cbe538SGunnar Mills         BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!";
194042cbe538SGunnar Mills         callback(inventoryItems);
194142cbe538SGunnar Mills         return;
194242cbe538SGunnar Mills     }
194342cbe538SGunnar Mills 
194442cbe538SGunnar Mills     // Assuming just one connection (service) for now
1945fe04d49cSNan Zhou     auto it = psAttributesConnections.begin();
194642cbe538SGunnar Mills 
194742cbe538SGunnar Mills     const std::string& psAttributesPath = (*it).first;
194842cbe538SGunnar Mills     const std::string& psAttributesConnection = (*it).second;
194942cbe538SGunnar Mills 
195042cbe538SGunnar Mills     // Response handler for Get DeratingFactor property
1951002d39b4SEd Tanous     auto respHandler =
1952002d39b4SEd Tanous         [sensorsAsyncResp, inventoryItems,
1953f94c4ecfSEd Tanous          callback{std::forward<Callback>(callback)}](
19545e7e2dc5SEd Tanous             const boost::system::error_code& ec, const uint32_t value) {
195542cbe538SGunnar Mills         BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter";
195642cbe538SGunnar Mills         if (ec)
195742cbe538SGunnar Mills         {
195842cbe538SGunnar Mills             BMCWEB_LOG_ERROR
195942cbe538SGunnar Mills                 << "getPowerSupplyAttributesData respHandler DBus error " << ec;
19608d1b46d7Szhanghch05             messages::internalError(sensorsAsyncResp->asyncResp->res);
196142cbe538SGunnar Mills             return;
196242cbe538SGunnar Mills         }
196342cbe538SGunnar Mills 
19641e1e598dSJonathan Doman         BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << value;
196542cbe538SGunnar Mills         // Store value in Power Supply Inventory Items
196642cbe538SGunnar Mills         for (InventoryItem& inventoryItem : *inventoryItems)
196742cbe538SGunnar Mills         {
196855f79e6fSEd Tanous             if (inventoryItem.isPowerSupply)
196942cbe538SGunnar Mills             {
197042cbe538SGunnar Mills                 inventoryItem.powerSupplyEfficiencyPercent =
19711e1e598dSJonathan Doman                     static_cast<int>(value);
197242cbe538SGunnar Mills             }
197342cbe538SGunnar Mills         }
197442cbe538SGunnar Mills 
197542cbe538SGunnar Mills         BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit";
197642cbe538SGunnar Mills         callback(inventoryItems);
197742cbe538SGunnar Mills     };
197842cbe538SGunnar Mills 
197942cbe538SGunnar Mills     // Get the DeratingFactor property for the PowerSupplyAttributes
198042cbe538SGunnar Mills     // Currently only property on the interface/only one we care about
19811e1e598dSJonathan Doman     sdbusplus::asio::getProperty<uint32_t>(
19821e1e598dSJonathan Doman         *crow::connections::systemBus, psAttributesConnection, psAttributesPath,
19831e1e598dSJonathan Doman         "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor",
19841e1e598dSJonathan Doman         std::move(respHandler));
198542cbe538SGunnar Mills 
198642cbe538SGunnar Mills     BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit";
198742cbe538SGunnar Mills }
198842cbe538SGunnar Mills 
198942cbe538SGunnar Mills /**
199042cbe538SGunnar Mills  * @brief Gets the Power Supply Attributes such as EfficiencyPercent
199142cbe538SGunnar Mills  *
199242cbe538SGunnar Mills  * Gets the D-Bus connection (service) that provides Power Supply Attributes
199342cbe538SGunnar Mills  * data. Then gets the Power Supply Attributes data from the connection
199442cbe538SGunnar Mills  * (currently just assumes 1 connection) and stores the data in the inventory
199542cbe538SGunnar Mills  * item.
199642cbe538SGunnar Mills  *
199742cbe538SGunnar Mills  * This data is later used to provide sensor property values in the JSON
199842cbe538SGunnar Mills  * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish.
199942cbe538SGunnar Mills  *
200042cbe538SGunnar Mills  * Finds the Power Supply Attributes data asynchronously. Invokes callback
200142cbe538SGunnar Mills  * when information has been obtained.
200242cbe538SGunnar Mills  *
200342cbe538SGunnar Mills  * The callback must have the following signature:
200442cbe538SGunnar Mills  *   @code
200542cbe538SGunnar Mills  *   callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
200642cbe538SGunnar Mills  *   @endcode
200742cbe538SGunnar Mills  *
200842cbe538SGunnar Mills  * @param sensorsAsyncResp Pointer to object holding response data.
200942cbe538SGunnar Mills  * @param inventoryItems D-Bus inventory items associated with sensors.
201042cbe538SGunnar Mills  * @param callback Callback to invoke when data has been obtained.
201142cbe538SGunnar Mills  */
201242cbe538SGunnar Mills template <typename Callback>
201342cbe538SGunnar Mills void getPowerSupplyAttributes(
201442cbe538SGunnar Mills     std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
201542cbe538SGunnar Mills     std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
201642cbe538SGunnar Mills     Callback&& callback)
201742cbe538SGunnar Mills {
201842cbe538SGunnar Mills     BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter";
201942cbe538SGunnar Mills 
202042cbe538SGunnar Mills     // Only need the power supply attributes when the Power Schema
2021a0ec28b6SAdrian Ambrożewicz     if (sensorsAsyncResp->chassisSubNode != sensors::node::power)
202242cbe538SGunnar Mills     {
202342cbe538SGunnar Mills         BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power";
202442cbe538SGunnar Mills         callback(inventoryItems);
202542cbe538SGunnar Mills         return;
202642cbe538SGunnar Mills     }
202742cbe538SGunnar Mills 
2028e99073f5SGeorge Liu     constexpr std::array<std::string_view, 1> interfaces = {
202942cbe538SGunnar Mills         "xyz.openbmc_project.Control.PowerSupplyAttributes"};
203042cbe538SGunnar Mills 
2031e99073f5SGeorge Liu     // Make call to ObjectMapper to find the PowerSupplyAttributes service
2032e99073f5SGeorge Liu     dbus::utility::getSubTree(
2033e99073f5SGeorge Liu         "/xyz/openbmc_project", 0, interfaces,
2034b9d36b47SEd Tanous         [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
2035b9d36b47SEd Tanous          inventoryItems](
2036e99073f5SGeorge Liu             const boost::system::error_code& ec,
2037b9d36b47SEd Tanous             const dbus::utility::MapperGetSubTreeResponse& subtree) {
2038e99073f5SGeorge Liu         // Response handler for parsing output from GetSubTree
203942cbe538SGunnar Mills         BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter";
204042cbe538SGunnar Mills         if (ec)
204142cbe538SGunnar Mills         {
20428d1b46d7Szhanghch05             messages::internalError(sensorsAsyncResp->asyncResp->res);
204342cbe538SGunnar Mills             BMCWEB_LOG_ERROR
204442cbe538SGunnar Mills                 << "getPowerSupplyAttributes respHandler DBus error " << ec;
204542cbe538SGunnar Mills             return;
204642cbe538SGunnar Mills         }
204726f6976fSEd Tanous         if (subtree.empty())
204842cbe538SGunnar Mills         {
204942cbe538SGunnar Mills             BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!";
205042cbe538SGunnar Mills             callback(inventoryItems);
205142cbe538SGunnar Mills             return;
205242cbe538SGunnar Mills         }
205342cbe538SGunnar Mills 
205442cbe538SGunnar Mills         // Currently we only support 1 power supply attribute, use this for
205542cbe538SGunnar Mills         // all the power supplies. Build map of object path to connection.
205642cbe538SGunnar Mills         // Assume just 1 connection and 1 path for now.
2057fe04d49cSNan Zhou         std::map<std::string, std::string> psAttributesConnections;
205842cbe538SGunnar Mills 
205942cbe538SGunnar Mills         if (subtree[0].first.empty() || subtree[0].second.empty())
206042cbe538SGunnar Mills         {
206142cbe538SGunnar Mills             BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
206242cbe538SGunnar Mills             callback(inventoryItems);
206342cbe538SGunnar Mills             return;
206442cbe538SGunnar Mills         }
206542cbe538SGunnar Mills 
206642cbe538SGunnar Mills         const std::string& psAttributesPath = subtree[0].first;
206742cbe538SGunnar Mills         const std::string& connection = subtree[0].second.begin()->first;
206842cbe538SGunnar Mills 
206942cbe538SGunnar Mills         if (connection.empty())
207042cbe538SGunnar Mills         {
207142cbe538SGunnar Mills             BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
207242cbe538SGunnar Mills             callback(inventoryItems);
207342cbe538SGunnar Mills             return;
207442cbe538SGunnar Mills         }
207542cbe538SGunnar Mills 
207642cbe538SGunnar Mills         psAttributesConnections[psAttributesPath] = connection;
207742cbe538SGunnar Mills         BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> "
207842cbe538SGunnar Mills                          << connection;
207942cbe538SGunnar Mills 
208042cbe538SGunnar Mills         getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems,
208142cbe538SGunnar Mills                                      psAttributesConnections,
208242cbe538SGunnar Mills                                      std::move(callback));
208342cbe538SGunnar Mills         BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit";
2084e99073f5SGeorge Liu         });
208542cbe538SGunnar Mills     BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit";
208642cbe538SGunnar Mills }
208742cbe538SGunnar Mills 
208842cbe538SGunnar Mills /**
2089adc4f0dbSShawn McCarney  * @brief Gets inventory items associated with sensors.
20908fb49dd6SShawn McCarney  *
20918fb49dd6SShawn McCarney  * Finds the inventory items that are associated with the specified sensors.
2092adc4f0dbSShawn McCarney  * Then gets D-Bus data for the inventory items, such as presence and VPD.
20938fb49dd6SShawn McCarney  *
2094adc4f0dbSShawn McCarney  * This data is later used to provide sensor property values in the JSON
2095adc4f0dbSShawn McCarney  * response.
20968fb49dd6SShawn McCarney  *
2097adc4f0dbSShawn McCarney  * Finds the inventory items asynchronously.  Invokes callback when the
2098adc4f0dbSShawn McCarney  * inventory items have been obtained.
2099adc4f0dbSShawn McCarney  *
2100adc4f0dbSShawn McCarney  * The callback must have the following signature:
2101adc4f0dbSShawn McCarney  *   @code
2102adc4f0dbSShawn McCarney  *   callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2103adc4f0dbSShawn McCarney  *   @endcode
21048fb49dd6SShawn McCarney  *
21058fb49dd6SShawn McCarney  * @param sensorsAsyncResp Pointer to object holding response data.
21068fb49dd6SShawn McCarney  * @param sensorNames All sensors within the current chassis.
21078fb49dd6SShawn McCarney  * implements ObjectManager.
2108adc4f0dbSShawn McCarney  * @param callback Callback to invoke when inventory items have been obtained.
21098fb49dd6SShawn McCarney  */
2110adc4f0dbSShawn McCarney template <typename Callback>
2111d0090733SEd Tanous static void
2112d0090733SEd Tanous     getInventoryItems(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2113fe04d49cSNan Zhou                       const std::shared_ptr<std::set<std::string>> sensorNames,
2114adc4f0dbSShawn McCarney                       Callback&& callback)
21158fb49dd6SShawn McCarney {
2116adc4f0dbSShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItems enter";
2117adc4f0dbSShawn McCarney     auto getInventoryItemAssociationsCb =
2118d0090733SEd Tanous         [sensorsAsyncResp, callback{std::forward<Callback>(callback)}](
2119adc4f0dbSShawn McCarney             std::shared_ptr<std::vector<InventoryItem>> inventoryItems) {
2120adc4f0dbSShawn McCarney         BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter";
21218fb49dd6SShawn McCarney         auto getInventoryItemsConnectionsCb =
2122d0090733SEd Tanous             [sensorsAsyncResp, inventoryItems,
2123f94c4ecfSEd Tanous              callback{std::forward<const Callback>(callback)}](
2124fe04d49cSNan Zhou                 std::shared_ptr<std::set<std::string>> invConnections) {
21258fb49dd6SShawn McCarney             BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter";
2126002d39b4SEd Tanous             auto getInventoryItemsDataCb = [sensorsAsyncResp, inventoryItems,
2127d500549bSAnthony Wilson                                             callback{std::move(callback)}]() {
2128d500549bSAnthony Wilson                 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter";
212942cbe538SGunnar Mills 
2130002d39b4SEd Tanous                 auto getInventoryLedsCb = [sensorsAsyncResp, inventoryItems,
2131002d39b4SEd Tanous                                            callback{std::move(callback)}]() {
213242cbe538SGunnar Mills                     BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter";
213342cbe538SGunnar Mills                     // Find Power Supply Attributes and get the data
2134002d39b4SEd Tanous                     getPowerSupplyAttributes(sensorsAsyncResp, inventoryItems,
213542cbe538SGunnar Mills                                              std::move(callback));
213642cbe538SGunnar Mills                     BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit";
213742cbe538SGunnar Mills                 };
213842cbe538SGunnar Mills 
2139d500549bSAnthony Wilson                 // Find led connections and get the data
2140d500549bSAnthony Wilson                 getInventoryLeds(sensorsAsyncResp, inventoryItems,
214142cbe538SGunnar Mills                                  std::move(getInventoryLedsCb));
2142d500549bSAnthony Wilson                 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit";
2143d500549bSAnthony Wilson             };
21448fb49dd6SShawn McCarney 
2145adc4f0dbSShawn McCarney             // Get inventory item data from connections
2146adc4f0dbSShawn McCarney             getInventoryItemsData(sensorsAsyncResp, inventoryItems,
2147d0090733SEd Tanous                                   invConnections,
2148d500549bSAnthony Wilson                                   std::move(getInventoryItemsDataCb));
21498fb49dd6SShawn McCarney             BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit";
21508fb49dd6SShawn McCarney         };
21518fb49dd6SShawn McCarney 
2152adc4f0dbSShawn McCarney         // Get connections that provide inventory item data
2153002d39b4SEd Tanous         getInventoryItemsConnections(sensorsAsyncResp, inventoryItems,
21548fb49dd6SShawn McCarney                                      std::move(getInventoryItemsConnectionsCb));
2155adc4f0dbSShawn McCarney         BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit";
21568fb49dd6SShawn McCarney     };
21578fb49dd6SShawn McCarney 
2158adc4f0dbSShawn McCarney     // Get associations from sensors to inventory items
2159d0090733SEd Tanous     getInventoryItemAssociations(sensorsAsyncResp, sensorNames,
2160adc4f0dbSShawn McCarney                                  std::move(getInventoryItemAssociationsCb));
2161adc4f0dbSShawn McCarney     BMCWEB_LOG_DEBUG << "getInventoryItems exit";
2162adc4f0dbSShawn McCarney }
2163adc4f0dbSShawn McCarney 
2164adc4f0dbSShawn McCarney /**
2165adc4f0dbSShawn McCarney  * @brief Returns JSON PowerSupply object for the specified inventory item.
2166adc4f0dbSShawn McCarney  *
2167adc4f0dbSShawn McCarney  * Searches for a JSON PowerSupply object that matches the specified inventory
2168adc4f0dbSShawn McCarney  * item.  If one is not found, a new PowerSupply object is added to the JSON
2169adc4f0dbSShawn McCarney  * array.
2170adc4f0dbSShawn McCarney  *
2171adc4f0dbSShawn McCarney  * Multiple sensors are often associated with one power supply inventory item.
2172adc4f0dbSShawn McCarney  * As a result, multiple sensor values are stored in one JSON PowerSupply
2173adc4f0dbSShawn McCarney  * object.
2174adc4f0dbSShawn McCarney  *
2175adc4f0dbSShawn McCarney  * @param powerSupplyArray JSON array containing Redfish PowerSupply objects.
2176adc4f0dbSShawn McCarney  * @param inventoryItem Inventory item for the power supply.
2177adc4f0dbSShawn McCarney  * @param chassisId Chassis that contains the power supply.
2178adc4f0dbSShawn McCarney  * @return JSON PowerSupply object for the specified inventory item.
2179adc4f0dbSShawn McCarney  */
218023a21a1cSEd Tanous inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray,
2181adc4f0dbSShawn McCarney                                       const InventoryItem& inventoryItem,
2182adc4f0dbSShawn McCarney                                       const std::string& chassisId)
2183adc4f0dbSShawn McCarney {
2184adc4f0dbSShawn McCarney     // Check if matching PowerSupply object already exists in JSON array
2185adc4f0dbSShawn McCarney     for (nlohmann::json& powerSupply : powerSupplyArray)
2186adc4f0dbSShawn McCarney     {
2187f7afb17bSAlexander Hansen         if (powerSupply["Name"] ==
2188f7afb17bSAlexander Hansen             boost::replace_all_copy(inventoryItem.name, "_", " "))
2189adc4f0dbSShawn McCarney         {
2190adc4f0dbSShawn McCarney             return powerSupply;
2191adc4f0dbSShawn McCarney         }
2192adc4f0dbSShawn McCarney     }
2193adc4f0dbSShawn McCarney 
2194adc4f0dbSShawn McCarney     // Add new PowerSupply object to JSON array
2195adc4f0dbSShawn McCarney     powerSupplyArray.push_back({});
2196adc4f0dbSShawn McCarney     nlohmann::json& powerSupply = powerSupplyArray.back();
2197eddfc437SWilly Tu     boost::urls::url url = crow::utility::urlFromPieces(
2198eddfc437SWilly Tu         "redfish", "v1", "Chassis", chassisId, "Power");
2199eddfc437SWilly Tu     url.set_fragment(("/PowerSupplies"_json_pointer).to_string());
2200eddfc437SWilly Tu     powerSupply["@odata.id"] = std::move(url);
2201adc4f0dbSShawn McCarney     powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " ");
2202adc4f0dbSShawn McCarney     powerSupply["Manufacturer"] = inventoryItem.manufacturer;
2203adc4f0dbSShawn McCarney     powerSupply["Model"] = inventoryItem.model;
2204adc4f0dbSShawn McCarney     powerSupply["PartNumber"] = inventoryItem.partNumber;
2205adc4f0dbSShawn McCarney     powerSupply["SerialNumber"] = inventoryItem.serialNumber;
2206d500549bSAnthony Wilson     setLedState(powerSupply, &inventoryItem);
2207adc4f0dbSShawn McCarney 
220842cbe538SGunnar Mills     if (inventoryItem.powerSupplyEfficiencyPercent >= 0)
220942cbe538SGunnar Mills     {
221042cbe538SGunnar Mills         powerSupply["EfficiencyPercent"] =
221142cbe538SGunnar Mills             inventoryItem.powerSupplyEfficiencyPercent;
221242cbe538SGunnar Mills     }
221342cbe538SGunnar Mills 
221442cbe538SGunnar Mills     powerSupply["Status"]["State"] = getState(&inventoryItem);
2215adc4f0dbSShawn McCarney     const char* health = inventoryItem.isFunctional ? "OK" : "Critical";
2216adc4f0dbSShawn McCarney     powerSupply["Status"]["Health"] = health;
2217adc4f0dbSShawn McCarney 
2218adc4f0dbSShawn McCarney     return powerSupply;
22198fb49dd6SShawn McCarney }
22208fb49dd6SShawn McCarney 
22218fb49dd6SShawn McCarney /**
2222de629b6eSShawn McCarney  * @brief Gets the values of the specified sensors.
2223de629b6eSShawn McCarney  *
2224de629b6eSShawn McCarney  * Stores the results as JSON in the SensorsAsyncResp.
2225de629b6eSShawn McCarney  *
2226de629b6eSShawn McCarney  * Gets the sensor values asynchronously.  Stores the results later when the
2227de629b6eSShawn McCarney  * information has been obtained.
2228de629b6eSShawn McCarney  *
2229adc4f0dbSShawn McCarney  * The sensorNames set contains all requested sensors for the current chassis.
2230de629b6eSShawn McCarney  *
2231de629b6eSShawn McCarney  * To minimize the number of DBus calls, the DBus method
2232de629b6eSShawn McCarney  * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the
2233de629b6eSShawn McCarney  * values of all sensors provided by a connection (service).
2234de629b6eSShawn McCarney  *
2235de629b6eSShawn McCarney  * The connections set contains all the connections that provide sensor values.
2236de629b6eSShawn McCarney  *
2237adc4f0dbSShawn McCarney  * The InventoryItem vector contains D-Bus inventory items associated with the
2238adc4f0dbSShawn McCarney  * sensors.  Inventory item data is needed for some Redfish sensor properties.
2239adc4f0dbSShawn McCarney  *
2240de629b6eSShawn McCarney  * @param SensorsAsyncResp Pointer to object holding response data.
2241adc4f0dbSShawn McCarney  * @param sensorNames All requested sensors within the current chassis.
2242de629b6eSShawn McCarney  * @param connections Connections that provide sensor values.
2243de629b6eSShawn McCarney  * implements ObjectManager.
2244adc4f0dbSShawn McCarney  * @param inventoryItems Inventory items associated with the sensors.
2245de629b6eSShawn McCarney  */
224623a21a1cSEd Tanous inline void getSensorData(
224781ce609eSEd Tanous     const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
2248fe04d49cSNan Zhou     const std::shared_ptr<std::set<std::string>>& sensorNames,
2249fe04d49cSNan Zhou     const std::set<std::string>& connections,
2250b5a76932SEd Tanous     const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems)
2251de629b6eSShawn McCarney {
2252de629b6eSShawn McCarney     BMCWEB_LOG_DEBUG << "getSensorData enter";
2253de629b6eSShawn McCarney     // Get managed objects from all services exposing sensors
2254de629b6eSShawn McCarney     for (const std::string& connection : connections)
2255de629b6eSShawn McCarney     {
2256de629b6eSShawn McCarney         // Response handler to process managed objects
2257002d39b4SEd Tanous         auto getManagedObjectsCb =
2258002d39b4SEd Tanous             [sensorsAsyncResp, sensorNames,
22595e7e2dc5SEd Tanous              inventoryItems](const boost::system::error_code& ec,
226002cad96eSEd Tanous                              const dbus::utility::ManagedObjectType& resp) {
2261de629b6eSShawn McCarney             BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter";
2262de629b6eSShawn McCarney             if (ec)
2263de629b6eSShawn McCarney             {
2264de629b6eSShawn McCarney                 BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec;
22658d1b46d7Szhanghch05                 messages::internalError(sensorsAsyncResp->asyncResp->res);
2266de629b6eSShawn McCarney                 return;
2267de629b6eSShawn McCarney             }
2268de629b6eSShawn McCarney             // Go through all objects and update response with sensor data
2269de629b6eSShawn McCarney             for (const auto& objDictEntry : resp)
2270de629b6eSShawn McCarney             {
2271de629b6eSShawn McCarney                 const std::string& objPath =
2272de629b6eSShawn McCarney                     static_cast<const std::string&>(objDictEntry.first);
2273de629b6eSShawn McCarney                 BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object "
2274de629b6eSShawn McCarney                                  << objPath;
2275de629b6eSShawn McCarney 
2276de629b6eSShawn McCarney                 std::vector<std::string> split;
2277de629b6eSShawn McCarney                 // Reserve space for
2278de629b6eSShawn McCarney                 // /xyz/openbmc_project/sensors/<name>/<subname>
2279de629b6eSShawn McCarney                 split.reserve(6);
228050ebd4afSEd Tanous                 // NOLINTNEXTLINE
228150ebd4afSEd Tanous                 bmcweb::split(split, objPath, '/');
2282de629b6eSShawn McCarney                 if (split.size() < 6)
2283de629b6eSShawn McCarney                 {
2284de629b6eSShawn McCarney                     BMCWEB_LOG_ERROR << "Got path that isn't long enough "
2285de629b6eSShawn McCarney                                      << objPath;
2286de629b6eSShawn McCarney                     continue;
2287de629b6eSShawn McCarney                 }
228850ebd4afSEd Tanous                 // These indexes aren't intuitive, as split puts an empty
2289de629b6eSShawn McCarney                 // string at the beginning
2290de629b6eSShawn McCarney                 const std::string& sensorType = split[4];
2291de629b6eSShawn McCarney                 const std::string& sensorName = split[5];
2292de629b6eSShawn McCarney                 BMCWEB_LOG_DEBUG << "sensorName " << sensorName
2293de629b6eSShawn McCarney                                  << " sensorType " << sensorType;
229449c53ac9SJohnathan Mantey                 if (sensorNames->find(objPath) == sensorNames->end())
2295de629b6eSShawn McCarney                 {
2296accdbb2cSAndrew Geissler                     BMCWEB_LOG_DEBUG << sensorName << " not in sensor list ";
2297de629b6eSShawn McCarney                     continue;
2298de629b6eSShawn McCarney                 }
2299de629b6eSShawn McCarney 
2300adc4f0dbSShawn McCarney                 // Find inventory item (if any) associated with sensor
2301adc4f0dbSShawn McCarney                 InventoryItem* inventoryItem =
2302adc4f0dbSShawn McCarney                     findInventoryItemForSensor(inventoryItems, objPath);
2303adc4f0dbSShawn McCarney 
230495a3ecadSAnthony Wilson                 const std::string& sensorSchema =
230581ce609eSEd Tanous                     sensorsAsyncResp->chassisSubNode;
230695a3ecadSAnthony Wilson 
230795a3ecadSAnthony Wilson                 nlohmann::json* sensorJson = nullptr;
230895a3ecadSAnthony Wilson 
2309928fefb9SNan Zhou                 if (sensorSchema == sensors::node::sensors &&
2310928fefb9SNan Zhou                     !sensorsAsyncResp->efficientExpand)
231195a3ecadSAnthony Wilson                 {
2312c1d019a6SEd Tanous                     std::string sensorTypeEscaped(sensorType);
2313c1d019a6SEd Tanous                     sensorTypeEscaped.erase(
2314c1d019a6SEd Tanous                         std::remove(sensorTypeEscaped.begin(),
2315c1d019a6SEd Tanous                                     sensorTypeEscaped.end(), '_'),
2316c1d019a6SEd Tanous                         sensorTypeEscaped.end());
2317c1d019a6SEd Tanous                     std::string sensorId(sensorTypeEscaped);
2318c1d019a6SEd Tanous                     sensorId += "_";
2319c1d019a6SEd Tanous                     sensorId += sensorName;
2320c1d019a6SEd Tanous 
23218d1b46d7Szhanghch05                     sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] =
2322c1d019a6SEd Tanous                         crow::utility::urlFromPieces(
2323c1d019a6SEd Tanous                             "redfish", "v1", "Chassis",
2324c1d019a6SEd Tanous                             sensorsAsyncResp->chassisId,
2325c1d019a6SEd Tanous                             sensorsAsyncResp->chassisSubNode, sensorId);
23268d1b46d7Szhanghch05                     sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue);
232795a3ecadSAnthony Wilson                 }
232895a3ecadSAnthony Wilson                 else
232995a3ecadSAnthony Wilson                 {
2330271584abSEd Tanous                     std::string fieldName;
2331928fefb9SNan Zhou                     if (sensorsAsyncResp->efficientExpand)
2332928fefb9SNan Zhou                     {
2333928fefb9SNan Zhou                         fieldName = "Members";
2334928fefb9SNan Zhou                     }
2335928fefb9SNan Zhou                     else if (sensorType == "temperature")
2336de629b6eSShawn McCarney                     {
2337de629b6eSShawn McCarney                         fieldName = "Temperatures";
2338de629b6eSShawn McCarney                     }
2339de629b6eSShawn McCarney                     else if (sensorType == "fan" || sensorType == "fan_tach" ||
2340de629b6eSShawn McCarney                              sensorType == "fan_pwm")
2341de629b6eSShawn McCarney                     {
2342de629b6eSShawn McCarney                         fieldName = "Fans";
2343de629b6eSShawn McCarney                     }
2344de629b6eSShawn McCarney                     else if (sensorType == "voltage")
2345de629b6eSShawn McCarney                     {
2346de629b6eSShawn McCarney                         fieldName = "Voltages";
2347de629b6eSShawn McCarney                     }
2348de629b6eSShawn McCarney                     else if (sensorType == "power")
2349de629b6eSShawn McCarney                     {
235055f79e6fSEd Tanous                         if (sensorName == "total_power")
2351028f7ebcSEddie James                         {
2352028f7ebcSEddie James                             fieldName = "PowerControl";
2353028f7ebcSEddie James                         }
2354adc4f0dbSShawn McCarney                         else if ((inventoryItem != nullptr) &&
2355adc4f0dbSShawn McCarney                                  (inventoryItem->isPowerSupply))
2356028f7ebcSEddie James                         {
2357de629b6eSShawn McCarney                             fieldName = "PowerSupplies";
2358de629b6eSShawn McCarney                         }
2359adc4f0dbSShawn McCarney                         else
2360adc4f0dbSShawn McCarney                         {
2361adc4f0dbSShawn McCarney                             // Other power sensors are in SensorCollection
2362adc4f0dbSShawn McCarney                             continue;
2363adc4f0dbSShawn McCarney                         }
2364028f7ebcSEddie James                     }
2365de629b6eSShawn McCarney                     else
2366de629b6eSShawn McCarney                     {
2367de629b6eSShawn McCarney                         BMCWEB_LOG_ERROR << "Unsure how to handle sensorType "
2368de629b6eSShawn McCarney                                          << sensorType;
2369de629b6eSShawn McCarney                         continue;
2370de629b6eSShawn McCarney                     }
2371de629b6eSShawn McCarney 
2372de629b6eSShawn McCarney                     nlohmann::json& tempArray =
23738d1b46d7Szhanghch05                         sensorsAsyncResp->asyncResp->res.jsonValue[fieldName];
2374adc4f0dbSShawn McCarney                     if (fieldName == "PowerControl")
237549c53ac9SJohnathan Mantey                     {
2376adc4f0dbSShawn McCarney                         if (tempArray.empty())
23777ab06f49SGunnar Mills                         {
237895a3ecadSAnthony Wilson                             // Put multiple "sensors" into a single
237995a3ecadSAnthony Wilson                             // PowerControl. Follows MemberId naming and
238095a3ecadSAnthony Wilson                             // naming in power.hpp.
23811476687dSEd Tanous                             nlohmann::json::object_t power;
2382eddfc437SWilly Tu                             boost::urls::url url = crow::utility::urlFromPieces(
2383eddfc437SWilly Tu                                 "redfish", "v1", "Chassis",
2384eddfc437SWilly Tu                                 sensorsAsyncResp->chassisId,
2385eddfc437SWilly Tu                                 sensorsAsyncResp->chassisSubNode);
2386eddfc437SWilly Tu                             url.set_fragment((""_json_pointer / fieldName / "0")
2387eddfc437SWilly Tu                                                  .to_string());
2388eddfc437SWilly Tu                             power["@odata.id"] = std::move(url);
2389*b2ba3072SPatrick Williams                             tempArray.emplace_back(std::move(power));
2390adc4f0dbSShawn McCarney                         }
2391adc4f0dbSShawn McCarney                         sensorJson = &(tempArray.back());
2392adc4f0dbSShawn McCarney                     }
2393adc4f0dbSShawn McCarney                     else if (fieldName == "PowerSupplies")
2394adc4f0dbSShawn McCarney                     {
2395adc4f0dbSShawn McCarney                         if (inventoryItem != nullptr)
2396adc4f0dbSShawn McCarney                         {
2397adc4f0dbSShawn McCarney                             sensorJson =
2398adc4f0dbSShawn McCarney                                 &(getPowerSupply(tempArray, *inventoryItem,
239981ce609eSEd Tanous                                                  sensorsAsyncResp->chassisId));
2400adc4f0dbSShawn McCarney                         }
240149c53ac9SJohnathan Mantey                     }
2402928fefb9SNan Zhou                     else if (fieldName == "Members")
2403928fefb9SNan Zhou                     {
2404677bb756SEd Tanous                         std::string sensorTypeEscaped(sensorType);
2405677bb756SEd Tanous                         sensorTypeEscaped.erase(
2406677bb756SEd Tanous                             std::remove(sensorTypeEscaped.begin(),
2407677bb756SEd Tanous                                         sensorTypeEscaped.end(), '_'),
2408677bb756SEd Tanous                             sensorTypeEscaped.end());
2409677bb756SEd Tanous                         std::string sensorId(sensorTypeEscaped);
2410677bb756SEd Tanous                         sensorId += "_";
2411677bb756SEd Tanous                         sensorId += sensorName;
2412677bb756SEd Tanous 
24131476687dSEd Tanous                         nlohmann::json::object_t member;
2414677bb756SEd Tanous                         member["@odata.id"] = crow::utility::urlFromPieces(
2415677bb756SEd Tanous                             "redfish", "v1", "Chassis",
2416677bb756SEd Tanous                             sensorsAsyncResp->chassisId,
2417677bb756SEd Tanous                             sensorsAsyncResp->chassisSubNode, sensorId);
2418*b2ba3072SPatrick Williams                         tempArray.emplace_back(std::move(member));
2419928fefb9SNan Zhou                         sensorJson = &(tempArray.back());
2420928fefb9SNan Zhou                     }
242149c53ac9SJohnathan Mantey                     else
242249c53ac9SJohnathan Mantey                     {
24231476687dSEd Tanous                         nlohmann::json::object_t member;
2424eddfc437SWilly Tu                         boost::urls::url url = crow::utility::urlFromPieces(
2425eddfc437SWilly Tu                             "redfish", "v1", "Chassis",
2426eddfc437SWilly Tu                             sensorsAsyncResp->chassisId,
2427eddfc437SWilly Tu                             sensorsAsyncResp->chassisSubNode);
2428eddfc437SWilly Tu                         url.set_fragment(
2429eddfc437SWilly Tu                             (""_json_pointer / fieldName).to_string());
2430eddfc437SWilly Tu                         member["@odata.id"] = std::move(url);
2431*b2ba3072SPatrick Williams                         tempArray.emplace_back(std::move(member));
2432adc4f0dbSShawn McCarney                         sensorJson = &(tempArray.back());
243349c53ac9SJohnathan Mantey                     }
243495a3ecadSAnthony Wilson                 }
2435de629b6eSShawn McCarney 
2436adc4f0dbSShawn McCarney                 if (sensorJson != nullptr)
2437adc4f0dbSShawn McCarney                 {
24381d7c0054SEd Tanous                     objectInterfacesToJson(sensorName, sensorType,
24391d7c0054SEd Tanous                                            sensorsAsyncResp->chassisSubNode,
24401d7c0054SEd Tanous                                            objDictEntry.second, *sensorJson,
24411d7c0054SEd Tanous                                            inventoryItem);
24421d7c0054SEd Tanous 
24431d7c0054SEd Tanous                     std::string path = "/xyz/openbmc_project/sensors/";
24441d7c0054SEd Tanous                     path += sensorType;
24451d7c0054SEd Tanous                     path += "/";
24461d7c0054SEd Tanous                     path += sensorName;
2447c1d019a6SEd Tanous                     sensorsAsyncResp->addMetadata(*sensorJson, path);
2448adc4f0dbSShawn McCarney                 }
2449de629b6eSShawn McCarney             }
245081ce609eSEd Tanous             if (sensorsAsyncResp.use_count() == 1)
245149c53ac9SJohnathan Mantey             {
245281ce609eSEd Tanous                 sortJSONResponse(sensorsAsyncResp);
2453928fefb9SNan Zhou                 if (sensorsAsyncResp->chassisSubNode ==
2454928fefb9SNan Zhou                         sensors::node::sensors &&
2455928fefb9SNan Zhou                     sensorsAsyncResp->efficientExpand)
2456928fefb9SNan Zhou                 {
2457928fefb9SNan Zhou                     sensorsAsyncResp->asyncResp->res
2458928fefb9SNan Zhou                         .jsonValue["Members@odata.count"] =
2459928fefb9SNan Zhou                         sensorsAsyncResp->asyncResp->res.jsonValue["Members"]
2460928fefb9SNan Zhou                             .size();
2461928fefb9SNan Zhou                 }
2462928fefb9SNan Zhou                 else if (sensorsAsyncResp->chassisSubNode ==
2463928fefb9SNan Zhou                          sensors::node::thermal)
24648bd25ccdSJames Feist                 {
246581ce609eSEd Tanous                     populateFanRedundancy(sensorsAsyncResp);
24668bd25ccdSJames Feist                 }
246749c53ac9SJohnathan Mantey             }
2468de629b6eSShawn McCarney             BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit";
2469de629b6eSShawn McCarney         };
2470de629b6eSShawn McCarney 
2471de629b6eSShawn McCarney         crow::connections::systemBus->async_method_call(
2472d0090733SEd Tanous             getManagedObjectsCb, connection, "/xyz/openbmc_project/sensors",
2473de629b6eSShawn McCarney             "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
247423a21a1cSEd Tanous     }
2475de629b6eSShawn McCarney     BMCWEB_LOG_DEBUG << "getSensorData exit";
2476de629b6eSShawn McCarney }
2477de629b6eSShawn McCarney 
2478fe04d49cSNan Zhou inline void
2479fe04d49cSNan Zhou     processSensorList(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
2480fe04d49cSNan Zhou                       const std::shared_ptr<std::set<std::string>>& sensorNames)
24811abe55efSEd Tanous {
2482fe04d49cSNan Zhou     auto getConnectionCb = [sensorsAsyncResp, sensorNames](
2483fe04d49cSNan Zhou                                const std::set<std::string>& connections) {
248455c7b7a2SEd Tanous         BMCWEB_LOG_DEBUG << "getConnectionCb enter";
2485adc4f0dbSShawn McCarney         auto getInventoryItemsCb =
2486d0090733SEd Tanous             [sensorsAsyncResp, sensorNames,
2487d0090733SEd Tanous              connections](const std::shared_ptr<std::vector<InventoryItem>>&
2488adc4f0dbSShawn McCarney                               inventoryItems) {
2489adc4f0dbSShawn McCarney             BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter";
249049c53ac9SJohnathan Mantey             // Get sensor data and store results in JSON
2491002d39b4SEd Tanous             getSensorData(sensorsAsyncResp, sensorNames, connections,
2492d0090733SEd Tanous                           inventoryItems);
2493adc4f0dbSShawn McCarney             BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit";
2494adc4f0dbSShawn McCarney         };
2495adc4f0dbSShawn McCarney 
2496adc4f0dbSShawn McCarney         // Get inventory items associated with sensors
2497d0090733SEd Tanous         getInventoryItems(sensorsAsyncResp, sensorNames,
2498adc4f0dbSShawn McCarney                           std::move(getInventoryItemsCb));
2499adc4f0dbSShawn McCarney 
250055c7b7a2SEd Tanous         BMCWEB_LOG_DEBUG << "getConnectionCb exit";
250108777fb0SLewanczyk, Dawid     };
2502de629b6eSShawn McCarney 
2503de629b6eSShawn McCarney     // Get set of connections that provide sensor values
250481ce609eSEd Tanous     getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb));
250595a3ecadSAnthony Wilson }
250695a3ecadSAnthony Wilson 
250795a3ecadSAnthony Wilson /**
250895a3ecadSAnthony Wilson  * @brief Entry point for retrieving sensors data related to requested
250995a3ecadSAnthony Wilson  *        chassis.
251095a3ecadSAnthony Wilson  * @param SensorsAsyncResp   Pointer to object holding response data
251195a3ecadSAnthony Wilson  */
2512b5a76932SEd Tanous inline void
251381ce609eSEd Tanous     getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
251495a3ecadSAnthony Wilson {
251595a3ecadSAnthony Wilson     BMCWEB_LOG_DEBUG << "getChassisData enter";
251695a3ecadSAnthony Wilson     auto getChassisCb =
251781ce609eSEd Tanous         [sensorsAsyncResp](
2518fe04d49cSNan Zhou             const std::shared_ptr<std::set<std::string>>& sensorNames) {
251995a3ecadSAnthony Wilson         BMCWEB_LOG_DEBUG << "getChassisCb enter";
252081ce609eSEd Tanous         processSensorList(sensorsAsyncResp, sensorNames);
252155c7b7a2SEd Tanous         BMCWEB_LOG_DEBUG << "getChassisCb exit";
252208777fb0SLewanczyk, Dawid     };
2523928fefb9SNan Zhou     // SensorCollection doesn't contain the Redundancy property
2524928fefb9SNan Zhou     if (sensorsAsyncResp->chassisSubNode != sensors::node::sensors)
2525928fefb9SNan Zhou     {
25268d1b46d7Szhanghch05         sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] =
25278d1b46d7Szhanghch05             nlohmann::json::array();
2528928fefb9SNan Zhou     }
252926f03899SShawn McCarney     // Get set of sensors in chassis
25307f1cc26dSEd Tanous     getChassis(sensorsAsyncResp->asyncResp, sensorsAsyncResp->chassisId,
25317f1cc26dSEd Tanous                sensorsAsyncResp->chassisSubNode, sensorsAsyncResp->types,
25327f1cc26dSEd Tanous                std::move(getChassisCb));
253355c7b7a2SEd Tanous     BMCWEB_LOG_DEBUG << "getChassisData exit";
2534271584abSEd Tanous }
253508777fb0SLewanczyk, Dawid 
2536413961deSRichard Marian Thomaiyar /**
253749c53ac9SJohnathan Mantey  * @brief Find the requested sensorName in the list of all sensors supplied by
253849c53ac9SJohnathan Mantey  * the chassis node
253949c53ac9SJohnathan Mantey  *
254049c53ac9SJohnathan Mantey  * @param sensorName   The sensor name supplied in the PATCH request
254149c53ac9SJohnathan Mantey  * @param sensorsList  The list of sensors managed by the chassis node
254249c53ac9SJohnathan Mantey  * @param sensorsModified  The list of sensors that were found as a result of
254349c53ac9SJohnathan Mantey  *                         repeated calls to this function
254449c53ac9SJohnathan Mantey  */
2545fe04d49cSNan Zhou inline bool
2546fe04d49cSNan Zhou     findSensorNameUsingSensorPath(std::string_view sensorName,
254702cad96eSEd Tanous                                   const std::set<std::string>& sensorsList,
2548fe04d49cSNan Zhou                                   std::set<std::string>& sensorsModified)
254949c53ac9SJohnathan Mantey {
2550fe04d49cSNan Zhou     for (const auto& chassisSensor : sensorsList)
255149c53ac9SJohnathan Mantey     {
255228aa8de5SGeorge Liu         sdbusplus::message::object_path path(chassisSensor);
2553b00dcc27SEd Tanous         std::string thisSensorName = path.filename();
255428aa8de5SGeorge Liu         if (thisSensorName.empty())
255549c53ac9SJohnathan Mantey         {
255649c53ac9SJohnathan Mantey             continue;
255749c53ac9SJohnathan Mantey         }
255849c53ac9SJohnathan Mantey         if (thisSensorName == sensorName)
255949c53ac9SJohnathan Mantey         {
256049c53ac9SJohnathan Mantey             sensorsModified.emplace(chassisSensor);
256149c53ac9SJohnathan Mantey             return true;
256249c53ac9SJohnathan Mantey         }
256349c53ac9SJohnathan Mantey     }
256449c53ac9SJohnathan Mantey     return false;
256549c53ac9SJohnathan Mantey }
256649c53ac9SJohnathan Mantey 
2567c71d6125SEd Tanous inline std::pair<std::string, std::string>
2568c71d6125SEd Tanous     splitSensorNameAndType(std::string_view sensorId)
2569c71d6125SEd Tanous {
2570c71d6125SEd Tanous     size_t index = sensorId.find('_');
2571c71d6125SEd Tanous     if (index == std::string::npos)
2572c71d6125SEd Tanous     {
2573c71d6125SEd Tanous         return std::make_pair<std::string, std::string>("", "");
2574c71d6125SEd Tanous     }
2575c71d6125SEd Tanous     std::string sensorType{sensorId.substr(0, index)};
2576c71d6125SEd Tanous     std::string sensorName{sensorId.substr(index + 1)};
2577c71d6125SEd Tanous     // fan_pwm and fan_tach need special handling
2578c71d6125SEd Tanous     if (sensorType == "fantach" || sensorType == "fanpwm")
2579c71d6125SEd Tanous     {
2580c71d6125SEd Tanous         sensorType.insert(3, 1, '_');
2581c71d6125SEd Tanous     }
2582c71d6125SEd Tanous     return std::make_pair(sensorType, sensorName);
2583c71d6125SEd Tanous }
2584c71d6125SEd Tanous 
258549c53ac9SJohnathan Mantey /**
2586413961deSRichard Marian Thomaiyar  * @brief Entry point for overriding sensor values of given sensor
2587413961deSRichard Marian Thomaiyar  *
25888d1b46d7Szhanghch05  * @param sensorAsyncResp   response object
25894bb3dc34SCarol Wang  * @param allCollections   Collections extract from sensors' request patch info
2590413961deSRichard Marian Thomaiyar  * @param chassisSubNode   Chassis Node for which the query has to happen
2591413961deSRichard Marian Thomaiyar  */
259223a21a1cSEd Tanous inline void setSensorsOverride(
2593b5a76932SEd Tanous     const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp,
25944bb3dc34SCarol Wang     std::unordered_map<std::string, std::vector<nlohmann::json>>&
2595397fd61fSjayaprakash Mutyala         allCollections)
2596413961deSRichard Marian Thomaiyar {
259770d1d0aaSjayaprakash Mutyala     BMCWEB_LOG_INFO << "setSensorsOverride for subNode"
25984bb3dc34SCarol Wang                     << sensorAsyncResp->chassisSubNode << "\n";
2599413961deSRichard Marian Thomaiyar 
2600543f4400SEd Tanous     const char* propertyValueName = nullptr;
2601f65af9e8SRichard Marian Thomaiyar     std::unordered_map<std::string, std::pair<double, std::string>> overrideMap;
2602413961deSRichard Marian Thomaiyar     std::string memberId;
2603543f4400SEd Tanous     double value = 0.0;
2604f65af9e8SRichard Marian Thomaiyar     for (auto& collectionItems : allCollections)
2605f65af9e8SRichard Marian Thomaiyar     {
2606f65af9e8SRichard Marian Thomaiyar         if (collectionItems.first == "Temperatures")
2607f65af9e8SRichard Marian Thomaiyar         {
2608f65af9e8SRichard Marian Thomaiyar             propertyValueName = "ReadingCelsius";
2609f65af9e8SRichard Marian Thomaiyar         }
2610f65af9e8SRichard Marian Thomaiyar         else if (collectionItems.first == "Fans")
2611f65af9e8SRichard Marian Thomaiyar         {
2612f65af9e8SRichard Marian Thomaiyar             propertyValueName = "Reading";
2613f65af9e8SRichard Marian Thomaiyar         }
2614f65af9e8SRichard Marian Thomaiyar         else
2615f65af9e8SRichard Marian Thomaiyar         {
2616f65af9e8SRichard Marian Thomaiyar             propertyValueName = "ReadingVolts";
2617f65af9e8SRichard Marian Thomaiyar         }
2618f65af9e8SRichard Marian Thomaiyar         for (auto& item : collectionItems.second)
2619f65af9e8SRichard Marian Thomaiyar         {
26208d1b46d7Szhanghch05             if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res,
26218d1b46d7Szhanghch05                                      "MemberId", memberId, propertyValueName,
26228d1b46d7Szhanghch05                                      value))
2623413961deSRichard Marian Thomaiyar             {
2624413961deSRichard Marian Thomaiyar                 return;
2625413961deSRichard Marian Thomaiyar             }
2626f65af9e8SRichard Marian Thomaiyar             overrideMap.emplace(memberId,
2627f65af9e8SRichard Marian Thomaiyar                                 std::make_pair(value, collectionItems.first));
2628f65af9e8SRichard Marian Thomaiyar         }
2629f65af9e8SRichard Marian Thomaiyar     }
26304bb3dc34SCarol Wang 
2631002d39b4SEd Tanous     auto getChassisSensorListCb =
2632002d39b4SEd Tanous         [sensorAsyncResp, overrideMap](
2633fe04d49cSNan Zhou             const std::shared_ptr<std::set<std::string>>& sensorsList) {
263449c53ac9SJohnathan Mantey         // Match sensor names in the PATCH request to those managed by the
263549c53ac9SJohnathan Mantey         // chassis node
2636fe04d49cSNan Zhou         const std::shared_ptr<std::set<std::string>> sensorNames =
2637fe04d49cSNan Zhou             std::make_shared<std::set<std::string>>();
2638f65af9e8SRichard Marian Thomaiyar         for (const auto& item : overrideMap)
2639413961deSRichard Marian Thomaiyar         {
2640f65af9e8SRichard Marian Thomaiyar             const auto& sensor = item.first;
2641c71d6125SEd Tanous             std::pair<std::string, std::string> sensorNameType =
2642c71d6125SEd Tanous                 splitSensorNameAndType(sensor);
2643c71d6125SEd Tanous             if (!findSensorNameUsingSensorPath(sensorNameType.second,
2644c71d6125SEd Tanous                                                *sensorsList, *sensorNames))
2645f65af9e8SRichard Marian Thomaiyar             {
2646f65af9e8SRichard Marian Thomaiyar                 BMCWEB_LOG_INFO << "Unable to find memberId " << item.first;
26478d1b46d7Szhanghch05                 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
2648f65af9e8SRichard Marian Thomaiyar                                            item.second.second, item.first);
2649413961deSRichard Marian Thomaiyar                 return;
2650413961deSRichard Marian Thomaiyar             }
2651f65af9e8SRichard Marian Thomaiyar         }
2652413961deSRichard Marian Thomaiyar         // Get the connection to which the memberId belongs
2653002d39b4SEd Tanous         auto getObjectsWithConnectionCb =
2654fe04d49cSNan Zhou             [sensorAsyncResp,
2655fe04d49cSNan Zhou              overrideMap](const std::set<std::string>& /*connections*/,
2656002d39b4SEd Tanous                           const std::set<std::pair<std::string, std::string>>&
2657413961deSRichard Marian Thomaiyar                               objectsWithConnection) {
2658f65af9e8SRichard Marian Thomaiyar             if (objectsWithConnection.size() != overrideMap.size())
2659413961deSRichard Marian Thomaiyar             {
2660413961deSRichard Marian Thomaiyar                 BMCWEB_LOG_INFO
2661f65af9e8SRichard Marian Thomaiyar                     << "Unable to find all objects with proper connection "
2662f65af9e8SRichard Marian Thomaiyar                     << objectsWithConnection.size() << " requested "
2663f65af9e8SRichard Marian Thomaiyar                     << overrideMap.size() << "\n";
26644f277b54SJayaprakash Mutyala                 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
2665a0ec28b6SAdrian Ambrożewicz                                            sensorAsyncResp->chassisSubNode ==
2666a0ec28b6SAdrian Ambrożewicz                                                    sensors::node::thermal
2667413961deSRichard Marian Thomaiyar                                                ? "Temperatures"
2668413961deSRichard Marian Thomaiyar                                                : "Voltages",
2669f65af9e8SRichard Marian Thomaiyar                                            "Count");
2670f65af9e8SRichard Marian Thomaiyar                 return;
2671f65af9e8SRichard Marian Thomaiyar             }
2672f65af9e8SRichard Marian Thomaiyar             for (const auto& item : objectsWithConnection)
2673f65af9e8SRichard Marian Thomaiyar             {
267428aa8de5SGeorge Liu                 sdbusplus::message::object_path path(item.first);
267528aa8de5SGeorge Liu                 std::string sensorName = path.filename();
267628aa8de5SGeorge Liu                 if (sensorName.empty())
2677f65af9e8SRichard Marian Thomaiyar                 {
26784f277b54SJayaprakash Mutyala                     messages::internalError(sensorAsyncResp->asyncResp->res);
2679f65af9e8SRichard Marian Thomaiyar                     return;
2680f65af9e8SRichard Marian Thomaiyar                 }
2681f65af9e8SRichard Marian Thomaiyar 
2682f65af9e8SRichard Marian Thomaiyar                 const auto& iterator = overrideMap.find(sensorName);
2683f65af9e8SRichard Marian Thomaiyar                 if (iterator == overrideMap.end())
2684f65af9e8SRichard Marian Thomaiyar                 {
2685f65af9e8SRichard Marian Thomaiyar                     BMCWEB_LOG_INFO << "Unable to find sensor object"
2686f65af9e8SRichard Marian Thomaiyar                                     << item.first << "\n";
26874f277b54SJayaprakash Mutyala                     messages::internalError(sensorAsyncResp->asyncResp->res);
2688413961deSRichard Marian Thomaiyar                     return;
2689413961deSRichard Marian Thomaiyar                 }
2690413961deSRichard Marian Thomaiyar                 crow::connections::systemBus->async_method_call(
26915e7e2dc5SEd Tanous                     [sensorAsyncResp](const boost::system::error_code& ec) {
2692413961deSRichard Marian Thomaiyar                     if (ec)
2693413961deSRichard Marian Thomaiyar                     {
26944f277b54SJayaprakash Mutyala                         if (ec.value() ==
26954f277b54SJayaprakash Mutyala                             boost::system::errc::permission_denied)
26964f277b54SJayaprakash Mutyala                         {
26974f277b54SJayaprakash Mutyala                             BMCWEB_LOG_WARNING
26984f277b54SJayaprakash Mutyala                                 << "Manufacturing mode is not Enabled...can't "
26994f277b54SJayaprakash Mutyala                                    "Override the sensor value. ";
27004f277b54SJayaprakash Mutyala 
27014f277b54SJayaprakash Mutyala                             messages::insufficientPrivilege(
27028d1b46d7Szhanghch05                                 sensorAsyncResp->asyncResp->res);
2703413961deSRichard Marian Thomaiyar                             return;
2704413961deSRichard Marian Thomaiyar                         }
27054f277b54SJayaprakash Mutyala                         BMCWEB_LOG_DEBUG
27064f277b54SJayaprakash Mutyala                             << "setOverrideValueStatus DBUS error: " << ec;
27074f277b54SJayaprakash Mutyala                         messages::internalError(
27084f277b54SJayaprakash Mutyala                             sensorAsyncResp->asyncResp->res);
27094f277b54SJayaprakash Mutyala                     }
2710413961deSRichard Marian Thomaiyar                     },
27114f277b54SJayaprakash Mutyala                     item.second, item.first, "org.freedesktop.DBus.Properties",
27124f277b54SJayaprakash Mutyala                     "Set", "xyz.openbmc_project.Sensor.Value", "Value",
2713168e20c1SEd Tanous                     dbus::utility::DbusVariantType(iterator->second.first));
2714f65af9e8SRichard Marian Thomaiyar             }
2715413961deSRichard Marian Thomaiyar         };
2716413961deSRichard Marian Thomaiyar         // Get object with connection for the given sensor name
2717413961deSRichard Marian Thomaiyar         getObjectsWithConnection(sensorAsyncResp, sensorNames,
2718413961deSRichard Marian Thomaiyar                                  std::move(getObjectsWithConnectionCb));
2719413961deSRichard Marian Thomaiyar     };
2720413961deSRichard Marian Thomaiyar     // get full sensor list for the given chassisId and cross verify the sensor.
27217f1cc26dSEd Tanous     getChassis(sensorAsyncResp->asyncResp, sensorAsyncResp->chassisId,
27227f1cc26dSEd Tanous                sensorAsyncResp->chassisSubNode, sensorAsyncResp->types,
27237f1cc26dSEd Tanous                std::move(getChassisSensorListCb));
2724413961deSRichard Marian Thomaiyar }
2725413961deSRichard Marian Thomaiyar 
2726a0ec28b6SAdrian Ambrożewicz /**
2727a0ec28b6SAdrian Ambrożewicz  * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus
2728a0ec28b6SAdrian Ambrożewicz  * path of the sensor.
2729a0ec28b6SAdrian Ambrożewicz  *
2730a0ec28b6SAdrian Ambrożewicz  * Function builds valid Redfish response for sensor query of given chassis and
2731a0ec28b6SAdrian Ambrożewicz  * node. It then builds metadata about Redfish<->D-Bus correlations and provides
2732a0ec28b6SAdrian Ambrożewicz  * it to caller in a callback.
2733a0ec28b6SAdrian Ambrożewicz  *
2734a0ec28b6SAdrian Ambrożewicz  * @param chassis   Chassis for which retrieval should be performed
2735a0ec28b6SAdrian Ambrożewicz  * @param node  Node (group) of sensors. See sensors::node for supported values
2736a0ec28b6SAdrian Ambrożewicz  * @param mapComplete   Callback to be called with retrieval result
2737a0ec28b6SAdrian Ambrożewicz  */
2738021d32cfSKrzysztof Grobelny inline void retrieveUriToDbusMap(const std::string& chassis,
2739021d32cfSKrzysztof Grobelny                                  const std::string& node,
2740a0ec28b6SAdrian Ambrożewicz                                  SensorsAsyncResp::DataCompleteCb&& mapComplete)
2741a0ec28b6SAdrian Ambrożewicz {
274202da7c5aSEd Tanous     decltype(sensors::paths)::const_iterator pathIt =
274302da7c5aSEd Tanous         std::find_if(sensors::paths.cbegin(), sensors::paths.cend(),
274402da7c5aSEd Tanous                      [&node](auto&& val) { return val.first == node; });
274502da7c5aSEd Tanous     if (pathIt == sensors::paths.cend())
2746a0ec28b6SAdrian Ambrożewicz     {
2747a0ec28b6SAdrian Ambrożewicz         BMCWEB_LOG_ERROR << "Wrong node provided : " << node;
2748a0ec28b6SAdrian Ambrożewicz         mapComplete(boost::beast::http::status::bad_request, {});
2749a0ec28b6SAdrian Ambrożewicz         return;
2750a0ec28b6SAdrian Ambrożewicz     }
2751d51e072fSKrzysztof Grobelny 
275272374eb7SNan Zhou     auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
2753fe04d49cSNan Zhou     auto callback = [asyncResp, mapCompleteCb{std::move(mapComplete)}](
2754a0ec28b6SAdrian Ambrożewicz                         const boost::beast::http::status status,
2755fe04d49cSNan Zhou                         const std::map<std::string, std::string>& uriToDbus) {
2756fe04d49cSNan Zhou         mapCompleteCb(status, uriToDbus);
2757fe04d49cSNan Zhou     };
2758a0ec28b6SAdrian Ambrożewicz 
2759a0ec28b6SAdrian Ambrożewicz     auto resp = std::make_shared<SensorsAsyncResp>(
2760d51e072fSKrzysztof Grobelny         asyncResp, chassis, pathIt->second, node, std::move(callback));
2761a0ec28b6SAdrian Ambrożewicz     getChassisData(resp);
2762a0ec28b6SAdrian Ambrożewicz }
2763a0ec28b6SAdrian Ambrożewicz 
2764bacb2162SNan Zhou namespace sensors
2765bacb2162SNan Zhou {
2766928fefb9SNan Zhou 
2767bacb2162SNan Zhou inline void getChassisCallback(
2768c1d019a6SEd Tanous     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2769c1d019a6SEd Tanous     std::string_view chassisId, std::string_view chassisSubNode,
2770fe04d49cSNan Zhou     const std::shared_ptr<std::set<std::string>>& sensorNames)
2771bacb2162SNan Zhou {
2772bacb2162SNan Zhou     BMCWEB_LOG_DEBUG << "getChassisCallback enter ";
2773bacb2162SNan Zhou 
2774c1d019a6SEd Tanous     nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
2775c1d019a6SEd Tanous     for (const std::string& sensor : *sensorNames)
2776bacb2162SNan Zhou     {
2777bacb2162SNan Zhou         BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor;
2778bacb2162SNan Zhou 
2779bacb2162SNan Zhou         sdbusplus::message::object_path path(sensor);
2780bacb2162SNan Zhou         std::string sensorName = path.filename();
2781bacb2162SNan Zhou         if (sensorName.empty())
2782bacb2162SNan Zhou         {
2783bacb2162SNan Zhou             BMCWEB_LOG_ERROR << "Invalid sensor path: " << sensor;
2784c1d019a6SEd Tanous             messages::internalError(asyncResp->res);
2785bacb2162SNan Zhou             return;
2786bacb2162SNan Zhou         }
2787c1d019a6SEd Tanous         std::string type = path.parent_path().filename();
2788c1d019a6SEd Tanous         // fan_tach has an underscore in it, so remove it to "normalize" the
2789c1d019a6SEd Tanous         // type in the URI
2790c1d019a6SEd Tanous         type.erase(std::remove(type.begin(), type.end(), '_'), type.end());
2791c1d019a6SEd Tanous 
27921476687dSEd Tanous         nlohmann::json::object_t member;
2793c1d019a6SEd Tanous         std::string id = type;
2794c1d019a6SEd Tanous         id += "_";
2795c1d019a6SEd Tanous         id += sensorName;
2796c1d019a6SEd Tanous         member["@odata.id"] = crow::utility::urlFromPieces(
2797c1d019a6SEd Tanous             "redfish", "v1", "Chassis", chassisId, chassisSubNode, id);
2798c1d019a6SEd Tanous 
2799*b2ba3072SPatrick Williams         entriesArray.emplace_back(std::move(member));
2800bacb2162SNan Zhou     }
2801bacb2162SNan Zhou 
2802c1d019a6SEd Tanous     asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
2803bacb2162SNan Zhou     BMCWEB_LOG_DEBUG << "getChassisCallback exit";
2804bacb2162SNan Zhou }
2805e6bd846dSNan Zhou 
2806de167a6fSNan Zhou inline void
2807de167a6fSNan Zhou     handleSensorCollectionGet(App& app, const crow::Request& req,
2808de167a6fSNan Zhou                               const std::shared_ptr<bmcweb::AsyncResp>& aResp,
2809de167a6fSNan Zhou                               const std::string& chassisId)
2810de167a6fSNan Zhou {
2811de167a6fSNan Zhou     query_param::QueryCapabilities capabilities = {
2812de167a6fSNan Zhou         .canDelegateExpandLevel = 1,
2813de167a6fSNan Zhou     };
2814de167a6fSNan Zhou     query_param::Query delegatedQuery;
28153ba00073SCarson Labrado     if (!redfish::setUpRedfishRouteWithDelegation(app, req, aResp,
2816de167a6fSNan Zhou                                                   delegatedQuery, capabilities))
2817de167a6fSNan Zhou     {
2818de167a6fSNan Zhou         return;
2819de167a6fSNan Zhou     }
2820de167a6fSNan Zhou 
2821de167a6fSNan Zhou     if (delegatedQuery.expandType != query_param::ExpandType::None)
2822de167a6fSNan Zhou     {
2823de167a6fSNan Zhou         // we perform efficient expand.
2824de167a6fSNan Zhou         auto asyncResp = std::make_shared<SensorsAsyncResp>(
2825de167a6fSNan Zhou             aResp, chassisId, sensors::dbus::sensorPaths,
2826de167a6fSNan Zhou             sensors::node::sensors,
2827de167a6fSNan Zhou             /*efficientExpand=*/true);
2828de167a6fSNan Zhou         getChassisData(asyncResp);
2829de167a6fSNan Zhou 
2830de167a6fSNan Zhou         BMCWEB_LOG_DEBUG
2831de167a6fSNan Zhou             << "SensorCollection doGet exit via efficient expand handler";
2832de167a6fSNan Zhou         return;
28330bad320cSEd Tanous     }
2834de167a6fSNan Zhou 
2835de167a6fSNan Zhou     // We get all sensors as hyperlinkes in the chassis (this
2836de167a6fSNan Zhou     // implies we reply on the default query parameters handler)
2837c1d019a6SEd Tanous     getChassis(aResp, chassisId, sensors::node::sensors, dbus::sensorPaths,
2838c1d019a6SEd Tanous                std::bind_front(sensors::getChassisCallback, aResp, chassisId,
2839c1d019a6SEd Tanous                                sensors::node::sensors));
2840c1d019a6SEd Tanous }
28417f1cc26dSEd Tanous 
2842c1d019a6SEd Tanous inline void
2843c1d019a6SEd Tanous     getSensorFromDbus(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2844c1d019a6SEd Tanous                       const std::string& sensorPath,
2845c1d019a6SEd Tanous                       const ::dbus::utility::MapperGetObject& mapperResponse)
2846c1d019a6SEd Tanous {
2847c1d019a6SEd Tanous     if (mapperResponse.size() != 1)
2848c1d019a6SEd Tanous     {
2849c1d019a6SEd Tanous         messages::internalError(asyncResp->res);
2850c1d019a6SEd Tanous         return;
2851c1d019a6SEd Tanous     }
2852c1d019a6SEd Tanous     const auto& valueIface = *mapperResponse.begin();
2853c1d019a6SEd Tanous     const std::string& connectionName = valueIface.first;
2854c1d019a6SEd Tanous     BMCWEB_LOG_DEBUG << "Looking up " << connectionName;
2855c1d019a6SEd Tanous     BMCWEB_LOG_DEBUG << "Path " << sensorPath;
2856c1343bf6SKrzysztof Grobelny 
2857c1343bf6SKrzysztof Grobelny     sdbusplus::asio::getAllProperties(
2858c1343bf6SKrzysztof Grobelny         *crow::connections::systemBus, connectionName, sensorPath, "",
2859c1d019a6SEd Tanous         [asyncResp,
28605e7e2dc5SEd Tanous          sensorPath](const boost::system::error_code& ec,
2861c1d019a6SEd Tanous                      const ::dbus::utility::DBusPropertiesMap& valuesDict) {
2862c1d019a6SEd Tanous         if (ec)
2863c1d019a6SEd Tanous         {
2864c1d019a6SEd Tanous             messages::internalError(asyncResp->res);
2865c1d019a6SEd Tanous             return;
2866c1d019a6SEd Tanous         }
2867c1d019a6SEd Tanous         sdbusplus::message::object_path path(sensorPath);
2868c1d019a6SEd Tanous         std::string name = path.filename();
2869c1d019a6SEd Tanous         path = path.parent_path();
2870c1d019a6SEd Tanous         std::string type = path.filename();
2871c1d019a6SEd Tanous         objectPropertiesToJson(name, type, sensors::node::sensors, valuesDict,
2872c1d019a6SEd Tanous                                asyncResp->res.jsonValue, nullptr);
2873c1343bf6SKrzysztof Grobelny         });
2874de167a6fSNan Zhou }
2875de167a6fSNan Zhou 
2876e6bd846dSNan Zhou inline void handleSensorGet(App& app, const crow::Request& req,
2877c1d019a6SEd Tanous                             const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2878677bb756SEd Tanous                             const std::string& chassisId,
2879c1d019a6SEd Tanous                             const std::string& sensorId)
2880e6bd846dSNan Zhou {
2881c1d019a6SEd Tanous     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2882e6bd846dSNan Zhou     {
2883e6bd846dSNan Zhou         return;
2884e6bd846dSNan Zhou     }
2885c71d6125SEd Tanous     std::pair<std::string, std::string> nameType =
2886c71d6125SEd Tanous         splitSensorNameAndType(sensorId);
2887c71d6125SEd Tanous     if (nameType.first.empty() || nameType.second.empty())
2888c1d019a6SEd Tanous     {
2889c1d019a6SEd Tanous         messages::resourceNotFound(asyncResp->res, sensorId, "Sensor");
2890c1d019a6SEd Tanous         return;
2891c1d019a6SEd Tanous     }
2892c71d6125SEd Tanous 
2893677bb756SEd Tanous     asyncResp->res.jsonValue["@odata.id"] = crow::utility::urlFromPieces(
2894677bb756SEd Tanous         "redfish", "v1", "Chassis", chassisId, "Sensors", sensorId);
2895c1d019a6SEd Tanous 
2896e6bd846dSNan Zhou     BMCWEB_LOG_DEBUG << "Sensor doGet enter";
2897e6bd846dSNan Zhou 
28982b73119cSGeorge Liu     constexpr std::array<std::string_view, 1> interfaces = {
2899e6bd846dSNan Zhou         "xyz.openbmc_project.Sensor.Value"};
2900c71d6125SEd Tanous     std::string sensorPath = "/xyz/openbmc_project/sensors/" + nameType.first +
2901c71d6125SEd Tanous                              '/' + nameType.second;
2902e6bd846dSNan Zhou     // Get a list of all of the sensors that implement Sensor.Value
2903e6bd846dSNan Zhou     // and get the path and service name associated with the sensor
29042b73119cSGeorge Liu     ::dbus::utility::getDbusObject(
29052b73119cSGeorge Liu         sensorPath, interfaces,
2906c71d6125SEd Tanous         [asyncResp,
29072b73119cSGeorge Liu          sensorPath](const boost::system::error_code& ec,
2908c1d019a6SEd Tanous                      const ::dbus::utility::MapperGetObject& subtree) {
2909e6bd846dSNan Zhou         BMCWEB_LOG_DEBUG << "respHandler1 enter";
2910e6bd846dSNan Zhou         if (ec)
2911e6bd846dSNan Zhou         {
2912c1d019a6SEd Tanous             messages::internalError(asyncResp->res);
2913e6bd846dSNan Zhou             BMCWEB_LOG_ERROR << "Sensor getSensorPaths resp_handler: "
2914e6bd846dSNan Zhou                              << "Dbus error " << ec;
2915e6bd846dSNan Zhou             return;
2916e6bd846dSNan Zhou         }
2917c1d019a6SEd Tanous         getSensorFromDbus(asyncResp, sensorPath, subtree);
2918e6bd846dSNan Zhou         BMCWEB_LOG_DEBUG << "respHandler1 exit";
29192b73119cSGeorge Liu         });
2920e6bd846dSNan Zhou }
2921e6bd846dSNan Zhou 
2922bacb2162SNan Zhou } // namespace sensors
2923bacb2162SNan Zhou 
29247e860f15SJohn Edward Broadbent inline void requestRoutesSensorCollection(App& app)
292595a3ecadSAnthony Wilson {
29267e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/")
2927ed398213SEd Tanous         .privileges(redfish::privileges::getSensorCollection)
2928002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2929de167a6fSNan Zhou             std::bind_front(sensors::handleSensorCollectionGet, std::ref(app)));
293095a3ecadSAnthony Wilson }
293195a3ecadSAnthony Wilson 
29327e860f15SJohn Edward Broadbent inline void requestRoutesSensor(App& app)
293395a3ecadSAnthony Wilson {
29347e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/")
2935ed398213SEd Tanous         .privileges(redfish::privileges::getSensor)
2936002d39b4SEd Tanous         .methods(boost::beast::http::verb::get)(
2937e6bd846dSNan Zhou             std::bind_front(sensors::handleSensorGet, std::ref(app)));
293895a3ecadSAnthony Wilson }
293995a3ecadSAnthony Wilson 
294008777fb0SLewanczyk, Dawid } // namespace redfish
2941