blob: f8b548c8e1501e6b8da5dea1abf7e9095c17703a [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;
64
65static inline auto responseParmNotSupported()
66{
67 return response(ccParmNotSupported);
68}
69} // namespace ipmi
70
George Liu5087b072025-03-11 19:28:17 +080071void registerNetFnChassisFunctions() __attribute__((constructor));
Adriana Kobylak40814c62015-10-27 15:58:44 -050072
shgoupfd84fbbf2015-12-17 10:05:51 +080073// Host settings in dbus
74// Service name should be referenced by connection name got via object mapper
Patrick Venture0b02be92018-08-31 11:55:55 -070075const char* settings_object_name = "/org/openbmc/settings/host0";
76const char* settings_intf_name = "org.freedesktop.DBus.Properties";
Patrick Venture0b02be92018-08-31 11:55:55 -070077const char* identify_led_object_name =
Tom Joseph5110c122018-03-23 17:55:40 +053078 "/xyz/openbmc_project/led/groups/enclosure_identify";
shgoupfd84fbbf2015-12-17 10:05:51 +080079
Ratan Guptadcb10672017-07-10 10:33:50 +053080constexpr auto SETTINGS_ROOT = "/";
81constexpr auto SETTINGS_MATCH = "host0";
Ratan Guptadcb10672017-07-10 10:33:50 +053082
83constexpr auto IP_INTERFACE = "xyz.openbmc_project.Network.IP";
84constexpr auto MAC_INTERFACE = "xyz.openbmc_project.Network.MACAddress";
85
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -050086static constexpr auto chassisStateRoot = "/xyz/openbmc_project/state";
87static constexpr auto chassisPOHStateIntf =
Patrick Venture0b02be92018-08-31 11:55:55 -070088 "xyz.openbmc_project.State.PowerOnHours";
Patrick Williams7345ac42021-04-30 20:57:39 -050089static constexpr auto pohCounterProperty = "POHCounter";
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -050090static constexpr auto match = "chassis0";
Yong Liae4b0402018-11-02 11:12:14 +080091const static constexpr char chassisCapIntf[] =
92 "xyz.openbmc_project.Control.ChassisCapabilities";
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -080093const static constexpr char chassisIntrusionProp[] = "ChassisIntrusionEnabled";
94const static constexpr char chassisFrontPanelLockoutProp[] =
95 "ChassisFrontPanelLockoutEnabled";
96const static constexpr char chassisNMIProp[] = "ChassisNMIEnabled";
97const static constexpr char chassisPowerInterlockProp[] =
98 "ChassisPowerInterlockEnabled";
Yong Liae4b0402018-11-02 11:12:14 +080099const static constexpr char chassisFRUDevAddrProp[] = "FRUDeviceAddress";
100const static constexpr char chassisSDRDevAddrProp[] = "SDRDeviceAddress";
101const static constexpr char chassisSELDevAddrProp[] = "SELDeviceAddress";
102const static constexpr char chassisSMDevAddrProp[] = "SMDeviceAddress";
103const static constexpr char chassisBridgeDevAddrProp[] = "BridgeDeviceAddress";
Yong Liae4b0402018-11-02 11:12:14 +0800104static constexpr uint8_t chassisCapAddrMask = 0xfe;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700105static constexpr const char* powerButtonIntf =
106 "xyz.openbmc_project.Chassis.Buttons.Power";
107static constexpr const char* powerButtonPath =
108 "/xyz/openbmc_project/Chassis/Buttons/Power0";
109static constexpr const char* resetButtonIntf =
110 "xyz.openbmc_project.Chassis.Buttons.Reset";
111static constexpr const char* resetButtonPath =
112 "/xyz/openbmc_project/Chassis/Buttons/Reset0";
Ratan Guptadcb10672017-07-10 10:33:50 +0530113
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530114// Phosphor Host State manager
Willy Tu523e2d12023-09-05 11:36:48 -0700115namespace State = sdbusplus::server::xyz::openbmc_project::state;
Vernon Mauery185b9f82018-07-20 10:52:36 -0700116namespace fs = std::filesystem;
Andrew Geisslera6e3a302017-05-31 19:34:00 -0500117
Ratan Guptadcb10672017-07-10 10:33:50 +0530118using namespace phosphor::logging;
Willy Tu523e2d12023-09-05 11:36:48 -0700119using namespace sdbusplus::error::xyz::openbmc_project::common;
120using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Chau Ly8c1376c2024-01-05 07:22:10 +0000121using Intrusion = sdbusplus::client::xyz::openbmc_project::chassis::Intrusion<>;
William A. Kennington III4c008022018-10-12 17:18:14 -0700122
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500123namespace chassis
124{
125namespace internal
126{
127
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300128constexpr auto bootSettingsPath = "/xyz/openbmc_project/control/host0/boot";
129constexpr auto bootEnableIntf = "xyz.openbmc_project.Object.Enable";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500130constexpr auto bootModeIntf = "xyz.openbmc_project.Control.Boot.Mode";
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300131constexpr auto bootTypeIntf = "xyz.openbmc_project.Control.Boot.Type";
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500132constexpr auto bootSourceIntf = "xyz.openbmc_project.Control.Boot.Source";
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +0300133constexpr auto bootSettingsOneTimePath =
134 "/xyz/openbmc_project/control/host0/boot/one_time";
135constexpr auto bootOneTimeIntf = "xyz.openbmc_project.Object.Enable";
136
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500137constexpr auto powerRestoreIntf =
138 "xyz.openbmc_project.Control.Power.RestorePolicy";
Patrick Williams5d82f472022-07-22 19:26:53 -0500139sdbusplus::bus_t dbus(ipmid_get_sd_bus_connection());
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500140
141namespace cache
142{
143
James Feist225dec82019-11-26 16:25:06 -0800144std::unique_ptr<settings::Objects> objectsPtr = nullptr;
145
146settings::Objects& getObjects()
147{
148 if (objectsPtr == nullptr)
149 {
150 objectsPtr = std::make_unique<settings::Objects>(
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +0300151 dbus, std::vector<std::string>{bootModeIntf, bootTypeIntf,
152 bootSourceIntf, powerRestoreIntf});
James Feist225dec82019-11-26 16:25:06 -0800153 }
154 return *objectsPtr;
155}
Deepak Kodihalli8cc19362017-07-21 11:18:38 -0500156
157} // namespace cache
158} // namespace internal
159} // namespace chassis
160
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500161namespace poh
162{
163
164constexpr auto minutesPerCount = 60;
165
166} // namespace poh
167
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000168int getHostNetworkData(ipmi::message::Payload& payload)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500169{
Ratan Guptadcb10672017-07-10 10:33:50 +0530170 ipmi::PropertyMap properties;
171 int rc = 0;
Ratan Gupta8c31d232017-08-13 05:49:43 +0530172 uint8_t addrSize = ipmi::network::IPV4_ADDRESS_SIZE_BYTE;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500173
Ratan Guptadcb10672017-07-10 10:33:50 +0530174 try
175 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700176 // TODO There may be cases where an interface is implemented by multiple
Ratan Guptadcb10672017-07-10 10:33:50 +0530177 // objects,to handle such cases we are interested on that object
178 // which are on interested busname.
179 // Currenlty mapper doesn't give the readable busname(gives busid)
180 // so we can't match with bus name so giving some object specific info
181 // as SETTINGS_MATCH.
182 // Later SETTINGS_MATCH will be replaced with busname.
Ratan Guptafd28dd72016-08-01 04:58:01 -0500183
Patrick Williams5d82f472022-07-22 19:26:53 -0500184 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Guptadcb10672017-07-10 10:33:50 +0530185
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530186 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
187 SETTINGS_ROOT, SETTINGS_MATCH);
188
189 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
190 SETTINGS_ROOT, SETTINGS_MATCH);
191
Patrick Venture0b02be92018-08-31 11:55:55 -0700192 properties = ipmi::getAllDbusProperties(
193 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400194 auto variant = ipmi::getDbusProperty(
195 bus, macObjectInfo.second, macObjectInfo.first, MAC_INTERFACE,
196 "MACAddress");
Ratan Guptadcb10672017-07-10 10:33:50 +0530197
Vernon Maueryf442e112019-04-09 11:44:36 -0700198 auto ipAddress = std::get<std::string>(properties["Address"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530199
Vernon Maueryf442e112019-04-09 11:44:36 -0700200 auto gateway = std::get<std::string>(properties["Gateway"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530201
Vernon Maueryf442e112019-04-09 11:44:36 -0700202 auto prefix = std::get<uint8_t>(properties["PrefixLength"]);
Ratan Guptad70f4532017-08-04 02:07:31 +0530203
Patrick Venture0b02be92018-08-31 11:55:55 -0700204 uint8_t isStatic =
Vernon Maueryf442e112019-04-09 11:44:36 -0700205 (std::get<std::string>(properties["Origin"]) ==
Patrick Venture0b02be92018-08-31 11:55:55 -0700206 "xyz.openbmc_project.Network.IP.AddressOrigin.Static")
207 ? 1
208 : 0;
Ratan Guptad70f4532017-08-04 02:07:31 +0530209
Vernon Maueryf442e112019-04-09 11:44:36 -0700210 auto MACAddress = std::get<std::string>(variant);
Ratan Guptacc8feb42017-07-25 21:52:10 +0530211
Ratan Guptad70f4532017-08-04 02:07:31 +0530212 // it is expected here that we should get the valid data
213 // but we may also get the default values.
214 // Validation of the data is done by settings.
215 //
216 // if mac address is default mac address then
217 // don't send blank override.
Ratan Gupta8c31d232017-08-13 05:49:43 +0530218 if ((MACAddress == ipmi::network::DEFAULT_MAC_ADDRESS))
Ratan Guptad70f4532017-08-04 02:07:31 +0530219 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530220 rc = -1;
221 return rc;
222 }
223 // if addr is static then ipaddress,gateway,prefix
224 // should not be default one,don't send blank override.
225 if (isStatic)
226 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700227 if ((ipAddress == ipmi::network::DEFAULT_ADDRESS) ||
228 (gateway == ipmi::network::DEFAULT_ADDRESS) || (!prefix))
Ratan Guptad70f4532017-08-04 02:07:31 +0530229 {
Ratan Guptad70f4532017-08-04 02:07:31 +0530230 rc = -1;
231 return rc;
232 }
233 }
234
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000235 std::string token;
236 std::stringstream ss(MACAddress);
Ratan Guptadcb10672017-07-10 10:33:50 +0530237
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000238 // First pack macOffset no of bytes in payload.
239 // Latter this PetiBoot-Specific data will be populated.
240 std::vector<uint8_t> payloadInitialBytes(macOffset);
241 payload.pack(payloadInitialBytes);
Ratan Guptadcb10672017-07-10 10:33:50 +0530242
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000243 while (std::getline(ss, token, ':'))
244 {
245 payload.pack(stoi(token, nullptr, 16));
246 }
247
248 payload.pack(0x00);
249
250 payload.pack(isStatic);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530251
Vernon Maueryf442e112019-04-09 11:44:36 -0700252 uint8_t addressFamily = (std::get<std::string>(properties["Type"]) ==
253 "xyz.openbmc_project.Network.IP.Protocol.IPv4")
254 ? AF_INET
255 : AF_INET6;
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530256
Patrick Venture0b02be92018-08-31 11:55:55 -0700257 addrSize = (addressFamily == AF_INET)
258 ? ipmi::network::IPV4_ADDRESS_SIZE_BYTE
259 : ipmi::network::IPV6_ADDRESS_SIZE_BYTE;
Ratan Guptadcb10672017-07-10 10:33:50 +0530260
261 // ipaddress and gateway would be in IPv4 format
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000262 std::vector<uint8_t> addrInBinary(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530263 inet_pton(addressFamily, ipAddress.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000264 reinterpret_cast<void*>(addrInBinary.data()));
Ratan Guptadcb10672017-07-10 10:33:50 +0530265
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000266 payload.pack(addrInBinary);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530267
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000268 payload.pack(prefix);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530269
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000270 std::vector<uint8_t> gatewayDetails(addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530271 inet_pton(addressFamily, gateway.c_str(),
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000272 reinterpret_cast<void*>(gatewayDetails.data()));
273 payload.pack(gatewayDetails);
Ratan Guptadcb10672017-07-10 10:33:50 +0530274 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500275 catch (const InternalFailure& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530276 {
277 commit<InternalFailure>();
Ratan Guptadcb10672017-07-10 10:33:50 +0530278 rc = -1;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500279 return rc;
280 }
281
Patrick Venture0b02be92018-08-31 11:55:55 -0700282 // PetiBoot-Specific
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000283 // If success then copy the first 9 bytes to the payload message
284 // payload first 2 bytes contain the parameter values. Skip that 2 bytes.
285 uint8_t skipFirstTwoBytes = 2;
286 size_t payloadSize = payload.size();
287 uint8_t* configDataStartingAddress = payload.data() + skipFirstTwoBytes;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500288
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000289 if (payloadSize < skipFirstTwoBytes + sizeof(netConfInitialBytes))
290 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700291 lg2::error("Invalid net config");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000292 rc = -1;
293 return rc;
294 }
295 std::copy(netConfInitialBytes,
296 netConfInitialBytes + sizeof(netConfInitialBytes),
297 configDataStartingAddress);
298
299 if (payloadSize < skipFirstTwoBytes + addrSizeOffset + sizeof(addrSize))
300 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700301 lg2::error("Invalid length of address size");
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000302 rc = -1;
303 return rc;
304 }
305 std::copy(&addrSize, &(addrSize) + sizeof(addrSize),
306 configDataStartingAddress + addrSizeOffset);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530307
Ratan Guptafd28dd72016-08-01 04:58:01 -0500308#ifdef _IPMI_DEBUG_
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700309 std::printf("\n===Printing the IPMI Formatted Data========\n");
Ratan Guptafd28dd72016-08-01 04:58:01 -0500310
Ratan Guptadcb10672017-07-10 10:33:50 +0530311 for (uint8_t pos = 0; pos < index; pos++)
312 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +0000313 std::printf("%02x ", payloadStartingAddress[pos]);
Ratan Guptadcb10672017-07-10 10:33:50 +0530314 }
Ratan Guptafd28dd72016-08-01 04:58:01 -0500315#endif
316
Ratan Guptafd28dd72016-08-01 04:58:01 -0500317 return rc;
318}
319
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530320/** @brief convert IPv4 and IPv6 addresses from binary to text form.
321 * @param[in] family - IPv4/Ipv6
322 * @param[in] data - req data pointer.
323 * @param[in] offset - offset in the data.
324 * @param[in] addrSize - size of the data which needs to be read from offset.
325 * @returns address in text form.
326 */
327
Patrick Venture0b02be92018-08-31 11:55:55 -0700328std::string getAddrStr(uint8_t family, uint8_t* data, uint8_t offset,
329 uint8_t addrSize)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530330{
331 char ipAddr[INET6_ADDRSTRLEN] = {};
332
Patrick Venture0b02be92018-08-31 11:55:55 -0700333 switch (family)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530334 {
335 case AF_INET:
336 {
Patrick Williams99db6882024-12-18 11:20:17 -0500337 struct sockaddr_in addr4{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700338 std::memcpy(&addr4.sin_addr.s_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530339
Patrick Venture0b02be92018-08-31 11:55:55 -0700340 inet_ntop(AF_INET, &addr4.sin_addr, ipAddr, INET_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530341
342 break;
343 }
344 case AF_INET6:
345 {
Patrick Williams99db6882024-12-18 11:20:17 -0500346 struct sockaddr_in6 addr6{};
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700347 std::memcpy(&addr6.sin6_addr.s6_addr, &data[offset], addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530348
Patrick Venture0b02be92018-08-31 11:55:55 -0700349 inet_ntop(AF_INET6, &addr6.sin6_addr, ipAddr, INET6_ADDRSTRLEN);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530350
351 break;
352 }
353 default:
354 {
355 return {};
356 }
357 }
358
359 return ipAddr;
360}
361
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000362ipmi::Cc setHostNetworkData(ipmi::message::Payload& data)
Ratan Guptafd28dd72016-08-01 04:58:01 -0500363{
Ratan Guptadcb10672017-07-10 10:33:50 +0530364 using namespace std::string_literals;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000365 std::string hostNetworkConfig;
366 std::string mac("00:00:00:00:00:00");
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530367 std::string ipAddress, gateway;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000368 std::string addrOrigin{0};
Patrick Venture0b02be92018-08-31 11:55:55 -0700369 uint8_t addrSize{0};
Ratan Guptadcb10672017-07-10 10:33:50 +0530370 std::string addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530371 "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP";
Patrick Venture0b02be92018-08-31 11:55:55 -0700372 std::string addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv4";
373 uint8_t prefix{0};
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530374 uint8_t family = AF_INET;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500375
Patrick Venture0b02be92018-08-31 11:55:55 -0700376 // cookie starts from second byte
Ratan Guptafd28dd72016-08-01 04:58:01 -0500377 // version starts from sixth byte
378
Ratan Guptadcb10672017-07-10 10:33:50 +0530379 try
Ratan Guptafd28dd72016-08-01 04:58:01 -0500380 {
Ratan Guptadcb10672017-07-10 10:33:50 +0530381 do
382 {
383 // cookie == 0x21 0x70 0x62 0x21
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000384 data.trailingOk = true;
385 auto msgLen = data.size();
386 std::vector<uint8_t> msgPayloadBytes(msgLen);
387 if (data.unpack(msgPayloadBytes) != 0 || !data.fullyUnpacked())
Ratan Guptadcb10672017-07-10 10:33:50 +0530388 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700389 lg2::error("Error in unpacking message of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000390 return ipmi::ccReqDataLenInvalid;
391 }
392
393 uint8_t* msgPayloadStartingPos = msgPayloadBytes.data();
394 constexpr size_t cookieSize = 4;
395 if (msgLen < cookieOffset + cookieSize)
396 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700397 lg2::error("Error in cookie getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000398 return ipmi::ccReqDataLenInvalid;
399 }
400 if (std::equal(msgPayloadStartingPos + cookieOffset,
401 msgPayloadStartingPos + cookieOffset + cookieSize,
402 (netConfInitialBytes + cookieOffset)) != 0)
403 {
404 // all cookie == 0
405 if (std::all_of(msgPayloadStartingPos + cookieOffset,
406 msgPayloadStartingPos + cookieOffset +
407 cookieSize,
408 [](int i) { return i == 0; }) == true)
Ratan Guptadcb10672017-07-10 10:33:50 +0530409 {
410 // need to zero out the network settings.
411 break;
412 }
413
Vernon Mauery38108d92024-03-11 12:53:55 -0700414 lg2::error("Invalid Cookie");
Ratan Guptadcb10672017-07-10 10:33:50 +0530415 elog<InternalFailure>();
416 }
417
418 // vesion == 0x00 0x01
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000419 if (msgLen < versionOffset + sizeVersion)
Ratan Guptadcb10672017-07-10 10:33:50 +0530420 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700421 lg2::error("Error in version getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000422 return ipmi::ccReqDataLenInvalid;
423 }
424 if (std::equal(msgPayloadStartingPos + versionOffset,
425 msgPayloadStartingPos + versionOffset + sizeVersion,
426 (netConfInitialBytes + versionOffset)) != 0)
427 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700428 lg2::error("Invalid Version");
Ratan Guptadcb10672017-07-10 10:33:50 +0530429 elog<InternalFailure>();
430 }
431
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000432 if (msgLen < macOffset + 6)
433 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700434 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000435 "Error in mac address getting of setHostNetworkData");
436 return ipmi::ccReqDataLenInvalid;
437 }
438 std::stringstream result;
439 std::copy((msgPayloadStartingPos + macOffset),
440 (msgPayloadStartingPos + macOffset + 5),
441 std::ostream_iterator<int>(result, ":"));
442 mac = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530443
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000444 if (msgLen < addrTypeOffset + sizeof(decltype(addrOrigin)))
445 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700446 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000447 "Error in original address getting of setHostNetworkData");
448 return ipmi::ccReqDataLenInvalid;
449 }
450 std::copy(msgPayloadStartingPos + addrTypeOffset,
451 msgPayloadStartingPos + addrTypeOffset +
452 sizeof(decltype(addrOrigin)),
453 std::ostream_iterator<int>(result, ""));
454 addrOrigin = result.str();
Ratan Guptadcb10672017-07-10 10:33:50 +0530455
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000456 if (!addrOrigin.empty())
Ratan Guptadcb10672017-07-10 10:33:50 +0530457 {
458 addressOrigin =
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530459 "xyz.openbmc_project.Network.IP.AddressOrigin.Static";
Ratan Guptadcb10672017-07-10 10:33:50 +0530460 }
461
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000462 if (msgLen < addrSizeOffset + sizeof(decltype(addrSize)))
463 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700464 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000465 "Error in address size getting of setHostNetworkData");
466 return ipmi::ccReqDataLenInvalid;
467 }
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530468 // Get the address size
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000469 std::copy(msgPayloadStartingPos + addrSizeOffset,
470 (msgPayloadStartingPos + addrSizeOffset +
471 sizeof(decltype(addrSize))),
472 &addrSize);
Ratan Guptadcb10672017-07-10 10:33:50 +0530473
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000474 uint8_t prefixOffset = ipAddrOffset + addrSize;
475 if (msgLen < prefixOffset + sizeof(decltype(prefix)))
476 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700477 lg2::error("Error in prefix getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000478 return ipmi::ccReqDataLenInvalid;
479 }
William A. Kennington III4c521022023-07-28 13:07:30 -0700480 // std::copy(msgPayloadStartingPos + prefixOffset,
481 // msgPayloadStartingPos + prefixOffset +
482 // sizeof(decltype(prefix)),
483 // &prefix);
484 // Workaround compiler misdetecting out of bounds memcpy
485 prefix = msgPayloadStartingPos[prefixOffset];
Ratan Guptadcb10672017-07-10 10:33:50 +0530486
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530487 uint8_t gatewayOffset = prefixOffset + sizeof(decltype(prefix));
Ratan Gupta8c31d232017-08-13 05:49:43 +0530488 if (addrSize != ipmi::network::IPV4_ADDRESS_SIZE_BYTE)
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530489 {
490 addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv6";
491 family = AF_INET6;
492 }
493
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000494 if (msgLen < ipAddrOffset + addrSize)
495 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700496 lg2::error("Error in IP address getting of setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000497 return ipmi::ccReqDataLenInvalid;
498 }
499 ipAddress = getAddrStr(family, msgPayloadStartingPos, ipAddrOffset,
500 addrSize);
Ratan Guptad70f4532017-08-04 02:07:31 +0530501
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000502 if (msgLen < gatewayOffset + addrSize)
503 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700504 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000505 "Error in gateway address getting of setHostNetworkData");
506 return ipmi::ccReqDataLenInvalid;
507 }
508 gateway = getAddrStr(family, msgPayloadStartingPos, gatewayOffset,
509 addrSize);
Ratan Gupta6ec7daa2017-07-15 14:13:01 +0530510
Patrick Venture0b02be92018-08-31 11:55:55 -0700511 } while (0);
Ratan Guptadcb10672017-07-10 10:33:50 +0530512
Patrick Venture0b02be92018-08-31 11:55:55 -0700513 // Cookie == 0 or it is a valid cookie
Patrick Williams1318a5e2024-08-16 15:19:54 -0400514 hostNetworkConfig +=
515 "ipaddress="s + ipAddress + ",prefix="s + std::to_string(prefix) +
516 ",gateway="s + gateway + ",mac="s + mac + ",addressOrigin="s +
517 addressOrigin;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500518
Patrick Williams5d82f472022-07-22 19:26:53 -0500519 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530520
521 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE,
522 SETTINGS_ROOT, SETTINGS_MATCH);
523 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE,
524 SETTINGS_ROOT, SETTINGS_MATCH);
Ratan Guptadcb10672017-07-10 10:33:50 +0530525 // set the dbus property
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530526 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700527 IP_INTERFACE, "Address", std::string(ipAddress));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530528 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700529 IP_INTERFACE, "PrefixLength", prefix);
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530530 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700531 IP_INTERFACE, "Origin", addressOrigin);
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, "Gateway", std::string(gateway));
534 ipmi::setDbusProperty(
535 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE, "Type",
536 std::string("xyz.openbmc_project.Network.IP.Protocol.IPv4"));
Ratan Gupta01d4bd12017-08-07 15:53:25 +0530537 ipmi::setDbusProperty(bus, macObjectInfo.second, macObjectInfo.first,
Patrick Venture0b02be92018-08-31 11:55:55 -0700538 MAC_INTERFACE, "MACAddress", std::string(mac));
Ratan Guptafd28dd72016-08-01 04:58:01 -0500539
Vernon Mauery38108d92024-03-11 12:53:55 -0700540 lg2::debug("Network configuration changed: {NETWORKCONFIG}",
541 "NETWORKCONFIG", hostNetworkConfig);
Ratan Guptafd28dd72016-08-01 04:58:01 -0500542 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500543 catch (const sdbusplus::exception_t& e)
Ratan Guptadcb10672017-07-10 10:33:50 +0530544 {
545 commit<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -0700546 lg2::error("Error in ipmiChassisSetSysBootOptions call");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000547 return ipmi::ccUnspecifiedError;
Ratan Guptadcb10672017-07-10 10:33:50 +0530548 }
549
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +0000550 return ipmi::ccSuccess;
Ratan Guptafd28dd72016-08-01 04:58:01 -0500551}
552
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500553uint32_t getPOHCounter()
554{
Patrick Williams5d82f472022-07-22 19:26:53 -0500555 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500556
Patrick Williams1318a5e2024-08-16 15:19:54 -0400557 auto chassisStateObj =
558 ipmi::getDbusObject(bus, chassisPOHStateIntf, chassisStateRoot, match);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500559
Patrick Williams1318a5e2024-08-16 15:19:54 -0400560 auto service =
561 ipmi::getService(bus, chassisPOHStateIntf, chassisStateObj.first);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500562
Patrick Williams1318a5e2024-08-16 15:19:54 -0400563 auto propValue =
564 ipmi::getDbusProperty(bus, service, chassisStateObj.first,
565 chassisPOHStateIntf, pohCounterProperty);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500566
Vernon Maueryf442e112019-04-09 11:44:36 -0700567 return std::get<uint32_t>(propValue);
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -0500568}
569
anil kumar appana43263c62019-05-27 12:45:04 +0000570/** @brief Implements the get chassis capabilities command
571 *
572 * @returns IPMI completion code plus response data
573 * chassisCapFlags - chassis capability flag
574 * chassisFRUInfoDevAddr - chassis FRU info Device Address
575 * chassisSDRDevAddr - chassis SDR device address
576 * chassisSELDevAddr - chassis SEL device address
577 * chassisSMDevAddr - chassis system management device address
578 * chassisBridgeDevAddr - chassis bridge device address
579 */
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800580ipmi::RspType<bool, // chassis intrusion sensor
581 bool, // chassis Front panel lockout
582 bool, // chassis NMI
583 bool, // chassis power interlock
584 uint4_t, // reserved
anil kumar appana43263c62019-05-27 12:45:04 +0000585 uint8_t, // chassis FRU info Device Address
586 uint8_t, // chassis SDR device address
587 uint8_t, // chassis SEL device address
588 uint8_t, // chassis system management device address
589 uint8_t // chassis bridge device address
590 >
591 ipmiGetChassisCap()
Nan Li8d15fb42016-08-16 22:29:40 +0800592{
anil kumar appana43263c62019-05-27 12:45:04 +0000593 ipmi::PropertyMap properties;
Yong Liae4b0402018-11-02 11:12:14 +0800594 try
595 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500596 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Nan Li8d15fb42016-08-16 22:29:40 +0800597
Yong Liae4b0402018-11-02 11:12:14 +0800598 ipmi::DbusObjectInfo chassisCapObject =
599 ipmi::getDbusObject(bus, chassisCapIntf);
Nan Li8d15fb42016-08-16 22:29:40 +0800600
Yong Liae4b0402018-11-02 11:12:14 +0800601 // capabilities flags
602 // [7..4] - reserved
603 // [3] – 1b = provides power interlock (IPM 1.5)
604 // [2] – 1b = provides Diagnostic Interrupt (FP NMI)
605 // [1] – 1b = provides “Front Panel Lockout” (indicates that the chassis
606 // has capabilities
607 // to lock out external power control and reset button or
608 // front panel interfaces and/or detect tampering with those
609 // interfaces).
610 // [0] -1b = Chassis provides intrusion (physical security) sensor.
611 // set to default value 0x0.
Nan Li8d15fb42016-08-16 22:29:40 +0800612
Patrick Williams1318a5e2024-08-16 15:19:54 -0400613 properties =
614 ipmi::getAllDbusProperties(bus, chassisCapObject.second,
615 chassisCapObject.first, chassisCapIntf);
Yong Liae4b0402018-11-02 11:12:14 +0800616 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500617 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800618 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700619 lg2::error("Failed to fetch Chassis Capability properties: {ERROR}",
620 "ERROR", e);
anil kumar appana43263c62019-05-27 12:45:04 +0000621 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800622 }
623
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800624 bool* chassisIntrusionFlag =
625 std::get_if<bool>(&properties[chassisIntrusionProp]);
626 if (chassisIntrusionFlag == nullptr)
anil kumar appana43263c62019-05-27 12:45:04 +0000627 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700628 lg2::error("Error to get chassis Intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800629 return ipmi::responseUnspecifiedError();
630 }
631 bool* chassisFrontPanelFlag =
632 std::get_if<bool>(&properties[chassisFrontPanelLockoutProp]);
633 if (chassisFrontPanelFlag == nullptr)
634 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700635 lg2::error("Error to get chassis intrusion flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800636 return ipmi::responseUnspecifiedError();
637 }
638 bool* chassisNMIFlag = std::get_if<bool>(&properties[chassisNMIProp]);
639 if (chassisNMIFlag == nullptr)
640 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700641 lg2::error("Error to get chassis NMI flags");
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800642 return ipmi::responseUnspecifiedError();
643 }
644 bool* chassisPowerInterlockFlag =
645 std::get_if<bool>(&properties[chassisPowerInterlockProp]);
646 if (chassisPowerInterlockFlag == nullptr)
647 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700648 lg2::error("Error to get chassis power interlock flags");
anil kumar appana43263c62019-05-27 12:45:04 +0000649 return ipmi::responseUnspecifiedError();
650 }
651 uint8_t* chassisFRUInfoDevAddr =
652 std::get_if<uint8_t>(&properties[chassisFRUDevAddrProp]);
653 if (chassisFRUInfoDevAddr == nullptr)
654 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700655 lg2::error("Error to get chassis FRU info device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000656 return ipmi::responseUnspecifiedError();
657 }
658 uint8_t* chassisSDRDevAddr =
659 std::get_if<uint8_t>(&properties[chassisSDRDevAddrProp]);
660 if (chassisSDRDevAddr == nullptr)
661 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700662 lg2::error("Error to get chassis SDR device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000663 return ipmi::responseUnspecifiedError();
664 }
665 uint8_t* chassisSELDevAddr =
666 std::get_if<uint8_t>(&properties[chassisSELDevAddrProp]);
667 if (chassisSELDevAddr == nullptr)
668 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700669 lg2::error("Error to get chassis SEL device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000670 return ipmi::responseUnspecifiedError();
671 }
672 uint8_t* chassisSMDevAddr =
673 std::get_if<uint8_t>(&properties[chassisSMDevAddrProp]);
674 if (chassisSMDevAddr == nullptr)
675 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700676 lg2::error("Error to get chassis SM device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000677 return ipmi::responseUnspecifiedError();
678 }
679 uint8_t* chassisBridgeDevAddr =
680 std::get_if<uint8_t>(&properties[chassisBridgeDevAddrProp]);
681 if (chassisBridgeDevAddr == nullptr)
682 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700683 lg2::error("Error to get chassis bridge device address");
anil kumar appana43263c62019-05-27 12:45:04 +0000684 return ipmi::responseUnspecifiedError();
685 }
686
Patrick Williams1318a5e2024-08-16 15:19:54 -0400687 return ipmi::responseSuccess(
688 *chassisIntrusionFlag, *chassisFrontPanelFlag, *chassisNMIFlag,
689 *chassisPowerInterlockFlag, 0, *chassisFRUInfoDevAddr,
690 *chassisSDRDevAddr, *chassisSELDevAddr, *chassisSMDevAddr,
691 *chassisBridgeDevAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800692}
693
anil kumar appana894d0222019-05-27 16:32:14 +0000694/** @brief implements set chassis capalibities command
695 * @param intrusion - chassis intrusion
696 * @param fpLockout - frontpannel lockout
697 * @param reserved1 - skip one bit
698 * @param fruDeviceAddr - chassis FRU info Device Address
699 * @param sdrDeviceAddr - chassis SDR device address
700 * @param selDeviceAddr - chassis SEL device address
701 * @param smDeviceAddr - chassis system management device address
702 * @param bridgeDeviceAddr - chassis bridge device address
703 *
704 * @returns IPMI completion code
705 */
Patrick Williams1318a5e2024-08-16 15:19:54 -0400706ipmi::RspType<> ipmiSetChassisCap(
707 bool intrusion, bool fpLockout, uint6_t reserved1,
anil kumar appana894d0222019-05-27 16:32:14 +0000708
Patrick Williams1318a5e2024-08-16 15:19:54 -0400709 uint8_t fruDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000710
Patrick Williams1318a5e2024-08-16 15:19:54 -0400711 uint8_t sdrDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000712
Patrick Williams1318a5e2024-08-16 15:19:54 -0400713 uint8_t selDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000714
Patrick Williams1318a5e2024-08-16 15:19:54 -0400715 uint8_t smDeviceAddr,
anil kumar appana894d0222019-05-27 16:32:14 +0000716
Patrick Williams1318a5e2024-08-16 15:19:54 -0400717 uint8_t bridgeDeviceAddr)
Yong Liae4b0402018-11-02 11:12:14 +0800718{
Yong Liae4b0402018-11-02 11:12:14 +0800719 // check input data
anil kumar appana894d0222019-05-27 16:32:14 +0000720 if (reserved1 != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800721 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700722 lg2::error("Unsupported request parameter");
anil kumar appana894d0222019-05-27 16:32:14 +0000723 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800724 }
725
anil kumar appana894d0222019-05-27 16:32:14 +0000726 if ((fruDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800727 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700728 lg2::error("Unsupported request parameter(FRU Addr) for REQ={REQ}",
729 "REQ", lg2::hex, fruDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000730 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800731 }
anil kumar appana894d0222019-05-27 16:32:14 +0000732 if ((sdrDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800733 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700734 lg2::error("Unsupported request parameter(SDR Addr) for REQ={REQ}",
735 "REQ", lg2::hex, sdrDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000736 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800737 }
738
anil kumar appana894d0222019-05-27 16:32:14 +0000739 if ((selDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800740 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700741 lg2::error("Unsupported request parameter(SEL Addr) for REQ={REQ}",
742 "REQ", lg2::hex, selDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000743 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800744 }
745
anil kumar appana894d0222019-05-27 16:32:14 +0000746 if ((smDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800747 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700748 lg2::error("Unsupported request parameter(SM Addr) for REQ={REQ}",
749 "REQ", lg2::hex, smDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000750 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800751 }
752
anil kumar appana894d0222019-05-27 16:32:14 +0000753 if ((bridgeDeviceAddr & ~chassisCapAddrMask) != 0)
Yong Liae4b0402018-11-02 11:12:14 +0800754 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700755 lg2::error("Unsupported request parameter(Bridge Addr) for REQ={REQ}",
756 "REQ", lg2::hex, bridgeDeviceAddr);
anil kumar appana894d0222019-05-27 16:32:14 +0000757 return ipmi::responseInvalidFieldRequest();
Yong Liae4b0402018-11-02 11:12:14 +0800758 }
759
760 try
761 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500762 sdbusplus::bus_t bus(ipmid_get_sd_bus_connection());
Yong Liae4b0402018-11-02 11:12:14 +0800763 ipmi::DbusObjectInfo chassisCapObject =
764 ipmi::getDbusObject(bus, chassisCapIntf);
765
766 ipmi::setDbusProperty(bus, chassisCapObject.second,
767 chassisCapObject.first, chassisCapIntf,
Karthick Sundarrajan86d8bd72019-11-26 12:48:50 -0800768 chassisIntrusionProp, intrusion);
769
770 ipmi::setDbusProperty(bus, chassisCapObject.second,
771 chassisCapObject.first, chassisCapIntf,
772 chassisFrontPanelLockoutProp, fpLockout);
Yong Liae4b0402018-11-02 11:12:14 +0800773
774 ipmi::setDbusProperty(bus, chassisCapObject.second,
775 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000776 chassisFRUDevAddrProp, fruDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800777
778 ipmi::setDbusProperty(bus, chassisCapObject.second,
779 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000780 chassisSDRDevAddrProp, sdrDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800781
782 ipmi::setDbusProperty(bus, chassisCapObject.second,
783 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000784 chassisSELDevAddrProp, selDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800785
786 ipmi::setDbusProperty(bus, chassisCapObject.second,
787 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000788 chassisSMDevAddrProp, smDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800789
790 ipmi::setDbusProperty(bus, chassisCapObject.second,
791 chassisCapObject.first, chassisCapIntf,
anil kumar appana894d0222019-05-27 16:32:14 +0000792 chassisBridgeDevAddrProp, bridgeDeviceAddr);
Yong Liae4b0402018-11-02 11:12:14 +0800793 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500794 catch (const std::exception& e)
Yong Liae4b0402018-11-02 11:12:14 +0800795 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700796 lg2::error("Failed to set chassis capability properties: {ERR}", "ERR",
797 e);
anil kumar appana894d0222019-05-27 16:32:14 +0000798 return ipmi::responseUnspecifiedError();
Yong Liae4b0402018-11-02 11:12:14 +0800799 }
anil kumar appana894d0222019-05-27 16:32:14 +0000800 return ipmi::responseSuccess();
Nan Li8d15fb42016-08-16 22:29:40 +0800801}
802
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530803//------------------------------------------
804// Calls into Host State Manager Dbus object
805//------------------------------------------
Jason M. Bills664e1c32020-01-30 16:02:39 -0800806int initiateHostStateTransition(ipmi::Context::ptr& ctx,
807 State::Host::Transition transition)
vishwa36993272015-11-20 12:43:49 -0600808{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500809 // OpenBMC Host State Manager dbus framework
Jason M. Bills664e1c32020-01-30 16:02:39 -0800810 constexpr auto hostStatePath = "/xyz/openbmc_project/state/host0";
811 constexpr auto hostStateIntf = "xyz.openbmc_project.State.Host";
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530812
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500813 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700814 auto request =
815 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
816 transition);
Vishwanatha Subbannab12b0c02017-03-07 18:17:19 +0530817
Jason M. Bills664e1c32020-01-30 16:02:39 -0800818 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400819 boost::system::error_code ec =
820 ipmi::getService(ctx, hostStateIntf, hostStatePath, service);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800821
822 if (!ec)
823 {
824 ec = ipmi::setDbusProperty(ctx, service, hostStatePath, hostStateIntf,
825 "RequestedHostTransition", request);
826 }
827 if (ec)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500828 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700829 lg2::error(
830 "Failed to initiate transition for request {REQUEST}: {EXCEPTION}",
831 "REQUEST", request, "EXCEPTION", ec.message());
Jason M. Bills664e1c32020-01-30 16:02:39 -0800832 return -1;
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500833 }
Vernon Mauery38108d92024-03-11 12:53:55 -0700834 lg2::info(
835 "Transition request {REQUEST} initiated successfully by user {USERID}",
836 "REQUEST", request, "USERID", ctx->userId);
Jason M. Bills664e1c32020-01-30 16:02:39 -0800837 return 0;
vishwa36993272015-11-20 12:43:49 -0600838}
839
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800840//------------------------------------------
Jason M. Billsad588bf2020-01-30 16:18:33 -0800841// Calls into Chassis State Manager Dbus object
842//------------------------------------------
843int initiateChassisStateTransition(ipmi::Context::ptr& ctx,
844 State::Chassis::Transition transition)
845{
846 // OpenBMC Chassis State Manager dbus framework
847 constexpr auto chassisStatePath = "/xyz/openbmc_project/state/chassis0";
848 constexpr auto chassisStateIntf = "xyz.openbmc_project.State.Chassis";
849
850 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400851 boost::system::error_code ec =
852 ipmi::getService(ctx, chassisStateIntf, chassisStatePath, service);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800853
854 // Convert to string equivalent of the passed in transition enum.
Willy Tu523e2d12023-09-05 11:36:48 -0700855 auto request =
856 sdbusplus::common::xyz::openbmc_project::state::convertForMessage(
857 transition);
Jason M. Billsad588bf2020-01-30 16:18:33 -0800858
859 if (!ec)
860 {
861 ec = ipmi::setDbusProperty(ctx, service, chassisStatePath,
862 chassisStateIntf, "RequestedPowerTransition",
863 request);
864 }
865 if (ec)
866 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700867 lg2::error("Failed to initiate transition {REQUEST}: {EXCEPTION}",
868 "REQUEST", request, "EXCEPTION", ec.message());
869
Jason M. Billsad588bf2020-01-30 16:18:33 -0800870 return -1;
871 }
872
873 return 0;
874}
875
876//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000877// Trigger an NMI on the host via dbus
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800878//------------------------------------------
Zev Weiss337a0972024-03-08 08:31:15 +0000879static int doNmi(ipmi::Context::ptr& ctx)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800880{
Zev Weiss337a0972024-03-08 08:31:15 +0000881 constexpr const char* nmiIntfName = "xyz.openbmc_project.Control.Host.NMI";
882 ipmi::DbusObjectInfo nmiObj{};
883 boost::system::error_code ec;
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800884
Zev Weiss337a0972024-03-08 08:31:15 +0000885 ec = ipmi::getDbusObject(ctx, nmiIntfName, nmiObj);
Vernon Mauery9bb4a382021-11-05 12:46:19 -0700886 if (ec)
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800887 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700888 lg2::error("Failed to find NMI service: {ERROR}", "ERROR",
889 ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000890 return -1;
891 }
892
George Liude1420d2025-03-03 15:14:25 +0800893 ec = ipmi::callDbusMethod(ctx, nmiObj.second, nmiObj.first, nmiIntfName,
894 "NMI");
Zev Weiss337a0972024-03-08 08:31:15 +0000895 if (ec)
896 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700897 lg2::error("NMI call failed: {ERROR}", "ERROR", ec.message());
Zev Weiss337a0972024-03-08 08:31:15 +0000898 elog<InternalFailure>();
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +0800899 return -1;
900 }
901
902 return 0;
903}
904
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500905namespace power_policy
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -0500906{
Nan Lifdd8ec52016-08-28 03:57:40 +0800907
Willy Tu523e2d12023-09-05 11:36:48 -0700908using namespace sdbusplus::server::xyz::openbmc_project::control::power;
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500909using IpmiValue = uint8_t;
910using DbusValue = RestorePolicy::Policy;
Nan Lifdd8ec52016-08-28 03:57:40 +0800911
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700912const std::map<DbusValue, IpmiValue> dbusToIpmi = {
Deepak Kodihalli18b70d12017-07-21 13:36:33 -0500913 {RestorePolicy::Policy::AlwaysOff, 0x00},
914 {RestorePolicy::Policy::Restore, 0x01},
George Liue561d3e2024-02-04 15:19:30 +0800915 {RestorePolicy::Policy::AlwaysOn, 0x02},
916 {RestorePolicy::Policy::None, 0x03}};
Nan Lifdd8ec52016-08-28 03:57:40 +0800917
Yong Lic6713cf2018-09-12 12:35:13 +0800918static constexpr uint8_t noChange = 0x03;
919static constexpr uint8_t allSupport = 0x01 | 0x02 | 0x04;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700920
921/* helper function for Get Chassis Status Command
922 */
923std::optional<uint2_t> getPowerRestorePolicy()
924{
925 uint2_t restorePolicy = 0;
926 using namespace chassis::internal;
927
James Feist225dec82019-11-26 16:25:06 -0800928 settings::Objects& objects = cache::getObjects();
929
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700930 try
931 {
932 const auto& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -0800933 objects.map.at(powerRestoreIntf).front();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700934 ipmi::Value result = ipmi::getDbusProperty(
935 *getSdBus(),
James Feist225dec82019-11-26 16:25:06 -0800936 objects.service(powerRestoreSetting, powerRestoreIntf).c_str(),
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700937 powerRestoreSetting.c_str(), powerRestoreIntf,
938 "PowerRestorePolicy");
939 auto powerRestore = RestorePolicy::convertPolicyFromString(
940 std::get<std::string>(result));
941 restorePolicy = dbusToIpmi.at(powerRestore);
942 }
943 catch (const std::exception& e)
944 {
Vernon Mauery38108d92024-03-11 12:53:55 -0700945 lg2::error(
946 "Failed to fetch pgood property ({PATH}/{INTERFACE}): {ERROR}",
947 "PATH", objects.map.at(powerRestoreIntf).front(), "INTERFACE",
948 powerRestoreIntf, "ERROR", e);
James Feist225dec82019-11-26 16:25:06 -0800949 cache::objectsPtr.reset();
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700950 return std::nullopt;
951 }
952 return std::make_optional(restorePolicy);
953}
954
955/*
956 * getPowerStatus
957 * helper function for Get Chassis Status Command
958 * return - optional value for pgood (no value on error)
959 */
960std::optional<bool> getPowerStatus()
961{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700962 bool powerGood = false;
963 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus();
964 try
965 {
Jason M. Bills3de424c2019-05-21 09:57:16 -0700966 constexpr const char* chassisStatePath =
967 "/xyz/openbmc_project/state/chassis0";
968 constexpr const char* chassisStateIntf =
969 "xyz.openbmc_project.State.Chassis";
Patrick Williams1318a5e2024-08-16 15:19:54 -0400970 auto service =
971 ipmi::getService(*busp, chassisStateIntf, chassisStatePath);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700972
Jason M. Bills3de424c2019-05-21 09:57:16 -0700973 ipmi::Value powerState =
974 ipmi::getDbusProperty(*busp, service, chassisStatePath,
975 chassisStateIntf, "CurrentPowerState");
Chau Lyee3983b2024-01-05 07:33:45 +0000976 std::string powerStateStr = std::get<std::string>(powerState);
977 if (powerStateStr.ends_with(".On") ||
978 powerStateStr.ends_with(".TransitioningToOff"))
979 {
980 powerGood = true;
981 }
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700982 }
983 catch (const std::exception& e)
984 {
985 try
986 {
987 // FIXME: some legacy modules use the older path; try that next
988 constexpr const char* legacyPwrCtrlObj =
989 "/org/openbmc/control/power0";
990 constexpr const char* legacyPwrCtrlIntf =
991 "org.openbmc.control.Power";
Patrick Williams1318a5e2024-08-16 15:19:54 -0400992 auto service =
993 ipmi::getService(*busp, legacyPwrCtrlIntf, legacyPwrCtrlObj);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -0700994
995 ipmi::Value variant = ipmi::getDbusProperty(
996 *busp, service, legacyPwrCtrlObj, legacyPwrCtrlIntf, "pgood");
997 powerGood = static_cast<bool>(std::get<int>(variant));
998 }
999 catch (const std::exception& e)
1000 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001001 lg2::error("Failed to fetch pgood property: {ERROR}", "ERROR", e);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001002 return std::nullopt;
1003 }
1004 }
1005 return std::make_optional(powerGood);
1006}
1007
Yong Li70ce7352019-05-16 21:15:27 +08001008/*
1009 * getACFailStatus
1010 * helper function for Get Chassis Status Command
1011 * return - bool value for ACFail (false on error)
1012 */
1013bool getACFailStatus()
1014{
1015 constexpr const char* powerControlObj =
1016 "/xyz/openbmc_project/Chassis/Control/Power0";
1017 constexpr const char* powerControlIntf =
1018 "xyz.openbmc_project.Chassis.Control.Power";
1019 bool acFail = false;
1020 std::shared_ptr<sdbusplus::asio::connection> bus = getSdBus();
1021 try
1022 {
Patrick Williams1318a5e2024-08-16 15:19:54 -04001023 auto service =
1024 ipmi::getService(*bus, powerControlIntf, powerControlObj);
Yong Li70ce7352019-05-16 21:15:27 +08001025
1026 ipmi::Value variant = ipmi::getDbusProperty(
1027 *bus, service, powerControlObj, powerControlIntf, "PFail");
1028 acFail = std::get<bool>(variant);
1029 }
1030 catch (const std::exception& e)
1031 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001032 lg2::error(
Konstantin Aladyshev37de2e12025-01-29 11:49:26 +03001033 "Failed to fetch PFail property ({PATH}/{INTERFACE}): {ERROR}",
Vernon Mauery38108d92024-03-11 12:53:55 -07001034 "PATH", powerControlObj, "INTERFACE", powerControlIntf, "ERROR", e);
Yong Li70ce7352019-05-16 21:15:27 +08001035 }
1036 return acFail;
1037}
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001038} // namespace power_policy
Nan Lifdd8ec52016-08-28 03:57:40 +08001039
Patrick Williams615a14e2025-04-07 17:07:24 -04001040static std::optional<bool> getButtonDisabled(ipmi::Context::ptr& ctx,
1041 const std::string& buttonPath,
1042 const std::string& buttonIntf)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001043{
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001044 bool buttonDisabled = false;
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001045 boost::system::error_code ec;
1046 std::string service;
1047 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1048 if (!ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001049 {
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001050 bool enabled;
1051 ec = ipmi::getDbusProperty(ctx, service, buttonPath, buttonIntf,
1052 "Enabled", enabled);
1053 buttonDisabled = !enabled;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001054 }
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001055
1056 if (ec)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001057 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001058 lg2::error("Fail to get button Enabled property ({PATH}): {ERROR}",
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001059 "PATH", buttonPath, "ERROR", ec.message());
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001060 return std::nullopt;
1061 }
1062 return std::make_optional(buttonDisabled);
1063}
1064
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001065static bool setButtonDisabled(ipmi::Context::ptr& ctx,
1066 const std::string& buttonPath,
1067 const std::string& buttonIntf, bool disable)
Kuiying Wang21addc52019-01-04 10:50:21 +08001068{
1069 std::string service;
1070 boost::system::error_code ec;
1071 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service);
1072 if (!ec)
1073 {
1074 ec = ipmi::setDbusProperty(ctx, service, buttonPath, buttonIntf,
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03001075 "Enabled", !disable);
Kuiying Wang21addc52019-01-04 10:50:21 +08001076 }
1077 if (ec)
1078 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001079 lg2::error(
1080 "Fail to set button Enabled property ({SERVICE}:{PATH}): {ERROR}",
1081 "SERVICE", service, "PATH", buttonPath, "ERROR", ec.message());
Kuiying Wang21addc52019-01-04 10:50:21 +08001082 return false;
1083 }
1084 return true;
1085}
1086
Chau Ly9e666cd2023-03-06 08:46:14 +00001087static std::optional<bool> getChassisIntrusionStatus(ipmi::Context::ptr& ctx)
1088{
Chau Ly8c1376c2024-01-05 07:22:10 +00001089 std::vector<std::string> interfaces = {std::string(Intrusion::interface)};
1090 ipmi::ObjectTree objs;
1091 std::string propVal;
1092 std::optional<bool> ret = std::nullopt;
Chau Ly9e666cd2023-03-06 08:46:14 +00001093
Chau Ly8c1376c2024-01-05 07:22:10 +00001094 boost::system::error_code ec =
1095 ipmi::getSubTree(ctx, interfaces, std::string("/"), 0, objs);
1096
1097 if (ec)
Chau Ly9e666cd2023-03-06 08:46:14 +00001098 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001099 lg2::error("Fail to find Chassis Intrusion Interface on D-Bus "
1100 "({INTERFACE}): {ERROR}",
1101 "INTERFACE", Intrusion::interface, "ERROR", ec.message());
1102 return ret;
1103 }
1104
1105 for (const auto& [path, map] : objs)
1106 {
1107 for (const auto& [service, intfs] : map)
Chau Ly9e666cd2023-03-06 08:46:14 +00001108 {
Chau Ly8c1376c2024-01-05 07:22:10 +00001109 ec = ipmi::getDbusProperty<std::string>(
1110 ctx, service, path, Intrusion::interface, "Status", propVal);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001111
Chau Ly8c1376c2024-01-05 07:22:10 +00001112 if (ec)
1113 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001114 lg2::error("Failed to get Chassis Intrusion Status property "
Chau Ly8c1376c2024-01-05 07:22:10 +00001115 "({SERVICE}/{PATH}/{INTERFACE}): {ERROR}",
1116 "SERVICE", service, "PATH", path, "INTERFACE",
1117 Intrusion::interface, "ERROR", ec.message());
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001118 continue;
Chau Ly8c1376c2024-01-05 07:22:10 +00001119 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001120
1121 auto statusOpt =
1122 sdbusplus::message::convert_from_string<Intrusion::Status>(
1123 propVal);
1124 if (statusOpt)
Chau Ly8c1376c2024-01-05 07:22:10 +00001125 {
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001126 if (*statusOpt == Intrusion::Status::Normal)
Chau Ly8c1376c2024-01-05 07:22:10 +00001127 {
1128 ret = std::make_optional(false);
1129 }
1130 else
1131 {
1132 ret = std::make_optional(true);
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001133 return ret; // Early return on first non-Normal status
Chau Ly8c1376c2024-01-05 07:22:10 +00001134 }
1135 }
Jayanth Othayoth195d5522025-06-07 02:28:07 -05001136 else
1137 {
1138 lg2::warning(
1139 "Invalid Intrusion::Status value received: {VALUE}",
1140 "VALUE", propVal);
1141 return std::nullopt;
1142 }
Chau Ly9e666cd2023-03-06 08:46:14 +00001143 }
1144 }
Chau Ly8c1376c2024-01-05 07:22:10 +00001145 return ret;
Chau Ly9e666cd2023-03-06 08:46:14 +00001146}
1147
Nan Lifdd8ec52016-08-28 03:57:40 +08001148//----------------------------------------------------------------------
1149// Get Chassis Status commands
1150//----------------------------------------------------------------------
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001151ipmi::RspType<bool, // Power is on
1152 bool, // Power overload
1153 bool, // Interlock
1154 bool, // power fault
1155 bool, // power control fault
1156 uint2_t, // power restore policy
1157 bool, // reserved
1158
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001159 bool, // AC failed
1160 bool, // last power down caused by a Power overload
1161 bool, // last power down caused by a power interlock
1162 bool, // last power down caused by power fault
Patrick Williams99db6882024-12-18 11:20:17 -05001163 bool, // last ‘Power is on’ state was entered via IPMI command
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001164 uint3_t, // reserved
1165
1166 bool, // Chassis intrusion active
1167 bool, // Front Panel Lockout active
1168 bool, // Drive Fault
1169 bool, // Cooling/fan fault detected
1170 uint2_t, // Chassis Identify State
1171 bool, // Chassis Identify command and state info supported
1172 bool, // reserved
1173
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001174 bool, // Power off button disabled
1175 bool, // Reset button disabled
1176 bool, // Diagnostic Interrupt button disabled
1177 bool, // Standby (sleep) button disabled
1178 bool, // Power off button disable allowed
1179 bool, // Reset button disable allowed
1180 bool, // Diagnostic Interrupt button disable allowed
1181 bool // Standby (sleep) button disable allowed
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001182 >
Chau Ly9e666cd2023-03-06 08:46:14 +00001183 ipmiGetChassisStatus(ipmi::Context::ptr& ctx)
Nan Lifdd8ec52016-08-28 03:57:40 +08001184{
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001185 using namespace chassis::internal;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001186 std::optional<uint2_t> restorePolicy =
1187 power_policy::getPowerRestorePolicy();
1188 std::optional<bool> powerGood = power_policy::getPowerStatus();
1189 if (!restorePolicy || !powerGood)
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001190 {
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001191 return ipmi::responseUnspecifiedError();
Deepak Kodihalli18b70d12017-07-21 13:36:33 -05001192 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001193
1194 // Front Panel Button Capabilities and disable/enable status(Optional)
Patrick Williams1318a5e2024-08-16 15:19:54 -04001195 std::optional<bool> powerButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001196 getButtonDisabled(ctx, powerButtonPath, powerButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001197 // allow disable if the interface is present
1198 bool powerButtonDisableAllow = static_cast<bool>(powerButtonReading);
1199 // default return the button is enabled (not disabled)
1200 bool powerButtonDisabled = false;
1201 if (powerButtonDisableAllow)
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001202 {
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001203 // return the real value of the button status, if present
1204 powerButtonDisabled = *powerButtonReading;
1205 }
1206
Patrick Williams1318a5e2024-08-16 15:19:54 -04001207 std::optional<bool> resetButtonReading =
Konstantin Aladyshev2738b9e2025-02-15 00:56:19 +03001208 getButtonDisabled(ctx, resetButtonPath, resetButtonIntf);
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001209 // allow disable if the interface is present
1210 bool resetButtonDisableAllow = static_cast<bool>(resetButtonReading);
1211 // default return the button is enabled (not disabled)
1212 bool resetButtonDisabled = false;
1213 if (resetButtonDisableAllow)
1214 {
1215 // return the real value of the button status, if present
1216 resetButtonDisabled = *resetButtonReading;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001217 }
Nan Lifdd8ec52016-08-28 03:57:40 +08001218
Yong Li70ce7352019-05-16 21:15:27 +08001219 bool powerDownAcFailed = power_policy::getACFailStatus();
1220
Chau Ly9e666cd2023-03-06 08:46:14 +00001221 bool chassisIntrusionActive = false;
1222 std::optional<bool> chassisIntrusionStatus = getChassisIntrusionStatus(ctx);
1223 if (chassisIntrusionStatus)
1224 {
1225 chassisIntrusionActive = chassisIntrusionStatus.value();
1226 }
1227
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001228 // This response has a lot of hard-coded, unsupported fields
1229 // They are set to false or 0
1230 constexpr bool powerOverload = false;
1231 constexpr bool chassisInterlock = false;
1232 constexpr bool powerFault = false;
1233 constexpr bool powerControlFault = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001234 constexpr bool powerDownOverload = false;
1235 constexpr bool powerDownInterlock = false;
1236 constexpr bool powerDownPowerFault = false;
1237 constexpr bool powerStatusIPMI = false;
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001238 constexpr bool frontPanelLockoutActive = false;
1239 constexpr bool driveFault = false;
1240 constexpr bool coolingFanFault = false;
1241 // chassisIdentifySupport set because this command is implemented
1242 constexpr bool chassisIdentifySupport = true;
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001243 uint2_t chassisIdentifyState = types::enum_cast<uint2_t>(chassisIDState);
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001244 constexpr bool diagButtonDisabled = false;
1245 constexpr bool sleepButtonDisabled = false;
1246 constexpr bool diagButtonDisableAllow = false;
1247 constexpr bool sleepButtonDisableAllow = false;
1248
1249 return ipmi::responseSuccess(
1250 *powerGood, powerOverload, chassisInterlock, powerFault,
1251 powerControlFault, *restorePolicy,
1252 false, // reserved
1253
1254 powerDownAcFailed, powerDownOverload, powerDownInterlock,
1255 powerDownPowerFault, powerStatusIPMI,
1256 uint3_t(0), // reserved
1257
1258 chassisIntrusionActive, frontPanelLockoutActive, driveFault,
1259 coolingFanFault, chassisIdentifyState, chassisIdentifySupport,
1260 false, // reserved
1261
Vernon Mauery6d5b2f72019-05-16 14:48:47 -07001262 powerButtonDisabled, resetButtonDisabled, diagButtonDisabled,
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07001263 sleepButtonDisabled, powerButtonDisableAllow, resetButtonDisableAllow,
1264 diagButtonDisableAllow, sleepButtonDisableAllow);
Nan Lifdd8ec52016-08-28 03:57:40 +08001265}
Chris Austen7888c4d2015-12-03 15:26:20 -06001266
Vijay Khemka074f64d2020-03-03 15:08:43 -08001267enum class IpmiRestartCause
1268{
1269 Unknown = 0x0,
1270 RemoteCommand = 0x1,
1271 ResetButton = 0x2,
1272 PowerButton = 0x3,
1273 WatchdogTimer = 0x4,
1274 PowerPolicyAlwaysOn = 0x6,
1275 PowerPolicyPreviousState = 0x7,
1276 SoftReset = 0xa,
1277};
1278
Patrick Williams69b4c282025-03-03 11:19:13 -05001279static IpmiRestartCause restartCauseToIpmiRestartCause(
1280 State::Host::RestartCause cause)
Vijay Khemka074f64d2020-03-03 15:08:43 -08001281{
1282 switch (cause)
1283 {
1284 case State::Host::RestartCause::Unknown:
1285 {
1286 return IpmiRestartCause::Unknown;
1287 }
1288 case State::Host::RestartCause::RemoteCommand:
1289 {
1290 return IpmiRestartCause::RemoteCommand;
1291 }
1292 case State::Host::RestartCause::ResetButton:
1293 {
1294 return IpmiRestartCause::ResetButton;
1295 }
1296 case State::Host::RestartCause::PowerButton:
1297 {
1298 return IpmiRestartCause::PowerButton;
1299 }
1300 case State::Host::RestartCause::WatchdogTimer:
1301 {
1302 return IpmiRestartCause::WatchdogTimer;
1303 }
1304 case State::Host::RestartCause::PowerPolicyAlwaysOn:
1305 {
1306 return IpmiRestartCause::PowerPolicyAlwaysOn;
1307 }
1308 case State::Host::RestartCause::PowerPolicyPreviousState:
1309 {
1310 return IpmiRestartCause::PowerPolicyPreviousState;
1311 }
1312 case State::Host::RestartCause::SoftReset:
1313 {
1314 return IpmiRestartCause::SoftReset;
1315 }
1316 default:
1317 {
1318 return IpmiRestartCause::Unknown;
1319 }
1320 }
1321}
1322
1323/*
1324 * getRestartCause
1325 * helper function for Get Host restart cause Command
1326 * return - optional value for RestartCause (no value on error)
1327 */
1328static std::optional<uint4_t> getRestartCause(ipmi::Context::ptr ctx)
1329{
okashanyced0ddf2023-05-18 18:35:09 +00001330 constexpr const char* restartCausePath = "/xyz/openbmc_project/state/host0";
1331 constexpr const char* restartCauseIntf = "xyz.openbmc_project.State.Host";
Vijay Khemka074f64d2020-03-03 15:08:43 -08001332
1333 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001334 boost::system::error_code ec =
1335 ipmi::getService(ctx, restartCauseIntf, restartCausePath, service);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001336 if (!ec)
1337 {
1338 std::string restartCauseStr;
1339 ec = ipmi::getDbusProperty<std::string>(
1340 ctx, service, restartCausePath, restartCauseIntf, "RestartCause",
1341 restartCauseStr);
1342 if (!ec)
1343 {
1344 auto cause =
1345 State::Host::convertRestartCauseFromString(restartCauseStr);
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001346 return types::enum_cast<uint4_t>(
1347 restartCauseToIpmiRestartCause(cause));
Vijay Khemka074f64d2020-03-03 15:08:43 -08001348 }
1349 }
1350
Vernon Mauery38108d92024-03-11 12:53:55 -07001351 lg2::error(
1352 "Failed to fetch RestartCause property ({PATH}/{INTERFACE}): {ERROR}",
1353 "ERROR", ec.message(), "PATH", restartCausePath, "INTERFACE",
1354 restartCauseIntf);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001355 return std::nullopt;
1356}
1357
1358ipmi::RspType<uint4_t, // Restart Cause
1359 uint4_t, // reserved
1360 uint8_t // channel number (not supported)
1361 >
1362 ipmiGetSystemRestartCause(ipmi::Context::ptr ctx)
1363{
1364 std::optional<uint4_t> cause = getRestartCause(ctx);
1365 if (!cause)
1366 {
1367 return ipmi::responseUnspecifiedError();
1368 }
1369
Vernon Mauery916d4232021-03-29 13:42:16 -07001370 constexpr uint4_t reserved = 0;
1371 auto channel = static_cast<uint8_t>(ctx->channel);
1372 return ipmi::responseSuccess(cause.value(), reserved, channel);
Vijay Khemka074f64d2020-03-03 15:08:43 -08001373}
anil kumar appanadafff5f2019-04-27 18:06:00 +00001374/** @brief Implementation of chassis control command
1375 *
1376 * @param - chassisControl command byte
1377 *
1378 * @return Success or InvalidFieldRequest.
1379 */
Jason M. Bills664e1c32020-01-30 16:02:39 -08001380ipmi::RspType<> ipmiChassisControl(ipmi::Context::ptr& ctx,
1381 uint8_t chassisControl)
vishwa36993272015-11-20 12:43:49 -06001382{
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001383 int rc = 0;
anil kumar appanadafff5f2019-04-27 18:06:00 +00001384 switch (chassisControl)
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001385 {
1386 case CMD_POWER_ON:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001387 rc = initiateHostStateTransition(ctx, State::Host::Transition::On);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001388 break;
1389 case CMD_POWER_OFF:
Jason M. Billsc2c3a402020-01-30 16:22:24 -08001390 rc = initiateChassisStateTransition(
1391 ctx, State::Chassis::Transition::Off);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001392 break;
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001393 case CMD_HARD_RESET:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001394 rc = initiateHostStateTransition(
1395 ctx, State::Host::Transition::ForceWarmReboot);
Chanh Nguyend0a7fcd2021-07-16 22:59:28 +07001396 break;
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001397 case CMD_POWER_CYCLE:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001398 rc = initiateHostStateTransition(ctx,
1399 State::Host::Transition::Reboot);
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001400 break;
Vishwanatha Subbanna8b26d352017-08-04 18:35:18 +05301401 case CMD_SOFT_OFF_VIA_OVER_TEMP:
Jason M. Bills664e1c32020-01-30 16:02:39 -08001402 rc = initiateHostStateTransition(ctx, State::Host::Transition::Off);
Vishwanatha Subbanna8b26d352017-08-04 18:35:18 +05301403 break;
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +08001404 case CMD_PULSE_DIAGNOSTIC_INTR:
Zev Weiss337a0972024-03-08 08:31:15 +00001405 rc = doNmi(ctx);
Kuiying Wang6b0ceaa2019-11-05 15:13:40 +08001406 break;
1407
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001408 default:
1409 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001410 lg2::error("Invalid Chassis Control command: {CMD}", "CMD",
1411 lg2::hex, chassisControl);
anil kumar appanadafff5f2019-04-27 18:06:00 +00001412 return ipmi::responseInvalidFieldRequest();
Andrew Geisslerfca6a4f2017-05-30 10:55:39 -05001413 }
1414 }
vishwa36993272015-11-20 12:43:49 -06001415
anil kumar appanadafff5f2019-04-27 18:06:00 +00001416 return ((rc < 0) ? ipmi::responseUnspecifiedError()
1417 : ipmi::responseSuccess());
vishwa36993272015-11-20 12:43:49 -06001418}
1419
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001420/** @brief Return D-Bus connection string to enclosure identify LED object
1421 *
1422 * @param[in, out] connection - connection to D-Bus object
1423 * @return a IPMI return code
1424 */
1425std::string getEnclosureIdentifyConnection()
Tom Joseph5110c122018-03-23 17:55:40 +05301426{
Tom Joseph5110c122018-03-23 17:55:40 +05301427 // lookup enclosure_identify group owner(s) in mapper
George Liu3e3cc352023-07-26 15:59:31 +08001428 try
Tom Joseph5110c122018-03-23 17:55:40 +05301429 {
George Liu3e3cc352023-07-26 15:59:31 +08001430 return ipmi::getService(*getSdBus(), "xyz.openbmc_project.Led.Group",
1431 identify_led_object_name);
1432 }
1433 catch (const std::exception& e)
1434 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001435 lg2::error("Chassis Identify: Error communicating to mapper: {ERROR}",
1436 "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001437 elog<InternalFailure>();
Tom Joseph5110c122018-03-23 17:55:40 +05301438 }
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001439}
Tom Joseph5110c122018-03-23 17:55:40 +05301440
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001441/** @brief Turn On/Off enclosure identify LED
1442 *
1443 * @param[in] flag - true to turn on LED, false to turn off
1444 * @return a IPMI return code
1445 */
1446void enclosureIdentifyLed(bool flag)
1447{
1448 using namespace chassis::internal;
George Liu3e3cc352023-07-26 15:59:31 +08001449 try
1450 {
1451 std::string connection = getEnclosureIdentifyConnection();
1452
1453 auto msg = std::string("enclosureIdentifyLed(") +
1454 boost::lexical_cast<std::string>(flag) + ")";
Vernon Mauery38108d92024-03-11 12:53:55 -07001455 lg2::debug(msg.c_str());
George Liu3e3cc352023-07-26 15:59:31 +08001456
1457 ipmi::setDbusProperty(*getSdBus(), connection, identify_led_object_name,
1458 "xyz.openbmc_project.Led.Group", "Asserted",
1459 flag);
1460 }
1461 catch (const std::exception& e)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001462 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001463 lg2::error("Chassis Identify: Error Setting State {LED_STATE}: {ERROR}",
1464 "LED_STATE", flag, "ERROR", e);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001465 elog<InternalFailure>();
1466 }
1467}
1468
1469/** @brief Callback method to turn off LED
1470 */
1471void enclosureIdentifyLedOff()
1472{
1473 try
1474 {
Yong Lif4e38512019-05-21 14:46:55 +08001475 chassisIDState = ChassisIDState::off;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001476 enclosureIdentifyLed(false);
1477 }
1478 catch (const InternalFailure& e)
1479 {
1480 report<InternalFailure>();
1481 }
1482}
1483
1484/** @brief Create timer to turn on and off the enclosure LED
1485 */
1486void createIdentifyTimer()
1487{
1488 if (!identifyTimer)
1489 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001490 identifyTimer =
Patrick Williams95655222023-12-05 12:45:02 -06001491 std::make_unique<sdbusplus::Timer>(enclosureIdentifyLedOff);
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001492 }
1493}
1494
Vernon Mauery400cc782018-10-09 13:49:53 -07001495ipmi::RspType<> ipmiChassisIdentify(std::optional<uint8_t> interval,
1496 std::optional<uint8_t> force)
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001497{
Vernon Mauery400cc782018-10-09 13:49:53 -07001498 uint8_t identifyInterval = interval.value_or(DEFAULT_IDENTIFY_TIME_OUT);
1499 bool forceIdentify = force.value_or(0) & 0x01;
Tom Josephbed26992018-07-31 23:00:24 +05301500
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001501 if (identifyInterval || forceIdentify)
1502 {
Vernon Mauery400cc782018-10-09 13:49:53 -07001503 // stop the timer if already started;
1504 // for force identify we should not turn off LED
Vernon Mauery1181af72018-10-08 12:05:00 -07001505 identifyTimer->stop();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001506 try
Tom Joseph5110c122018-03-23 17:55:40 +05301507 {
Yong Lif4e38512019-05-21 14:46:55 +08001508 chassisIDState = ChassisIDState::temporaryOn;
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001509 enclosureIdentifyLed(true);
1510 }
1511 catch (const InternalFailure& e)
1512 {
1513 report<InternalFailure>();
Vernon Mauery400cc782018-10-09 13:49:53 -07001514 return ipmi::responseResponseError();
Tom Joseph5110c122018-03-23 17:55:40 +05301515 }
1516
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001517 if (forceIdentify)
Tom Joseph5110c122018-03-23 17:55:40 +05301518 {
Yong Lif4e38512019-05-21 14:46:55 +08001519 chassisIDState = ChassisIDState::indefiniteOn;
Vernon Mauery400cc782018-10-09 13:49:53 -07001520 return ipmi::responseSuccess();
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05001521 }
1522 // start the timer
1523 auto time = std::chrono::duration_cast<std::chrono::microseconds>(
Patrick Venture0b02be92018-08-31 11:55:55 -07001524 std::chrono::seconds(identifyInterval));
Vernon Mauery1181af72018-10-08 12:05:00 -07001525 identifyTimer->start(time);
Tom Joseph5110c122018-03-23 17:55:40 +05301526 }
Tom Josephbed26992018-07-31 23:00:24 +05301527 else if (!identifyInterval)
1528 {
Vernon Mauery1181af72018-10-08 12:05:00 -07001529 identifyTimer->stop();
Tom Josephbed26992018-07-31 23:00:24 +05301530 enclosureIdentifyLedOff();
1531 }
Vernon Mauery400cc782018-10-09 13:49:53 -07001532 return ipmi::responseSuccess();
Tom Joseph5110c122018-03-23 17:55:40 +05301533}
1534
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001535namespace boot_options
1536{
1537
Willy Tu523e2d12023-09-05 11:36:48 -07001538using namespace sdbusplus::server::xyz::openbmc_project::control::boot;
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001539using IpmiValue = uint8_t;
1540constexpr auto ipmiDefault = 0;
1541
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001542std::map<IpmiValue, Type::Types> typeIpmiToDbus = {{0x00, Type::Types::Legacy},
1543 {0x01, Type::Types::EFI}};
1544
Patrick Venture0b02be92018-08-31 11:55:55 -07001545std::map<IpmiValue, Source::Sources> sourceIpmiToDbus = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001546 {0x01, Source::Sources::Network},
1547 {0x02, Source::Sources::Disk},
1548 {0x05, Source::Sources::ExternalMedia},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001549 {0x0f, Source::Sources::RemovableMedia},
Patrick Venture0b02be92018-08-31 11:55:55 -07001550 {ipmiDefault, Source::Sources::Default}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001551
Patrick Venture0b02be92018-08-31 11:55:55 -07001552std::map<IpmiValue, Mode::Modes> modeIpmiToDbus = {
Yong Li5833cb62019-10-30 13:27:12 +08001553#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001554 {0x03, Mode::Modes::Safe},
Yong Li5833cb62019-10-30 13:27:12 +08001555#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001556 {0x06, Mode::Modes::Setup},
Patrick Venture0b02be92018-08-31 11:55:55 -07001557 {ipmiDefault, Mode::Modes::Regular}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001558
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001559std::map<Type::Types, IpmiValue> typeDbusToIpmi = {{Type::Types::Legacy, 0x00},
1560 {Type::Types::EFI, 0x01}};
1561
Patrick Venture0b02be92018-08-31 11:55:55 -07001562std::map<Source::Sources, IpmiValue> sourceDbusToIpmi = {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001563 {Source::Sources::Network, 0x01},
1564 {Source::Sources::Disk, 0x02},
1565 {Source::Sources::ExternalMedia, 0x05},
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08001566 {Source::Sources::RemovableMedia, 0x0f},
Patrick Venture0b02be92018-08-31 11:55:55 -07001567 {Source::Sources::Default, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001568
Patrick Venture0b02be92018-08-31 11:55:55 -07001569std::map<Mode::Modes, IpmiValue> modeDbusToIpmi = {
Yong Li5833cb62019-10-30 13:27:12 +08001570#ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001571 {Mode::Modes::Safe, 0x03},
Yong Li5833cb62019-10-30 13:27:12 +08001572#endif // ENABLE_BOOT_SAFE_MODE_SUPPORT
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001573 {Mode::Modes::Setup, 0x06},
Patrick Venture0b02be92018-08-31 11:55:55 -07001574 {Mode::Modes::Regular, ipmiDefault}};
shgoupfd84fbbf2015-12-17 10:05:51 +08001575
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001576} // namespace boot_options
shgoupfd84fbbf2015-12-17 10:05:51 +08001577
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001578/** @brief Get the property value for boot source
1579 * @param[in] ctx - context pointer
1580 * @param[out] source - boot source value
1581 * @return On failure return IPMI error.
1582 */
1583static ipmi::Cc getBootSource(ipmi::Context::ptr& ctx, Source::Sources& source)
1584{
1585 using namespace chassis::internal;
1586 std::string result;
1587 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001588 boost::system::error_code ec =
1589 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001590 if (!ec)
1591 {
1592 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1593 bootSourceIntf, "BootSource", result);
1594 if (!ec)
1595 {
1596 source = Source::convertSourcesFromString(result);
1597 return ipmi::ccSuccess;
1598 }
1599 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001600 lg2::error("Error in BootSource Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001601 return ipmi::ccUnspecifiedError;
1602}
1603
Marri Devender Rao81719702018-05-07 00:53:48 -05001604/** @brief Set the property value for boot source
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001605 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001606 * @param[in] source - boot source value
1607 * @return On failure return IPMI error.
1608 */
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00001609static ipmi::Cc setBootSource(ipmi::Context::ptr& ctx,
1610 const Source::Sources& source)
Marri Devender Rao81719702018-05-07 00:53:48 -05001611{
1612 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001613 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001614 boost::system::error_code ec =
1615 getService(ctx, bootSourceIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001616 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001617 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001618 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1619 bootSourceIntf, "BootSource",
1620 convertForMessage(source));
1621 if (!ec)
1622 {
1623 return ipmi::ccSuccess;
1624 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001625 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001626 lg2::error("Error in BootSource Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001627 return ipmi::ccUnspecifiedError;
1628}
1629
1630/** @brief Get the property value for boot mode
1631 * @param[in] ctx - context pointer
1632 * @param[out] mode - boot mode value
1633 * @return On failure return IPMI error.
1634 */
1635static ipmi::Cc getBootMode(ipmi::Context::ptr& ctx, Mode::Modes& mode)
1636{
1637 using namespace chassis::internal;
1638 std::string result;
1639 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001640 boost::system::error_code ec =
1641 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001642 if (!ec)
1643 {
1644 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1645 "BootMode", result);
1646 if (!ec)
1647 {
1648 mode = Mode::convertModesFromString(result);
1649 return ipmi::ccSuccess;
1650 }
1651 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001652 lg2::error("Error in BootMode Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001653 return ipmi::ccUnspecifiedError;
Marri Devender Rao81719702018-05-07 00:53:48 -05001654}
1655
Patrick Venture0b02be92018-08-31 11:55:55 -07001656/** @brief Set the property value for boot mode
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001657 * @param[in] ctx - context pointer
Marri Devender Rao81719702018-05-07 00:53:48 -05001658 * @param[in] mode - boot mode value
1659 * @return On failure return IPMI error.
1660 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001661static ipmi::Cc setBootMode(ipmi::Context::ptr& ctx, const Mode::Modes& mode)
Marri Devender Rao81719702018-05-07 00:53:48 -05001662{
1663 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001664 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001665 boost::system::error_code ec =
1666 getService(ctx, bootModeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001667 if (!ec)
Marri Devender Rao81719702018-05-07 00:53:48 -05001668 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001669 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootModeIntf,
1670 "BootMode", convertForMessage(mode));
1671 if (!ec)
1672 {
1673 return ipmi::ccSuccess;
1674 }
Marri Devender Rao81719702018-05-07 00:53:48 -05001675 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001676 lg2::error("Error in BootMode Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001677 return ipmi::ccUnspecifiedError;
1678}
1679
1680/** @brief Get the property value for boot type
1681 * @param[in] ctx - context pointer
1682 * @param[out] type - boot type value
1683 * @return On failure return IPMI error.
1684 */
1685static ipmi::Cc getBootType(ipmi::Context::ptr& ctx, Type::Types& type)
1686{
1687 using namespace chassis::internal;
1688 std::string result;
1689 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001690 boost::system::error_code ec =
1691 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001692
1693 // Don't throw error if BootType interface is not present.
1694 // This interface is not relevant for some Host architectures
1695 // (for example POWER). In this case we don't won't IPMI to
1696 // return an error, but simply return bootType as EFI.
1697 type = Type::Types::EFI;
1698 if (!ec)
1699 {
1700 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1701 "BootType", result);
1702 if (ec)
1703 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001704 lg2::error("Error in BootType Get: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001705 return ipmi::ccUnspecifiedError;
1706 }
1707 type = Type::convertTypesFromString(result);
1708 }
1709
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00001710 return ipmi::ccSuccess;
Marri Devender Rao81719702018-05-07 00:53:48 -05001711}
1712
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001713/** @brief Set the property value for boot type
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001714 * @param[in] ctx - context pointer
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001715 * @param[in] type - boot type value
1716 * @return On failure return IPMI error.
1717 */
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001718static ipmi::Cc setBootType(ipmi::Context::ptr& ctx, const Type::Types& type)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001719{
1720 using namespace chassis::internal;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001721 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001722 boost::system::error_code ec =
1723 getService(ctx, bootTypeIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001724 if (!ec)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001725 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001726 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf,
1727 "BootType", convertForMessage(type));
1728 if (ec)
1729 {
Vernon Mauery38108d92024-03-11 12:53:55 -07001730 lg2::error("Error in BootType Set: {ERROR}", "ERROR", ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001731 return ipmi::ccUnspecifiedError;
1732 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001733 }
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001734 // Don't throw error if BootType interface is not present.
1735 // This interface is not relevant for some Host architectures
1736 // (for example POWER). In this case we don't won't IPMI to
1737 // return an error, but want to just skip this function.
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001738 return ipmi::ccSuccess;
1739}
1740
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001741/** @brief Get the property value for boot override enable
1742 * @param[in] ctx - context pointer
1743 * @param[out] enable - boot override enable
1744 * @return On failure return IPMI error.
1745 */
1746static ipmi::Cc getBootEnable(ipmi::Context::ptr& ctx, bool& enable)
1747{
1748 using namespace chassis::internal;
1749 std::string result;
1750 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001751 boost::system::error_code ec =
1752 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001753 if (!ec)
1754 {
1755 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath,
1756 bootEnableIntf, "Enabled", enable);
1757 if (!ec)
1758 {
1759 return ipmi::ccSuccess;
1760 }
1761 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001762 lg2::error("Error in Boot Override Enable Get: {ERROR}", "ERROR",
1763 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001764 return ipmi::ccUnspecifiedError;
1765}
1766
1767/** @brief Set the property value for boot override enable
1768 * @param[in] ctx - context pointer
1769 * @param[in] enable - boot override enable
1770 * @return On failure return IPMI error.
1771 */
1772static ipmi::Cc setBootEnable(ipmi::Context::ptr& ctx, const bool& enable)
1773{
1774 using namespace chassis::internal;
1775 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001776 boost::system::error_code ec =
1777 getService(ctx, bootEnableIntf, bootSettingsPath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001778 if (!ec)
1779 {
1780 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath,
1781 bootEnableIntf, "Enabled", enable);
1782 if (!ec)
1783 {
1784 return ipmi::ccSuccess;
1785 }
1786 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001787 lg2::error("Error in Boot Source Override Enable Set: {ERROR}", "ERROR",
1788 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001789 return ipmi::ccUnspecifiedError;
1790}
1791
1792/** @brief Get the property value for boot override one-time
1793 * @param[in] ctx - context pointer
1794 * @param[out] onetime - boot override one-time
1795 * @return On failure return IPMI error.
1796 */
1797static ipmi::Cc getBootOneTime(ipmi::Context::ptr& ctx, bool& onetime)
1798{
1799 using namespace chassis::internal;
1800 std::string result;
1801 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001802 boost::system::error_code ec =
1803 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001804 if (!ec)
1805 {
1806 ec = ipmi::getDbusProperty(ctx, service, bootSettingsOneTimePath,
1807 bootOneTimeIntf, "Enabled", onetime);
1808 if (!ec)
1809 {
1810 return ipmi::ccSuccess;
1811 }
1812 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001813 lg2::error("Error in Boot Override OneTime Get: {ERROR}", "ERROR",
1814 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001815 return ipmi::ccUnspecifiedError;
1816}
1817
1818/** @brief Set the property value for boot override one-time
1819 * @param[in] ctx - context pointer
1820 * @param[in] onetime - boot override one-time
1821 * @return On failure return IPMI error.
1822 */
1823static ipmi::Cc setBootOneTime(ipmi::Context::ptr& ctx, const bool& onetime)
1824{
1825 using namespace chassis::internal;
1826 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -04001827 boost::system::error_code ec =
1828 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001829 if (!ec)
1830 {
1831 ec = ipmi::setDbusProperty(ctx, service, bootSettingsOneTimePath,
1832 bootOneTimeIntf, "Enabled", onetime);
1833 if (!ec)
1834 {
1835 return ipmi::ccSuccess;
1836 }
1837 }
Vernon Mauery38108d92024-03-11 12:53:55 -07001838 lg2::error("Error in Boot Source Override OneTime Set: {ERROR}", "ERROR",
1839 ec.message());
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001840 return ipmi::ccUnspecifiedError;
1841}
1842
huangheab369282020-10-10 14:40:00 +08001843static constexpr uint8_t setComplete = 0x0;
1844static constexpr uint8_t setInProgress = 0x1;
1845static uint8_t transferStatus = setComplete;
Chen Yugang86ac4992021-06-25 08:14:52 +08001846static uint8_t bootFlagValidBitClr = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001847static uint5_t bootInitiatorAckData = 0x0;
Hieu Huynh1982a3f2021-09-21 03:06:45 +00001848static bool cmosClear = false;
Cosmo Chou53831212025-01-10 13:36:36 +08001849static uint2_t biosVerbosity = 0x0;
huangheab369282020-10-10 14:40:00 +08001850
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001851/** @brief implements the Get Chassis system boot option
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03001852 * @param ctx - context pointer
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001853 * @param bootOptionParameter - boot option parameter selector
1854 * @param reserved1 - reserved bit
1855 * @param setSelector - selects a particular block or set of parameters
1856 * under the given parameter selector
1857 * write as 00h if parameter doesn't use a setSelector
1858 * @param blockSelector- selects a particular block within a set of
1859 * parameters write as 00h if parameter doesn't use a
1860 * blockSelector
1861 *
1862 * @return IPMI completion code plus response data
1863 * @return Payload contains below parameters:
1864 * version - parameter version
1865 * bootOptionParameter - boot option parameter selector
Patrick Venture8b1c3032020-09-15 09:43:03 -07001866 * parmIndicator - parameter valid/invalid indicator
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001867 * data - configuration parameter data
1868 */
Patrick Williams1318a5e2024-08-16 15:19:54 -04001869ipmi::RspType<ipmi::message::Payload> ipmiChassisGetSysBootOptions(
1870 ipmi::Context::ptr ctx, uint7_t bootOptionParameter, bool reserved1,
1871 [[maybe_unused]] uint8_t setSelector,
1872 [[maybe_unused]] uint8_t blockSelector)
Adriana Kobylak40814c62015-10-27 15:58:44 -05001873{
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001874 ipmi::Cc rc;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001875 if (reserved1)
1876 {
1877 return ipmi::responseInvalidFieldRequest();
1878 }
1879
1880 constexpr uint4_t version = 0x01;
1881 ipmi::message::Payload response;
1882 response.pack(version, uint4_t{});
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001883 using namespace boot_options;
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001884
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001885 IpmiValue bootOption = ipmiDefault;
Adriana Kobylak40814c62015-10-27 15:58:44 -05001886
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001887 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1888 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08001889 {
1890 response.pack(bootOptionParameter, reserved1, transferStatus);
1891 return ipmi::responseSuccess(std::move(response));
1892 }
1893
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001894 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1895 BootOptionParameter::bootInfo)
John Wang0213f902020-12-28 14:49:57 +08001896 {
1897 constexpr uint8_t writeMask = 0;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00001898 response.pack(bootOptionParameter, reserved1, writeMask,
1899 bootInitiatorAckData);
John Wang0213f902020-12-28 14:49:57 +08001900 return ipmi::responseSuccess(std::move(response));
1901 }
1902
Chen Yugang86ac4992021-06-25 08:14:52 +08001903 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1904 BootOptionParameter::bootFlagValidClr)
1905 {
1906 response.pack(bootOptionParameter, reserved1,
1907 uint5_t{bootFlagValidBitClr}, uint3_t{});
1908 return ipmi::responseSuccess(std::move(response));
1909 }
1910
shgoupfd84fbbf2015-12-17 10:05:51 +08001911 /*
1912 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
1913 * This is the only parameter used by petitboot.
1914 */
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001915 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1916 BootOptionParameter::bootFlags)
Patrick Venture0b02be92018-08-31 11:55:55 -07001917 {
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001918 using namespace chassis::internal;
1919 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08001920
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001921 try
ratagupta6f6bff2016-04-04 06:20:11 -05001922 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001923 Source::Sources bootSource;
1924 rc = getBootSource(ctx, bootSource);
1925 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001926 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001927 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001928 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001929
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001930 Type::Types bootType;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001931 rc = getBootType(ctx, bootType);
1932 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001933 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001934 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001935 }
1936
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001937 Mode::Modes bootMode;
1938 rc = getBootMode(ctx, bootMode);
1939 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001940 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001941 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001942 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05001943
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001944 bootOption = sourceDbusToIpmi.at(bootSource);
1945 if ((Mode::Modes::Regular == bootMode) &&
1946 (Source::Sources::Default == bootSource))
1947 {
1948 bootOption = ipmiDefault;
1949 }
1950 else if (Source::Sources::Default == bootSource)
1951 {
1952 bootOption = modeDbusToIpmi.at(bootMode);
1953 }
ratagupta6f6bff2016-04-04 06:20:11 -05001954
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001955 IpmiValue biosBootType = typeDbusToIpmi.at(bootType);
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001956
1957 bool oneTimeEnabled;
1958 rc = getBootOneTime(ctx, oneTimeEnabled);
1959 if (rc != ipmi::ccSuccess)
1960 {
1961 return ipmi::response(rc);
1962 }
1963
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001964 uint1_t permanent = oneTimeEnabled ? 0 : 1;
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03001965
1966 bool valid;
1967 rc = getBootEnable(ctx, valid);
1968 if (rc != ipmi::ccSuccess)
1969 {
1970 return ipmi::response(rc);
1971 }
1972
1973 uint1_t validFlag = valid ? 1 : 0;
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03001974
Cosmo Chou53831212025-01-10 13:36:36 +08001975 response.pack(
1976 bootOptionParameter, reserved1, uint5_t{},
1977 uint1_t{biosBootType}, uint1_t{permanent}, uint1_t{validFlag},
1978 uint2_t{}, uint4_t{bootOption}, uint1_t{}, cmosClear, uint5_t{},
1979 uint2_t{biosVerbosity}, uint1_t{}, uint8_t{}, uint8_t{});
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001980 return ipmi::responseSuccess(std::move(response));
ratagupta6f6bff2016-04-04 06:20:11 -05001981 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001982 catch (const InternalFailure& e)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001983 {
James Feist225dec82019-11-26 16:25:06 -08001984 cache::objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001985 report<InternalFailure>();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001986 return ipmi::responseUnspecifiedError();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05001987 }
Patrick Venture0b02be92018-08-31 11:55:55 -07001988 }
Patrick Venture0b02be92018-08-31 11:55:55 -07001989 else
1990 {
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001991 if ((bootOptionParameter >= oemParmStart) &&
1992 (bootOptionParameter <= oemParmEnd))
1993 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07001994 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) ==
1995 BootOptionParameter::opalNetworkSettings)
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00001996 {
1997 response.pack(bootOptionParameter, reserved1);
1998 int ret = getHostNetworkData(response);
1999 if (ret < 0)
2000 {
2001 response.trailingOk = true;
Vernon Mauery38108d92024-03-11 12:53:55 -07002002 lg2::error(
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002003 "getHostNetworkData failed for GetSysBootOptions.");
2004 return ipmi::responseUnspecifiedError();
2005 }
2006 else
2007 {
2008 return ipmi::responseSuccess(std::move(response));
2009 }
2010 }
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002011 else
2012 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002013 lg2::error(
2014 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2015 "PARAM", lg2::hex,
2016 static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala43a88102021-08-04 16:41:58 +00002017 return ipmi::responseParmNotSupported();
2018 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002019 }
2020 else
2021 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002022 lg2::error(
2023 "ipmiChassisGetSysBootOptions: Unsupported parameter {PARAM}",
2024 "PARAM", lg2::hex, static_cast<uint8_t>(bootOptionParameter));
Jayaprakash Mutyala6088e9f2021-07-14 07:40:29 +00002025 return ipmi::responseParmNotSupported();
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002026 }
shgoupfd84fbbf2015-12-17 10:05:51 +08002027 }
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002028 return ipmi::responseUnspecifiedError();
shgoupfd84fbbf2015-12-17 10:05:51 +08002029}
2030
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002031ipmi::RspType<> ipmiChassisSetSysBootOptions(ipmi::Context::ptr ctx,
Willy Tu11d68892022-01-20 10:37:34 -08002032 uint7_t parameterSelector, bool,
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002033 ipmi::message::Payload& data)
shgoupfd84fbbf2015-12-17 10:05:51 +08002034{
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002035 using namespace boot_options;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002036 ipmi::Cc rc;
shgoupfd84fbbf2015-12-17 10:05:51 +08002037
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002038 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2039 BootOptionParameter::setInProgress)
huangheab369282020-10-10 14:40:00 +08002040 {
2041 uint2_t setInProgressFlag;
2042 uint6_t rsvd;
2043 if (data.unpack(setInProgressFlag, rsvd) != 0 || !data.fullyUnpacked())
2044 {
2045 return ipmi::responseReqDataLenInvalid();
2046 }
2047 if (rsvd)
2048 {
2049 return ipmi::responseInvalidFieldRequest();
2050 }
2051 if ((transferStatus == setInProgress) &&
2052 (static_cast<uint8_t>(setInProgressFlag) != setComplete))
2053 {
2054 return ipmi::response(IPMI_CC_FAIL_SET_IN_PROGRESS);
2055 }
2056 transferStatus = static_cast<uint8_t>(setInProgressFlag);
2057 return ipmi::responseSuccess();
2058 }
2059
shgoupfd84fbbf2015-12-17 10:05:51 +08002060 /* 000101
2061 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc.
2062 * This is the only parameter used by petitboot.
2063 */
Ratan Guptafd28dd72016-08-01 04:58:01 -05002064
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002065 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2066 BootOptionParameter::bootFlags)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002067 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002068 uint5_t rsvd;
2069 bool validFlag;
2070 bool permanent;
2071 bool biosBootType;
2072 bool lockOutResetButton;
2073 bool screenBlank;
2074 uint4_t bootDeviceSelector;
2075 bool lockKeyboard;
Cosmo Chou53831212025-01-10 13:36:36 +08002076 uint5_t biosCtrls;
2077 bool lockOutPower;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002078 uint4_t biosInfo;
2079 uint4_t rsvd1;
2080 uint5_t deviceInstance;
2081 uint3_t rsvd2;
2082
2083 if (data.unpack(rsvd, biosBootType, permanent, validFlag,
2084 lockOutResetButton, screenBlank, bootDeviceSelector,
Cosmo Chou53831212025-01-10 13:36:36 +08002085 lockKeyboard, cmosClear, biosCtrls, biosVerbosity,
2086 lockOutPower, biosInfo, rsvd1, deviceInstance, rsvd2) !=
2087 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002088 !data.fullyUnpacked())
2089 {
2090 return ipmi::responseReqDataLenInvalid();
2091 }
2092 if (rsvd || rsvd1 || rsvd2)
2093 {
2094 return ipmi::responseInvalidFieldRequest();
2095 }
2096
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002097 using namespace chassis::internal;
2098 using namespace chassis::internal::cache;
shgoupfd84fbbf2015-12-17 10:05:51 +08002099
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002100 try
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002101 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002102 rc = setBootOneTime(ctx, !permanent);
2103 if (rc != ipmi::ccSuccess)
Konstantin Aladyshev69e8e842021-06-18 17:01:18 +03002104 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002105 return ipmi::response(rc);
2106 }
Vernon Maueryafd45db2021-07-29 16:27:25 +00002107
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002108 rc = setBootEnable(ctx, validFlag);
2109 if (rc != ipmi::ccSuccess)
2110 {
2111 return ipmi::response(rc);
Tom Joseph57e8eb72017-09-25 18:05:02 +05302112 }
2113
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002114 auto modeItr =
2115 modeIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002116 auto typeItr =
2117 typeIpmiToDbus.find(static_cast<uint8_t>(biosBootType));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002118 auto sourceItr =
2119 sourceIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector));
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002120 if (sourceIpmiToDbus.end() != sourceItr)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002121 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002122 rc = setBootSource(ctx, sourceItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002123 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002124 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002125 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002126 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002127 // If a set boot device is mapping to a boot source, then reset
2128 // the boot mode D-Bus property to default.
2129 // This way the ipmid code can determine which property is not
2130 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002131 if (sourceItr->second != Source::Sources::Default)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002132 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002133 rc = setBootMode(ctx, Mode::Modes::Regular);
2134 if (rc != ipmi::ccSuccess)
2135 {
2136 return ipmi::response(rc);
2137 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002138 }
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002139 }
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002140
2141 if (typeIpmiToDbus.end() != typeItr)
2142 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002143 rc = setBootType(ctx, typeItr->second);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002144 if (rc != ipmi::ccSuccess)
2145 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002146 return ipmi::response(rc);
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002147 }
2148 }
2149
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002150 if (modeIpmiToDbus.end() != modeItr)
2151 {
Konstantin Aladysheve76a61a2021-03-18 22:19:13 +03002152 rc = setBootMode(ctx, modeItr->second);
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002153 if (rc != ipmi::ccSuccess)
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002154 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002155 return ipmi::response(rc);
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002156 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002157 // If a set boot device is mapping to a boot mode, then reset
2158 // the boot source D-Bus property to default.
2159 // This way the ipmid code can determine which property is not
2160 // at the default value
Patrick Venture0b02be92018-08-31 11:55:55 -07002161 if (modeItr->second != Mode::Modes::Regular)
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002162 {
Konstantin Aladyshev08a080a2021-06-18 17:01:18 +03002163 rc = setBootSource(ctx, Source::Sources::Default);
2164 if (rc != ipmi::ccSuccess)
2165 {
2166 return ipmi::response(rc);
2167 }
Marri Devender Rao54fa1302018-05-07 01:06:23 -05002168 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002169 }
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002170 if ((modeIpmiToDbus.end() == modeItr) &&
Konstantin Aladyshev96ef0282021-02-09 13:57:10 +03002171 (typeIpmiToDbus.end() == typeItr) &&
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002172 (sourceIpmiToDbus.end() == sourceItr))
2173 {
2174 // return error if boot option is not supported
Vernon Mauery38108d92024-03-11 12:53:55 -07002175 lg2::error(
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002176 "ipmiChassisSetSysBootOptions: Boot option not supported");
2177 return ipmi::responseInvalidFieldRequest();
Jia, chunhui67c5e5d2019-05-06 11:29:54 +08002178 }
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002179 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002180 catch (const sdbusplus::exception_t& e)
Deepak Kodihalli8cc19362017-07-21 11:18:38 -05002181 {
James Feist225dec82019-11-26 16:25:06 -08002182 objectsPtr.reset();
Deepak Kodihalli13791bd2017-08-28 06:50:51 -05002183 report<InternalFailure>();
Vernon Mauery38108d92024-03-11 12:53:55 -07002184 lg2::error("ipmiChassisSetSysBootOptions: Error in setting Boot "
2185 "flag parameters");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002186 return ipmi::responseUnspecifiedError();
Ratan Guptafd28dd72016-08-01 04:58:01 -05002187 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002188 }
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002189 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2190 BootOptionParameter::bootInfo)
Patrick Venture0b02be92018-08-31 11:55:55 -07002191 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002192 uint8_t writeMak;
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002193 uint5_t bootInfoAck;
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002194 uint3_t rsvd;
2195
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002196 if (data.unpack(writeMak, bootInfoAck, rsvd) != 0 ||
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002197 !data.fullyUnpacked())
2198 {
2199 return ipmi::responseReqDataLenInvalid();
2200 }
2201 if (rsvd)
2202 {
2203 return ipmi::responseInvalidFieldRequest();
2204 }
Hieu Huynh38ffafc2021-05-14 08:40:14 +00002205 bootInitiatorAckData &= ~writeMak;
2206 bootInitiatorAckData |= (writeMak & bootInfoAck);
Vernon Mauery38108d92024-03-11 12:53:55 -07002207 lg2::info("ipmiChassisSetSysBootOptions: bootInfo parameter set "
2208 "successfully");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002209 data.trailingOk = true;
2210 return ipmi::responseSuccess();
Patrick Venture0b02be92018-08-31 11:55:55 -07002211 }
Chen Yugang86ac4992021-06-25 08:14:52 +08002212 else if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2213 BootOptionParameter::bootFlagValidClr)
2214 {
2215 uint5_t bootFlagValidClr;
2216 uint3_t rsvd;
2217
2218 if (data.unpack(bootFlagValidClr, rsvd) != 0 || !data.fullyUnpacked())
2219 {
2220 return ipmi::responseReqDataLenInvalid();
2221 }
2222 if (rsvd)
2223 {
2224 return ipmi::responseInvalidFieldRequest();
2225 }
2226 // store boot flag valid bits clear value
2227 bootFlagValidBitClr = static_cast<uint8_t>(bootFlagValidClr);
Vernon Mauery38108d92024-03-11 12:53:55 -07002228 lg2::info(
Chen Yugang86ac4992021-06-25 08:14:52 +08002229 "ipmiChassisSetSysBootOptions: bootFlagValidBits parameter set "
Vernon Mauery38108d92024-03-11 12:53:55 -07002230 "successfully to {VALUE}",
2231 "VALUE", lg2::hex, bootFlagValidBitClr);
Chen Yugang86ac4992021-06-25 08:14:52 +08002232 return ipmi::responseSuccess();
2233 }
Patrick Venture0b02be92018-08-31 11:55:55 -07002234 else
2235 {
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002236 if ((parameterSelector >= static_cast<uint7_t>(oemParmStart)) &&
2237 (parameterSelector <= static_cast<uint7_t>(oemParmEnd)))
2238 {
William A. Kennington III7a0e5df2021-05-19 13:31:29 -07002239 if (types::enum_cast<BootOptionParameter>(parameterSelector) ==
2240 BootOptionParameter::opalNetworkSettings)
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002241 {
2242 ipmi::Cc ret = setHostNetworkData(data);
2243 if (ret != ipmi::ccSuccess)
2244 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002245 lg2::error("ipmiChassisSetSysBootOptions: Error in "
2246 "setHostNetworkData");
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002247 data.trailingOk = true;
2248 return ipmi::response(ret);
2249 }
2250 data.trailingOk = true;
2251 return ipmi::responseSuccess();
2252 }
2253 else
2254 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002255 lg2::error(
2256 "ipmiChassisSetSysBootOptions: Unsupported param: {PARAM}",
2257 "PARAM", lg2::hex, static_cast<uint8_t>(parameterSelector));
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002258 data.trailingOk = true;
2259 return ipmi::responseParmNotSupported();
2260 }
2261 }
2262 data.trailingOk = true;
2263 return ipmi::responseParmNotSupported();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002264 }
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002265 return ipmi::responseSuccess();
Adriana Kobylak40814c62015-10-27 15:58:44 -05002266}
2267
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002268/** @brief implements Get POH counter command
2269 * @parameter
2270 * - none
2271 * @returns IPMI completion code plus response data
2272 * - minPerCount - Minutes per count
2273 * - counterReading - counter reading
2274 */
2275ipmi::RspType<uint8_t, // Minutes per count
2276 uint32_t // Counter reading
2277 >
2278 ipmiGetPOHCounter()
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002279{
2280 // sd_bus error
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002281 try
2282 {
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002283 return ipmi::responseSuccess(static_cast<uint8_t>(poh::minutesPerCount),
2284 getPOHCounter());
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002285 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002286 catch (const std::exception& e)
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002287 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002288 lg2::error("getPOHCounter error: {ERROR}", "ERROR", e);
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002289 return ipmi::responseUnspecifiedError();
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002290 }
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002291}
2292
Jason M. Billsbc996a32019-06-17 15:46:37 -07002293ipmi::RspType<uint3_t, // policy support
2294 uint5_t // reserved
2295 >
George Liude1420d2025-03-03 15:14:25 +08002296 ipmiChassisSetPowerRestorePolicy(ipmi::Context::ptr ctx, uint3_t policy,
2297 uint5_t reserved)
Yong Lic6713cf2018-09-12 12:35:13 +08002298{
Yong Lic6713cf2018-09-12 12:35:13 +08002299 power_policy::DbusValue value =
2300 power_policy::RestorePolicy::Policy::AlwaysOff;
2301
Jason M. Billsbc996a32019-06-17 15:46:37 -07002302 if (reserved || (policy > power_policy::noChange))
Yong Lic6713cf2018-09-12 12:35:13 +08002303 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002304 lg2::error("Reserved request parameter: {REQ}", "REQ", lg2::hex,
2305 static_cast<int>(policy));
Jason M. Billsbc996a32019-06-17 15:46:37 -07002306 return ipmi::responseInvalidFieldRequest();
Yong Lic6713cf2018-09-12 12:35:13 +08002307 }
2308
Vernon Mauerye278ead2018-10-09 09:23:43 -07002309 if (policy == power_policy::noChange)
Yong Lic6713cf2018-09-12 12:35:13 +08002310 {
2311 // just return the supported policy
Jason M. Billsbc996a32019-06-17 15:46:37 -07002312 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002313 }
2314
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05002315 for (const auto& it : power_policy::dbusToIpmi)
Yong Lic6713cf2018-09-12 12:35:13 +08002316 {
Vernon Mauerye278ead2018-10-09 09:23:43 -07002317 if (it.second == policy)
Yong Lic6713cf2018-09-12 12:35:13 +08002318 {
2319 value = it.first;
2320 break;
2321 }
2322 }
2323
2324 try
2325 {
James Feist225dec82019-11-26 16:25:06 -08002326 settings::Objects& objects = chassis::internal::cache::getObjects();
Yong Lic6713cf2018-09-12 12:35:13 +08002327 const settings::Path& powerRestoreSetting =
James Feist225dec82019-11-26 16:25:06 -08002328 objects.map.at(chassis::internal::powerRestoreIntf).front();
Yong Lic6713cf2018-09-12 12:35:13 +08002329
George Liude1420d2025-03-03 15:14:25 +08002330 boost::system::error_code ec = ipmi::setDbusProperty(
2331 ctx,
2332 objects.service(powerRestoreSetting,
2333 chassis::internal::powerRestoreIntf),
2334 powerRestoreSetting, chassis::internal::powerRestoreIntf,
2335 "PowerRestorePolicy", convertForMessage(value));
Vernon Mauerye278ead2018-10-09 09:23:43 -07002336 if (ec)
Yong Lic6713cf2018-09-12 12:35:13 +08002337 {
Vernon Mauery38108d92024-03-11 12:53:55 -07002338 lg2::error("Unspecified Error");
Vernon Mauerye278ead2018-10-09 09:23:43 -07002339 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002340 }
2341 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05002342 catch (const InternalFailure& e)
Yong Lic6713cf2018-09-12 12:35:13 +08002343 {
James Feist225dec82019-11-26 16:25:06 -08002344 chassis::internal::cache::objectsPtr.reset();
Yong Lic6713cf2018-09-12 12:35:13 +08002345 report<InternalFailure>();
Vernon Mauerye278ead2018-10-09 09:23:43 -07002346 return ipmi::responseUnspecifiedError();
Yong Lic6713cf2018-09-12 12:35:13 +08002347 }
2348
Jason M. Billsbc996a32019-06-17 15:46:37 -07002349 return ipmi::responseSuccess(power_policy::allSupport, reserved);
Yong Lic6713cf2018-09-12 12:35:13 +08002350}
2351
Patrick Williams1318a5e2024-08-16 15:19:54 -04002352ipmi::RspType<> ipmiSetFrontPanelButtonEnables(
2353 ipmi::Context::ptr ctx, bool disablePowerButton, bool disableResetButton,
2354 bool, bool, uint4_t)
Kuiying Wang21addc52019-01-04 10:50:21 +08002355{
2356 using namespace chassis::internal;
2357
2358 // set power button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002359 bool success = setButtonDisabled(ctx, powerButtonPath, powerButtonIntf,
2360 disablePowerButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002361
2362 // set reset button Enabled property
Konstantin Aladyshev305d8642025-02-15 00:36:54 +03002363 success &= setButtonDisabled(ctx, resetButtonPath, resetButtonIntf,
2364 disableResetButton);
Kuiying Wang21addc52019-01-04 10:50:21 +08002365
2366 if (!success)
2367 {
2368 // not all buttons were successfully set
2369 return ipmi::responseUnspecifiedError();
2370 }
2371 return ipmi::responseSuccess();
2372}
2373
George Liu5087b072025-03-11 19:28:17 +08002374void registerNetFnChassisFunctions()
Adriana Kobylak40814c62015-10-27 15:58:44 -05002375{
Marri Devender Rao6706c1c2018-05-14 00:29:38 -05002376 createIdentifyTimer();
2377
Tom05732372016-09-06 17:21:23 +05302378 // Get Chassis Capabilities
anil kumar appana43263c62019-05-27 12:45:04 +00002379 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2380 ipmi::chassis::cmdGetChassisCapabilities,
2381 ipmi::Privilege::User, ipmiGetChassisCap);
Nan Li8d15fb42016-08-16 22:29:40 +08002382
Kuiying Wang21addc52019-01-04 10:50:21 +08002383 // Set Front Panel Button Enables
2384 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2385 ipmi::chassis::cmdSetFrontPanelButtonEnables,
2386 ipmi::Privilege::Admin,
2387 ipmiSetFrontPanelButtonEnables);
2388
Yong Liae4b0402018-11-02 11:12:14 +08002389 // Set Chassis Capabilities
anil kumar appana894d0222019-05-27 16:32:14 +00002390 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2391 ipmi::chassis::cmdSetChassisCapabilities,
2392 ipmi::Privilege::User, ipmiSetChassisCap);
Yong Liae4b0402018-11-02 11:12:14 +08002393
Tom05732372016-09-06 17:21:23 +05302394 // <Get System Boot Options>
Jayaprakash Mutyalad1ef8772020-08-25 10:32:58 +00002395 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2396 ipmi::chassis::cmdGetSystemBootOptions,
2397 ipmi::Privilege::Operator,
2398 ipmiChassisGetSysBootOptions);
Adriana Kobylak40814c62015-10-27 15:58:44 -05002399
Tom05732372016-09-06 17:21:23 +05302400 // <Get Chassis Status>
Vernon Mauery4a8a4eb2019-04-04 15:09:37 -07002401 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2402 ipmi::chassis::cmdGetChassisStatus,
2403 ipmi::Privilege::User, ipmiGetChassisStatus);
Nan Lifdd8ec52016-08-28 03:57:40 +08002404
Vijay Khemka074f64d2020-03-03 15:08:43 -08002405 // <Chassis Get System Restart Cause>
2406 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2407 ipmi::chassis::cmdGetSystemRestartCause,
2408 ipmi::Privilege::User, ipmiGetSystemRestartCause);
2409
Tom05732372016-09-06 17:21:23 +05302410 // <Chassis Control>
anil kumar appanadafff5f2019-04-27 18:06:00 +00002411 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2412 ipmi::chassis::cmdChassisControl,
2413 ipmi::Privilege::Operator, ipmiChassisControl);
shgoupfd84fbbf2015-12-17 10:05:51 +08002414
Tom Joseph5110c122018-03-23 17:55:40 +05302415 // <Chassis Identify>
Vernon Mauery400cc782018-10-09 13:49:53 -07002416 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2417 ipmi::chassis::cmdChassisIdentify,
2418 ipmi::Privilege::Operator, ipmiChassisIdentify);
Tom Joseph5110c122018-03-23 17:55:40 +05302419
Tom05732372016-09-06 17:21:23 +05302420 // <Set System Boot Options>
jayaprakash Mutyalabfd8fc42020-05-05 22:38:03 +00002421 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2422 ipmi::chassis::cmdSetSystemBootOptions,
2423 ipmi::Privilege::Operator,
2424 ipmiChassisSetSysBootOptions);
2425
Nagaraju Gorugantia59d83f2018-04-06 05:55:42 -05002426 // <Get POH Counter>
anil kumar appanaa5a76eb2019-04-30 14:57:24 +00002427 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2428 ipmi::chassis::cmdGetPohCounter,
2429 ipmi::Privilege::User, ipmiGetPOHCounter);
Yong Lic6713cf2018-09-12 12:35:13 +08002430
2431 // <Set Power Restore Policy>
Vernon Mauerye278ead2018-10-09 09:23:43 -07002432 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis,
2433 ipmi::chassis::cmdSetPowerRestorePolicy,
2434 ipmi::Privilege::Operator,
2435 ipmiChassisSetPowerRestorePolicy);
vishwa36993272015-11-20 12:43:49 -06002436}