blob: dd771951400c289f75e722abd5cc05cfad0a9260 [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",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -080052 [aResp{std::move(aResp)}](const boost::system::error_code& ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -070053 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",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -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",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800179 [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",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800200 [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
George Liu6c3e9452023-03-03 13:55:29 +0800253 dbus::utility::getAssociationEndPoints(
254 path + "/all_sensors",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800255 [health](const boost::system::error_code& ec2,
George Liu6c3e9452023-03-03 13:55:29 +0800256 const dbus::utility::MapperEndPoints& resp) {
Nan Zhoucf7eba02022-07-21 23:53:20 +0000257 if (ec2)
258 {
259 return; // no sensors = no failures
260 }
261 health->inventory = resp;
262 });
263
264 health->populate();
265
266 if (connectionNames.empty())
267 {
268 BMCWEB_LOG_ERROR << "Got 0 Connection names";
269 continue;
270 }
271
272 asyncResp->res.jsonValue["@odata.type"] =
273 "#Chassis.v1_16_0.Chassis";
274 asyncResp->res.jsonValue["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000275 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
276 chassisId);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000277 asyncResp->res.jsonValue["Name"] = "Chassis Collection";
278 asyncResp->res.jsonValue["ChassisType"] = "RackMount";
279 asyncResp->res.jsonValue["Actions"]["#Chassis.Reset"]["target"] =
Willy Tueddfc432022-09-26 16:46:38 +0000280 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
281 chassisId, "Actions",
282 "Chassis.Reset");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000283 asyncResp->res
284 .jsonValue["Actions"]["#Chassis.Reset"]["@Redfish.ActionInfo"] =
Willy Tueddfc432022-09-26 16:46:38 +0000285 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
286 chassisId, "ResetActionInfo");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000287 asyncResp->res.jsonValue["PCIeDevices"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000288 crow::utility::urlFromPieces("redfish", "v1", "Systems",
289 "system", "PCIeDevices");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000290
George Liu6c3e9452023-03-03 13:55:29 +0800291 dbus::utility::getAssociationEndPoints(
292 path + "/drive",
293 [asyncResp,
294 chassisId](const boost::system::error_code& ec3,
295 const dbus::utility::MapperEndPoints& resp) {
Nan Zhoucf7eba02022-07-21 23:53:20 +0000296 if (ec3 || resp.empty())
297 {
298 return; // no drives = no failures
299 }
300
301 nlohmann::json reference;
John Edward Broadbenta0cb40c2022-06-29 17:27:38 -0700302 reference["@odata.id"] = crow::utility::urlFromPieces(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000303 "redfish", "v1", "Chassis", chassisId, "Drives");
304 asyncResp->res.jsonValue["Drives"] = std::move(reference);
305 });
306
307 const std::string& connectionName = connectionNames[0].first;
308
309 const std::vector<std::string>& interfaces2 =
310 connectionNames[0].second;
311 const std::array<const char*, 2> hasIndicatorLed = {
312 "xyz.openbmc_project.Inventory.Item.Panel",
313 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
314
315 const std::string assetTagInterface =
316 "xyz.openbmc_project.Inventory.Decorator.AssetTag";
317 if (std::find(interfaces2.begin(), interfaces2.end(),
318 assetTagInterface) != interfaces2.end())
319 {
320 sdbusplus::asio::getProperty<std::string>(
321 *crow::connections::systemBus, connectionName, path,
322 assetTagInterface, "AssetTag",
323 [asyncResp, chassisId(std::string(chassisId))](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800324 const boost::system::error_code& ec2,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000325 const std::string& property) {
326 if (ec2)
327 {
328 BMCWEB_LOG_DEBUG << "DBus response error for AssetTag";
329 messages::internalError(asyncResp->res);
330 return;
331 }
332 asyncResp->res.jsonValue["AssetTag"] = property;
333 });
334 }
335
336 for (const char* interface : hasIndicatorLed)
337 {
338 if (std::find(interfaces2.begin(), interfaces2.end(),
339 interface) != interfaces2.end())
340 {
341 getIndicatorLedState(asyncResp);
342 getLocationIndicatorActive(asyncResp);
343 break;
344 }
345 }
346
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200347 sdbusplus::asio::getAllProperties(
348 *crow::connections::systemBus, connectionName, path,
349 "xyz.openbmc_project.Inventory.Decorator.Asset",
Nan Zhoucf7eba02022-07-21 23:53:20 +0000350 [asyncResp, chassisId(std::string(chassisId))](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800351 const boost::system::error_code& /*ec2*/,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000352 const dbus::utility::DBusPropertiesMap& propertiesList) {
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200353 const std::string* partNumber = nullptr;
354 const std::string* serialNumber = nullptr;
355 const std::string* manufacturer = nullptr;
356 const std::string* model = nullptr;
357 const std::string* sparePartNumber = nullptr;
358
359 const bool success = sdbusplus::unpackPropertiesNoThrow(
360 dbus_utils::UnpackErrorPrinter(), propertiesList,
361 "PartNumber", partNumber, "SerialNumber", serialNumber,
362 "Manufacturer", manufacturer, "Model", model,
363 "SparePartNumber", sparePartNumber);
364
365 if (!success)
Nan Zhoucf7eba02022-07-21 23:53:20 +0000366 {
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200367 messages::internalError(asyncResp->res);
368 return;
Nan Zhoucf7eba02022-07-21 23:53:20 +0000369 }
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200370
371 if (partNumber != nullptr)
372 {
373 asyncResp->res.jsonValue["PartNumber"] = *partNumber;
374 }
375
376 if (serialNumber != nullptr)
377 {
378 asyncResp->res.jsonValue["SerialNumber"] = *serialNumber;
379 }
380
381 if (manufacturer != nullptr)
382 {
383 asyncResp->res.jsonValue["Manufacturer"] = *manufacturer;
384 }
385
386 if (model != nullptr)
387 {
388 asyncResp->res.jsonValue["Model"] = *model;
389 }
390
391 // SparePartNumber is optional on D-Bus
392 // so skip if it is empty
393 if (sparePartNumber != nullptr && !sparePartNumber->empty())
394 {
395 asyncResp->res.jsonValue["SparePartNumber"] =
396 *sparePartNumber;
397 }
398
Nan Zhoucf7eba02022-07-21 23:53:20 +0000399 asyncResp->res.jsonValue["Name"] = chassisId;
400 asyncResp->res.jsonValue["Id"] = chassisId;
401#ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL
402 asyncResp->res.jsonValue["Thermal"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000403 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
404 chassisId, "Thermal");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000405 // Power object
406 asyncResp->res.jsonValue["Power"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000407 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
408 chassisId, "Power");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000409#endif
Xiaochao Ma29739632021-03-02 15:53:13 +0800410#ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
411 asyncResp->res.jsonValue["ThermalSubsystem"]["@odata.id"] =
412 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
413 chassisId, "ThermalSubsystem");
Chicago Duan77b36432021-02-05 15:48:26 +0800414 asyncResp->res.jsonValue["PowerSubsystem"]["@odata.id"] =
415 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
416 chassisId, "PowerSubsystem");
Albert Zhang4ca3ec32021-06-13 14:39:38 +0800417 asyncResp->res.jsonValue["EnvironmentMetrics"]["@odata.id"] =
418 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
419 chassisId,
420 "EnvironmentMetrics");
Xiaochao Ma29739632021-03-02 15:53:13 +0800421#endif
Nan Zhoucf7eba02022-07-21 23:53:20 +0000422 // SensorCollection
423 asyncResp->res.jsonValue["Sensors"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +0000424 crow::utility::urlFromPieces("redfish", "v1", "Chassis",
425 chassisId, "Sensors");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000426 asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
427
428 nlohmann::json::array_t computerSystems;
429 nlohmann::json::object_t system;
430 system["@odata.id"] = "/redfish/v1/Systems/system";
431 computerSystems.push_back(std::move(system));
432 asyncResp->res.jsonValue["Links"]["ComputerSystems"] =
433 std::move(computerSystems);
434
435 nlohmann::json::array_t managedBy;
436 nlohmann::json::object_t manager;
437 manager["@odata.id"] = "/redfish/v1/Managers/bmc";
438 managedBy.push_back(std::move(manager));
439 asyncResp->res.jsonValue["Links"]["ManagedBy"] =
440 std::move(managedBy);
441 getChassisState(asyncResp);
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +0200442 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000443
444 for (const auto& interface : interfaces2)
445 {
446 if (interface == "xyz.openbmc_project.Common.UUID")
447 {
448 getChassisUUID(asyncResp, connectionName, path);
449 }
450 else if (interface ==
451 "xyz.openbmc_project.Inventory.Decorator.LocationCode")
452 {
453 getChassisLocationCode(asyncResp, connectionName, path);
454 }
455 }
456
457 return;
458 }
459
460 // Couldn't find an object with that name. return an error
Jiaqing Zhaod8a5d5d2022-08-05 16:21:51 +0800461 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
George Liue99073f2022-12-09 11:06:16 +0800462 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000463
464 getPhysicalSecurityData(asyncResp);
465}
466
467inline void
468 handleChassisPatch(App& app, const crow::Request& req,
469 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
470 const std::string& param)
471{
472 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
473 {
474 return;
475 }
476 std::optional<bool> locationIndicatorActive;
477 std::optional<std::string> indicatorLed;
478
479 if (param.empty())
480 {
481 return;
482 }
483
484 if (!json_util::readJsonPatch(
485 req, asyncResp->res, "LocationIndicatorActive",
486 locationIndicatorActive, "IndicatorLED", indicatorLed))
487 {
488 return;
489 }
490
491 // TODO (Gunnar): Remove IndicatorLED after enough time has passed
492 if (!locationIndicatorActive && !indicatorLed)
493 {
494 return; // delete this when we support more patch properties
495 }
496 if (indicatorLed)
497 {
498 asyncResp->res.addHeader(
499 boost::beast::http::field::warning,
500 "299 - \"IndicatorLED is deprecated. Use LocationIndicatorActive instead.\"");
501 }
502
George Liue99073f2022-12-09 11:06:16 +0800503 constexpr std::array<std::string_view, 2> interfaces = {
Nan Zhoucf7eba02022-07-21 23:53:20 +0000504 "xyz.openbmc_project.Inventory.Item.Board",
505 "xyz.openbmc_project.Inventory.Item.Chassis"};
506
507 const std::string& chassisId = param;
508
George Liue99073f2022-12-09 11:06:16 +0800509 dbus::utility::getSubTree(
510 "/xyz/openbmc_project/inventory", 0, interfaces,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000511 [asyncResp, chassisId, locationIndicatorActive,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800512 indicatorLed](const boost::system::error_code& ec,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000513 const dbus::utility::MapperGetSubTreeResponse& subtree) {
514 if (ec)
515 {
516 messages::internalError(asyncResp->res);
517 return;
518 }
519
520 // Iterate over all retrieved ObjectPaths.
521 for (const std::pair<
522 std::string,
523 std::vector<std::pair<std::string, std::vector<std::string>>>>&
524 object : subtree)
525 {
526 const std::string& path = object.first;
527 const std::vector<std::pair<std::string, std::vector<std::string>>>&
528 connectionNames = object.second;
529
530 sdbusplus::message::object_path objPath(path);
531 if (objPath.filename() != chassisId)
532 {
533 continue;
534 }
535
536 if (connectionNames.empty())
537 {
538 BMCWEB_LOG_ERROR << "Got 0 Connection names";
539 continue;
540 }
541
542 const std::vector<std::string>& interfaces3 =
543 connectionNames[0].second;
544
545 const std::array<const char*, 2> hasIndicatorLed = {
546 "xyz.openbmc_project.Inventory.Item.Panel",
547 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
548 bool indicatorChassis = false;
549 for (const char* interface : hasIndicatorLed)
550 {
551 if (std::find(interfaces3.begin(), interfaces3.end(),
552 interface) != interfaces3.end())
553 {
554 indicatorChassis = true;
555 break;
556 }
557 }
558 if (locationIndicatorActive)
559 {
560 if (indicatorChassis)
561 {
562 setLocationIndicatorActive(asyncResp,
563 *locationIndicatorActive);
564 }
565 else
566 {
567 messages::propertyUnknown(asyncResp->res,
568 "LocationIndicatorActive");
569 }
570 }
571 if (indicatorLed)
572 {
573 if (indicatorChassis)
574 {
575 setIndicatorLedState(asyncResp, *indicatorLed);
576 }
577 else
578 {
579 messages::propertyUnknown(asyncResp->res, "IndicatorLED");
580 }
581 }
582 return;
583 }
584
Jiaqing Zhaod8a5d5d2022-08-05 16:21:51 +0800585 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
George Liue99073f2022-12-09 11:06:16 +0800586 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000587}
588
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100589/**
590 * Chassis override class for delivering Chassis Schema
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700591 * Functions triggers appropriate requests on DBus
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100592 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700593inline void requestRoutesChassis(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700594{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700595 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700596 .privileges(redfish::privileges::getChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700597 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000598 std::bind_front(handleChassisGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700599
600 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700601 .privileges(redfish::privileges::patchChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700602 .methods(boost::beast::http::verb::patch)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000603 std::bind_front(handleChassisPatch, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700604}
P.K. Leedd99e042020-06-17 19:43:16 +0800605
zhanghch058d1b46d2021-04-01 11:18:24 +0800606inline void
607 doChassisPowerCycle(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
P.K. Leedd99e042020-06-17 19:43:16 +0800608{
George Liu7a1dbc42022-12-07 16:03:22 +0800609 constexpr std::array<std::string_view, 1> interfaces = {
Vijay Khemkac3b3c922020-09-22 23:00:12 -0700610 "xyz.openbmc_project.State.Chassis"};
611
612 // Use mapper to get subtree paths.
George Liu7a1dbc42022-12-07 16:03:22 +0800613 dbus::utility::getSubTreePaths(
614 "/", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800615 [asyncResp](
George Liu7a1dbc42022-12-07 16:03:22 +0800616 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800617 const dbus::utility::MapperGetSubTreePathsResponse& chassisList) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700618 if (ec)
619 {
620 BMCWEB_LOG_DEBUG << "[mapper] Bad D-Bus request error: " << ec;
621 messages::internalError(asyncResp->res);
622 return;
623 }
624
625 const char* processName = "xyz.openbmc_project.State.Chassis";
626 const char* interfaceName = "xyz.openbmc_project.State.Chassis";
627 const char* destProperty = "RequestedPowerTransition";
628 const std::string propertyValue =
629 "xyz.openbmc_project.State.Chassis.Transition.PowerCycle";
630 std::string objectPath = "/xyz/openbmc_project/state/chassis_system0";
631
632 /* Look for system reset chassis path */
633 if ((std::find(chassisList.begin(), chassisList.end(), objectPath)) ==
634 chassisList.end())
635 {
636 /* We prefer to reset the full chassis_system, but if it doesn't
637 * exist on some platforms, fall back to a host-only power reset
638 */
639 objectPath = "/xyz/openbmc_project/state/chassis0";
640 }
641
642 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800643 [asyncResp](const boost::system::error_code& ec2) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700644 // Use "Set" method to set the property value.
Ed Tanous8a592812022-06-04 09:06:59 -0700645 if (ec2)
P.K. Leedd99e042020-06-17 19:43:16 +0800646 {
Ed Tanous8a592812022-06-04 09:06:59 -0700647 BMCWEB_LOG_DEBUG << "[Set] Bad D-Bus request error: " << ec2;
P.K. Leedd99e042020-06-17 19:43:16 +0800648 messages::internalError(asyncResp->res);
649 return;
650 }
651
Ed Tanous002d39b2022-05-31 08:59:27 -0700652 messages::success(asyncResp->res);
653 },
654 processName, objectPath, "org.freedesktop.DBus.Properties", "Set",
655 interfaceName, destProperty,
656 dbus::utility::DbusVariantType{propertyValue});
George Liu7a1dbc42022-12-07 16:03:22 +0800657 });
P.K. Leedd99e042020-06-17 19:43:16 +0800658}
659
Nan Zhoucf7eba02022-07-21 23:53:20 +0000660inline void handleChassisResetActionInfoPost(
661 App& app, const crow::Request& req,
662 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
663 const std::string& /*chassisId*/)
664{
665 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
666 {
667 return;
668 }
669 BMCWEB_LOG_DEBUG << "Post Chassis Reset.";
670
671 std::string resetType;
672
673 if (!json_util::readJsonAction(req, asyncResp->res, "ResetType", resetType))
674 {
675 return;
676 }
677
678 if (resetType != "PowerCycle")
679 {
680 BMCWEB_LOG_DEBUG << "Invalid property value for ResetType: "
681 << resetType;
682 messages::actionParameterNotSupported(asyncResp->res, resetType,
683 "ResetType");
684
685 return;
686 }
687 doChassisPowerCycle(asyncResp);
688}
689
P.K. Leedd99e042020-06-17 19:43:16 +0800690/**
691 * ChassisResetAction class supports the POST method for the Reset
692 * action.
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700693 * Function handles POST method request.
694 * Analyzes POST body before sending Reset request data to D-Bus.
P.K. Leedd99e042020-06-17 19:43:16 +0800695 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700696
697inline void requestRoutesChassisResetAction(App& app)
P.K. Leedd99e042020-06-17 19:43:16 +0800698{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700699 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Actions/Chassis.Reset/")
Ed Tanoused398212021-06-09 17:05:54 -0700700 .privileges(redfish::privileges::postChassis)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700701 .methods(boost::beast::http::verb::post)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000702 std::bind_front(handleChassisResetActionInfoPost, std::ref(app)));
703}
P.K. Leedd99e042020-06-17 19:43:16 +0800704
Nan Zhoucf7eba02022-07-21 23:53:20 +0000705inline void handleChassisResetActionInfoGet(
706 App& app, const crow::Request& req,
707 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
708 const std::string& chassisId)
709{
710 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
711 {
712 return;
713 }
714 asyncResp->res.jsonValue["@odata.type"] = "#ActionInfo.v1_1_2.ActionInfo";
Willy Tueddfc432022-09-26 16:46:38 +0000715 asyncResp->res.jsonValue["@odata.id"] = crow::utility::urlFromPieces(
716 "redfish", "v1", "Chassis", chassisId, "ResetActionInfo");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000717 asyncResp->res.jsonValue["Name"] = "Reset Action Info";
P.K. Leedd99e042020-06-17 19:43:16 +0800718
Nan Zhoucf7eba02022-07-21 23:53:20 +0000719 asyncResp->res.jsonValue["Id"] = "ResetActionInfo";
720 nlohmann::json::array_t parameters;
721 nlohmann::json::object_t parameter;
722 parameter["Name"] = "ResetType";
723 parameter["Required"] = true;
724 parameter["DataType"] = "String";
725 nlohmann::json::array_t allowed;
726 allowed.push_back("PowerCycle");
727 parameter["AllowableValues"] = std::move(allowed);
728 parameters.push_back(std::move(parameter));
P.K. Leedd99e042020-06-17 19:43:16 +0800729
Nan Zhoucf7eba02022-07-21 23:53:20 +0000730 asyncResp->res.jsonValue["Parameters"] = std::move(parameters);
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700731}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530732
733/**
734 * ChassisResetActionInfo derived class for delivering Chassis
735 * ResetType AllowableValues using ResetInfo schema.
736 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700737inline void requestRoutesChassisResetActionInfo(App& app)
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530738{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700739 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/ResetActionInfo/")
Ed Tanoused398212021-06-09 17:05:54 -0700740 .privileges(redfish::privileges::getActionInfo)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700741 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000742 std::bind_front(handleChassisResetActionInfoGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700743}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530744
Ed Tanous1abe55e2018-09-05 08:30:59 -0700745} // namespace redfish