blob: 4db6719173dc88a764ccccc3fb3518fa1e019720 [file] [log] [blame]
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +01001/*
2// Copyright (c) 2018 Intel Corporation
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15*/
16#pragma once
17
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080018#include "app.hpp"
George Liu7a1dbc42022-12-07 16:03:22 +080019#include "dbus_utility.hpp"
James Feistb49ac872019-05-21 15:12:01 -070020#include "health.hpp"
James Feist1c8fba92019-12-20 15:12:07 -080021#include "led.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080022#include "query.hpp"
23#include "registries/privilege_registry.hpp"
24#include "utils/collection.hpp"
25#include "utils/dbus_utils.hpp"
Nan Zhoucf7eba02022-07-21 23:53:20 +000026#include "utils/json_utils.hpp"
Ed Tanous1abe55e2018-09-05 08:30:59 -070027
George Liue99073f2022-12-09 11:06:16 +080028#include <boost/system/error_code.hpp>
Jonathan Doman1e1e5982021-06-11 09:36:17 -070029#include <sdbusplus/asio/property.hpp>
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +020030#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050031
George Liu7a1dbc42022-12-07 16:03:22 +080032#include <array>
33#include <string_view>
34
Ed Tanous1abe55e2018-09-05 08:30:59 -070035namespace redfish
36{
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +010037
38/**
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060039 * @brief Retrieves chassis state properties over dbus
40 *
41 * @param[in] aResp - Shared pointer for completing asynchronous calls.
42 *
43 * @return None.
44 */
zhanghch058d1b46d2021-04-01 11:18:24 +080045inline void getChassisState(std::shared_ptr<bmcweb::AsyncResp> aResp)
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060046{
Jonathan Doman1e1e5982021-06-11 09:36:17 -070047 // crow::connections::systemBus->async_method_call(
48 sdbusplus::asio::getProperty<std::string>(
49 *crow::connections::systemBus, "xyz.openbmc_project.State.Chassis",
50 "/xyz/openbmc_project/state/chassis0",
51 "xyz.openbmc_project.State.Chassis", "CurrentPowerState",
52 [aResp{std::move(aResp)}](const boost::system::error_code ec,
53 const std::string& chassisState) {
Ed Tanous002d39b2022-05-31 08:59:27 -070054 if (ec)
55 {
56 if (ec == boost::system::errc::host_unreachable)
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060057 {
Ed Tanous002d39b2022-05-31 08:59:27 -070058 // Service not available, no error, just don't return
59 // chassis state info
60 BMCWEB_LOG_DEBUG << "Service not available " << ec;
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060061 return;
62 }
Ed Tanous002d39b2022-05-31 08:59:27 -070063 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
64 messages::internalError(aResp->res);
65 return;
66 }
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060067
Ed Tanous002d39b2022-05-31 08:59:27 -070068 BMCWEB_LOG_DEBUG << "Chassis state: " << chassisState;
69 // Verify Chassis State
70 if (chassisState == "xyz.openbmc_project.State.Chassis.PowerState.On")
71 {
72 aResp->res.jsonValue["PowerState"] = "On";
73 aResp->res.jsonValue["Status"]["State"] = "Enabled";
74 }
75 else if (chassisState ==
76 "xyz.openbmc_project.State.Chassis.PowerState.Off")
77 {
78 aResp->res.jsonValue["PowerState"] = "Off";
79 aResp->res.jsonValue["Status"]["State"] = "StandbyOffline";
80 }
Jonathan Doman1e1e5982021-06-11 09:36:17 -070081 });
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060082}
83
zhanghch058d1b46d2021-04-01 11:18:24 +080084inline void getIntrusionByService(std::shared_ptr<bmcweb::AsyncResp> aResp,
Ed Tanous23a21a12020-07-25 04:45:05 +000085 const std::string& service,
86 const std::string& objPath)
Qiang XUc1819422019-02-27 13:51:32 +080087{
88 BMCWEB_LOG_DEBUG << "Get intrusion status by service \n";
89
Jonathan Doman1e1e5982021-06-11 09:36:17 -070090 sdbusplus::asio::getProperty<std::string>(
91 *crow::connections::systemBus, service, objPath,
92 "xyz.openbmc_project.Chassis.Intrusion", "Status",
Qiang XUc1819422019-02-27 13:51:32 +080093 [aResp{std::move(aResp)}](const boost::system::error_code ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -070094 const std::string& value) {
Ed Tanous002d39b2022-05-31 08:59:27 -070095 if (ec)
96 {
97 // do not add err msg in redfish response, because this is not
98 // mandatory property
99 BMCWEB_LOG_ERROR << "DBUS response error " << ec << "\n";
100 return;
101 }
Qiang XUc1819422019-02-27 13:51:32 +0800102
Ed Tanous002d39b2022-05-31 08:59:27 -0700103 aResp->res.jsonValue["PhysicalSecurity"]["IntrusionSensorNumber"] = 1;
104 aResp->res.jsonValue["PhysicalSecurity"]["IntrusionSensor"] = value;
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700105 });
Qiang XUc1819422019-02-27 13:51:32 +0800106}
107
108/**
109 * Retrieves physical security properties over dbus
110 */
zhanghch058d1b46d2021-04-01 11:18:24 +0800111inline void getPhysicalSecurityData(std::shared_ptr<bmcweb::AsyncResp> aResp)
Qiang XUc1819422019-02-27 13:51:32 +0800112{
George Liue99073f2022-12-09 11:06:16 +0800113 constexpr std::array<std::string_view, 1> interfaces = {
114 "xyz.openbmc_project.Chassis.Intrusion"};
115 dbus::utility::getSubTree(
116 "/xyz/openbmc_project/Intrusion", 1, interfaces,
Qiang XUc1819422019-02-27 13:51:32 +0800117 [aResp{std::move(aResp)}](
George Liue99073f2022-12-09 11:06:16 +0800118 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800119 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700120 if (ec)
121 {
122 // do not add err msg in redfish response, because this is not
123 // mandatory property
124 BMCWEB_LOG_INFO << "DBUS error: no matched iface " << ec << "\n";
125 return;
126 }
127 // Iterate over all retrieved ObjectPaths.
128 for (const auto& object : subtree)
129 {
130 for (const auto& service : object.second)
Qiang XUc1819422019-02-27 13:51:32 +0800131 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700132 getIntrusionByService(aResp, service.first, object.first);
Qiang XUc1819422019-02-27 13:51:32 +0800133 return;
134 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700135 }
George Liue99073f2022-12-09 11:06:16 +0800136 });
Qiang XUc1819422019-02-27 13:51:32 +0800137}
138
Nan Zhoucf7eba02022-07-21 23:53:20 +0000139inline void handleChassisCollectionGet(
140 App& app, const crow::Request& req,
141 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
142{
143 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
144 {
145 return;
146 }
147 asyncResp->res.jsonValue["@odata.type"] =
148 "#ChassisCollection.ChassisCollection";
149 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Chassis";
150 asyncResp->res.jsonValue["Name"] = "Chassis Collection";
151
George Liu7a1dbc42022-12-07 16:03:22 +0800152 constexpr std::array<std::string_view, 2> interfaces{
153 "xyz.openbmc_project.Inventory.Item.Board",
154 "xyz.openbmc_project.Inventory.Item.Chassis"};
Nan Zhoucf7eba02022-07-21 23:53:20 +0000155 collection_util::getCollectionMembers(
George Liu7a1dbc42022-12-07 16:03:22 +0800156 asyncResp, boost::urls::url("/redfish/v1/Chassis"), interfaces);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000157}
158
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100159/**
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100160 * ChassisCollection derived class for delivering Chassis Collection Schema
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700161 * Functions triggers appropriate requests on DBus
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100162 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700163inline void requestRoutesChassisCollection(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700164{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700165 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/")
Ed Tanoused398212021-06-09 17:05:54 -0700166 .privileges(redfish::privileges::getChassisCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700167 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000168 std::bind_front(handleChassisCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700169}
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100170
Willy Tu308f70c2021-09-28 20:24:52 -0700171inline void
172 getChassisLocationCode(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
173 const std::string& connectionName,
174 const std::string& path)
175{
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700176 sdbusplus::asio::getProperty<std::string>(
177 *crow::connections::systemBus, connectionName, path,
178 "xyz.openbmc_project.Inventory.Decorator.LocationCode", "LocationCode",
Willy Tu308f70c2021-09-28 20:24:52 -0700179 [asyncResp](const boost::system::error_code ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700180 const std::string& property) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700181 if (ec)
182 {
183 BMCWEB_LOG_DEBUG << "DBUS response error for Location";
184 messages::internalError(asyncResp->res);
185 return;
186 }
Willy Tu308f70c2021-09-28 20:24:52 -0700187
Ed Tanous002d39b2022-05-31 08:59:27 -0700188 asyncResp->res.jsonValue["Location"]["PartLocation"]["ServiceLabel"] =
189 property;
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700190 });
Willy Tu308f70c2021-09-28 20:24:52 -0700191}
192
193inline void getChassisUUID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
194 const std::string& connectionName,
195 const std::string& path)
196{
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700197 sdbusplus::asio::getProperty<std::string>(
198 *crow::connections::systemBus, connectionName, path,
199 "xyz.openbmc_project.Common.UUID", "UUID",
Willy Tu308f70c2021-09-28 20:24:52 -0700200 [asyncResp](const boost::system::error_code ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700201 const std::string& chassisUUID) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700202 if (ec)
203 {
204 BMCWEB_LOG_DEBUG << "DBUS response error for UUID";
205 messages::internalError(asyncResp->res);
206 return;
207 }
208 asyncResp->res.jsonValue["UUID"] = chassisUUID;
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700209 });
Willy Tu308f70c2021-09-28 20:24:52 -0700210}
211
Nan Zhoucf7eba02022-07-21 23:53:20 +0000212inline void
213 handleChassisGet(App& app, const crow::Request& req,
214 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
215 const std::string& chassisId)
216{
217 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
218 {
219 return;
220 }
George Liue99073f2022-12-09 11:06:16 +0800221 constexpr std::array<std::string_view, 2> interfaces = {
Nan Zhoucf7eba02022-07-21 23:53:20 +0000222 "xyz.openbmc_project.Inventory.Item.Board",
223 "xyz.openbmc_project.Inventory.Item.Chassis"};
224
George Liue99073f2022-12-09 11:06:16 +0800225 dbus::utility::getSubTree(
226 "/xyz/openbmc_project/inventory", 0, interfaces,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000227 [asyncResp, chassisId(std::string(chassisId))](
George Liue99073f2022-12-09 11:06:16 +0800228 const boost::system::error_code& ec,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000229 const dbus::utility::MapperGetSubTreeResponse& subtree) {
230 if (ec)
231 {
232 messages::internalError(asyncResp->res);
233 return;
234 }
235 // Iterate over all retrieved ObjectPaths.
236 for (const std::pair<
237 std::string,
238 std::vector<std::pair<std::string, std::vector<std::string>>>>&
239 object : subtree)
240 {
241 const std::string& path = object.first;
242 const std::vector<std::pair<std::string, std::vector<std::string>>>&
243 connectionNames = object.second;
244
245 sdbusplus::message::object_path objPath(path);
246 if (objPath.filename() != chassisId)
247 {
248 continue;
249 }
250
251 auto health = std::make_shared<HealthPopulate>(asyncResp);
252
253 sdbusplus::asio::getProperty<std::vector<std::string>>(
254 *crow::connections::systemBus,
255 "xyz.openbmc_project.ObjectMapper", path + "/all_sensors",
256 "xyz.openbmc_project.Association", "endpoints",
257 [health](const boost::system::error_code ec2,
258 const std::vector<std::string>& resp) {
259 if (ec2)
260 {
261 return; // no sensors = no failures
262 }
263 health->inventory = resp;
264 });
265
266 health->populate();
267
268 if (connectionNames.empty())
269 {
270 BMCWEB_LOG_ERROR << "Got 0 Connection names";
271 continue;
272 }
273
274 asyncResp->res.jsonValue["@odata.type"] =
275 "#Chassis.v1_16_0.Chassis";
276 asyncResp->res.jsonValue["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000277 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
278 chassisId);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000279 asyncResp->res.jsonValue["Name"] = "Chassis Collection";
280 asyncResp->res.jsonValue["ChassisType"] = "RackMount";
281 asyncResp->res.jsonValue["Actions"]["#Chassis.Reset"]["target"] =
Willy Tueddfc432022-09-26 16:46:38 +0000282 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
283 chassisId, "Actions",
284 "Chassis.Reset");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000285 asyncResp->res
286 .jsonValue["Actions"]["#Chassis.Reset"]["@Redfish.ActionInfo"] =
Willy Tueddfc432022-09-26 16:46:38 +0000287 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
288 chassisId, "ResetActionInfo");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000289 asyncResp->res.jsonValue["PCIeDevices"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000290 crow::utility::urlFromPieces("redfish", "v1", "Systems",
291 "system", "PCIeDevices");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000292
293 sdbusplus::asio::getProperty<std::vector<std::string>>(
294 *crow::connections::systemBus,
295 "xyz.openbmc_project.ObjectMapper", path + "/drive",
296 "xyz.openbmc_project.Association", "endpoints",
297 [asyncResp, chassisId](const boost::system::error_code ec3,
298 const std::vector<std::string>& resp) {
299 if (ec3 || resp.empty())
300 {
301 return; // no drives = no failures
302 }
303
304 nlohmann::json reference;
John Edward Broadbenta0cb40c2022-06-29 17:27:38 -0700305 reference["@odata.id"] = crow::utility::urlFromPieces(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000306 "redfish", "v1", "Chassis", chassisId, "Drives");
307 asyncResp->res.jsonValue["Drives"] = std::move(reference);
308 });
309
310 const std::string& connectionName = connectionNames[0].first;
311
312 const std::vector<std::string>& interfaces2 =
313 connectionNames[0].second;
314 const std::array<const char*, 2> hasIndicatorLed = {
315 "xyz.openbmc_project.Inventory.Item.Panel",
316 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
317
318 const std::string assetTagInterface =
319 "xyz.openbmc_project.Inventory.Decorator.AssetTag";
320 if (std::find(interfaces2.begin(), interfaces2.end(),
321 assetTagInterface) != interfaces2.end())
322 {
323 sdbusplus::asio::getProperty<std::string>(
324 *crow::connections::systemBus, connectionName, path,
325 assetTagInterface, "AssetTag",
326 [asyncResp, chassisId(std::string(chassisId))](
327 const boost::system::error_code ec2,
328 const std::string& property) {
329 if (ec2)
330 {
331 BMCWEB_LOG_DEBUG << "DBus response error for AssetTag";
332 messages::internalError(asyncResp->res);
333 return;
334 }
335 asyncResp->res.jsonValue["AssetTag"] = property;
336 });
337 }
338
339 for (const char* interface : hasIndicatorLed)
340 {
341 if (std::find(interfaces2.begin(), interfaces2.end(),
342 interface) != interfaces2.end())
343 {
344 getIndicatorLedState(asyncResp);
345 getLocationIndicatorActive(asyncResp);
346 break;
347 }
348 }
349
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200350 sdbusplus::asio::getAllProperties(
351 *crow::connections::systemBus, connectionName, path,
352 "xyz.openbmc_project.Inventory.Decorator.Asset",
Nan Zhoucf7eba02022-07-21 23:53:20 +0000353 [asyncResp, chassisId(std::string(chassisId))](
354 const boost::system::error_code /*ec2*/,
355 const dbus::utility::DBusPropertiesMap& propertiesList) {
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200356 const std::string* partNumber = nullptr;
357 const std::string* serialNumber = nullptr;
358 const std::string* manufacturer = nullptr;
359 const std::string* model = nullptr;
360 const std::string* sparePartNumber = nullptr;
361
362 const bool success = sdbusplus::unpackPropertiesNoThrow(
363 dbus_utils::UnpackErrorPrinter(), propertiesList,
364 "PartNumber", partNumber, "SerialNumber", serialNumber,
365 "Manufacturer", manufacturer, "Model", model,
366 "SparePartNumber", sparePartNumber);
367
368 if (!success)
Nan Zhoucf7eba02022-07-21 23:53:20 +0000369 {
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200370 messages::internalError(asyncResp->res);
371 return;
Nan Zhoucf7eba02022-07-21 23:53:20 +0000372 }
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200373
374 if (partNumber != nullptr)
375 {
376 asyncResp->res.jsonValue["PartNumber"] = *partNumber;
377 }
378
379 if (serialNumber != nullptr)
380 {
381 asyncResp->res.jsonValue["SerialNumber"] = *serialNumber;
382 }
383
384 if (manufacturer != nullptr)
385 {
386 asyncResp->res.jsonValue["Manufacturer"] = *manufacturer;
387 }
388
389 if (model != nullptr)
390 {
391 asyncResp->res.jsonValue["Model"] = *model;
392 }
393
394 // SparePartNumber is optional on D-Bus
395 // so skip if it is empty
396 if (sparePartNumber != nullptr && !sparePartNumber->empty())
397 {
398 asyncResp->res.jsonValue["SparePartNumber"] =
399 *sparePartNumber;
400 }
401
Nan Zhoucf7eba02022-07-21 23:53:20 +0000402 asyncResp->res.jsonValue["Name"] = chassisId;
403 asyncResp->res.jsonValue["Id"] = chassisId;
404#ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL
405 asyncResp->res.jsonValue["Thermal"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000406 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
407 chassisId, "Thermal");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000408 // Power object
409 asyncResp->res.jsonValue["Power"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000410 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
411 chassisId, "Power");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000412#endif
Xiaochao Ma29739632021-03-02 15:53:13 +0800413#ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
414 asyncResp->res.jsonValue["ThermalSubsystem"]["@odata.id"] =
415 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
416 chassisId, "ThermalSubsystem");
Chicago Duan77b36432021-02-05 15:48:26 +0800417 asyncResp->res.jsonValue["PowerSubsystem"]["@odata.id"] =
418 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
419 chassisId, "PowerSubsystem");
Albert Zhang4ca3ec32021-06-13 14:39:38 +0800420 asyncResp->res.jsonValue["EnvironmentMetrics"]["@odata.id"] =
421 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
422 chassisId,
423 "EnvironmentMetrics");
Xiaochao Ma29739632021-03-02 15:53:13 +0800424#endif
Nan Zhoucf7eba02022-07-21 23:53:20 +0000425 // SensorCollection
426 asyncResp->res.jsonValue["Sensors"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000427 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
428 chassisId, "Sensors");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000429 asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
430
431 nlohmann::json::array_t computerSystems;
432 nlohmann::json::object_t system;
433 system["@odata.id"] = "/redfish/v1/Systems/system";
434 computerSystems.push_back(std::move(system));
435 asyncResp->res.jsonValue["Links"]["ComputerSystems"] =
436 std::move(computerSystems);
437
438 nlohmann::json::array_t managedBy;
439 nlohmann::json::object_t manager;
440 manager["@odata.id"] = "/redfish/v1/Managers/bmc";
441 managedBy.push_back(std::move(manager));
442 asyncResp->res.jsonValue["Links"]["ManagedBy"] =
443 std::move(managedBy);
444 getChassisState(asyncResp);
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200445 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000446
447 for (const auto& interface : interfaces2)
448 {
449 if (interface == "xyz.openbmc_project.Common.UUID")
450 {
451 getChassisUUID(asyncResp, connectionName, path);
452 }
453 else if (interface ==
454 "xyz.openbmc_project.Inventory.Decorator.LocationCode")
455 {
456 getChassisLocationCode(asyncResp, connectionName, path);
457 }
458 }
459
460 return;
461 }
462
463 // Couldn't find an object with that name. return an error
Jiaqing Zhaod8a5d5d2022-08-05 16:21:51 +0800464 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
George Liue99073f2022-12-09 11:06:16 +0800465 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000466
467 getPhysicalSecurityData(asyncResp);
468}
469
470inline void
471 handleChassisPatch(App& app, const crow::Request& req,
472 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
473 const std::string& param)
474{
475 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
476 {
477 return;
478 }
479 std::optional<bool> locationIndicatorActive;
480 std::optional<std::string> indicatorLed;
481
482 if (param.empty())
483 {
484 return;
485 }
486
487 if (!json_util::readJsonPatch(
488 req, asyncResp->res, "LocationIndicatorActive",
489 locationIndicatorActive, "IndicatorLED", indicatorLed))
490 {
491 return;
492 }
493
494 // TODO (Gunnar): Remove IndicatorLED after enough time has passed
495 if (!locationIndicatorActive && !indicatorLed)
496 {
497 return; // delete this when we support more patch properties
498 }
499 if (indicatorLed)
500 {
501 asyncResp->res.addHeader(
502 boost::beast::http::field::warning,
503 "299 - \"IndicatorLED is deprecated. Use LocationIndicatorActive instead.\"");
504 }
505
George Liue99073f2022-12-09 11:06:16 +0800506 constexpr std::array<std::string_view, 2> interfaces = {
Nan Zhoucf7eba02022-07-21 23:53:20 +0000507 "xyz.openbmc_project.Inventory.Item.Board",
508 "xyz.openbmc_project.Inventory.Item.Chassis"};
509
510 const std::string& chassisId = param;
511
George Liue99073f2022-12-09 11:06:16 +0800512 dbus::utility::getSubTree(
513 "/xyz/openbmc_project/inventory", 0, interfaces,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000514 [asyncResp, chassisId, locationIndicatorActive,
515 indicatorLed](const boost::system::error_code ec,
516 const dbus::utility::MapperGetSubTreeResponse& subtree) {
517 if (ec)
518 {
519 messages::internalError(asyncResp->res);
520 return;
521 }
522
523 // Iterate over all retrieved ObjectPaths.
524 for (const std::pair<
525 std::string,
526 std::vector<std::pair<std::string, std::vector<std::string>>>>&
527 object : subtree)
528 {
529 const std::string& path = object.first;
530 const std::vector<std::pair<std::string, std::vector<std::string>>>&
531 connectionNames = object.second;
532
533 sdbusplus::message::object_path objPath(path);
534 if (objPath.filename() != chassisId)
535 {
536 continue;
537 }
538
539 if (connectionNames.empty())
540 {
541 BMCWEB_LOG_ERROR << "Got 0 Connection names";
542 continue;
543 }
544
545 const std::vector<std::string>& interfaces3 =
546 connectionNames[0].second;
547
548 const std::array<const char*, 2> hasIndicatorLed = {
549 "xyz.openbmc_project.Inventory.Item.Panel",
550 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
551 bool indicatorChassis = false;
552 for (const char* interface : hasIndicatorLed)
553 {
554 if (std::find(interfaces3.begin(), interfaces3.end(),
555 interface) != interfaces3.end())
556 {
557 indicatorChassis = true;
558 break;
559 }
560 }
561 if (locationIndicatorActive)
562 {
563 if (indicatorChassis)
564 {
565 setLocationIndicatorActive(asyncResp,
566 *locationIndicatorActive);
567 }
568 else
569 {
570 messages::propertyUnknown(asyncResp->res,
571 "LocationIndicatorActive");
572 }
573 }
574 if (indicatorLed)
575 {
576 if (indicatorChassis)
577 {
578 setIndicatorLedState(asyncResp, *indicatorLed);
579 }
580 else
581 {
582 messages::propertyUnknown(asyncResp->res, "IndicatorLED");
583 }
584 }
585 return;
586 }
587
Jiaqing Zhaod8a5d5d2022-08-05 16:21:51 +0800588 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
George Liue99073f2022-12-09 11:06:16 +0800589 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000590}
591
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100592/**
593 * Chassis override class for delivering Chassis Schema
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700594 * Functions triggers appropriate requests on DBus
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100595 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700596inline void requestRoutesChassis(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700597{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700598 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700599 .privileges(redfish::privileges::getChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700600 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000601 std::bind_front(handleChassisGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700602
603 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700604 .privileges(redfish::privileges::patchChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700605 .methods(boost::beast::http::verb::patch)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000606 std::bind_front(handleChassisPatch, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700607}
P.K. Leedd99e042020-06-17 19:43:16 +0800608
zhanghch058d1b46d2021-04-01 11:18:24 +0800609inline void
610 doChassisPowerCycle(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
P.K. Leedd99e042020-06-17 19:43:16 +0800611{
George Liu7a1dbc42022-12-07 16:03:22 +0800612 constexpr std::array<std::string_view, 1> interfaces = {
Vijay Khemkac3b3c922020-09-22 23:00:12 -0700613 "xyz.openbmc_project.State.Chassis"};
614
615 // Use mapper to get subtree paths.
George Liu7a1dbc42022-12-07 16:03:22 +0800616 dbus::utility::getSubTreePaths(
617 "/", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800618 [asyncResp](
George Liu7a1dbc42022-12-07 16:03:22 +0800619 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800620 const dbus::utility::MapperGetSubTreePathsResponse& chassisList) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700621 if (ec)
622 {
623 BMCWEB_LOG_DEBUG << "[mapper] Bad D-Bus request error: " << ec;
624 messages::internalError(asyncResp->res);
625 return;
626 }
627
628 const char* processName = "xyz.openbmc_project.State.Chassis";
629 const char* interfaceName = "xyz.openbmc_project.State.Chassis";
630 const char* destProperty = "RequestedPowerTransition";
631 const std::string propertyValue =
632 "xyz.openbmc_project.State.Chassis.Transition.PowerCycle";
633 std::string objectPath = "/xyz/openbmc_project/state/chassis_system0";
634
635 /* Look for system reset chassis path */
636 if ((std::find(chassisList.begin(), chassisList.end(), objectPath)) ==
637 chassisList.end())
638 {
639 /* We prefer to reset the full chassis_system, but if it doesn't
640 * exist on some platforms, fall back to a host-only power reset
641 */
642 objectPath = "/xyz/openbmc_project/state/chassis0";
643 }
644
645 crow::connections::systemBus->async_method_call(
Ed Tanous8a592812022-06-04 09:06:59 -0700646 [asyncResp](const boost::system::error_code ec2) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700647 // Use "Set" method to set the property value.
Ed Tanous8a592812022-06-04 09:06:59 -0700648 if (ec2)
P.K. Leedd99e042020-06-17 19:43:16 +0800649 {
Ed Tanous8a592812022-06-04 09:06:59 -0700650 BMCWEB_LOG_DEBUG << "[Set] Bad D-Bus request error: " << ec2;
P.K. Leedd99e042020-06-17 19:43:16 +0800651 messages::internalError(asyncResp->res);
652 return;
653 }
654
Ed Tanous002d39b2022-05-31 08:59:27 -0700655 messages::success(asyncResp->res);
656 },
657 processName, objectPath, "org.freedesktop.DBus.Properties", "Set",
658 interfaceName, destProperty,
659 dbus::utility::DbusVariantType{propertyValue});
George Liu7a1dbc42022-12-07 16:03:22 +0800660 });
P.K. Leedd99e042020-06-17 19:43:16 +0800661}
662
Nan Zhoucf7eba02022-07-21 23:53:20 +0000663inline void handleChassisResetActionInfoPost(
664 App& app, const crow::Request& req,
665 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
666 const std::string& /*chassisId*/)
667{
668 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
669 {
670 return;
671 }
672 BMCWEB_LOG_DEBUG << "Post Chassis Reset.";
673
674 std::string resetType;
675
676 if (!json_util::readJsonAction(req, asyncResp->res, "ResetType", resetType))
677 {
678 return;
679 }
680
681 if (resetType != "PowerCycle")
682 {
683 BMCWEB_LOG_DEBUG << "Invalid property value for ResetType: "
684 << resetType;
685 messages::actionParameterNotSupported(asyncResp->res, resetType,
686 "ResetType");
687
688 return;
689 }
690 doChassisPowerCycle(asyncResp);
691}
692
P.K. Leedd99e042020-06-17 19:43:16 +0800693/**
694 * ChassisResetAction class supports the POST method for the Reset
695 * action.
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700696 * Function handles POST method request.
697 * Analyzes POST body before sending Reset request data to D-Bus.
P.K. Leedd99e042020-06-17 19:43:16 +0800698 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700699
700inline void requestRoutesChassisResetAction(App& app)
P.K. Leedd99e042020-06-17 19:43:16 +0800701{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700702 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Actions/Chassis.Reset/")
Ed Tanoused398212021-06-09 17:05:54 -0700703 .privileges(redfish::privileges::postChassis)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700704 .methods(boost::beast::http::verb::post)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000705 std::bind_front(handleChassisResetActionInfoPost, std::ref(app)));
706}
P.K. Leedd99e042020-06-17 19:43:16 +0800707
Nan Zhoucf7eba02022-07-21 23:53:20 +0000708inline void handleChassisResetActionInfoGet(
709 App& app, const crow::Request& req,
710 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
711 const std::string& chassisId)
712{
713 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
714 {
715 return;
716 }
717 asyncResp->res.jsonValue["@odata.type"] = "#ActionInfo.v1_1_2.ActionInfo";
Willy Tueddfc432022-09-26 16:46:38 +0000718 asyncResp->res.jsonValue["@odata.id"] = crow::utility::urlFromPieces(
719 "redfish", "v1", "Chassis", chassisId, "ResetActionInfo");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000720 asyncResp->res.jsonValue["Name"] = "Reset Action Info";
P.K. Leedd99e042020-06-17 19:43:16 +0800721
Nan Zhoucf7eba02022-07-21 23:53:20 +0000722 asyncResp->res.jsonValue["Id"] = "ResetActionInfo";
723 nlohmann::json::array_t parameters;
724 nlohmann::json::object_t parameter;
725 parameter["Name"] = "ResetType";
726 parameter["Required"] = true;
727 parameter["DataType"] = "String";
728 nlohmann::json::array_t allowed;
729 allowed.push_back("PowerCycle");
730 parameter["AllowableValues"] = std::move(allowed);
731 parameters.push_back(std::move(parameter));
P.K. Leedd99e042020-06-17 19:43:16 +0800732
Nan Zhoucf7eba02022-07-21 23:53:20 +0000733 asyncResp->res.jsonValue["Parameters"] = std::move(parameters);
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700734}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530735
736/**
737 * ChassisResetActionInfo derived class for delivering Chassis
738 * ResetType AllowableValues using ResetInfo schema.
739 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700740inline void requestRoutesChassisResetActionInfo(App& app)
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530741{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700742 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/ResetActionInfo/")
Ed Tanoused398212021-06-09 17:05:54 -0700743 .privileges(redfish::privileges::getActionInfo)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700744 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000745 std::bind_front(handleChassisResetActionInfoGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700746}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530747
Ed Tanous1abe55e2018-09-05 08:30:59 -0700748} // namespace redfish