blob: a6a8062af65c855345d6b1bf8e7a0781e1cc1f26 [file] [log] [blame]
Patrick Venture46470a32018-09-07 19:26:25 -07001#include "config.h"
2
3#include "chassishandler.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07004
Patrick Venture0b02be92018-08-31 11:55:55 -07005#include <arpa/inet.h>
6#include <endian.h>
7#include <limits.h>
Patrick Venture0b02be92018-08-31 11:55:55 -07008#include <netinet/in.h>
Patrick Venture0b02be92018-08-31 11:55:55 -07009
Vernon Mauerye08fbff2019-04-03 09:19:34 -070010#include <ipmid/api.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070011#include <ipmid/types.hpp>
Vernon Mauery6a98fe72019-03-11 15:57:48 -070012#include <ipmid/utils.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070013#include <phosphor-logging/elog-errors.hpp>
Vernon Mauery38108d92024-03-11 12:53:55 -070014#include <phosphor-logging/lg2.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070015#include <sdbusplus/bus.hpp>
William A. Kennington III4c008022018-10-12 17:18:14 -070016#include <sdbusplus/message/types.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070017#include <sdbusplus/server/object.hpp>
Vernon Mauery1181af72018-10-08 12:05:00 -070018#include <sdbusplus/timer.hpp>
Vernon Mauerye278ead2018-10-09 09:23:43 -070019#include <settings.hpp>
Chau Ly8c1376c2024-01-05 07:22:10 +000020#include <xyz/openbmc_project/Chassis/Intrusion/client.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070021#include <xyz/openbmc_project/Common/error.hpp>
22#include <xyz/openbmc_project/Control/Boot/Mode/server.hpp>
23#include <xyz/openbmc_project/Control/Boot/Source/server.hpp>
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +030024#include <xyz/openbmc_project/Control/Boot/Type/server.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070025#include <xyz/openbmc_project/Control/Power/RestorePolicy/server.hpp>
Jason M. Billsad588bf2020-01-30 16:18:33 -080026#include <xyz/openbmc_project/State/Chassis/server.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070027#include <xyz/openbmc_project/State/Host/server.hpp>
28#include <xyz/openbmc_project/State/PowerOnHours/server.hpp>
29
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050030#include <array>
31#include <chrono>
32#include <cstring>
33#include <filesystem>
34#include <fstream>
35#include <future>
36#include <map>
37#include <sstream>
38#include <string>
39
Patrick Williams95655222023-12-05 12:45:02 -060040std::unique_ptr<sdbusplus::Timer> identifyTimer
Lei YU4b0ddb62019-01-25 16:43:50 +080041 __attribute__((init_priority(101)));
Marri Devender Rao6706c1c2018-05-14 00:29:38 -050042
Yong Lif4e38512019-05-21 14:46:55 +080043static ChassisIDState chassisIDState = ChassisIDState::reserved;
44
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000045constexpr size_t sizeVersion = 2;
Tom Joseph5110c122018-03-23 17:55:40 +053046constexpr size_t DEFAULT_IDENTIFY_TIME_OUT = 15;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +053047
Patrick Venture0b02be92018-08-31 11:55:55 -070048// PetiBoot-Specific
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000049static constexpr uint8_t netConfInitialBytes[] = {0x80, 0x21, 0x70, 0x62,
50 0x21, 0x00, 0x01, 0x06};
51static constexpr uint8_t oemParmStart = 96;
52static constexpr uint8_t oemParmEnd = 127;
Ratan Guptafd28dd72016-08-01 04:58:01 -050053
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000054static constexpr size_t cookieOffset = 1;
55static constexpr size_t versionOffset = 5;
56static constexpr size_t addrSizeOffset = 8;
57static constexpr size_t macOffset = 9;
58static constexpr size_t addrTypeOffset = 16;
59static constexpr size_t ipAddrOffset = 17;
ratagupta6f6bff2016-04-04 06:20:11 -050060
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000061namespace ipmi
62{
63constexpr Cc ccParmNotSupported = 0x80;
George Liuf5dd1022025-07-07 09:13:07 +080064constexpr Cc ccFailSetInProgress = 0x81;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000065
66static inline auto responseParmNotSupported()
67{
68 return response(ccParmNotSupported);
69}
George Liuf5dd1022025-07-07 09:13:07 +080070
71static inline auto responsefailSetInProgress()
72{
73 return response(ccFailSetInProgress);
74}
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +000075} // namespace ipmi
76
George Liu5087b072025-03-11 19:28:17 +080077void registerNetFnChassisFunctions() __attribute__((constructor));
Adriana Kobylak40814c62015-10-27 15:58:44 -050078
shgoupfd84fbbf2015-12-17 10:05:51 +080079// Host settings in dbus
80// Service name should be referenced by connection name got via object mapper
Patrick Venture0b02be92018-08-31 11:55:55 -070081const char* settings_object_name = "/org/openbmc/settings/host0";
82const char* settings_intf_name = "org.freedesktop.DBus.Properties";
Patrick Venture0b02be92018-08-31 11:55:55 -070083const char* identify_led_object_name =
Tom Joseph5110c122018-03-23 17:55:40 +053084 "/xyz/openbmc_project/led/groups/enclosure_identify";
shgoupfd84fbbf2015-12-17 10:05:51 +080085
Ratan Guptadcb10672017-07-10 10:33:50 +053086constexpr auto SETTINGS_ROOT = "/";
87constexpr auto SETTINGS_MATCH = "host0";
Ratan Guptadcb10672017-07-10 10:33:50 +053088
89constexpr auto IP_INTERFACE = "xyz.openbmc_project.Network.IP";
90constexpr auto MAC_INTERFACE = "xyz.openbmc_project.Network.MACAddress";
91
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -050092static constexpr auto chassisStateRoot = "/xyz/openbmc_project/state";
93static constexpr auto chassisPOHStateIntf =
Patrick Venture0b02be92018-08-31 11:55:55 -070094 "xyz.openbmc_project.State.PowerOnHours";
Patrick Williams7345ac42021-04-30 20:57:39 -050095static constexpr auto pohCounterProperty = "POHCounter";
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -050096static constexpr auto match = "chassis0";
Yong Liae4b0402018-11-02 11:12:14 +080097const static constexpr char chassisCapIntf[] =
98 "xyz.openbmc_project.Control.ChassisCapabilities";
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -080099const static constexpr char chassisIntrusionProp[] = "ChassisIntrusionEnabled";
100const static constexpr char chassisFrontPanelLockoutProp[] =
101 "ChassisFrontPanelLockoutEnabled";
102const static constexpr char chassisNMIProp[] = "ChassisNMIEnabled";
103const static constexpr char chassisPowerInterlockProp[] =
104 "ChassisPowerInterlockEnabled";
Yong Liae4b0402018-11-02 11:12:14 +0800105const static constexpr char chassisFRUDevAddrProp[] = "FRUDeviceAddress";
106const static constexpr char chassisSDRDevAddrProp[] = "SDRDeviceAddress";
107const static constexpr char chassisSELDevAddrProp[] = "SELDeviceAddress";
108const static constexpr char chassisSMDevAddrProp[] = "SMDeviceAddress";
109const static constexpr char chassisBridgeDevAddrProp[] = "BridgeDeviceAddress";
Yong Liae4b0402018-11-02 11:12:14 +0800110static constexpr uint8_t chassisCapAddrMask = 0xfe;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700111static constexpr const char* powerButtonIntf =
112 "xyz.openbmc_project.Chassis.Buttons.Power";
113static constexpr const char* powerButtonPath =
114 "/xyz/openbmc_project/Chassis/Buttons/Power0";
115static constexpr const char* resetButtonIntf =
116 "xyz.openbmc_project.Chassis.Buttons.Reset";
117static constexpr const char* resetButtonPath =
118 "/xyz/openbmc_project/Chassis/Buttons/Reset0";
Ratan Guptadcb10672017-07-10 10:33:50 +0530119
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530120// Phosphor Host State manager
Willy Tu523e2d12023-09-05 11:36:48 -0700121namespace State = sdbusplus::server::xyz::openbmc_project::state;
Vernon Mauery185b9f82018-07-20 10:52:36 -0700122namespace fs = std::filesystem;
Andrew Geisslera6e3a302017-05-31 19:34:00 -0500123
Ratan Guptadcb10672017-07-10 10:33:50 +0530124using namespace phosphor::logging;
Willy Tu523e2d12023-09-05 11:36:48 -0700125using namespace sdbusplus::error::xyz::openbmc_project::common;
126using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Chau Ly8c1376c2024-01-05 07:22:10 +0000127using Intrusion = sdbusplus::client::xyz::openbmc_project::chassis::Intrusion<>;
Alexander Hansen76bfd752025-11-07 17:04:32 +0100128using HostState = sdbusplus::common::xyz::openbmc_project::state::Host;
Alexander Hansen2260ff32025-11-07 17:12:52 +0100129using ChassisState = sdbusplus::common::xyz::openbmc_project::state::Chassis;
William A. Kennington III4c008022018-10-12 17:18:14 -0700130
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500131namespace chassis
132{
133namespace internal
134{
135
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300136constexpr auto bootSettingsPath = "/xyz/openbmc_project/control/host0/boot";
137constexpr auto bootEnableIntf = "xyz.openbmc_project.Object.Enable";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500138constexpr auto bootModeIntf = "xyz.openbmc_project.Control.Boot.Mode";
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300139constexpr auto bootTypeIntf = "xyz.openbmc_project.Control.Boot.Type";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500140constexpr auto bootSourceIntf = "xyz.openbmc_project.Control.Boot.Source";
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300141constexpr auto bootSettingsOneTimePath =
142 "/xyz/openbmc_project/control/host0/boot/one_time";
143constexpr auto bootOneTimeIntf = "xyz.openbmc_project.Object.Enable";
144
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500145constexpr auto powerRestoreIntf =
146 "xyz.openbmc_project.Control.Power.RestorePolicy";
Patrick Williams5d82f472022-07-22 19:26:53 -0500147sdbusplus::bus_t dbus(ipmid_get_sd_bus_connection());
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500148
149namespace cache
150{
151
James Feist225dec82019-11-26 16:25:06 -0800152std::unique_ptr<settings::Objects> objectsPtr = nullptr;
153
154settings::Objects& getObjects()
155{
156 if (objectsPtr == nullptr)
157 {
158 objectsPtr = std::make_unique<settings::Objects>(
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300159 dbus, std::vector<std::string>{bootModeIntf, bootTypeIntf,
160 bootSourceIntf, powerRestoreIntf});
James Feist225dec82019-11-26 16:25:06 -0800161 }
162 return *objectsPtr;
163}
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500164
165} // namespace cache
166} // namespace internal
167} // namespace chassis
168
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500169namespace poh
170{
171
172constexpr auto minutesPerCount = 60;
173
174} // namespace poh
175
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000176int getHostNetworkData(ipmi::message::Payload& payload)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500177{
Ratan Guptadcb10672017-07-10 10:33:50 +0530178 ipmi::PropertyMap properties;
179 int rc = 0;
Ratan Gupta8c31d232017-08-13 05:49:43 +0530180 uint8_t addrSize = ipmi::network::IPV4_ADDRESS_SIZE_BYTE;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500181
Ratan Guptadcb10672017-07-10 10:33:50 +0530182 try
183 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700184 // TODO There may be cases where an interface is implemented by multiple
Ratan Guptadcb10672017-07-10 10:33:50 +0530185 // objects,to handle such cases we are interested on that object
186 // which are on interested busname.
187 // Currenlty mapper doesn't give the readable busname(gives busid)
188 // so we can't match with bus name so giving some object specific info
189 // as SETTINGS_MATCH.
190 // Later SETTINGS_MATCH will be replaced with busname.
Ratan Guptafd28dd72016-08-01 04:58:01 -0500191
Patrick Williams5d82f472022-07-22 19:26:53 -0500192 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Guptadcb10672017-07-10 10:33:50 +0530193
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530194 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
195 SETTINGS_ROOT, SETTINGS_MATCH);
196
197 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
198 SETTINGS_ROOT, SETTINGS_MATCH);
199
Patrick Venture0b02be92018-08-31 11:55:55 -0700200 properties = ipmi::getAllDbusProperties(
201 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400202 auto variant = ipmi::getDbusProperty(
203 bus, macObjectInfo.second, macObjectInfo.first, MAC_INTERFACE,
204 "MACAddress");
Ratan Guptadcb10672017-07-10 10:33:50 +0530205
Vernon Maueryf442e112019-04-09 11:44:36 -0700206 auto ipAddress = std::get<std::string>(properties["Address"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530207
Vernon Maueryf442e112019-04-09 11:44:36 -0700208 auto gateway = std::get<std::string>(properties["Gateway"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530209
Vernon Maueryf442e112019-04-09 11:44:36 -0700210 auto prefix = std::get<uint8_t>(properties["PrefixLength"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530211
Patrick Venture0b02be92018-08-31 11:55:55 -0700212 uint8_t isStatic =
Vernon Maueryf442e112019-04-09 11:44:36 -0700213 (std::get<std::string>(properties["Origin"]) ==
Patrick Venture0b02be92018-08-31 11:55:55 -0700214 "xyz.openbmc_project.Network.IP.AddressOrigin.Static")
215 ? 1
216 : 0;
Ratan Guptad70f4532017-08-04 02:07:31 +0530217
Vernon Maueryf442e112019-04-09 11:44:36 -0700218 auto MACAddress = std::get<std::string>(variant);
Ratan Guptacc8feb42017-07-25 21:52:10 +0530219
Ratan Guptad70f4532017-08-04 02:07:31 +0530220 // it is expected here that we should get the valid data
221 // but we may also get the default values.
222 // Validation of the data is done by settings.
223 //
224 // if mac address is default mac address then
225 // don't send blank override.
Ratan Gupta8c31d232017-08-13 05:49:43 +0530226 if ((MACAddress == ipmi::network::DEFAULT_MAC_ADDRESS))
Ratan Guptad70f4532017-08-04 02:07:31 +0530227 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530228 rc = -1;
229 return rc;
230 }
231 // if addr is static then ipaddress,gateway,prefix
232 // should not be default one,don't send blank override.
233 if (isStatic)
234 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700235 if ((ipAddress == ipmi::network::DEFAULT_ADDRESS) ||
236 (gateway == ipmi::network::DEFAULT_ADDRESS) || (!prefix))
Ratan Guptad70f4532017-08-04 02:07:31 +0530237 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530238 rc = -1;
239 return rc;
240 }
241 }
242
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000243 std::string token;
244 std::stringstream ss(MACAddress);
Ratan Guptadcb10672017-07-10 10:33:50 +0530245
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000246 // First pack macOffset no of bytes in payload.
247 // Latter this PetiBoot-Specific data will be populated.
248 std::vector<uint8_t> payloadInitialBytes(macOffset);
249 payload.pack(payloadInitialBytes);
Ratan Guptadcb10672017-07-10 10:33:50 +0530250
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000251 while (std::getline(ss, token, ':'))
252 {
253 payload.pack(stoi(token, nullptr, 16));
254 }
255
256 payload.pack(0x00);
257
258 payload.pack(isStatic);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530259
Vernon Maueryf442e112019-04-09 11:44:36 -0700260 uint8_t addressFamily = (std::get<std::string>(properties["Type"]) ==
261 "xyz.openbmc_project.Network.IP.Protocol.IPv4")
262 ? AF_INET
263 : AF_INET6;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530264
Patrick Venture0b02be92018-08-31 11:55:55 -0700265 addrSize = (addressFamily == AF_INET)
266 ? ipmi::network::IPV4_ADDRESS_SIZE_BYTE
267 : ipmi::network::IPV6_ADDRESS_SIZE_BYTE;
Ratan Guptadcb10672017-07-10 10:33:50 +0530268
269 // ipaddress and gateway would be in IPv4 format
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000270 std::vector<uint8_t> addrInBinary(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530271 inet_pton(addressFamily, ipAddress.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000272 reinterpret_cast<void*>(addrInBinary.data()));
Ratan Guptadcb10672017-07-10 10:33:50 +0530273
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000274 payload.pack(addrInBinary);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530275
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000276 payload.pack(prefix);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530277
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000278 std::vector<uint8_t> gatewayDetails(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530279 inet_pton(addressFamily, gateway.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000280 reinterpret_cast<void*>(gatewayDetails.data()));
281 payload.pack(gatewayDetails);
Ratan Guptadcb10672017-07-10 10:33:50 +0530282 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500283 catch (const InternalFailure& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530284 {
285 commit<InternalFailure>();
Ratan Guptadcb10672017-07-10 10:33:50 +0530286 rc = -1;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500287 return rc;
288 }
289
Patrick Venture0b02be92018-08-31 11:55:55 -0700290 // PetiBoot-Specific
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000291 // If success then copy the first 9 bytes to the payload message
292 // payload first 2 bytes contain the parameter values. Skip that 2 bytes.
293 uint8_t skipFirstTwoBytes = 2;
294 size_t payloadSize = payload.size();
295 uint8_t* configDataStartingAddress = payload.data() + skipFirstTwoBytes;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500296
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000297 if (payloadSize < skipFirstTwoBytes + sizeof(netConfInitialBytes))
298 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700299 lg2::error("Invalid net config");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000300 rc = -1;
301 return rc;
302 }
303 std::copy(netConfInitialBytes,
304 netConfInitialBytes + sizeof(netConfInitialBytes),
305 configDataStartingAddress);
306
307 if (payloadSize < skipFirstTwoBytes + addrSizeOffset + sizeof(addrSize))
308 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700309 lg2::error("Invalid length of address size");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000310 rc = -1;
311 return rc;
312 }
313 std::copy(&addrSize, &(addrSize) + sizeof(addrSize),
314 configDataStartingAddress + addrSizeOffset);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530315
Ratan Guptafd28dd72016-08-01 04:58:01 -0500316#ifdef _IPMI_DEBUG_
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700317 std::printf("\n===Printing the IPMI Formatted Data========\n");
Ratan Guptafd28dd72016-08-01 04:58:01 -0500318
Ratan Guptadcb10672017-07-10 10:33:50 +0530319 for (uint8_t pos = 0; pos < index; pos++)
320 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000321 std::printf("%02x ", payloadStartingAddress[pos]);
Ratan Guptadcb10672017-07-10 10:33:50 +0530322 }
Ratan Guptafd28dd72016-08-01 04:58:01 -0500323#endif
324
Ratan Guptafd28dd72016-08-01 04:58:01 -0500325 return rc;
326}
327
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530328/** @brief convert IPv4 and IPv6 addresses from binary to text form.
329 * @param[in] family - IPv4/Ipv6
330 * @param[in] data - req data pointer.
331 * @param[in] offset - offset in the data.
332 * @param[in] addrSize - size of the data which needs to be read from offset.
333 * @returns address in text form.
334 */
335
Patrick Venture0b02be92018-08-31 11:55:55 -0700336std::string getAddrStr(uint8_t family, uint8_t* data, uint8_t offset,
337 uint8_t addrSize)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530338{
339 char ipAddr[INET6_ADDRSTRLEN] = {};
340
Patrick Venture0b02be92018-08-31 11:55:55 -0700341 switch (family)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530342 {
343 case AF_INET:
344 {
Patrick Williams99db6882024-12-18 11:20:17 -0500345 struct sockaddr_in addr4{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700346 std::memcpy(&addr4.sin_addr.s_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530347
Patrick Venture0b02be92018-08-31 11:55:55 -0700348 inet_ntop(AF_INET, &addr4.sin_addr, ipAddr, INET_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530349
350 break;
351 }
352 case AF_INET6:
353 {
Patrick Williams99db6882024-12-18 11:20:17 -0500354 struct sockaddr_in6 addr6{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700355 std::memcpy(&addr6.sin6_addr.s6_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530356
Patrick Venture0b02be92018-08-31 11:55:55 -0700357 inet_ntop(AF_INET6, &addr6.sin6_addr, ipAddr, INET6_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530358
359 break;
360 }
361 default:
362 {
363 return {};
364 }
365 }
366
367 return ipAddr;
368}
369
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000370ipmi::Cc setHostNetworkData(ipmi::message::Payload& data)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500371{
Ratan Guptadcb10672017-07-10 10:33:50 +0530372 using namespace std::string_literals;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000373 std::string hostNetworkConfig;
374 std::string mac("00:00:00:00:00:00");
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530375 std::string ipAddress, gateway;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000376 std::string addrOrigin{0};
Patrick Venture0b02be92018-08-31 11:55:55 -0700377 uint8_t addrSize{0};
Ratan Guptadcb10672017-07-10 10:33:50 +0530378 std::string addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530379 "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP";
Patrick Venture0b02be92018-08-31 11:55:55 -0700380 std::string addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv4";
381 uint8_t prefix{0};
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530382 uint8_t family = AF_INET;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500383
Patrick Venture0b02be92018-08-31 11:55:55 -0700384 // cookie starts from second byte
Ratan Guptafd28dd72016-08-01 04:58:01 -0500385 // version starts from sixth byte
386
Ratan Guptadcb10672017-07-10 10:33:50 +0530387 try
Ratan Guptafd28dd72016-08-01 04:58:01 -0500388 {
Ratan Guptadcb10672017-07-10 10:33:50 +0530389 do
390 {
391 // cookie == 0x21 0x70 0x62 0x21
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000392 data.trailingOk = true;
393 auto msgLen = data.size();
394 std::vector<uint8_t> msgPayloadBytes(msgLen);
395 if (data.unpack(msgPayloadBytes) != 0 || !data.fullyUnpacked())
Ratan Guptadcb10672017-07-10 10:33:50 +0530396 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700397 lg2::error("Error in unpacking message of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000398 return ipmi::ccReqDataLenInvalid;
399 }
400
401 uint8_t* msgPayloadStartingPos = msgPayloadBytes.data();
402 constexpr size_t cookieSize = 4;
403 if (msgLen < cookieOffset + cookieSize)
404 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700405 lg2::error("Error in cookie getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000406 return ipmi::ccReqDataLenInvalid;
407 }
408 if (std::equal(msgPayloadStartingPos + cookieOffset,
409 msgPayloadStartingPos + cookieOffset + cookieSize,
410 (netConfInitialBytes + cookieOffset)) != 0)
411 {
412 // all cookie == 0
413 if (std::all_of(msgPayloadStartingPos + cookieOffset,
414 msgPayloadStartingPos + cookieOffset +
415 cookieSize,
416 [](int i) { return i == 0; }) == true)
Ratan Guptadcb10672017-07-10 10:33:50 +0530417 {
418 // need to zero out the network settings.
419 break;
420 }
421
Vernon Mauery38108d92024-03-11 12:53:55 -0700422 lg2::error("Invalid Cookie");
Ratan Guptadcb10672017-07-10 10:33:50 +0530423 elog<InternalFailure>();
424 }
425
426 // vesion == 0x00 0x01
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000427 if (msgLen < versionOffset + sizeVersion)
Ratan Guptadcb10672017-07-10 10:33:50 +0530428 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700429 lg2::error("Error in version getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000430 return ipmi::ccReqDataLenInvalid;
431 }
432 if (std::equal(msgPayloadStartingPos + versionOffset,
433 msgPayloadStartingPos + versionOffset + sizeVersion,
434 (netConfInitialBytes + versionOffset)) != 0)
435 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700436 lg2::error("Invalid Version");
Ratan Guptadcb10672017-07-10 10:33:50 +0530437 elog<InternalFailure>();
438 }
439
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000440 if (msgLen < macOffset + 6)
441 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700442 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000443 "Error in mac address getting of setHostNetworkData");
444 return ipmi::ccReqDataLenInvalid;
445 }
446 std::stringstream result;
447 std::copy((msgPayloadStartingPos + macOffset),
448 (msgPayloadStartingPos + macOffset + 5),
449 std::ostream_iterator<int>(result, ":"));
450 mac = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530451
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000452 if (msgLen < addrTypeOffset + sizeof(decltype(addrOrigin)))
453 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700454 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000455 "Error in original address getting of setHostNetworkData");
456 return ipmi::ccReqDataLenInvalid;
457 }
458 std::copy(msgPayloadStartingPos + addrTypeOffset,
459 msgPayloadStartingPos + addrTypeOffset +
460 sizeof(decltype(addrOrigin)),
461 std::ostream_iterator<int>(result, ""));
462 addrOrigin = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530463
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000464 if (!addrOrigin.empty())
Ratan Guptadcb10672017-07-10 10:33:50 +0530465 {
466 addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530467 "xyz.openbmc_project.Network.IP.AddressOrigin.Static";
Ratan Guptadcb10672017-07-10 10:33:50 +0530468 }
469
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000470 if (msgLen < addrSizeOffset + sizeof(decltype(addrSize)))
471 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700472 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000473 "Error in address size getting of setHostNetworkData");
474 return ipmi::ccReqDataLenInvalid;
475 }
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530476 // Get the address size
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000477 std::copy(msgPayloadStartingPos + addrSizeOffset,
478 (msgPayloadStartingPos + addrSizeOffset +
479 sizeof(decltype(addrSize))),
480 &addrSize);
Ratan Guptadcb10672017-07-10 10:33:50 +0530481
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000482 uint8_t prefixOffset = ipAddrOffset + addrSize;
483 if (msgLen < prefixOffset + sizeof(decltype(prefix)))
484 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700485 lg2::error("Error in prefix getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000486 return ipmi::ccReqDataLenInvalid;
487 }
William A. Kennington III4c521022023-07-28 13:07:30 -0700488 // std::copy(msgPayloadStartingPos + prefixOffset,
489 // msgPayloadStartingPos + prefixOffset +
490 // sizeof(decltype(prefix)),
491 // &prefix);
492 // Workaround compiler misdetecting out of bounds memcpy
493 prefix = msgPayloadStartingPos[prefixOffset];
Ratan Guptadcb10672017-07-10 10:33:50 +0530494
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530495 uint8_t gatewayOffset = prefixOffset + sizeof(decltype(prefix));
Ratan Gupta8c31d232017-08-13 05:49:43 +0530496 if (addrSize != ipmi::network::IPV4_ADDRESS_SIZE_BYTE)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530497 {
498 addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv6";
499 family = AF_INET6;
500 }
501
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000502 if (msgLen < ipAddrOffset + addrSize)
503 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700504 lg2::error("Error in IP address getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000505 return ipmi::ccReqDataLenInvalid;
506 }
507 ipAddress = getAddrStr(family, msgPayloadStartingPos, ipAddrOffset,
508 addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530509
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000510 if (msgLen < gatewayOffset + addrSize)
511 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700512 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000513 "Error in gateway address getting of setHostNetworkData");
514 return ipmi::ccReqDataLenInvalid;
515 }
516 gateway = getAddrStr(family, msgPayloadStartingPos, gatewayOffset,
517 addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530518
Patrick Venture0b02be92018-08-31 11:55:55 -0700519 } while (0);
Ratan Guptadcb10672017-07-10 10:33:50 +0530520
Patrick Venture0b02be92018-08-31 11:55:55 -0700521 // Cookie == 0 or it is a valid cookie
Patrick Williams1318a5e2024-08-16 15:19:54 -0400522 hostNetworkConfig +=
523 "ipaddress="s + ipAddress + ",prefix="s + std::to_string(prefix) +
524 ",gateway="s + gateway + ",mac="s + mac + ",addressOrigin="s +
525 addressOrigin;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500526
Patrick Williams5d82f472022-07-22 19:26:53 -0500527 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530528
529 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
530 SETTINGS_ROOT, SETTINGS_MATCH);
531 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
532 SETTINGS_ROOT, SETTINGS_MATCH);
Ratan Guptadcb10672017-07-10 10:33:50 +0530533 // set the dbus property
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530534 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700535 IP_INTERFACE, "Address", std::string(ipAddress));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530536 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700537 IP_INTERFACE, "PrefixLength", prefix);
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530538 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700539 IP_INTERFACE, "Origin", addressOrigin);
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530540 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700541 IP_INTERFACE, "Gateway", std::string(gateway));
542 ipmi::setDbusProperty(
543 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE, "Type",
544 std::string("xyz.openbmc_project.Network.IP.Protocol.IPv4"));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530545 ipmi::setDbusProperty(bus, macObjectInfo.second, macObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700546 MAC_INTERFACE, "MACAddress", std::string(mac));
Ratan Guptafd28dd72016-08-01 04:58:01 -0500547
Vernon Mauery38108d92024-03-11 12:53:55 -0700548 lg2::debug("Network configuration changed: {NETWORKCONFIG}",
549 "NETWORKCONFIG", hostNetworkConfig);
Ratan Guptafd28dd72016-08-01 04:58:01 -0500550 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500551 catch (const sdbusplus::exception_t& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530552 {
553 commit<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -0700554 lg2::error("Error in ipmiChassisSetSysBootOptions call");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000555 return ipmi::ccUnspecifiedError;
Ratan Guptadcb10672017-07-10 10:33:50 +0530556 }
557
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000558 return ipmi::ccSuccess;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500559}
560
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500561uint32_t getPOHCounter()
562{
Patrick Williams5d82f472022-07-22 19:26:53 -0500563 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500564
Patrick Williams1318a5e2024-08-16 15:19:54 -0400565 auto chassisStateObj =
566 ipmi::getDbusObject(bus, chassisPOHStateIntf, chassisStateRoot, match);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500567
Patrick Williams1318a5e2024-08-16 15:19:54 -0400568 auto service =
569 ipmi::getService(bus, chassisPOHStateIntf, chassisStateObj.first);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500570
Patrick Williams1318a5e2024-08-16 15:19:54 -0400571 auto propValue =
572 ipmi::getDbusProperty(bus, service, chassisStateObj.first,
573 chassisPOHStateIntf, pohCounterProperty);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500574
Vernon Maueryf442e112019-04-09 11:44:36 -0700575 return std::get<uint32_t>(propValue);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500576}
577
anil kumar appana43263c62019-05-27 12:45:04 +0000578/** @brief Implements the get chassis capabilities command
579 *
580 * @returns IPMI completion code plus response data
581 * chassisCapFlags - chassis capability flag
582 * chassisFRUInfoDevAddr - chassis FRU info Device Address
583 * chassisSDRDevAddr - chassis SDR device address
584 * chassisSELDevAddr - chassis SEL device address
585 * chassisSMDevAddr - chassis system management device address
586 * chassisBridgeDevAddr - chassis bridge device address
587 */
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800588ipmi::RspType<bool, // chassis intrusion sensor
589 bool, // chassis Front panel lockout
590 bool, // chassis NMI
591 bool, // chassis power interlock
592 uint4_t, // reserved
anil kumar appana43263c62019-05-27 12:45:04 +0000593 uint8_t, // chassis FRU info Device Address
594 uint8_t, // chassis SDR device address
595 uint8_t, // chassis SEL device address
596 uint8_t, // chassis system management device address
597 uint8_t // chassis bridge device address
598 >
599 ipmiGetChassisCap()
Nan Li8d15fb42016-08-16 22:29:40 +0800600{
anil kumar appana43263c62019-05-27 12:45:04 +0000601 ipmi::PropertyMap properties;
Yong Liae4b0402018-11-02 11:12:14 +0800602 try
603 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500604 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nan Li8d15fb42016-08-16 22:29:40 +0800605
Yong Liae4b0402018-11-02 11:12:14 +0800606 ipmi::DbusObjectInfo chassisCapObject =
607 ipmi::getDbusObject(bus, chassisCapIntf);
Nan Li8d15fb42016-08-16 22:29:40 +0800608
Yong Liae4b0402018-11-02 11:12:14 +0800609 // capabilities flags
610 // [7..4] - reserved
611 // [3] – 1b = provides power interlock (IPM 1.5)
612 // [2] – 1b = provides Diagnostic Interrupt (FP NMI)
613 // [1] – 1b = provides “Front Panel Lockout” (indicates that the chassis
614 // has capabilities
615 // to lock out external power control and reset button or
616 // front panel interfaces and/or detect tampering with those
617 // interfaces).
618 // [0] -1b = Chassis provides intrusion (physical security) sensor.
619 // set to default value 0x0.
Nan Li8d15fb42016-08-16 22:29:40 +0800620
Patrick Williams1318a5e2024-08-16 15:19:54 -0400621 properties =
622 ipmi::getAllDbusProperties(bus, chassisCapObject.second,
623 chassisCapObject.first, chassisCapIntf);
Yong Liae4b0402018-11-02 11:12:14 +0800624 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500625 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800626 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700627 lg2::error("Failed to fetch Chassis Capability properties: {ERROR}",
628 "ERROR", e);
anil kumar appana43263c62019-05-27 12:45:04 +0000629 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800630 }
631
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800632 bool* chassisIntrusionFlag =
633 std::get_if<bool>(&properties[chassisIntrusionProp]);
634 if (chassisIntrusionFlag == nullptr)
anil kumar appana43263c62019-05-27 12:45:04 +0000635 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700636 lg2::error("Error to get chassis Intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800637 return ipmi::responseUnspecifiedError();
638 }
639 bool* chassisFrontPanelFlag =
640 std::get_if<bool>(&properties[chassisFrontPanelLockoutProp]);
641 if (chassisFrontPanelFlag == nullptr)
642 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700643 lg2::error("Error to get chassis intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800644 return ipmi::responseUnspecifiedError();
645 }
646 bool* chassisNMIFlag = std::get_if<bool>(&properties[chassisNMIProp]);
647 if (chassisNMIFlag == nullptr)
648 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700649 lg2::error("Error to get chassis NMI flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800650 return ipmi::responseUnspecifiedError();
651 }
652 bool* chassisPowerInterlockFlag =
653 std::get_if<bool>(&properties[chassisPowerInterlockProp]);
654 if (chassisPowerInterlockFlag == nullptr)
655 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700656 lg2::error("Error to get chassis power interlock flags");
anil kumar appana43263c62019-05-27 12:45:04 +0000657 return ipmi::responseUnspecifiedError();
658 }
659 uint8_t* chassisFRUInfoDevAddr =
660 std::get_if<uint8_t>(&properties[chassisFRUDevAddrProp]);
661 if (chassisFRUInfoDevAddr == nullptr)
662 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700663 lg2::error("Error to get chassis FRU info device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000664 return ipmi::responseUnspecifiedError();
665 }
666 uint8_t* chassisSDRDevAddr =
667 std::get_if<uint8_t>(&properties[chassisSDRDevAddrProp]);
668 if (chassisSDRDevAddr == nullptr)
669 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700670 lg2::error("Error to get chassis SDR device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000671 return ipmi::responseUnspecifiedError();
672 }
673 uint8_t* chassisSELDevAddr =
674 std::get_if<uint8_t>(&properties[chassisSELDevAddrProp]);
675 if (chassisSELDevAddr == nullptr)
676 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700677 lg2::error("Error to get chassis SEL device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000678 return ipmi::responseUnspecifiedError();
679 }
680 uint8_t* chassisSMDevAddr =
681 std::get_if<uint8_t>(&properties[chassisSMDevAddrProp]);
682 if (chassisSMDevAddr == nullptr)
683 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700684 lg2::error("Error to get chassis SM device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000685 return ipmi::responseUnspecifiedError();
686 }
687 uint8_t* chassisBridgeDevAddr =
688 std::get_if<uint8_t>(&properties[chassisBridgeDevAddrProp]);
689 if (chassisBridgeDevAddr == nullptr)
690 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700691 lg2::error("Error to get chassis bridge device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000692 return ipmi::responseUnspecifiedError();
693 }
694
Patrick Williams1318a5e2024-08-16 15:19:54 -0400695 return ipmi::responseSuccess(
696 *chassisIntrusionFlag, *chassisFrontPanelFlag, *chassisNMIFlag,
697 *chassisPowerInterlockFlag, 0, *chassisFRUInfoDevAddr,
698 *chassisSDRDevAddr, *chassisSELDevAddr, *chassisSMDevAddr,
699 *chassisBridgeDevAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800700}
701
anil kumar appana894d0222019-05-27 16:32:14 +0000702/** @brief implements set chassis capalibities command
703 * @param intrusion - chassis intrusion
704 * @param fpLockout - frontpannel lockout
705 * @param reserved1 - skip one bit
706 * @param fruDeviceAddr - chassis FRU info Device Address
707 * @param sdrDeviceAddr - chassis SDR device address
708 * @param selDeviceAddr - chassis SEL device address
709 * @param smDeviceAddr - chassis system management device address
710 * @param bridgeDeviceAddr - chassis bridge device address
711 *
712 * @returns IPMI completion code
713 */
Patrick Williams1318a5e2024-08-16 15:19:54 -0400714ipmi::RspType<> ipmiSetChassisCap(
715 bool intrusion, bool fpLockout, uint6_t reserved1,
anil kumar appana894d0222019-05-27 16:32:14 +0000716
Patrick Williams1318a5e2024-08-16 15:19:54 -0400717 uint8_t fruDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000718
Patrick Williams1318a5e2024-08-16 15:19:54 -0400719 uint8_t sdrDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000720
Patrick Williams1318a5e2024-08-16 15:19:54 -0400721 uint8_t selDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000722
Patrick Williams1318a5e2024-08-16 15:19:54 -0400723 uint8_t smDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000724
NikhilaDande530239b2025-09-30 09:09:40 +0530725 std::optional<uint8_t> bridgeDeviceAddr)
Yong Liae4b0402018-11-02 11:12:14 +0800726{
Yong Liae4b0402018-11-02 11:12:14 +0800727 // check input data
anil kumar appana894d0222019-05-27 16:32:14 +0000728 if (reserved1 != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800729 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700730 lg2::error("Unsupported request parameter");
anil kumar appana894d0222019-05-27 16:32:14 +0000731 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800732 }
733
anil kumar appana894d0222019-05-27 16:32:14 +0000734 if ((fruDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800735 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700736 lg2::error("Unsupported request parameter(FRU Addr) for REQ={REQ}",
737 "REQ", lg2::hex, fruDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000738 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800739 }
anil kumar appana894d0222019-05-27 16:32:14 +0000740 if ((sdrDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800741 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700742 lg2::error("Unsupported request parameter(SDR Addr) for REQ={REQ}",
743 "REQ", lg2::hex, sdrDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000744 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800745 }
746
anil kumar appana894d0222019-05-27 16:32:14 +0000747 if ((selDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800748 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700749 lg2::error("Unsupported request parameter(SEL Addr) for REQ={REQ}",
750 "REQ", lg2::hex, selDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000751 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800752 }
753
anil kumar appana894d0222019-05-27 16:32:14 +0000754 if ((smDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800755 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700756 lg2::error("Unsupported request parameter(SM Addr) for REQ={REQ}",
757 "REQ", lg2::hex, smDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000758 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800759 }
760
NikhilaDande530239b2025-09-30 09:09:40 +0530761 if (bridgeDeviceAddr.has_value())
Yong Liae4b0402018-11-02 11:12:14 +0800762 {
NikhilaDande530239b2025-09-30 09:09:40 +0530763 if ((bridgeDeviceAddr.value() & ~chassisCapAddrMask) != 0)
764 {
765 lg2::error(
766 "Unsupported request parameter(Bridge Addr) for REQ={REQ}",
767 "REQ", lg2::hex, bridgeDeviceAddr.value());
768 return ipmi::responseInvalidFieldRequest();
769 }
Yong Liae4b0402018-11-02 11:12:14 +0800770 }
771
772 try
773 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500774 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Yong Liae4b0402018-11-02 11:12:14 +0800775 ipmi::DbusObjectInfo chassisCapObject =
776 ipmi::getDbusObject(bus, chassisCapIntf);
777
778 ipmi::setDbusProperty(bus, chassisCapObject.second,
779 chassisCapObject.first, chassisCapIntf,
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800780 chassisIntrusionProp, intrusion);
781
782 ipmi::setDbusProperty(bus, chassisCapObject.second,
783 chassisCapObject.first, chassisCapIntf,
784 chassisFrontPanelLockoutProp, fpLockout);
Yong Liae4b0402018-11-02 11:12:14 +0800785
786 ipmi::setDbusProperty(bus, chassisCapObject.second,
787 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000788 chassisFRUDevAddrProp, fruDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800789
790 ipmi::setDbusProperty(bus, chassisCapObject.second,
791 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000792 chassisSDRDevAddrProp, sdrDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800793
794 ipmi::setDbusProperty(bus, chassisCapObject.second,
795 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000796 chassisSELDevAddrProp, selDeviceAddr);
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 chassisSMDevAddrProp, smDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800801
NikhilaDande530239b2025-09-30 09:09:40 +0530802 if (bridgeDeviceAddr.has_value())
803 {
804 ipmi::setDbusProperty(bus, chassisCapObject.second,
805 chassisCapObject.first, chassisCapIntf,
806 chassisBridgeDevAddrProp,
807 bridgeDeviceAddr.value());
808 }
Yong Liae4b0402018-11-02 11:12:14 +0800809 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500810 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800811 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700812 lg2::error("Failed to set chassis capability properties: {ERR}", "ERR",
813 e);
anil kumar appana894d0222019-05-27 16:32:14 +0000814 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800815 }
anil kumar appana894d0222019-05-27 16:32:14 +0000816 return ipmi::responseSuccess();
Nan Li8d15fb42016-08-16 22:29:40 +0800817}
818
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530819//------------------------------------------
820// Calls into Host State Manager Dbus object
821//------------------------------------------
Jason M. Bills664e1c32020-01-30 16:02:39 -0800822int initiateHostStateTransition(ipmi::Context::ptr& ctx,
823 State::Host::Transition transition)
vishwa36993272015-11-20 12:43:49 -0600824{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500825 // OpenBMC Host State Manager dbus framework
Alexander Hansen76bfd752025-11-07 17:04:32 +0100826 const auto hostStatePath =
827 std::format("{}/{}", HostState::namespace_path::value, "host0");
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530828
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500829 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700830 auto request =
831 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
832 transition);
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530833
Jason M. Bills664e1c32020-01-30 16:02:39 -0800834 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400835 boost::system::error_code ec =
Alexander Hansen76bfd752025-11-07 17:04:32 +0100836 ipmi::getService(ctx, HostState::interface, hostStatePath, service);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800837
838 if (!ec)
839 {
Alexander Hansen76bfd752025-11-07 17:04:32 +0100840 ec = ipmi::setDbusProperty(
841 ctx, service, hostStatePath, HostState::interface,
842 HostState::property_names::requested_host_transition, request);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800843 }
844 if (ec)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500845 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700846 lg2::error(
847 "Failed to initiate transition for request {REQUEST}: {EXCEPTION}",
848 "REQUEST", request, "EXCEPTION", ec.message());
Jason M. Bills664e1c32020-01-30 16:02:39 -0800849 return -1;
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500850 }
Vernon Mauery38108d92024-03-11 12:53:55 -0700851 lg2::info(
852 "Transition request {REQUEST} initiated successfully by user {USERID}",
853 "REQUEST", request, "USERID", ctx->userId);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800854 return 0;
vishwa36993272015-11-20 12:43:49 -0600855}
856
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800857//------------------------------------------
Jason M. Billsad588bf2020-01-30 16:18:33 -0800858// Calls into Chassis State Manager Dbus object
859//------------------------------------------
860int initiateChassisStateTransition(ipmi::Context::ptr& ctx,
861 State::Chassis::Transition transition)
862{
863 // OpenBMC Chassis State Manager dbus framework
864 constexpr auto chassisStatePath = "/xyz/openbmc_project/state/chassis0";
Jason M. Billsad588bf2020-01-30 16:18:33 -0800865
866 std::string service;
Alexander Hansen2260ff32025-11-07 17:12:52 +0100867 boost::system::error_code ec = ipmi::getService(
868 ctx, ChassisState::interface, chassisStatePath, service);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800869
870 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700871 auto request =
872 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
873 transition);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800874
875 if (!ec)
876 {
Alexander Hansen2260ff32025-11-07 17:12:52 +0100877 ec = ipmi::setDbusProperty(
878 ctx, service, chassisStatePath, ChassisState::interface,
879 ChassisState::property_names::requested_power_transition, request);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800880 }
881 if (ec)
882 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700883 lg2::error("Failed to initiate transition {REQUEST}: {EXCEPTION}",
884 "REQUEST", request, "EXCEPTION", ec.message());
885
Jason M. Billsad588bf2020-01-30 16:18:33 -0800886 return -1;
887 }
888
889 return 0;
890}
891
892//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000893// Trigger an NMI on the host via dbus
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800894//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000895static int doNmi(ipmi::Context::ptr& ctx)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800896{
Zev Weiss337a0972024-03-08 08:31:15 +0000897 constexpr const char* nmiIntfName = "xyz.openbmc_project.Control.Host.NMI";
898 ipmi::DbusObjectInfo nmiObj{};
899 boost::system::error_code ec;
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800900
Zev Weiss337a0972024-03-08 08:31:15 +0000901 ec = ipmi::getDbusObject(ctx, nmiIntfName, nmiObj);
Vernon Mauery9bb4a382021-11-05 12:46:19 -0700902 if (ec)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800903 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700904 lg2::error("Failed to find NMI service: {ERROR}", "ERROR",
905 ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000906 return -1;
907 }
908
George Liude1420d2025-03-03 15:14:25 +0800909 ec = ipmi::callDbusMethod(ctx, nmiObj.second, nmiObj.first, nmiIntfName,
910 "NMI");
Zev Weiss337a0972024-03-08 08:31:15 +0000911 if (ec)
912 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700913 lg2::error("NMI call failed: {ERROR}", "ERROR", ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000914 elog<InternalFailure>();
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800915 return -1;
916 }
917
918 return 0;
919}
920
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500921namespace power_policy
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500922{
Nan Lifdd8ec52016-08-28 03:57:40 +0800923
Willy Tu523e2d12023-09-05 11:36:48 -0700924using namespace sdbusplus::server::xyz::openbmc_project::control::power;
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500925using IpmiValue = uint8_t;
926using DbusValue = RestorePolicy::Policy;
Nan Lifdd8ec52016-08-28 03:57:40 +0800927
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700928const std::map<DbusValue, IpmiValue> dbusToIpmi = {
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500929 {RestorePolicy::Policy::AlwaysOff, 0x00},
930 {RestorePolicy::Policy::Restore, 0x01},
George Liue561d3e2024-02-04 15:19:30 +0800931 {RestorePolicy::Policy::AlwaysOn, 0x02},
932 {RestorePolicy::Policy::None, 0x03}};
Nan Lifdd8ec52016-08-28 03:57:40 +0800933
Yong Lic6713cf2018-09-12 12:35:13 +0800934static constexpr uint8_t noChange = 0x03;
935static constexpr uint8_t allSupport = 0x01 | 0x02 | 0x04;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700936
937/* helper function for Get Chassis Status Command
938 */
939std::optional<uint2_t> getPowerRestorePolicy()
940{
941 uint2_t restorePolicy = 0;
942 using namespace chassis::internal;
943
James Feist225dec82019-11-26 16:25:06 -0800944 settings::Objects& objects = cache::getObjects();
945
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700946 try
947 {
948 const auto& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -0800949 objects.map.at(powerRestoreIntf).front();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700950 ipmi::Value result = ipmi::getDbusProperty(
951 *getSdBus(),
James Feist225dec82019-11-26 16:25:06 -0800952 objects.service(powerRestoreSetting, powerRestoreIntf).c_str(),
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700953 powerRestoreSetting.c_str(), powerRestoreIntf,
954 "PowerRestorePolicy");
955 auto powerRestore = RestorePolicy::convertPolicyFromString(
956 std::get<std::string>(result));
957 restorePolicy = dbusToIpmi.at(powerRestore);
958 }
959 catch (const std::exception& e)
960 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700961 lg2::error(
962 "Failed to fetch pgood property ({PATH}/{INTERFACE}): {ERROR}",
963 "PATH", objects.map.at(powerRestoreIntf).front(), "INTERFACE",
964 powerRestoreIntf, "ERROR", e);
James Feist225dec82019-11-26 16:25:06 -0800965 cache::objectsPtr.reset();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700966 return std::nullopt;
967 }
968 return std::make_optional(restorePolicy);
969}
970
971/*
972 * getPowerStatus
973 * helper function for Get Chassis Status Command
974 * return - optional value for pgood (no value on error)
975 */
976std::optional<bool> getPowerStatus()
977{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700978 bool powerGood = false;
979 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus();
980 try
981 {
Jason M. Bills3de424c2019-05-21 09:57:16 -0700982 constexpr const char* chassisStatePath =
983 "/xyz/openbmc_project/state/chassis0";
Patrick Williams1318a5e2024-08-16 15:19:54 -0400984 auto service =
Alexander Hansen2260ff32025-11-07 17:12:52 +0100985 ipmi::getService(*busp, ChassisState::interface, chassisStatePath);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700986
Alexander Hansen2260ff32025-11-07 17:12:52 +0100987 ipmi::Value powerState = ipmi::getDbusProperty(
988 *busp, service, chassisStatePath, ChassisState::interface,
989 ChassisState::property_names::current_power_state);
Chau Lyee3983b2024-01-05 07:33:45 +0000990 std::string powerStateStr = std::get<std::string>(powerState);
991 if (powerStateStr.ends_with(".On") ||
992 powerStateStr.ends_with(".TransitioningToOff"))
993 {
994 powerGood = true;
995 }
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700996 }
997 catch (const std::exception& e)
998 {
999 try
1000 {
1001 // FIXME: some legacy modules use the older path; try that next
1002 constexpr const char* legacyPwrCtrlObj =
1003 "/org/openbmc/control/power0";
1004 constexpr const char* legacyPwrCtrlIntf =
1005 "org.openbmc.control.Power";
Patrick Williams1318a5e2024-08-16 15:19:54 -04001006 auto service =
1007 ipmi::getService(*busp, legacyPwrCtrlIntf, legacyPwrCtrlObj);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001008
1009 ipmi::Value variant = ipmi::getDbusProperty(
1010 *busp, service, legacyPwrCtrlObj, legacyPwrCtrlIntf, "pgood");
1011 powerGood = static_cast<bool>(std::get<int>(variant));
1012 }
1013 catch (const std::exception& e)
1014 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001015 lg2::error("Failed to fetch pgood property: {ERROR}", "ERROR", e);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001016 return std::nullopt;
1017 }
1018 }
1019 return std::make_optional(powerGood);
1020}
1021
Yong Li70ce7352019-05-16 21:15:27 +08001022/*
1023 * getACFailStatus
1024 * helper function for Get Chassis Status Command
1025 * return - bool value for ACFail (false on error)
1026 */
1027bool getACFailStatus()
1028{
1029 constexpr const char* powerControlObj =
1030 "/xyz/openbmc_project/Chassis/Control/Power0";
1031 constexpr const char* powerControlIntf =
1032 "xyz.openbmc_project.Chassis.Control.Power";
1033 bool acFail = false;
1034 std::shared_ptr<sdbusplus::asio::connection> bus = getSdBus();
1035 try
1036 {
Patrick Williams1318a5e2024-08-16 15:19:54 -04001037 auto service =
1038 ipmi::getService(*bus, powerControlIntf, powerControlObj);
Yong Li70ce7352019-05-16 21:15:27 +08001039
1040 ipmi::Value variant = ipmi::getDbusProperty(
1041 *bus, service, powerControlObj, powerControlIntf, "PFail");
1042 acFail = std::get<bool>(variant);
1043 }
1044 catch (const std::exception& e)
1045 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001046 lg2::error(
Konstantin Aladyshev37de2e12025-01-29 11:49:26 +03001047 "Failed to fetch PFail property ({PATH}/{INTERFACE}): {ERROR}",
Vernon Mauery38108d92024-03-11 12:53:55 -07001048 "PATH", powerControlObj, "INTERFACE", powerControlIntf, "ERROR", e);
Yong Li70ce7352019-05-16 21:15:27 +08001049 }
1050 return acFail;
1051}
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001052} // namespace power_policy
Nan Lifdd8ec52016-08-28 03:57:40 +08001053
Patrick Williams615a14e2025-04-07 17:07:24 -04001054static std::optional<bool> getButtonDisabled(ipmi::Context::ptr& ctx,
1055 const std::string& buttonPath,
1056 const std::string& buttonIntf)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001057{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001058 bool buttonDisabled = false;
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001059 boost::system::error_code ec;
1060 std::string service;
1061 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1062 if (!ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001063 {
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001064 bool enabled;
1065 ec = ipmi::getDbusProperty(ctx, service, buttonPath, buttonIntf,
1066 "Enabled", enabled);
1067 buttonDisabled = !enabled;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001068 }
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001069
1070 if (ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001071 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001072 lg2::error("Fail to get button Enabled property ({PATH}): {ERROR}",
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001073 "PATH", buttonPath, "ERROR", ec.message());
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001074 return std::nullopt;
1075 }
1076 return std::make_optional(buttonDisabled);
1077}
1078
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001079static bool setButtonDisabled(ipmi::Context::ptr& ctx,
1080 const std::string& buttonPath,
1081 const std::string& buttonIntf, bool disable)
Kuiying Wang21addc52019-01-04 10:50:21 +08001082{
1083 std::string service;
1084 boost::system::error_code ec;
1085 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1086 if (!ec)
1087 {
1088 ec = ipmi::setDbusProperty(ctx, service, buttonPath, buttonIntf,
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001089 "Enabled", !disable);
Kuiying Wang21addc52019-01-04 10:50:21 +08001090 }
1091 if (ec)
1092 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001093 lg2::error(
1094 "Fail to set button Enabled property ({SERVICE}:{PATH}): {ERROR}",
1095 "SERVICE", service, "PATH", buttonPath, "ERROR", ec.message());
Kuiying Wang21addc52019-01-04 10:50:21 +08001096 return false;
1097 }
1098 return true;
1099}
1100
Chau Ly9e666cd2023-03-06 08:46:14 +00001101static std::optional<bool> getChassisIntrusionStatus(ipmi::Context::ptr& ctx)
1102{
Chau Ly8c1376c2024-01-05 07:22:10 +00001103 std::vector<std::string> interfaces = {std::string(Intrusion::interface)};
1104 ipmi::ObjectTree objs;
1105 std::string propVal;
1106 std::optional<bool> ret = std::nullopt;
Chau Ly9e666cd2023-03-06 08:46:14 +00001107
Chau Ly8c1376c2024-01-05 07:22:10 +00001108 boost::system::error_code ec =
1109 ipmi::getSubTree(ctx, interfaces, std::string("/"), 0, objs);
1110
1111 if (ec)
Chau Ly9e666cd2023-03-06 08:46:14 +00001112 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001113 lg2::error("Fail to find Chassis Intrusion Interface on D-Bus "
1114 "({INTERFACE}): {ERROR}",
1115 "INTERFACE", Intrusion::interface, "ERROR", ec.message());
1116 return ret;
1117 }
1118
1119 for (const auto& [path, map] : objs)
1120 {
1121 for (const auto& [service, intfs] : map)
Chau Ly9e666cd2023-03-06 08:46:14 +00001122 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001123 ec = ipmi::getDbusProperty<std::string>(
1124 ctx, service, path, Intrusion::interface, "Status", propVal);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001125
Chau Ly8c1376c2024-01-05 07:22:10 +00001126 if (ec)
1127 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001128 lg2::error("Failed to get Chassis Intrusion Status property "
Chau Ly8c1376c2024-01-05 07:22:10 +00001129 "({SERVICE}/{PATH}/{INTERFACE}): {ERROR}",
1130 "SERVICE", service, "PATH", path, "INTERFACE",
1131 Intrusion::interface, "ERROR", ec.message());
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001132 continue;
Chau Ly8c1376c2024-01-05 07:22:10 +00001133 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001134
1135 auto statusOpt =
1136 sdbusplus::message::convert_from_string<Intrusion::Status>(
1137 propVal);
1138 if (statusOpt)
Chau Ly8c1376c2024-01-05 07:22:10 +00001139 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001140 if (*statusOpt == Intrusion::Status::Normal)
Chau Ly8c1376c2024-01-05 07:22:10 +00001141 {
1142 ret = std::make_optional(false);
1143 }
1144 else
1145 {
1146 ret = std::make_optional(true);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001147 return ret; // Early return on first non-Normal status
Chau Ly8c1376c2024-01-05 07:22:10 +00001148 }
1149 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001150 else
1151 {
1152 lg2::warning(
1153 "Invalid Intrusion::Status value received: {VALUE}",
1154 "VALUE", propVal);
1155 return std::nullopt;
1156 }
Chau Ly9e666cd2023-03-06 08:46:14 +00001157 }
1158 }
Chau Ly8c1376c2024-01-05 07:22:10 +00001159 return ret;
Chau Ly9e666cd2023-03-06 08:46:14 +00001160}
1161
Nan Lifdd8ec52016-08-28 03:57:40 +08001162//----------------------------------------------------------------------
1163// Get Chassis Status commands
1164//----------------------------------------------------------------------
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001165ipmi::RspType<bool, // Power is on
1166 bool, // Power overload
1167 bool, // Interlock
1168 bool, // power fault
1169 bool, // power control fault
1170 uint2_t, // power restore policy
1171 bool, // reserved
1172
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001173 bool, // AC failed
1174 bool, // last power down caused by a Power overload
1175 bool, // last power down caused by a power interlock
1176 bool, // last power down caused by power fault
Patrick Williams99db6882024-12-18 11:20:17 -05001177 bool, // last ‘Power is on’ state was entered via IPMI command
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001178 uint3_t, // reserved
1179
1180 bool, // Chassis intrusion active
1181 bool, // Front Panel Lockout active
1182 bool, // Drive Fault
1183 bool, // Cooling/fan fault detected
1184 uint2_t, // Chassis Identify State
1185 bool, // Chassis Identify command and state info supported
1186 bool, // reserved
1187
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001188 bool, // Power off button disabled
1189 bool, // Reset button disabled
1190 bool, // Diagnostic Interrupt button disabled
1191 bool, // Standby (sleep) button disabled
1192 bool, // Power off button disable allowed
1193 bool, // Reset button disable allowed
1194 bool, // Diagnostic Interrupt button disable allowed
1195 bool // Standby (sleep) button disable allowed
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001196 >
Chau Ly9e666cd2023-03-06 08:46:14 +00001197 ipmiGetChassisStatus(ipmi::Context::ptr& ctx)
Nan Lifdd8ec52016-08-28 03:57:40 +08001198{
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001199 using namespace chassis::internal;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001200 std::optional<uint2_t> restorePolicy =
1201 power_policy::getPowerRestorePolicy();
1202 std::optional<bool> powerGood = power_policy::getPowerStatus();
1203 if (!restorePolicy || !powerGood)
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001204 {
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001205 return ipmi::responseUnspecifiedError();
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001206 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001207
1208 // Front Panel Button Capabilities and disable/enable status(Optional)
Patrick Williams1318a5e2024-08-16 15:19:54 -04001209 std::optional<bool> powerButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001210 getButtonDisabled(ctx, powerButtonPath, powerButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001211 // allow disable if the interface is present
1212 bool powerButtonDisableAllow = static_cast<bool>(powerButtonReading);
1213 // default return the button is enabled (not disabled)
1214 bool powerButtonDisabled = false;
1215 if (powerButtonDisableAllow)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001216 {
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001217 // return the real value of the button status, if present
1218 powerButtonDisabled = *powerButtonReading;
1219 }
1220
Patrick Williams1318a5e2024-08-16 15:19:54 -04001221 std::optional<bool> resetButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001222 getButtonDisabled(ctx, resetButtonPath, resetButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001223 // allow disable if the interface is present
1224 bool resetButtonDisableAllow = static_cast<bool>(resetButtonReading);
1225 // default return the button is enabled (not disabled)
1226 bool resetButtonDisabled = false;
1227 if (resetButtonDisableAllow)
1228 {
1229 // return the real value of the button status, if present
1230 resetButtonDisabled = *resetButtonReading;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001231 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001232
Yong Li70ce7352019-05-16 21:15:27 +08001233 bool powerDownAcFailed = power_policy::getACFailStatus();
1234
Chau Ly9e666cd2023-03-06 08:46:14 +00001235 bool chassisIntrusionActive = false;
1236 std::optional<bool> chassisIntrusionStatus = getChassisIntrusionStatus(ctx);
1237 if (chassisIntrusionStatus)
1238 {
1239 chassisIntrusionActive = chassisIntrusionStatus.value();
1240 }
1241
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001242 // This response has a lot of hard-coded, unsupported fields
1243 // They are set to false or 0
1244 constexpr bool powerOverload = false;
1245 constexpr bool chassisInterlock = false;
1246 constexpr bool powerFault = false;
1247 constexpr bool powerControlFault = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001248 constexpr bool powerDownOverload = false;
1249 constexpr bool powerDownInterlock = false;
1250 constexpr bool powerDownPowerFault = false;
1251 constexpr bool powerStatusIPMI = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001252 constexpr bool frontPanelLockoutActive = false;
1253 constexpr bool driveFault = false;
1254 constexpr bool coolingFanFault = false;
1255 // chassisIdentifySupport set because this command is implemented
1256 constexpr bool chassisIdentifySupport = true;
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001257 uint2_t chassisIdentifyState = types::enum_cast<uint2_t>(chassisIDState);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001258 constexpr bool diagButtonDisabled = false;
1259 constexpr bool sleepButtonDisabled = false;
1260 constexpr bool diagButtonDisableAllow = false;
1261 constexpr bool sleepButtonDisableAllow = false;
1262
1263 return ipmi::responseSuccess(
1264 *powerGood, powerOverload, chassisInterlock, powerFault,
1265 powerControlFault, *restorePolicy,
1266 false, // reserved
1267
1268 powerDownAcFailed, powerDownOverload, powerDownInterlock,
1269 powerDownPowerFault, powerStatusIPMI,
1270 uint3_t(0), // reserved
1271
1272 chassisIntrusionActive, frontPanelLockoutActive, driveFault,
1273 coolingFanFault, chassisIdentifyState, chassisIdentifySupport,
1274 false, // reserved
1275
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001276 powerButtonDisabled, resetButtonDisabled, diagButtonDisabled,
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001277 sleepButtonDisabled, powerButtonDisableAllow, resetButtonDisableAllow,
1278 diagButtonDisableAllow, sleepButtonDisableAllow);
Nan Lifdd8ec52016-08-28 03:57:40 +08001279}
Chris Austen7888c4d2015-12-03 15:26:20 -06001280
Vijay Khemka074f64d2020-03-03 15:08:43 -08001281enum class IpmiRestartCause
1282{
1283 Unknown = 0x0,
1284 RemoteCommand = 0x1,
1285 ResetButton = 0x2,
1286 PowerButton = 0x3,
1287 WatchdogTimer = 0x4,
1288 PowerPolicyAlwaysOn = 0x6,
1289 PowerPolicyPreviousState = 0x7,
1290 SoftReset = 0xa,
1291};
1292
Patrick Williams69b4c282025-03-03 11:19:13 -05001293static IpmiRestartCause restartCauseToIpmiRestartCause(
1294 State::Host::RestartCause cause)
Vijay Khemka074f64d2020-03-03 15:08:43 -08001295{
1296 switch (cause)
1297 {
1298 case State::Host::RestartCause::Unknown:
1299 {
1300 return IpmiRestartCause::Unknown;
1301 }
1302 case State::Host::RestartCause::RemoteCommand:
1303 {
1304 return IpmiRestartCause::RemoteCommand;
1305 }
1306 case State::Host::RestartCause::ResetButton:
1307 {
1308 return IpmiRestartCause::ResetButton;
1309 }
1310 case State::Host::RestartCause::PowerButton:
1311 {
1312 return IpmiRestartCause::PowerButton;
1313 }
1314 case State::Host::RestartCause::WatchdogTimer:
1315 {
1316 return IpmiRestartCause::WatchdogTimer;
1317 }
1318 case State::Host::RestartCause::PowerPolicyAlwaysOn:
1319 {
1320 return IpmiRestartCause::PowerPolicyAlwaysOn;
1321 }
1322 case State::Host::RestartCause::PowerPolicyPreviousState:
1323 {
1324 return IpmiRestartCause::PowerPolicyPreviousState;
1325 }
1326 case State::Host::RestartCause::SoftReset:
1327 {
1328 return IpmiRestartCause::SoftReset;
1329 }
1330 default:
1331 {
1332 return IpmiRestartCause::Unknown;
1333 }
1334 }
1335}
1336
1337/*
1338 * getRestartCause
1339 * helper function for Get Host restart cause Command
1340 * return - optional value for RestartCause (no value on error)
1341 */
1342static std::optional<uint4_t> getRestartCause(ipmi::Context::ptr ctx)
1343{
okashanyced0ddf2023-05-18 18:35:09 +00001344 constexpr const char* restartCausePath = "/xyz/openbmc_project/state/host0";
Vijay Khemka074f64d2020-03-03 15:08:43 -08001345
1346 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001347 boost::system::error_code ec =
Alexander Hansen76bfd752025-11-07 17:04:32 +01001348 ipmi::getService(ctx, HostState::interface, restartCausePath, service);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001349 if (!ec)
1350 {
1351 std::string restartCauseStr;
1352 ec = ipmi::getDbusProperty<std::string>(
Alexander Hansen76bfd752025-11-07 17:04:32 +01001353 ctx, service, restartCausePath, HostState::interface,
1354 HostState::property_names::restart_cause, restartCauseStr);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001355 if (!ec)
1356 {
1357 auto cause =
1358 State::Host::convertRestartCauseFromString(restartCauseStr);
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001359 return types::enum_cast<uint4_t>(
1360 restartCauseToIpmiRestartCause(cause));
Vijay Khemka074f64d2020-03-03 15:08:43 -08001361 }
1362 }
1363
Vernon Mauery38108d92024-03-11 12:53:55 -07001364 lg2::error(
1365 "Failed to fetch RestartCause property ({PATH}/{INTERFACE}): {ERROR}",
1366 "ERROR", ec.message(), "PATH", restartCausePath, "INTERFACE",
Alexander Hansen76bfd752025-11-07 17:04:32 +01001367 HostState::interface);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001368 return std::nullopt;
1369}
1370
1371ipmi::RspType<uint4_t, // Restart Cause
1372 uint4_t, // reserved
1373 uint8_t // channel number (not supported)
1374 >
1375 ipmiGetSystemRestartCause(ipmi::Context::ptr ctx)
1376{
1377 std::optional<uint4_t> cause = getRestartCause(ctx);
1378 if (!cause)
1379 {
1380 return ipmi::responseUnspecifiedError();
1381 }
1382
Vernon Mauery916d4232021-03-29 13:42:16 -07001383 constexpr uint4_t reserved = 0;
1384 auto channel = static_cast<uint8_t>(ctx->channel);
1385 return ipmi::responseSuccess(cause.value(), reserved, channel);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001386}
anil kumar appanadafff5f2019-04-27 18:06:00 +00001387/** @brief Implementation of chassis control command
1388 *
1389 * @param - chassisControl command byte
1390 *
1391 * @return Success or InvalidFieldRequest.
1392 */
Jason M. Bills664e1c32020-01-30 16:02:39 -08001393ipmi::RspType<> ipmiChassisControl(ipmi::Context::ptr& ctx,
1394 uint8_t chassisControl)
vishwa36993272015-11-20 12:43:49 -06001395{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001396 int rc = 0;
anil kumar appanadafff5f2019-04-27 18:06:00 +00001397 switch (chassisControl)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001398 {
George Liu8f4717c2025-07-03 09:22:34 +08001399 case cmdPowerOn:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001400 rc = initiateHostStateTransition(ctx, State::Host::Transition::On);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001401 break;
George Liu8f4717c2025-07-03 09:22:34 +08001402 case cmdPowerOff:
Jason M. Billsc2c3a402020-01-30 16:22:24 -08001403 rc = initiateChassisStateTransition(
1404 ctx, State::Chassis::Transition::Off);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001405 break;
George Liu8f4717c2025-07-03 09:22:34 +08001406 case cmdHardReset:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001407 rc = initiateHostStateTransition(
1408 ctx, State::Host::Transition::ForceWarmReboot);
Chanh Nguyend0a7fcd2021-07-16 22:59:28 +07001409 break;
George Liu8f4717c2025-07-03 09:22:34 +08001410 case cmdPowerCycle:
Thang Trana7d592c2025-09-17 03:43:14 +00001411 {
1412 auto powerState = power_policy::getPowerStatus();
1413
1414 if (powerState == std::nullopt)
1415 {
1416 return ipmi::responseUnspecifiedError();
1417 }
1418
1419 /*
1420 * As define in the Chapter 28.3 - Chassis Control Command of IPMI
1421 * specification: It is recommended that no action occur if system
1422 * power is off (S4/S5) when this action is selected, and that a D5
1423 * "Requiest parameter(s) not supported in this presenst state."
1424 * error completion code be returned.
1425 */
1426 if (powerState.value() == false)
1427 {
1428 return ipmi::responseCommandNotAvailable();
1429 }
1430
Jason M. Bills664e1c32020-01-30 16:02:39 -08001431 rc = initiateHostStateTransition(ctx,
1432 State::Host::Transition::Reboot);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001433 break;
Thang Trana7d592c2025-09-17 03:43:14 +00001434 }
George Liu8f4717c2025-07-03 09:22:34 +08001435 case cmdSoftOffViaOverTemp:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001436 rc = initiateHostStateTransition(ctx, State::Host::Transition::Off);
Vishwanatha Subbanna8b26d352017-08-04 18:35:18 +05301437 break;
George Liu8f4717c2025-07-03 09:22:34 +08001438 case cmdPulseDiagnosticInterrupt:
Zev Weiss337a0972024-03-08 08:31:15 +00001439 rc = doNmi(ctx);
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +08001440 break;
1441
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001442 default:
1443 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001444 lg2::error("Invalid Chassis Control command: {CMD}", "CMD",
1445 lg2::hex, chassisControl);
anil kumar appanadafff5f2019-04-27 18:06:00 +00001446 return ipmi::responseInvalidFieldRequest();
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001447 }
1448 }
vishwa36993272015-11-20 12:43:49 -06001449
anil kumar appanadafff5f2019-04-27 18:06:00 +00001450 return ((rc < 0) ? ipmi::responseUnspecifiedError()
1451 : ipmi::responseSuccess());
vishwa36993272015-11-20 12:43:49 -06001452}
1453
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001454/** @brief Return D-Bus connection string to enclosure identify LED object
1455 *
1456 * @param[in, out] connection - connection to D-Bus object
1457 * @return a IPMI return code
1458 */
1459std::string getEnclosureIdentifyConnection()
Tom Joseph5110c122018-03-23 17:55:40 +05301460{
Tom Joseph5110c122018-03-23 17:55:40 +05301461 // lookup enclosure_identify group owner(s) in mapper
George Liu3e3cc352023-07-26 15:59:31 +08001462 try
Tom Joseph5110c122018-03-23 17:55:40 +05301463 {
George Liu3e3cc352023-07-26 15:59:31 +08001464 return ipmi::getService(*getSdBus(), "xyz.openbmc_project.Led.Group",
1465 identify_led_object_name);
1466 }
1467 catch (const std::exception& e)
1468 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001469 lg2::error("Chassis Identify: Error communicating to mapper: {ERROR}",
1470 "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001471 elog<InternalFailure>();
Tom Joseph5110c122018-03-23 17:55:40 +05301472 }
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001473}
Tom Joseph5110c122018-03-23 17:55:40 +05301474
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001475/** @brief Turn On/Off enclosure identify LED
1476 *
1477 * @param[in] flag - true to turn on LED, false to turn off
1478 * @return a IPMI return code
1479 */
1480void enclosureIdentifyLed(bool flag)
1481{
1482 using namespace chassis::internal;
George Liucbe50fd2025-08-21 16:51:33 +08001483
1484 std::string connection = getEnclosureIdentifyConnection();
1485
1486 lg2::debug("enclosureIdentifyLed({FLAG})", "FLAG", flag);
1487
George Liu3e3cc352023-07-26 15:59:31 +08001488 try
1489 {
George Liu3e3cc352023-07-26 15:59:31 +08001490 ipmi::setDbusProperty(*getSdBus(), connection, identify_led_object_name,
1491 "xyz.openbmc_project.Led.Group", "Asserted",
1492 flag);
1493 }
1494 catch (const std::exception& e)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001495 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001496 lg2::error("Chassis Identify: Error Setting State {LED_STATE}: {ERROR}",
1497 "LED_STATE", flag, "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001498 elog<InternalFailure>();
1499 }
1500}
1501
1502/** @brief Callback method to turn off LED
1503 */
1504void enclosureIdentifyLedOff()
1505{
1506 try
1507 {
Yong Lif4e38512019-05-21 14:46:55 +08001508 chassisIDState = ChassisIDState::off;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001509 enclosureIdentifyLed(false);
1510 }
1511 catch (const InternalFailure& e)
1512 {
1513 report<InternalFailure>();
1514 }
1515}
1516
1517/** @brief Create timer to turn on and off the enclosure LED
1518 */
1519void createIdentifyTimer()
1520{
1521 if (!identifyTimer)
1522 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001523 identifyTimer =
Patrick Williams95655222023-12-05 12:45:02 -06001524 std::make_unique<sdbusplus::Timer>(enclosureIdentifyLedOff);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001525 }
1526}
1527
Vernon Mauery400cc782018-10-09 13:49:53 -07001528ipmi::RspType<> ipmiChassisIdentify(std::optional<uint8_t> interval,
1529 std::optional<uint8_t> force)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001530{
Vernon Mauery400cc782018-10-09 13:49:53 -07001531 uint8_t identifyInterval = interval.value_or(DEFAULT_IDENTIFY_TIME_OUT);
1532 bool forceIdentify = force.value_or(0) & 0x01;
Tom Josephbed26992018-07-31 23:00:24 +05301533
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001534 if (identifyInterval || forceIdentify)
1535 {
Vernon Mauery400cc782018-10-09 13:49:53 -07001536 // stop the timer if already started;
1537 // for force identify we should not turn off LED
Vernon Mauery1181af72018-10-08 12:05:00 -07001538 identifyTimer->stop();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001539 try
Tom Joseph5110c122018-03-23 17:55:40 +05301540 {
Yong Lif4e38512019-05-21 14:46:55 +08001541 chassisIDState = ChassisIDState::temporaryOn;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001542 enclosureIdentifyLed(true);
1543 }
1544 catch (const InternalFailure& e)
1545 {
1546 report<InternalFailure>();
Vernon Mauery400cc782018-10-09 13:49:53 -07001547 return ipmi::responseResponseError();
Tom Joseph5110c122018-03-23 17:55:40 +05301548 }
1549
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001550 if (forceIdentify)
Tom Joseph5110c122018-03-23 17:55:40 +05301551 {
Yong Lif4e38512019-05-21 14:46:55 +08001552 chassisIDState = ChassisIDState::indefiniteOn;
Vernon Mauery400cc782018-10-09 13:49:53 -07001553 return ipmi::responseSuccess();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001554 }
1555 // start the timer
1556 auto time = std::chrono::duration_cast<std::chrono::microseconds>(
Patrick Venture0b02be92018-08-31 11:55:55 -07001557 std::chrono::seconds(identifyInterval));
Vernon Mauery1181af72018-10-08 12:05:00 -07001558 identifyTimer->start(time);
Tom Joseph5110c122018-03-23 17:55:40 +05301559 }
Tom Josephbed26992018-07-31 23:00:24 +05301560 else if (!identifyInterval)
1561 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001562 identifyTimer->stop();
Tom Josephbed26992018-07-31 23:00:24 +05301563 enclosureIdentifyLedOff();
1564 }
Vernon Mauery400cc782018-10-09 13:49:53 -07001565 return ipmi::responseSuccess();
Tom Joseph5110c122018-03-23 17:55:40 +05301566}
1567
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001568namespace boot_options
1569{
1570
Willy Tu523e2d12023-09-05 11:36:48 -07001571using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001572using IpmiValue = uint8_t;
1573constexpr auto ipmiDefault = 0;
1574
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001575std::map<IpmiValue, Type::Types> typeIpmiToDbus = {{0x00, Type::Types::Legacy},
1576 {0x01, Type::Types::EFI}};
1577
Patrick Venture0b02be92018-08-31 11:55:55 -07001578std::map<IpmiValue, Source::Sources> sourceIpmiToDbus = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001579 {0x01, Source::Sources::Network},
1580 {0x02, Source::Sources::Disk},
1581 {0x05, Source::Sources::ExternalMedia},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001582 {0x0f, Source::Sources::RemovableMedia},
Patrick Venture0b02be92018-08-31 11:55:55 -07001583 {ipmiDefault, Source::Sources::Default}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001584
Patrick Venture0b02be92018-08-31 11:55:55 -07001585std::map<IpmiValue, Mode::Modes> modeIpmiToDbus = {
Yong Li5833cb62019-10-30 13:27:12 +08001586#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001587 {0x03, Mode::Modes::Safe},
Yong Li5833cb62019-10-30 13:27:12 +08001588#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001589 {0x06, Mode::Modes::Setup},
Patrick Venture0b02be92018-08-31 11:55:55 -07001590 {ipmiDefault, Mode::Modes::Regular}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001591
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001592std::map<Type::Types, IpmiValue> typeDbusToIpmi = {{Type::Types::Legacy, 0x00},
1593 {Type::Types::EFI, 0x01}};
1594
Patrick Venture0b02be92018-08-31 11:55:55 -07001595std::map<Source::Sources, IpmiValue> sourceDbusToIpmi = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001596 {Source::Sources::Network, 0x01},
1597 {Source::Sources::Disk, 0x02},
1598 {Source::Sources::ExternalMedia, 0x05},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001599 {Source::Sources::RemovableMedia, 0x0f},
Patrick Venture0b02be92018-08-31 11:55:55 -07001600 {Source::Sources::Default, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001601
Patrick Venture0b02be92018-08-31 11:55:55 -07001602std::map<Mode::Modes, IpmiValue> modeDbusToIpmi = {
Yong Li5833cb62019-10-30 13:27:12 +08001603#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001604 {Mode::Modes::Safe, 0x03},
Yong Li5833cb62019-10-30 13:27:12 +08001605#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001606 {Mode::Modes::Setup, 0x06},
Patrick Venture0b02be92018-08-31 11:55:55 -07001607 {Mode::Modes::Regular, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001608
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001609} // namespace boot_options
shgoupfd84fbbf2015-12-17 10:05:51 +08001610
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001611/** @brief Get the property value for boot source
1612 * @param[in] ctx - context pointer
1613 * @param[out] source - boot source value
1614 * @return On failure return IPMI error.
1615 */
1616static ipmi::Cc getBootSource(ipmi::Context::ptr& ctx, Source::Sources& source)
1617{
1618 using namespace chassis::internal;
1619 std::string result;
1620 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001621 boost::system::error_code ec =
1622 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001623 if (!ec)
1624 {
1625 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1626 bootSourceIntf, "BootSource", result);
1627 if (!ec)
1628 {
1629 source = Source::convertSourcesFromString(result);
1630 return ipmi::ccSuccess;
1631 }
1632 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001633 lg2::error("Error in BootSource Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001634 return ipmi::ccUnspecifiedError;
1635}
1636
Marri Devender Rao81719702018-05-07 00:53:48 -05001637/** @brief Set the property value for boot source
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001638 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001639 * @param[in] source - boot source value
1640 * @return On failure return IPMI error.
1641 */
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00001642static ipmi::Cc setBootSource(ipmi::Context::ptr& ctx,
1643 const Source::Sources& source)
Marri Devender Rao81719702018-05-07 00:53:48 -05001644{
1645 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001646 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001647 boost::system::error_code ec =
1648 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001649 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001650 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001651 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1652 bootSourceIntf, "BootSource",
1653 convertForMessage(source));
1654 if (!ec)
1655 {
1656 return ipmi::ccSuccess;
1657 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001658 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001659 lg2::error("Error in BootSource Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001660 return ipmi::ccUnspecifiedError;
1661}
1662
1663/** @brief Get the property value for boot mode
1664 * @param[in] ctx - context pointer
1665 * @param[out] mode - boot mode value
1666 * @return On failure return IPMI error.
1667 */
1668static ipmi::Cc getBootMode(ipmi::Context::ptr& ctx, Mode::Modes& mode)
1669{
1670 using namespace chassis::internal;
1671 std::string result;
1672 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001673 boost::system::error_code ec =
1674 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001675 if (!ec)
1676 {
1677 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1678 "BootMode", result);
1679 if (!ec)
1680 {
1681 mode = Mode::convertModesFromString(result);
1682 return ipmi::ccSuccess;
1683 }
1684 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001685 lg2::error("Error in BootMode Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001686 return ipmi::ccUnspecifiedError;
Marri Devender Rao81719702018-05-07 00:53:48 -05001687}
1688
Patrick Venture0b02be92018-08-31 11:55:55 -07001689/** @brief Set the property value for boot mode
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001690 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001691 * @param[in] mode - boot mode value
1692 * @return On failure return IPMI error.
1693 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001694static ipmi::Cc setBootMode(ipmi::Context::ptr& ctx, const Mode::Modes& mode)
Marri Devender Rao81719702018-05-07 00:53:48 -05001695{
1696 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001697 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001698 boost::system::error_code ec =
1699 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001700 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001701 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001702 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1703 "BootMode", convertForMessage(mode));
1704 if (!ec)
1705 {
1706 return ipmi::ccSuccess;
1707 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001708 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001709 lg2::error("Error in BootMode Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001710 return ipmi::ccUnspecifiedError;
1711}
1712
1713/** @brief Get the property value for boot type
1714 * @param[in] ctx - context pointer
1715 * @param[out] type - boot type value
1716 * @return On failure return IPMI error.
1717 */
1718static ipmi::Cc getBootType(ipmi::Context::ptr& ctx, Type::Types& type)
1719{
1720 using namespace chassis::internal;
1721 std::string result;
1722 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001723 boost::system::error_code ec =
1724 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001725
1726 // Don't throw error if BootType interface is not present.
1727 // This interface is not relevant for some Host architectures
1728 // (for example POWER). In this case we don't won't IPMI to
1729 // return an error, but simply return bootType as EFI.
1730 type = Type::Types::EFI;
1731 if (!ec)
1732 {
1733 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1734 "BootType", result);
1735 if (ec)
1736 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001737 lg2::error("Error in BootType Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001738 return ipmi::ccUnspecifiedError;
1739 }
1740 type = Type::convertTypesFromString(result);
1741 }
1742
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00001743 return ipmi::ccSuccess;
Marri Devender Rao81719702018-05-07 00:53:48 -05001744}
1745
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001746/** @brief Set the property value for boot type
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001747 * @param[in] ctx - context pointer
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001748 * @param[in] type - boot type value
1749 * @return On failure return IPMI error.
1750 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001751static ipmi::Cc setBootType(ipmi::Context::ptr& ctx, const Type::Types& type)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001752{
1753 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001754 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001755 boost::system::error_code ec =
1756 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001757 if (!ec)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001758 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001759 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1760 "BootType", convertForMessage(type));
1761 if (ec)
1762 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001763 lg2::error("Error in BootType Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001764 return ipmi::ccUnspecifiedError;
1765 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001766 }
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001767 // Don't throw error if BootType interface is not present.
1768 // This interface is not relevant for some Host architectures
1769 // (for example POWER). In this case we don't won't IPMI to
1770 // return an error, but want to just skip this function.
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001771 return ipmi::ccSuccess;
1772}
1773
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001774/** @brief Get the property value for boot override enable
1775 * @param[in] ctx - context pointer
1776 * @param[out] enable - boot override enable
1777 * @return On failure return IPMI error.
1778 */
1779static ipmi::Cc getBootEnable(ipmi::Context::ptr& ctx, bool& enable)
1780{
1781 using namespace chassis::internal;
1782 std::string result;
1783 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001784 boost::system::error_code ec =
1785 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001786 if (!ec)
1787 {
1788 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1789 bootEnableIntf, "Enabled", enable);
1790 if (!ec)
1791 {
1792 return ipmi::ccSuccess;
1793 }
1794 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001795 lg2::error("Error in Boot Override Enable Get: {ERROR}", "ERROR",
1796 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001797 return ipmi::ccUnspecifiedError;
1798}
1799
1800/** @brief Set the property value for boot override enable
1801 * @param[in] ctx - context pointer
1802 * @param[in] enable - boot override enable
1803 * @return On failure return IPMI error.
1804 */
1805static ipmi::Cc setBootEnable(ipmi::Context::ptr& ctx, const bool& enable)
1806{
1807 using namespace chassis::internal;
1808 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001809 boost::system::error_code ec =
1810 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001811 if (!ec)
1812 {
1813 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1814 bootEnableIntf, "Enabled", enable);
1815 if (!ec)
1816 {
1817 return ipmi::ccSuccess;
1818 }
1819 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001820 lg2::error("Error in Boot Source Override Enable Set: {ERROR}", "ERROR",
1821 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001822 return ipmi::ccUnspecifiedError;
1823}
1824
1825/** @brief Get the property value for boot override one-time
1826 * @param[in] ctx - context pointer
1827 * @param[out] onetime - boot override one-time
1828 * @return On failure return IPMI error.
1829 */
1830static ipmi::Cc getBootOneTime(ipmi::Context::ptr& ctx, bool& onetime)
1831{
1832 using namespace chassis::internal;
1833 std::string result;
1834 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001835 boost::system::error_code ec =
1836 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001837 if (!ec)
1838 {
1839 ec = ipmi::getDbusProperty(ctx, service, bootSettingsOneTimePath,
1840 bootOneTimeIntf, "Enabled", onetime);
1841 if (!ec)
1842 {
1843 return ipmi::ccSuccess;
1844 }
1845 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001846 lg2::error("Error in Boot Override OneTime Get: {ERROR}", "ERROR",
1847 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001848 return ipmi::ccUnspecifiedError;
1849}
1850
1851/** @brief Set the property value for boot override one-time
1852 * @param[in] ctx - context pointer
1853 * @param[in] onetime - boot override one-time
1854 * @return On failure return IPMI error.
1855 */
1856static ipmi::Cc setBootOneTime(ipmi::Context::ptr& ctx, const bool& onetime)
1857{
1858 using namespace chassis::internal;
1859 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001860 boost::system::error_code ec =
1861 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001862 if (!ec)
1863 {
1864 ec = ipmi::setDbusProperty(ctx, service, bootSettingsOneTimePath,
1865 bootOneTimeIntf, "Enabled", onetime);
1866 if (!ec)
1867 {
1868 return ipmi::ccSuccess;
1869 }
1870 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001871 lg2::error("Error in Boot Source Override OneTime Set: {ERROR}", "ERROR",
1872 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001873 return ipmi::ccUnspecifiedError;
1874}
1875
huangheab369282020-10-10 14:40:00 +08001876static constexpr uint8_t setComplete = 0x0;
1877static constexpr uint8_t setInProgress = 0x1;
1878static uint8_t transferStatus = setComplete;
Chen Yugang86ac4992021-06-25 08:14:52 +08001879static uint8_t bootFlagValidBitClr = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001880static uint5_t bootInitiatorAckData = 0x0;
Hieu Huynh1982a3f2021-09-21 03:06:45 +00001881static bool cmosClear = false;
Cosmo Chou53831212025-01-10 13:36:36 +08001882static uint2_t biosVerbosity = 0x0;
huangheab369282020-10-10 14:40:00 +08001883
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001884/** @brief implements the Get Chassis system boot option
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001885 * @param ctx - context pointer
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001886 * @param bootOptionParameter - boot option parameter selector
1887 * @param reserved1 - reserved bit
1888 * @param setSelector - selects a particular block or set of parameters
1889 * under the given parameter selector
1890 * write as 00h if parameter doesn't use a setSelector
1891 * @param blockSelector- selects a particular block within a set of
1892 * parameters write as 00h if parameter doesn't use a
1893 * blockSelector
1894 *
1895 * @return IPMI completion code plus response data
1896 * @return Payload contains below parameters:
1897 * version - parameter version
1898 * bootOptionParameter - boot option parameter selector
Patrick Venture8b1c3032020-09-15 09:43:03 -07001899 * parmIndicator - parameter valid/invalid indicator
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001900 * data - configuration parameter data
1901 */
Patrick Williams1318a5e2024-08-16 15:19:54 -04001902ipmi::RspType<ipmi::message::Payload> ipmiChassisGetSysBootOptions(
1903 ipmi::Context::ptr ctx, uint7_t bootOptionParameter, bool reserved1,
1904 [[maybe_unused]] uint8_t setSelector,
1905 [[maybe_unused]] uint8_t blockSelector)
Adriana Kobylak40814c62015-10-27 15:58:44 -05001906{
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001907 ipmi::Cc rc;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001908 if (reserved1)
1909 {
1910 return ipmi::responseInvalidFieldRequest();
1911 }
1912
1913 constexpr uint4_t version = 0x01;
1914 ipmi::message::Payload response;
1915 response.pack(version, uint4_t{});
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001916 using namespace boot_options;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001917
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001918 IpmiValue bootOption = ipmiDefault;
Adriana Kobylak40814c62015-10-27 15:58:44 -05001919
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001920 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1921 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08001922 {
1923 response.pack(bootOptionParameter, reserved1, transferStatus);
1924 return ipmi::responseSuccess(std::move(response));
1925 }
1926
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001927 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1928 BootOptionParameter::bootInfo)
John Wang0213f902020-12-28 14:49:57 +08001929 {
1930 constexpr uint8_t writeMask = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001931 response.pack(bootOptionParameter, reserved1, writeMask,
1932 bootInitiatorAckData);
John Wang0213f902020-12-28 14:49:57 +08001933 return ipmi::responseSuccess(std::move(response));
1934 }
1935
Chen Yugang86ac4992021-06-25 08:14:52 +08001936 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1937 BootOptionParameter::bootFlagValidClr)
1938 {
1939 response.pack(bootOptionParameter, reserved1,
1940 uint5_t{bootFlagValidBitClr}, uint3_t{});
1941 return ipmi::responseSuccess(std::move(response));
1942 }
1943
shgoupfd84fbbf2015-12-17 10:05:51 +08001944 /*
1945 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
1946 * This is the only parameter used by petitboot.
1947 */
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001948 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1949 BootOptionParameter::bootFlags)
Patrick Venture0b02be92018-08-31 11:55:55 -07001950 {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001951 using namespace chassis::internal;
1952 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08001953
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001954 try
ratagupta6f6bff2016-04-04 06:20:11 -05001955 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001956 Source::Sources bootSource;
1957 rc = getBootSource(ctx, bootSource);
1958 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001959 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001960 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001961 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001962
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001963 Type::Types bootType;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001964 rc = getBootType(ctx, bootType);
1965 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001966 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001967 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001968 }
1969
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001970 Mode::Modes bootMode;
1971 rc = getBootMode(ctx, bootMode);
1972 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001973 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001974 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001975 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001976
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001977 bootOption = sourceDbusToIpmi.at(bootSource);
1978 if ((Mode::Modes::Regular == bootMode) &&
1979 (Source::Sources::Default == bootSource))
1980 {
1981 bootOption = ipmiDefault;
1982 }
1983 else if (Source::Sources::Default == bootSource)
1984 {
1985 bootOption = modeDbusToIpmi.at(bootMode);
1986 }
ratagupta6f6bff2016-04-04 06:20:11 -05001987
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001988 IpmiValue biosBootType = typeDbusToIpmi.at(bootType);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001989
1990 bool oneTimeEnabled;
1991 rc = getBootOneTime(ctx, oneTimeEnabled);
1992 if (rc != ipmi::ccSuccess)
1993 {
1994 return ipmi::response(rc);
1995 }
1996
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001997 uint1_t permanent = oneTimeEnabled ? 0 : 1;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001998
1999 bool valid;
2000 rc = getBootEnable(ctx, valid);
2001 if (rc != ipmi::ccSuccess)
2002 {
2003 return ipmi::response(rc);
2004 }
2005
2006 uint1_t validFlag = valid ? 1 : 0;
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002007
Cosmo Chou53831212025-01-10 13:36:36 +08002008 response.pack(
2009 bootOptionParameter, reserved1, uint5_t{},
2010 uint1_t{biosBootType}, uint1_t{permanent}, uint1_t{validFlag},
2011 uint2_t{}, uint4_t{bootOption}, uint1_t{}, cmosClear, uint5_t{},
2012 uint2_t{biosVerbosity}, uint1_t{}, uint8_t{}, uint8_t{});
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002013 return ipmi::responseSuccess(std::move(response));
ratagupta6f6bff2016-04-04 06:20:11 -05002014 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002015 catch (const InternalFailure& e)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002016 {
James Feist225dec82019-11-26 16:25:06 -08002017 cache::objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002018 report<InternalFailure>();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002019 return ipmi::responseUnspecifiedError();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002020 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002021 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002022 else
2023 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002024 if ((bootOptionParameter >= oemParmStart) &&
2025 (bootOptionParameter <= oemParmEnd))
2026 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002027 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
2028 BootOptionParameter::opalNetworkSettings)
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002029 {
2030 response.pack(bootOptionParameter, reserved1);
2031 int ret = getHostNetworkData(response);
2032 if (ret < 0)
2033 {
2034 response.trailingOk = true;
Vernon Mauery38108d92024-03-11 12:53:55 -07002035 lg2::error(
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002036 "getHostNetworkData failed for GetSysBootOptions.");
2037 return ipmi::responseUnspecifiedError();
2038 }
2039 else
2040 {
2041 return ipmi::responseSuccess(std::move(response));
2042 }
2043 }
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002044 else
2045 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002046 lg2::error(
2047 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2048 "PARAM", lg2::hex,
2049 static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002050 return ipmi::responseParmNotSupported();
2051 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002052 }
2053 else
2054 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002055 lg2::error(
2056 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2057 "PARAM", lg2::hex, static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00002058 return ipmi::responseParmNotSupported();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002059 }
shgoupfd84fbbf2015-12-17 10:05:51 +08002060 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002061 return ipmi::responseUnspecifiedError();
shgoupfd84fbbf2015-12-17 10:05:51 +08002062}
2063
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002064ipmi::RspType<> ipmiChassisSetSysBootOptions(ipmi::Context::ptr ctx,
Willy Tu11d68892022-01-20 10:37:34 -08002065 uint7_t parameterSelector, bool,
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002066 ipmi::message::Payload& data)
shgoupfd84fbbf2015-12-17 10:05:51 +08002067{
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002068 using namespace boot_options;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002069 ipmi::Cc rc;
shgoupfd84fbbf2015-12-17 10:05:51 +08002070
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002071 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2072 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08002073 {
2074 uint2_t setInProgressFlag;
2075 uint6_t rsvd;
2076 if (data.unpack(setInProgressFlag, rsvd) != 0 || !data.fullyUnpacked())
2077 {
2078 return ipmi::responseReqDataLenInvalid();
2079 }
2080 if (rsvd)
2081 {
2082 return ipmi::responseInvalidFieldRequest();
2083 }
2084 if ((transferStatus == setInProgress) &&
2085 (static_cast<uint8_t>(setInProgressFlag) != setComplete))
2086 {
George Liuf5dd1022025-07-07 09:13:07 +08002087 return ipmi::responsefailSetInProgress();
huangheab369282020-10-10 14:40:00 +08002088 }
2089 transferStatus = static_cast<uint8_t>(setInProgressFlag);
2090 return ipmi::responseSuccess();
2091 }
2092
shgoupfd84fbbf2015-12-17 10:05:51 +08002093 /* 000101
2094 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
2095 * This is the only parameter used by petitboot.
2096 */
Ratan Guptafd28dd72016-08-01 04:58:01 -05002097
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002098 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2099 BootOptionParameter::bootFlags)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002100 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002101 uint5_t rsvd;
2102 bool validFlag;
2103 bool permanent;
2104 bool biosBootType;
2105 bool lockOutResetButton;
2106 bool screenBlank;
2107 uint4_t bootDeviceSelector;
2108 bool lockKeyboard;
Cosmo Chou53831212025-01-10 13:36:36 +08002109 uint5_t biosCtrls;
2110 bool lockOutPower;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002111 uint4_t biosInfo;
2112 uint4_t rsvd1;
2113 uint5_t deviceInstance;
2114 uint3_t rsvd2;
2115
2116 if (data.unpack(rsvd, biosBootType, permanent, validFlag,
2117 lockOutResetButton, screenBlank, bootDeviceSelector,
Cosmo Chou53831212025-01-10 13:36:36 +08002118 lockKeyboard, cmosClear, biosCtrls, biosVerbosity,
2119 lockOutPower, biosInfo, rsvd1, deviceInstance, rsvd2) !=
2120 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002121 !data.fullyUnpacked())
2122 {
2123 return ipmi::responseReqDataLenInvalid();
2124 }
2125 if (rsvd || rsvd1 || rsvd2)
2126 {
2127 return ipmi::responseInvalidFieldRequest();
2128 }
2129
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002130 using namespace chassis::internal;
2131 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08002132
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002133 try
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002134 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002135 rc = setBootOneTime(ctx, !permanent);
2136 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev69e8e842021-06-18 17:01:18 +03002137 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002138 return ipmi::response(rc);
2139 }
Vernon Maueryafd45db2021-07-29 16:27:25 +00002140
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002141 rc = setBootEnable(ctx, validFlag);
2142 if (rc != ipmi::ccSuccess)
2143 {
2144 return ipmi::response(rc);
Tom Joseph57e8eb72017-09-25 18:05:02 +05302145 }
2146
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002147 auto modeItr =
2148 modeIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002149 auto typeItr =
2150 typeIpmiToDbus.find(static_cast<uint8_t>(biosBootType));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002151 auto sourceItr =
2152 sourceIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002153 if (sourceIpmiToDbus.end() != sourceItr)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002154 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002155 rc = setBootSource(ctx, sourceItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002156 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002157 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002158 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002159 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002160 // If a set boot device is mapping to a boot source, then reset
2161 // the boot mode D-Bus property to default.
2162 // This way the ipmid code can determine which property is not
2163 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002164 if (sourceItr->second != Source::Sources::Default)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002165 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002166 rc = setBootMode(ctx, Mode::Modes::Regular);
2167 if (rc != ipmi::ccSuccess)
2168 {
2169 return ipmi::response(rc);
2170 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002171 }
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002172 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002173
2174 if (typeIpmiToDbus.end() != typeItr)
2175 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002176 rc = setBootType(ctx, typeItr->second);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002177 if (rc != ipmi::ccSuccess)
2178 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002179 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002180 }
2181 }
2182
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002183 if (modeIpmiToDbus.end() != modeItr)
2184 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002185 rc = setBootMode(ctx, modeItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002186 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002187 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002188 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002189 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002190 // If a set boot device is mapping to a boot mode, then reset
2191 // the boot source D-Bus property to default.
2192 // This way the ipmid code can determine which property is not
2193 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002194 if (modeItr->second != Mode::Modes::Regular)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002195 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002196 rc = setBootSource(ctx, Source::Sources::Default);
2197 if (rc != ipmi::ccSuccess)
2198 {
2199 return ipmi::response(rc);
2200 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002201 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002202 }
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002203 if ((modeIpmiToDbus.end() == modeItr) &&
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002204 (typeIpmiToDbus.end() == typeItr) &&
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002205 (sourceIpmiToDbus.end() == sourceItr))
2206 {
2207 // return error if boot option is not supported
Vernon Mauery38108d92024-03-11 12:53:55 -07002208 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002209 "ipmiChassisSetSysBootOptions: Boot option not supported");
2210 return ipmi::responseInvalidFieldRequest();
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002211 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002212 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002213 catch (const sdbusplus::exception_t& e)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002214 {
James Feist225dec82019-11-26 16:25:06 -08002215 objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002216 report<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -07002217 lg2::error("ipmiChassisSetSysBootOptions: Error in setting Boot "
2218 "flag parameters");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002219 return ipmi::responseUnspecifiedError();
Ratan Guptafd28dd72016-08-01 04:58:01 -05002220 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002221 }
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002222 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2223 BootOptionParameter::bootInfo)
Patrick Venture0b02be92018-08-31 11:55:55 -07002224 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002225 uint8_t writeMak;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002226 uint5_t bootInfoAck;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002227 uint3_t rsvd;
2228
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002229 if (data.unpack(writeMak, bootInfoAck, rsvd) != 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002230 !data.fullyUnpacked())
2231 {
2232 return ipmi::responseReqDataLenInvalid();
2233 }
2234 if (rsvd)
2235 {
2236 return ipmi::responseInvalidFieldRequest();
2237 }
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002238 bootInitiatorAckData &= ~writeMak;
2239 bootInitiatorAckData |= (writeMak & bootInfoAck);
Vernon Mauery38108d92024-03-11 12:53:55 -07002240 lg2::info("ipmiChassisSetSysBootOptions: bootInfo parameter set "
2241 "successfully");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002242 data.trailingOk = true;
2243 return ipmi::responseSuccess();
Patrick Venture0b02be92018-08-31 11:55:55 -07002244 }
Chen Yugang86ac4992021-06-25 08:14:52 +08002245 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2246 BootOptionParameter::bootFlagValidClr)
2247 {
2248 uint5_t bootFlagValidClr;
2249 uint3_t rsvd;
2250
2251 if (data.unpack(bootFlagValidClr, rsvd) != 0 || !data.fullyUnpacked())
2252 {
2253 return ipmi::responseReqDataLenInvalid();
2254 }
2255 if (rsvd)
2256 {
2257 return ipmi::responseInvalidFieldRequest();
2258 }
2259 // store boot flag valid bits clear value
2260 bootFlagValidBitClr = static_cast<uint8_t>(bootFlagValidClr);
Vernon Mauery38108d92024-03-11 12:53:55 -07002261 lg2::info(
Chen Yugang86ac4992021-06-25 08:14:52 +08002262 "ipmiChassisSetSysBootOptions: bootFlagValidBits parameter set "
Vernon Mauery38108d92024-03-11 12:53:55 -07002263 "successfully to {VALUE}",
2264 "VALUE", lg2::hex, bootFlagValidBitClr);
Chen Yugang86ac4992021-06-25 08:14:52 +08002265 return ipmi::responseSuccess();
2266 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002267 else
2268 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002269 if ((parameterSelector >= static_cast<uint7_t>(oemParmStart)) &&
2270 (parameterSelector <= static_cast<uint7_t>(oemParmEnd)))
2271 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002272 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2273 BootOptionParameter::opalNetworkSettings)
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002274 {
2275 ipmi::Cc ret = setHostNetworkData(data);
2276 if (ret != ipmi::ccSuccess)
2277 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002278 lg2::error("ipmiChassisSetSysBootOptions: Error in "
2279 "setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002280 data.trailingOk = true;
2281 return ipmi::response(ret);
2282 }
2283 data.trailingOk = true;
2284 return ipmi::responseSuccess();
2285 }
2286 else
2287 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002288 lg2::error(
2289 "ipmiChassisSetSysBootOptions: Unsupported param: {PARAM}",
2290 "PARAM", lg2::hex, static_cast<uint8_t>(parameterSelector));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002291 data.trailingOk = true;
2292 return ipmi::responseParmNotSupported();
2293 }
2294 }
2295 data.trailingOk = true;
2296 return ipmi::responseParmNotSupported();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002297 }
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002298 return ipmi::responseSuccess();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002299}
2300
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002301/** @brief implements Get POH counter command
2302 * @parameter
2303 * - none
2304 * @returns IPMI completion code plus response data
2305 * - minPerCount - Minutes per count
2306 * - counterReading - counter reading
2307 */
2308ipmi::RspType<uint8_t, // Minutes per count
2309 uint32_t // Counter reading
2310 >
2311 ipmiGetPOHCounter()
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002312{
2313 // sd_bus error
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002314 try
2315 {
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002316 return ipmi::responseSuccess(static_cast<uint8_t>(poh::minutesPerCount),
2317 getPOHCounter());
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002318 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002319 catch (const std::exception& e)
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002320 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002321 lg2::error("getPOHCounter error: {ERROR}", "ERROR", e);
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002322 return ipmi::responseUnspecifiedError();
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002323 }
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002324}
2325
Jason M. Billsbc996a32019-06-17 15:46:37 -07002326ipmi::RspType<uint3_t, // policy support
2327 uint5_t // reserved
2328 >
George Liude1420d2025-03-03 15:14:25 +08002329 ipmiChassisSetPowerRestorePolicy(ipmi::Context::ptr ctx, uint3_t policy,
2330 uint5_t reserved)
Yong Lic6713cf2018-09-12 12:35:13 +08002331{
Yong Lic6713cf2018-09-12 12:35:13 +08002332 power_policy::DbusValue value =
2333 power_policy::RestorePolicy::Policy::AlwaysOff;
2334
Jason M. Billsbc996a32019-06-17 15:46:37 -07002335 if (reserved || (policy > power_policy::noChange))
Yong Lic6713cf2018-09-12 12:35:13 +08002336 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002337 lg2::error("Reserved request parameter: {REQ}", "REQ", lg2::hex,
2338 static_cast<int>(policy));
Jason M. Billsbc996a32019-06-17 15:46:37 -07002339 return ipmi::responseInvalidFieldRequest();
Yong Lic6713cf2018-09-12 12:35:13 +08002340 }
2341
Vernon Mauerye278ead2018-10-09 09:23:43 -07002342 if (policy == power_policy::noChange)
Yong Lic6713cf2018-09-12 12:35:13 +08002343 {
2344 // just return the supported policy
Jason M. Billsbc996a32019-06-17 15:46:37 -07002345 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002346 }
2347
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05002348 for (const auto& it : power_policy::dbusToIpmi)
Yong Lic6713cf2018-09-12 12:35:13 +08002349 {
Vernon Mauerye278ead2018-10-09 09:23:43 -07002350 if (it.second == policy)
Yong Lic6713cf2018-09-12 12:35:13 +08002351 {
2352 value = it.first;
2353 break;
2354 }
2355 }
2356
2357 try
2358 {
James Feist225dec82019-11-26 16:25:06 -08002359 settings::Objects& objects = chassis::internal::cache::getObjects();
Yong Lic6713cf2018-09-12 12:35:13 +08002360 const settings::Path& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -08002361 objects.map.at(chassis::internal::powerRestoreIntf).front();
Yong Lic6713cf2018-09-12 12:35:13 +08002362
George Liude1420d2025-03-03 15:14:25 +08002363 boost::system::error_code ec = ipmi::setDbusProperty(
2364 ctx,
2365 objects.service(powerRestoreSetting,
2366 chassis::internal::powerRestoreIntf),
2367 powerRestoreSetting, chassis::internal::powerRestoreIntf,
2368 "PowerRestorePolicy", convertForMessage(value));
Vernon Mauerye278ead2018-10-09 09:23:43 -07002369 if (ec)
Yong Lic6713cf2018-09-12 12:35:13 +08002370 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002371 lg2::error("Unspecified Error");
Vernon Mauerye278ead2018-10-09 09:23:43 -07002372 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002373 }
2374 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002375 catch (const InternalFailure& e)
Yong Lic6713cf2018-09-12 12:35:13 +08002376 {
James Feist225dec82019-11-26 16:25:06 -08002377 chassis::internal::cache::objectsPtr.reset();
Yong Lic6713cf2018-09-12 12:35:13 +08002378 report<InternalFailure>();
Vernon Mauerye278ead2018-10-09 09:23:43 -07002379 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002380 }
2381
Jason M. Billsbc996a32019-06-17 15:46:37 -07002382 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002383}
2384
Patrick Williams1318a5e2024-08-16 15:19:54 -04002385ipmi::RspType<> ipmiSetFrontPanelButtonEnables(
2386 ipmi::Context::ptr ctx, bool disablePowerButton, bool disableResetButton,
2387 bool, bool, uint4_t)
Kuiying Wang21addc52019-01-04 10:50:21 +08002388{
2389 using namespace chassis::internal;
2390
2391 // set power button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002392 bool success = setButtonDisabled(ctx, powerButtonPath, powerButtonIntf,
2393 disablePowerButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002394
2395 // set reset button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002396 success &= setButtonDisabled(ctx, resetButtonPath, resetButtonIntf,
2397 disableResetButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002398
2399 if (!success)
2400 {
2401 // not all buttons were successfully set
2402 return ipmi::responseUnspecifiedError();
2403 }
2404 return ipmi::responseSuccess();
2405}
2406
George Liu5087b072025-03-11 19:28:17 +08002407void registerNetFnChassisFunctions()
Adriana Kobylak40814c62015-10-27 15:58:44 -05002408{
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05002409 createIdentifyTimer();
2410
Tom05732372016-09-06 17:21:23 +05302411 // Get Chassis Capabilities
anil kumar appana43263c62019-05-27 12:45:04 +00002412 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2413 ipmi::chassis::cmdGetChassisCapabilities,
2414 ipmi::Privilege::User, ipmiGetChassisCap);
Nan Li8d15fb42016-08-16 22:29:40 +08002415
Kuiying Wang21addc52019-01-04 10:50:21 +08002416 // Set Front Panel Button Enables
2417 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2418 ipmi::chassis::cmdSetFrontPanelButtonEnables,
2419 ipmi::Privilege::Admin,
2420 ipmiSetFrontPanelButtonEnables);
2421
Yong Liae4b0402018-11-02 11:12:14 +08002422 // Set Chassis Capabilities
anil kumar appana894d0222019-05-27 16:32:14 +00002423 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2424 ipmi::chassis::cmdSetChassisCapabilities,
2425 ipmi::Privilege::User, ipmiSetChassisCap);
Yong Liae4b0402018-11-02 11:12:14 +08002426
Tom05732372016-09-06 17:21:23 +05302427 // <Get System Boot Options>
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002428 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2429 ipmi::chassis::cmdGetSystemBootOptions,
2430 ipmi::Privilege::Operator,
2431 ipmiChassisGetSysBootOptions);
Adriana Kobylak40814c62015-10-27 15:58:44 -05002432
Tom05732372016-09-06 17:21:23 +05302433 // <Get Chassis Status>
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07002434 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2435 ipmi::chassis::cmdGetChassisStatus,
2436 ipmi::Privilege::User, ipmiGetChassisStatus);
Nan Lifdd8ec52016-08-28 03:57:40 +08002437
Vijay Khemka074f64d2020-03-03 15:08:43 -08002438 // <Chassis Get System Restart Cause>
2439 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2440 ipmi::chassis::cmdGetSystemRestartCause,
2441 ipmi::Privilege::User, ipmiGetSystemRestartCause);
2442
Tom05732372016-09-06 17:21:23 +05302443 // <Chassis Control>
anil kumar appanadafff5f2019-04-27 18:06:00 +00002444 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2445 ipmi::chassis::cmdChassisControl,
2446 ipmi::Privilege::Operator, ipmiChassisControl);
shgoupfd84fbbf2015-12-17 10:05:51 +08002447
Tom Joseph5110c122018-03-23 17:55:40 +05302448 // <Chassis Identify>
Vernon Mauery400cc782018-10-09 13:49:53 -07002449 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2450 ipmi::chassis::cmdChassisIdentify,
2451 ipmi::Privilege::Operator, ipmiChassisIdentify);
Tom Joseph5110c122018-03-23 17:55:40 +05302452
Tom05732372016-09-06 17:21:23 +05302453 // <Set System Boot Options>
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002454 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2455 ipmi::chassis::cmdSetSystemBootOptions,
2456 ipmi::Privilege::Operator,
2457 ipmiChassisSetSysBootOptions);
2458
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002459 // <Get POH Counter>
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002460 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2461 ipmi::chassis::cmdGetPohCounter,
2462 ipmi::Privilege::User, ipmiGetPOHCounter);
Yong Lic6713cf2018-09-12 12:35:13 +08002463
2464 // <Set Power Restore Policy>
Vernon Mauerye278ead2018-10-09 09:23:43 -07002465 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2466 ipmi::chassis::cmdSetPowerRestorePolicy,
2467 ipmi::Privilege::Operator,
2468 ipmiChassisSetPowerRestorePolicy);
vishwa36993272015-11-20 12:43:49 -06002469}