blob: 2f8cbadc458cff623e2dc5971b503e5fa1090bc8 [file] [log] [blame]
Patrick Venture46470a32018-09-07 19:26:25 -07001#include "config.h"
2
3#include "chassishandler.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07004
Patrick Venture0b02be92018-08-31 11:55:55 -07005#include <arpa/inet.h>
6#include <endian.h>
7#include <limits.h>
Patrick Venture0b02be92018-08-31 11:55:55 -07008#include <netinet/in.h>
Patrick Venture0b02be92018-08-31 11:55:55 -07009
Vernon Mauerye08fbff2019-04-03 09:19:34 -070010#include <ipmid/api.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070011#include <ipmid/types.hpp>
Vernon Mauery6a98fe72019-03-11 15:57:48 -070012#include <ipmid/utils.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070013#include <phosphor-logging/elog-errors.hpp>
Vernon Mauery38108d92024-03-11 12:53:55 -070014#include <phosphor-logging/lg2.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070015#include <sdbusplus/bus.hpp>
William A. Kennington III4c008022018-10-12 17:18:14 -070016#include <sdbusplus/message/types.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070017#include <sdbusplus/server/object.hpp>
Vernon Mauery1181af72018-10-08 12:05:00 -070018#include <sdbusplus/timer.hpp>
Vernon Mauerye278ead2018-10-09 09:23:43 -070019#include <settings.hpp>
Chau Ly8c1376c2024-01-05 07:22:10 +000020#include <xyz/openbmc_project/Chassis/Intrusion/client.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070021#include <xyz/openbmc_project/Common/error.hpp>
22#include <xyz/openbmc_project/Control/Boot/Mode/server.hpp>
23#include <xyz/openbmc_project/Control/Boot/Source/server.hpp>
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +030024#include <xyz/openbmc_project/Control/Boot/Type/server.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070025#include <xyz/openbmc_project/Control/Power/RestorePolicy/server.hpp>
Jason M. Billsad588bf2020-01-30 16:18:33 -080026#include <xyz/openbmc_project/State/Chassis/server.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070027#include <xyz/openbmc_project/State/Host/server.hpp>
28#include <xyz/openbmc_project/State/PowerOnHours/server.hpp>
29
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050030#include <array>
31#include <chrono>
32#include <cstring>
33#include <filesystem>
34#include <fstream>
35#include <future>
36#include <map>
37#include <sstream>
38#include <string>
39
Patrick Williams95655222023-12-05 12:45:02 -060040std::unique_ptr<sdbusplus::Timer> identifyTimer
Lei YU4b0ddb62019-01-25 16:43:50 +080041 __attribute__((init_priority(101)));
Marri Devender Rao6706c1c2018-05-14 00:29:38 -050042
Yong Lif4e38512019-05-21 14:46:55 +080043static ChassisIDState chassisIDState = ChassisIDState::reserved;
44
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000045constexpr size_t sizeVersion = 2;
Tom Joseph5110c122018-03-23 17:55:40 +053046constexpr size_t DEFAULT_IDENTIFY_TIME_OUT = 15;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +053047
Patrick Venture0b02be92018-08-31 11:55:55 -070048// PetiBoot-Specific
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000049static constexpr uint8_t netConfInitialBytes[] = {0x80, 0x21, 0x70, 0x62,
50 0x21, 0x00, 0x01, 0x06};
51static constexpr uint8_t oemParmStart = 96;
52static constexpr uint8_t oemParmEnd = 127;
Ratan Guptafd28dd72016-08-01 04:58:01 -050053
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000054static constexpr size_t cookieOffset = 1;
55static constexpr size_t versionOffset = 5;
56static constexpr size_t addrSizeOffset = 8;
57static constexpr size_t macOffset = 9;
58static constexpr size_t addrTypeOffset = 16;
59static constexpr size_t ipAddrOffset = 17;
ratagupta6f6bff2016-04-04 06:20:11 -050060
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000061namespace ipmi
62{
63constexpr Cc ccParmNotSupported = 0x80;
George Liuf5dd1022025-07-07 09:13:07 +080064constexpr Cc ccFailSetInProgress = 0x81;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000065
66static inline auto responseParmNotSupported()
67{
68 return response(ccParmNotSupported);
69}
George Liuf5dd1022025-07-07 09:13:07 +080070
71static inline auto responsefailSetInProgress()
72{
73 return response(ccFailSetInProgress);
74}
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000075} // namespace ipmi
76
George Liu5087b072025-03-11 19:28:17 +080077void registerNetFnChassisFunctions() __attribute__((constructor));
Adriana Kobylak40814c62015-10-27 15:58:44 -050078
shgoupfd84fbbf2015-12-17 10:05:51 +080079// Host settings in dbus
80// Service name should be referenced by connection name got via object mapper
Patrick Venture0b02be92018-08-31 11:55:55 -070081const char* settings_object_name = "/org/openbmc/settings/host0";
82const char* settings_intf_name = "org.freedesktop.DBus.Properties";
Patrick Venture0b02be92018-08-31 11:55:55 -070083const char* identify_led_object_name =
Tom Joseph5110c122018-03-23 17:55:40 +053084 "/xyz/openbmc_project/led/groups/enclosure_identify";
shgoupfd84fbbf2015-12-17 10:05:51 +080085
Ratan Guptadcb10672017-07-10 10:33:50 +053086constexpr auto SETTINGS_ROOT = "/";
87constexpr auto SETTINGS_MATCH = "host0";
Ratan Guptadcb10672017-07-10 10:33:50 +053088
89constexpr auto IP_INTERFACE = "xyz.openbmc_project.Network.IP";
90constexpr auto MAC_INTERFACE = "xyz.openbmc_project.Network.MACAddress";
91
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -050092static constexpr auto chassisStateRoot = "/xyz/openbmc_project/state";
93static constexpr auto chassisPOHStateIntf =
Patrick Venture0b02be92018-08-31 11:55:55 -070094 "xyz.openbmc_project.State.PowerOnHours";
Patrick Williams7345ac42021-04-30 20:57:39 -050095static constexpr auto pohCounterProperty = "POHCounter";
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -050096static constexpr auto match = "chassis0";
Yong Liae4b0402018-11-02 11:12:14 +080097const static constexpr char chassisCapIntf[] =
98 "xyz.openbmc_project.Control.ChassisCapabilities";
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -080099const static constexpr char chassisIntrusionProp[] = "ChassisIntrusionEnabled";
100const static constexpr char chassisFrontPanelLockoutProp[] =
101 "ChassisFrontPanelLockoutEnabled";
102const static constexpr char chassisNMIProp[] = "ChassisNMIEnabled";
103const static constexpr char chassisPowerInterlockProp[] =
104 "ChassisPowerInterlockEnabled";
Yong Liae4b0402018-11-02 11:12:14 +0800105const static constexpr char chassisFRUDevAddrProp[] = "FRUDeviceAddress";
106const static constexpr char chassisSDRDevAddrProp[] = "SDRDeviceAddress";
107const static constexpr char chassisSELDevAddrProp[] = "SELDeviceAddress";
108const static constexpr char chassisSMDevAddrProp[] = "SMDeviceAddress";
109const static constexpr char chassisBridgeDevAddrProp[] = "BridgeDeviceAddress";
Yong Liae4b0402018-11-02 11:12:14 +0800110static constexpr uint8_t chassisCapAddrMask = 0xfe;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700111static constexpr const char* powerButtonIntf =
112 "xyz.openbmc_project.Chassis.Buttons.Power";
113static constexpr const char* powerButtonPath =
114 "/xyz/openbmc_project/Chassis/Buttons/Power0";
115static constexpr const char* resetButtonIntf =
116 "xyz.openbmc_project.Chassis.Buttons.Reset";
117static constexpr const char* resetButtonPath =
118 "/xyz/openbmc_project/Chassis/Buttons/Reset0";
Ratan Guptadcb10672017-07-10 10:33:50 +0530119
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530120// Phosphor Host State manager
Willy Tu523e2d12023-09-05 11:36:48 -0700121namespace State = sdbusplus::server::xyz::openbmc_project::state;
Vernon Mauery185b9f82018-07-20 10:52:36 -0700122namespace fs = std::filesystem;
Andrew Geisslera6e3a302017-05-31 19:34:00 -0500123
Ratan Guptadcb10672017-07-10 10:33:50 +0530124using namespace phosphor::logging;
Willy Tu523e2d12023-09-05 11:36:48 -0700125using namespace sdbusplus::error::xyz::openbmc_project::common;
126using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Chau Ly8c1376c2024-01-05 07:22:10 +0000127using Intrusion = sdbusplus::client::xyz::openbmc_project::chassis::Intrusion<>;
Alexander Hansen76bfd752025-11-07 17:04:32 +0100128using HostState = sdbusplus::common::xyz::openbmc_project::state::Host;
William A. Kennington III4c008022018-10-12 17:18:14 -0700129
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500130namespace chassis
131{
132namespace internal
133{
134
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300135constexpr auto bootSettingsPath = "/xyz/openbmc_project/control/host0/boot";
136constexpr auto bootEnableIntf = "xyz.openbmc_project.Object.Enable";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500137constexpr auto bootModeIntf = "xyz.openbmc_project.Control.Boot.Mode";
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300138constexpr auto bootTypeIntf = "xyz.openbmc_project.Control.Boot.Type";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500139constexpr auto bootSourceIntf = "xyz.openbmc_project.Control.Boot.Source";
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300140constexpr auto bootSettingsOneTimePath =
141 "/xyz/openbmc_project/control/host0/boot/one_time";
142constexpr auto bootOneTimeIntf = "xyz.openbmc_project.Object.Enable";
143
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500144constexpr auto powerRestoreIntf =
145 "xyz.openbmc_project.Control.Power.RestorePolicy";
Patrick Williams5d82f472022-07-22 19:26:53 -0500146sdbusplus::bus_t dbus(ipmid_get_sd_bus_connection());
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500147
148namespace cache
149{
150
James Feist225dec82019-11-26 16:25:06 -0800151std::unique_ptr<settings::Objects> objectsPtr = nullptr;
152
153settings::Objects& getObjects()
154{
155 if (objectsPtr == nullptr)
156 {
157 objectsPtr = std::make_unique<settings::Objects>(
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300158 dbus, std::vector<std::string>{bootModeIntf, bootTypeIntf,
159 bootSourceIntf, powerRestoreIntf});
James Feist225dec82019-11-26 16:25:06 -0800160 }
161 return *objectsPtr;
162}
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500163
164} // namespace cache
165} // namespace internal
166} // namespace chassis
167
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500168namespace poh
169{
170
171constexpr auto minutesPerCount = 60;
172
173} // namespace poh
174
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000175int getHostNetworkData(ipmi::message::Payload& payload)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500176{
Ratan Guptadcb10672017-07-10 10:33:50 +0530177 ipmi::PropertyMap properties;
178 int rc = 0;
Ratan Gupta8c31d232017-08-13 05:49:43 +0530179 uint8_t addrSize = ipmi::network::IPV4_ADDRESS_SIZE_BYTE;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500180
Ratan Guptadcb10672017-07-10 10:33:50 +0530181 try
182 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700183 // TODO There may be cases where an interface is implemented by multiple
Ratan Guptadcb10672017-07-10 10:33:50 +0530184 // objects,to handle such cases we are interested on that object
185 // which are on interested busname.
186 // Currenlty mapper doesn't give the readable busname(gives busid)
187 // so we can't match with bus name so giving some object specific info
188 // as SETTINGS_MATCH.
189 // Later SETTINGS_MATCH will be replaced with busname.
Ratan Guptafd28dd72016-08-01 04:58:01 -0500190
Patrick Williams5d82f472022-07-22 19:26:53 -0500191 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Guptadcb10672017-07-10 10:33:50 +0530192
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530193 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
194 SETTINGS_ROOT, SETTINGS_MATCH);
195
196 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
197 SETTINGS_ROOT, SETTINGS_MATCH);
198
Patrick Venture0b02be92018-08-31 11:55:55 -0700199 properties = ipmi::getAllDbusProperties(
200 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400201 auto variant = ipmi::getDbusProperty(
202 bus, macObjectInfo.second, macObjectInfo.first, MAC_INTERFACE,
203 "MACAddress");
Ratan Guptadcb10672017-07-10 10:33:50 +0530204
Vernon Maueryf442e112019-04-09 11:44:36 -0700205 auto ipAddress = std::get<std::string>(properties["Address"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530206
Vernon Maueryf442e112019-04-09 11:44:36 -0700207 auto gateway = std::get<std::string>(properties["Gateway"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530208
Vernon Maueryf442e112019-04-09 11:44:36 -0700209 auto prefix = std::get<uint8_t>(properties["PrefixLength"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530210
Patrick Venture0b02be92018-08-31 11:55:55 -0700211 uint8_t isStatic =
Vernon Maueryf442e112019-04-09 11:44:36 -0700212 (std::get<std::string>(properties["Origin"]) ==
Patrick Venture0b02be92018-08-31 11:55:55 -0700213 "xyz.openbmc_project.Network.IP.AddressOrigin.Static")
214 ? 1
215 : 0;
Ratan Guptad70f4532017-08-04 02:07:31 +0530216
Vernon Maueryf442e112019-04-09 11:44:36 -0700217 auto MACAddress = std::get<std::string>(variant);
Ratan Guptacc8feb42017-07-25 21:52:10 +0530218
Ratan Guptad70f4532017-08-04 02:07:31 +0530219 // it is expected here that we should get the valid data
220 // but we may also get the default values.
221 // Validation of the data is done by settings.
222 //
223 // if mac address is default mac address then
224 // don't send blank override.
Ratan Gupta8c31d232017-08-13 05:49:43 +0530225 if ((MACAddress == ipmi::network::DEFAULT_MAC_ADDRESS))
Ratan Guptad70f4532017-08-04 02:07:31 +0530226 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530227 rc = -1;
228 return rc;
229 }
230 // if addr is static then ipaddress,gateway,prefix
231 // should not be default one,don't send blank override.
232 if (isStatic)
233 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700234 if ((ipAddress == ipmi::network::DEFAULT_ADDRESS) ||
235 (gateway == ipmi::network::DEFAULT_ADDRESS) || (!prefix))
Ratan Guptad70f4532017-08-04 02:07:31 +0530236 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530237 rc = -1;
238 return rc;
239 }
240 }
241
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000242 std::string token;
243 std::stringstream ss(MACAddress);
Ratan Guptadcb10672017-07-10 10:33:50 +0530244
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000245 // First pack macOffset no of bytes in payload.
246 // Latter this PetiBoot-Specific data will be populated.
247 std::vector<uint8_t> payloadInitialBytes(macOffset);
248 payload.pack(payloadInitialBytes);
Ratan Guptadcb10672017-07-10 10:33:50 +0530249
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000250 while (std::getline(ss, token, ':'))
251 {
252 payload.pack(stoi(token, nullptr, 16));
253 }
254
255 payload.pack(0x00);
256
257 payload.pack(isStatic);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530258
Vernon Maueryf442e112019-04-09 11:44:36 -0700259 uint8_t addressFamily = (std::get<std::string>(properties["Type"]) ==
260 "xyz.openbmc_project.Network.IP.Protocol.IPv4")
261 ? AF_INET
262 : AF_INET6;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530263
Patrick Venture0b02be92018-08-31 11:55:55 -0700264 addrSize = (addressFamily == AF_INET)
265 ? ipmi::network::IPV4_ADDRESS_SIZE_BYTE
266 : ipmi::network::IPV6_ADDRESS_SIZE_BYTE;
Ratan Guptadcb10672017-07-10 10:33:50 +0530267
268 // ipaddress and gateway would be in IPv4 format
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000269 std::vector<uint8_t> addrInBinary(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530270 inet_pton(addressFamily, ipAddress.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000271 reinterpret_cast<void*>(addrInBinary.data()));
Ratan Guptadcb10672017-07-10 10:33:50 +0530272
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000273 payload.pack(addrInBinary);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530274
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000275 payload.pack(prefix);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530276
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000277 std::vector<uint8_t> gatewayDetails(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530278 inet_pton(addressFamily, gateway.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000279 reinterpret_cast<void*>(gatewayDetails.data()));
280 payload.pack(gatewayDetails);
Ratan Guptadcb10672017-07-10 10:33:50 +0530281 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500282 catch (const InternalFailure& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530283 {
284 commit<InternalFailure>();
Ratan Guptadcb10672017-07-10 10:33:50 +0530285 rc = -1;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500286 return rc;
287 }
288
Patrick Venture0b02be92018-08-31 11:55:55 -0700289 // PetiBoot-Specific
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000290 // If success then copy the first 9 bytes to the payload message
291 // payload first 2 bytes contain the parameter values. Skip that 2 bytes.
292 uint8_t skipFirstTwoBytes = 2;
293 size_t payloadSize = payload.size();
294 uint8_t* configDataStartingAddress = payload.data() + skipFirstTwoBytes;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500295
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000296 if (payloadSize < skipFirstTwoBytes + sizeof(netConfInitialBytes))
297 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700298 lg2::error("Invalid net config");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000299 rc = -1;
300 return rc;
301 }
302 std::copy(netConfInitialBytes,
303 netConfInitialBytes + sizeof(netConfInitialBytes),
304 configDataStartingAddress);
305
306 if (payloadSize < skipFirstTwoBytes + addrSizeOffset + sizeof(addrSize))
307 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700308 lg2::error("Invalid length of address size");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000309 rc = -1;
310 return rc;
311 }
312 std::copy(&addrSize, &(addrSize) + sizeof(addrSize),
313 configDataStartingAddress + addrSizeOffset);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530314
Ratan Guptafd28dd72016-08-01 04:58:01 -0500315#ifdef _IPMI_DEBUG_
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700316 std::printf("\n===Printing the IPMI Formatted Data========\n");
Ratan Guptafd28dd72016-08-01 04:58:01 -0500317
Ratan Guptadcb10672017-07-10 10:33:50 +0530318 for (uint8_t pos = 0; pos < index; pos++)
319 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000320 std::printf("%02x ", payloadStartingAddress[pos]);
Ratan Guptadcb10672017-07-10 10:33:50 +0530321 }
Ratan Guptafd28dd72016-08-01 04:58:01 -0500322#endif
323
Ratan Guptafd28dd72016-08-01 04:58:01 -0500324 return rc;
325}
326
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530327/** @brief convert IPv4 and IPv6 addresses from binary to text form.
328 * @param[in] family - IPv4/Ipv6
329 * @param[in] data - req data pointer.
330 * @param[in] offset - offset in the data.
331 * @param[in] addrSize - size of the data which needs to be read from offset.
332 * @returns address in text form.
333 */
334
Patrick Venture0b02be92018-08-31 11:55:55 -0700335std::string getAddrStr(uint8_t family, uint8_t* data, uint8_t offset,
336 uint8_t addrSize)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530337{
338 char ipAddr[INET6_ADDRSTRLEN] = {};
339
Patrick Venture0b02be92018-08-31 11:55:55 -0700340 switch (family)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530341 {
342 case AF_INET:
343 {
Patrick Williams99db6882024-12-18 11:20:17 -0500344 struct sockaddr_in addr4{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700345 std::memcpy(&addr4.sin_addr.s_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530346
Patrick Venture0b02be92018-08-31 11:55:55 -0700347 inet_ntop(AF_INET, &addr4.sin_addr, ipAddr, INET_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530348
349 break;
350 }
351 case AF_INET6:
352 {
Patrick Williams99db6882024-12-18 11:20:17 -0500353 struct sockaddr_in6 addr6{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700354 std::memcpy(&addr6.sin6_addr.s6_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530355
Patrick Venture0b02be92018-08-31 11:55:55 -0700356 inet_ntop(AF_INET6, &addr6.sin6_addr, ipAddr, INET6_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530357
358 break;
359 }
360 default:
361 {
362 return {};
363 }
364 }
365
366 return ipAddr;
367}
368
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000369ipmi::Cc setHostNetworkData(ipmi::message::Payload& data)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500370{
Ratan Guptadcb10672017-07-10 10:33:50 +0530371 using namespace std::string_literals;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000372 std::string hostNetworkConfig;
373 std::string mac("00:00:00:00:00:00");
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530374 std::string ipAddress, gateway;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000375 std::string addrOrigin{0};
Patrick Venture0b02be92018-08-31 11:55:55 -0700376 uint8_t addrSize{0};
Ratan Guptadcb10672017-07-10 10:33:50 +0530377 std::string addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530378 "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP";
Patrick Venture0b02be92018-08-31 11:55:55 -0700379 std::string addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv4";
380 uint8_t prefix{0};
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530381 uint8_t family = AF_INET;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500382
Patrick Venture0b02be92018-08-31 11:55:55 -0700383 // cookie starts from second byte
Ratan Guptafd28dd72016-08-01 04:58:01 -0500384 // version starts from sixth byte
385
Ratan Guptadcb10672017-07-10 10:33:50 +0530386 try
Ratan Guptafd28dd72016-08-01 04:58:01 -0500387 {
Ratan Guptadcb10672017-07-10 10:33:50 +0530388 do
389 {
390 // cookie == 0x21 0x70 0x62 0x21
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000391 data.trailingOk = true;
392 auto msgLen = data.size();
393 std::vector<uint8_t> msgPayloadBytes(msgLen);
394 if (data.unpack(msgPayloadBytes) != 0 || !data.fullyUnpacked())
Ratan Guptadcb10672017-07-10 10:33:50 +0530395 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700396 lg2::error("Error in unpacking message of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000397 return ipmi::ccReqDataLenInvalid;
398 }
399
400 uint8_t* msgPayloadStartingPos = msgPayloadBytes.data();
401 constexpr size_t cookieSize = 4;
402 if (msgLen < cookieOffset + cookieSize)
403 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700404 lg2::error("Error in cookie getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000405 return ipmi::ccReqDataLenInvalid;
406 }
407 if (std::equal(msgPayloadStartingPos + cookieOffset,
408 msgPayloadStartingPos + cookieOffset + cookieSize,
409 (netConfInitialBytes + cookieOffset)) != 0)
410 {
411 // all cookie == 0
412 if (std::all_of(msgPayloadStartingPos + cookieOffset,
413 msgPayloadStartingPos + cookieOffset +
414 cookieSize,
415 [](int i) { return i == 0; }) == true)
Ratan Guptadcb10672017-07-10 10:33:50 +0530416 {
417 // need to zero out the network settings.
418 break;
419 }
420
Vernon Mauery38108d92024-03-11 12:53:55 -0700421 lg2::error("Invalid Cookie");
Ratan Guptadcb10672017-07-10 10:33:50 +0530422 elog<InternalFailure>();
423 }
424
425 // vesion == 0x00 0x01
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000426 if (msgLen < versionOffset + sizeVersion)
Ratan Guptadcb10672017-07-10 10:33:50 +0530427 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700428 lg2::error("Error in version getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000429 return ipmi::ccReqDataLenInvalid;
430 }
431 if (std::equal(msgPayloadStartingPos + versionOffset,
432 msgPayloadStartingPos + versionOffset + sizeVersion,
433 (netConfInitialBytes + versionOffset)) != 0)
434 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700435 lg2::error("Invalid Version");
Ratan Guptadcb10672017-07-10 10:33:50 +0530436 elog<InternalFailure>();
437 }
438
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000439 if (msgLen < macOffset + 6)
440 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700441 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000442 "Error in mac address getting of setHostNetworkData");
443 return ipmi::ccReqDataLenInvalid;
444 }
445 std::stringstream result;
446 std::copy((msgPayloadStartingPos + macOffset),
447 (msgPayloadStartingPos + macOffset + 5),
448 std::ostream_iterator<int>(result, ":"));
449 mac = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530450
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000451 if (msgLen < addrTypeOffset + sizeof(decltype(addrOrigin)))
452 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700453 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000454 "Error in original address getting of setHostNetworkData");
455 return ipmi::ccReqDataLenInvalid;
456 }
457 std::copy(msgPayloadStartingPos + addrTypeOffset,
458 msgPayloadStartingPos + addrTypeOffset +
459 sizeof(decltype(addrOrigin)),
460 std::ostream_iterator<int>(result, ""));
461 addrOrigin = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530462
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000463 if (!addrOrigin.empty())
Ratan Guptadcb10672017-07-10 10:33:50 +0530464 {
465 addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530466 "xyz.openbmc_project.Network.IP.AddressOrigin.Static";
Ratan Guptadcb10672017-07-10 10:33:50 +0530467 }
468
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000469 if (msgLen < addrSizeOffset + sizeof(decltype(addrSize)))
470 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700471 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000472 "Error in address size getting of setHostNetworkData");
473 return ipmi::ccReqDataLenInvalid;
474 }
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530475 // Get the address size
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000476 std::copy(msgPayloadStartingPos + addrSizeOffset,
477 (msgPayloadStartingPos + addrSizeOffset +
478 sizeof(decltype(addrSize))),
479 &addrSize);
Ratan Guptadcb10672017-07-10 10:33:50 +0530480
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000481 uint8_t prefixOffset = ipAddrOffset + addrSize;
482 if (msgLen < prefixOffset + sizeof(decltype(prefix)))
483 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700484 lg2::error("Error in prefix getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000485 return ipmi::ccReqDataLenInvalid;
486 }
William A. Kennington III4c521022023-07-28 13:07:30 -0700487 // std::copy(msgPayloadStartingPos + prefixOffset,
488 // msgPayloadStartingPos + prefixOffset +
489 // sizeof(decltype(prefix)),
490 // &prefix);
491 // Workaround compiler misdetecting out of bounds memcpy
492 prefix = msgPayloadStartingPos[prefixOffset];
Ratan Guptadcb10672017-07-10 10:33:50 +0530493
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530494 uint8_t gatewayOffset = prefixOffset + sizeof(decltype(prefix));
Ratan Gupta8c31d232017-08-13 05:49:43 +0530495 if (addrSize != ipmi::network::IPV4_ADDRESS_SIZE_BYTE)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530496 {
497 addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv6";
498 family = AF_INET6;
499 }
500
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000501 if (msgLen < ipAddrOffset + addrSize)
502 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700503 lg2::error("Error in IP address getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000504 return ipmi::ccReqDataLenInvalid;
505 }
506 ipAddress = getAddrStr(family, msgPayloadStartingPos, ipAddrOffset,
507 addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530508
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000509 if (msgLen < gatewayOffset + addrSize)
510 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700511 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000512 "Error in gateway address getting of setHostNetworkData");
513 return ipmi::ccReqDataLenInvalid;
514 }
515 gateway = getAddrStr(family, msgPayloadStartingPos, gatewayOffset,
516 addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530517
Patrick Venture0b02be92018-08-31 11:55:55 -0700518 } while (0);
Ratan Guptadcb10672017-07-10 10:33:50 +0530519
Patrick Venture0b02be92018-08-31 11:55:55 -0700520 // Cookie == 0 or it is a valid cookie
Patrick Williams1318a5e2024-08-16 15:19:54 -0400521 hostNetworkConfig +=
522 "ipaddress="s + ipAddress + ",prefix="s + std::to_string(prefix) +
523 ",gateway="s + gateway + ",mac="s + mac + ",addressOrigin="s +
524 addressOrigin;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500525
Patrick Williams5d82f472022-07-22 19:26:53 -0500526 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530527
528 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
529 SETTINGS_ROOT, SETTINGS_MATCH);
530 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
531 SETTINGS_ROOT, SETTINGS_MATCH);
Ratan Guptadcb10672017-07-10 10:33:50 +0530532 // set the dbus property
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530533 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700534 IP_INTERFACE, "Address", std::string(ipAddress));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530535 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700536 IP_INTERFACE, "PrefixLength", prefix);
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530537 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700538 IP_INTERFACE, "Origin", addressOrigin);
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530539 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700540 IP_INTERFACE, "Gateway", std::string(gateway));
541 ipmi::setDbusProperty(
542 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE, "Type",
543 std::string("xyz.openbmc_project.Network.IP.Protocol.IPv4"));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530544 ipmi::setDbusProperty(bus, macObjectInfo.second, macObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700545 MAC_INTERFACE, "MACAddress", std::string(mac));
Ratan Guptafd28dd72016-08-01 04:58:01 -0500546
Vernon Mauery38108d92024-03-11 12:53:55 -0700547 lg2::debug("Network configuration changed: {NETWORKCONFIG}",
548 "NETWORKCONFIG", hostNetworkConfig);
Ratan Guptafd28dd72016-08-01 04:58:01 -0500549 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500550 catch (const sdbusplus::exception_t& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530551 {
552 commit<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -0700553 lg2::error("Error in ipmiChassisSetSysBootOptions call");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000554 return ipmi::ccUnspecifiedError;
Ratan Guptadcb10672017-07-10 10:33:50 +0530555 }
556
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000557 return ipmi::ccSuccess;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500558}
559
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500560uint32_t getPOHCounter()
561{
Patrick Williams5d82f472022-07-22 19:26:53 -0500562 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500563
Patrick Williams1318a5e2024-08-16 15:19:54 -0400564 auto chassisStateObj =
565 ipmi::getDbusObject(bus, chassisPOHStateIntf, chassisStateRoot, match);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500566
Patrick Williams1318a5e2024-08-16 15:19:54 -0400567 auto service =
568 ipmi::getService(bus, chassisPOHStateIntf, chassisStateObj.first);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500569
Patrick Williams1318a5e2024-08-16 15:19:54 -0400570 auto propValue =
571 ipmi::getDbusProperty(bus, service, chassisStateObj.first,
572 chassisPOHStateIntf, pohCounterProperty);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500573
Vernon Maueryf442e112019-04-09 11:44:36 -0700574 return std::get<uint32_t>(propValue);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500575}
576
anil kumar appana43263c62019-05-27 12:45:04 +0000577/** @brief Implements the get chassis capabilities command
578 *
579 * @returns IPMI completion code plus response data
580 * chassisCapFlags - chassis capability flag
581 * chassisFRUInfoDevAddr - chassis FRU info Device Address
582 * chassisSDRDevAddr - chassis SDR device address
583 * chassisSELDevAddr - chassis SEL device address
584 * chassisSMDevAddr - chassis system management device address
585 * chassisBridgeDevAddr - chassis bridge device address
586 */
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800587ipmi::RspType<bool, // chassis intrusion sensor
588 bool, // chassis Front panel lockout
589 bool, // chassis NMI
590 bool, // chassis power interlock
591 uint4_t, // reserved
anil kumar appana43263c62019-05-27 12:45:04 +0000592 uint8_t, // chassis FRU info Device Address
593 uint8_t, // chassis SDR device address
594 uint8_t, // chassis SEL device address
595 uint8_t, // chassis system management device address
596 uint8_t // chassis bridge device address
597 >
598 ipmiGetChassisCap()
Nan Li8d15fb42016-08-16 22:29:40 +0800599{
anil kumar appana43263c62019-05-27 12:45:04 +0000600 ipmi::PropertyMap properties;
Yong Liae4b0402018-11-02 11:12:14 +0800601 try
602 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500603 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nan Li8d15fb42016-08-16 22:29:40 +0800604
Yong Liae4b0402018-11-02 11:12:14 +0800605 ipmi::DbusObjectInfo chassisCapObject =
606 ipmi::getDbusObject(bus, chassisCapIntf);
Nan Li8d15fb42016-08-16 22:29:40 +0800607
Yong Liae4b0402018-11-02 11:12:14 +0800608 // capabilities flags
609 // [7..4] - reserved
610 // [3] – 1b = provides power interlock (IPM 1.5)
611 // [2] – 1b = provides Diagnostic Interrupt (FP NMI)
612 // [1] – 1b = provides “Front Panel Lockout” (indicates that the chassis
613 // has capabilities
614 // to lock out external power control and reset button or
615 // front panel interfaces and/or detect tampering with those
616 // interfaces).
617 // [0] -1b = Chassis provides intrusion (physical security) sensor.
618 // set to default value 0x0.
Nan Li8d15fb42016-08-16 22:29:40 +0800619
Patrick Williams1318a5e2024-08-16 15:19:54 -0400620 properties =
621 ipmi::getAllDbusProperties(bus, chassisCapObject.second,
622 chassisCapObject.first, chassisCapIntf);
Yong Liae4b0402018-11-02 11:12:14 +0800623 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500624 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800625 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700626 lg2::error("Failed to fetch Chassis Capability properties: {ERROR}",
627 "ERROR", e);
anil kumar appana43263c62019-05-27 12:45:04 +0000628 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800629 }
630
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800631 bool* chassisIntrusionFlag =
632 std::get_if<bool>(&properties[chassisIntrusionProp]);
633 if (chassisIntrusionFlag == nullptr)
anil kumar appana43263c62019-05-27 12:45:04 +0000634 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700635 lg2::error("Error to get chassis Intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800636 return ipmi::responseUnspecifiedError();
637 }
638 bool* chassisFrontPanelFlag =
639 std::get_if<bool>(&properties[chassisFrontPanelLockoutProp]);
640 if (chassisFrontPanelFlag == nullptr)
641 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700642 lg2::error("Error to get chassis intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800643 return ipmi::responseUnspecifiedError();
644 }
645 bool* chassisNMIFlag = std::get_if<bool>(&properties[chassisNMIProp]);
646 if (chassisNMIFlag == nullptr)
647 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700648 lg2::error("Error to get chassis NMI flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800649 return ipmi::responseUnspecifiedError();
650 }
651 bool* chassisPowerInterlockFlag =
652 std::get_if<bool>(&properties[chassisPowerInterlockProp]);
653 if (chassisPowerInterlockFlag == nullptr)
654 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700655 lg2::error("Error to get chassis power interlock flags");
anil kumar appana43263c62019-05-27 12:45:04 +0000656 return ipmi::responseUnspecifiedError();
657 }
658 uint8_t* chassisFRUInfoDevAddr =
659 std::get_if<uint8_t>(&properties[chassisFRUDevAddrProp]);
660 if (chassisFRUInfoDevAddr == nullptr)
661 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700662 lg2::error("Error to get chassis FRU info device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000663 return ipmi::responseUnspecifiedError();
664 }
665 uint8_t* chassisSDRDevAddr =
666 std::get_if<uint8_t>(&properties[chassisSDRDevAddrProp]);
667 if (chassisSDRDevAddr == nullptr)
668 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700669 lg2::error("Error to get chassis SDR device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000670 return ipmi::responseUnspecifiedError();
671 }
672 uint8_t* chassisSELDevAddr =
673 std::get_if<uint8_t>(&properties[chassisSELDevAddrProp]);
674 if (chassisSELDevAddr == nullptr)
675 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700676 lg2::error("Error to get chassis SEL device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000677 return ipmi::responseUnspecifiedError();
678 }
679 uint8_t* chassisSMDevAddr =
680 std::get_if<uint8_t>(&properties[chassisSMDevAddrProp]);
681 if (chassisSMDevAddr == nullptr)
682 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700683 lg2::error("Error to get chassis SM device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000684 return ipmi::responseUnspecifiedError();
685 }
686 uint8_t* chassisBridgeDevAddr =
687 std::get_if<uint8_t>(&properties[chassisBridgeDevAddrProp]);
688 if (chassisBridgeDevAddr == nullptr)
689 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700690 lg2::error("Error to get chassis bridge device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000691 return ipmi::responseUnspecifiedError();
692 }
693
Patrick Williams1318a5e2024-08-16 15:19:54 -0400694 return ipmi::responseSuccess(
695 *chassisIntrusionFlag, *chassisFrontPanelFlag, *chassisNMIFlag,
696 *chassisPowerInterlockFlag, 0, *chassisFRUInfoDevAddr,
697 *chassisSDRDevAddr, *chassisSELDevAddr, *chassisSMDevAddr,
698 *chassisBridgeDevAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800699}
700
anil kumar appana894d0222019-05-27 16:32:14 +0000701/** @brief implements set chassis capalibities command
702 * @param intrusion - chassis intrusion
703 * @param fpLockout - frontpannel lockout
704 * @param reserved1 - skip one bit
705 * @param fruDeviceAddr - chassis FRU info Device Address
706 * @param sdrDeviceAddr - chassis SDR device address
707 * @param selDeviceAddr - chassis SEL device address
708 * @param smDeviceAddr - chassis system management device address
709 * @param bridgeDeviceAddr - chassis bridge device address
710 *
711 * @returns IPMI completion code
712 */
Patrick Williams1318a5e2024-08-16 15:19:54 -0400713ipmi::RspType<> ipmiSetChassisCap(
714 bool intrusion, bool fpLockout, uint6_t reserved1,
anil kumar appana894d0222019-05-27 16:32:14 +0000715
Patrick Williams1318a5e2024-08-16 15:19:54 -0400716 uint8_t fruDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000717
Patrick Williams1318a5e2024-08-16 15:19:54 -0400718 uint8_t sdrDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000719
Patrick Williams1318a5e2024-08-16 15:19:54 -0400720 uint8_t selDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000721
Patrick Williams1318a5e2024-08-16 15:19:54 -0400722 uint8_t smDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000723
NikhilaDande530239b2025-09-30 09:09:40 +0530724 std::optional<uint8_t> bridgeDeviceAddr)
Yong Liae4b0402018-11-02 11:12:14 +0800725{
Yong Liae4b0402018-11-02 11:12:14 +0800726 // check input data
anil kumar appana894d0222019-05-27 16:32:14 +0000727 if (reserved1 != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800728 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700729 lg2::error("Unsupported request parameter");
anil kumar appana894d0222019-05-27 16:32:14 +0000730 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800731 }
732
anil kumar appana894d0222019-05-27 16:32:14 +0000733 if ((fruDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800734 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700735 lg2::error("Unsupported request parameter(FRU Addr) for REQ={REQ}",
736 "REQ", lg2::hex, fruDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000737 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800738 }
anil kumar appana894d0222019-05-27 16:32:14 +0000739 if ((sdrDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800740 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700741 lg2::error("Unsupported request parameter(SDR Addr) for REQ={REQ}",
742 "REQ", lg2::hex, sdrDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000743 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800744 }
745
anil kumar appana894d0222019-05-27 16:32:14 +0000746 if ((selDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800747 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700748 lg2::error("Unsupported request parameter(SEL Addr) for REQ={REQ}",
749 "REQ", lg2::hex, selDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000750 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800751 }
752
anil kumar appana894d0222019-05-27 16:32:14 +0000753 if ((smDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800754 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700755 lg2::error("Unsupported request parameter(SM Addr) for REQ={REQ}",
756 "REQ", lg2::hex, smDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000757 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800758 }
759
NikhilaDande530239b2025-09-30 09:09:40 +0530760 if (bridgeDeviceAddr.has_value())
Yong Liae4b0402018-11-02 11:12:14 +0800761 {
NikhilaDande530239b2025-09-30 09:09:40 +0530762 if ((bridgeDeviceAddr.value() & ~chassisCapAddrMask) != 0)
763 {
764 lg2::error(
765 "Unsupported request parameter(Bridge Addr) for REQ={REQ}",
766 "REQ", lg2::hex, bridgeDeviceAddr.value());
767 return ipmi::responseInvalidFieldRequest();
768 }
Yong Liae4b0402018-11-02 11:12:14 +0800769 }
770
771 try
772 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500773 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Yong Liae4b0402018-11-02 11:12:14 +0800774 ipmi::DbusObjectInfo chassisCapObject =
775 ipmi::getDbusObject(bus, chassisCapIntf);
776
777 ipmi::setDbusProperty(bus, chassisCapObject.second,
778 chassisCapObject.first, chassisCapIntf,
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800779 chassisIntrusionProp, intrusion);
780
781 ipmi::setDbusProperty(bus, chassisCapObject.second,
782 chassisCapObject.first, chassisCapIntf,
783 chassisFrontPanelLockoutProp, fpLockout);
Yong Liae4b0402018-11-02 11:12:14 +0800784
785 ipmi::setDbusProperty(bus, chassisCapObject.second,
786 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000787 chassisFRUDevAddrProp, fruDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800788
789 ipmi::setDbusProperty(bus, chassisCapObject.second,
790 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000791 chassisSDRDevAddrProp, sdrDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800792
793 ipmi::setDbusProperty(bus, chassisCapObject.second,
794 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000795 chassisSELDevAddrProp, selDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800796
797 ipmi::setDbusProperty(bus, chassisCapObject.second,
798 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000799 chassisSMDevAddrProp, smDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800800
NikhilaDande530239b2025-09-30 09:09:40 +0530801 if (bridgeDeviceAddr.has_value())
802 {
803 ipmi::setDbusProperty(bus, chassisCapObject.second,
804 chassisCapObject.first, chassisCapIntf,
805 chassisBridgeDevAddrProp,
806 bridgeDeviceAddr.value());
807 }
Yong Liae4b0402018-11-02 11:12:14 +0800808 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500809 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800810 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700811 lg2::error("Failed to set chassis capability properties: {ERR}", "ERR",
812 e);
anil kumar appana894d0222019-05-27 16:32:14 +0000813 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800814 }
anil kumar appana894d0222019-05-27 16:32:14 +0000815 return ipmi::responseSuccess();
Nan Li8d15fb42016-08-16 22:29:40 +0800816}
817
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530818//------------------------------------------
819// Calls into Host State Manager Dbus object
820//------------------------------------------
Jason M. Bills664e1c32020-01-30 16:02:39 -0800821int initiateHostStateTransition(ipmi::Context::ptr& ctx,
822 State::Host::Transition transition)
vishwa36993272015-11-20 12:43:49 -0600823{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500824 // OpenBMC Host State Manager dbus framework
Alexander Hansen76bfd752025-11-07 17:04:32 +0100825 const auto hostStatePath =
826 std::format("{}/{}", HostState::namespace_path::value, "host0");
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530827
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500828 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700829 auto request =
830 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
831 transition);
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530832
Jason M. Bills664e1c32020-01-30 16:02:39 -0800833 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400834 boost::system::error_code ec =
Alexander Hansen76bfd752025-11-07 17:04:32 +0100835 ipmi::getService(ctx, HostState::interface, hostStatePath, service);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800836
837 if (!ec)
838 {
Alexander Hansen76bfd752025-11-07 17:04:32 +0100839 ec = ipmi::setDbusProperty(
840 ctx, service, hostStatePath, HostState::interface,
841 HostState::property_names::requested_host_transition, request);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800842 }
843 if (ec)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500844 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700845 lg2::error(
846 "Failed to initiate transition for request {REQUEST}: {EXCEPTION}",
847 "REQUEST", request, "EXCEPTION", ec.message());
Jason M. Bills664e1c32020-01-30 16:02:39 -0800848 return -1;
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500849 }
Vernon Mauery38108d92024-03-11 12:53:55 -0700850 lg2::info(
851 "Transition request {REQUEST} initiated successfully by user {USERID}",
852 "REQUEST", request, "USERID", ctx->userId);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800853 return 0;
vishwa36993272015-11-20 12:43:49 -0600854}
855
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800856//------------------------------------------
Jason M. Billsad588bf2020-01-30 16:18:33 -0800857// Calls into Chassis State Manager Dbus object
858//------------------------------------------
859int initiateChassisStateTransition(ipmi::Context::ptr& ctx,
860 State::Chassis::Transition transition)
861{
862 // OpenBMC Chassis State Manager dbus framework
863 constexpr auto chassisStatePath = "/xyz/openbmc_project/state/chassis0";
864 constexpr auto chassisStateIntf = "xyz.openbmc_project.State.Chassis";
865
866 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400867 boost::system::error_code ec =
868 ipmi::getService(ctx, chassisStateIntf, chassisStatePath, service);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800869
870 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700871 auto request =
872 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
873 transition);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800874
875 if (!ec)
876 {
877 ec = ipmi::setDbusProperty(ctx, service, chassisStatePath,
878 chassisStateIntf, "RequestedPowerTransition",
879 request);
880 }
881 if (ec)
882 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700883 lg2::error("Failed to initiate transition {REQUEST}: {EXCEPTION}",
884 "REQUEST", request, "EXCEPTION", ec.message());
885
Jason M. Billsad588bf2020-01-30 16:18:33 -0800886 return -1;
887 }
888
889 return 0;
890}
891
892//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000893// Trigger an NMI on the host via dbus
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800894//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000895static int doNmi(ipmi::Context::ptr& ctx)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800896{
Zev Weiss337a0972024-03-08 08:31:15 +0000897 constexpr const char* nmiIntfName = "xyz.openbmc_project.Control.Host.NMI";
898 ipmi::DbusObjectInfo nmiObj{};
899 boost::system::error_code ec;
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800900
Zev Weiss337a0972024-03-08 08:31:15 +0000901 ec = ipmi::getDbusObject(ctx, nmiIntfName, nmiObj);
Vernon Mauery9bb4a382021-11-05 12:46:19 -0700902 if (ec)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800903 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700904 lg2::error("Failed to find NMI service: {ERROR}", "ERROR",
905 ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000906 return -1;
907 }
908
George Liude1420d2025-03-03 15:14:25 +0800909 ec = ipmi::callDbusMethod(ctx, nmiObj.second, nmiObj.first, nmiIntfName,
910 "NMI");
Zev Weiss337a0972024-03-08 08:31:15 +0000911 if (ec)
912 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700913 lg2::error("NMI call failed: {ERROR}", "ERROR", ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000914 elog<InternalFailure>();
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800915 return -1;
916 }
917
918 return 0;
919}
920
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500921namespace power_policy
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500922{
Nan Lifdd8ec52016-08-28 03:57:40 +0800923
Willy Tu523e2d12023-09-05 11:36:48 -0700924using namespace sdbusplus::server::xyz::openbmc_project::control::power;
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500925using IpmiValue = uint8_t;
926using DbusValue = RestorePolicy::Policy;
Nan Lifdd8ec52016-08-28 03:57:40 +0800927
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700928const std::map<DbusValue, IpmiValue> dbusToIpmi = {
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500929 {RestorePolicy::Policy::AlwaysOff, 0x00},
930 {RestorePolicy::Policy::Restore, 0x01},
George Liue561d3e2024-02-04 15:19:30 +0800931 {RestorePolicy::Policy::AlwaysOn, 0x02},
932 {RestorePolicy::Policy::None, 0x03}};
Nan Lifdd8ec52016-08-28 03:57:40 +0800933
Yong Lic6713cf2018-09-12 12:35:13 +0800934static constexpr uint8_t noChange = 0x03;
935static constexpr uint8_t allSupport = 0x01 | 0x02 | 0x04;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700936
937/* helper function for Get Chassis Status Command
938 */
939std::optional<uint2_t> getPowerRestorePolicy()
940{
941 uint2_t restorePolicy = 0;
942 using namespace chassis::internal;
943
James Feist225dec82019-11-26 16:25:06 -0800944 settings::Objects& objects = cache::getObjects();
945
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700946 try
947 {
948 const auto& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -0800949 objects.map.at(powerRestoreIntf).front();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700950 ipmi::Value result = ipmi::getDbusProperty(
951 *getSdBus(),
James Feist225dec82019-11-26 16:25:06 -0800952 objects.service(powerRestoreSetting, powerRestoreIntf).c_str(),
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700953 powerRestoreSetting.c_str(), powerRestoreIntf,
954 "PowerRestorePolicy");
955 auto powerRestore = RestorePolicy::convertPolicyFromString(
956 std::get<std::string>(result));
957 restorePolicy = dbusToIpmi.at(powerRestore);
958 }
959 catch (const std::exception& e)
960 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700961 lg2::error(
962 "Failed to fetch pgood property ({PATH}/{INTERFACE}): {ERROR}",
963 "PATH", objects.map.at(powerRestoreIntf).front(), "INTERFACE",
964 powerRestoreIntf, "ERROR", e);
James Feist225dec82019-11-26 16:25:06 -0800965 cache::objectsPtr.reset();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700966 return std::nullopt;
967 }
968 return std::make_optional(restorePolicy);
969}
970
971/*
972 * getPowerStatus
973 * helper function for Get Chassis Status Command
974 * return - optional value for pgood (no value on error)
975 */
976std::optional<bool> getPowerStatus()
977{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700978 bool powerGood = false;
979 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus();
980 try
981 {
Jason M. Bills3de424c2019-05-21 09:57:16 -0700982 constexpr const char* chassisStatePath =
983 "/xyz/openbmc_project/state/chassis0";
984 constexpr const char* chassisStateIntf =
985 "xyz.openbmc_project.State.Chassis";
Patrick Williams1318a5e2024-08-16 15:19:54 -0400986 auto service =
987 ipmi::getService(*busp, chassisStateIntf, chassisStatePath);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700988
Jason M. Bills3de424c2019-05-21 09:57:16 -0700989 ipmi::Value powerState =
990 ipmi::getDbusProperty(*busp, service, chassisStatePath,
991 chassisStateIntf, "CurrentPowerState");
Chau Lyee3983b2024-01-05 07:33:45 +0000992 std::string powerStateStr = std::get<std::string>(powerState);
993 if (powerStateStr.ends_with(".On") ||
994 powerStateStr.ends_with(".TransitioningToOff"))
995 {
996 powerGood = true;
997 }
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700998 }
999 catch (const std::exception& e)
1000 {
1001 try
1002 {
1003 // FIXME: some legacy modules use the older path; try that next
1004 constexpr const char* legacyPwrCtrlObj =
1005 "/org/openbmc/control/power0";
1006 constexpr const char* legacyPwrCtrlIntf =
1007 "org.openbmc.control.Power";
Patrick Williams1318a5e2024-08-16 15:19:54 -04001008 auto service =
1009 ipmi::getService(*busp, legacyPwrCtrlIntf, legacyPwrCtrlObj);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001010
1011 ipmi::Value variant = ipmi::getDbusProperty(
1012 *busp, service, legacyPwrCtrlObj, legacyPwrCtrlIntf, "pgood");
1013 powerGood = static_cast<bool>(std::get<int>(variant));
1014 }
1015 catch (const std::exception& e)
1016 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001017 lg2::error("Failed to fetch pgood property: {ERROR}", "ERROR", e);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001018 return std::nullopt;
1019 }
1020 }
1021 return std::make_optional(powerGood);
1022}
1023
Yong Li70ce7352019-05-16 21:15:27 +08001024/*
1025 * getACFailStatus
1026 * helper function for Get Chassis Status Command
1027 * return - bool value for ACFail (false on error)
1028 */
1029bool getACFailStatus()
1030{
1031 constexpr const char* powerControlObj =
1032 "/xyz/openbmc_project/Chassis/Control/Power0";
1033 constexpr const char* powerControlIntf =
1034 "xyz.openbmc_project.Chassis.Control.Power";
1035 bool acFail = false;
1036 std::shared_ptr<sdbusplus::asio::connection> bus = getSdBus();
1037 try
1038 {
Patrick Williams1318a5e2024-08-16 15:19:54 -04001039 auto service =
1040 ipmi::getService(*bus, powerControlIntf, powerControlObj);
Yong Li70ce7352019-05-16 21:15:27 +08001041
1042 ipmi::Value variant = ipmi::getDbusProperty(
1043 *bus, service, powerControlObj, powerControlIntf, "PFail");
1044 acFail = std::get<bool>(variant);
1045 }
1046 catch (const std::exception& e)
1047 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001048 lg2::error(
Konstantin Aladyshev37de2e12025-01-29 11:49:26 +03001049 "Failed to fetch PFail property ({PATH}/{INTERFACE}): {ERROR}",
Vernon Mauery38108d92024-03-11 12:53:55 -07001050 "PATH", powerControlObj, "INTERFACE", powerControlIntf, "ERROR", e);
Yong Li70ce7352019-05-16 21:15:27 +08001051 }
1052 return acFail;
1053}
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001054} // namespace power_policy
Nan Lifdd8ec52016-08-28 03:57:40 +08001055
Patrick Williams615a14e2025-04-07 17:07:24 -04001056static std::optional<bool> getButtonDisabled(ipmi::Context::ptr& ctx,
1057 const std::string& buttonPath,
1058 const std::string& buttonIntf)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001059{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001060 bool buttonDisabled = false;
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001061 boost::system::error_code ec;
1062 std::string service;
1063 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1064 if (!ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001065 {
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001066 bool enabled;
1067 ec = ipmi::getDbusProperty(ctx, service, buttonPath, buttonIntf,
1068 "Enabled", enabled);
1069 buttonDisabled = !enabled;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001070 }
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001071
1072 if (ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001073 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001074 lg2::error("Fail to get button Enabled property ({PATH}): {ERROR}",
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001075 "PATH", buttonPath, "ERROR", ec.message());
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001076 return std::nullopt;
1077 }
1078 return std::make_optional(buttonDisabled);
1079}
1080
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001081static bool setButtonDisabled(ipmi::Context::ptr& ctx,
1082 const std::string& buttonPath,
1083 const std::string& buttonIntf, bool disable)
Kuiying Wang21addc52019-01-04 10:50:21 +08001084{
1085 std::string service;
1086 boost::system::error_code ec;
1087 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1088 if (!ec)
1089 {
1090 ec = ipmi::setDbusProperty(ctx, service, buttonPath, buttonIntf,
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001091 "Enabled", !disable);
Kuiying Wang21addc52019-01-04 10:50:21 +08001092 }
1093 if (ec)
1094 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001095 lg2::error(
1096 "Fail to set button Enabled property ({SERVICE}:{PATH}): {ERROR}",
1097 "SERVICE", service, "PATH", buttonPath, "ERROR", ec.message());
Kuiying Wang21addc52019-01-04 10:50:21 +08001098 return false;
1099 }
1100 return true;
1101}
1102
Chau Ly9e666cd2023-03-06 08:46:14 +00001103static std::optional<bool> getChassisIntrusionStatus(ipmi::Context::ptr& ctx)
1104{
Chau Ly8c1376c2024-01-05 07:22:10 +00001105 std::vector<std::string> interfaces = {std::string(Intrusion::interface)};
1106 ipmi::ObjectTree objs;
1107 std::string propVal;
1108 std::optional<bool> ret = std::nullopt;
Chau Ly9e666cd2023-03-06 08:46:14 +00001109
Chau Ly8c1376c2024-01-05 07:22:10 +00001110 boost::system::error_code ec =
1111 ipmi::getSubTree(ctx, interfaces, std::string("/"), 0, objs);
1112
1113 if (ec)
Chau Ly9e666cd2023-03-06 08:46:14 +00001114 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001115 lg2::error("Fail to find Chassis Intrusion Interface on D-Bus "
1116 "({INTERFACE}): {ERROR}",
1117 "INTERFACE", Intrusion::interface, "ERROR", ec.message());
1118 return ret;
1119 }
1120
1121 for (const auto& [path, map] : objs)
1122 {
1123 for (const auto& [service, intfs] : map)
Chau Ly9e666cd2023-03-06 08:46:14 +00001124 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001125 ec = ipmi::getDbusProperty<std::string>(
1126 ctx, service, path, Intrusion::interface, "Status", propVal);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001127
Chau Ly8c1376c2024-01-05 07:22:10 +00001128 if (ec)
1129 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001130 lg2::error("Failed to get Chassis Intrusion Status property "
Chau Ly8c1376c2024-01-05 07:22:10 +00001131 "({SERVICE}/{PATH}/{INTERFACE}): {ERROR}",
1132 "SERVICE", service, "PATH", path, "INTERFACE",
1133 Intrusion::interface, "ERROR", ec.message());
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001134 continue;
Chau Ly8c1376c2024-01-05 07:22:10 +00001135 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001136
1137 auto statusOpt =
1138 sdbusplus::message::convert_from_string<Intrusion::Status>(
1139 propVal);
1140 if (statusOpt)
Chau Ly8c1376c2024-01-05 07:22:10 +00001141 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001142 if (*statusOpt == Intrusion::Status::Normal)
Chau Ly8c1376c2024-01-05 07:22:10 +00001143 {
1144 ret = std::make_optional(false);
1145 }
1146 else
1147 {
1148 ret = std::make_optional(true);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001149 return ret; // Early return on first non-Normal status
Chau Ly8c1376c2024-01-05 07:22:10 +00001150 }
1151 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001152 else
1153 {
1154 lg2::warning(
1155 "Invalid Intrusion::Status value received: {VALUE}",
1156 "VALUE", propVal);
1157 return std::nullopt;
1158 }
Chau Ly9e666cd2023-03-06 08:46:14 +00001159 }
1160 }
Chau Ly8c1376c2024-01-05 07:22:10 +00001161 return ret;
Chau Ly9e666cd2023-03-06 08:46:14 +00001162}
1163
Nan Lifdd8ec52016-08-28 03:57:40 +08001164//----------------------------------------------------------------------
1165// Get Chassis Status commands
1166//----------------------------------------------------------------------
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001167ipmi::RspType<bool, // Power is on
1168 bool, // Power overload
1169 bool, // Interlock
1170 bool, // power fault
1171 bool, // power control fault
1172 uint2_t, // power restore policy
1173 bool, // reserved
1174
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001175 bool, // AC failed
1176 bool, // last power down caused by a Power overload
1177 bool, // last power down caused by a power interlock
1178 bool, // last power down caused by power fault
Patrick Williams99db6882024-12-18 11:20:17 -05001179 bool, // last ‘Power is on’ state was entered via IPMI command
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001180 uint3_t, // reserved
1181
1182 bool, // Chassis intrusion active
1183 bool, // Front Panel Lockout active
1184 bool, // Drive Fault
1185 bool, // Cooling/fan fault detected
1186 uint2_t, // Chassis Identify State
1187 bool, // Chassis Identify command and state info supported
1188 bool, // reserved
1189
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001190 bool, // Power off button disabled
1191 bool, // Reset button disabled
1192 bool, // Diagnostic Interrupt button disabled
1193 bool, // Standby (sleep) button disabled
1194 bool, // Power off button disable allowed
1195 bool, // Reset button disable allowed
1196 bool, // Diagnostic Interrupt button disable allowed
1197 bool // Standby (sleep) button disable allowed
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001198 >
Chau Ly9e666cd2023-03-06 08:46:14 +00001199 ipmiGetChassisStatus(ipmi::Context::ptr& ctx)
Nan Lifdd8ec52016-08-28 03:57:40 +08001200{
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001201 using namespace chassis::internal;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001202 std::optional<uint2_t> restorePolicy =
1203 power_policy::getPowerRestorePolicy();
1204 std::optional<bool> powerGood = power_policy::getPowerStatus();
1205 if (!restorePolicy || !powerGood)
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001206 {
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001207 return ipmi::responseUnspecifiedError();
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001208 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001209
1210 // Front Panel Button Capabilities and disable/enable status(Optional)
Patrick Williams1318a5e2024-08-16 15:19:54 -04001211 std::optional<bool> powerButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001212 getButtonDisabled(ctx, powerButtonPath, powerButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001213 // allow disable if the interface is present
1214 bool powerButtonDisableAllow = static_cast<bool>(powerButtonReading);
1215 // default return the button is enabled (not disabled)
1216 bool powerButtonDisabled = false;
1217 if (powerButtonDisableAllow)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001218 {
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001219 // return the real value of the button status, if present
1220 powerButtonDisabled = *powerButtonReading;
1221 }
1222
Patrick Williams1318a5e2024-08-16 15:19:54 -04001223 std::optional<bool> resetButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001224 getButtonDisabled(ctx, resetButtonPath, resetButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001225 // allow disable if the interface is present
1226 bool resetButtonDisableAllow = static_cast<bool>(resetButtonReading);
1227 // default return the button is enabled (not disabled)
1228 bool resetButtonDisabled = false;
1229 if (resetButtonDisableAllow)
1230 {
1231 // return the real value of the button status, if present
1232 resetButtonDisabled = *resetButtonReading;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001233 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001234
Yong Li70ce7352019-05-16 21:15:27 +08001235 bool powerDownAcFailed = power_policy::getACFailStatus();
1236
Chau Ly9e666cd2023-03-06 08:46:14 +00001237 bool chassisIntrusionActive = false;
1238 std::optional<bool> chassisIntrusionStatus = getChassisIntrusionStatus(ctx);
1239 if (chassisIntrusionStatus)
1240 {
1241 chassisIntrusionActive = chassisIntrusionStatus.value();
1242 }
1243
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001244 // This response has a lot of hard-coded, unsupported fields
1245 // They are set to false or 0
1246 constexpr bool powerOverload = false;
1247 constexpr bool chassisInterlock = false;
1248 constexpr bool powerFault = false;
1249 constexpr bool powerControlFault = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001250 constexpr bool powerDownOverload = false;
1251 constexpr bool powerDownInterlock = false;
1252 constexpr bool powerDownPowerFault = false;
1253 constexpr bool powerStatusIPMI = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001254 constexpr bool frontPanelLockoutActive = false;
1255 constexpr bool driveFault = false;
1256 constexpr bool coolingFanFault = false;
1257 // chassisIdentifySupport set because this command is implemented
1258 constexpr bool chassisIdentifySupport = true;
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001259 uint2_t chassisIdentifyState = types::enum_cast<uint2_t>(chassisIDState);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001260 constexpr bool diagButtonDisabled = false;
1261 constexpr bool sleepButtonDisabled = false;
1262 constexpr bool diagButtonDisableAllow = false;
1263 constexpr bool sleepButtonDisableAllow = false;
1264
1265 return ipmi::responseSuccess(
1266 *powerGood, powerOverload, chassisInterlock, powerFault,
1267 powerControlFault, *restorePolicy,
1268 false, // reserved
1269
1270 powerDownAcFailed, powerDownOverload, powerDownInterlock,
1271 powerDownPowerFault, powerStatusIPMI,
1272 uint3_t(0), // reserved
1273
1274 chassisIntrusionActive, frontPanelLockoutActive, driveFault,
1275 coolingFanFault, chassisIdentifyState, chassisIdentifySupport,
1276 false, // reserved
1277
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001278 powerButtonDisabled, resetButtonDisabled, diagButtonDisabled,
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001279 sleepButtonDisabled, powerButtonDisableAllow, resetButtonDisableAllow,
1280 diagButtonDisableAllow, sleepButtonDisableAllow);
Nan Lifdd8ec52016-08-28 03:57:40 +08001281}
Chris Austen7888c4d2015-12-03 15:26:20 -06001282
Vijay Khemka074f64d2020-03-03 15:08:43 -08001283enum class IpmiRestartCause
1284{
1285 Unknown = 0x0,
1286 RemoteCommand = 0x1,
1287 ResetButton = 0x2,
1288 PowerButton = 0x3,
1289 WatchdogTimer = 0x4,
1290 PowerPolicyAlwaysOn = 0x6,
1291 PowerPolicyPreviousState = 0x7,
1292 SoftReset = 0xa,
1293};
1294
Patrick Williams69b4c282025-03-03 11:19:13 -05001295static IpmiRestartCause restartCauseToIpmiRestartCause(
1296 State::Host::RestartCause cause)
Vijay Khemka074f64d2020-03-03 15:08:43 -08001297{
1298 switch (cause)
1299 {
1300 case State::Host::RestartCause::Unknown:
1301 {
1302 return IpmiRestartCause::Unknown;
1303 }
1304 case State::Host::RestartCause::RemoteCommand:
1305 {
1306 return IpmiRestartCause::RemoteCommand;
1307 }
1308 case State::Host::RestartCause::ResetButton:
1309 {
1310 return IpmiRestartCause::ResetButton;
1311 }
1312 case State::Host::RestartCause::PowerButton:
1313 {
1314 return IpmiRestartCause::PowerButton;
1315 }
1316 case State::Host::RestartCause::WatchdogTimer:
1317 {
1318 return IpmiRestartCause::WatchdogTimer;
1319 }
1320 case State::Host::RestartCause::PowerPolicyAlwaysOn:
1321 {
1322 return IpmiRestartCause::PowerPolicyAlwaysOn;
1323 }
1324 case State::Host::RestartCause::PowerPolicyPreviousState:
1325 {
1326 return IpmiRestartCause::PowerPolicyPreviousState;
1327 }
1328 case State::Host::RestartCause::SoftReset:
1329 {
1330 return IpmiRestartCause::SoftReset;
1331 }
1332 default:
1333 {
1334 return IpmiRestartCause::Unknown;
1335 }
1336 }
1337}
1338
1339/*
1340 * getRestartCause
1341 * helper function for Get Host restart cause Command
1342 * return - optional value for RestartCause (no value on error)
1343 */
1344static std::optional<uint4_t> getRestartCause(ipmi::Context::ptr ctx)
1345{
okashanyced0ddf2023-05-18 18:35:09 +00001346 constexpr const char* restartCausePath = "/xyz/openbmc_project/state/host0";
Vijay Khemka074f64d2020-03-03 15:08:43 -08001347
1348 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001349 boost::system::error_code ec =
Alexander Hansen76bfd752025-11-07 17:04:32 +01001350 ipmi::getService(ctx, HostState::interface, restartCausePath, service);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001351 if (!ec)
1352 {
1353 std::string restartCauseStr;
1354 ec = ipmi::getDbusProperty<std::string>(
Alexander Hansen76bfd752025-11-07 17:04:32 +01001355 ctx, service, restartCausePath, HostState::interface,
1356 HostState::property_names::restart_cause, restartCauseStr);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001357 if (!ec)
1358 {
1359 auto cause =
1360 State::Host::convertRestartCauseFromString(restartCauseStr);
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001361 return types::enum_cast<uint4_t>(
1362 restartCauseToIpmiRestartCause(cause));
Vijay Khemka074f64d2020-03-03 15:08:43 -08001363 }
1364 }
1365
Vernon Mauery38108d92024-03-11 12:53:55 -07001366 lg2::error(
1367 "Failed to fetch RestartCause property ({PATH}/{INTERFACE}): {ERROR}",
1368 "ERROR", ec.message(), "PATH", restartCausePath, "INTERFACE",
Alexander Hansen76bfd752025-11-07 17:04:32 +01001369 HostState::interface);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001370 return std::nullopt;
1371}
1372
1373ipmi::RspType<uint4_t, // Restart Cause
1374 uint4_t, // reserved
1375 uint8_t // channel number (not supported)
1376 >
1377 ipmiGetSystemRestartCause(ipmi::Context::ptr ctx)
1378{
1379 std::optional<uint4_t> cause = getRestartCause(ctx);
1380 if (!cause)
1381 {
1382 return ipmi::responseUnspecifiedError();
1383 }
1384
Vernon Mauery916d4232021-03-29 13:42:16 -07001385 constexpr uint4_t reserved = 0;
1386 auto channel = static_cast<uint8_t>(ctx->channel);
1387 return ipmi::responseSuccess(cause.value(), reserved, channel);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001388}
anil kumar appanadafff5f2019-04-27 18:06:00 +00001389/** @brief Implementation of chassis control command
1390 *
1391 * @param - chassisControl command byte
1392 *
1393 * @return Success or InvalidFieldRequest.
1394 */
Jason M. Bills664e1c32020-01-30 16:02:39 -08001395ipmi::RspType<> ipmiChassisControl(ipmi::Context::ptr& ctx,
1396 uint8_t chassisControl)
vishwa36993272015-11-20 12:43:49 -06001397{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001398 int rc = 0;
anil kumar appanadafff5f2019-04-27 18:06:00 +00001399 switch (chassisControl)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001400 {
George Liu8f4717c2025-07-03 09:22:34 +08001401 case cmdPowerOn:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001402 rc = initiateHostStateTransition(ctx, State::Host::Transition::On);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001403 break;
George Liu8f4717c2025-07-03 09:22:34 +08001404 case cmdPowerOff:
Jason M. Billsc2c3a402020-01-30 16:22:24 -08001405 rc = initiateChassisStateTransition(
1406 ctx, State::Chassis::Transition::Off);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001407 break;
George Liu8f4717c2025-07-03 09:22:34 +08001408 case cmdHardReset:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001409 rc = initiateHostStateTransition(
1410 ctx, State::Host::Transition::ForceWarmReboot);
Chanh Nguyend0a7fcd2021-07-16 22:59:28 +07001411 break;
George Liu8f4717c2025-07-03 09:22:34 +08001412 case cmdPowerCycle:
Thang Trana7d592c2025-09-17 03:43:14 +00001413 {
1414 auto powerState = power_policy::getPowerStatus();
1415
1416 if (powerState == std::nullopt)
1417 {
1418 return ipmi::responseUnspecifiedError();
1419 }
1420
1421 /*
1422 * As define in the Chapter 28.3 - Chassis Control Command of IPMI
1423 * specification: It is recommended that no action occur if system
1424 * power is off (S4/S5) when this action is selected, and that a D5
1425 * "Requiest parameter(s) not supported in this presenst state."
1426 * error completion code be returned.
1427 */
1428 if (powerState.value() == false)
1429 {
1430 return ipmi::responseCommandNotAvailable();
1431 }
1432
Jason M. Bills664e1c32020-01-30 16:02:39 -08001433 rc = initiateHostStateTransition(ctx,
1434 State::Host::Transition::Reboot);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001435 break;
Thang Trana7d592c2025-09-17 03:43:14 +00001436 }
George Liu8f4717c2025-07-03 09:22:34 +08001437 case cmdSoftOffViaOverTemp:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001438 rc = initiateHostStateTransition(ctx, State::Host::Transition::Off);
Vishwanatha Subbanna8b26d352017-08-04 18:35:18 +05301439 break;
George Liu8f4717c2025-07-03 09:22:34 +08001440 case cmdPulseDiagnosticInterrupt:
Zev Weiss337a0972024-03-08 08:31:15 +00001441 rc = doNmi(ctx);
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +08001442 break;
1443
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001444 default:
1445 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001446 lg2::error("Invalid Chassis Control command: {CMD}", "CMD",
1447 lg2::hex, chassisControl);
anil kumar appanadafff5f2019-04-27 18:06:00 +00001448 return ipmi::responseInvalidFieldRequest();
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001449 }
1450 }
vishwa36993272015-11-20 12:43:49 -06001451
anil kumar appanadafff5f2019-04-27 18:06:00 +00001452 return ((rc < 0) ? ipmi::responseUnspecifiedError()
1453 : ipmi::responseSuccess());
vishwa36993272015-11-20 12:43:49 -06001454}
1455
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001456/** @brief Return D-Bus connection string to enclosure identify LED object
1457 *
1458 * @param[in, out] connection - connection to D-Bus object
1459 * @return a IPMI return code
1460 */
1461std::string getEnclosureIdentifyConnection()
Tom Joseph5110c122018-03-23 17:55:40 +05301462{
Tom Joseph5110c122018-03-23 17:55:40 +05301463 // lookup enclosure_identify group owner(s) in mapper
George Liu3e3cc352023-07-26 15:59:31 +08001464 try
Tom Joseph5110c122018-03-23 17:55:40 +05301465 {
George Liu3e3cc352023-07-26 15:59:31 +08001466 return ipmi::getService(*getSdBus(), "xyz.openbmc_project.Led.Group",
1467 identify_led_object_name);
1468 }
1469 catch (const std::exception& e)
1470 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001471 lg2::error("Chassis Identify: Error communicating to mapper: {ERROR}",
1472 "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001473 elog<InternalFailure>();
Tom Joseph5110c122018-03-23 17:55:40 +05301474 }
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001475}
Tom Joseph5110c122018-03-23 17:55:40 +05301476
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001477/** @brief Turn On/Off enclosure identify LED
1478 *
1479 * @param[in] flag - true to turn on LED, false to turn off
1480 * @return a IPMI return code
1481 */
1482void enclosureIdentifyLed(bool flag)
1483{
1484 using namespace chassis::internal;
George Liucbe50fd2025-08-21 16:51:33 +08001485
1486 std::string connection = getEnclosureIdentifyConnection();
1487
1488 lg2::debug("enclosureIdentifyLed({FLAG})", "FLAG", flag);
1489
George Liu3e3cc352023-07-26 15:59:31 +08001490 try
1491 {
George Liu3e3cc352023-07-26 15:59:31 +08001492 ipmi::setDbusProperty(*getSdBus(), connection, identify_led_object_name,
1493 "xyz.openbmc_project.Led.Group", "Asserted",
1494 flag);
1495 }
1496 catch (const std::exception& e)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001497 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001498 lg2::error("Chassis Identify: Error Setting State {LED_STATE}: {ERROR}",
1499 "LED_STATE", flag, "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001500 elog<InternalFailure>();
1501 }
1502}
1503
1504/** @brief Callback method to turn off LED
1505 */
1506void enclosureIdentifyLedOff()
1507{
1508 try
1509 {
Yong Lif4e38512019-05-21 14:46:55 +08001510 chassisIDState = ChassisIDState::off;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001511 enclosureIdentifyLed(false);
1512 }
1513 catch (const InternalFailure& e)
1514 {
1515 report<InternalFailure>();
1516 }
1517}
1518
1519/** @brief Create timer to turn on and off the enclosure LED
1520 */
1521void createIdentifyTimer()
1522{
1523 if (!identifyTimer)
1524 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001525 identifyTimer =
Patrick Williams95655222023-12-05 12:45:02 -06001526 std::make_unique<sdbusplus::Timer>(enclosureIdentifyLedOff);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001527 }
1528}
1529
Vernon Mauery400cc782018-10-09 13:49:53 -07001530ipmi::RspType<> ipmiChassisIdentify(std::optional<uint8_t> interval,
1531 std::optional<uint8_t> force)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001532{
Vernon Mauery400cc782018-10-09 13:49:53 -07001533 uint8_t identifyInterval = interval.value_or(DEFAULT_IDENTIFY_TIME_OUT);
1534 bool forceIdentify = force.value_or(0) & 0x01;
Tom Josephbed26992018-07-31 23:00:24 +05301535
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001536 if (identifyInterval || forceIdentify)
1537 {
Vernon Mauery400cc782018-10-09 13:49:53 -07001538 // stop the timer if already started;
1539 // for force identify we should not turn off LED
Vernon Mauery1181af72018-10-08 12:05:00 -07001540 identifyTimer->stop();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001541 try
Tom Joseph5110c122018-03-23 17:55:40 +05301542 {
Yong Lif4e38512019-05-21 14:46:55 +08001543 chassisIDState = ChassisIDState::temporaryOn;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001544 enclosureIdentifyLed(true);
1545 }
1546 catch (const InternalFailure& e)
1547 {
1548 report<InternalFailure>();
Vernon Mauery400cc782018-10-09 13:49:53 -07001549 return ipmi::responseResponseError();
Tom Joseph5110c122018-03-23 17:55:40 +05301550 }
1551
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001552 if (forceIdentify)
Tom Joseph5110c122018-03-23 17:55:40 +05301553 {
Yong Lif4e38512019-05-21 14:46:55 +08001554 chassisIDState = ChassisIDState::indefiniteOn;
Vernon Mauery400cc782018-10-09 13:49:53 -07001555 return ipmi::responseSuccess();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001556 }
1557 // start the timer
1558 auto time = std::chrono::duration_cast<std::chrono::microseconds>(
Patrick Venture0b02be92018-08-31 11:55:55 -07001559 std::chrono::seconds(identifyInterval));
Vernon Mauery1181af72018-10-08 12:05:00 -07001560 identifyTimer->start(time);
Tom Joseph5110c122018-03-23 17:55:40 +05301561 }
Tom Josephbed26992018-07-31 23:00:24 +05301562 else if (!identifyInterval)
1563 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001564 identifyTimer->stop();
Tom Josephbed26992018-07-31 23:00:24 +05301565 enclosureIdentifyLedOff();
1566 }
Vernon Mauery400cc782018-10-09 13:49:53 -07001567 return ipmi::responseSuccess();
Tom Joseph5110c122018-03-23 17:55:40 +05301568}
1569
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001570namespace boot_options
1571{
1572
Willy Tu523e2d12023-09-05 11:36:48 -07001573using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001574using IpmiValue = uint8_t;
1575constexpr auto ipmiDefault = 0;
1576
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001577std::map<IpmiValue, Type::Types> typeIpmiToDbus = {{0x00, Type::Types::Legacy},
1578 {0x01, Type::Types::EFI}};
1579
Patrick Venture0b02be92018-08-31 11:55:55 -07001580std::map<IpmiValue, Source::Sources> sourceIpmiToDbus = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001581 {0x01, Source::Sources::Network},
1582 {0x02, Source::Sources::Disk},
1583 {0x05, Source::Sources::ExternalMedia},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001584 {0x0f, Source::Sources::RemovableMedia},
Patrick Venture0b02be92018-08-31 11:55:55 -07001585 {ipmiDefault, Source::Sources::Default}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001586
Patrick Venture0b02be92018-08-31 11:55:55 -07001587std::map<IpmiValue, Mode::Modes> modeIpmiToDbus = {
Yong Li5833cb62019-10-30 13:27:12 +08001588#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001589 {0x03, Mode::Modes::Safe},
Yong Li5833cb62019-10-30 13:27:12 +08001590#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001591 {0x06, Mode::Modes::Setup},
Patrick Venture0b02be92018-08-31 11:55:55 -07001592 {ipmiDefault, Mode::Modes::Regular}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001593
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001594std::map<Type::Types, IpmiValue> typeDbusToIpmi = {{Type::Types::Legacy, 0x00},
1595 {Type::Types::EFI, 0x01}};
1596
Patrick Venture0b02be92018-08-31 11:55:55 -07001597std::map<Source::Sources, IpmiValue> sourceDbusToIpmi = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001598 {Source::Sources::Network, 0x01},
1599 {Source::Sources::Disk, 0x02},
1600 {Source::Sources::ExternalMedia, 0x05},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001601 {Source::Sources::RemovableMedia, 0x0f},
Patrick Venture0b02be92018-08-31 11:55:55 -07001602 {Source::Sources::Default, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001603
Patrick Venture0b02be92018-08-31 11:55:55 -07001604std::map<Mode::Modes, IpmiValue> modeDbusToIpmi = {
Yong Li5833cb62019-10-30 13:27:12 +08001605#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001606 {Mode::Modes::Safe, 0x03},
Yong Li5833cb62019-10-30 13:27:12 +08001607#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001608 {Mode::Modes::Setup, 0x06},
Patrick Venture0b02be92018-08-31 11:55:55 -07001609 {Mode::Modes::Regular, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001610
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001611} // namespace boot_options
shgoupfd84fbbf2015-12-17 10:05:51 +08001612
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001613/** @brief Get the property value for boot source
1614 * @param[in] ctx - context pointer
1615 * @param[out] source - boot source value
1616 * @return On failure return IPMI error.
1617 */
1618static ipmi::Cc getBootSource(ipmi::Context::ptr& ctx, Source::Sources& source)
1619{
1620 using namespace chassis::internal;
1621 std::string result;
1622 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001623 boost::system::error_code ec =
1624 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001625 if (!ec)
1626 {
1627 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1628 bootSourceIntf, "BootSource", result);
1629 if (!ec)
1630 {
1631 source = Source::convertSourcesFromString(result);
1632 return ipmi::ccSuccess;
1633 }
1634 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001635 lg2::error("Error in BootSource Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001636 return ipmi::ccUnspecifiedError;
1637}
1638
Marri Devender Rao81719702018-05-07 00:53:48 -05001639/** @brief Set the property value for boot source
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001640 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001641 * @param[in] source - boot source value
1642 * @return On failure return IPMI error.
1643 */
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00001644static ipmi::Cc setBootSource(ipmi::Context::ptr& ctx,
1645 const Source::Sources& source)
Marri Devender Rao81719702018-05-07 00:53:48 -05001646{
1647 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001648 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001649 boost::system::error_code ec =
1650 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001651 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001652 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001653 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1654 bootSourceIntf, "BootSource",
1655 convertForMessage(source));
1656 if (!ec)
1657 {
1658 return ipmi::ccSuccess;
1659 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001660 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001661 lg2::error("Error in BootSource Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001662 return ipmi::ccUnspecifiedError;
1663}
1664
1665/** @brief Get the property value for boot mode
1666 * @param[in] ctx - context pointer
1667 * @param[out] mode - boot mode value
1668 * @return On failure return IPMI error.
1669 */
1670static ipmi::Cc getBootMode(ipmi::Context::ptr& ctx, Mode::Modes& mode)
1671{
1672 using namespace chassis::internal;
1673 std::string result;
1674 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001675 boost::system::error_code ec =
1676 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001677 if (!ec)
1678 {
1679 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1680 "BootMode", result);
1681 if (!ec)
1682 {
1683 mode = Mode::convertModesFromString(result);
1684 return ipmi::ccSuccess;
1685 }
1686 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001687 lg2::error("Error in BootMode Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001688 return ipmi::ccUnspecifiedError;
Marri Devender Rao81719702018-05-07 00:53:48 -05001689}
1690
Patrick Venture0b02be92018-08-31 11:55:55 -07001691/** @brief Set the property value for boot mode
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001692 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001693 * @param[in] mode - boot mode value
1694 * @return On failure return IPMI error.
1695 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001696static ipmi::Cc setBootMode(ipmi::Context::ptr& ctx, const Mode::Modes& mode)
Marri Devender Rao81719702018-05-07 00:53:48 -05001697{
1698 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001699 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001700 boost::system::error_code ec =
1701 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001702 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001703 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001704 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1705 "BootMode", convertForMessage(mode));
1706 if (!ec)
1707 {
1708 return ipmi::ccSuccess;
1709 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001710 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001711 lg2::error("Error in BootMode Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001712 return ipmi::ccUnspecifiedError;
1713}
1714
1715/** @brief Get the property value for boot type
1716 * @param[in] ctx - context pointer
1717 * @param[out] type - boot type value
1718 * @return On failure return IPMI error.
1719 */
1720static ipmi::Cc getBootType(ipmi::Context::ptr& ctx, Type::Types& type)
1721{
1722 using namespace chassis::internal;
1723 std::string result;
1724 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001725 boost::system::error_code ec =
1726 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001727
1728 // Don't throw error if BootType interface is not present.
1729 // This interface is not relevant for some Host architectures
1730 // (for example POWER). In this case we don't won't IPMI to
1731 // return an error, but simply return bootType as EFI.
1732 type = Type::Types::EFI;
1733 if (!ec)
1734 {
1735 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1736 "BootType", result);
1737 if (ec)
1738 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001739 lg2::error("Error in BootType Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001740 return ipmi::ccUnspecifiedError;
1741 }
1742 type = Type::convertTypesFromString(result);
1743 }
1744
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00001745 return ipmi::ccSuccess;
Marri Devender Rao81719702018-05-07 00:53:48 -05001746}
1747
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001748/** @brief Set the property value for boot type
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001749 * @param[in] ctx - context pointer
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001750 * @param[in] type - boot type value
1751 * @return On failure return IPMI error.
1752 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001753static ipmi::Cc setBootType(ipmi::Context::ptr& ctx, const Type::Types& type)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001754{
1755 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001756 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001757 boost::system::error_code ec =
1758 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001759 if (!ec)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001760 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001761 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1762 "BootType", convertForMessage(type));
1763 if (ec)
1764 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001765 lg2::error("Error in BootType Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001766 return ipmi::ccUnspecifiedError;
1767 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001768 }
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001769 // Don't throw error if BootType interface is not present.
1770 // This interface is not relevant for some Host architectures
1771 // (for example POWER). In this case we don't won't IPMI to
1772 // return an error, but want to just skip this function.
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001773 return ipmi::ccSuccess;
1774}
1775
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001776/** @brief Get the property value for boot override enable
1777 * @param[in] ctx - context pointer
1778 * @param[out] enable - boot override enable
1779 * @return On failure return IPMI error.
1780 */
1781static ipmi::Cc getBootEnable(ipmi::Context::ptr& ctx, bool& enable)
1782{
1783 using namespace chassis::internal;
1784 std::string result;
1785 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001786 boost::system::error_code ec =
1787 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001788 if (!ec)
1789 {
1790 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1791 bootEnableIntf, "Enabled", enable);
1792 if (!ec)
1793 {
1794 return ipmi::ccSuccess;
1795 }
1796 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001797 lg2::error("Error in Boot Override Enable Get: {ERROR}", "ERROR",
1798 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001799 return ipmi::ccUnspecifiedError;
1800}
1801
1802/** @brief Set the property value for boot override enable
1803 * @param[in] ctx - context pointer
1804 * @param[in] enable - boot override enable
1805 * @return On failure return IPMI error.
1806 */
1807static ipmi::Cc setBootEnable(ipmi::Context::ptr& ctx, const bool& enable)
1808{
1809 using namespace chassis::internal;
1810 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001811 boost::system::error_code ec =
1812 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001813 if (!ec)
1814 {
1815 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1816 bootEnableIntf, "Enabled", enable);
1817 if (!ec)
1818 {
1819 return ipmi::ccSuccess;
1820 }
1821 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001822 lg2::error("Error in Boot Source Override Enable Set: {ERROR}", "ERROR",
1823 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001824 return ipmi::ccUnspecifiedError;
1825}
1826
1827/** @brief Get the property value for boot override one-time
1828 * @param[in] ctx - context pointer
1829 * @param[out] onetime - boot override one-time
1830 * @return On failure return IPMI error.
1831 */
1832static ipmi::Cc getBootOneTime(ipmi::Context::ptr& ctx, bool& onetime)
1833{
1834 using namespace chassis::internal;
1835 std::string result;
1836 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001837 boost::system::error_code ec =
1838 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001839 if (!ec)
1840 {
1841 ec = ipmi::getDbusProperty(ctx, service, bootSettingsOneTimePath,
1842 bootOneTimeIntf, "Enabled", onetime);
1843 if (!ec)
1844 {
1845 return ipmi::ccSuccess;
1846 }
1847 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001848 lg2::error("Error in Boot Override OneTime Get: {ERROR}", "ERROR",
1849 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001850 return ipmi::ccUnspecifiedError;
1851}
1852
1853/** @brief Set the property value for boot override one-time
1854 * @param[in] ctx - context pointer
1855 * @param[in] onetime - boot override one-time
1856 * @return On failure return IPMI error.
1857 */
1858static ipmi::Cc setBootOneTime(ipmi::Context::ptr& ctx, const bool& onetime)
1859{
1860 using namespace chassis::internal;
1861 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001862 boost::system::error_code ec =
1863 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001864 if (!ec)
1865 {
1866 ec = ipmi::setDbusProperty(ctx, service, bootSettingsOneTimePath,
1867 bootOneTimeIntf, "Enabled", onetime);
1868 if (!ec)
1869 {
1870 return ipmi::ccSuccess;
1871 }
1872 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001873 lg2::error("Error in Boot Source Override OneTime Set: {ERROR}", "ERROR",
1874 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001875 return ipmi::ccUnspecifiedError;
1876}
1877
huangheab369282020-10-10 14:40:00 +08001878static constexpr uint8_t setComplete = 0x0;
1879static constexpr uint8_t setInProgress = 0x1;
1880static uint8_t transferStatus = setComplete;
Chen Yugang86ac4992021-06-25 08:14:52 +08001881static uint8_t bootFlagValidBitClr = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001882static uint5_t bootInitiatorAckData = 0x0;
Hieu Huynh1982a3f2021-09-21 03:06:45 +00001883static bool cmosClear = false;
Cosmo Chou53831212025-01-10 13:36:36 +08001884static uint2_t biosVerbosity = 0x0;
huangheab369282020-10-10 14:40:00 +08001885
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001886/** @brief implements the Get Chassis system boot option
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001887 * @param ctx - context pointer
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001888 * @param bootOptionParameter - boot option parameter selector
1889 * @param reserved1 - reserved bit
1890 * @param setSelector - selects a particular block or set of parameters
1891 * under the given parameter selector
1892 * write as 00h if parameter doesn't use a setSelector
1893 * @param blockSelector- selects a particular block within a set of
1894 * parameters write as 00h if parameter doesn't use a
1895 * blockSelector
1896 *
1897 * @return IPMI completion code plus response data
1898 * @return Payload contains below parameters:
1899 * version - parameter version
1900 * bootOptionParameter - boot option parameter selector
Patrick Venture8b1c3032020-09-15 09:43:03 -07001901 * parmIndicator - parameter valid/invalid indicator
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001902 * data - configuration parameter data
1903 */
Patrick Williams1318a5e2024-08-16 15:19:54 -04001904ipmi::RspType<ipmi::message::Payload> ipmiChassisGetSysBootOptions(
1905 ipmi::Context::ptr ctx, uint7_t bootOptionParameter, bool reserved1,
1906 [[maybe_unused]] uint8_t setSelector,
1907 [[maybe_unused]] uint8_t blockSelector)
Adriana Kobylak40814c62015-10-27 15:58:44 -05001908{
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001909 ipmi::Cc rc;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001910 if (reserved1)
1911 {
1912 return ipmi::responseInvalidFieldRequest();
1913 }
1914
1915 constexpr uint4_t version = 0x01;
1916 ipmi::message::Payload response;
1917 response.pack(version, uint4_t{});
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001918 using namespace boot_options;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001919
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001920 IpmiValue bootOption = ipmiDefault;
Adriana Kobylak40814c62015-10-27 15:58:44 -05001921
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001922 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1923 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08001924 {
1925 response.pack(bootOptionParameter, reserved1, transferStatus);
1926 return ipmi::responseSuccess(std::move(response));
1927 }
1928
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001929 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1930 BootOptionParameter::bootInfo)
John Wang0213f902020-12-28 14:49:57 +08001931 {
1932 constexpr uint8_t writeMask = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001933 response.pack(bootOptionParameter, reserved1, writeMask,
1934 bootInitiatorAckData);
John Wang0213f902020-12-28 14:49:57 +08001935 return ipmi::responseSuccess(std::move(response));
1936 }
1937
Chen Yugang86ac4992021-06-25 08:14:52 +08001938 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1939 BootOptionParameter::bootFlagValidClr)
1940 {
1941 response.pack(bootOptionParameter, reserved1,
1942 uint5_t{bootFlagValidBitClr}, uint3_t{});
1943 return ipmi::responseSuccess(std::move(response));
1944 }
1945
shgoupfd84fbbf2015-12-17 10:05:51 +08001946 /*
1947 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
1948 * This is the only parameter used by petitboot.
1949 */
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001950 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1951 BootOptionParameter::bootFlags)
Patrick Venture0b02be92018-08-31 11:55:55 -07001952 {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001953 using namespace chassis::internal;
1954 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08001955
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001956 try
ratagupta6f6bff2016-04-04 06:20:11 -05001957 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001958 Source::Sources bootSource;
1959 rc = getBootSource(ctx, bootSource);
1960 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001961 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001962 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001963 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001964
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001965 Type::Types bootType;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001966 rc = getBootType(ctx, bootType);
1967 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001968 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001969 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001970 }
1971
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001972 Mode::Modes bootMode;
1973 rc = getBootMode(ctx, bootMode);
1974 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001975 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001976 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001977 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001978
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001979 bootOption = sourceDbusToIpmi.at(bootSource);
1980 if ((Mode::Modes::Regular == bootMode) &&
1981 (Source::Sources::Default == bootSource))
1982 {
1983 bootOption = ipmiDefault;
1984 }
1985 else if (Source::Sources::Default == bootSource)
1986 {
1987 bootOption = modeDbusToIpmi.at(bootMode);
1988 }
ratagupta6f6bff2016-04-04 06:20:11 -05001989
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001990 IpmiValue biosBootType = typeDbusToIpmi.at(bootType);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001991
1992 bool oneTimeEnabled;
1993 rc = getBootOneTime(ctx, oneTimeEnabled);
1994 if (rc != ipmi::ccSuccess)
1995 {
1996 return ipmi::response(rc);
1997 }
1998
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001999 uint1_t permanent = oneTimeEnabled ? 0 : 1;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002000
2001 bool valid;
2002 rc = getBootEnable(ctx, valid);
2003 if (rc != ipmi::ccSuccess)
2004 {
2005 return ipmi::response(rc);
2006 }
2007
2008 uint1_t validFlag = valid ? 1 : 0;
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002009
Cosmo Chou53831212025-01-10 13:36:36 +08002010 response.pack(
2011 bootOptionParameter, reserved1, uint5_t{},
2012 uint1_t{biosBootType}, uint1_t{permanent}, uint1_t{validFlag},
2013 uint2_t{}, uint4_t{bootOption}, uint1_t{}, cmosClear, uint5_t{},
2014 uint2_t{biosVerbosity}, uint1_t{}, uint8_t{}, uint8_t{});
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002015 return ipmi::responseSuccess(std::move(response));
ratagupta6f6bff2016-04-04 06:20:11 -05002016 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002017 catch (const InternalFailure& e)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002018 {
James Feist225dec82019-11-26 16:25:06 -08002019 cache::objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002020 report<InternalFailure>();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002021 return ipmi::responseUnspecifiedError();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002022 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002023 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002024 else
2025 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002026 if ((bootOptionParameter >= oemParmStart) &&
2027 (bootOptionParameter <= oemParmEnd))
2028 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002029 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
2030 BootOptionParameter::opalNetworkSettings)
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002031 {
2032 response.pack(bootOptionParameter, reserved1);
2033 int ret = getHostNetworkData(response);
2034 if (ret < 0)
2035 {
2036 response.trailingOk = true;
Vernon Mauery38108d92024-03-11 12:53:55 -07002037 lg2::error(
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002038 "getHostNetworkData failed for GetSysBootOptions.");
2039 return ipmi::responseUnspecifiedError();
2040 }
2041 else
2042 {
2043 return ipmi::responseSuccess(std::move(response));
2044 }
2045 }
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002046 else
2047 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002048 lg2::error(
2049 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2050 "PARAM", lg2::hex,
2051 static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002052 return ipmi::responseParmNotSupported();
2053 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002054 }
2055 else
2056 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002057 lg2::error(
2058 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2059 "PARAM", lg2::hex, static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00002060 return ipmi::responseParmNotSupported();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002061 }
shgoupfd84fbbf2015-12-17 10:05:51 +08002062 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002063 return ipmi::responseUnspecifiedError();
shgoupfd84fbbf2015-12-17 10:05:51 +08002064}
2065
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002066ipmi::RspType<> ipmiChassisSetSysBootOptions(ipmi::Context::ptr ctx,
Willy Tu11d68892022-01-20 10:37:34 -08002067 uint7_t parameterSelector, bool,
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002068 ipmi::message::Payload& data)
shgoupfd84fbbf2015-12-17 10:05:51 +08002069{
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002070 using namespace boot_options;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002071 ipmi::Cc rc;
shgoupfd84fbbf2015-12-17 10:05:51 +08002072
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002073 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2074 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08002075 {
2076 uint2_t setInProgressFlag;
2077 uint6_t rsvd;
2078 if (data.unpack(setInProgressFlag, rsvd) != 0 || !data.fullyUnpacked())
2079 {
2080 return ipmi::responseReqDataLenInvalid();
2081 }
2082 if (rsvd)
2083 {
2084 return ipmi::responseInvalidFieldRequest();
2085 }
2086 if ((transferStatus == setInProgress) &&
2087 (static_cast<uint8_t>(setInProgressFlag) != setComplete))
2088 {
George Liuf5dd1022025-07-07 09:13:07 +08002089 return ipmi::responsefailSetInProgress();
huangheab369282020-10-10 14:40:00 +08002090 }
2091 transferStatus = static_cast<uint8_t>(setInProgressFlag);
2092 return ipmi::responseSuccess();
2093 }
2094
shgoupfd84fbbf2015-12-17 10:05:51 +08002095 /* 000101
2096 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
2097 * This is the only parameter used by petitboot.
2098 */
Ratan Guptafd28dd72016-08-01 04:58:01 -05002099
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002100 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2101 BootOptionParameter::bootFlags)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002102 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002103 uint5_t rsvd;
2104 bool validFlag;
2105 bool permanent;
2106 bool biosBootType;
2107 bool lockOutResetButton;
2108 bool screenBlank;
2109 uint4_t bootDeviceSelector;
2110 bool lockKeyboard;
Cosmo Chou53831212025-01-10 13:36:36 +08002111 uint5_t biosCtrls;
2112 bool lockOutPower;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002113 uint4_t biosInfo;
2114 uint4_t rsvd1;
2115 uint5_t deviceInstance;
2116 uint3_t rsvd2;
2117
2118 if (data.unpack(rsvd, biosBootType, permanent, validFlag,
2119 lockOutResetButton, screenBlank, bootDeviceSelector,
Cosmo Chou53831212025-01-10 13:36:36 +08002120 lockKeyboard, cmosClear, biosCtrls, biosVerbosity,
2121 lockOutPower, biosInfo, rsvd1, deviceInstance, rsvd2) !=
2122 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002123 !data.fullyUnpacked())
2124 {
2125 return ipmi::responseReqDataLenInvalid();
2126 }
2127 if (rsvd || rsvd1 || rsvd2)
2128 {
2129 return ipmi::responseInvalidFieldRequest();
2130 }
2131
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002132 using namespace chassis::internal;
2133 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08002134
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002135 try
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002136 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002137 rc = setBootOneTime(ctx, !permanent);
2138 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev69e8e842021-06-18 17:01:18 +03002139 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002140 return ipmi::response(rc);
2141 }
Vernon Maueryafd45db2021-07-29 16:27:25 +00002142
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002143 rc = setBootEnable(ctx, validFlag);
2144 if (rc != ipmi::ccSuccess)
2145 {
2146 return ipmi::response(rc);
Tom Joseph57e8eb72017-09-25 18:05:02 +05302147 }
2148
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002149 auto modeItr =
2150 modeIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002151 auto typeItr =
2152 typeIpmiToDbus.find(static_cast<uint8_t>(biosBootType));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002153 auto sourceItr =
2154 sourceIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002155 if (sourceIpmiToDbus.end() != sourceItr)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002156 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002157 rc = setBootSource(ctx, sourceItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002158 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002159 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002160 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002161 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002162 // If a set boot device is mapping to a boot source, then reset
2163 // the boot mode D-Bus property to default.
2164 // This way the ipmid code can determine which property is not
2165 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002166 if (sourceItr->second != Source::Sources::Default)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002167 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002168 rc = setBootMode(ctx, Mode::Modes::Regular);
2169 if (rc != ipmi::ccSuccess)
2170 {
2171 return ipmi::response(rc);
2172 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002173 }
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002174 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002175
2176 if (typeIpmiToDbus.end() != typeItr)
2177 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002178 rc = setBootType(ctx, typeItr->second);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002179 if (rc != ipmi::ccSuccess)
2180 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002181 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002182 }
2183 }
2184
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002185 if (modeIpmiToDbus.end() != modeItr)
2186 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002187 rc = setBootMode(ctx, modeItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002188 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002189 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002190 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002191 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002192 // If a set boot device is mapping to a boot mode, then reset
2193 // the boot source D-Bus property to default.
2194 // This way the ipmid code can determine which property is not
2195 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002196 if (modeItr->second != Mode::Modes::Regular)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002197 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002198 rc = setBootSource(ctx, Source::Sources::Default);
2199 if (rc != ipmi::ccSuccess)
2200 {
2201 return ipmi::response(rc);
2202 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002203 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002204 }
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002205 if ((modeIpmiToDbus.end() == modeItr) &&
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002206 (typeIpmiToDbus.end() == typeItr) &&
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002207 (sourceIpmiToDbus.end() == sourceItr))
2208 {
2209 // return error if boot option is not supported
Vernon Mauery38108d92024-03-11 12:53:55 -07002210 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002211 "ipmiChassisSetSysBootOptions: Boot option not supported");
2212 return ipmi::responseInvalidFieldRequest();
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002213 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002214 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002215 catch (const sdbusplus::exception_t& e)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002216 {
James Feist225dec82019-11-26 16:25:06 -08002217 objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002218 report<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -07002219 lg2::error("ipmiChassisSetSysBootOptions: Error in setting Boot "
2220 "flag parameters");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002221 return ipmi::responseUnspecifiedError();
Ratan Guptafd28dd72016-08-01 04:58:01 -05002222 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002223 }
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002224 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2225 BootOptionParameter::bootInfo)
Patrick Venture0b02be92018-08-31 11:55:55 -07002226 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002227 uint8_t writeMak;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002228 uint5_t bootInfoAck;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002229 uint3_t rsvd;
2230
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002231 if (data.unpack(writeMak, bootInfoAck, rsvd) != 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002232 !data.fullyUnpacked())
2233 {
2234 return ipmi::responseReqDataLenInvalid();
2235 }
2236 if (rsvd)
2237 {
2238 return ipmi::responseInvalidFieldRequest();
2239 }
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002240 bootInitiatorAckData &= ~writeMak;
2241 bootInitiatorAckData |= (writeMak & bootInfoAck);
Vernon Mauery38108d92024-03-11 12:53:55 -07002242 lg2::info("ipmiChassisSetSysBootOptions: bootInfo parameter set "
2243 "successfully");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002244 data.trailingOk = true;
2245 return ipmi::responseSuccess();
Patrick Venture0b02be92018-08-31 11:55:55 -07002246 }
Chen Yugang86ac4992021-06-25 08:14:52 +08002247 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2248 BootOptionParameter::bootFlagValidClr)
2249 {
2250 uint5_t bootFlagValidClr;
2251 uint3_t rsvd;
2252
2253 if (data.unpack(bootFlagValidClr, rsvd) != 0 || !data.fullyUnpacked())
2254 {
2255 return ipmi::responseReqDataLenInvalid();
2256 }
2257 if (rsvd)
2258 {
2259 return ipmi::responseInvalidFieldRequest();
2260 }
2261 // store boot flag valid bits clear value
2262 bootFlagValidBitClr = static_cast<uint8_t>(bootFlagValidClr);
Vernon Mauery38108d92024-03-11 12:53:55 -07002263 lg2::info(
Chen Yugang86ac4992021-06-25 08:14:52 +08002264 "ipmiChassisSetSysBootOptions: bootFlagValidBits parameter set "
Vernon Mauery38108d92024-03-11 12:53:55 -07002265 "successfully to {VALUE}",
2266 "VALUE", lg2::hex, bootFlagValidBitClr);
Chen Yugang86ac4992021-06-25 08:14:52 +08002267 return ipmi::responseSuccess();
2268 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002269 else
2270 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002271 if ((parameterSelector >= static_cast<uint7_t>(oemParmStart)) &&
2272 (parameterSelector <= static_cast<uint7_t>(oemParmEnd)))
2273 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002274 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2275 BootOptionParameter::opalNetworkSettings)
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002276 {
2277 ipmi::Cc ret = setHostNetworkData(data);
2278 if (ret != ipmi::ccSuccess)
2279 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002280 lg2::error("ipmiChassisSetSysBootOptions: Error in "
2281 "setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002282 data.trailingOk = true;
2283 return ipmi::response(ret);
2284 }
2285 data.trailingOk = true;
2286 return ipmi::responseSuccess();
2287 }
2288 else
2289 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002290 lg2::error(
2291 "ipmiChassisSetSysBootOptions: Unsupported param: {PARAM}",
2292 "PARAM", lg2::hex, static_cast<uint8_t>(parameterSelector));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002293 data.trailingOk = true;
2294 return ipmi::responseParmNotSupported();
2295 }
2296 }
2297 data.trailingOk = true;
2298 return ipmi::responseParmNotSupported();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002299 }
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002300 return ipmi::responseSuccess();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002301}
2302
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002303/** @brief implements Get POH counter command
2304 * @parameter
2305 * - none
2306 * @returns IPMI completion code plus response data
2307 * - minPerCount - Minutes per count
2308 * - counterReading - counter reading
2309 */
2310ipmi::RspType<uint8_t, // Minutes per count
2311 uint32_t // Counter reading
2312 >
2313 ipmiGetPOHCounter()
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002314{
2315 // sd_bus error
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002316 try
2317 {
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002318 return ipmi::responseSuccess(static_cast<uint8_t>(poh::minutesPerCount),
2319 getPOHCounter());
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002320 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002321 catch (const std::exception& e)
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002322 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002323 lg2::error("getPOHCounter error: {ERROR}", "ERROR", e);
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002324 return ipmi::responseUnspecifiedError();
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002325 }
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002326}
2327
Jason M. Billsbc996a32019-06-17 15:46:37 -07002328ipmi::RspType<uint3_t, // policy support
2329 uint5_t // reserved
2330 >
George Liude1420d2025-03-03 15:14:25 +08002331 ipmiChassisSetPowerRestorePolicy(ipmi::Context::ptr ctx, uint3_t policy,
2332 uint5_t reserved)
Yong Lic6713cf2018-09-12 12:35:13 +08002333{
Yong Lic6713cf2018-09-12 12:35:13 +08002334 power_policy::DbusValue value =
2335 power_policy::RestorePolicy::Policy::AlwaysOff;
2336
Jason M. Billsbc996a32019-06-17 15:46:37 -07002337 if (reserved || (policy > power_policy::noChange))
Yong Lic6713cf2018-09-12 12:35:13 +08002338 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002339 lg2::error("Reserved request parameter: {REQ}", "REQ", lg2::hex,
2340 static_cast<int>(policy));
Jason M. Billsbc996a32019-06-17 15:46:37 -07002341 return ipmi::responseInvalidFieldRequest();
Yong Lic6713cf2018-09-12 12:35:13 +08002342 }
2343
Vernon Mauerye278ead2018-10-09 09:23:43 -07002344 if (policy == power_policy::noChange)
Yong Lic6713cf2018-09-12 12:35:13 +08002345 {
2346 // just return the supported policy
Jason M. Billsbc996a32019-06-17 15:46:37 -07002347 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002348 }
2349
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05002350 for (const auto& it : power_policy::dbusToIpmi)
Yong Lic6713cf2018-09-12 12:35:13 +08002351 {
Vernon Mauerye278ead2018-10-09 09:23:43 -07002352 if (it.second == policy)
Yong Lic6713cf2018-09-12 12:35:13 +08002353 {
2354 value = it.first;
2355 break;
2356 }
2357 }
2358
2359 try
2360 {
James Feist225dec82019-11-26 16:25:06 -08002361 settings::Objects& objects = chassis::internal::cache::getObjects();
Yong Lic6713cf2018-09-12 12:35:13 +08002362 const settings::Path& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -08002363 objects.map.at(chassis::internal::powerRestoreIntf).front();
Yong Lic6713cf2018-09-12 12:35:13 +08002364
George Liude1420d2025-03-03 15:14:25 +08002365 boost::system::error_code ec = ipmi::setDbusProperty(
2366 ctx,
2367 objects.service(powerRestoreSetting,
2368 chassis::internal::powerRestoreIntf),
2369 powerRestoreSetting, chassis::internal::powerRestoreIntf,
2370 "PowerRestorePolicy", convertForMessage(value));
Vernon Mauerye278ead2018-10-09 09:23:43 -07002371 if (ec)
Yong Lic6713cf2018-09-12 12:35:13 +08002372 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002373 lg2::error("Unspecified Error");
Vernon Mauerye278ead2018-10-09 09:23:43 -07002374 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002375 }
2376 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002377 catch (const InternalFailure& e)
Yong Lic6713cf2018-09-12 12:35:13 +08002378 {
James Feist225dec82019-11-26 16:25:06 -08002379 chassis::internal::cache::objectsPtr.reset();
Yong Lic6713cf2018-09-12 12:35:13 +08002380 report<InternalFailure>();
Vernon Mauerye278ead2018-10-09 09:23:43 -07002381 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002382 }
2383
Jason M. Billsbc996a32019-06-17 15:46:37 -07002384 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002385}
2386
Patrick Williams1318a5e2024-08-16 15:19:54 -04002387ipmi::RspType<> ipmiSetFrontPanelButtonEnables(
2388 ipmi::Context::ptr ctx, bool disablePowerButton, bool disableResetButton,
2389 bool, bool, uint4_t)
Kuiying Wang21addc52019-01-04 10:50:21 +08002390{
2391 using namespace chassis::internal;
2392
2393 // set power button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002394 bool success = setButtonDisabled(ctx, powerButtonPath, powerButtonIntf,
2395 disablePowerButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002396
2397 // set reset button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002398 success &= setButtonDisabled(ctx, resetButtonPath, resetButtonIntf,
2399 disableResetButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002400
2401 if (!success)
2402 {
2403 // not all buttons were successfully set
2404 return ipmi::responseUnspecifiedError();
2405 }
2406 return ipmi::responseSuccess();
2407}
2408
George Liu5087b072025-03-11 19:28:17 +08002409void registerNetFnChassisFunctions()
Adriana Kobylak40814c62015-10-27 15:58:44 -05002410{
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05002411 createIdentifyTimer();
2412
Tom05732372016-09-06 17:21:23 +05302413 // Get Chassis Capabilities
anil kumar appana43263c62019-05-27 12:45:04 +00002414 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2415 ipmi::chassis::cmdGetChassisCapabilities,
2416 ipmi::Privilege::User, ipmiGetChassisCap);
Nan Li8d15fb42016-08-16 22:29:40 +08002417
Kuiying Wang21addc52019-01-04 10:50:21 +08002418 // Set Front Panel Button Enables
2419 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2420 ipmi::chassis::cmdSetFrontPanelButtonEnables,
2421 ipmi::Privilege::Admin,
2422 ipmiSetFrontPanelButtonEnables);
2423
Yong Liae4b0402018-11-02 11:12:14 +08002424 // Set Chassis Capabilities
anil kumar appana894d0222019-05-27 16:32:14 +00002425 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2426 ipmi::chassis::cmdSetChassisCapabilities,
2427 ipmi::Privilege::User, ipmiSetChassisCap);
Yong Liae4b0402018-11-02 11:12:14 +08002428
Tom05732372016-09-06 17:21:23 +05302429 // <Get System Boot Options>
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002430 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2431 ipmi::chassis::cmdGetSystemBootOptions,
2432 ipmi::Privilege::Operator,
2433 ipmiChassisGetSysBootOptions);
Adriana Kobylak40814c62015-10-27 15:58:44 -05002434
Tom05732372016-09-06 17:21:23 +05302435 // <Get Chassis Status>
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07002436 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2437 ipmi::chassis::cmdGetChassisStatus,
2438 ipmi::Privilege::User, ipmiGetChassisStatus);
Nan Lifdd8ec52016-08-28 03:57:40 +08002439
Vijay Khemka074f64d2020-03-03 15:08:43 -08002440 // <Chassis Get System Restart Cause>
2441 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2442 ipmi::chassis::cmdGetSystemRestartCause,
2443 ipmi::Privilege::User, ipmiGetSystemRestartCause);
2444
Tom05732372016-09-06 17:21:23 +05302445 // <Chassis Control>
anil kumar appanadafff5f2019-04-27 18:06:00 +00002446 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2447 ipmi::chassis::cmdChassisControl,
2448 ipmi::Privilege::Operator, ipmiChassisControl);
shgoupfd84fbbf2015-12-17 10:05:51 +08002449
Tom Joseph5110c122018-03-23 17:55:40 +05302450 // <Chassis Identify>
Vernon Mauery400cc782018-10-09 13:49:53 -07002451 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2452 ipmi::chassis::cmdChassisIdentify,
2453 ipmi::Privilege::Operator, ipmiChassisIdentify);
Tom Joseph5110c122018-03-23 17:55:40 +05302454
Tom05732372016-09-06 17:21:23 +05302455 // <Set System Boot Options>
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002456 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2457 ipmi::chassis::cmdSetSystemBootOptions,
2458 ipmi::Privilege::Operator,
2459 ipmiChassisSetSysBootOptions);
2460
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002461 // <Get POH Counter>
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002462 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2463 ipmi::chassis::cmdGetPohCounter,
2464 ipmi::Privilege::User, ipmiGetPOHCounter);
Yong Lic6713cf2018-09-12 12:35:13 +08002465
2466 // <Set Power Restore Policy>
Vernon Mauerye278ead2018-10-09 09:23:43 -07002467 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2468 ipmi::chassis::cmdSetPowerRestorePolicy,
2469 ipmi::Privilege::Operator,
2470 ipmiChassisSetPowerRestorePolicy);
vishwa36993272015-11-20 12:43:49 -06002471}