blob: 2243293df2ddea1953483fb1fea4d382b3932ccc [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>
Alexander Hansende7abb92025-11-14 14:40:50 +010026#include <xyz/openbmc_project/Network/IP/common.hpp>
Jason M. Billsad588bf2020-01-30 16:18:33 -080027#include <xyz/openbmc_project/State/Chassis/server.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070028#include <xyz/openbmc_project/State/Host/server.hpp>
29#include <xyz/openbmc_project/State/PowerOnHours/server.hpp>
30
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050031#include <array>
32#include <chrono>
33#include <cstring>
34#include <filesystem>
35#include <fstream>
36#include <future>
37#include <map>
38#include <sstream>
39#include <string>
40
Patrick Williams95655222023-12-05 12:45:02 -060041std::unique_ptr<sdbusplus::Timer> identifyTimer
Lei YU4b0ddb62019-01-25 16:43:50 +080042 __attribute__((init_priority(101)));
Marri Devender Rao6706c1c2018-05-14 00:29:38 -050043
Yong Lif4e38512019-05-21 14:46:55 +080044static ChassisIDState chassisIDState = ChassisIDState::reserved;
45
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000046constexpr size_t sizeVersion = 2;
Tom Joseph5110c122018-03-23 17:55:40 +053047constexpr size_t DEFAULT_IDENTIFY_TIME_OUT = 15;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +053048
Patrick Venture0b02be92018-08-31 11:55:55 -070049// PetiBoot-Specific
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000050static constexpr uint8_t netConfInitialBytes[] = {0x80, 0x21, 0x70, 0x62,
51 0x21, 0x00, 0x01, 0x06};
52static constexpr uint8_t oemParmStart = 96;
53static constexpr uint8_t oemParmEnd = 127;
Ratan Guptafd28dd72016-08-01 04:58:01 -050054
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000055static constexpr size_t cookieOffset = 1;
56static constexpr size_t versionOffset = 5;
57static constexpr size_t addrSizeOffset = 8;
58static constexpr size_t macOffset = 9;
59static constexpr size_t addrTypeOffset = 16;
60static constexpr size_t ipAddrOffset = 17;
ratagupta6f6bff2016-04-04 06:20:11 -050061
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000062namespace ipmi
63{
64constexpr Cc ccParmNotSupported = 0x80;
George Liuf5dd1022025-07-07 09:13:07 +080065constexpr Cc ccFailSetInProgress = 0x81;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000066
67static inline auto responseParmNotSupported()
68{
69 return response(ccParmNotSupported);
70}
George Liuf5dd1022025-07-07 09:13:07 +080071
72static inline auto responsefailSetInProgress()
73{
74 return response(ccFailSetInProgress);
75}
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000076} // namespace ipmi
77
George Liu5087b072025-03-11 19:28:17 +080078void registerNetFnChassisFunctions() __attribute__((constructor));
Adriana Kobylak40814c62015-10-27 15:58:44 -050079
shgoupfd84fbbf2015-12-17 10:05:51 +080080// Host settings in dbus
81// Service name should be referenced by connection name got via object mapper
Patrick Venture0b02be92018-08-31 11:55:55 -070082const char* settings_object_name = "/org/openbmc/settings/host0";
83const char* settings_intf_name = "org.freedesktop.DBus.Properties";
Patrick Venture0b02be92018-08-31 11:55:55 -070084const char* identify_led_object_name =
Tom Joseph5110c122018-03-23 17:55:40 +053085 "/xyz/openbmc_project/led/groups/enclosure_identify";
shgoupfd84fbbf2015-12-17 10:05:51 +080086
Ratan Guptadcb10672017-07-10 10:33:50 +053087constexpr auto SETTINGS_ROOT = "/";
88constexpr auto SETTINGS_MATCH = "host0";
Ratan Guptadcb10672017-07-10 10:33:50 +053089
Ratan Guptadcb10672017-07-10 10:33:50 +053090constexpr 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;
Alexander Hansen2260ff32025-11-07 17:12:52 +0100129using ChassisState = sdbusplus::common::xyz::openbmc_project::state::Chassis;
Alexander Hansende7abb92025-11-14 14:40:50 +0100130using NetworkIP = sdbusplus::common::xyz::openbmc_project::network::IP;
William A. Kennington III4c008022018-10-12 17:18:14 -0700131
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500132namespace chassis
133{
134namespace internal
135{
136
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300137constexpr auto bootSettingsPath = "/xyz/openbmc_project/control/host0/boot";
138constexpr auto bootEnableIntf = "xyz.openbmc_project.Object.Enable";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500139constexpr auto bootModeIntf = "xyz.openbmc_project.Control.Boot.Mode";
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300140constexpr auto bootTypeIntf = "xyz.openbmc_project.Control.Boot.Type";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500141constexpr auto bootSourceIntf = "xyz.openbmc_project.Control.Boot.Source";
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300142constexpr auto bootSettingsOneTimePath =
143 "/xyz/openbmc_project/control/host0/boot/one_time";
144constexpr auto bootOneTimeIntf = "xyz.openbmc_project.Object.Enable";
145
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500146constexpr auto powerRestoreIntf =
147 "xyz.openbmc_project.Control.Power.RestorePolicy";
Patrick Williams5d82f472022-07-22 19:26:53 -0500148sdbusplus::bus_t dbus(ipmid_get_sd_bus_connection());
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500149
150namespace cache
151{
152
James Feist225dec82019-11-26 16:25:06 -0800153std::unique_ptr<settings::Objects> objectsPtr = nullptr;
154
155settings::Objects& getObjects()
156{
157 if (objectsPtr == nullptr)
158 {
159 objectsPtr = std::make_unique<settings::Objects>(
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300160 dbus, std::vector<std::string>{bootModeIntf, bootTypeIntf,
161 bootSourceIntf, powerRestoreIntf});
James Feist225dec82019-11-26 16:25:06 -0800162 }
163 return *objectsPtr;
164}
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500165
166} // namespace cache
167} // namespace internal
168} // namespace chassis
169
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500170namespace poh
171{
172
173constexpr auto minutesPerCount = 60;
174
175} // namespace poh
176
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000177int getHostNetworkData(ipmi::message::Payload& payload)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500178{
Ratan Guptadcb10672017-07-10 10:33:50 +0530179 ipmi::PropertyMap properties;
180 int rc = 0;
Ratan Gupta8c31d232017-08-13 05:49:43 +0530181 uint8_t addrSize = ipmi::network::IPV4_ADDRESS_SIZE_BYTE;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500182
Ratan Guptadcb10672017-07-10 10:33:50 +0530183 try
184 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700185 // TODO There may be cases where an interface is implemented by multiple
Ratan Guptadcb10672017-07-10 10:33:50 +0530186 // objects,to handle such cases we are interested on that object
187 // which are on interested busname.
188 // Currenlty mapper doesn't give the readable busname(gives busid)
189 // so we can't match with bus name so giving some object specific info
190 // as SETTINGS_MATCH.
191 // Later SETTINGS_MATCH will be replaced with busname.
Ratan Guptafd28dd72016-08-01 04:58:01 -0500192
Patrick Williams5d82f472022-07-22 19:26:53 -0500193 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Guptadcb10672017-07-10 10:33:50 +0530194
Alexander Hansende7abb92025-11-14 14:40:50 +0100195 auto ipObjectInfo = ipmi::getDbusObject(bus, NetworkIP::interface,
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530196 SETTINGS_ROOT, SETTINGS_MATCH);
197
198 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
199 SETTINGS_ROOT, SETTINGS_MATCH);
200
Patrick Venture0b02be92018-08-31 11:55:55 -0700201 properties = ipmi::getAllDbusProperties(
Alexander Hansende7abb92025-11-14 14:40:50 +0100202 bus, ipObjectInfo.second, ipObjectInfo.first, NetworkIP::interface);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400203 auto variant = ipmi::getDbusProperty(
204 bus, macObjectInfo.second, macObjectInfo.first, MAC_INTERFACE,
205 "MACAddress");
Ratan Guptadcb10672017-07-10 10:33:50 +0530206
Alexander Hansende7abb92025-11-14 14:40:50 +0100207 auto ipAddress = std::get<std::string>(
208 properties[NetworkIP::property_names::address]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530209
Alexander Hansende7abb92025-11-14 14:40:50 +0100210 auto gateway = std::get<std::string>(
211 properties[NetworkIP::property_names::gateway]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530212
Alexander Hansende7abb92025-11-14 14:40:50 +0100213 auto prefix = std::get<uint8_t>(
214 properties[NetworkIP::property_names::prefix_length]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530215
Patrick Venture0b02be92018-08-31 11:55:55 -0700216 uint8_t isStatic =
Alexander Hansende7abb92025-11-14 14:40:50 +0100217 (std::get<std::string>(
218 properties[NetworkIP::property_names::origin]) ==
Patrick Venture0b02be92018-08-31 11:55:55 -0700219 "xyz.openbmc_project.Network.IP.AddressOrigin.Static")
220 ? 1
221 : 0;
Ratan Guptad70f4532017-08-04 02:07:31 +0530222
Vernon Maueryf442e112019-04-09 11:44:36 -0700223 auto MACAddress = std::get<std::string>(variant);
Ratan Guptacc8feb42017-07-25 21:52:10 +0530224
Ratan Guptad70f4532017-08-04 02:07:31 +0530225 // it is expected here that we should get the valid data
226 // but we may also get the default values.
227 // Validation of the data is done by settings.
228 //
229 // if mac address is default mac address then
230 // don't send blank override.
Ratan Gupta8c31d232017-08-13 05:49:43 +0530231 if ((MACAddress == ipmi::network::DEFAULT_MAC_ADDRESS))
Ratan Guptad70f4532017-08-04 02:07:31 +0530232 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530233 rc = -1;
234 return rc;
235 }
236 // if addr is static then ipaddress,gateway,prefix
237 // should not be default one,don't send blank override.
238 if (isStatic)
239 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700240 if ((ipAddress == ipmi::network::DEFAULT_ADDRESS) ||
241 (gateway == ipmi::network::DEFAULT_ADDRESS) || (!prefix))
Ratan Guptad70f4532017-08-04 02:07:31 +0530242 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530243 rc = -1;
244 return rc;
245 }
246 }
247
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000248 std::string token;
249 std::stringstream ss(MACAddress);
Ratan Guptadcb10672017-07-10 10:33:50 +0530250
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000251 // First pack macOffset no of bytes in payload.
252 // Latter this PetiBoot-Specific data will be populated.
253 std::vector<uint8_t> payloadInitialBytes(macOffset);
254 payload.pack(payloadInitialBytes);
Ratan Guptadcb10672017-07-10 10:33:50 +0530255
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000256 while (std::getline(ss, token, ':'))
257 {
258 payload.pack(stoi(token, nullptr, 16));
259 }
260
261 payload.pack(0x00);
262
263 payload.pack(isStatic);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530264
Alexander Hansende7abb92025-11-14 14:40:50 +0100265 uint8_t addressFamily =
266 (std::get<std::string>(
267 properties[NetworkIP::property_names::type]) ==
268 "xyz.openbmc_project.Network.IP.Protocol.IPv4")
269 ? AF_INET
270 : AF_INET6;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530271
Patrick Venture0b02be92018-08-31 11:55:55 -0700272 addrSize = (addressFamily == AF_INET)
273 ? ipmi::network::IPV4_ADDRESS_SIZE_BYTE
274 : ipmi::network::IPV6_ADDRESS_SIZE_BYTE;
Ratan Guptadcb10672017-07-10 10:33:50 +0530275
276 // ipaddress and gateway would be in IPv4 format
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000277 std::vector<uint8_t> addrInBinary(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530278 inet_pton(addressFamily, ipAddress.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000279 reinterpret_cast<void*>(addrInBinary.data()));
Ratan Guptadcb10672017-07-10 10:33:50 +0530280
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000281 payload.pack(addrInBinary);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530282
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000283 payload.pack(prefix);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530284
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000285 std::vector<uint8_t> gatewayDetails(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530286 inet_pton(addressFamily, gateway.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000287 reinterpret_cast<void*>(gatewayDetails.data()));
288 payload.pack(gatewayDetails);
Ratan Guptadcb10672017-07-10 10:33:50 +0530289 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500290 catch (const InternalFailure& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530291 {
292 commit<InternalFailure>();
Ratan Guptadcb10672017-07-10 10:33:50 +0530293 rc = -1;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500294 return rc;
295 }
296
Patrick Venture0b02be92018-08-31 11:55:55 -0700297 // PetiBoot-Specific
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000298 // If success then copy the first 9 bytes to the payload message
299 // payload first 2 bytes contain the parameter values. Skip that 2 bytes.
300 uint8_t skipFirstTwoBytes = 2;
301 size_t payloadSize = payload.size();
302 uint8_t* configDataStartingAddress = payload.data() + skipFirstTwoBytes;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500303
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000304 if (payloadSize < skipFirstTwoBytes + sizeof(netConfInitialBytes))
305 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700306 lg2::error("Invalid net config");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000307 rc = -1;
308 return rc;
309 }
310 std::copy(netConfInitialBytes,
311 netConfInitialBytes + sizeof(netConfInitialBytes),
312 configDataStartingAddress);
313
314 if (payloadSize < skipFirstTwoBytes + addrSizeOffset + sizeof(addrSize))
315 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700316 lg2::error("Invalid length of address size");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000317 rc = -1;
318 return rc;
319 }
320 std::copy(&addrSize, &(addrSize) + sizeof(addrSize),
321 configDataStartingAddress + addrSizeOffset);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530322
Ratan Guptafd28dd72016-08-01 04:58:01 -0500323#ifdef _IPMI_DEBUG_
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700324 std::printf("\n===Printing the IPMI Formatted Data========\n");
Ratan Guptafd28dd72016-08-01 04:58:01 -0500325
Ratan Guptadcb10672017-07-10 10:33:50 +0530326 for (uint8_t pos = 0; pos < index; pos++)
327 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000328 std::printf("%02x ", payloadStartingAddress[pos]);
Ratan Guptadcb10672017-07-10 10:33:50 +0530329 }
Ratan Guptafd28dd72016-08-01 04:58:01 -0500330#endif
331
Ratan Guptafd28dd72016-08-01 04:58:01 -0500332 return rc;
333}
334
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530335/** @brief convert IPv4 and IPv6 addresses from binary to text form.
336 * @param[in] family - IPv4/Ipv6
337 * @param[in] data - req data pointer.
338 * @param[in] offset - offset in the data.
339 * @param[in] addrSize - size of the data which needs to be read from offset.
340 * @returns address in text form.
341 */
342
Patrick Venture0b02be92018-08-31 11:55:55 -0700343std::string getAddrStr(uint8_t family, uint8_t* data, uint8_t offset,
344 uint8_t addrSize)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530345{
346 char ipAddr[INET6_ADDRSTRLEN] = {};
347
Patrick Venture0b02be92018-08-31 11:55:55 -0700348 switch (family)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530349 {
350 case AF_INET:
351 {
Patrick Williams99db6882024-12-18 11:20:17 -0500352 struct sockaddr_in addr4{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700353 std::memcpy(&addr4.sin_addr.s_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530354
Patrick Venture0b02be92018-08-31 11:55:55 -0700355 inet_ntop(AF_INET, &addr4.sin_addr, ipAddr, INET_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530356
357 break;
358 }
359 case AF_INET6:
360 {
Patrick Williams99db6882024-12-18 11:20:17 -0500361 struct sockaddr_in6 addr6{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700362 std::memcpy(&addr6.sin6_addr.s6_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530363
Patrick Venture0b02be92018-08-31 11:55:55 -0700364 inet_ntop(AF_INET6, &addr6.sin6_addr, ipAddr, INET6_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530365
366 break;
367 }
368 default:
369 {
370 return {};
371 }
372 }
373
374 return ipAddr;
375}
376
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000377ipmi::Cc setHostNetworkData(ipmi::message::Payload& data)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500378{
Ratan Guptadcb10672017-07-10 10:33:50 +0530379 using namespace std::string_literals;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000380 std::string hostNetworkConfig;
381 std::string mac("00:00:00:00:00:00");
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530382 std::string ipAddress, gateway;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000383 std::string addrOrigin{0};
Patrick Venture0b02be92018-08-31 11:55:55 -0700384 uint8_t addrSize{0};
Ratan Guptadcb10672017-07-10 10:33:50 +0530385 std::string addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530386 "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP";
Patrick Venture0b02be92018-08-31 11:55:55 -0700387 std::string addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv4";
388 uint8_t prefix{0};
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530389 uint8_t family = AF_INET;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500390
Patrick Venture0b02be92018-08-31 11:55:55 -0700391 // cookie starts from second byte
Ratan Guptafd28dd72016-08-01 04:58:01 -0500392 // version starts from sixth byte
393
Ratan Guptadcb10672017-07-10 10:33:50 +0530394 try
Ratan Guptafd28dd72016-08-01 04:58:01 -0500395 {
Ratan Guptadcb10672017-07-10 10:33:50 +0530396 do
397 {
398 // cookie == 0x21 0x70 0x62 0x21
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000399 data.trailingOk = true;
400 auto msgLen = data.size();
401 std::vector<uint8_t> msgPayloadBytes(msgLen);
402 if (data.unpack(msgPayloadBytes) != 0 || !data.fullyUnpacked())
Ratan Guptadcb10672017-07-10 10:33:50 +0530403 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700404 lg2::error("Error in unpacking message of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000405 return ipmi::ccReqDataLenInvalid;
406 }
407
408 uint8_t* msgPayloadStartingPos = msgPayloadBytes.data();
409 constexpr size_t cookieSize = 4;
410 if (msgLen < cookieOffset + cookieSize)
411 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700412 lg2::error("Error in cookie getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000413 return ipmi::ccReqDataLenInvalid;
414 }
415 if (std::equal(msgPayloadStartingPos + cookieOffset,
416 msgPayloadStartingPos + cookieOffset + cookieSize,
417 (netConfInitialBytes + cookieOffset)) != 0)
418 {
419 // all cookie == 0
420 if (std::all_of(msgPayloadStartingPos + cookieOffset,
421 msgPayloadStartingPos + cookieOffset +
422 cookieSize,
423 [](int i) { return i == 0; }) == true)
Ratan Guptadcb10672017-07-10 10:33:50 +0530424 {
425 // need to zero out the network settings.
426 break;
427 }
428
Vernon Mauery38108d92024-03-11 12:53:55 -0700429 lg2::error("Invalid Cookie");
Ratan Guptadcb10672017-07-10 10:33:50 +0530430 elog<InternalFailure>();
431 }
432
433 // vesion == 0x00 0x01
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000434 if (msgLen < versionOffset + sizeVersion)
Ratan Guptadcb10672017-07-10 10:33:50 +0530435 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700436 lg2::error("Error in version getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000437 return ipmi::ccReqDataLenInvalid;
438 }
439 if (std::equal(msgPayloadStartingPos + versionOffset,
440 msgPayloadStartingPos + versionOffset + sizeVersion,
441 (netConfInitialBytes + versionOffset)) != 0)
442 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700443 lg2::error("Invalid Version");
Ratan Guptadcb10672017-07-10 10:33:50 +0530444 elog<InternalFailure>();
445 }
446
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000447 if (msgLen < macOffset + 6)
448 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700449 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000450 "Error in mac address getting of setHostNetworkData");
451 return ipmi::ccReqDataLenInvalid;
452 }
453 std::stringstream result;
454 std::copy((msgPayloadStartingPos + macOffset),
455 (msgPayloadStartingPos + macOffset + 5),
456 std::ostream_iterator<int>(result, ":"));
457 mac = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530458
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000459 if (msgLen < addrTypeOffset + sizeof(decltype(addrOrigin)))
460 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700461 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000462 "Error in original address getting of setHostNetworkData");
463 return ipmi::ccReqDataLenInvalid;
464 }
465 std::copy(msgPayloadStartingPos + addrTypeOffset,
466 msgPayloadStartingPos + addrTypeOffset +
467 sizeof(decltype(addrOrigin)),
468 std::ostream_iterator<int>(result, ""));
469 addrOrigin = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530470
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000471 if (!addrOrigin.empty())
Ratan Guptadcb10672017-07-10 10:33:50 +0530472 {
473 addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530474 "xyz.openbmc_project.Network.IP.AddressOrigin.Static";
Ratan Guptadcb10672017-07-10 10:33:50 +0530475 }
476
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000477 if (msgLen < addrSizeOffset + sizeof(decltype(addrSize)))
478 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700479 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000480 "Error in address size getting of setHostNetworkData");
481 return ipmi::ccReqDataLenInvalid;
482 }
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530483 // Get the address size
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000484 std::copy(msgPayloadStartingPos + addrSizeOffset,
485 (msgPayloadStartingPos + addrSizeOffset +
486 sizeof(decltype(addrSize))),
487 &addrSize);
Ratan Guptadcb10672017-07-10 10:33:50 +0530488
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000489 uint8_t prefixOffset = ipAddrOffset + addrSize;
490 if (msgLen < prefixOffset + sizeof(decltype(prefix)))
491 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700492 lg2::error("Error in prefix getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000493 return ipmi::ccReqDataLenInvalid;
494 }
William A. Kennington III4c521022023-07-28 13:07:30 -0700495 // std::copy(msgPayloadStartingPos + prefixOffset,
496 // msgPayloadStartingPos + prefixOffset +
497 // sizeof(decltype(prefix)),
498 // &prefix);
499 // Workaround compiler misdetecting out of bounds memcpy
500 prefix = msgPayloadStartingPos[prefixOffset];
Ratan Guptadcb10672017-07-10 10:33:50 +0530501
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530502 uint8_t gatewayOffset = prefixOffset + sizeof(decltype(prefix));
Ratan Gupta8c31d232017-08-13 05:49:43 +0530503 if (addrSize != ipmi::network::IPV4_ADDRESS_SIZE_BYTE)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530504 {
505 addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv6";
506 family = AF_INET6;
507 }
508
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000509 if (msgLen < ipAddrOffset + addrSize)
510 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700511 lg2::error("Error in IP address getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000512 return ipmi::ccReqDataLenInvalid;
513 }
514 ipAddress = getAddrStr(family, msgPayloadStartingPos, ipAddrOffset,
515 addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530516
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000517 if (msgLen < gatewayOffset + addrSize)
518 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700519 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000520 "Error in gateway address getting of setHostNetworkData");
521 return ipmi::ccReqDataLenInvalid;
522 }
523 gateway = getAddrStr(family, msgPayloadStartingPos, gatewayOffset,
524 addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530525
Patrick Venture0b02be92018-08-31 11:55:55 -0700526 } while (0);
Ratan Guptadcb10672017-07-10 10:33:50 +0530527
Patrick Venture0b02be92018-08-31 11:55:55 -0700528 // Cookie == 0 or it is a valid cookie
Patrick Williams1318a5e2024-08-16 15:19:54 -0400529 hostNetworkConfig +=
530 "ipaddress="s + ipAddress + ",prefix="s + std::to_string(prefix) +
531 ",gateway="s + gateway + ",mac="s + mac + ",addressOrigin="s +
532 addressOrigin;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500533
Patrick Williams5d82f472022-07-22 19:26:53 -0500534 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530535
Alexander Hansende7abb92025-11-14 14:40:50 +0100536 auto ipObjectInfo = ipmi::getDbusObject(bus, NetworkIP::interface,
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530537 SETTINGS_ROOT, SETTINGS_MATCH);
538 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
539 SETTINGS_ROOT, SETTINGS_MATCH);
Ratan Guptadcb10672017-07-10 10:33:50 +0530540 // set the dbus property
Patrick Venture0b02be92018-08-31 11:55:55 -0700541 ipmi::setDbusProperty(
Alexander Hansende7abb92025-11-14 14:40:50 +0100542 bus, ipObjectInfo.second, ipObjectInfo.first, NetworkIP::interface,
543 NetworkIP::property_names::address, std::string(ipAddress));
544 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
545 NetworkIP::interface,
546 NetworkIP::property_names::prefix_length, prefix);
547 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
548 NetworkIP::interface,
549 NetworkIP::property_names::origin, addressOrigin);
550 ipmi::setDbusProperty(
551 bus, ipObjectInfo.second, ipObjectInfo.first, NetworkIP::interface,
552 NetworkIP::property_names::gateway, std::string(gateway));
553 ipmi::setDbusProperty(
554 bus, ipObjectInfo.second, ipObjectInfo.first, NetworkIP::interface,
555 NetworkIP::property_names::type,
Patrick Venture0b02be92018-08-31 11:55:55 -0700556 std::string("xyz.openbmc_project.Network.IP.Protocol.IPv4"));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530557 ipmi::setDbusProperty(bus, macObjectInfo.second, macObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700558 MAC_INTERFACE, "MACAddress", std::string(mac));
Ratan Guptafd28dd72016-08-01 04:58:01 -0500559
Vernon Mauery38108d92024-03-11 12:53:55 -0700560 lg2::debug("Network configuration changed: {NETWORKCONFIG}",
561 "NETWORKCONFIG", hostNetworkConfig);
Ratan Guptafd28dd72016-08-01 04:58:01 -0500562 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500563 catch (const sdbusplus::exception_t& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530564 {
565 commit<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -0700566 lg2::error("Error in ipmiChassisSetSysBootOptions call");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000567 return ipmi::ccUnspecifiedError;
Ratan Guptadcb10672017-07-10 10:33:50 +0530568 }
569
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000570 return ipmi::ccSuccess;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500571}
572
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500573uint32_t getPOHCounter()
574{
Patrick Williams5d82f472022-07-22 19:26:53 -0500575 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500576
Patrick Williams1318a5e2024-08-16 15:19:54 -0400577 auto chassisStateObj =
578 ipmi::getDbusObject(bus, chassisPOHStateIntf, chassisStateRoot, match);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500579
Patrick Williams1318a5e2024-08-16 15:19:54 -0400580 auto service =
581 ipmi::getService(bus, chassisPOHStateIntf, chassisStateObj.first);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500582
Patrick Williams1318a5e2024-08-16 15:19:54 -0400583 auto propValue =
584 ipmi::getDbusProperty(bus, service, chassisStateObj.first,
585 chassisPOHStateIntf, pohCounterProperty);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500586
Vernon Maueryf442e112019-04-09 11:44:36 -0700587 return std::get<uint32_t>(propValue);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500588}
589
anil kumar appana43263c62019-05-27 12:45:04 +0000590/** @brief Implements the get chassis capabilities command
591 *
592 * @returns IPMI completion code plus response data
593 * chassisCapFlags - chassis capability flag
594 * chassisFRUInfoDevAddr - chassis FRU info Device Address
595 * chassisSDRDevAddr - chassis SDR device address
596 * chassisSELDevAddr - chassis SEL device address
597 * chassisSMDevAddr - chassis system management device address
598 * chassisBridgeDevAddr - chassis bridge device address
599 */
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800600ipmi::RspType<bool, // chassis intrusion sensor
601 bool, // chassis Front panel lockout
602 bool, // chassis NMI
603 bool, // chassis power interlock
604 uint4_t, // reserved
anil kumar appana43263c62019-05-27 12:45:04 +0000605 uint8_t, // chassis FRU info Device Address
606 uint8_t, // chassis SDR device address
607 uint8_t, // chassis SEL device address
608 uint8_t, // chassis system management device address
609 uint8_t // chassis bridge device address
610 >
611 ipmiGetChassisCap()
Nan Li8d15fb42016-08-16 22:29:40 +0800612{
anil kumar appana43263c62019-05-27 12:45:04 +0000613 ipmi::PropertyMap properties;
Yong Liae4b0402018-11-02 11:12:14 +0800614 try
615 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500616 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nan Li8d15fb42016-08-16 22:29:40 +0800617
Yong Liae4b0402018-11-02 11:12:14 +0800618 ipmi::DbusObjectInfo chassisCapObject =
619 ipmi::getDbusObject(bus, chassisCapIntf);
Nan Li8d15fb42016-08-16 22:29:40 +0800620
Yong Liae4b0402018-11-02 11:12:14 +0800621 // capabilities flags
622 // [7..4] - reserved
623 // [3] – 1b = provides power interlock (IPM 1.5)
624 // [2] – 1b = provides Diagnostic Interrupt (FP NMI)
625 // [1] – 1b = provides “Front Panel Lockout” (indicates that the chassis
626 // has capabilities
627 // to lock out external power control and reset button or
628 // front panel interfaces and/or detect tampering with those
629 // interfaces).
630 // [0] -1b = Chassis provides intrusion (physical security) sensor.
631 // set to default value 0x0.
Nan Li8d15fb42016-08-16 22:29:40 +0800632
Patrick Williams1318a5e2024-08-16 15:19:54 -0400633 properties =
634 ipmi::getAllDbusProperties(bus, chassisCapObject.second,
635 chassisCapObject.first, chassisCapIntf);
Yong Liae4b0402018-11-02 11:12:14 +0800636 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500637 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800638 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700639 lg2::error("Failed to fetch Chassis Capability properties: {ERROR}",
640 "ERROR", e);
anil kumar appana43263c62019-05-27 12:45:04 +0000641 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800642 }
643
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800644 bool* chassisIntrusionFlag =
645 std::get_if<bool>(&properties[chassisIntrusionProp]);
646 if (chassisIntrusionFlag == nullptr)
anil kumar appana43263c62019-05-27 12:45:04 +0000647 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700648 lg2::error("Error to get chassis Intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800649 return ipmi::responseUnspecifiedError();
650 }
651 bool* chassisFrontPanelFlag =
652 std::get_if<bool>(&properties[chassisFrontPanelLockoutProp]);
653 if (chassisFrontPanelFlag == nullptr)
654 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700655 lg2::error("Error to get chassis intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800656 return ipmi::responseUnspecifiedError();
657 }
658 bool* chassisNMIFlag = std::get_if<bool>(&properties[chassisNMIProp]);
659 if (chassisNMIFlag == nullptr)
660 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700661 lg2::error("Error to get chassis NMI flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800662 return ipmi::responseUnspecifiedError();
663 }
664 bool* chassisPowerInterlockFlag =
665 std::get_if<bool>(&properties[chassisPowerInterlockProp]);
666 if (chassisPowerInterlockFlag == nullptr)
667 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700668 lg2::error("Error to get chassis power interlock flags");
anil kumar appana43263c62019-05-27 12:45:04 +0000669 return ipmi::responseUnspecifiedError();
670 }
671 uint8_t* chassisFRUInfoDevAddr =
672 std::get_if<uint8_t>(&properties[chassisFRUDevAddrProp]);
673 if (chassisFRUInfoDevAddr == nullptr)
674 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700675 lg2::error("Error to get chassis FRU info device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000676 return ipmi::responseUnspecifiedError();
677 }
678 uint8_t* chassisSDRDevAddr =
679 std::get_if<uint8_t>(&properties[chassisSDRDevAddrProp]);
680 if (chassisSDRDevAddr == nullptr)
681 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700682 lg2::error("Error to get chassis SDR device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000683 return ipmi::responseUnspecifiedError();
684 }
685 uint8_t* chassisSELDevAddr =
686 std::get_if<uint8_t>(&properties[chassisSELDevAddrProp]);
687 if (chassisSELDevAddr == nullptr)
688 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700689 lg2::error("Error to get chassis SEL device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000690 return ipmi::responseUnspecifiedError();
691 }
692 uint8_t* chassisSMDevAddr =
693 std::get_if<uint8_t>(&properties[chassisSMDevAddrProp]);
694 if (chassisSMDevAddr == nullptr)
695 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700696 lg2::error("Error to get chassis SM device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000697 return ipmi::responseUnspecifiedError();
698 }
699 uint8_t* chassisBridgeDevAddr =
700 std::get_if<uint8_t>(&properties[chassisBridgeDevAddrProp]);
701 if (chassisBridgeDevAddr == nullptr)
702 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700703 lg2::error("Error to get chassis bridge device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000704 return ipmi::responseUnspecifiedError();
705 }
706
Patrick Williams1318a5e2024-08-16 15:19:54 -0400707 return ipmi::responseSuccess(
708 *chassisIntrusionFlag, *chassisFrontPanelFlag, *chassisNMIFlag,
709 *chassisPowerInterlockFlag, 0, *chassisFRUInfoDevAddr,
710 *chassisSDRDevAddr, *chassisSELDevAddr, *chassisSMDevAddr,
711 *chassisBridgeDevAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800712}
713
anil kumar appana894d0222019-05-27 16:32:14 +0000714/** @brief implements set chassis capalibities command
715 * @param intrusion - chassis intrusion
716 * @param fpLockout - frontpannel lockout
717 * @param reserved1 - skip one bit
718 * @param fruDeviceAddr - chassis FRU info Device Address
719 * @param sdrDeviceAddr - chassis SDR device address
720 * @param selDeviceAddr - chassis SEL device address
721 * @param smDeviceAddr - chassis system management device address
722 * @param bridgeDeviceAddr - chassis bridge device address
723 *
724 * @returns IPMI completion code
725 */
Patrick Williams1318a5e2024-08-16 15:19:54 -0400726ipmi::RspType<> ipmiSetChassisCap(
727 bool intrusion, bool fpLockout, uint6_t reserved1,
anil kumar appana894d0222019-05-27 16:32:14 +0000728
Patrick Williams1318a5e2024-08-16 15:19:54 -0400729 uint8_t fruDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000730
Patrick Williams1318a5e2024-08-16 15:19:54 -0400731 uint8_t sdrDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000732
Patrick Williams1318a5e2024-08-16 15:19:54 -0400733 uint8_t selDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000734
Patrick Williams1318a5e2024-08-16 15:19:54 -0400735 uint8_t smDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000736
NikhilaDande530239b2025-09-30 09:09:40 +0530737 std::optional<uint8_t> bridgeDeviceAddr)
Yong Liae4b0402018-11-02 11:12:14 +0800738{
Yong Liae4b0402018-11-02 11:12:14 +0800739 // check input data
anil kumar appana894d0222019-05-27 16:32:14 +0000740 if (reserved1 != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800741 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700742 lg2::error("Unsupported request parameter");
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 ((fruDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800747 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700748 lg2::error("Unsupported request parameter(FRU Addr) for REQ={REQ}",
749 "REQ", lg2::hex, fruDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000750 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800751 }
anil kumar appana894d0222019-05-27 16:32:14 +0000752 if ((sdrDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800753 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700754 lg2::error("Unsupported request parameter(SDR Addr) for REQ={REQ}",
755 "REQ", lg2::hex, sdrDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000756 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800757 }
758
anil kumar appana894d0222019-05-27 16:32:14 +0000759 if ((selDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800760 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700761 lg2::error("Unsupported request parameter(SEL Addr) for REQ={REQ}",
762 "REQ", lg2::hex, selDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000763 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800764 }
765
anil kumar appana894d0222019-05-27 16:32:14 +0000766 if ((smDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800767 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700768 lg2::error("Unsupported request parameter(SM Addr) for REQ={REQ}",
769 "REQ", lg2::hex, smDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000770 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800771 }
772
NikhilaDande530239b2025-09-30 09:09:40 +0530773 if (bridgeDeviceAddr.has_value())
Yong Liae4b0402018-11-02 11:12:14 +0800774 {
NikhilaDande530239b2025-09-30 09:09:40 +0530775 if ((bridgeDeviceAddr.value() & ~chassisCapAddrMask) != 0)
776 {
777 lg2::error(
778 "Unsupported request parameter(Bridge Addr) for REQ={REQ}",
779 "REQ", lg2::hex, bridgeDeviceAddr.value());
780 return ipmi::responseInvalidFieldRequest();
781 }
Yong Liae4b0402018-11-02 11:12:14 +0800782 }
783
784 try
785 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500786 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Yong Liae4b0402018-11-02 11:12:14 +0800787 ipmi::DbusObjectInfo chassisCapObject =
788 ipmi::getDbusObject(bus, chassisCapIntf);
789
790 ipmi::setDbusProperty(bus, chassisCapObject.second,
791 chassisCapObject.first, chassisCapIntf,
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800792 chassisIntrusionProp, intrusion);
793
794 ipmi::setDbusProperty(bus, chassisCapObject.second,
795 chassisCapObject.first, chassisCapIntf,
796 chassisFrontPanelLockoutProp, fpLockout);
Yong Liae4b0402018-11-02 11:12:14 +0800797
798 ipmi::setDbusProperty(bus, chassisCapObject.second,
799 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000800 chassisFRUDevAddrProp, fruDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800801
802 ipmi::setDbusProperty(bus, chassisCapObject.second,
803 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000804 chassisSDRDevAddrProp, sdrDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800805
806 ipmi::setDbusProperty(bus, chassisCapObject.second,
807 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000808 chassisSELDevAddrProp, selDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800809
810 ipmi::setDbusProperty(bus, chassisCapObject.second,
811 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000812 chassisSMDevAddrProp, smDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800813
NikhilaDande530239b2025-09-30 09:09:40 +0530814 if (bridgeDeviceAddr.has_value())
815 {
816 ipmi::setDbusProperty(bus, chassisCapObject.second,
817 chassisCapObject.first, chassisCapIntf,
818 chassisBridgeDevAddrProp,
819 bridgeDeviceAddr.value());
820 }
Yong Liae4b0402018-11-02 11:12:14 +0800821 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500822 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800823 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700824 lg2::error("Failed to set chassis capability properties: {ERR}", "ERR",
825 e);
anil kumar appana894d0222019-05-27 16:32:14 +0000826 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800827 }
anil kumar appana894d0222019-05-27 16:32:14 +0000828 return ipmi::responseSuccess();
Nan Li8d15fb42016-08-16 22:29:40 +0800829}
830
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530831//------------------------------------------
832// Calls into Host State Manager Dbus object
833//------------------------------------------
Jason M. Bills664e1c32020-01-30 16:02:39 -0800834int initiateHostStateTransition(ipmi::Context::ptr& ctx,
835 State::Host::Transition transition)
vishwa36993272015-11-20 12:43:49 -0600836{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500837 // OpenBMC Host State Manager dbus framework
Alexander Hansen76bfd752025-11-07 17:04:32 +0100838 const auto hostStatePath =
839 std::format("{}/{}", HostState::namespace_path::value, "host0");
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530840
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500841 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700842 auto request =
843 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
844 transition);
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530845
Jason M. Bills664e1c32020-01-30 16:02:39 -0800846 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400847 boost::system::error_code ec =
Alexander Hansen76bfd752025-11-07 17:04:32 +0100848 ipmi::getService(ctx, HostState::interface, hostStatePath, service);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800849
850 if (!ec)
851 {
Alexander Hansen76bfd752025-11-07 17:04:32 +0100852 ec = ipmi::setDbusProperty(
853 ctx, service, hostStatePath, HostState::interface,
854 HostState::property_names::requested_host_transition, request);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800855 }
856 if (ec)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500857 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700858 lg2::error(
859 "Failed to initiate transition for request {REQUEST}: {EXCEPTION}",
860 "REQUEST", request, "EXCEPTION", ec.message());
Jason M. Bills664e1c32020-01-30 16:02:39 -0800861 return -1;
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500862 }
Vernon Mauery38108d92024-03-11 12:53:55 -0700863 lg2::info(
864 "Transition request {REQUEST} initiated successfully by user {USERID}",
865 "REQUEST", request, "USERID", ctx->userId);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800866 return 0;
vishwa36993272015-11-20 12:43:49 -0600867}
868
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800869//------------------------------------------
Jason M. Billsad588bf2020-01-30 16:18:33 -0800870// Calls into Chassis State Manager Dbus object
871//------------------------------------------
872int initiateChassisStateTransition(ipmi::Context::ptr& ctx,
873 State::Chassis::Transition transition)
874{
875 // OpenBMC Chassis State Manager dbus framework
876 constexpr auto chassisStatePath = "/xyz/openbmc_project/state/chassis0";
Jason M. Billsad588bf2020-01-30 16:18:33 -0800877
878 std::string service;
Alexander Hansen2260ff32025-11-07 17:12:52 +0100879 boost::system::error_code ec = ipmi::getService(
880 ctx, ChassisState::interface, chassisStatePath, service);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800881
882 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700883 auto request =
884 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
885 transition);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800886
887 if (!ec)
888 {
Alexander Hansen2260ff32025-11-07 17:12:52 +0100889 ec = ipmi::setDbusProperty(
890 ctx, service, chassisStatePath, ChassisState::interface,
891 ChassisState::property_names::requested_power_transition, request);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800892 }
893 if (ec)
894 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700895 lg2::error("Failed to initiate transition {REQUEST}: {EXCEPTION}",
896 "REQUEST", request, "EXCEPTION", ec.message());
897
Jason M. Billsad588bf2020-01-30 16:18:33 -0800898 return -1;
899 }
900
901 return 0;
902}
903
904//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000905// Trigger an NMI on the host via dbus
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800906//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000907static int doNmi(ipmi::Context::ptr& ctx)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800908{
Zev Weiss337a0972024-03-08 08:31:15 +0000909 constexpr const char* nmiIntfName = "xyz.openbmc_project.Control.Host.NMI";
910 ipmi::DbusObjectInfo nmiObj{};
911 boost::system::error_code ec;
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800912
Zev Weiss337a0972024-03-08 08:31:15 +0000913 ec = ipmi::getDbusObject(ctx, nmiIntfName, nmiObj);
Vernon Mauery9bb4a382021-11-05 12:46:19 -0700914 if (ec)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800915 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700916 lg2::error("Failed to find NMI service: {ERROR}", "ERROR",
917 ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000918 return -1;
919 }
920
George Liude1420d2025-03-03 15:14:25 +0800921 ec = ipmi::callDbusMethod(ctx, nmiObj.second, nmiObj.first, nmiIntfName,
922 "NMI");
Zev Weiss337a0972024-03-08 08:31:15 +0000923 if (ec)
924 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700925 lg2::error("NMI call failed: {ERROR}", "ERROR", ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000926 elog<InternalFailure>();
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800927 return -1;
928 }
929
930 return 0;
931}
932
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500933namespace power_policy
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500934{
Nan Lifdd8ec52016-08-28 03:57:40 +0800935
Willy Tu523e2d12023-09-05 11:36:48 -0700936using namespace sdbusplus::server::xyz::openbmc_project::control::power;
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500937using IpmiValue = uint8_t;
938using DbusValue = RestorePolicy::Policy;
Nan Lifdd8ec52016-08-28 03:57:40 +0800939
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700940const std::map<DbusValue, IpmiValue> dbusToIpmi = {
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500941 {RestorePolicy::Policy::AlwaysOff, 0x00},
942 {RestorePolicy::Policy::Restore, 0x01},
George Liue561d3e2024-02-04 15:19:30 +0800943 {RestorePolicy::Policy::AlwaysOn, 0x02},
944 {RestorePolicy::Policy::None, 0x03}};
Nan Lifdd8ec52016-08-28 03:57:40 +0800945
Yong Lic6713cf2018-09-12 12:35:13 +0800946static constexpr uint8_t noChange = 0x03;
947static constexpr uint8_t allSupport = 0x01 | 0x02 | 0x04;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700948
949/* helper function for Get Chassis Status Command
950 */
951std::optional<uint2_t> getPowerRestorePolicy()
952{
953 uint2_t restorePolicy = 0;
954 using namespace chassis::internal;
955
James Feist225dec82019-11-26 16:25:06 -0800956 settings::Objects& objects = cache::getObjects();
957
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700958 try
959 {
960 const auto& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -0800961 objects.map.at(powerRestoreIntf).front();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700962 ipmi::Value result = ipmi::getDbusProperty(
963 *getSdBus(),
James Feist225dec82019-11-26 16:25:06 -0800964 objects.service(powerRestoreSetting, powerRestoreIntf).c_str(),
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700965 powerRestoreSetting.c_str(), powerRestoreIntf,
966 "PowerRestorePolicy");
967 auto powerRestore = RestorePolicy::convertPolicyFromString(
968 std::get<std::string>(result));
969 restorePolicy = dbusToIpmi.at(powerRestore);
970 }
971 catch (const std::exception& e)
972 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700973 lg2::error(
974 "Failed to fetch pgood property ({PATH}/{INTERFACE}): {ERROR}",
975 "PATH", objects.map.at(powerRestoreIntf).front(), "INTERFACE",
976 powerRestoreIntf, "ERROR", e);
James Feist225dec82019-11-26 16:25:06 -0800977 cache::objectsPtr.reset();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700978 return std::nullopt;
979 }
980 return std::make_optional(restorePolicy);
981}
982
983/*
984 * getPowerStatus
985 * helper function for Get Chassis Status Command
986 * return - optional value for pgood (no value on error)
987 */
988std::optional<bool> getPowerStatus()
989{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700990 bool powerGood = false;
991 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus();
992 try
993 {
Jason M. Bills3de424c2019-05-21 09:57:16 -0700994 constexpr const char* chassisStatePath =
995 "/xyz/openbmc_project/state/chassis0";
Patrick Williams1318a5e2024-08-16 15:19:54 -0400996 auto service =
Alexander Hansen2260ff32025-11-07 17:12:52 +0100997 ipmi::getService(*busp, ChassisState::interface, chassisStatePath);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700998
Alexander Hansen2260ff32025-11-07 17:12:52 +0100999 ipmi::Value powerState = ipmi::getDbusProperty(
1000 *busp, service, chassisStatePath, ChassisState::interface,
1001 ChassisState::property_names::current_power_state);
Chau Lyee3983b2024-01-05 07:33:45 +00001002 std::string powerStateStr = std::get<std::string>(powerState);
1003 if (powerStateStr.ends_with(".On") ||
1004 powerStateStr.ends_with(".TransitioningToOff"))
1005 {
1006 powerGood = true;
1007 }
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001008 }
1009 catch (const std::exception& e)
1010 {
1011 try
1012 {
1013 // FIXME: some legacy modules use the older path; try that next
1014 constexpr const char* legacyPwrCtrlObj =
1015 "/org/openbmc/control/power0";
1016 constexpr const char* legacyPwrCtrlIntf =
1017 "org.openbmc.control.Power";
Patrick Williams1318a5e2024-08-16 15:19:54 -04001018 auto service =
1019 ipmi::getService(*busp, legacyPwrCtrlIntf, legacyPwrCtrlObj);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001020
1021 ipmi::Value variant = ipmi::getDbusProperty(
1022 *busp, service, legacyPwrCtrlObj, legacyPwrCtrlIntf, "pgood");
1023 powerGood = static_cast<bool>(std::get<int>(variant));
1024 }
1025 catch (const std::exception& e)
1026 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001027 lg2::error("Failed to fetch pgood property: {ERROR}", "ERROR", e);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001028 return std::nullopt;
1029 }
1030 }
1031 return std::make_optional(powerGood);
1032}
1033
Yong Li70ce7352019-05-16 21:15:27 +08001034/*
1035 * getACFailStatus
1036 * helper function for Get Chassis Status Command
1037 * return - bool value for ACFail (false on error)
1038 */
1039bool getACFailStatus()
1040{
1041 constexpr const char* powerControlObj =
1042 "/xyz/openbmc_project/Chassis/Control/Power0";
1043 constexpr const char* powerControlIntf =
1044 "xyz.openbmc_project.Chassis.Control.Power";
1045 bool acFail = false;
1046 std::shared_ptr<sdbusplus::asio::connection> bus = getSdBus();
1047 try
1048 {
Patrick Williams1318a5e2024-08-16 15:19:54 -04001049 auto service =
1050 ipmi::getService(*bus, powerControlIntf, powerControlObj);
Yong Li70ce7352019-05-16 21:15:27 +08001051
1052 ipmi::Value variant = ipmi::getDbusProperty(
1053 *bus, service, powerControlObj, powerControlIntf, "PFail");
1054 acFail = std::get<bool>(variant);
1055 }
1056 catch (const std::exception& e)
1057 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001058 lg2::error(
Konstantin Aladyshev37de2e12025-01-29 11:49:26 +03001059 "Failed to fetch PFail property ({PATH}/{INTERFACE}): {ERROR}",
Vernon Mauery38108d92024-03-11 12:53:55 -07001060 "PATH", powerControlObj, "INTERFACE", powerControlIntf, "ERROR", e);
Yong Li70ce7352019-05-16 21:15:27 +08001061 }
1062 return acFail;
1063}
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001064} // namespace power_policy
Nan Lifdd8ec52016-08-28 03:57:40 +08001065
Patrick Williams615a14e2025-04-07 17:07:24 -04001066static std::optional<bool> getButtonDisabled(ipmi::Context::ptr& ctx,
1067 const std::string& buttonPath,
1068 const std::string& buttonIntf)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001069{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001070 bool buttonDisabled = false;
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001071 boost::system::error_code ec;
1072 std::string service;
1073 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1074 if (!ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001075 {
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001076 bool enabled;
1077 ec = ipmi::getDbusProperty(ctx, service, buttonPath, buttonIntf,
1078 "Enabled", enabled);
1079 buttonDisabled = !enabled;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001080 }
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001081
1082 if (ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001083 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001084 lg2::error("Fail to get button Enabled property ({PATH}): {ERROR}",
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001085 "PATH", buttonPath, "ERROR", ec.message());
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001086 return std::nullopt;
1087 }
1088 return std::make_optional(buttonDisabled);
1089}
1090
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001091static bool setButtonDisabled(ipmi::Context::ptr& ctx,
1092 const std::string& buttonPath,
1093 const std::string& buttonIntf, bool disable)
Kuiying Wang21addc52019-01-04 10:50:21 +08001094{
1095 std::string service;
1096 boost::system::error_code ec;
1097 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1098 if (!ec)
1099 {
1100 ec = ipmi::setDbusProperty(ctx, service, buttonPath, buttonIntf,
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001101 "Enabled", !disable);
Kuiying Wang21addc52019-01-04 10:50:21 +08001102 }
1103 if (ec)
1104 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001105 lg2::error(
1106 "Fail to set button Enabled property ({SERVICE}:{PATH}): {ERROR}",
1107 "SERVICE", service, "PATH", buttonPath, "ERROR", ec.message());
Kuiying Wang21addc52019-01-04 10:50:21 +08001108 return false;
1109 }
1110 return true;
1111}
1112
Chau Ly9e666cd2023-03-06 08:46:14 +00001113static std::optional<bool> getChassisIntrusionStatus(ipmi::Context::ptr& ctx)
1114{
Chau Ly8c1376c2024-01-05 07:22:10 +00001115 std::vector<std::string> interfaces = {std::string(Intrusion::interface)};
1116 ipmi::ObjectTree objs;
1117 std::string propVal;
1118 std::optional<bool> ret = std::nullopt;
Chau Ly9e666cd2023-03-06 08:46:14 +00001119
Chau Ly8c1376c2024-01-05 07:22:10 +00001120 boost::system::error_code ec =
1121 ipmi::getSubTree(ctx, interfaces, std::string("/"), 0, objs);
1122
1123 if (ec)
Chau Ly9e666cd2023-03-06 08:46:14 +00001124 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001125 lg2::error("Fail to find Chassis Intrusion Interface on D-Bus "
1126 "({INTERFACE}): {ERROR}",
1127 "INTERFACE", Intrusion::interface, "ERROR", ec.message());
1128 return ret;
1129 }
1130
1131 for (const auto& [path, map] : objs)
1132 {
1133 for (const auto& [service, intfs] : map)
Chau Ly9e666cd2023-03-06 08:46:14 +00001134 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001135 ec = ipmi::getDbusProperty<std::string>(
1136 ctx, service, path, Intrusion::interface, "Status", propVal);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001137
Chau Ly8c1376c2024-01-05 07:22:10 +00001138 if (ec)
1139 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001140 lg2::error("Failed to get Chassis Intrusion Status property "
Chau Ly8c1376c2024-01-05 07:22:10 +00001141 "({SERVICE}/{PATH}/{INTERFACE}): {ERROR}",
1142 "SERVICE", service, "PATH", path, "INTERFACE",
1143 Intrusion::interface, "ERROR", ec.message());
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001144 continue;
Chau Ly8c1376c2024-01-05 07:22:10 +00001145 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001146
1147 auto statusOpt =
1148 sdbusplus::message::convert_from_string<Intrusion::Status>(
1149 propVal);
1150 if (statusOpt)
Chau Ly8c1376c2024-01-05 07:22:10 +00001151 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001152 if (*statusOpt == Intrusion::Status::Normal)
Chau Ly8c1376c2024-01-05 07:22:10 +00001153 {
1154 ret = std::make_optional(false);
1155 }
1156 else
1157 {
1158 ret = std::make_optional(true);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001159 return ret; // Early return on first non-Normal status
Chau Ly8c1376c2024-01-05 07:22:10 +00001160 }
1161 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001162 else
1163 {
1164 lg2::warning(
1165 "Invalid Intrusion::Status value received: {VALUE}",
1166 "VALUE", propVal);
1167 return std::nullopt;
1168 }
Chau Ly9e666cd2023-03-06 08:46:14 +00001169 }
1170 }
Chau Ly8c1376c2024-01-05 07:22:10 +00001171 return ret;
Chau Ly9e666cd2023-03-06 08:46:14 +00001172}
1173
Nan Lifdd8ec52016-08-28 03:57:40 +08001174//----------------------------------------------------------------------
1175// Get Chassis Status commands
1176//----------------------------------------------------------------------
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001177ipmi::RspType<bool, // Power is on
1178 bool, // Power overload
1179 bool, // Interlock
1180 bool, // power fault
1181 bool, // power control fault
1182 uint2_t, // power restore policy
1183 bool, // reserved
1184
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001185 bool, // AC failed
1186 bool, // last power down caused by a Power overload
1187 bool, // last power down caused by a power interlock
1188 bool, // last power down caused by power fault
Patrick Williams99db6882024-12-18 11:20:17 -05001189 bool, // last ‘Power is on’ state was entered via IPMI command
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001190 uint3_t, // reserved
1191
1192 bool, // Chassis intrusion active
1193 bool, // Front Panel Lockout active
1194 bool, // Drive Fault
1195 bool, // Cooling/fan fault detected
1196 uint2_t, // Chassis Identify State
1197 bool, // Chassis Identify command and state info supported
1198 bool, // reserved
1199
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001200 bool, // Power off button disabled
1201 bool, // Reset button disabled
1202 bool, // Diagnostic Interrupt button disabled
1203 bool, // Standby (sleep) button disabled
1204 bool, // Power off button disable allowed
1205 bool, // Reset button disable allowed
1206 bool, // Diagnostic Interrupt button disable allowed
1207 bool // Standby (sleep) button disable allowed
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001208 >
Chau Ly9e666cd2023-03-06 08:46:14 +00001209 ipmiGetChassisStatus(ipmi::Context::ptr& ctx)
Nan Lifdd8ec52016-08-28 03:57:40 +08001210{
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001211 using namespace chassis::internal;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001212 std::optional<uint2_t> restorePolicy =
1213 power_policy::getPowerRestorePolicy();
1214 std::optional<bool> powerGood = power_policy::getPowerStatus();
1215 if (!restorePolicy || !powerGood)
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001216 {
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001217 return ipmi::responseUnspecifiedError();
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001218 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001219
1220 // Front Panel Button Capabilities and disable/enable status(Optional)
Patrick Williams1318a5e2024-08-16 15:19:54 -04001221 std::optional<bool> powerButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001222 getButtonDisabled(ctx, powerButtonPath, powerButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001223 // allow disable if the interface is present
1224 bool powerButtonDisableAllow = static_cast<bool>(powerButtonReading);
1225 // default return the button is enabled (not disabled)
1226 bool powerButtonDisabled = false;
1227 if (powerButtonDisableAllow)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001228 {
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001229 // return the real value of the button status, if present
1230 powerButtonDisabled = *powerButtonReading;
1231 }
1232
Patrick Williams1318a5e2024-08-16 15:19:54 -04001233 std::optional<bool> resetButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001234 getButtonDisabled(ctx, resetButtonPath, resetButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001235 // allow disable if the interface is present
1236 bool resetButtonDisableAllow = static_cast<bool>(resetButtonReading);
1237 // default return the button is enabled (not disabled)
1238 bool resetButtonDisabled = false;
1239 if (resetButtonDisableAllow)
1240 {
1241 // return the real value of the button status, if present
1242 resetButtonDisabled = *resetButtonReading;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001243 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001244
Yong Li70ce7352019-05-16 21:15:27 +08001245 bool powerDownAcFailed = power_policy::getACFailStatus();
1246
Chau Ly9e666cd2023-03-06 08:46:14 +00001247 bool chassisIntrusionActive = false;
1248 std::optional<bool> chassisIntrusionStatus = getChassisIntrusionStatus(ctx);
1249 if (chassisIntrusionStatus)
1250 {
1251 chassisIntrusionActive = chassisIntrusionStatus.value();
1252 }
1253
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001254 // This response has a lot of hard-coded, unsupported fields
1255 // They are set to false or 0
1256 constexpr bool powerOverload = false;
1257 constexpr bool chassisInterlock = false;
1258 constexpr bool powerFault = false;
1259 constexpr bool powerControlFault = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001260 constexpr bool powerDownOverload = false;
1261 constexpr bool powerDownInterlock = false;
1262 constexpr bool powerDownPowerFault = false;
1263 constexpr bool powerStatusIPMI = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001264 constexpr bool frontPanelLockoutActive = false;
1265 constexpr bool driveFault = false;
1266 constexpr bool coolingFanFault = false;
1267 // chassisIdentifySupport set because this command is implemented
1268 constexpr bool chassisIdentifySupport = true;
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001269 uint2_t chassisIdentifyState = types::enum_cast<uint2_t>(chassisIDState);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001270 constexpr bool diagButtonDisabled = false;
1271 constexpr bool sleepButtonDisabled = false;
1272 constexpr bool diagButtonDisableAllow = false;
1273 constexpr bool sleepButtonDisableAllow = false;
1274
1275 return ipmi::responseSuccess(
1276 *powerGood, powerOverload, chassisInterlock, powerFault,
1277 powerControlFault, *restorePolicy,
1278 false, // reserved
1279
1280 powerDownAcFailed, powerDownOverload, powerDownInterlock,
1281 powerDownPowerFault, powerStatusIPMI,
1282 uint3_t(0), // reserved
1283
1284 chassisIntrusionActive, frontPanelLockoutActive, driveFault,
1285 coolingFanFault, chassisIdentifyState, chassisIdentifySupport,
1286 false, // reserved
1287
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001288 powerButtonDisabled, resetButtonDisabled, diagButtonDisabled,
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001289 sleepButtonDisabled, powerButtonDisableAllow, resetButtonDisableAllow,
1290 diagButtonDisableAllow, sleepButtonDisableAllow);
Nan Lifdd8ec52016-08-28 03:57:40 +08001291}
Chris Austen7888c4d2015-12-03 15:26:20 -06001292
Vijay Khemka074f64d2020-03-03 15:08:43 -08001293enum class IpmiRestartCause
1294{
1295 Unknown = 0x0,
1296 RemoteCommand = 0x1,
1297 ResetButton = 0x2,
1298 PowerButton = 0x3,
1299 WatchdogTimer = 0x4,
1300 PowerPolicyAlwaysOn = 0x6,
1301 PowerPolicyPreviousState = 0x7,
1302 SoftReset = 0xa,
1303};
1304
Patrick Williams69b4c282025-03-03 11:19:13 -05001305static IpmiRestartCause restartCauseToIpmiRestartCause(
1306 State::Host::RestartCause cause)
Vijay Khemka074f64d2020-03-03 15:08:43 -08001307{
1308 switch (cause)
1309 {
1310 case State::Host::RestartCause::Unknown:
1311 {
1312 return IpmiRestartCause::Unknown;
1313 }
1314 case State::Host::RestartCause::RemoteCommand:
1315 {
1316 return IpmiRestartCause::RemoteCommand;
1317 }
1318 case State::Host::RestartCause::ResetButton:
1319 {
1320 return IpmiRestartCause::ResetButton;
1321 }
1322 case State::Host::RestartCause::PowerButton:
1323 {
1324 return IpmiRestartCause::PowerButton;
1325 }
1326 case State::Host::RestartCause::WatchdogTimer:
1327 {
1328 return IpmiRestartCause::WatchdogTimer;
1329 }
1330 case State::Host::RestartCause::PowerPolicyAlwaysOn:
1331 {
1332 return IpmiRestartCause::PowerPolicyAlwaysOn;
1333 }
1334 case State::Host::RestartCause::PowerPolicyPreviousState:
1335 {
1336 return IpmiRestartCause::PowerPolicyPreviousState;
1337 }
1338 case State::Host::RestartCause::SoftReset:
1339 {
1340 return IpmiRestartCause::SoftReset;
1341 }
1342 default:
1343 {
1344 return IpmiRestartCause::Unknown;
1345 }
1346 }
1347}
1348
1349/*
1350 * getRestartCause
1351 * helper function for Get Host restart cause Command
1352 * return - optional value for RestartCause (no value on error)
1353 */
1354static std::optional<uint4_t> getRestartCause(ipmi::Context::ptr ctx)
1355{
okashanyced0ddf2023-05-18 18:35:09 +00001356 constexpr const char* restartCausePath = "/xyz/openbmc_project/state/host0";
Vijay Khemka074f64d2020-03-03 15:08:43 -08001357
1358 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001359 boost::system::error_code ec =
Alexander Hansen76bfd752025-11-07 17:04:32 +01001360 ipmi::getService(ctx, HostState::interface, restartCausePath, service);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001361 if (!ec)
1362 {
1363 std::string restartCauseStr;
1364 ec = ipmi::getDbusProperty<std::string>(
Alexander Hansen76bfd752025-11-07 17:04:32 +01001365 ctx, service, restartCausePath, HostState::interface,
1366 HostState::property_names::restart_cause, restartCauseStr);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001367 if (!ec)
1368 {
1369 auto cause =
1370 State::Host::convertRestartCauseFromString(restartCauseStr);
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001371 return types::enum_cast<uint4_t>(
1372 restartCauseToIpmiRestartCause(cause));
Vijay Khemka074f64d2020-03-03 15:08:43 -08001373 }
1374 }
1375
Vernon Mauery38108d92024-03-11 12:53:55 -07001376 lg2::error(
1377 "Failed to fetch RestartCause property ({PATH}/{INTERFACE}): {ERROR}",
1378 "ERROR", ec.message(), "PATH", restartCausePath, "INTERFACE",
Alexander Hansen76bfd752025-11-07 17:04:32 +01001379 HostState::interface);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001380 return std::nullopt;
1381}
1382
1383ipmi::RspType<uint4_t, // Restart Cause
1384 uint4_t, // reserved
1385 uint8_t // channel number (not supported)
1386 >
1387 ipmiGetSystemRestartCause(ipmi::Context::ptr ctx)
1388{
1389 std::optional<uint4_t> cause = getRestartCause(ctx);
1390 if (!cause)
1391 {
1392 return ipmi::responseUnspecifiedError();
1393 }
1394
Vernon Mauery916d4232021-03-29 13:42:16 -07001395 constexpr uint4_t reserved = 0;
1396 auto channel = static_cast<uint8_t>(ctx->channel);
1397 return ipmi::responseSuccess(cause.value(), reserved, channel);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001398}
anil kumar appanadafff5f2019-04-27 18:06:00 +00001399/** @brief Implementation of chassis control command
1400 *
1401 * @param - chassisControl command byte
1402 *
1403 * @return Success or InvalidFieldRequest.
1404 */
Jason M. Bills664e1c32020-01-30 16:02:39 -08001405ipmi::RspType<> ipmiChassisControl(ipmi::Context::ptr& ctx,
1406 uint8_t chassisControl)
vishwa36993272015-11-20 12:43:49 -06001407{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001408 int rc = 0;
anil kumar appanadafff5f2019-04-27 18:06:00 +00001409 switch (chassisControl)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001410 {
George Liu8f4717c2025-07-03 09:22:34 +08001411 case cmdPowerOn:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001412 rc = initiateHostStateTransition(ctx, State::Host::Transition::On);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001413 break;
George Liu8f4717c2025-07-03 09:22:34 +08001414 case cmdPowerOff:
Jason M. Billsc2c3a402020-01-30 16:22:24 -08001415 rc = initiateChassisStateTransition(
1416 ctx, State::Chassis::Transition::Off);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001417 break;
George Liu8f4717c2025-07-03 09:22:34 +08001418 case cmdHardReset:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001419 rc = initiateHostStateTransition(
1420 ctx, State::Host::Transition::ForceWarmReboot);
Chanh Nguyend0a7fcd2021-07-16 22:59:28 +07001421 break;
George Liu8f4717c2025-07-03 09:22:34 +08001422 case cmdPowerCycle:
Thang Trana7d592c2025-09-17 03:43:14 +00001423 {
1424 auto powerState = power_policy::getPowerStatus();
1425
1426 if (powerState == std::nullopt)
1427 {
1428 return ipmi::responseUnspecifiedError();
1429 }
1430
1431 /*
1432 * As define in the Chapter 28.3 - Chassis Control Command of IPMI
1433 * specification: It is recommended that no action occur if system
1434 * power is off (S4/S5) when this action is selected, and that a D5
1435 * "Requiest parameter(s) not supported in this presenst state."
1436 * error completion code be returned.
1437 */
1438 if (powerState.value() == false)
1439 {
1440 return ipmi::responseCommandNotAvailable();
1441 }
1442
Jason M. Bills664e1c32020-01-30 16:02:39 -08001443 rc = initiateHostStateTransition(ctx,
1444 State::Host::Transition::Reboot);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001445 break;
Thang Trana7d592c2025-09-17 03:43:14 +00001446 }
George Liu8f4717c2025-07-03 09:22:34 +08001447 case cmdSoftOffViaOverTemp:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001448 rc = initiateHostStateTransition(ctx, State::Host::Transition::Off);
Vishwanatha Subbanna8b26d352017-08-04 18:35:18 +05301449 break;
George Liu8f4717c2025-07-03 09:22:34 +08001450 case cmdPulseDiagnosticInterrupt:
Zev Weiss337a0972024-03-08 08:31:15 +00001451 rc = doNmi(ctx);
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +08001452 break;
1453
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001454 default:
1455 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001456 lg2::error("Invalid Chassis Control command: {CMD}", "CMD",
1457 lg2::hex, chassisControl);
anil kumar appanadafff5f2019-04-27 18:06:00 +00001458 return ipmi::responseInvalidFieldRequest();
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001459 }
1460 }
vishwa36993272015-11-20 12:43:49 -06001461
anil kumar appanadafff5f2019-04-27 18:06:00 +00001462 return ((rc < 0) ? ipmi::responseUnspecifiedError()
1463 : ipmi::responseSuccess());
vishwa36993272015-11-20 12:43:49 -06001464}
1465
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001466/** @brief Return D-Bus connection string to enclosure identify LED object
1467 *
1468 * @param[in, out] connection - connection to D-Bus object
1469 * @return a IPMI return code
1470 */
1471std::string getEnclosureIdentifyConnection()
Tom Joseph5110c122018-03-23 17:55:40 +05301472{
Tom Joseph5110c122018-03-23 17:55:40 +05301473 // lookup enclosure_identify group owner(s) in mapper
George Liu3e3cc352023-07-26 15:59:31 +08001474 try
Tom Joseph5110c122018-03-23 17:55:40 +05301475 {
George Liu3e3cc352023-07-26 15:59:31 +08001476 return ipmi::getService(*getSdBus(), "xyz.openbmc_project.Led.Group",
1477 identify_led_object_name);
1478 }
1479 catch (const std::exception& e)
1480 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001481 lg2::error("Chassis Identify: Error communicating to mapper: {ERROR}",
1482 "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001483 elog<InternalFailure>();
Tom Joseph5110c122018-03-23 17:55:40 +05301484 }
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001485}
Tom Joseph5110c122018-03-23 17:55:40 +05301486
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001487/** @brief Turn On/Off enclosure identify LED
1488 *
1489 * @param[in] flag - true to turn on LED, false to turn off
1490 * @return a IPMI return code
1491 */
1492void enclosureIdentifyLed(bool flag)
1493{
1494 using namespace chassis::internal;
George Liucbe50fd2025-08-21 16:51:33 +08001495
1496 std::string connection = getEnclosureIdentifyConnection();
1497
1498 lg2::debug("enclosureIdentifyLed({FLAG})", "FLAG", flag);
1499
George Liu3e3cc352023-07-26 15:59:31 +08001500 try
1501 {
George Liu3e3cc352023-07-26 15:59:31 +08001502 ipmi::setDbusProperty(*getSdBus(), connection, identify_led_object_name,
1503 "xyz.openbmc_project.Led.Group", "Asserted",
1504 flag);
1505 }
1506 catch (const std::exception& e)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001507 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001508 lg2::error("Chassis Identify: Error Setting State {LED_STATE}: {ERROR}",
1509 "LED_STATE", flag, "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001510 elog<InternalFailure>();
1511 }
1512}
1513
1514/** @brief Callback method to turn off LED
1515 */
1516void enclosureIdentifyLedOff()
1517{
1518 try
1519 {
Yong Lif4e38512019-05-21 14:46:55 +08001520 chassisIDState = ChassisIDState::off;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001521 enclosureIdentifyLed(false);
1522 }
1523 catch (const InternalFailure& e)
1524 {
1525 report<InternalFailure>();
1526 }
1527}
1528
1529/** @brief Create timer to turn on and off the enclosure LED
1530 */
1531void createIdentifyTimer()
1532{
1533 if (!identifyTimer)
1534 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001535 identifyTimer =
Patrick Williams95655222023-12-05 12:45:02 -06001536 std::make_unique<sdbusplus::Timer>(enclosureIdentifyLedOff);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001537 }
1538}
1539
Vernon Mauery400cc782018-10-09 13:49:53 -07001540ipmi::RspType<> ipmiChassisIdentify(std::optional<uint8_t> interval,
1541 std::optional<uint8_t> force)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001542{
Vernon Mauery400cc782018-10-09 13:49:53 -07001543 uint8_t identifyInterval = interval.value_or(DEFAULT_IDENTIFY_TIME_OUT);
1544 bool forceIdentify = force.value_or(0) & 0x01;
Tom Josephbed26992018-07-31 23:00:24 +05301545
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001546 if (identifyInterval || forceIdentify)
1547 {
Vernon Mauery400cc782018-10-09 13:49:53 -07001548 // stop the timer if already started;
1549 // for force identify we should not turn off LED
Vernon Mauery1181af72018-10-08 12:05:00 -07001550 identifyTimer->stop();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001551 try
Tom Joseph5110c122018-03-23 17:55:40 +05301552 {
Yong Lif4e38512019-05-21 14:46:55 +08001553 chassisIDState = ChassisIDState::temporaryOn;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001554 enclosureIdentifyLed(true);
1555 }
1556 catch (const InternalFailure& e)
1557 {
1558 report<InternalFailure>();
Vernon Mauery400cc782018-10-09 13:49:53 -07001559 return ipmi::responseResponseError();
Tom Joseph5110c122018-03-23 17:55:40 +05301560 }
1561
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001562 if (forceIdentify)
Tom Joseph5110c122018-03-23 17:55:40 +05301563 {
Yong Lif4e38512019-05-21 14:46:55 +08001564 chassisIDState = ChassisIDState::indefiniteOn;
Vernon Mauery400cc782018-10-09 13:49:53 -07001565 return ipmi::responseSuccess();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001566 }
1567 // start the timer
1568 auto time = std::chrono::duration_cast<std::chrono::microseconds>(
Patrick Venture0b02be92018-08-31 11:55:55 -07001569 std::chrono::seconds(identifyInterval));
Vernon Mauery1181af72018-10-08 12:05:00 -07001570 identifyTimer->start(time);
Tom Joseph5110c122018-03-23 17:55:40 +05301571 }
Tom Josephbed26992018-07-31 23:00:24 +05301572 else if (!identifyInterval)
1573 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001574 identifyTimer->stop();
Tom Josephbed26992018-07-31 23:00:24 +05301575 enclosureIdentifyLedOff();
1576 }
Vernon Mauery400cc782018-10-09 13:49:53 -07001577 return ipmi::responseSuccess();
Tom Joseph5110c122018-03-23 17:55:40 +05301578}
1579
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001580namespace boot_options
1581{
1582
Willy Tu523e2d12023-09-05 11:36:48 -07001583using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001584using IpmiValue = uint8_t;
1585constexpr auto ipmiDefault = 0;
1586
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001587std::map<IpmiValue, Type::Types> typeIpmiToDbus = {{0x00, Type::Types::Legacy},
1588 {0x01, Type::Types::EFI}};
1589
Patrick Venture0b02be92018-08-31 11:55:55 -07001590std::map<IpmiValue, Source::Sources> sourceIpmiToDbus = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001591 {0x01, Source::Sources::Network},
1592 {0x02, Source::Sources::Disk},
1593 {0x05, Source::Sources::ExternalMedia},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001594 {0x0f, Source::Sources::RemovableMedia},
Patrick Venture0b02be92018-08-31 11:55:55 -07001595 {ipmiDefault, Source::Sources::Default}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001596
Patrick Venture0b02be92018-08-31 11:55:55 -07001597std::map<IpmiValue, Mode::Modes> modeIpmiToDbus = {
Yong Li5833cb62019-10-30 13:27:12 +08001598#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001599 {0x03, Mode::Modes::Safe},
Yong Li5833cb62019-10-30 13:27:12 +08001600#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001601 {0x06, Mode::Modes::Setup},
Patrick Venture0b02be92018-08-31 11:55:55 -07001602 {ipmiDefault, Mode::Modes::Regular}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001603
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001604std::map<Type::Types, IpmiValue> typeDbusToIpmi = {{Type::Types::Legacy, 0x00},
1605 {Type::Types::EFI, 0x01}};
1606
Patrick Venture0b02be92018-08-31 11:55:55 -07001607std::map<Source::Sources, IpmiValue> sourceDbusToIpmi = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001608 {Source::Sources::Network, 0x01},
1609 {Source::Sources::Disk, 0x02},
1610 {Source::Sources::ExternalMedia, 0x05},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001611 {Source::Sources::RemovableMedia, 0x0f},
Patrick Venture0b02be92018-08-31 11:55:55 -07001612 {Source::Sources::Default, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001613
Patrick Venture0b02be92018-08-31 11:55:55 -07001614std::map<Mode::Modes, IpmiValue> modeDbusToIpmi = {
Yong Li5833cb62019-10-30 13:27:12 +08001615#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001616 {Mode::Modes::Safe, 0x03},
Yong Li5833cb62019-10-30 13:27:12 +08001617#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001618 {Mode::Modes::Setup, 0x06},
Patrick Venture0b02be92018-08-31 11:55:55 -07001619 {Mode::Modes::Regular, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001620
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001621} // namespace boot_options
shgoupfd84fbbf2015-12-17 10:05:51 +08001622
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001623/** @brief Get the property value for boot source
1624 * @param[in] ctx - context pointer
1625 * @param[out] source - boot source value
1626 * @return On failure return IPMI error.
1627 */
1628static ipmi::Cc getBootSource(ipmi::Context::ptr& ctx, Source::Sources& source)
1629{
1630 using namespace chassis::internal;
1631 std::string result;
1632 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001633 boost::system::error_code ec =
1634 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001635 if (!ec)
1636 {
1637 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1638 bootSourceIntf, "BootSource", result);
1639 if (!ec)
1640 {
1641 source = Source::convertSourcesFromString(result);
1642 return ipmi::ccSuccess;
1643 }
1644 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001645 lg2::error("Error in BootSource Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001646 return ipmi::ccUnspecifiedError;
1647}
1648
Marri Devender Rao81719702018-05-07 00:53:48 -05001649/** @brief Set the property value for boot source
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001650 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001651 * @param[in] source - boot source value
1652 * @return On failure return IPMI error.
1653 */
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00001654static ipmi::Cc setBootSource(ipmi::Context::ptr& ctx,
1655 const Source::Sources& source)
Marri Devender Rao81719702018-05-07 00:53:48 -05001656{
1657 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001658 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001659 boost::system::error_code ec =
1660 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001661 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001662 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001663 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1664 bootSourceIntf, "BootSource",
1665 convertForMessage(source));
1666 if (!ec)
1667 {
1668 return ipmi::ccSuccess;
1669 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001670 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001671 lg2::error("Error in BootSource Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001672 return ipmi::ccUnspecifiedError;
1673}
1674
1675/** @brief Get the property value for boot mode
1676 * @param[in] ctx - context pointer
1677 * @param[out] mode - boot mode value
1678 * @return On failure return IPMI error.
1679 */
1680static ipmi::Cc getBootMode(ipmi::Context::ptr& ctx, Mode::Modes& mode)
1681{
1682 using namespace chassis::internal;
1683 std::string result;
1684 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001685 boost::system::error_code ec =
1686 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001687 if (!ec)
1688 {
1689 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1690 "BootMode", result);
1691 if (!ec)
1692 {
1693 mode = Mode::convertModesFromString(result);
1694 return ipmi::ccSuccess;
1695 }
1696 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001697 lg2::error("Error in BootMode Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001698 return ipmi::ccUnspecifiedError;
Marri Devender Rao81719702018-05-07 00:53:48 -05001699}
1700
Patrick Venture0b02be92018-08-31 11:55:55 -07001701/** @brief Set the property value for boot mode
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001702 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001703 * @param[in] mode - boot mode value
1704 * @return On failure return IPMI error.
1705 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001706static ipmi::Cc setBootMode(ipmi::Context::ptr& ctx, const Mode::Modes& mode)
Marri Devender Rao81719702018-05-07 00:53:48 -05001707{
1708 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001709 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001710 boost::system::error_code ec =
1711 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001712 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001713 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001714 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1715 "BootMode", convertForMessage(mode));
1716 if (!ec)
1717 {
1718 return ipmi::ccSuccess;
1719 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001720 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001721 lg2::error("Error in BootMode Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001722 return ipmi::ccUnspecifiedError;
1723}
1724
1725/** @brief Get the property value for boot type
1726 * @param[in] ctx - context pointer
1727 * @param[out] type - boot type value
1728 * @return On failure return IPMI error.
1729 */
1730static ipmi::Cc getBootType(ipmi::Context::ptr& ctx, Type::Types& type)
1731{
1732 using namespace chassis::internal;
1733 std::string result;
1734 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001735 boost::system::error_code ec =
1736 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001737
1738 // Don't throw error if BootType interface is not present.
1739 // This interface is not relevant for some Host architectures
1740 // (for example POWER). In this case we don't won't IPMI to
1741 // return an error, but simply return bootType as EFI.
1742 type = Type::Types::EFI;
1743 if (!ec)
1744 {
1745 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1746 "BootType", result);
1747 if (ec)
1748 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001749 lg2::error("Error in BootType Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001750 return ipmi::ccUnspecifiedError;
1751 }
1752 type = Type::convertTypesFromString(result);
1753 }
1754
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00001755 return ipmi::ccSuccess;
Marri Devender Rao81719702018-05-07 00:53:48 -05001756}
1757
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001758/** @brief Set the property value for boot type
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001759 * @param[in] ctx - context pointer
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001760 * @param[in] type - boot type value
1761 * @return On failure return IPMI error.
1762 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001763static ipmi::Cc setBootType(ipmi::Context::ptr& ctx, const Type::Types& type)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001764{
1765 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001766 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001767 boost::system::error_code ec =
1768 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001769 if (!ec)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001770 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001771 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1772 "BootType", convertForMessage(type));
1773 if (ec)
1774 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001775 lg2::error("Error in BootType Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001776 return ipmi::ccUnspecifiedError;
1777 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001778 }
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001779 // Don't throw error if BootType interface is not present.
1780 // This interface is not relevant for some Host architectures
1781 // (for example POWER). In this case we don't won't IPMI to
1782 // return an error, but want to just skip this function.
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001783 return ipmi::ccSuccess;
1784}
1785
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001786/** @brief Get the property value for boot override enable
1787 * @param[in] ctx - context pointer
1788 * @param[out] enable - boot override enable
1789 * @return On failure return IPMI error.
1790 */
1791static ipmi::Cc getBootEnable(ipmi::Context::ptr& ctx, bool& enable)
1792{
1793 using namespace chassis::internal;
1794 std::string result;
1795 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001796 boost::system::error_code ec =
1797 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001798 if (!ec)
1799 {
1800 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1801 bootEnableIntf, "Enabled", enable);
1802 if (!ec)
1803 {
1804 return ipmi::ccSuccess;
1805 }
1806 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001807 lg2::error("Error in Boot Override Enable Get: {ERROR}", "ERROR",
1808 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001809 return ipmi::ccUnspecifiedError;
1810}
1811
1812/** @brief Set the property value for boot override enable
1813 * @param[in] ctx - context pointer
1814 * @param[in] enable - boot override enable
1815 * @return On failure return IPMI error.
1816 */
1817static ipmi::Cc setBootEnable(ipmi::Context::ptr& ctx, const bool& enable)
1818{
1819 using namespace chassis::internal;
1820 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001821 boost::system::error_code ec =
1822 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001823 if (!ec)
1824 {
1825 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1826 bootEnableIntf, "Enabled", enable);
1827 if (!ec)
1828 {
1829 return ipmi::ccSuccess;
1830 }
1831 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001832 lg2::error("Error in Boot Source Override Enable Set: {ERROR}", "ERROR",
1833 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001834 return ipmi::ccUnspecifiedError;
1835}
1836
1837/** @brief Get the property value for boot override one-time
1838 * @param[in] ctx - context pointer
1839 * @param[out] onetime - boot override one-time
1840 * @return On failure return IPMI error.
1841 */
1842static ipmi::Cc getBootOneTime(ipmi::Context::ptr& ctx, bool& onetime)
1843{
1844 using namespace chassis::internal;
1845 std::string result;
1846 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001847 boost::system::error_code ec =
1848 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001849 if (!ec)
1850 {
1851 ec = ipmi::getDbusProperty(ctx, service, bootSettingsOneTimePath,
1852 bootOneTimeIntf, "Enabled", onetime);
1853 if (!ec)
1854 {
1855 return ipmi::ccSuccess;
1856 }
1857 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001858 lg2::error("Error in Boot Override OneTime Get: {ERROR}", "ERROR",
1859 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001860 return ipmi::ccUnspecifiedError;
1861}
1862
1863/** @brief Set the property value for boot override one-time
1864 * @param[in] ctx - context pointer
1865 * @param[in] onetime - boot override one-time
1866 * @return On failure return IPMI error.
1867 */
1868static ipmi::Cc setBootOneTime(ipmi::Context::ptr& ctx, const bool& onetime)
1869{
1870 using namespace chassis::internal;
1871 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001872 boost::system::error_code ec =
1873 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001874 if (!ec)
1875 {
1876 ec = ipmi::setDbusProperty(ctx, service, bootSettingsOneTimePath,
1877 bootOneTimeIntf, "Enabled", onetime);
1878 if (!ec)
1879 {
1880 return ipmi::ccSuccess;
1881 }
1882 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001883 lg2::error("Error in Boot Source Override OneTime Set: {ERROR}", "ERROR",
1884 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001885 return ipmi::ccUnspecifiedError;
1886}
1887
huangheab369282020-10-10 14:40:00 +08001888static constexpr uint8_t setComplete = 0x0;
1889static constexpr uint8_t setInProgress = 0x1;
1890static uint8_t transferStatus = setComplete;
Chen Yugang86ac4992021-06-25 08:14:52 +08001891static uint8_t bootFlagValidBitClr = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001892static uint5_t bootInitiatorAckData = 0x0;
Hieu Huynh1982a3f2021-09-21 03:06:45 +00001893static bool cmosClear = false;
Cosmo Chou53831212025-01-10 13:36:36 +08001894static uint2_t biosVerbosity = 0x0;
huangheab369282020-10-10 14:40:00 +08001895
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001896/** @brief implements the Get Chassis system boot option
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001897 * @param ctx - context pointer
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001898 * @param bootOptionParameter - boot option parameter selector
1899 * @param reserved1 - reserved bit
1900 * @param setSelector - selects a particular block or set of parameters
1901 * under the given parameter selector
1902 * write as 00h if parameter doesn't use a setSelector
1903 * @param blockSelector- selects a particular block within a set of
1904 * parameters write as 00h if parameter doesn't use a
1905 * blockSelector
1906 *
1907 * @return IPMI completion code plus response data
1908 * @return Payload contains below parameters:
1909 * version - parameter version
1910 * bootOptionParameter - boot option parameter selector
Patrick Venture8b1c3032020-09-15 09:43:03 -07001911 * parmIndicator - parameter valid/invalid indicator
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001912 * data - configuration parameter data
1913 */
Patrick Williams1318a5e2024-08-16 15:19:54 -04001914ipmi::RspType<ipmi::message::Payload> ipmiChassisGetSysBootOptions(
1915 ipmi::Context::ptr ctx, uint7_t bootOptionParameter, bool reserved1,
1916 [[maybe_unused]] uint8_t setSelector,
1917 [[maybe_unused]] uint8_t blockSelector)
Adriana Kobylak40814c62015-10-27 15:58:44 -05001918{
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001919 ipmi::Cc rc;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001920 if (reserved1)
1921 {
1922 return ipmi::responseInvalidFieldRequest();
1923 }
1924
1925 constexpr uint4_t version = 0x01;
1926 ipmi::message::Payload response;
1927 response.pack(version, uint4_t{});
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001928 using namespace boot_options;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001929
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001930 IpmiValue bootOption = ipmiDefault;
Adriana Kobylak40814c62015-10-27 15:58:44 -05001931
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001932 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1933 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08001934 {
1935 response.pack(bootOptionParameter, reserved1, transferStatus);
1936 return ipmi::responseSuccess(std::move(response));
1937 }
1938
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001939 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1940 BootOptionParameter::bootInfo)
John Wang0213f902020-12-28 14:49:57 +08001941 {
1942 constexpr uint8_t writeMask = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001943 response.pack(bootOptionParameter, reserved1, writeMask,
1944 bootInitiatorAckData);
John Wang0213f902020-12-28 14:49:57 +08001945 return ipmi::responseSuccess(std::move(response));
1946 }
1947
Chen Yugang86ac4992021-06-25 08:14:52 +08001948 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1949 BootOptionParameter::bootFlagValidClr)
1950 {
1951 response.pack(bootOptionParameter, reserved1,
1952 uint5_t{bootFlagValidBitClr}, uint3_t{});
1953 return ipmi::responseSuccess(std::move(response));
1954 }
1955
shgoupfd84fbbf2015-12-17 10:05:51 +08001956 /*
1957 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
1958 * This is the only parameter used by petitboot.
1959 */
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001960 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1961 BootOptionParameter::bootFlags)
Patrick Venture0b02be92018-08-31 11:55:55 -07001962 {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001963 using namespace chassis::internal;
1964 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08001965
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001966 try
ratagupta6f6bff2016-04-04 06:20:11 -05001967 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001968 Source::Sources bootSource;
1969 rc = getBootSource(ctx, bootSource);
1970 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001971 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001972 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001973 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001974
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001975 Type::Types bootType;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001976 rc = getBootType(ctx, bootType);
1977 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001978 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001979 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001980 }
1981
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001982 Mode::Modes bootMode;
1983 rc = getBootMode(ctx, bootMode);
1984 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001985 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001986 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001987 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001988
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001989 bootOption = sourceDbusToIpmi.at(bootSource);
1990 if ((Mode::Modes::Regular == bootMode) &&
1991 (Source::Sources::Default == bootSource))
1992 {
1993 bootOption = ipmiDefault;
1994 }
1995 else if (Source::Sources::Default == bootSource)
1996 {
1997 bootOption = modeDbusToIpmi.at(bootMode);
1998 }
ratagupta6f6bff2016-04-04 06:20:11 -05001999
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002000 IpmiValue biosBootType = typeDbusToIpmi.at(bootType);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002001
2002 bool oneTimeEnabled;
2003 rc = getBootOneTime(ctx, oneTimeEnabled);
2004 if (rc != ipmi::ccSuccess)
2005 {
2006 return ipmi::response(rc);
2007 }
2008
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002009 uint1_t permanent = oneTimeEnabled ? 0 : 1;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002010
2011 bool valid;
2012 rc = getBootEnable(ctx, valid);
2013 if (rc != ipmi::ccSuccess)
2014 {
2015 return ipmi::response(rc);
2016 }
2017
2018 uint1_t validFlag = valid ? 1 : 0;
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002019
Cosmo Chou53831212025-01-10 13:36:36 +08002020 response.pack(
2021 bootOptionParameter, reserved1, uint5_t{},
2022 uint1_t{biosBootType}, uint1_t{permanent}, uint1_t{validFlag},
2023 uint2_t{}, uint4_t{bootOption}, uint1_t{}, cmosClear, uint5_t{},
2024 uint2_t{biosVerbosity}, uint1_t{}, uint8_t{}, uint8_t{});
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002025 return ipmi::responseSuccess(std::move(response));
ratagupta6f6bff2016-04-04 06:20:11 -05002026 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002027 catch (const InternalFailure& e)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002028 {
James Feist225dec82019-11-26 16:25:06 -08002029 cache::objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002030 report<InternalFailure>();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002031 return ipmi::responseUnspecifiedError();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002032 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002033 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002034 else
2035 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002036 if ((bootOptionParameter >= oemParmStart) &&
2037 (bootOptionParameter <= oemParmEnd))
2038 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002039 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
2040 BootOptionParameter::opalNetworkSettings)
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002041 {
2042 response.pack(bootOptionParameter, reserved1);
2043 int ret = getHostNetworkData(response);
2044 if (ret < 0)
2045 {
2046 response.trailingOk = true;
Vernon Mauery38108d92024-03-11 12:53:55 -07002047 lg2::error(
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002048 "getHostNetworkData failed for GetSysBootOptions.");
2049 return ipmi::responseUnspecifiedError();
2050 }
2051 else
2052 {
2053 return ipmi::responseSuccess(std::move(response));
2054 }
2055 }
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002056 else
2057 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002058 lg2::error(
2059 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2060 "PARAM", lg2::hex,
2061 static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002062 return ipmi::responseParmNotSupported();
2063 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002064 }
2065 else
2066 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002067 lg2::error(
2068 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2069 "PARAM", lg2::hex, static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00002070 return ipmi::responseParmNotSupported();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002071 }
shgoupfd84fbbf2015-12-17 10:05:51 +08002072 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002073 return ipmi::responseUnspecifiedError();
shgoupfd84fbbf2015-12-17 10:05:51 +08002074}
2075
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002076ipmi::RspType<> ipmiChassisSetSysBootOptions(ipmi::Context::ptr ctx,
Willy Tu11d68892022-01-20 10:37:34 -08002077 uint7_t parameterSelector, bool,
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002078 ipmi::message::Payload& data)
shgoupfd84fbbf2015-12-17 10:05:51 +08002079{
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002080 using namespace boot_options;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002081 ipmi::Cc rc;
shgoupfd84fbbf2015-12-17 10:05:51 +08002082
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002083 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2084 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08002085 {
2086 uint2_t setInProgressFlag;
2087 uint6_t rsvd;
2088 if (data.unpack(setInProgressFlag, rsvd) != 0 || !data.fullyUnpacked())
2089 {
2090 return ipmi::responseReqDataLenInvalid();
2091 }
2092 if (rsvd)
2093 {
2094 return ipmi::responseInvalidFieldRequest();
2095 }
2096 if ((transferStatus == setInProgress) &&
2097 (static_cast<uint8_t>(setInProgressFlag) != setComplete))
2098 {
George Liuf5dd1022025-07-07 09:13:07 +08002099 return ipmi::responsefailSetInProgress();
huangheab369282020-10-10 14:40:00 +08002100 }
2101 transferStatus = static_cast<uint8_t>(setInProgressFlag);
2102 return ipmi::responseSuccess();
2103 }
2104
shgoupfd84fbbf2015-12-17 10:05:51 +08002105 /* 000101
2106 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
2107 * This is the only parameter used by petitboot.
2108 */
Ratan Guptafd28dd72016-08-01 04:58:01 -05002109
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002110 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2111 BootOptionParameter::bootFlags)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002112 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002113 uint5_t rsvd;
2114 bool validFlag;
2115 bool permanent;
2116 bool biosBootType;
2117 bool lockOutResetButton;
2118 bool screenBlank;
2119 uint4_t bootDeviceSelector;
2120 bool lockKeyboard;
Cosmo Chou53831212025-01-10 13:36:36 +08002121 uint5_t biosCtrls;
2122 bool lockOutPower;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002123 uint4_t biosInfo;
2124 uint4_t rsvd1;
2125 uint5_t deviceInstance;
2126 uint3_t rsvd2;
2127
2128 if (data.unpack(rsvd, biosBootType, permanent, validFlag,
2129 lockOutResetButton, screenBlank, bootDeviceSelector,
Cosmo Chou53831212025-01-10 13:36:36 +08002130 lockKeyboard, cmosClear, biosCtrls, biosVerbosity,
2131 lockOutPower, biosInfo, rsvd1, deviceInstance, rsvd2) !=
2132 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002133 !data.fullyUnpacked())
2134 {
2135 return ipmi::responseReqDataLenInvalid();
2136 }
2137 if (rsvd || rsvd1 || rsvd2)
2138 {
2139 return ipmi::responseInvalidFieldRequest();
2140 }
2141
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002142 using namespace chassis::internal;
2143 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08002144
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002145 try
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002146 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002147 rc = setBootOneTime(ctx, !permanent);
2148 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev69e8e842021-06-18 17:01:18 +03002149 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002150 return ipmi::response(rc);
2151 }
Vernon Maueryafd45db2021-07-29 16:27:25 +00002152
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002153 rc = setBootEnable(ctx, validFlag);
2154 if (rc != ipmi::ccSuccess)
2155 {
2156 return ipmi::response(rc);
Tom Joseph57e8eb72017-09-25 18:05:02 +05302157 }
2158
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002159 auto modeItr =
2160 modeIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002161 auto typeItr =
2162 typeIpmiToDbus.find(static_cast<uint8_t>(biosBootType));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002163 auto sourceItr =
2164 sourceIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002165 if (sourceIpmiToDbus.end() != sourceItr)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002166 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002167 rc = setBootSource(ctx, sourceItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002168 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002169 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002170 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002171 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002172 // If a set boot device is mapping to a boot source, then reset
2173 // the boot mode D-Bus property to default.
2174 // This way the ipmid code can determine which property is not
2175 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002176 if (sourceItr->second != Source::Sources::Default)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002177 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002178 rc = setBootMode(ctx, Mode::Modes::Regular);
2179 if (rc != ipmi::ccSuccess)
2180 {
2181 return ipmi::response(rc);
2182 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002183 }
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002184 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002185
2186 if (typeIpmiToDbus.end() != typeItr)
2187 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002188 rc = setBootType(ctx, typeItr->second);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002189 if (rc != ipmi::ccSuccess)
2190 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002191 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002192 }
2193 }
2194
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002195 if (modeIpmiToDbus.end() != modeItr)
2196 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002197 rc = setBootMode(ctx, modeItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002198 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002199 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002200 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002201 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002202 // If a set boot device is mapping to a boot mode, then reset
2203 // the boot source D-Bus property to default.
2204 // This way the ipmid code can determine which property is not
2205 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002206 if (modeItr->second != Mode::Modes::Regular)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002207 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002208 rc = setBootSource(ctx, Source::Sources::Default);
2209 if (rc != ipmi::ccSuccess)
2210 {
2211 return ipmi::response(rc);
2212 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002213 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002214 }
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002215 if ((modeIpmiToDbus.end() == modeItr) &&
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002216 (typeIpmiToDbus.end() == typeItr) &&
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002217 (sourceIpmiToDbus.end() == sourceItr))
2218 {
2219 // return error if boot option is not supported
Vernon Mauery38108d92024-03-11 12:53:55 -07002220 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002221 "ipmiChassisSetSysBootOptions: Boot option not supported");
2222 return ipmi::responseInvalidFieldRequest();
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002223 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002224 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002225 catch (const sdbusplus::exception_t& e)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002226 {
James Feist225dec82019-11-26 16:25:06 -08002227 objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002228 report<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -07002229 lg2::error("ipmiChassisSetSysBootOptions: Error in setting Boot "
2230 "flag parameters");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002231 return ipmi::responseUnspecifiedError();
Ratan Guptafd28dd72016-08-01 04:58:01 -05002232 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002233 }
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002234 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2235 BootOptionParameter::bootInfo)
Patrick Venture0b02be92018-08-31 11:55:55 -07002236 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002237 uint8_t writeMak;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002238 uint5_t bootInfoAck;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002239 uint3_t rsvd;
2240
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002241 if (data.unpack(writeMak, bootInfoAck, rsvd) != 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002242 !data.fullyUnpacked())
2243 {
2244 return ipmi::responseReqDataLenInvalid();
2245 }
2246 if (rsvd)
2247 {
2248 return ipmi::responseInvalidFieldRequest();
2249 }
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002250 bootInitiatorAckData &= ~writeMak;
2251 bootInitiatorAckData |= (writeMak & bootInfoAck);
Vernon Mauery38108d92024-03-11 12:53:55 -07002252 lg2::info("ipmiChassisSetSysBootOptions: bootInfo parameter set "
2253 "successfully");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002254 data.trailingOk = true;
2255 return ipmi::responseSuccess();
Patrick Venture0b02be92018-08-31 11:55:55 -07002256 }
Chen Yugang86ac4992021-06-25 08:14:52 +08002257 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2258 BootOptionParameter::bootFlagValidClr)
2259 {
2260 uint5_t bootFlagValidClr;
2261 uint3_t rsvd;
2262
2263 if (data.unpack(bootFlagValidClr, rsvd) != 0 || !data.fullyUnpacked())
2264 {
2265 return ipmi::responseReqDataLenInvalid();
2266 }
2267 if (rsvd)
2268 {
2269 return ipmi::responseInvalidFieldRequest();
2270 }
2271 // store boot flag valid bits clear value
2272 bootFlagValidBitClr = static_cast<uint8_t>(bootFlagValidClr);
Vernon Mauery38108d92024-03-11 12:53:55 -07002273 lg2::info(
Chen Yugang86ac4992021-06-25 08:14:52 +08002274 "ipmiChassisSetSysBootOptions: bootFlagValidBits parameter set "
Vernon Mauery38108d92024-03-11 12:53:55 -07002275 "successfully to {VALUE}",
2276 "VALUE", lg2::hex, bootFlagValidBitClr);
Chen Yugang86ac4992021-06-25 08:14:52 +08002277 return ipmi::responseSuccess();
2278 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002279 else
2280 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002281 if ((parameterSelector >= static_cast<uint7_t>(oemParmStart)) &&
2282 (parameterSelector <= static_cast<uint7_t>(oemParmEnd)))
2283 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002284 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2285 BootOptionParameter::opalNetworkSettings)
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002286 {
2287 ipmi::Cc ret = setHostNetworkData(data);
2288 if (ret != ipmi::ccSuccess)
2289 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002290 lg2::error("ipmiChassisSetSysBootOptions: Error in "
2291 "setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002292 data.trailingOk = true;
2293 return ipmi::response(ret);
2294 }
2295 data.trailingOk = true;
2296 return ipmi::responseSuccess();
2297 }
2298 else
2299 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002300 lg2::error(
2301 "ipmiChassisSetSysBootOptions: Unsupported param: {PARAM}",
2302 "PARAM", lg2::hex, static_cast<uint8_t>(parameterSelector));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002303 data.trailingOk = true;
2304 return ipmi::responseParmNotSupported();
2305 }
2306 }
2307 data.trailingOk = true;
2308 return ipmi::responseParmNotSupported();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002309 }
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002310 return ipmi::responseSuccess();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002311}
2312
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002313/** @brief implements Get POH counter command
2314 * @parameter
2315 * - none
2316 * @returns IPMI completion code plus response data
2317 * - minPerCount - Minutes per count
2318 * - counterReading - counter reading
2319 */
2320ipmi::RspType<uint8_t, // Minutes per count
2321 uint32_t // Counter reading
2322 >
2323 ipmiGetPOHCounter()
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002324{
2325 // sd_bus error
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002326 try
2327 {
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002328 return ipmi::responseSuccess(static_cast<uint8_t>(poh::minutesPerCount),
2329 getPOHCounter());
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002330 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002331 catch (const std::exception& e)
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002332 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002333 lg2::error("getPOHCounter error: {ERROR}", "ERROR", e);
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002334 return ipmi::responseUnspecifiedError();
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002335 }
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002336}
2337
Jason M. Billsbc996a32019-06-17 15:46:37 -07002338ipmi::RspType<uint3_t, // policy support
2339 uint5_t // reserved
2340 >
George Liude1420d2025-03-03 15:14:25 +08002341 ipmiChassisSetPowerRestorePolicy(ipmi::Context::ptr ctx, uint3_t policy,
2342 uint5_t reserved)
Yong Lic6713cf2018-09-12 12:35:13 +08002343{
Yong Lic6713cf2018-09-12 12:35:13 +08002344 power_policy::DbusValue value =
2345 power_policy::RestorePolicy::Policy::AlwaysOff;
2346
Jason M. Billsbc996a32019-06-17 15:46:37 -07002347 if (reserved || (policy > power_policy::noChange))
Yong Lic6713cf2018-09-12 12:35:13 +08002348 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002349 lg2::error("Reserved request parameter: {REQ}", "REQ", lg2::hex,
2350 static_cast<int>(policy));
Jason M. Billsbc996a32019-06-17 15:46:37 -07002351 return ipmi::responseInvalidFieldRequest();
Yong Lic6713cf2018-09-12 12:35:13 +08002352 }
2353
Vernon Mauerye278ead2018-10-09 09:23:43 -07002354 if (policy == power_policy::noChange)
Yong Lic6713cf2018-09-12 12:35:13 +08002355 {
2356 // just return the supported policy
Jason M. Billsbc996a32019-06-17 15:46:37 -07002357 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002358 }
2359
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05002360 for (const auto& it : power_policy::dbusToIpmi)
Yong Lic6713cf2018-09-12 12:35:13 +08002361 {
Vernon Mauerye278ead2018-10-09 09:23:43 -07002362 if (it.second == policy)
Yong Lic6713cf2018-09-12 12:35:13 +08002363 {
2364 value = it.first;
2365 break;
2366 }
2367 }
2368
2369 try
2370 {
James Feist225dec82019-11-26 16:25:06 -08002371 settings::Objects& objects = chassis::internal::cache::getObjects();
Yong Lic6713cf2018-09-12 12:35:13 +08002372 const settings::Path& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -08002373 objects.map.at(chassis::internal::powerRestoreIntf).front();
Yong Lic6713cf2018-09-12 12:35:13 +08002374
George Liude1420d2025-03-03 15:14:25 +08002375 boost::system::error_code ec = ipmi::setDbusProperty(
2376 ctx,
2377 objects.service(powerRestoreSetting,
2378 chassis::internal::powerRestoreIntf),
2379 powerRestoreSetting, chassis::internal::powerRestoreIntf,
2380 "PowerRestorePolicy", convertForMessage(value));
Vernon Mauerye278ead2018-10-09 09:23:43 -07002381 if (ec)
Yong Lic6713cf2018-09-12 12:35:13 +08002382 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002383 lg2::error("Unspecified Error");
Vernon Mauerye278ead2018-10-09 09:23:43 -07002384 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002385 }
2386 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002387 catch (const InternalFailure& e)
Yong Lic6713cf2018-09-12 12:35:13 +08002388 {
James Feist225dec82019-11-26 16:25:06 -08002389 chassis::internal::cache::objectsPtr.reset();
Yong Lic6713cf2018-09-12 12:35:13 +08002390 report<InternalFailure>();
Vernon Mauerye278ead2018-10-09 09:23:43 -07002391 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002392 }
2393
Jason M. Billsbc996a32019-06-17 15:46:37 -07002394 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002395}
2396
Patrick Williams1318a5e2024-08-16 15:19:54 -04002397ipmi::RspType<> ipmiSetFrontPanelButtonEnables(
2398 ipmi::Context::ptr ctx, bool disablePowerButton, bool disableResetButton,
2399 bool, bool, uint4_t)
Kuiying Wang21addc52019-01-04 10:50:21 +08002400{
2401 using namespace chassis::internal;
2402
2403 // set power button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002404 bool success = setButtonDisabled(ctx, powerButtonPath, powerButtonIntf,
2405 disablePowerButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002406
2407 // set reset button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002408 success &= setButtonDisabled(ctx, resetButtonPath, resetButtonIntf,
2409 disableResetButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002410
2411 if (!success)
2412 {
2413 // not all buttons were successfully set
2414 return ipmi::responseUnspecifiedError();
2415 }
2416 return ipmi::responseSuccess();
2417}
2418
George Liu5087b072025-03-11 19:28:17 +08002419void registerNetFnChassisFunctions()
Adriana Kobylak40814c62015-10-27 15:58:44 -05002420{
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05002421 createIdentifyTimer();
2422
Tom05732372016-09-06 17:21:23 +05302423 // Get Chassis Capabilities
anil kumar appana43263c62019-05-27 12:45:04 +00002424 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2425 ipmi::chassis::cmdGetChassisCapabilities,
2426 ipmi::Privilege::User, ipmiGetChassisCap);
Nan Li8d15fb42016-08-16 22:29:40 +08002427
Kuiying Wang21addc52019-01-04 10:50:21 +08002428 // Set Front Panel Button Enables
2429 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2430 ipmi::chassis::cmdSetFrontPanelButtonEnables,
2431 ipmi::Privilege::Admin,
2432 ipmiSetFrontPanelButtonEnables);
2433
Yong Liae4b0402018-11-02 11:12:14 +08002434 // Set Chassis Capabilities
anil kumar appana894d0222019-05-27 16:32:14 +00002435 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2436 ipmi::chassis::cmdSetChassisCapabilities,
2437 ipmi::Privilege::User, ipmiSetChassisCap);
Yong Liae4b0402018-11-02 11:12:14 +08002438
Tom05732372016-09-06 17:21:23 +05302439 // <Get System Boot Options>
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002440 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2441 ipmi::chassis::cmdGetSystemBootOptions,
2442 ipmi::Privilege::Operator,
2443 ipmiChassisGetSysBootOptions);
Adriana Kobylak40814c62015-10-27 15:58:44 -05002444
Tom05732372016-09-06 17:21:23 +05302445 // <Get Chassis Status>
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07002446 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2447 ipmi::chassis::cmdGetChassisStatus,
2448 ipmi::Privilege::User, ipmiGetChassisStatus);
Nan Lifdd8ec52016-08-28 03:57:40 +08002449
Vijay Khemka074f64d2020-03-03 15:08:43 -08002450 // <Chassis Get System Restart Cause>
2451 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2452 ipmi::chassis::cmdGetSystemRestartCause,
2453 ipmi::Privilege::User, ipmiGetSystemRestartCause);
2454
Tom05732372016-09-06 17:21:23 +05302455 // <Chassis Control>
anil kumar appanadafff5f2019-04-27 18:06:00 +00002456 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2457 ipmi::chassis::cmdChassisControl,
2458 ipmi::Privilege::Operator, ipmiChassisControl);
shgoupfd84fbbf2015-12-17 10:05:51 +08002459
Tom Joseph5110c122018-03-23 17:55:40 +05302460 // <Chassis Identify>
Vernon Mauery400cc782018-10-09 13:49:53 -07002461 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2462 ipmi::chassis::cmdChassisIdentify,
2463 ipmi::Privilege::Operator, ipmiChassisIdentify);
Tom Joseph5110c122018-03-23 17:55:40 +05302464
Tom05732372016-09-06 17:21:23 +05302465 // <Set System Boot Options>
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002466 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2467 ipmi::chassis::cmdSetSystemBootOptions,
2468 ipmi::Privilege::Operator,
2469 ipmiChassisSetSysBootOptions);
2470
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002471 // <Get POH Counter>
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002472 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2473 ipmi::chassis::cmdGetPohCounter,
2474 ipmi::Privilege::User, ipmiGetPOHCounter);
Yong Lic6713cf2018-09-12 12:35:13 +08002475
2476 // <Set Power Restore Policy>
Vernon Mauerye278ead2018-10-09 09:23:43 -07002477 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2478 ipmi::chassis::cmdSetPowerRestorePolicy,
2479 ipmi::Privilege::Operator,
2480 ipmiChassisSetPowerRestorePolicy);
vishwa36993272015-11-20 12:43:49 -06002481}