blob: d4bc27de9bd037c203174d65f21406820ea49dcb [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<>;
William A. Kennington III4c008022018-10-12 17:18:14 -0700128
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500129namespace chassis
130{
131namespace internal
132{
133
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300134constexpr auto bootSettingsPath = "/xyz/openbmc_project/control/host0/boot";
135constexpr auto bootEnableIntf = "xyz.openbmc_project.Object.Enable";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500136constexpr auto bootModeIntf = "xyz.openbmc_project.Control.Boot.Mode";
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300137constexpr auto bootTypeIntf = "xyz.openbmc_project.Control.Boot.Type";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500138constexpr auto bootSourceIntf = "xyz.openbmc_project.Control.Boot.Source";
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300139constexpr auto bootSettingsOneTimePath =
140 "/xyz/openbmc_project/control/host0/boot/one_time";
141constexpr auto bootOneTimeIntf = "xyz.openbmc_project.Object.Enable";
142
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500143constexpr auto powerRestoreIntf =
144 "xyz.openbmc_project.Control.Power.RestorePolicy";
Patrick Williams5d82f472022-07-22 19:26:53 -0500145sdbusplus::bus_t dbus(ipmid_get_sd_bus_connection());
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500146
147namespace cache
148{
149
James Feist225dec82019-11-26 16:25:06 -0800150std::unique_ptr<settings::Objects> objectsPtr = nullptr;
151
152settings::Objects& getObjects()
153{
154 if (objectsPtr == nullptr)
155 {
156 objectsPtr = std::make_unique<settings::Objects>(
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300157 dbus, std::vector<std::string>{bootModeIntf, bootTypeIntf,
158 bootSourceIntf, powerRestoreIntf});
James Feist225dec82019-11-26 16:25:06 -0800159 }
160 return *objectsPtr;
161}
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500162
163} // namespace cache
164} // namespace internal
165} // namespace chassis
166
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500167namespace poh
168{
169
170constexpr auto minutesPerCount = 60;
171
172} // namespace poh
173
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000174int getHostNetworkData(ipmi::message::Payload& payload)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500175{
Ratan Guptadcb10672017-07-10 10:33:50 +0530176 ipmi::PropertyMap properties;
177 int rc = 0;
Ratan Gupta8c31d232017-08-13 05:49:43 +0530178 uint8_t addrSize = ipmi::network::IPV4_ADDRESS_SIZE_BYTE;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500179
Ratan Guptadcb10672017-07-10 10:33:50 +0530180 try
181 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700182 // TODO There may be cases where an interface is implemented by multiple
Ratan Guptadcb10672017-07-10 10:33:50 +0530183 // objects,to handle such cases we are interested on that object
184 // which are on interested busname.
185 // Currenlty mapper doesn't give the readable busname(gives busid)
186 // so we can't match with bus name so giving some object specific info
187 // as SETTINGS_MATCH.
188 // Later SETTINGS_MATCH will be replaced with busname.
Ratan Guptafd28dd72016-08-01 04:58:01 -0500189
Patrick Williams5d82f472022-07-22 19:26:53 -0500190 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Guptadcb10672017-07-10 10:33:50 +0530191
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530192 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
193 SETTINGS_ROOT, SETTINGS_MATCH);
194
195 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
196 SETTINGS_ROOT, SETTINGS_MATCH);
197
Patrick Venture0b02be92018-08-31 11:55:55 -0700198 properties = ipmi::getAllDbusProperties(
199 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400200 auto variant = ipmi::getDbusProperty(
201 bus, macObjectInfo.second, macObjectInfo.first, MAC_INTERFACE,
202 "MACAddress");
Ratan Guptadcb10672017-07-10 10:33:50 +0530203
Vernon Maueryf442e112019-04-09 11:44:36 -0700204 auto ipAddress = std::get<std::string>(properties["Address"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530205
Vernon Maueryf442e112019-04-09 11:44:36 -0700206 auto gateway = std::get<std::string>(properties["Gateway"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530207
Vernon Maueryf442e112019-04-09 11:44:36 -0700208 auto prefix = std::get<uint8_t>(properties["PrefixLength"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530209
Patrick Venture0b02be92018-08-31 11:55:55 -0700210 uint8_t isStatic =
Vernon Maueryf442e112019-04-09 11:44:36 -0700211 (std::get<std::string>(properties["Origin"]) ==
Patrick Venture0b02be92018-08-31 11:55:55 -0700212 "xyz.openbmc_project.Network.IP.AddressOrigin.Static")
213 ? 1
214 : 0;
Ratan Guptad70f4532017-08-04 02:07:31 +0530215
Vernon Maueryf442e112019-04-09 11:44:36 -0700216 auto MACAddress = std::get<std::string>(variant);
Ratan Guptacc8feb42017-07-25 21:52:10 +0530217
Ratan Guptad70f4532017-08-04 02:07:31 +0530218 // it is expected here that we should get the valid data
219 // but we may also get the default values.
220 // Validation of the data is done by settings.
221 //
222 // if mac address is default mac address then
223 // don't send blank override.
Ratan Gupta8c31d232017-08-13 05:49:43 +0530224 if ((MACAddress == ipmi::network::DEFAULT_MAC_ADDRESS))
Ratan Guptad70f4532017-08-04 02:07:31 +0530225 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530226 rc = -1;
227 return rc;
228 }
229 // if addr is static then ipaddress,gateway,prefix
230 // should not be default one,don't send blank override.
231 if (isStatic)
232 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700233 if ((ipAddress == ipmi::network::DEFAULT_ADDRESS) ||
234 (gateway == ipmi::network::DEFAULT_ADDRESS) || (!prefix))
Ratan Guptad70f4532017-08-04 02:07:31 +0530235 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530236 rc = -1;
237 return rc;
238 }
239 }
240
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000241 std::string token;
242 std::stringstream ss(MACAddress);
Ratan Guptadcb10672017-07-10 10:33:50 +0530243
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000244 // First pack macOffset no of bytes in payload.
245 // Latter this PetiBoot-Specific data will be populated.
246 std::vector<uint8_t> payloadInitialBytes(macOffset);
247 payload.pack(payloadInitialBytes);
Ratan Guptadcb10672017-07-10 10:33:50 +0530248
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000249 while (std::getline(ss, token, ':'))
250 {
251 payload.pack(stoi(token, nullptr, 16));
252 }
253
254 payload.pack(0x00);
255
256 payload.pack(isStatic);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530257
Vernon Maueryf442e112019-04-09 11:44:36 -0700258 uint8_t addressFamily = (std::get<std::string>(properties["Type"]) ==
259 "xyz.openbmc_project.Network.IP.Protocol.IPv4")
260 ? AF_INET
261 : AF_INET6;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530262
Patrick Venture0b02be92018-08-31 11:55:55 -0700263 addrSize = (addressFamily == AF_INET)
264 ? ipmi::network::IPV4_ADDRESS_SIZE_BYTE
265 : ipmi::network::IPV6_ADDRESS_SIZE_BYTE;
Ratan Guptadcb10672017-07-10 10:33:50 +0530266
267 // ipaddress and gateway would be in IPv4 format
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000268 std::vector<uint8_t> addrInBinary(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530269 inet_pton(addressFamily, ipAddress.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000270 reinterpret_cast<void*>(addrInBinary.data()));
Ratan Guptadcb10672017-07-10 10:33:50 +0530271
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000272 payload.pack(addrInBinary);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530273
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000274 payload.pack(prefix);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530275
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000276 std::vector<uint8_t> gatewayDetails(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530277 inet_pton(addressFamily, gateway.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000278 reinterpret_cast<void*>(gatewayDetails.data()));
279 payload.pack(gatewayDetails);
Ratan Guptadcb10672017-07-10 10:33:50 +0530280 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500281 catch (const InternalFailure& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530282 {
283 commit<InternalFailure>();
Ratan Guptadcb10672017-07-10 10:33:50 +0530284 rc = -1;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500285 return rc;
286 }
287
Patrick Venture0b02be92018-08-31 11:55:55 -0700288 // PetiBoot-Specific
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000289 // If success then copy the first 9 bytes to the payload message
290 // payload first 2 bytes contain the parameter values. Skip that 2 bytes.
291 uint8_t skipFirstTwoBytes = 2;
292 size_t payloadSize = payload.size();
293 uint8_t* configDataStartingAddress = payload.data() + skipFirstTwoBytes;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500294
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000295 if (payloadSize < skipFirstTwoBytes + sizeof(netConfInitialBytes))
296 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700297 lg2::error("Invalid net config");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000298 rc = -1;
299 return rc;
300 }
301 std::copy(netConfInitialBytes,
302 netConfInitialBytes + sizeof(netConfInitialBytes),
303 configDataStartingAddress);
304
305 if (payloadSize < skipFirstTwoBytes + addrSizeOffset + sizeof(addrSize))
306 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700307 lg2::error("Invalid length of address size");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000308 rc = -1;
309 return rc;
310 }
311 std::copy(&addrSize, &(addrSize) + sizeof(addrSize),
312 configDataStartingAddress + addrSizeOffset);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530313
Ratan Guptafd28dd72016-08-01 04:58:01 -0500314#ifdef _IPMI_DEBUG_
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700315 std::printf("\n===Printing the IPMI Formatted Data========\n");
Ratan Guptafd28dd72016-08-01 04:58:01 -0500316
Ratan Guptadcb10672017-07-10 10:33:50 +0530317 for (uint8_t pos = 0; pos < index; pos++)
318 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000319 std::printf("%02x ", payloadStartingAddress[pos]);
Ratan Guptadcb10672017-07-10 10:33:50 +0530320 }
Ratan Guptafd28dd72016-08-01 04:58:01 -0500321#endif
322
Ratan Guptafd28dd72016-08-01 04:58:01 -0500323 return rc;
324}
325
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530326/** @brief convert IPv4 and IPv6 addresses from binary to text form.
327 * @param[in] family - IPv4/Ipv6
328 * @param[in] data - req data pointer.
329 * @param[in] offset - offset in the data.
330 * @param[in] addrSize - size of the data which needs to be read from offset.
331 * @returns address in text form.
332 */
333
Patrick Venture0b02be92018-08-31 11:55:55 -0700334std::string getAddrStr(uint8_t family, uint8_t* data, uint8_t offset,
335 uint8_t addrSize)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530336{
337 char ipAddr[INET6_ADDRSTRLEN] = {};
338
Patrick Venture0b02be92018-08-31 11:55:55 -0700339 switch (family)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530340 {
341 case AF_INET:
342 {
Patrick Williams99db6882024-12-18 11:20:17 -0500343 struct sockaddr_in addr4{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700344 std::memcpy(&addr4.sin_addr.s_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530345
Patrick Venture0b02be92018-08-31 11:55:55 -0700346 inet_ntop(AF_INET, &addr4.sin_addr, ipAddr, INET_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530347
348 break;
349 }
350 case AF_INET6:
351 {
Patrick Williams99db6882024-12-18 11:20:17 -0500352 struct sockaddr_in6 addr6{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700353 std::memcpy(&addr6.sin6_addr.s6_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530354
Patrick Venture0b02be92018-08-31 11:55:55 -0700355 inet_ntop(AF_INET6, &addr6.sin6_addr, ipAddr, INET6_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530356
357 break;
358 }
359 default:
360 {
361 return {};
362 }
363 }
364
365 return ipAddr;
366}
367
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000368ipmi::Cc setHostNetworkData(ipmi::message::Payload& data)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500369{
Ratan Guptadcb10672017-07-10 10:33:50 +0530370 using namespace std::string_literals;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000371 std::string hostNetworkConfig;
372 std::string mac("00:00:00:00:00:00");
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530373 std::string ipAddress, gateway;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000374 std::string addrOrigin{0};
Patrick Venture0b02be92018-08-31 11:55:55 -0700375 uint8_t addrSize{0};
Ratan Guptadcb10672017-07-10 10:33:50 +0530376 std::string addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530377 "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP";
Patrick Venture0b02be92018-08-31 11:55:55 -0700378 std::string addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv4";
379 uint8_t prefix{0};
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530380 uint8_t family = AF_INET;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500381
Patrick Venture0b02be92018-08-31 11:55:55 -0700382 // cookie starts from second byte
Ratan Guptafd28dd72016-08-01 04:58:01 -0500383 // version starts from sixth byte
384
Ratan Guptadcb10672017-07-10 10:33:50 +0530385 try
Ratan Guptafd28dd72016-08-01 04:58:01 -0500386 {
Ratan Guptadcb10672017-07-10 10:33:50 +0530387 do
388 {
389 // cookie == 0x21 0x70 0x62 0x21
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000390 data.trailingOk = true;
391 auto msgLen = data.size();
392 std::vector<uint8_t> msgPayloadBytes(msgLen);
393 if (data.unpack(msgPayloadBytes) != 0 || !data.fullyUnpacked())
Ratan Guptadcb10672017-07-10 10:33:50 +0530394 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700395 lg2::error("Error in unpacking message of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000396 return ipmi::ccReqDataLenInvalid;
397 }
398
399 uint8_t* msgPayloadStartingPos = msgPayloadBytes.data();
400 constexpr size_t cookieSize = 4;
401 if (msgLen < cookieOffset + cookieSize)
402 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700403 lg2::error("Error in cookie getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000404 return ipmi::ccReqDataLenInvalid;
405 }
406 if (std::equal(msgPayloadStartingPos + cookieOffset,
407 msgPayloadStartingPos + cookieOffset + cookieSize,
408 (netConfInitialBytes + cookieOffset)) != 0)
409 {
410 // all cookie == 0
411 if (std::all_of(msgPayloadStartingPos + cookieOffset,
412 msgPayloadStartingPos + cookieOffset +
413 cookieSize,
414 [](int i) { return i == 0; }) == true)
Ratan Guptadcb10672017-07-10 10:33:50 +0530415 {
416 // need to zero out the network settings.
417 break;
418 }
419
Vernon Mauery38108d92024-03-11 12:53:55 -0700420 lg2::error("Invalid Cookie");
Ratan Guptadcb10672017-07-10 10:33:50 +0530421 elog<InternalFailure>();
422 }
423
424 // vesion == 0x00 0x01
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000425 if (msgLen < versionOffset + sizeVersion)
Ratan Guptadcb10672017-07-10 10:33:50 +0530426 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700427 lg2::error("Error in version getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000428 return ipmi::ccReqDataLenInvalid;
429 }
430 if (std::equal(msgPayloadStartingPos + versionOffset,
431 msgPayloadStartingPos + versionOffset + sizeVersion,
432 (netConfInitialBytes + versionOffset)) != 0)
433 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700434 lg2::error("Invalid Version");
Ratan Guptadcb10672017-07-10 10:33:50 +0530435 elog<InternalFailure>();
436 }
437
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000438 if (msgLen < macOffset + 6)
439 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700440 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000441 "Error in mac address getting of setHostNetworkData");
442 return ipmi::ccReqDataLenInvalid;
443 }
444 std::stringstream result;
445 std::copy((msgPayloadStartingPos + macOffset),
446 (msgPayloadStartingPos + macOffset + 5),
447 std::ostream_iterator<int>(result, ":"));
448 mac = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530449
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000450 if (msgLen < addrTypeOffset + sizeof(decltype(addrOrigin)))
451 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700452 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000453 "Error in original address getting of setHostNetworkData");
454 return ipmi::ccReqDataLenInvalid;
455 }
456 std::copy(msgPayloadStartingPos + addrTypeOffset,
457 msgPayloadStartingPos + addrTypeOffset +
458 sizeof(decltype(addrOrigin)),
459 std::ostream_iterator<int>(result, ""));
460 addrOrigin = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530461
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000462 if (!addrOrigin.empty())
Ratan Guptadcb10672017-07-10 10:33:50 +0530463 {
464 addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530465 "xyz.openbmc_project.Network.IP.AddressOrigin.Static";
Ratan Guptadcb10672017-07-10 10:33:50 +0530466 }
467
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000468 if (msgLen < addrSizeOffset + sizeof(decltype(addrSize)))
469 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700470 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000471 "Error in address size getting of setHostNetworkData");
472 return ipmi::ccReqDataLenInvalid;
473 }
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530474 // Get the address size
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000475 std::copy(msgPayloadStartingPos + addrSizeOffset,
476 (msgPayloadStartingPos + addrSizeOffset +
477 sizeof(decltype(addrSize))),
478 &addrSize);
Ratan Guptadcb10672017-07-10 10:33:50 +0530479
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000480 uint8_t prefixOffset = ipAddrOffset + addrSize;
481 if (msgLen < prefixOffset + sizeof(decltype(prefix)))
482 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700483 lg2::error("Error in prefix getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000484 return ipmi::ccReqDataLenInvalid;
485 }
William A. Kennington III4c521022023-07-28 13:07:30 -0700486 // std::copy(msgPayloadStartingPos + prefixOffset,
487 // msgPayloadStartingPos + prefixOffset +
488 // sizeof(decltype(prefix)),
489 // &prefix);
490 // Workaround compiler misdetecting out of bounds memcpy
491 prefix = msgPayloadStartingPos[prefixOffset];
Ratan Guptadcb10672017-07-10 10:33:50 +0530492
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530493 uint8_t gatewayOffset = prefixOffset + sizeof(decltype(prefix));
Ratan Gupta8c31d232017-08-13 05:49:43 +0530494 if (addrSize != ipmi::network::IPV4_ADDRESS_SIZE_BYTE)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530495 {
496 addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv6";
497 family = AF_INET6;
498 }
499
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000500 if (msgLen < ipAddrOffset + addrSize)
501 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700502 lg2::error("Error in IP address getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000503 return ipmi::ccReqDataLenInvalid;
504 }
505 ipAddress = getAddrStr(family, msgPayloadStartingPos, ipAddrOffset,
506 addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530507
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000508 if (msgLen < gatewayOffset + addrSize)
509 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700510 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000511 "Error in gateway address getting of setHostNetworkData");
512 return ipmi::ccReqDataLenInvalid;
513 }
514 gateway = getAddrStr(family, msgPayloadStartingPos, gatewayOffset,
515 addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530516
Patrick Venture0b02be92018-08-31 11:55:55 -0700517 } while (0);
Ratan Guptadcb10672017-07-10 10:33:50 +0530518
Patrick Venture0b02be92018-08-31 11:55:55 -0700519 // Cookie == 0 or it is a valid cookie
Patrick Williams1318a5e2024-08-16 15:19:54 -0400520 hostNetworkConfig +=
521 "ipaddress="s + ipAddress + ",prefix="s + std::to_string(prefix) +
522 ",gateway="s + gateway + ",mac="s + mac + ",addressOrigin="s +
523 addressOrigin;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500524
Patrick Williams5d82f472022-07-22 19:26:53 -0500525 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530526
527 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
528 SETTINGS_ROOT, SETTINGS_MATCH);
529 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
530 SETTINGS_ROOT, SETTINGS_MATCH);
Ratan Guptadcb10672017-07-10 10:33:50 +0530531 // set the dbus property
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530532 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700533 IP_INTERFACE, "Address", std::string(ipAddress));
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, "PrefixLength", prefix);
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, "Origin", addressOrigin);
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, "Gateway", std::string(gateway));
540 ipmi::setDbusProperty(
541 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE, "Type",
542 std::string("xyz.openbmc_project.Network.IP.Protocol.IPv4"));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530543 ipmi::setDbusProperty(bus, macObjectInfo.second, macObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700544 MAC_INTERFACE, "MACAddress", std::string(mac));
Ratan Guptafd28dd72016-08-01 04:58:01 -0500545
Vernon Mauery38108d92024-03-11 12:53:55 -0700546 lg2::debug("Network configuration changed: {NETWORKCONFIG}",
547 "NETWORKCONFIG", hostNetworkConfig);
Ratan Guptafd28dd72016-08-01 04:58:01 -0500548 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500549 catch (const sdbusplus::exception_t& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530550 {
551 commit<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -0700552 lg2::error("Error in ipmiChassisSetSysBootOptions call");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000553 return ipmi::ccUnspecifiedError;
Ratan Guptadcb10672017-07-10 10:33:50 +0530554 }
555
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000556 return ipmi::ccSuccess;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500557}
558
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500559uint32_t getPOHCounter()
560{
Patrick Williams5d82f472022-07-22 19:26:53 -0500561 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500562
Patrick Williams1318a5e2024-08-16 15:19:54 -0400563 auto chassisStateObj =
564 ipmi::getDbusObject(bus, chassisPOHStateIntf, chassisStateRoot, match);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500565
Patrick Williams1318a5e2024-08-16 15:19:54 -0400566 auto service =
567 ipmi::getService(bus, chassisPOHStateIntf, chassisStateObj.first);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500568
Patrick Williams1318a5e2024-08-16 15:19:54 -0400569 auto propValue =
570 ipmi::getDbusProperty(bus, service, chassisStateObj.first,
571 chassisPOHStateIntf, pohCounterProperty);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500572
Vernon Maueryf442e112019-04-09 11:44:36 -0700573 return std::get<uint32_t>(propValue);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500574}
575
anil kumar appana43263c62019-05-27 12:45:04 +0000576/** @brief Implements the get chassis capabilities command
577 *
578 * @returns IPMI completion code plus response data
579 * chassisCapFlags - chassis capability flag
580 * chassisFRUInfoDevAddr - chassis FRU info Device Address
581 * chassisSDRDevAddr - chassis SDR device address
582 * chassisSELDevAddr - chassis SEL device address
583 * chassisSMDevAddr - chassis system management device address
584 * chassisBridgeDevAddr - chassis bridge device address
585 */
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800586ipmi::RspType<bool, // chassis intrusion sensor
587 bool, // chassis Front panel lockout
588 bool, // chassis NMI
589 bool, // chassis power interlock
590 uint4_t, // reserved
anil kumar appana43263c62019-05-27 12:45:04 +0000591 uint8_t, // chassis FRU info Device Address
592 uint8_t, // chassis SDR device address
593 uint8_t, // chassis SEL device address
594 uint8_t, // chassis system management device address
595 uint8_t // chassis bridge device address
596 >
597 ipmiGetChassisCap()
Nan Li8d15fb42016-08-16 22:29:40 +0800598{
anil kumar appana43263c62019-05-27 12:45:04 +0000599 ipmi::PropertyMap properties;
Yong Liae4b0402018-11-02 11:12:14 +0800600 try
601 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500602 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nan Li8d15fb42016-08-16 22:29:40 +0800603
Yong Liae4b0402018-11-02 11:12:14 +0800604 ipmi::DbusObjectInfo chassisCapObject =
605 ipmi::getDbusObject(bus, chassisCapIntf);
Nan Li8d15fb42016-08-16 22:29:40 +0800606
Yong Liae4b0402018-11-02 11:12:14 +0800607 // capabilities flags
608 // [7..4] - reserved
609 // [3] – 1b = provides power interlock (IPM 1.5)
610 // [2] – 1b = provides Diagnostic Interrupt (FP NMI)
611 // [1] – 1b = provides “Front Panel Lockout” (indicates that the chassis
612 // has capabilities
613 // to lock out external power control and reset button or
614 // front panel interfaces and/or detect tampering with those
615 // interfaces).
616 // [0] -1b = Chassis provides intrusion (physical security) sensor.
617 // set to default value 0x0.
Nan Li8d15fb42016-08-16 22:29:40 +0800618
Patrick Williams1318a5e2024-08-16 15:19:54 -0400619 properties =
620 ipmi::getAllDbusProperties(bus, chassisCapObject.second,
621 chassisCapObject.first, chassisCapIntf);
Yong Liae4b0402018-11-02 11:12:14 +0800622 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500623 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800624 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700625 lg2::error("Failed to fetch Chassis Capability properties: {ERROR}",
626 "ERROR", e);
anil kumar appana43263c62019-05-27 12:45:04 +0000627 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800628 }
629
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800630 bool* chassisIntrusionFlag =
631 std::get_if<bool>(&properties[chassisIntrusionProp]);
632 if (chassisIntrusionFlag == nullptr)
anil kumar appana43263c62019-05-27 12:45:04 +0000633 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700634 lg2::error("Error to get chassis Intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800635 return ipmi::responseUnspecifiedError();
636 }
637 bool* chassisFrontPanelFlag =
638 std::get_if<bool>(&properties[chassisFrontPanelLockoutProp]);
639 if (chassisFrontPanelFlag == nullptr)
640 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700641 lg2::error("Error to get chassis intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800642 return ipmi::responseUnspecifiedError();
643 }
644 bool* chassisNMIFlag = std::get_if<bool>(&properties[chassisNMIProp]);
645 if (chassisNMIFlag == nullptr)
646 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700647 lg2::error("Error to get chassis NMI flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800648 return ipmi::responseUnspecifiedError();
649 }
650 bool* chassisPowerInterlockFlag =
651 std::get_if<bool>(&properties[chassisPowerInterlockProp]);
652 if (chassisPowerInterlockFlag == nullptr)
653 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700654 lg2::error("Error to get chassis power interlock flags");
anil kumar appana43263c62019-05-27 12:45:04 +0000655 return ipmi::responseUnspecifiedError();
656 }
657 uint8_t* chassisFRUInfoDevAddr =
658 std::get_if<uint8_t>(&properties[chassisFRUDevAddrProp]);
659 if (chassisFRUInfoDevAddr == nullptr)
660 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700661 lg2::error("Error to get chassis FRU info device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000662 return ipmi::responseUnspecifiedError();
663 }
664 uint8_t* chassisSDRDevAddr =
665 std::get_if<uint8_t>(&properties[chassisSDRDevAddrProp]);
666 if (chassisSDRDevAddr == nullptr)
667 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700668 lg2::error("Error to get chassis SDR device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000669 return ipmi::responseUnspecifiedError();
670 }
671 uint8_t* chassisSELDevAddr =
672 std::get_if<uint8_t>(&properties[chassisSELDevAddrProp]);
673 if (chassisSELDevAddr == nullptr)
674 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700675 lg2::error("Error to get chassis SEL device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000676 return ipmi::responseUnspecifiedError();
677 }
678 uint8_t* chassisSMDevAddr =
679 std::get_if<uint8_t>(&properties[chassisSMDevAddrProp]);
680 if (chassisSMDevAddr == nullptr)
681 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700682 lg2::error("Error to get chassis SM device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000683 return ipmi::responseUnspecifiedError();
684 }
685 uint8_t* chassisBridgeDevAddr =
686 std::get_if<uint8_t>(&properties[chassisBridgeDevAddrProp]);
687 if (chassisBridgeDevAddr == nullptr)
688 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700689 lg2::error("Error to get chassis bridge device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000690 return ipmi::responseUnspecifiedError();
691 }
692
Patrick Williams1318a5e2024-08-16 15:19:54 -0400693 return ipmi::responseSuccess(
694 *chassisIntrusionFlag, *chassisFrontPanelFlag, *chassisNMIFlag,
695 *chassisPowerInterlockFlag, 0, *chassisFRUInfoDevAddr,
696 *chassisSDRDevAddr, *chassisSELDevAddr, *chassisSMDevAddr,
697 *chassisBridgeDevAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800698}
699
anil kumar appana894d0222019-05-27 16:32:14 +0000700/** @brief implements set chassis capalibities command
701 * @param intrusion - chassis intrusion
702 * @param fpLockout - frontpannel lockout
703 * @param reserved1 - skip one bit
704 * @param fruDeviceAddr - chassis FRU info Device Address
705 * @param sdrDeviceAddr - chassis SDR device address
706 * @param selDeviceAddr - chassis SEL device address
707 * @param smDeviceAddr - chassis system management device address
708 * @param bridgeDeviceAddr - chassis bridge device address
709 *
710 * @returns IPMI completion code
711 */
Patrick Williams1318a5e2024-08-16 15:19:54 -0400712ipmi::RspType<> ipmiSetChassisCap(
713 bool intrusion, bool fpLockout, uint6_t reserved1,
anil kumar appana894d0222019-05-27 16:32:14 +0000714
Patrick Williams1318a5e2024-08-16 15:19:54 -0400715 uint8_t fruDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000716
Patrick Williams1318a5e2024-08-16 15:19:54 -0400717 uint8_t sdrDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000718
Patrick Williams1318a5e2024-08-16 15:19:54 -0400719 uint8_t selDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000720
Patrick Williams1318a5e2024-08-16 15:19:54 -0400721 uint8_t smDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000722
NikhilaDande530239b2025-09-30 09:09:40 +0530723 std::optional<uint8_t> bridgeDeviceAddr)
Yong Liae4b0402018-11-02 11:12:14 +0800724{
Yong Liae4b0402018-11-02 11:12:14 +0800725 // check input data
anil kumar appana894d0222019-05-27 16:32:14 +0000726 if (reserved1 != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800727 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700728 lg2::error("Unsupported request parameter");
anil kumar appana894d0222019-05-27 16:32:14 +0000729 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800730 }
731
anil kumar appana894d0222019-05-27 16:32:14 +0000732 if ((fruDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800733 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700734 lg2::error("Unsupported request parameter(FRU Addr) for REQ={REQ}",
735 "REQ", lg2::hex, fruDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000736 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800737 }
anil kumar appana894d0222019-05-27 16:32:14 +0000738 if ((sdrDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800739 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700740 lg2::error("Unsupported request parameter(SDR Addr) for REQ={REQ}",
741 "REQ", lg2::hex, sdrDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000742 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800743 }
744
anil kumar appana894d0222019-05-27 16:32:14 +0000745 if ((selDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800746 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700747 lg2::error("Unsupported request parameter(SEL Addr) for REQ={REQ}",
748 "REQ", lg2::hex, selDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000749 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800750 }
751
anil kumar appana894d0222019-05-27 16:32:14 +0000752 if ((smDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800753 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700754 lg2::error("Unsupported request parameter(SM Addr) for REQ={REQ}",
755 "REQ", lg2::hex, smDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000756 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800757 }
758
NikhilaDande530239b2025-09-30 09:09:40 +0530759 if (bridgeDeviceAddr.has_value())
Yong Liae4b0402018-11-02 11:12:14 +0800760 {
NikhilaDande530239b2025-09-30 09:09:40 +0530761 if ((bridgeDeviceAddr.value() & ~chassisCapAddrMask) != 0)
762 {
763 lg2::error(
764 "Unsupported request parameter(Bridge Addr) for REQ={REQ}",
765 "REQ", lg2::hex, bridgeDeviceAddr.value());
766 return ipmi::responseInvalidFieldRequest();
767 }
Yong Liae4b0402018-11-02 11:12:14 +0800768 }
769
770 try
771 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500772 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Yong Liae4b0402018-11-02 11:12:14 +0800773 ipmi::DbusObjectInfo chassisCapObject =
774 ipmi::getDbusObject(bus, chassisCapIntf);
775
776 ipmi::setDbusProperty(bus, chassisCapObject.second,
777 chassisCapObject.first, chassisCapIntf,
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800778 chassisIntrusionProp, intrusion);
779
780 ipmi::setDbusProperty(bus, chassisCapObject.second,
781 chassisCapObject.first, chassisCapIntf,
782 chassisFrontPanelLockoutProp, fpLockout);
Yong Liae4b0402018-11-02 11:12:14 +0800783
784 ipmi::setDbusProperty(bus, chassisCapObject.second,
785 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000786 chassisFRUDevAddrProp, fruDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800787
788 ipmi::setDbusProperty(bus, chassisCapObject.second,
789 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000790 chassisSDRDevAddrProp, sdrDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800791
792 ipmi::setDbusProperty(bus, chassisCapObject.second,
793 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000794 chassisSELDevAddrProp, selDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800795
796 ipmi::setDbusProperty(bus, chassisCapObject.second,
797 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000798 chassisSMDevAddrProp, smDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800799
NikhilaDande530239b2025-09-30 09:09:40 +0530800 if (bridgeDeviceAddr.has_value())
801 {
802 ipmi::setDbusProperty(bus, chassisCapObject.second,
803 chassisCapObject.first, chassisCapIntf,
804 chassisBridgeDevAddrProp,
805 bridgeDeviceAddr.value());
806 }
Yong Liae4b0402018-11-02 11:12:14 +0800807 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500808 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800809 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700810 lg2::error("Failed to set chassis capability properties: {ERR}", "ERR",
811 e);
anil kumar appana894d0222019-05-27 16:32:14 +0000812 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800813 }
anil kumar appana894d0222019-05-27 16:32:14 +0000814 return ipmi::responseSuccess();
Nan Li8d15fb42016-08-16 22:29:40 +0800815}
816
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530817//------------------------------------------
818// Calls into Host State Manager Dbus object
819//------------------------------------------
Jason M. Bills664e1c32020-01-30 16:02:39 -0800820int initiateHostStateTransition(ipmi::Context::ptr& ctx,
821 State::Host::Transition transition)
vishwa36993272015-11-20 12:43:49 -0600822{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500823 // OpenBMC Host State Manager dbus framework
Jason M. Bills664e1c32020-01-30 16:02:39 -0800824 constexpr auto hostStatePath = "/xyz/openbmc_project/state/host0";
825 constexpr auto hostStateIntf = "xyz.openbmc_project.State.Host";
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530826
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500827 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700828 auto request =
829 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
830 transition);
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530831
Jason M. Bills664e1c32020-01-30 16:02:39 -0800832 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400833 boost::system::error_code ec =
834 ipmi::getService(ctx, hostStateIntf, hostStatePath, service);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800835
836 if (!ec)
837 {
838 ec = ipmi::setDbusProperty(ctx, service, hostStatePath, hostStateIntf,
839 "RequestedHostTransition", request);
840 }
841 if (ec)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500842 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700843 lg2::error(
844 "Failed to initiate transition for request {REQUEST}: {EXCEPTION}",
845 "REQUEST", request, "EXCEPTION", ec.message());
Jason M. Bills664e1c32020-01-30 16:02:39 -0800846 return -1;
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500847 }
Vernon Mauery38108d92024-03-11 12:53:55 -0700848 lg2::info(
849 "Transition request {REQUEST} initiated successfully by user {USERID}",
850 "REQUEST", request, "USERID", ctx->userId);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800851 return 0;
vishwa36993272015-11-20 12:43:49 -0600852}
853
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800854//------------------------------------------
Jason M. Billsad588bf2020-01-30 16:18:33 -0800855// Calls into Chassis State Manager Dbus object
856//------------------------------------------
857int initiateChassisStateTransition(ipmi::Context::ptr& ctx,
858 State::Chassis::Transition transition)
859{
860 // OpenBMC Chassis State Manager dbus framework
861 constexpr auto chassisStatePath = "/xyz/openbmc_project/state/chassis0";
862 constexpr auto chassisStateIntf = "xyz.openbmc_project.State.Chassis";
863
864 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400865 boost::system::error_code ec =
866 ipmi::getService(ctx, chassisStateIntf, chassisStatePath, service);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800867
868 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700869 auto request =
870 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
871 transition);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800872
873 if (!ec)
874 {
875 ec = ipmi::setDbusProperty(ctx, service, chassisStatePath,
876 chassisStateIntf, "RequestedPowerTransition",
877 request);
878 }
879 if (ec)
880 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700881 lg2::error("Failed to initiate transition {REQUEST}: {EXCEPTION}",
882 "REQUEST", request, "EXCEPTION", ec.message());
883
Jason M. Billsad588bf2020-01-30 16:18:33 -0800884 return -1;
885 }
886
887 return 0;
888}
889
890//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000891// Trigger an NMI on the host via dbus
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800892//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000893static int doNmi(ipmi::Context::ptr& ctx)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800894{
Zev Weiss337a0972024-03-08 08:31:15 +0000895 constexpr const char* nmiIntfName = "xyz.openbmc_project.Control.Host.NMI";
896 ipmi::DbusObjectInfo nmiObj{};
897 boost::system::error_code ec;
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800898
Zev Weiss337a0972024-03-08 08:31:15 +0000899 ec = ipmi::getDbusObject(ctx, nmiIntfName, nmiObj);
Vernon Mauery9bb4a382021-11-05 12:46:19 -0700900 if (ec)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800901 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700902 lg2::error("Failed to find NMI service: {ERROR}", "ERROR",
903 ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000904 return -1;
905 }
906
George Liude1420d2025-03-03 15:14:25 +0800907 ec = ipmi::callDbusMethod(ctx, nmiObj.second, nmiObj.first, nmiIntfName,
908 "NMI");
Zev Weiss337a0972024-03-08 08:31:15 +0000909 if (ec)
910 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700911 lg2::error("NMI call failed: {ERROR}", "ERROR", ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000912 elog<InternalFailure>();
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800913 return -1;
914 }
915
916 return 0;
917}
918
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500919namespace power_policy
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500920{
Nan Lifdd8ec52016-08-28 03:57:40 +0800921
Willy Tu523e2d12023-09-05 11:36:48 -0700922using namespace sdbusplus::server::xyz::openbmc_project::control::power;
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500923using IpmiValue = uint8_t;
924using DbusValue = RestorePolicy::Policy;
Nan Lifdd8ec52016-08-28 03:57:40 +0800925
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700926const std::map<DbusValue, IpmiValue> dbusToIpmi = {
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500927 {RestorePolicy::Policy::AlwaysOff, 0x00},
928 {RestorePolicy::Policy::Restore, 0x01},
George Liue561d3e2024-02-04 15:19:30 +0800929 {RestorePolicy::Policy::AlwaysOn, 0x02},
930 {RestorePolicy::Policy::None, 0x03}};
Nan Lifdd8ec52016-08-28 03:57:40 +0800931
Yong Lic6713cf2018-09-12 12:35:13 +0800932static constexpr uint8_t noChange = 0x03;
933static constexpr uint8_t allSupport = 0x01 | 0x02 | 0x04;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700934
935/* helper function for Get Chassis Status Command
936 */
937std::optional<uint2_t> getPowerRestorePolicy()
938{
939 uint2_t restorePolicy = 0;
940 using namespace chassis::internal;
941
James Feist225dec82019-11-26 16:25:06 -0800942 settings::Objects& objects = cache::getObjects();
943
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700944 try
945 {
946 const auto& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -0800947 objects.map.at(powerRestoreIntf).front();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700948 ipmi::Value result = ipmi::getDbusProperty(
949 *getSdBus(),
James Feist225dec82019-11-26 16:25:06 -0800950 objects.service(powerRestoreSetting, powerRestoreIntf).c_str(),
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700951 powerRestoreSetting.c_str(), powerRestoreIntf,
952 "PowerRestorePolicy");
953 auto powerRestore = RestorePolicy::convertPolicyFromString(
954 std::get<std::string>(result));
955 restorePolicy = dbusToIpmi.at(powerRestore);
956 }
957 catch (const std::exception& e)
958 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700959 lg2::error(
960 "Failed to fetch pgood property ({PATH}/{INTERFACE}): {ERROR}",
961 "PATH", objects.map.at(powerRestoreIntf).front(), "INTERFACE",
962 powerRestoreIntf, "ERROR", e);
James Feist225dec82019-11-26 16:25:06 -0800963 cache::objectsPtr.reset();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700964 return std::nullopt;
965 }
966 return std::make_optional(restorePolicy);
967}
968
969/*
970 * getPowerStatus
971 * helper function for Get Chassis Status Command
972 * return - optional value for pgood (no value on error)
973 */
974std::optional<bool> getPowerStatus()
975{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700976 bool powerGood = false;
977 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus();
978 try
979 {
Jason M. Bills3de424c2019-05-21 09:57:16 -0700980 constexpr const char* chassisStatePath =
981 "/xyz/openbmc_project/state/chassis0";
982 constexpr const char* chassisStateIntf =
983 "xyz.openbmc_project.State.Chassis";
Patrick Williams1318a5e2024-08-16 15:19:54 -0400984 auto service =
985 ipmi::getService(*busp, chassisStateIntf, chassisStatePath);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700986
Jason M. Bills3de424c2019-05-21 09:57:16 -0700987 ipmi::Value powerState =
988 ipmi::getDbusProperty(*busp, service, chassisStatePath,
989 chassisStateIntf, "CurrentPowerState");
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";
1345 constexpr const char* restartCauseIntf = "xyz.openbmc_project.State.Host";
Vijay Khemka074f64d2020-03-03 15:08:43 -08001346
1347 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001348 boost::system::error_code ec =
1349 ipmi::getService(ctx, restartCauseIntf, restartCausePath, service);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001350 if (!ec)
1351 {
1352 std::string restartCauseStr;
1353 ec = ipmi::getDbusProperty<std::string>(
1354 ctx, service, restartCausePath, restartCauseIntf, "RestartCause",
1355 restartCauseStr);
1356 if (!ec)
1357 {
1358 auto cause =
1359 State::Host::convertRestartCauseFromString(restartCauseStr);
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001360 return types::enum_cast<uint4_t>(
1361 restartCauseToIpmiRestartCause(cause));
Vijay Khemka074f64d2020-03-03 15:08:43 -08001362 }
1363 }
1364
Vernon Mauery38108d92024-03-11 12:53:55 -07001365 lg2::error(
1366 "Failed to fetch RestartCause property ({PATH}/{INTERFACE}): {ERROR}",
1367 "ERROR", ec.message(), "PATH", restartCausePath, "INTERFACE",
1368 restartCauseIntf);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001369 return std::nullopt;
1370}
1371
1372ipmi::RspType<uint4_t, // Restart Cause
1373 uint4_t, // reserved
1374 uint8_t // channel number (not supported)
1375 >
1376 ipmiGetSystemRestartCause(ipmi::Context::ptr ctx)
1377{
1378 std::optional<uint4_t> cause = getRestartCause(ctx);
1379 if (!cause)
1380 {
1381 return ipmi::responseUnspecifiedError();
1382 }
1383
Vernon Mauery916d4232021-03-29 13:42:16 -07001384 constexpr uint4_t reserved = 0;
1385 auto channel = static_cast<uint8_t>(ctx->channel);
1386 return ipmi::responseSuccess(cause.value(), reserved, channel);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001387}
anil kumar appanadafff5f2019-04-27 18:06:00 +00001388/** @brief Implementation of chassis control command
1389 *
1390 * @param - chassisControl command byte
1391 *
1392 * @return Success or InvalidFieldRequest.
1393 */
Jason M. Bills664e1c32020-01-30 16:02:39 -08001394ipmi::RspType<> ipmiChassisControl(ipmi::Context::ptr& ctx,
1395 uint8_t chassisControl)
vishwa36993272015-11-20 12:43:49 -06001396{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001397 int rc = 0;
anil kumar appanadafff5f2019-04-27 18:06:00 +00001398 switch (chassisControl)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001399 {
George Liu8f4717c2025-07-03 09:22:34 +08001400 case cmdPowerOn:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001401 rc = initiateHostStateTransition(ctx, State::Host::Transition::On);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001402 break;
George Liu8f4717c2025-07-03 09:22:34 +08001403 case cmdPowerOff:
Jason M. Billsc2c3a402020-01-30 16:22:24 -08001404 rc = initiateChassisStateTransition(
1405 ctx, State::Chassis::Transition::Off);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001406 break;
George Liu8f4717c2025-07-03 09:22:34 +08001407 case cmdHardReset:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001408 rc = initiateHostStateTransition(
1409 ctx, State::Host::Transition::ForceWarmReboot);
Chanh Nguyend0a7fcd2021-07-16 22:59:28 +07001410 break;
George Liu8f4717c2025-07-03 09:22:34 +08001411 case cmdPowerCycle:
Thang Trana7d592c2025-09-17 03:43:14 +00001412 {
1413 auto powerState = power_policy::getPowerStatus();
1414
1415 if (powerState == std::nullopt)
1416 {
1417 return ipmi::responseUnspecifiedError();
1418 }
1419
1420 /*
1421 * As define in the Chapter 28.3 - Chassis Control Command of IPMI
1422 * specification: It is recommended that no action occur if system
1423 * power is off (S4/S5) when this action is selected, and that a D5
1424 * "Requiest parameter(s) not supported in this presenst state."
1425 * error completion code be returned.
1426 */
1427 if (powerState.value() == false)
1428 {
1429 return ipmi::responseCommandNotAvailable();
1430 }
1431
Jason M. Bills664e1c32020-01-30 16:02:39 -08001432 rc = initiateHostStateTransition(ctx,
1433 State::Host::Transition::Reboot);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001434 break;
Thang Trana7d592c2025-09-17 03:43:14 +00001435 }
George Liu8f4717c2025-07-03 09:22:34 +08001436 case cmdSoftOffViaOverTemp:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001437 rc = initiateHostStateTransition(ctx, State::Host::Transition::Off);
Vishwanatha Subbanna8b26d352017-08-04 18:35:18 +05301438 break;
George Liu8f4717c2025-07-03 09:22:34 +08001439 case cmdPulseDiagnosticInterrupt:
Zev Weiss337a0972024-03-08 08:31:15 +00001440 rc = doNmi(ctx);
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +08001441 break;
1442
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001443 default:
1444 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001445 lg2::error("Invalid Chassis Control command: {CMD}", "CMD",
1446 lg2::hex, chassisControl);
anil kumar appanadafff5f2019-04-27 18:06:00 +00001447 return ipmi::responseInvalidFieldRequest();
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001448 }
1449 }
vishwa36993272015-11-20 12:43:49 -06001450
anil kumar appanadafff5f2019-04-27 18:06:00 +00001451 return ((rc < 0) ? ipmi::responseUnspecifiedError()
1452 : ipmi::responseSuccess());
vishwa36993272015-11-20 12:43:49 -06001453}
1454
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001455/** @brief Return D-Bus connection string to enclosure identify LED object
1456 *
1457 * @param[in, out] connection - connection to D-Bus object
1458 * @return a IPMI return code
1459 */
1460std::string getEnclosureIdentifyConnection()
Tom Joseph5110c122018-03-23 17:55:40 +05301461{
Tom Joseph5110c122018-03-23 17:55:40 +05301462 // lookup enclosure_identify group owner(s) in mapper
George Liu3e3cc352023-07-26 15:59:31 +08001463 try
Tom Joseph5110c122018-03-23 17:55:40 +05301464 {
George Liu3e3cc352023-07-26 15:59:31 +08001465 return ipmi::getService(*getSdBus(), "xyz.openbmc_project.Led.Group",
1466 identify_led_object_name);
1467 }
1468 catch (const std::exception& e)
1469 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001470 lg2::error("Chassis Identify: Error communicating to mapper: {ERROR}",
1471 "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001472 elog<InternalFailure>();
Tom Joseph5110c122018-03-23 17:55:40 +05301473 }
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001474}
Tom Joseph5110c122018-03-23 17:55:40 +05301475
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001476/** @brief Turn On/Off enclosure identify LED
1477 *
1478 * @param[in] flag - true to turn on LED, false to turn off
1479 * @return a IPMI return code
1480 */
1481void enclosureIdentifyLed(bool flag)
1482{
1483 using namespace chassis::internal;
George Liucbe50fd2025-08-21 16:51:33 +08001484
1485 std::string connection = getEnclosureIdentifyConnection();
1486
1487 lg2::debug("enclosureIdentifyLed({FLAG})", "FLAG", flag);
1488
George Liu3e3cc352023-07-26 15:59:31 +08001489 try
1490 {
George Liu3e3cc352023-07-26 15:59:31 +08001491 ipmi::setDbusProperty(*getSdBus(), connection, identify_led_object_name,
1492 "xyz.openbmc_project.Led.Group", "Asserted",
1493 flag);
1494 }
1495 catch (const std::exception& e)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001496 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001497 lg2::error("Chassis Identify: Error Setting State {LED_STATE}: {ERROR}",
1498 "LED_STATE", flag, "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001499 elog<InternalFailure>();
1500 }
1501}
1502
1503/** @brief Callback method to turn off LED
1504 */
1505void enclosureIdentifyLedOff()
1506{
1507 try
1508 {
Yong Lif4e38512019-05-21 14:46:55 +08001509 chassisIDState = ChassisIDState::off;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001510 enclosureIdentifyLed(false);
1511 }
1512 catch (const InternalFailure& e)
1513 {
1514 report<InternalFailure>();
1515 }
1516}
1517
1518/** @brief Create timer to turn on and off the enclosure LED
1519 */
1520void createIdentifyTimer()
1521{
1522 if (!identifyTimer)
1523 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001524 identifyTimer =
Patrick Williams95655222023-12-05 12:45:02 -06001525 std::make_unique<sdbusplus::Timer>(enclosureIdentifyLedOff);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001526 }
1527}
1528
Vernon Mauery400cc782018-10-09 13:49:53 -07001529ipmi::RspType<> ipmiChassisIdentify(std::optional<uint8_t> interval,
1530 std::optional<uint8_t> force)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001531{
Vernon Mauery400cc782018-10-09 13:49:53 -07001532 uint8_t identifyInterval = interval.value_or(DEFAULT_IDENTIFY_TIME_OUT);
1533 bool forceIdentify = force.value_or(0) & 0x01;
Tom Josephbed26992018-07-31 23:00:24 +05301534
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001535 if (identifyInterval || forceIdentify)
1536 {
Vernon Mauery400cc782018-10-09 13:49:53 -07001537 // stop the timer if already started;
1538 // for force identify we should not turn off LED
Vernon Mauery1181af72018-10-08 12:05:00 -07001539 identifyTimer->stop();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001540 try
Tom Joseph5110c122018-03-23 17:55:40 +05301541 {
Yong Lif4e38512019-05-21 14:46:55 +08001542 chassisIDState = ChassisIDState::temporaryOn;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001543 enclosureIdentifyLed(true);
1544 }
1545 catch (const InternalFailure& e)
1546 {
1547 report<InternalFailure>();
Vernon Mauery400cc782018-10-09 13:49:53 -07001548 return ipmi::responseResponseError();
Tom Joseph5110c122018-03-23 17:55:40 +05301549 }
1550
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001551 if (forceIdentify)
Tom Joseph5110c122018-03-23 17:55:40 +05301552 {
Yong Lif4e38512019-05-21 14:46:55 +08001553 chassisIDState = ChassisIDState::indefiniteOn;
Vernon Mauery400cc782018-10-09 13:49:53 -07001554 return ipmi::responseSuccess();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001555 }
1556 // start the timer
1557 auto time = std::chrono::duration_cast<std::chrono::microseconds>(
Patrick Venture0b02be92018-08-31 11:55:55 -07001558 std::chrono::seconds(identifyInterval));
Vernon Mauery1181af72018-10-08 12:05:00 -07001559 identifyTimer->start(time);
Tom Joseph5110c122018-03-23 17:55:40 +05301560 }
Tom Josephbed26992018-07-31 23:00:24 +05301561 else if (!identifyInterval)
1562 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001563 identifyTimer->stop();
Tom Josephbed26992018-07-31 23:00:24 +05301564 enclosureIdentifyLedOff();
1565 }
Vernon Mauery400cc782018-10-09 13:49:53 -07001566 return ipmi::responseSuccess();
Tom Joseph5110c122018-03-23 17:55:40 +05301567}
1568
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001569namespace boot_options
1570{
1571
Willy Tu523e2d12023-09-05 11:36:48 -07001572using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001573using IpmiValue = uint8_t;
1574constexpr auto ipmiDefault = 0;
1575
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001576std::map<IpmiValue, Type::Types> typeIpmiToDbus = {{0x00, Type::Types::Legacy},
1577 {0x01, Type::Types::EFI}};
1578
Patrick Venture0b02be92018-08-31 11:55:55 -07001579std::map<IpmiValue, Source::Sources> sourceIpmiToDbus = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001580 {0x01, Source::Sources::Network},
1581 {0x02, Source::Sources::Disk},
1582 {0x05, Source::Sources::ExternalMedia},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001583 {0x0f, Source::Sources::RemovableMedia},
Patrick Venture0b02be92018-08-31 11:55:55 -07001584 {ipmiDefault, Source::Sources::Default}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001585
Patrick Venture0b02be92018-08-31 11:55:55 -07001586std::map<IpmiValue, Mode::Modes> modeIpmiToDbus = {
Yong Li5833cb62019-10-30 13:27:12 +08001587#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001588 {0x03, Mode::Modes::Safe},
Yong Li5833cb62019-10-30 13:27:12 +08001589#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001590 {0x06, Mode::Modes::Setup},
Patrick Venture0b02be92018-08-31 11:55:55 -07001591 {ipmiDefault, Mode::Modes::Regular}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001592
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001593std::map<Type::Types, IpmiValue> typeDbusToIpmi = {{Type::Types::Legacy, 0x00},
1594 {Type::Types::EFI, 0x01}};
1595
Patrick Venture0b02be92018-08-31 11:55:55 -07001596std::map<Source::Sources, IpmiValue> sourceDbusToIpmi = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001597 {Source::Sources::Network, 0x01},
1598 {Source::Sources::Disk, 0x02},
1599 {Source::Sources::ExternalMedia, 0x05},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001600 {Source::Sources::RemovableMedia, 0x0f},
Patrick Venture0b02be92018-08-31 11:55:55 -07001601 {Source::Sources::Default, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001602
Patrick Venture0b02be92018-08-31 11:55:55 -07001603std::map<Mode::Modes, IpmiValue> modeDbusToIpmi = {
Yong Li5833cb62019-10-30 13:27:12 +08001604#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001605 {Mode::Modes::Safe, 0x03},
Yong Li5833cb62019-10-30 13:27:12 +08001606#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001607 {Mode::Modes::Setup, 0x06},
Patrick Venture0b02be92018-08-31 11:55:55 -07001608 {Mode::Modes::Regular, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001609
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001610} // namespace boot_options
shgoupfd84fbbf2015-12-17 10:05:51 +08001611
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001612/** @brief Get the property value for boot source
1613 * @param[in] ctx - context pointer
1614 * @param[out] source - boot source value
1615 * @return On failure return IPMI error.
1616 */
1617static ipmi::Cc getBootSource(ipmi::Context::ptr& ctx, Source::Sources& source)
1618{
1619 using namespace chassis::internal;
1620 std::string result;
1621 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001622 boost::system::error_code ec =
1623 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001624 if (!ec)
1625 {
1626 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1627 bootSourceIntf, "BootSource", result);
1628 if (!ec)
1629 {
1630 source = Source::convertSourcesFromString(result);
1631 return ipmi::ccSuccess;
1632 }
1633 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001634 lg2::error("Error in BootSource Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001635 return ipmi::ccUnspecifiedError;
1636}
1637
Marri Devender Rao81719702018-05-07 00:53:48 -05001638/** @brief Set the property value for boot source
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001639 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001640 * @param[in] source - boot source value
1641 * @return On failure return IPMI error.
1642 */
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00001643static ipmi::Cc setBootSource(ipmi::Context::ptr& ctx,
1644 const Source::Sources& source)
Marri Devender Rao81719702018-05-07 00:53:48 -05001645{
1646 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001647 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001648 boost::system::error_code ec =
1649 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001650 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001651 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001652 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1653 bootSourceIntf, "BootSource",
1654 convertForMessage(source));
1655 if (!ec)
1656 {
1657 return ipmi::ccSuccess;
1658 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001659 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001660 lg2::error("Error in BootSource Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001661 return ipmi::ccUnspecifiedError;
1662}
1663
1664/** @brief Get the property value for boot mode
1665 * @param[in] ctx - context pointer
1666 * @param[out] mode - boot mode value
1667 * @return On failure return IPMI error.
1668 */
1669static ipmi::Cc getBootMode(ipmi::Context::ptr& ctx, Mode::Modes& mode)
1670{
1671 using namespace chassis::internal;
1672 std::string result;
1673 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001674 boost::system::error_code ec =
1675 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001676 if (!ec)
1677 {
1678 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1679 "BootMode", result);
1680 if (!ec)
1681 {
1682 mode = Mode::convertModesFromString(result);
1683 return ipmi::ccSuccess;
1684 }
1685 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001686 lg2::error("Error in BootMode Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001687 return ipmi::ccUnspecifiedError;
Marri Devender Rao81719702018-05-07 00:53:48 -05001688}
1689
Patrick Venture0b02be92018-08-31 11:55:55 -07001690/** @brief Set the property value for boot mode
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001691 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001692 * @param[in] mode - boot mode value
1693 * @return On failure return IPMI error.
1694 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001695static ipmi::Cc setBootMode(ipmi::Context::ptr& ctx, const Mode::Modes& mode)
Marri Devender Rao81719702018-05-07 00:53:48 -05001696{
1697 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001698 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001699 boost::system::error_code ec =
1700 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001701 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001702 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001703 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1704 "BootMode", convertForMessage(mode));
1705 if (!ec)
1706 {
1707 return ipmi::ccSuccess;
1708 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001709 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001710 lg2::error("Error in BootMode Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001711 return ipmi::ccUnspecifiedError;
1712}
1713
1714/** @brief Get the property value for boot type
1715 * @param[in] ctx - context pointer
1716 * @param[out] type - boot type value
1717 * @return On failure return IPMI error.
1718 */
1719static ipmi::Cc getBootType(ipmi::Context::ptr& ctx, Type::Types& type)
1720{
1721 using namespace chassis::internal;
1722 std::string result;
1723 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001724 boost::system::error_code ec =
1725 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001726
1727 // Don't throw error if BootType interface is not present.
1728 // This interface is not relevant for some Host architectures
1729 // (for example POWER). In this case we don't won't IPMI to
1730 // return an error, but simply return bootType as EFI.
1731 type = Type::Types::EFI;
1732 if (!ec)
1733 {
1734 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1735 "BootType", result);
1736 if (ec)
1737 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001738 lg2::error("Error in BootType Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001739 return ipmi::ccUnspecifiedError;
1740 }
1741 type = Type::convertTypesFromString(result);
1742 }
1743
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00001744 return ipmi::ccSuccess;
Marri Devender Rao81719702018-05-07 00:53:48 -05001745}
1746
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001747/** @brief Set the property value for boot type
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001748 * @param[in] ctx - context pointer
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001749 * @param[in] type - boot type value
1750 * @return On failure return IPMI error.
1751 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001752static ipmi::Cc setBootType(ipmi::Context::ptr& ctx, const Type::Types& type)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001753{
1754 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001755 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001756 boost::system::error_code ec =
1757 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001758 if (!ec)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001759 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001760 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1761 "BootType", convertForMessage(type));
1762 if (ec)
1763 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001764 lg2::error("Error in BootType Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001765 return ipmi::ccUnspecifiedError;
1766 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001767 }
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001768 // Don't throw error if BootType interface is not present.
1769 // This interface is not relevant for some Host architectures
1770 // (for example POWER). In this case we don't won't IPMI to
1771 // return an error, but want to just skip this function.
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001772 return ipmi::ccSuccess;
1773}
1774
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001775/** @brief Get the property value for boot override enable
1776 * @param[in] ctx - context pointer
1777 * @param[out] enable - boot override enable
1778 * @return On failure return IPMI error.
1779 */
1780static ipmi::Cc getBootEnable(ipmi::Context::ptr& ctx, bool& enable)
1781{
1782 using namespace chassis::internal;
1783 std::string result;
1784 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001785 boost::system::error_code ec =
1786 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001787 if (!ec)
1788 {
1789 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1790 bootEnableIntf, "Enabled", enable);
1791 if (!ec)
1792 {
1793 return ipmi::ccSuccess;
1794 }
1795 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001796 lg2::error("Error in Boot Override Enable Get: {ERROR}", "ERROR",
1797 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001798 return ipmi::ccUnspecifiedError;
1799}
1800
1801/** @brief Set the property value for boot override enable
1802 * @param[in] ctx - context pointer
1803 * @param[in] enable - boot override enable
1804 * @return On failure return IPMI error.
1805 */
1806static ipmi::Cc setBootEnable(ipmi::Context::ptr& ctx, const bool& enable)
1807{
1808 using namespace chassis::internal;
1809 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001810 boost::system::error_code ec =
1811 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001812 if (!ec)
1813 {
1814 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1815 bootEnableIntf, "Enabled", enable);
1816 if (!ec)
1817 {
1818 return ipmi::ccSuccess;
1819 }
1820 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001821 lg2::error("Error in Boot Source Override Enable Set: {ERROR}", "ERROR",
1822 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001823 return ipmi::ccUnspecifiedError;
1824}
1825
1826/** @brief Get the property value for boot override one-time
1827 * @param[in] ctx - context pointer
1828 * @param[out] onetime - boot override one-time
1829 * @return On failure return IPMI error.
1830 */
1831static ipmi::Cc getBootOneTime(ipmi::Context::ptr& ctx, bool& onetime)
1832{
1833 using namespace chassis::internal;
1834 std::string result;
1835 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001836 boost::system::error_code ec =
1837 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001838 if (!ec)
1839 {
1840 ec = ipmi::getDbusProperty(ctx, service, bootSettingsOneTimePath,
1841 bootOneTimeIntf, "Enabled", onetime);
1842 if (!ec)
1843 {
1844 return ipmi::ccSuccess;
1845 }
1846 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001847 lg2::error("Error in Boot Override OneTime Get: {ERROR}", "ERROR",
1848 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001849 return ipmi::ccUnspecifiedError;
1850}
1851
1852/** @brief Set the property value for boot override one-time
1853 * @param[in] ctx - context pointer
1854 * @param[in] onetime - boot override one-time
1855 * @return On failure return IPMI error.
1856 */
1857static ipmi::Cc setBootOneTime(ipmi::Context::ptr& ctx, const bool& onetime)
1858{
1859 using namespace chassis::internal;
1860 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001861 boost::system::error_code ec =
1862 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001863 if (!ec)
1864 {
1865 ec = ipmi::setDbusProperty(ctx, service, bootSettingsOneTimePath,
1866 bootOneTimeIntf, "Enabled", onetime);
1867 if (!ec)
1868 {
1869 return ipmi::ccSuccess;
1870 }
1871 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001872 lg2::error("Error in Boot Source Override OneTime Set: {ERROR}", "ERROR",
1873 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001874 return ipmi::ccUnspecifiedError;
1875}
1876
huangheab369282020-10-10 14:40:00 +08001877static constexpr uint8_t setComplete = 0x0;
1878static constexpr uint8_t setInProgress = 0x1;
1879static uint8_t transferStatus = setComplete;
Chen Yugang86ac4992021-06-25 08:14:52 +08001880static uint8_t bootFlagValidBitClr = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001881static uint5_t bootInitiatorAckData = 0x0;
Hieu Huynh1982a3f2021-09-21 03:06:45 +00001882static bool cmosClear = false;
Cosmo Chou53831212025-01-10 13:36:36 +08001883static uint2_t biosVerbosity = 0x0;
huangheab369282020-10-10 14:40:00 +08001884
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001885/** @brief implements the Get Chassis system boot option
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001886 * @param ctx - context pointer
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001887 * @param bootOptionParameter - boot option parameter selector
1888 * @param reserved1 - reserved bit
1889 * @param setSelector - selects a particular block or set of parameters
1890 * under the given parameter selector
1891 * write as 00h if parameter doesn't use a setSelector
1892 * @param blockSelector- selects a particular block within a set of
1893 * parameters write as 00h if parameter doesn't use a
1894 * blockSelector
1895 *
1896 * @return IPMI completion code plus response data
1897 * @return Payload contains below parameters:
1898 * version - parameter version
1899 * bootOptionParameter - boot option parameter selector
Patrick Venture8b1c3032020-09-15 09:43:03 -07001900 * parmIndicator - parameter valid/invalid indicator
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001901 * data - configuration parameter data
1902 */
Patrick Williams1318a5e2024-08-16 15:19:54 -04001903ipmi::RspType<ipmi::message::Payload> ipmiChassisGetSysBootOptions(
1904 ipmi::Context::ptr ctx, uint7_t bootOptionParameter, bool reserved1,
1905 [[maybe_unused]] uint8_t setSelector,
1906 [[maybe_unused]] uint8_t blockSelector)
Adriana Kobylak40814c62015-10-27 15:58:44 -05001907{
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001908 ipmi::Cc rc;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001909 if (reserved1)
1910 {
1911 return ipmi::responseInvalidFieldRequest();
1912 }
1913
1914 constexpr uint4_t version = 0x01;
1915 ipmi::message::Payload response;
1916 response.pack(version, uint4_t{});
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001917 using namespace boot_options;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001918
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001919 IpmiValue bootOption = ipmiDefault;
Adriana Kobylak40814c62015-10-27 15:58:44 -05001920
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001921 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1922 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08001923 {
1924 response.pack(bootOptionParameter, reserved1, transferStatus);
1925 return ipmi::responseSuccess(std::move(response));
1926 }
1927
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001928 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1929 BootOptionParameter::bootInfo)
John Wang0213f902020-12-28 14:49:57 +08001930 {
1931 constexpr uint8_t writeMask = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001932 response.pack(bootOptionParameter, reserved1, writeMask,
1933 bootInitiatorAckData);
John Wang0213f902020-12-28 14:49:57 +08001934 return ipmi::responseSuccess(std::move(response));
1935 }
1936
Chen Yugang86ac4992021-06-25 08:14:52 +08001937 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1938 BootOptionParameter::bootFlagValidClr)
1939 {
1940 response.pack(bootOptionParameter, reserved1,
1941 uint5_t{bootFlagValidBitClr}, uint3_t{});
1942 return ipmi::responseSuccess(std::move(response));
1943 }
1944
shgoupfd84fbbf2015-12-17 10:05:51 +08001945 /*
1946 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
1947 * This is the only parameter used by petitboot.
1948 */
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001949 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1950 BootOptionParameter::bootFlags)
Patrick Venture0b02be92018-08-31 11:55:55 -07001951 {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001952 using namespace chassis::internal;
1953 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08001954
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001955 try
ratagupta6f6bff2016-04-04 06:20:11 -05001956 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001957 Source::Sources bootSource;
1958 rc = getBootSource(ctx, bootSource);
1959 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001960 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001961 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001962 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001963
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001964 Type::Types bootType;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001965 rc = getBootType(ctx, bootType);
1966 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001967 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001968 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001969 }
1970
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001971 Mode::Modes bootMode;
1972 rc = getBootMode(ctx, bootMode);
1973 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001974 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001975 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001976 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001977
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001978 bootOption = sourceDbusToIpmi.at(bootSource);
1979 if ((Mode::Modes::Regular == bootMode) &&
1980 (Source::Sources::Default == bootSource))
1981 {
1982 bootOption = ipmiDefault;
1983 }
1984 else if (Source::Sources::Default == bootSource)
1985 {
1986 bootOption = modeDbusToIpmi.at(bootMode);
1987 }
ratagupta6f6bff2016-04-04 06:20:11 -05001988
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001989 IpmiValue biosBootType = typeDbusToIpmi.at(bootType);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001990
1991 bool oneTimeEnabled;
1992 rc = getBootOneTime(ctx, oneTimeEnabled);
1993 if (rc != ipmi::ccSuccess)
1994 {
1995 return ipmi::response(rc);
1996 }
1997
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001998 uint1_t permanent = oneTimeEnabled ? 0 : 1;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001999
2000 bool valid;
2001 rc = getBootEnable(ctx, valid);
2002 if (rc != ipmi::ccSuccess)
2003 {
2004 return ipmi::response(rc);
2005 }
2006
2007 uint1_t validFlag = valid ? 1 : 0;
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002008
Cosmo Chou53831212025-01-10 13:36:36 +08002009 response.pack(
2010 bootOptionParameter, reserved1, uint5_t{},
2011 uint1_t{biosBootType}, uint1_t{permanent}, uint1_t{validFlag},
2012 uint2_t{}, uint4_t{bootOption}, uint1_t{}, cmosClear, uint5_t{},
2013 uint2_t{biosVerbosity}, uint1_t{}, uint8_t{}, uint8_t{});
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002014 return ipmi::responseSuccess(std::move(response));
ratagupta6f6bff2016-04-04 06:20:11 -05002015 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002016 catch (const InternalFailure& e)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002017 {
James Feist225dec82019-11-26 16:25:06 -08002018 cache::objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002019 report<InternalFailure>();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002020 return ipmi::responseUnspecifiedError();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002021 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002022 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002023 else
2024 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002025 if ((bootOptionParameter >= oemParmStart) &&
2026 (bootOptionParameter <= oemParmEnd))
2027 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002028 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
2029 BootOptionParameter::opalNetworkSettings)
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002030 {
2031 response.pack(bootOptionParameter, reserved1);
2032 int ret = getHostNetworkData(response);
2033 if (ret < 0)
2034 {
2035 response.trailingOk = true;
Vernon Mauery38108d92024-03-11 12:53:55 -07002036 lg2::error(
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002037 "getHostNetworkData failed for GetSysBootOptions.");
2038 return ipmi::responseUnspecifiedError();
2039 }
2040 else
2041 {
2042 return ipmi::responseSuccess(std::move(response));
2043 }
2044 }
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002045 else
2046 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002047 lg2::error(
2048 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2049 "PARAM", lg2::hex,
2050 static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002051 return ipmi::responseParmNotSupported();
2052 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002053 }
2054 else
2055 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002056 lg2::error(
2057 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2058 "PARAM", lg2::hex, static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00002059 return ipmi::responseParmNotSupported();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002060 }
shgoupfd84fbbf2015-12-17 10:05:51 +08002061 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002062 return ipmi::responseUnspecifiedError();
shgoupfd84fbbf2015-12-17 10:05:51 +08002063}
2064
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002065ipmi::RspType<> ipmiChassisSetSysBootOptions(ipmi::Context::ptr ctx,
Willy Tu11d68892022-01-20 10:37:34 -08002066 uint7_t parameterSelector, bool,
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002067 ipmi::message::Payload& data)
shgoupfd84fbbf2015-12-17 10:05:51 +08002068{
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002069 using namespace boot_options;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002070 ipmi::Cc rc;
shgoupfd84fbbf2015-12-17 10:05:51 +08002071
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002072 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2073 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08002074 {
2075 uint2_t setInProgressFlag;
2076 uint6_t rsvd;
2077 if (data.unpack(setInProgressFlag, rsvd) != 0 || !data.fullyUnpacked())
2078 {
2079 return ipmi::responseReqDataLenInvalid();
2080 }
2081 if (rsvd)
2082 {
2083 return ipmi::responseInvalidFieldRequest();
2084 }
2085 if ((transferStatus == setInProgress) &&
2086 (static_cast<uint8_t>(setInProgressFlag) != setComplete))
2087 {
George Liuf5dd1022025-07-07 09:13:07 +08002088 return ipmi::responsefailSetInProgress();
huangheab369282020-10-10 14:40:00 +08002089 }
2090 transferStatus = static_cast<uint8_t>(setInProgressFlag);
2091 return ipmi::responseSuccess();
2092 }
2093
shgoupfd84fbbf2015-12-17 10:05:51 +08002094 /* 000101
2095 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
2096 * This is the only parameter used by petitboot.
2097 */
Ratan Guptafd28dd72016-08-01 04:58:01 -05002098
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002099 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2100 BootOptionParameter::bootFlags)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002101 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002102 uint5_t rsvd;
2103 bool validFlag;
2104 bool permanent;
2105 bool biosBootType;
2106 bool lockOutResetButton;
2107 bool screenBlank;
2108 uint4_t bootDeviceSelector;
2109 bool lockKeyboard;
Cosmo Chou53831212025-01-10 13:36:36 +08002110 uint5_t biosCtrls;
2111 bool lockOutPower;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002112 uint4_t biosInfo;
2113 uint4_t rsvd1;
2114 uint5_t deviceInstance;
2115 uint3_t rsvd2;
2116
2117 if (data.unpack(rsvd, biosBootType, permanent, validFlag,
2118 lockOutResetButton, screenBlank, bootDeviceSelector,
Cosmo Chou53831212025-01-10 13:36:36 +08002119 lockKeyboard, cmosClear, biosCtrls, biosVerbosity,
2120 lockOutPower, biosInfo, rsvd1, deviceInstance, rsvd2) !=
2121 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002122 !data.fullyUnpacked())
2123 {
2124 return ipmi::responseReqDataLenInvalid();
2125 }
2126 if (rsvd || rsvd1 || rsvd2)
2127 {
2128 return ipmi::responseInvalidFieldRequest();
2129 }
2130
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002131 using namespace chassis::internal;
2132 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08002133
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002134 try
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002135 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002136 rc = setBootOneTime(ctx, !permanent);
2137 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev69e8e842021-06-18 17:01:18 +03002138 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002139 return ipmi::response(rc);
2140 }
Vernon Maueryafd45db2021-07-29 16:27:25 +00002141
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002142 rc = setBootEnable(ctx, validFlag);
2143 if (rc != ipmi::ccSuccess)
2144 {
2145 return ipmi::response(rc);
Tom Joseph57e8eb72017-09-25 18:05:02 +05302146 }
2147
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002148 auto modeItr =
2149 modeIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002150 auto typeItr =
2151 typeIpmiToDbus.find(static_cast<uint8_t>(biosBootType));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002152 auto sourceItr =
2153 sourceIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002154 if (sourceIpmiToDbus.end() != sourceItr)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002155 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002156 rc = setBootSource(ctx, sourceItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002157 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002158 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002159 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002160 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002161 // If a set boot device is mapping to a boot source, then reset
2162 // the boot mode D-Bus property to default.
2163 // This way the ipmid code can determine which property is not
2164 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002165 if (sourceItr->second != Source::Sources::Default)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002166 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002167 rc = setBootMode(ctx, Mode::Modes::Regular);
2168 if (rc != ipmi::ccSuccess)
2169 {
2170 return ipmi::response(rc);
2171 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002172 }
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002173 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002174
2175 if (typeIpmiToDbus.end() != typeItr)
2176 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002177 rc = setBootType(ctx, typeItr->second);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002178 if (rc != ipmi::ccSuccess)
2179 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002180 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002181 }
2182 }
2183
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002184 if (modeIpmiToDbus.end() != modeItr)
2185 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002186 rc = setBootMode(ctx, modeItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002187 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002188 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002189 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002190 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002191 // If a set boot device is mapping to a boot mode, then reset
2192 // the boot source D-Bus property to default.
2193 // This way the ipmid code can determine which property is not
2194 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002195 if (modeItr->second != Mode::Modes::Regular)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002196 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002197 rc = setBootSource(ctx, Source::Sources::Default);
2198 if (rc != ipmi::ccSuccess)
2199 {
2200 return ipmi::response(rc);
2201 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002202 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002203 }
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002204 if ((modeIpmiToDbus.end() == modeItr) &&
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002205 (typeIpmiToDbus.end() == typeItr) &&
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002206 (sourceIpmiToDbus.end() == sourceItr))
2207 {
2208 // return error if boot option is not supported
Vernon Mauery38108d92024-03-11 12:53:55 -07002209 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002210 "ipmiChassisSetSysBootOptions: Boot option not supported");
2211 return ipmi::responseInvalidFieldRequest();
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002212 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002213 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002214 catch (const sdbusplus::exception_t& e)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002215 {
James Feist225dec82019-11-26 16:25:06 -08002216 objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002217 report<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -07002218 lg2::error("ipmiChassisSetSysBootOptions: Error in setting Boot "
2219 "flag parameters");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002220 return ipmi::responseUnspecifiedError();
Ratan Guptafd28dd72016-08-01 04:58:01 -05002221 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002222 }
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002223 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2224 BootOptionParameter::bootInfo)
Patrick Venture0b02be92018-08-31 11:55:55 -07002225 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002226 uint8_t writeMak;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002227 uint5_t bootInfoAck;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002228 uint3_t rsvd;
2229
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002230 if (data.unpack(writeMak, bootInfoAck, rsvd) != 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002231 !data.fullyUnpacked())
2232 {
2233 return ipmi::responseReqDataLenInvalid();
2234 }
2235 if (rsvd)
2236 {
2237 return ipmi::responseInvalidFieldRequest();
2238 }
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002239 bootInitiatorAckData &= ~writeMak;
2240 bootInitiatorAckData |= (writeMak & bootInfoAck);
Vernon Mauery38108d92024-03-11 12:53:55 -07002241 lg2::info("ipmiChassisSetSysBootOptions: bootInfo parameter set "
2242 "successfully");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002243 data.trailingOk = true;
2244 return ipmi::responseSuccess();
Patrick Venture0b02be92018-08-31 11:55:55 -07002245 }
Chen Yugang86ac4992021-06-25 08:14:52 +08002246 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2247 BootOptionParameter::bootFlagValidClr)
2248 {
2249 uint5_t bootFlagValidClr;
2250 uint3_t rsvd;
2251
2252 if (data.unpack(bootFlagValidClr, rsvd) != 0 || !data.fullyUnpacked())
2253 {
2254 return ipmi::responseReqDataLenInvalid();
2255 }
2256 if (rsvd)
2257 {
2258 return ipmi::responseInvalidFieldRequest();
2259 }
2260 // store boot flag valid bits clear value
2261 bootFlagValidBitClr = static_cast<uint8_t>(bootFlagValidClr);
Vernon Mauery38108d92024-03-11 12:53:55 -07002262 lg2::info(
Chen Yugang86ac4992021-06-25 08:14:52 +08002263 "ipmiChassisSetSysBootOptions: bootFlagValidBits parameter set "
Vernon Mauery38108d92024-03-11 12:53:55 -07002264 "successfully to {VALUE}",
2265 "VALUE", lg2::hex, bootFlagValidBitClr);
Chen Yugang86ac4992021-06-25 08:14:52 +08002266 return ipmi::responseSuccess();
2267 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002268 else
2269 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002270 if ((parameterSelector >= static_cast<uint7_t>(oemParmStart)) &&
2271 (parameterSelector <= static_cast<uint7_t>(oemParmEnd)))
2272 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002273 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2274 BootOptionParameter::opalNetworkSettings)
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002275 {
2276 ipmi::Cc ret = setHostNetworkData(data);
2277 if (ret != ipmi::ccSuccess)
2278 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002279 lg2::error("ipmiChassisSetSysBootOptions: Error in "
2280 "setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002281 data.trailingOk = true;
2282 return ipmi::response(ret);
2283 }
2284 data.trailingOk = true;
2285 return ipmi::responseSuccess();
2286 }
2287 else
2288 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002289 lg2::error(
2290 "ipmiChassisSetSysBootOptions: Unsupported param: {PARAM}",
2291 "PARAM", lg2::hex, static_cast<uint8_t>(parameterSelector));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002292 data.trailingOk = true;
2293 return ipmi::responseParmNotSupported();
2294 }
2295 }
2296 data.trailingOk = true;
2297 return ipmi::responseParmNotSupported();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002298 }
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002299 return ipmi::responseSuccess();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002300}
2301
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002302/** @brief implements Get POH counter command
2303 * @parameter
2304 * - none
2305 * @returns IPMI completion code plus response data
2306 * - minPerCount - Minutes per count
2307 * - counterReading - counter reading
2308 */
2309ipmi::RspType<uint8_t, // Minutes per count
2310 uint32_t // Counter reading
2311 >
2312 ipmiGetPOHCounter()
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002313{
2314 // sd_bus error
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002315 try
2316 {
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002317 return ipmi::responseSuccess(static_cast<uint8_t>(poh::minutesPerCount),
2318 getPOHCounter());
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002319 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002320 catch (const std::exception& e)
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002321 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002322 lg2::error("getPOHCounter error: {ERROR}", "ERROR", e);
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002323 return ipmi::responseUnspecifiedError();
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002324 }
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002325}
2326
Jason M. Billsbc996a32019-06-17 15:46:37 -07002327ipmi::RspType<uint3_t, // policy support
2328 uint5_t // reserved
2329 >
George Liude1420d2025-03-03 15:14:25 +08002330 ipmiChassisSetPowerRestorePolicy(ipmi::Context::ptr ctx, uint3_t policy,
2331 uint5_t reserved)
Yong Lic6713cf2018-09-12 12:35:13 +08002332{
Yong Lic6713cf2018-09-12 12:35:13 +08002333 power_policy::DbusValue value =
2334 power_policy::RestorePolicy::Policy::AlwaysOff;
2335
Jason M. Billsbc996a32019-06-17 15:46:37 -07002336 if (reserved || (policy > power_policy::noChange))
Yong Lic6713cf2018-09-12 12:35:13 +08002337 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002338 lg2::error("Reserved request parameter: {REQ}", "REQ", lg2::hex,
2339 static_cast<int>(policy));
Jason M. Billsbc996a32019-06-17 15:46:37 -07002340 return ipmi::responseInvalidFieldRequest();
Yong Lic6713cf2018-09-12 12:35:13 +08002341 }
2342
Vernon Mauerye278ead2018-10-09 09:23:43 -07002343 if (policy == power_policy::noChange)
Yong Lic6713cf2018-09-12 12:35:13 +08002344 {
2345 // just return the supported policy
Jason M. Billsbc996a32019-06-17 15:46:37 -07002346 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002347 }
2348
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05002349 for (const auto& it : power_policy::dbusToIpmi)
Yong Lic6713cf2018-09-12 12:35:13 +08002350 {
Vernon Mauerye278ead2018-10-09 09:23:43 -07002351 if (it.second == policy)
Yong Lic6713cf2018-09-12 12:35:13 +08002352 {
2353 value = it.first;
2354 break;
2355 }
2356 }
2357
2358 try
2359 {
James Feist225dec82019-11-26 16:25:06 -08002360 settings::Objects& objects = chassis::internal::cache::getObjects();
Yong Lic6713cf2018-09-12 12:35:13 +08002361 const settings::Path& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -08002362 objects.map.at(chassis::internal::powerRestoreIntf).front();
Yong Lic6713cf2018-09-12 12:35:13 +08002363
George Liude1420d2025-03-03 15:14:25 +08002364 boost::system::error_code ec = ipmi::setDbusProperty(
2365 ctx,
2366 objects.service(powerRestoreSetting,
2367 chassis::internal::powerRestoreIntf),
2368 powerRestoreSetting, chassis::internal::powerRestoreIntf,
2369 "PowerRestorePolicy", convertForMessage(value));
Vernon Mauerye278ead2018-10-09 09:23:43 -07002370 if (ec)
Yong Lic6713cf2018-09-12 12:35:13 +08002371 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002372 lg2::error("Unspecified Error");
Vernon Mauerye278ead2018-10-09 09:23:43 -07002373 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002374 }
2375 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002376 catch (const InternalFailure& e)
Yong Lic6713cf2018-09-12 12:35:13 +08002377 {
James Feist225dec82019-11-26 16:25:06 -08002378 chassis::internal::cache::objectsPtr.reset();
Yong Lic6713cf2018-09-12 12:35:13 +08002379 report<InternalFailure>();
Vernon Mauerye278ead2018-10-09 09:23:43 -07002380 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002381 }
2382
Jason M. Billsbc996a32019-06-17 15:46:37 -07002383 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002384}
2385
Patrick Williams1318a5e2024-08-16 15:19:54 -04002386ipmi::RspType<> ipmiSetFrontPanelButtonEnables(
2387 ipmi::Context::ptr ctx, bool disablePowerButton, bool disableResetButton,
2388 bool, bool, uint4_t)
Kuiying Wang21addc52019-01-04 10:50:21 +08002389{
2390 using namespace chassis::internal;
2391
2392 // set power button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002393 bool success = setButtonDisabled(ctx, powerButtonPath, powerButtonIntf,
2394 disablePowerButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002395
2396 // set reset button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002397 success &= setButtonDisabled(ctx, resetButtonPath, resetButtonIntf,
2398 disableResetButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002399
2400 if (!success)
2401 {
2402 // not all buttons were successfully set
2403 return ipmi::responseUnspecifiedError();
2404 }
2405 return ipmi::responseSuccess();
2406}
2407
George Liu5087b072025-03-11 19:28:17 +08002408void registerNetFnChassisFunctions()
Adriana Kobylak40814c62015-10-27 15:58:44 -05002409{
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05002410 createIdentifyTimer();
2411
Tom05732372016-09-06 17:21:23 +05302412 // Get Chassis Capabilities
anil kumar appana43263c62019-05-27 12:45:04 +00002413 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2414 ipmi::chassis::cmdGetChassisCapabilities,
2415 ipmi::Privilege::User, ipmiGetChassisCap);
Nan Li8d15fb42016-08-16 22:29:40 +08002416
Kuiying Wang21addc52019-01-04 10:50:21 +08002417 // Set Front Panel Button Enables
2418 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2419 ipmi::chassis::cmdSetFrontPanelButtonEnables,
2420 ipmi::Privilege::Admin,
2421 ipmiSetFrontPanelButtonEnables);
2422
Yong Liae4b0402018-11-02 11:12:14 +08002423 // Set Chassis Capabilities
anil kumar appana894d0222019-05-27 16:32:14 +00002424 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2425 ipmi::chassis::cmdSetChassisCapabilities,
2426 ipmi::Privilege::User, ipmiSetChassisCap);
Yong Liae4b0402018-11-02 11:12:14 +08002427
Tom05732372016-09-06 17:21:23 +05302428 // <Get System Boot Options>
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002429 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2430 ipmi::chassis::cmdGetSystemBootOptions,
2431 ipmi::Privilege::Operator,
2432 ipmiChassisGetSysBootOptions);
Adriana Kobylak40814c62015-10-27 15:58:44 -05002433
Tom05732372016-09-06 17:21:23 +05302434 // <Get Chassis Status>
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07002435 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2436 ipmi::chassis::cmdGetChassisStatus,
2437 ipmi::Privilege::User, ipmiGetChassisStatus);
Nan Lifdd8ec52016-08-28 03:57:40 +08002438
Vijay Khemka074f64d2020-03-03 15:08:43 -08002439 // <Chassis Get System Restart Cause>
2440 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2441 ipmi::chassis::cmdGetSystemRestartCause,
2442 ipmi::Privilege::User, ipmiGetSystemRestartCause);
2443
Tom05732372016-09-06 17:21:23 +05302444 // <Chassis Control>
anil kumar appanadafff5f2019-04-27 18:06:00 +00002445 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2446 ipmi::chassis::cmdChassisControl,
2447 ipmi::Privilege::Operator, ipmiChassisControl);
shgoupfd84fbbf2015-12-17 10:05:51 +08002448
Tom Joseph5110c122018-03-23 17:55:40 +05302449 // <Chassis Identify>
Vernon Mauery400cc782018-10-09 13:49:53 -07002450 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2451 ipmi::chassis::cmdChassisIdentify,
2452 ipmi::Privilege::Operator, ipmiChassisIdentify);
Tom Joseph5110c122018-03-23 17:55:40 +05302453
Tom05732372016-09-06 17:21:23 +05302454 // <Set System Boot Options>
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002455 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2456 ipmi::chassis::cmdSetSystemBootOptions,
2457 ipmi::Privilege::Operator,
2458 ipmiChassisSetSysBootOptions);
2459
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002460 // <Get POH Counter>
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002461 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2462 ipmi::chassis::cmdGetPohCounter,
2463 ipmi::Privilege::User, ipmiGetPOHCounter);
Yong Lic6713cf2018-09-12 12:35:13 +08002464
2465 // <Set Power Restore Policy>
Vernon Mauerye278ead2018-10-09 09:23:43 -07002466 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2467 ipmi::chassis::cmdSetPowerRestorePolicy,
2468 ipmi::Privilege::Operator,
2469 ipmiChassisSetPowerRestorePolicy);
vishwa36993272015-11-20 12:43:49 -06002470}