1 #include "config.h" 2 3 #include "chassishandler.hpp" 4 5 #include <arpa/inet.h> 6 #include <endian.h> 7 #include <limits.h> 8 #include <mapper.h> 9 #include <netinet/in.h> 10 11 #include <array> 12 #include <chrono> 13 #include <cstring> 14 #include <filesystem> 15 #include <fstream> 16 #include <future> 17 #include <ipmid/api.hpp> 18 #include <ipmid/types.hpp> 19 #include <ipmid/utils.hpp> 20 #include <map> 21 #include <phosphor-logging/elog-errors.hpp> 22 #include <phosphor-logging/log.hpp> 23 #include <sdbusplus/bus.hpp> 24 #include <sdbusplus/message/types.hpp> 25 #include <sdbusplus/server/object.hpp> 26 #include <sdbusplus/timer.hpp> 27 #include <settings.hpp> 28 #include <sstream> 29 #include <string> 30 #include <xyz/openbmc_project/Common/error.hpp> 31 #include <xyz/openbmc_project/Control/Boot/Mode/server.hpp> 32 #include <xyz/openbmc_project/Control/Boot/Source/server.hpp> 33 #include <xyz/openbmc_project/Control/Boot/Type/server.hpp> 34 #include <xyz/openbmc_project/Control/Power/RestorePolicy/server.hpp> 35 #include <xyz/openbmc_project/State/Chassis/server.hpp> 36 #include <xyz/openbmc_project/State/Host/server.hpp> 37 #include <xyz/openbmc_project/State/PowerOnHours/server.hpp> 38 39 std::unique_ptr<phosphor::Timer> identifyTimer 40 __attribute__((init_priority(101))); 41 42 static ChassisIDState chassisIDState = ChassisIDState::reserved; 43 static constexpr uint8_t setParmVersion = 0x01; 44 45 constexpr size_t sizeVersion = 2; 46 constexpr size_t DEFAULT_IDENTIFY_TIME_OUT = 15; 47 48 // PetiBoot-Specific 49 static constexpr uint8_t netConfInitialBytes[] = {0x80, 0x21, 0x70, 0x62, 50 0x21, 0x00, 0x01, 0x06}; 51 static constexpr uint8_t oemParmStart = 96; 52 static constexpr uint8_t oemParmEnd = 127; 53 54 static constexpr size_t cookieOffset = 1; 55 static constexpr size_t versionOffset = 5; 56 static constexpr size_t addrSizeOffset = 8; 57 static constexpr size_t macOffset = 9; 58 static constexpr size_t addrTypeOffset = 16; 59 static constexpr size_t ipAddrOffset = 17; 60 61 static constexpr size_t encIdentifyObjectsSize = 1; 62 static constexpr size_t chassisIdentifyReqLength = 2; 63 static constexpr size_t identifyIntervalPos = 0; 64 static constexpr size_t forceIdentifyPos = 1; 65 66 namespace ipmi 67 { 68 constexpr Cc ccParmNotSupported = 0x80; 69 70 static inline auto responseParmNotSupported() 71 { 72 return response(ccParmNotSupported); 73 } 74 } // namespace ipmi 75 76 void register_netfn_chassis_functions() __attribute__((constructor)); 77 78 // Host settings in dbus 79 // Service name should be referenced by connection name got via object mapper 80 const char* settings_object_name = "/org/openbmc/settings/host0"; 81 const char* settings_intf_name = "org.freedesktop.DBus.Properties"; 82 const char* identify_led_object_name = 83 "/xyz/openbmc_project/led/groups/enclosure_identify"; 84 85 constexpr auto SETTINGS_ROOT = "/"; 86 constexpr auto SETTINGS_MATCH = "host0"; 87 88 constexpr auto IP_INTERFACE = "xyz.openbmc_project.Network.IP"; 89 constexpr auto MAC_INTERFACE = "xyz.openbmc_project.Network.MACAddress"; 90 91 static constexpr auto chassisStateRoot = "/xyz/openbmc_project/state"; 92 static constexpr auto chassisPOHStateIntf = 93 "xyz.openbmc_project.State.PowerOnHours"; 94 static constexpr auto pohCounterProperty = "POHCounter"; 95 static constexpr auto match = "chassis0"; 96 const static constexpr char chassisCapIntf[] = 97 "xyz.openbmc_project.Control.ChassisCapabilities"; 98 const static constexpr char chassisIntrusionProp[] = "ChassisIntrusionEnabled"; 99 const static constexpr char chassisFrontPanelLockoutProp[] = 100 "ChassisFrontPanelLockoutEnabled"; 101 const static constexpr char chassisNMIProp[] = "ChassisNMIEnabled"; 102 const static constexpr char chassisPowerInterlockProp[] = 103 "ChassisPowerInterlockEnabled"; 104 const static constexpr char chassisFRUDevAddrProp[] = "FRUDeviceAddress"; 105 const static constexpr char chassisSDRDevAddrProp[] = "SDRDeviceAddress"; 106 const static constexpr char chassisSELDevAddrProp[] = "SELDeviceAddress"; 107 const static constexpr char chassisSMDevAddrProp[] = "SMDeviceAddress"; 108 const static constexpr char chassisBridgeDevAddrProp[] = "BridgeDeviceAddress"; 109 static constexpr uint8_t chassisCapFlagMask = 0x0f; 110 static constexpr uint8_t chassisCapAddrMask = 0xfe; 111 static constexpr const char* powerButtonIntf = 112 "xyz.openbmc_project.Chassis.Buttons.Power"; 113 static constexpr const char* powerButtonPath = 114 "/xyz/openbmc_project/Chassis/Buttons/Power0"; 115 static constexpr const char* resetButtonIntf = 116 "xyz.openbmc_project.Chassis.Buttons.Reset"; 117 static constexpr const char* resetButtonPath = 118 "/xyz/openbmc_project/Chassis/Buttons/Reset0"; 119 120 // Phosphor Host State manager 121 namespace State = sdbusplus::xyz::openbmc_project::State::server; 122 123 namespace fs = std::filesystem; 124 125 using namespace phosphor::logging; 126 using namespace sdbusplus::xyz::openbmc_project::Common::Error; 127 using namespace sdbusplus::xyz::openbmc_project::Control::Boot::server; 128 129 namespace chassis 130 { 131 namespace internal 132 { 133 134 constexpr auto bootSettingsPath = "/xyz/openbmc_project/control/host0/boot"; 135 constexpr auto bootEnableIntf = "xyz.openbmc_project.Object.Enable"; 136 constexpr auto bootModeIntf = "xyz.openbmc_project.Control.Boot.Mode"; 137 constexpr auto bootTypeIntf = "xyz.openbmc_project.Control.Boot.Type"; 138 constexpr auto bootSourceIntf = "xyz.openbmc_project.Control.Boot.Source"; 139 constexpr auto bootSettingsOneTimePath = 140 "/xyz/openbmc_project/control/host0/boot/one_time"; 141 constexpr auto bootOneTimeIntf = "xyz.openbmc_project.Object.Enable"; 142 143 constexpr auto powerRestoreIntf = 144 "xyz.openbmc_project.Control.Power.RestorePolicy"; 145 sdbusplus::bus::bus dbus(ipmid_get_sd_bus_connection()); 146 147 namespace cache 148 { 149 150 std::unique_ptr<settings::Objects> objectsPtr = nullptr; 151 152 settings::Objects& getObjects() 153 { 154 if (objectsPtr == nullptr) 155 { 156 objectsPtr = std::make_unique<settings::Objects>( 157 dbus, std::vector<std::string>{bootModeIntf, bootTypeIntf, 158 bootSourceIntf, powerRestoreIntf}); 159 } 160 return *objectsPtr; 161 } 162 163 } // namespace cache 164 } // namespace internal 165 } // namespace chassis 166 167 namespace poh 168 { 169 170 constexpr auto minutesPerCount = 60; 171 172 } // namespace poh 173 174 int getHostNetworkData(ipmi::message::Payload& payload) 175 { 176 ipmi::PropertyMap properties; 177 int rc = 0; 178 uint8_t addrSize = ipmi::network::IPV4_ADDRESS_SIZE_BYTE; 179 180 try 181 { 182 // TODO There may be cases where an interface is implemented by multiple 183 // objects,to handle such cases we are interested on that object 184 // which are on interested busname. 185 // Currenlty mapper doesn't give the readable busname(gives busid) 186 // so we can't match with bus name so giving some object specific info 187 // as SETTINGS_MATCH. 188 // Later SETTINGS_MATCH will be replaced with busname. 189 190 sdbusplus::bus::bus bus(ipmid_get_sd_bus_connection()); 191 192 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE, 193 SETTINGS_ROOT, SETTINGS_MATCH); 194 195 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE, 196 SETTINGS_ROOT, SETTINGS_MATCH); 197 198 properties = ipmi::getAllDbusProperties( 199 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE); 200 auto variant = ipmi::getDbusProperty(bus, macObjectInfo.second, 201 macObjectInfo.first, MAC_INTERFACE, 202 "MACAddress"); 203 204 auto ipAddress = std::get<std::string>(properties["Address"]); 205 206 auto gateway = std::get<std::string>(properties["Gateway"]); 207 208 auto prefix = std::get<uint8_t>(properties["PrefixLength"]); 209 210 uint8_t isStatic = 211 (std::get<std::string>(properties["Origin"]) == 212 "xyz.openbmc_project.Network.IP.AddressOrigin.Static") 213 ? 1 214 : 0; 215 216 auto MACAddress = std::get<std::string>(variant); 217 218 // it is expected here that we should get the valid data 219 // but we may also get the default values. 220 // Validation of the data is done by settings. 221 // 222 // if mac address is default mac address then 223 // don't send blank override. 224 if ((MACAddress == ipmi::network::DEFAULT_MAC_ADDRESS)) 225 { 226 rc = -1; 227 return rc; 228 } 229 // if addr is static then ipaddress,gateway,prefix 230 // should not be default one,don't send blank override. 231 if (isStatic) 232 { 233 if ((ipAddress == ipmi::network::DEFAULT_ADDRESS) || 234 (gateway == ipmi::network::DEFAULT_ADDRESS) || (!prefix)) 235 { 236 rc = -1; 237 return rc; 238 } 239 } 240 241 std::string token; 242 std::stringstream ss(MACAddress); 243 244 // First pack macOffset no of bytes in payload. 245 // Latter this PetiBoot-Specific data will be populated. 246 std::vector<uint8_t> payloadInitialBytes(macOffset); 247 payload.pack(payloadInitialBytes); 248 249 while (std::getline(ss, token, ':')) 250 { 251 payload.pack(stoi(token, nullptr, 16)); 252 } 253 254 payload.pack(0x00); 255 256 payload.pack(isStatic); 257 258 uint8_t addressFamily = (std::get<std::string>(properties["Type"]) == 259 "xyz.openbmc_project.Network.IP.Protocol.IPv4") 260 ? AF_INET 261 : AF_INET6; 262 263 addrSize = (addressFamily == AF_INET) 264 ? ipmi::network::IPV4_ADDRESS_SIZE_BYTE 265 : ipmi::network::IPV6_ADDRESS_SIZE_BYTE; 266 267 // ipaddress and gateway would be in IPv4 format 268 std::vector<uint8_t> addrInBinary(addrSize); 269 inet_pton(addressFamily, ipAddress.c_str(), 270 reinterpret_cast<void*>(addrInBinary.data())); 271 272 payload.pack(addrInBinary); 273 274 payload.pack(prefix); 275 276 std::vector<uint8_t> gatewayDetails(addrSize); 277 inet_pton(addressFamily, gateway.c_str(), 278 reinterpret_cast<void*>(gatewayDetails.data())); 279 payload.pack(gatewayDetails); 280 } 281 catch (const InternalFailure& e) 282 { 283 commit<InternalFailure>(); 284 rc = -1; 285 return rc; 286 } 287 288 // PetiBoot-Specific 289 // If success then copy the first 9 bytes to the payload message 290 // payload first 2 bytes contain the parameter values. Skip that 2 bytes. 291 uint8_t skipFirstTwoBytes = 2; 292 size_t payloadSize = payload.size(); 293 uint8_t* configDataStartingAddress = payload.data() + skipFirstTwoBytes; 294 295 if (payloadSize < skipFirstTwoBytes + sizeof(netConfInitialBytes)) 296 { 297 log<level::ERR>("Invalid net config "); 298 rc = -1; 299 return rc; 300 } 301 std::copy(netConfInitialBytes, 302 netConfInitialBytes + sizeof(netConfInitialBytes), 303 configDataStartingAddress); 304 305 if (payloadSize < skipFirstTwoBytes + addrSizeOffset + sizeof(addrSize)) 306 { 307 log<level::ERR>("Invalid length of address size"); 308 rc = -1; 309 return rc; 310 } 311 std::copy(&addrSize, &(addrSize) + sizeof(addrSize), 312 configDataStartingAddress + addrSizeOffset); 313 314 #ifdef _IPMI_DEBUG_ 315 std::printf("\n===Printing the IPMI Formatted Data========\n"); 316 317 for (uint8_t pos = 0; pos < index; pos++) 318 { 319 std::printf("%02x ", payloadStartingAddress[pos]); 320 } 321 #endif 322 323 return rc; 324 } 325 326 /** @brief convert IPv4 and IPv6 addresses from binary to text form. 327 * @param[in] family - IPv4/Ipv6 328 * @param[in] data - req data pointer. 329 * @param[in] offset - offset in the data. 330 * @param[in] addrSize - size of the data which needs to be read from offset. 331 * @returns address in text form. 332 */ 333 334 std::string getAddrStr(uint8_t family, uint8_t* data, uint8_t offset, 335 uint8_t addrSize) 336 { 337 char ipAddr[INET6_ADDRSTRLEN] = {}; 338 339 switch (family) 340 { 341 case AF_INET: 342 { 343 struct sockaddr_in addr4 344 { 345 }; 346 std::memcpy(&addr4.sin_addr.s_addr, &data[offset], addrSize); 347 348 inet_ntop(AF_INET, &addr4.sin_addr, ipAddr, INET_ADDRSTRLEN); 349 350 break; 351 } 352 case AF_INET6: 353 { 354 struct sockaddr_in6 addr6 355 { 356 }; 357 std::memcpy(&addr6.sin6_addr.s6_addr, &data[offset], addrSize); 358 359 inet_ntop(AF_INET6, &addr6.sin6_addr, ipAddr, INET6_ADDRSTRLEN); 360 361 break; 362 } 363 default: 364 { 365 return {}; 366 } 367 } 368 369 return ipAddr; 370 } 371 372 ipmi::Cc setHostNetworkData(ipmi::message::Payload& data) 373 { 374 using namespace std::string_literals; 375 std::string hostNetworkConfig; 376 std::string mac("00:00:00:00:00:00"); 377 std::string ipAddress, gateway; 378 std::string addrOrigin{0}; 379 uint8_t addrSize{0}; 380 std::string addressOrigin = 381 "xyz.openbmc_project.Network.IP.AddressOrigin.DHCP"; 382 std::string addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv4"; 383 uint8_t prefix{0}; 384 uint8_t family = AF_INET; 385 386 // cookie starts from second byte 387 // version starts from sixth byte 388 389 try 390 { 391 do 392 { 393 // cookie == 0x21 0x70 0x62 0x21 394 data.trailingOk = true; 395 auto msgLen = data.size(); 396 std::vector<uint8_t> msgPayloadBytes(msgLen); 397 if (data.unpack(msgPayloadBytes) != 0 || !data.fullyUnpacked()) 398 { 399 log<level::ERR>( 400 "Error in unpacking message of setHostNetworkData"); 401 return ipmi::ccReqDataLenInvalid; 402 } 403 404 uint8_t* msgPayloadStartingPos = msgPayloadBytes.data(); 405 constexpr size_t cookieSize = 4; 406 if (msgLen < cookieOffset + cookieSize) 407 { 408 log<level::ERR>( 409 "Error in cookie getting of setHostNetworkData"); 410 return ipmi::ccReqDataLenInvalid; 411 } 412 if (std::equal(msgPayloadStartingPos + cookieOffset, 413 msgPayloadStartingPos + cookieOffset + cookieSize, 414 (netConfInitialBytes + cookieOffset)) != 0) 415 { 416 // all cookie == 0 417 if (std::all_of(msgPayloadStartingPos + cookieOffset, 418 msgPayloadStartingPos + cookieOffset + 419 cookieSize, 420 [](int i) { return i == 0; }) == true) 421 { 422 // need to zero out the network settings. 423 break; 424 } 425 426 log<level::ERR>("Invalid Cookie"); 427 elog<InternalFailure>(); 428 } 429 430 // vesion == 0x00 0x01 431 if (msgLen < versionOffset + sizeVersion) 432 { 433 log<level::ERR>( 434 "Error in version getting of setHostNetworkData"); 435 return ipmi::ccReqDataLenInvalid; 436 } 437 if (std::equal(msgPayloadStartingPos + versionOffset, 438 msgPayloadStartingPos + versionOffset + sizeVersion, 439 (netConfInitialBytes + versionOffset)) != 0) 440 { 441 log<level::ERR>("Invalid Version"); 442 elog<InternalFailure>(); 443 } 444 445 if (msgLen < macOffset + 6) 446 { 447 log<level::ERR>( 448 "Error in mac address getting of setHostNetworkData"); 449 return ipmi::ccReqDataLenInvalid; 450 } 451 std::stringstream result; 452 std::copy((msgPayloadStartingPos + macOffset), 453 (msgPayloadStartingPos + macOffset + 5), 454 std::ostream_iterator<int>(result, ":")); 455 mac = result.str(); 456 457 if (msgLen < addrTypeOffset + sizeof(decltype(addrOrigin))) 458 { 459 log<level::ERR>( 460 "Error in original address getting of setHostNetworkData"); 461 return ipmi::ccReqDataLenInvalid; 462 } 463 std::copy(msgPayloadStartingPos + addrTypeOffset, 464 msgPayloadStartingPos + addrTypeOffset + 465 sizeof(decltype(addrOrigin)), 466 std::ostream_iterator<int>(result, "")); 467 addrOrigin = result.str(); 468 469 if (!addrOrigin.empty()) 470 { 471 addressOrigin = 472 "xyz.openbmc_project.Network.IP.AddressOrigin.Static"; 473 } 474 475 if (msgLen < addrSizeOffset + sizeof(decltype(addrSize))) 476 { 477 log<level::ERR>( 478 "Error in address size getting of setHostNetworkData"); 479 return ipmi::ccReqDataLenInvalid; 480 } 481 // Get the address size 482 std::copy(msgPayloadStartingPos + addrSizeOffset, 483 (msgPayloadStartingPos + addrSizeOffset + 484 sizeof(decltype(addrSize))), 485 &addrSize); 486 487 uint8_t prefixOffset = ipAddrOffset + addrSize; 488 if (msgLen < prefixOffset + sizeof(decltype(prefix))) 489 { 490 log<level::ERR>( 491 "Error in prefix getting of setHostNetworkData"); 492 return ipmi::ccReqDataLenInvalid; 493 } 494 std::copy(msgPayloadStartingPos + prefixOffset, 495 (msgPayloadStartingPos + prefixOffset + 496 sizeof(decltype(prefix))), 497 &prefix); 498 499 uint8_t gatewayOffset = prefixOffset + sizeof(decltype(prefix)); 500 if (addrSize != ipmi::network::IPV4_ADDRESS_SIZE_BYTE) 501 { 502 addressType = "xyz.openbmc_project.Network.IP.Protocol.IPv6"; 503 family = AF_INET6; 504 } 505 506 if (msgLen < ipAddrOffset + addrSize) 507 { 508 log<level::ERR>( 509 "Error in IP address getting of setHostNetworkData"); 510 return ipmi::ccReqDataLenInvalid; 511 } 512 ipAddress = getAddrStr(family, msgPayloadStartingPos, ipAddrOffset, 513 addrSize); 514 515 if (msgLen < gatewayOffset + addrSize) 516 { 517 log<level::ERR>( 518 "Error in gateway address getting of setHostNetworkData"); 519 return ipmi::ccReqDataLenInvalid; 520 } 521 gateway = getAddrStr(family, msgPayloadStartingPos, gatewayOffset, 522 addrSize); 523 524 } while (0); 525 526 // Cookie == 0 or it is a valid cookie 527 hostNetworkConfig += "ipaddress="s + ipAddress + ",prefix="s + 528 std::to_string(prefix) + ",gateway="s + gateway + 529 ",mac="s + mac + ",addressOrigin="s + 530 addressOrigin; 531 532 sdbusplus::bus::bus bus(ipmid_get_sd_bus_connection()); 533 534 auto ipObjectInfo = ipmi::getDbusObject(bus, IP_INTERFACE, 535 SETTINGS_ROOT, SETTINGS_MATCH); 536 auto macObjectInfo = ipmi::getDbusObject(bus, MAC_INTERFACE, 537 SETTINGS_ROOT, SETTINGS_MATCH); 538 // set the dbus property 539 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first, 540 IP_INTERFACE, "Address", std::string(ipAddress)); 541 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first, 542 IP_INTERFACE, "PrefixLength", prefix); 543 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first, 544 IP_INTERFACE, "Origin", addressOrigin); 545 ipmi::setDbusProperty(bus, ipObjectInfo.second, ipObjectInfo.first, 546 IP_INTERFACE, "Gateway", std::string(gateway)); 547 ipmi::setDbusProperty( 548 bus, ipObjectInfo.second, ipObjectInfo.first, IP_INTERFACE, "Type", 549 std::string("xyz.openbmc_project.Network.IP.Protocol.IPv4")); 550 ipmi::setDbusProperty(bus, macObjectInfo.second, macObjectInfo.first, 551 MAC_INTERFACE, "MACAddress", std::string(mac)); 552 553 log<level::DEBUG>("Network configuration changed", 554 entry("NETWORKCONFIG=%s", hostNetworkConfig.c_str())); 555 } 556 catch (const sdbusplus::exception_t& e) 557 { 558 commit<InternalFailure>(); 559 log<level::ERR>("Error in ipmiChassisSetSysBootOptions call"); 560 return ipmi::ccUnspecifiedError; 561 } 562 563 return ipmi::ccSuccess; 564 } 565 566 uint32_t getPOHCounter() 567 { 568 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()}; 569 570 auto chassisStateObj = 571 ipmi::getDbusObject(bus, chassisPOHStateIntf, chassisStateRoot, match); 572 573 auto service = 574 ipmi::getService(bus, chassisPOHStateIntf, chassisStateObj.first); 575 576 auto propValue = 577 ipmi::getDbusProperty(bus, service, chassisStateObj.first, 578 chassisPOHStateIntf, pohCounterProperty); 579 580 return std::get<uint32_t>(propValue); 581 } 582 583 /** @brief Implements the get chassis capabilities command 584 * 585 * @returns IPMI completion code plus response data 586 * chassisCapFlags - chassis capability flag 587 * chassisFRUInfoDevAddr - chassis FRU info Device Address 588 * chassisSDRDevAddr - chassis SDR device address 589 * chassisSELDevAddr - chassis SEL device address 590 * chassisSMDevAddr - chassis system management device address 591 * chassisBridgeDevAddr - chassis bridge device address 592 */ 593 ipmi::RspType<bool, // chassis intrusion sensor 594 bool, // chassis Front panel lockout 595 bool, // chassis NMI 596 bool, // chassis power interlock 597 uint4_t, // reserved 598 uint8_t, // chassis FRU info Device Address 599 uint8_t, // chassis SDR device address 600 uint8_t, // chassis SEL device address 601 uint8_t, // chassis system management device address 602 uint8_t // chassis bridge device address 603 > 604 ipmiGetChassisCap() 605 { 606 ipmi::PropertyMap properties; 607 try 608 { 609 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()}; 610 611 ipmi::DbusObjectInfo chassisCapObject = 612 ipmi::getDbusObject(bus, chassisCapIntf); 613 614 // capabilities flags 615 // [7..4] - reserved 616 // [3] – 1b = provides power interlock (IPM 1.5) 617 // [2] – 1b = provides Diagnostic Interrupt (FP NMI) 618 // [1] – 1b = provides “Front Panel Lockout” (indicates that the chassis 619 // has capabilities 620 // to lock out external power control and reset button or 621 // front panel interfaces and/or detect tampering with those 622 // interfaces). 623 // [0] -1b = Chassis provides intrusion (physical security) sensor. 624 // set to default value 0x0. 625 626 properties = 627 ipmi::getAllDbusProperties(bus, chassisCapObject.second, 628 chassisCapObject.first, chassisCapIntf); 629 } 630 catch (const std::exception& e) 631 { 632 log<level::ERR>("Failed to fetch Chassis Capability properties", 633 entry("ERROR=%s", e.what())); 634 return ipmi::responseUnspecifiedError(); 635 } 636 637 bool* chassisIntrusionFlag = 638 std::get_if<bool>(&properties[chassisIntrusionProp]); 639 if (chassisIntrusionFlag == nullptr) 640 { 641 log<level::ERR>("Error to get chassis Intrusion flags"); 642 return ipmi::responseUnspecifiedError(); 643 } 644 bool* chassisFrontPanelFlag = 645 std::get_if<bool>(&properties[chassisFrontPanelLockoutProp]); 646 if (chassisFrontPanelFlag == nullptr) 647 { 648 log<level::ERR>("Error to get chassis intrusion flags"); 649 return ipmi::responseUnspecifiedError(); 650 } 651 bool* chassisNMIFlag = std::get_if<bool>(&properties[chassisNMIProp]); 652 if (chassisNMIFlag == nullptr) 653 { 654 log<level::ERR>("Error to get chassis NMI flags"); 655 return ipmi::responseUnspecifiedError(); 656 } 657 bool* chassisPowerInterlockFlag = 658 std::get_if<bool>(&properties[chassisPowerInterlockProp]); 659 if (chassisPowerInterlockFlag == nullptr) 660 { 661 log<level::ERR>("Error to get chassis power interlock flags"); 662 return ipmi::responseUnspecifiedError(); 663 } 664 uint8_t* chassisFRUInfoDevAddr = 665 std::get_if<uint8_t>(&properties[chassisFRUDevAddrProp]); 666 if (chassisFRUInfoDevAddr == nullptr) 667 { 668 log<level::ERR>("Error to get chassis FRU info device address"); 669 return ipmi::responseUnspecifiedError(); 670 } 671 uint8_t* chassisSDRDevAddr = 672 std::get_if<uint8_t>(&properties[chassisSDRDevAddrProp]); 673 if (chassisSDRDevAddr == nullptr) 674 { 675 log<level::ERR>("Error to get chassis SDR device address"); 676 return ipmi::responseUnspecifiedError(); 677 } 678 uint8_t* chassisSELDevAddr = 679 std::get_if<uint8_t>(&properties[chassisSELDevAddrProp]); 680 if (chassisSELDevAddr == nullptr) 681 { 682 log<level::ERR>("Error to get chassis SEL device address"); 683 return ipmi::responseUnspecifiedError(); 684 } 685 uint8_t* chassisSMDevAddr = 686 std::get_if<uint8_t>(&properties[chassisSMDevAddrProp]); 687 if (chassisSMDevAddr == nullptr) 688 { 689 log<level::ERR>("Error to get chassis SM device address"); 690 return ipmi::responseUnspecifiedError(); 691 } 692 uint8_t* chassisBridgeDevAddr = 693 std::get_if<uint8_t>(&properties[chassisBridgeDevAddrProp]); 694 if (chassisBridgeDevAddr == nullptr) 695 { 696 log<level::ERR>("Error to get chassis bridge device address"); 697 return ipmi::responseUnspecifiedError(); 698 } 699 700 return ipmi::responseSuccess(*chassisIntrusionFlag, *chassisFrontPanelFlag, 701 *chassisNMIFlag, *chassisPowerInterlockFlag, 0, 702 *chassisFRUInfoDevAddr, *chassisSDRDevAddr, 703 *chassisSELDevAddr, *chassisSMDevAddr, 704 *chassisBridgeDevAddr); 705 } 706 707 /** @brief implements set chassis capalibities command 708 * @param intrusion - chassis intrusion 709 * @param fpLockout - frontpannel lockout 710 * @param reserved1 - skip one bit 711 * @param fruDeviceAddr - chassis FRU info Device Address 712 * @param sdrDeviceAddr - chassis SDR device address 713 * @param selDeviceAddr - chassis SEL device address 714 * @param smDeviceAddr - chassis system management device address 715 * @param bridgeDeviceAddr - chassis bridge device address 716 * 717 * @returns IPMI completion code 718 */ 719 ipmi::RspType<> ipmiSetChassisCap(bool intrusion, bool fpLockout, 720 uint6_t reserved1, 721 722 uint8_t fruDeviceAddr, 723 724 uint8_t sdrDeviceAddr, 725 726 uint8_t selDeviceAddr, 727 728 uint8_t smDeviceAddr, 729 730 uint8_t bridgeDeviceAddr) 731 { 732 733 // check input data 734 if (reserved1 != 0) 735 { 736 log<level::ERR>("Unsupported request parameter"); 737 return ipmi::responseInvalidFieldRequest(); 738 } 739 740 if ((fruDeviceAddr & ~chassisCapAddrMask) != 0) 741 { 742 log<level::ERR>("Unsupported request parameter(FRU Addr)", 743 entry("REQ=0x%x", fruDeviceAddr)); 744 return ipmi::responseInvalidFieldRequest(); 745 } 746 if ((sdrDeviceAddr & ~chassisCapAddrMask) != 0) 747 { 748 log<level::ERR>("Unsupported request parameter(SDR Addr)", 749 entry("REQ=0x%x", sdrDeviceAddr)); 750 return ipmi::responseInvalidFieldRequest(); 751 } 752 753 if ((selDeviceAddr & ~chassisCapAddrMask) != 0) 754 { 755 log<level::ERR>("Unsupported request parameter(SEL Addr)", 756 entry("REQ=0x%x", selDeviceAddr)); 757 return ipmi::responseInvalidFieldRequest(); 758 } 759 760 if ((smDeviceAddr & ~chassisCapAddrMask) != 0) 761 { 762 log<level::ERR>("Unsupported request parameter(SM Addr)", 763 entry("REQ=0x%x", smDeviceAddr)); 764 return ipmi::responseInvalidFieldRequest(); 765 } 766 767 if ((bridgeDeviceAddr & ~chassisCapAddrMask) != 0) 768 { 769 log<level::ERR>("Unsupported request parameter(Bridge Addr)", 770 entry("REQ=0x%x", bridgeDeviceAddr)); 771 return ipmi::responseInvalidFieldRequest(); 772 } 773 774 try 775 { 776 sdbusplus::bus::bus bus(ipmid_get_sd_bus_connection()); 777 ipmi::DbusObjectInfo chassisCapObject = 778 ipmi::getDbusObject(bus, chassisCapIntf); 779 780 ipmi::setDbusProperty(bus, chassisCapObject.second, 781 chassisCapObject.first, chassisCapIntf, 782 chassisIntrusionProp, intrusion); 783 784 ipmi::setDbusProperty(bus, chassisCapObject.second, 785 chassisCapObject.first, chassisCapIntf, 786 chassisFrontPanelLockoutProp, fpLockout); 787 788 ipmi::setDbusProperty(bus, chassisCapObject.second, 789 chassisCapObject.first, chassisCapIntf, 790 chassisFRUDevAddrProp, fruDeviceAddr); 791 792 ipmi::setDbusProperty(bus, chassisCapObject.second, 793 chassisCapObject.first, chassisCapIntf, 794 chassisSDRDevAddrProp, sdrDeviceAddr); 795 796 ipmi::setDbusProperty(bus, chassisCapObject.second, 797 chassisCapObject.first, chassisCapIntf, 798 chassisSELDevAddrProp, selDeviceAddr); 799 800 ipmi::setDbusProperty(bus, chassisCapObject.second, 801 chassisCapObject.first, chassisCapIntf, 802 chassisSMDevAddrProp, smDeviceAddr); 803 804 ipmi::setDbusProperty(bus, chassisCapObject.second, 805 chassisCapObject.first, chassisCapIntf, 806 chassisBridgeDevAddrProp, bridgeDeviceAddr); 807 } 808 catch (const std::exception& e) 809 { 810 log<level::ERR>(e.what()); 811 return ipmi::responseUnspecifiedError(); 812 } 813 return ipmi::responseSuccess(); 814 } 815 816 //------------------------------------------ 817 // Calls into Host State Manager Dbus object 818 //------------------------------------------ 819 int initiateHostStateTransition(ipmi::Context::ptr& ctx, 820 State::Host::Transition transition) 821 { 822 // OpenBMC Host State Manager dbus framework 823 constexpr auto hostStatePath = "/xyz/openbmc_project/state/host0"; 824 constexpr auto hostStateIntf = "xyz.openbmc_project.State.Host"; 825 826 // Convert to string equivalent of the passed in transition enum. 827 auto request = State::convertForMessage(transition); 828 829 std::string service; 830 boost::system::error_code ec = 831 ipmi::getService(ctx, hostStateIntf, hostStatePath, service); 832 833 if (!ec) 834 { 835 ec = ipmi::setDbusProperty(ctx, service, hostStatePath, hostStateIntf, 836 "RequestedHostTransition", request); 837 } 838 if (ec) 839 { 840 log<level::ERR>("Failed to initiate transition", 841 entry("EXCEPTION=%s, REQUEST=%s", ec.message().c_str(), 842 request.c_str())); 843 return -1; 844 } 845 log<level::INFO>( 846 "Transition request initiated successfully", 847 entry("USERID=%d, REQUEST=%s", ctx->userId, request.c_str())); 848 return 0; 849 } 850 851 //------------------------------------------ 852 // Calls into Chassis State Manager Dbus object 853 //------------------------------------------ 854 int initiateChassisStateTransition(ipmi::Context::ptr& ctx, 855 State::Chassis::Transition transition) 856 { 857 // OpenBMC Chassis State Manager dbus framework 858 constexpr auto chassisStatePath = "/xyz/openbmc_project/state/chassis0"; 859 constexpr auto chassisStateIntf = "xyz.openbmc_project.State.Chassis"; 860 861 std::string service; 862 boost::system::error_code ec = 863 ipmi::getService(ctx, chassisStateIntf, chassisStatePath, service); 864 865 // Convert to string equivalent of the passed in transition enum. 866 auto request = State::convertForMessage(transition); 867 868 if (!ec) 869 { 870 ec = ipmi::setDbusProperty(ctx, service, chassisStatePath, 871 chassisStateIntf, "RequestedPowerTransition", 872 request); 873 } 874 if (ec) 875 { 876 log<level::ERR>("Failed to initiate transition", 877 entry("EXCEPTION=%s, REQUEST=%s", ec.message().c_str(), 878 request.c_str())); 879 return -1; 880 } 881 882 return 0; 883 } 884 885 //------------------------------------------ 886 // Set Enabled property to inform NMI source 887 // handling to trigger a NMI_OUT BSOD. 888 //------------------------------------------ 889 int setNmiProperty(const bool value) 890 { 891 constexpr const char* nmiSourceObjPath = 892 "/xyz/openbmc_project/Chassis/Control/NMISource"; 893 constexpr const char* nmiSourceIntf = 894 "xyz.openbmc_project.Chassis.Control.NMISource"; 895 std::string bmcSourceSignal = "xyz.openbmc_project.Chassis.Control." 896 "NMISource.BMCSourceSignal.ChassisCmd"; 897 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus(); 898 899 try 900 { 901 auto service = ipmi::getService(*busp, nmiSourceIntf, nmiSourceObjPath); 902 ipmi::setDbusProperty(*busp, service, nmiSourceObjPath, nmiSourceIntf, 903 "BMCSource", bmcSourceSignal); 904 ipmi::setDbusProperty(*busp, service, nmiSourceObjPath, nmiSourceIntf, 905 "Enabled", value); 906 } 907 catch (const std::exception& e) 908 { 909 log<level::ERR>("Failed to trigger NMI_OUT", 910 entry("EXCEPTION=%s", e.what())); 911 return -1; 912 } 913 914 return 0; 915 } 916 917 namespace power_policy 918 { 919 920 using namespace sdbusplus::xyz::openbmc_project::Control::Power::server; 921 using IpmiValue = uint8_t; 922 using DbusValue = RestorePolicy::Policy; 923 924 const std::map<DbusValue, IpmiValue> dbusToIpmi = { 925 {RestorePolicy::Policy::AlwaysOff, 0x00}, 926 {RestorePolicy::Policy::Restore, 0x01}, 927 {RestorePolicy::Policy::AlwaysOn, 0x02}}; 928 929 static constexpr uint8_t noChange = 0x03; 930 static constexpr uint8_t allSupport = 0x01 | 0x02 | 0x04; 931 932 /* helper function for Get Chassis Status Command 933 */ 934 std::optional<uint2_t> getPowerRestorePolicy() 935 { 936 uint2_t restorePolicy = 0; 937 using namespace chassis::internal; 938 939 settings::Objects& objects = cache::getObjects(); 940 941 try 942 { 943 const auto& powerRestoreSetting = 944 objects.map.at(powerRestoreIntf).front(); 945 ipmi::Value result = ipmi::getDbusProperty( 946 *getSdBus(), 947 objects.service(powerRestoreSetting, powerRestoreIntf).c_str(), 948 powerRestoreSetting.c_str(), powerRestoreIntf, 949 "PowerRestorePolicy"); 950 auto powerRestore = RestorePolicy::convertPolicyFromString( 951 std::get<std::string>(result)); 952 restorePolicy = dbusToIpmi.at(powerRestore); 953 } 954 catch (const std::exception& e) 955 { 956 log<level::ERR>( 957 "Failed to fetch pgood property", entry("ERROR=%s", e.what()), 958 entry("PATH=%s", objects.map.at(powerRestoreIntf).front().c_str()), 959 entry("INTERFACE=%s", powerRestoreIntf)); 960 cache::objectsPtr.reset(); 961 return std::nullopt; 962 } 963 return std::make_optional(restorePolicy); 964 } 965 966 /* 967 * getPowerStatus 968 * helper function for Get Chassis Status Command 969 * return - optional value for pgood (no value on error) 970 */ 971 std::optional<bool> getPowerStatus() 972 { 973 bool powerGood = false; 974 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus(); 975 try 976 { 977 constexpr const char* chassisStatePath = 978 "/xyz/openbmc_project/state/chassis0"; 979 constexpr const char* chassisStateIntf = 980 "xyz.openbmc_project.State.Chassis"; 981 auto service = 982 ipmi::getService(*busp, chassisStateIntf, chassisStatePath); 983 984 ipmi::Value powerState = 985 ipmi::getDbusProperty(*busp, service, chassisStatePath, 986 chassisStateIntf, "CurrentPowerState"); 987 powerGood = std::get<std::string>(powerState) == 988 "xyz.openbmc_project.State.Chassis.PowerState.On"; 989 } 990 catch (const std::exception& e) 991 { 992 try 993 { 994 // FIXME: some legacy modules use the older path; try that next 995 constexpr const char* legacyPwrCtrlObj = 996 "/org/openbmc/control/power0"; 997 constexpr const char* legacyPwrCtrlIntf = 998 "org.openbmc.control.Power"; 999 auto service = 1000 ipmi::getService(*busp, legacyPwrCtrlIntf, legacyPwrCtrlObj); 1001 1002 ipmi::Value variant = ipmi::getDbusProperty( 1003 *busp, service, legacyPwrCtrlObj, legacyPwrCtrlIntf, "pgood"); 1004 powerGood = static_cast<bool>(std::get<int>(variant)); 1005 } 1006 catch (const std::exception& e) 1007 { 1008 log<level::ERR>("Failed to fetch pgood property", 1009 entry("ERROR=%s", e.what())); 1010 return std::nullopt; 1011 } 1012 } 1013 return std::make_optional(powerGood); 1014 } 1015 1016 /* 1017 * getACFailStatus 1018 * helper function for Get Chassis Status Command 1019 * return - bool value for ACFail (false on error) 1020 */ 1021 bool getACFailStatus() 1022 { 1023 constexpr const char* powerControlObj = 1024 "/xyz/openbmc_project/Chassis/Control/Power0"; 1025 constexpr const char* powerControlIntf = 1026 "xyz.openbmc_project.Chassis.Control.Power"; 1027 bool acFail = false; 1028 std::shared_ptr<sdbusplus::asio::connection> bus = getSdBus(); 1029 try 1030 { 1031 auto service = 1032 ipmi::getService(*bus, powerControlIntf, powerControlObj); 1033 1034 ipmi::Value variant = ipmi::getDbusProperty( 1035 *bus, service, powerControlObj, powerControlIntf, "PFail"); 1036 acFail = std::get<bool>(variant); 1037 } 1038 catch (const std::exception& e) 1039 { 1040 log<level::ERR>("Failed to fetch PFail property", 1041 entry("ERROR=%s", e.what()), 1042 entry("PATH=%s", powerControlObj), 1043 entry("INTERFACE=%s", powerControlIntf)); 1044 } 1045 return acFail; 1046 } 1047 } // namespace power_policy 1048 1049 static std::optional<bool> getButtonEnabled(const std::string& buttonPath, 1050 const std::string& buttonIntf) 1051 { 1052 std::shared_ptr<sdbusplus::asio::connection> busp = getSdBus(); 1053 bool buttonDisabled = false; 1054 try 1055 { 1056 auto service = ipmi::getService(*busp, buttonIntf, buttonPath); 1057 ipmi::Value enabled = ipmi::getDbusProperty(*busp, service, buttonPath, 1058 buttonIntf, "Enabled"); 1059 buttonDisabled = !std::get<bool>(enabled); 1060 } 1061 catch (const sdbusplus::exception::exception& e) 1062 { 1063 log<level::ERR>("Fail to get button Enabled property", 1064 entry("PATH=%s", buttonPath.c_str()), 1065 entry("ERROR=%s", e.what())); 1066 return std::nullopt; 1067 } 1068 return std::make_optional(buttonDisabled); 1069 } 1070 1071 static bool setButtonEnabled(ipmi::Context::ptr& ctx, 1072 const std::string& buttonPath, 1073 const std::string& buttonIntf, bool enable) 1074 { 1075 std::string service; 1076 boost::system::error_code ec; 1077 ec = ipmi::getService(ctx, buttonIntf, buttonPath, service); 1078 if (!ec) 1079 { 1080 ec = ipmi::setDbusProperty(ctx, service, buttonPath, buttonIntf, 1081 "Enabled", enable); 1082 } 1083 if (ec) 1084 { 1085 log<level::ERR>("Fail to set button Enabled property", 1086 entry("SERVICE=%s", service.c_str()), 1087 entry("PATH=%s", buttonPath.c_str()), 1088 entry("ERROR=%s", ec.message().c_str())); 1089 return false; 1090 } 1091 return true; 1092 } 1093 1094 //---------------------------------------------------------------------- 1095 // Get Chassis Status commands 1096 //---------------------------------------------------------------------- 1097 ipmi::RspType<bool, // Power is on 1098 bool, // Power overload 1099 bool, // Interlock 1100 bool, // power fault 1101 bool, // power control fault 1102 uint2_t, // power restore policy 1103 bool, // reserved 1104 1105 bool, // AC failed 1106 bool, // last power down caused by a Power overload 1107 bool, // last power down caused by a power interlock 1108 bool, // last power down caused by power fault 1109 bool, // last ‘Power is on’ state was entered via IPMI command 1110 uint3_t, // reserved 1111 1112 bool, // Chassis intrusion active 1113 bool, // Front Panel Lockout active 1114 bool, // Drive Fault 1115 bool, // Cooling/fan fault detected 1116 uint2_t, // Chassis Identify State 1117 bool, // Chassis Identify command and state info supported 1118 bool, // reserved 1119 1120 bool, // Power off button disabled 1121 bool, // Reset button disabled 1122 bool, // Diagnostic Interrupt button disabled 1123 bool, // Standby (sleep) button disabled 1124 bool, // Power off button disable allowed 1125 bool, // Reset button disable allowed 1126 bool, // Diagnostic Interrupt button disable allowed 1127 bool // Standby (sleep) button disable allowed 1128 > 1129 ipmiGetChassisStatus() 1130 { 1131 using namespace chassis::internal; 1132 std::optional<uint2_t> restorePolicy = 1133 power_policy::getPowerRestorePolicy(); 1134 std::optional<bool> powerGood = power_policy::getPowerStatus(); 1135 if (!restorePolicy || !powerGood) 1136 { 1137 return ipmi::responseUnspecifiedError(); 1138 } 1139 1140 // Front Panel Button Capabilities and disable/enable status(Optional) 1141 std::optional<bool> powerButtonReading = 1142 getButtonEnabled(powerButtonPath, powerButtonIntf); 1143 // allow disable if the interface is present 1144 bool powerButtonDisableAllow = static_cast<bool>(powerButtonReading); 1145 // default return the button is enabled (not disabled) 1146 bool powerButtonDisabled = false; 1147 if (powerButtonDisableAllow) 1148 { 1149 // return the real value of the button status, if present 1150 powerButtonDisabled = *powerButtonReading; 1151 } 1152 1153 std::optional<bool> resetButtonReading = 1154 getButtonEnabled(resetButtonPath, resetButtonIntf); 1155 // allow disable if the interface is present 1156 bool resetButtonDisableAllow = static_cast<bool>(resetButtonReading); 1157 // default return the button is enabled (not disabled) 1158 bool resetButtonDisabled = false; 1159 if (resetButtonDisableAllow) 1160 { 1161 // return the real value of the button status, if present 1162 resetButtonDisabled = *resetButtonReading; 1163 } 1164 1165 bool powerDownAcFailed = power_policy::getACFailStatus(); 1166 1167 // This response has a lot of hard-coded, unsupported fields 1168 // They are set to false or 0 1169 constexpr bool powerOverload = false; 1170 constexpr bool chassisInterlock = false; 1171 constexpr bool powerFault = false; 1172 constexpr bool powerControlFault = false; 1173 constexpr bool powerDownOverload = false; 1174 constexpr bool powerDownInterlock = false; 1175 constexpr bool powerDownPowerFault = false; 1176 constexpr bool powerStatusIPMI = false; 1177 constexpr bool chassisIntrusionActive = false; 1178 constexpr bool frontPanelLockoutActive = false; 1179 constexpr bool driveFault = false; 1180 constexpr bool coolingFanFault = false; 1181 // chassisIdentifySupport set because this command is implemented 1182 constexpr bool chassisIdentifySupport = true; 1183 uint2_t chassisIdentifyState = types::enum_cast<uint2_t>(chassisIDState); 1184 constexpr bool diagButtonDisabled = false; 1185 constexpr bool sleepButtonDisabled = false; 1186 constexpr bool diagButtonDisableAllow = false; 1187 constexpr bool sleepButtonDisableAllow = false; 1188 1189 return ipmi::responseSuccess( 1190 *powerGood, powerOverload, chassisInterlock, powerFault, 1191 powerControlFault, *restorePolicy, 1192 false, // reserved 1193 1194 powerDownAcFailed, powerDownOverload, powerDownInterlock, 1195 powerDownPowerFault, powerStatusIPMI, 1196 uint3_t(0), // reserved 1197 1198 chassisIntrusionActive, frontPanelLockoutActive, driveFault, 1199 coolingFanFault, chassisIdentifyState, chassisIdentifySupport, 1200 false, // reserved 1201 1202 powerButtonDisabled, resetButtonDisabled, diagButtonDisabled, 1203 sleepButtonDisabled, powerButtonDisableAllow, resetButtonDisableAllow, 1204 diagButtonDisableAllow, sleepButtonDisableAllow); 1205 } 1206 1207 enum class IpmiRestartCause 1208 { 1209 Unknown = 0x0, 1210 RemoteCommand = 0x1, 1211 ResetButton = 0x2, 1212 PowerButton = 0x3, 1213 WatchdogTimer = 0x4, 1214 PowerPolicyAlwaysOn = 0x6, 1215 PowerPolicyPreviousState = 0x7, 1216 SoftReset = 0xa, 1217 }; 1218 1219 static IpmiRestartCause 1220 restartCauseToIpmiRestartCause(State::Host::RestartCause cause) 1221 { 1222 switch (cause) 1223 { 1224 case State::Host::RestartCause::Unknown: 1225 { 1226 return IpmiRestartCause::Unknown; 1227 } 1228 case State::Host::RestartCause::RemoteCommand: 1229 { 1230 return IpmiRestartCause::RemoteCommand; 1231 } 1232 case State::Host::RestartCause::ResetButton: 1233 { 1234 return IpmiRestartCause::ResetButton; 1235 } 1236 case State::Host::RestartCause::PowerButton: 1237 { 1238 return IpmiRestartCause::PowerButton; 1239 } 1240 case State::Host::RestartCause::WatchdogTimer: 1241 { 1242 return IpmiRestartCause::WatchdogTimer; 1243 } 1244 case State::Host::RestartCause::PowerPolicyAlwaysOn: 1245 { 1246 return IpmiRestartCause::PowerPolicyAlwaysOn; 1247 } 1248 case State::Host::RestartCause::PowerPolicyPreviousState: 1249 { 1250 return IpmiRestartCause::PowerPolicyPreviousState; 1251 } 1252 case State::Host::RestartCause::SoftReset: 1253 { 1254 return IpmiRestartCause::SoftReset; 1255 } 1256 default: 1257 { 1258 return IpmiRestartCause::Unknown; 1259 } 1260 } 1261 } 1262 1263 /* 1264 * getRestartCause 1265 * helper function for Get Host restart cause Command 1266 * return - optional value for RestartCause (no value on error) 1267 */ 1268 static std::optional<uint4_t> getRestartCause(ipmi::Context::ptr ctx) 1269 { 1270 constexpr const char* restartCausePath = 1271 "/xyz/openbmc_project/control/host0/restart_cause"; 1272 constexpr const char* restartCauseIntf = 1273 "xyz.openbmc_project.Control.Host.RestartCause"; 1274 1275 std::string service; 1276 boost::system::error_code ec = 1277 ipmi::getService(ctx, restartCauseIntf, restartCausePath, service); 1278 if (!ec) 1279 { 1280 std::string restartCauseStr; 1281 ec = ipmi::getDbusProperty<std::string>( 1282 ctx, service, restartCausePath, restartCauseIntf, "RestartCause", 1283 restartCauseStr); 1284 if (!ec) 1285 { 1286 auto cause = 1287 State::Host::convertRestartCauseFromString(restartCauseStr); 1288 return types::enum_cast<uint4_t>( 1289 restartCauseToIpmiRestartCause(cause)); 1290 } 1291 } 1292 1293 log<level::ERR>("Failed to fetch RestartCause property", 1294 entry("ERROR=%s", ec.message().c_str()), 1295 entry("PATH=%s", restartCausePath), 1296 entry("INTERFACE=%s", restartCauseIntf)); 1297 return std::nullopt; 1298 } 1299 1300 ipmi::RspType<uint4_t, // Restart Cause 1301 uint4_t, // reserved 1302 uint8_t // channel number (not supported) 1303 > 1304 ipmiGetSystemRestartCause(ipmi::Context::ptr ctx) 1305 { 1306 std::optional<uint4_t> cause = getRestartCause(ctx); 1307 if (!cause) 1308 { 1309 return ipmi::responseUnspecifiedError(); 1310 } 1311 1312 constexpr uint4_t reserved = 0; 1313 auto channel = static_cast<uint8_t>(ctx->channel); 1314 return ipmi::responseSuccess(cause.value(), reserved, channel); 1315 } 1316 /** @brief Implementation of chassis control command 1317 * 1318 * @param - chassisControl command byte 1319 * 1320 * @return Success or InvalidFieldRequest. 1321 */ 1322 ipmi::RspType<> ipmiChassisControl(ipmi::Context::ptr& ctx, 1323 uint8_t chassisControl) 1324 { 1325 int rc = 0; 1326 switch (chassisControl) 1327 { 1328 case CMD_POWER_ON: 1329 rc = initiateHostStateTransition(ctx, State::Host::Transition::On); 1330 break; 1331 case CMD_POWER_OFF: 1332 rc = initiateChassisStateTransition( 1333 ctx, State::Chassis::Transition::Off); 1334 break; 1335 case CMD_HARD_RESET: 1336 rc = initiateHostStateTransition( 1337 ctx, State::Host::Transition::ForceWarmReboot); 1338 break; 1339 case CMD_POWER_CYCLE: 1340 rc = initiateHostStateTransition(ctx, 1341 State::Host::Transition::Reboot); 1342 break; 1343 case CMD_SOFT_OFF_VIA_OVER_TEMP: 1344 rc = initiateHostStateTransition(ctx, State::Host::Transition::Off); 1345 break; 1346 case CMD_PULSE_DIAGNOSTIC_INTR: 1347 rc = setNmiProperty(true); 1348 break; 1349 1350 default: 1351 { 1352 log<level::ERR>("Invalid Chassis Control command", 1353 entry("CMD=0x%X", chassisControl)); 1354 return ipmi::responseInvalidFieldRequest(); 1355 } 1356 } 1357 1358 return ((rc < 0) ? ipmi::responseUnspecifiedError() 1359 : ipmi::responseSuccess()); 1360 } 1361 1362 /** @brief Return D-Bus connection string to enclosure identify LED object 1363 * 1364 * @param[in, out] connection - connection to D-Bus object 1365 * @return a IPMI return code 1366 */ 1367 std::string getEnclosureIdentifyConnection() 1368 { 1369 // lookup enclosure_identify group owner(s) in mapper 1370 auto mapperCall = chassis::internal::dbus.new_method_call( 1371 ipmi::MAPPER_BUS_NAME, ipmi::MAPPER_OBJ, ipmi::MAPPER_INTF, 1372 "GetObject"); 1373 1374 mapperCall.append(identify_led_object_name); 1375 static const std::vector<std::string> interfaces = { 1376 "xyz.openbmc_project.Led.Group"}; 1377 mapperCall.append(interfaces); 1378 auto mapperReply = chassis::internal::dbus.call(mapperCall); 1379 if (mapperReply.is_method_error()) 1380 { 1381 log<level::ERR>("Chassis Identify: Error communicating to mapper."); 1382 elog<InternalFailure>(); 1383 } 1384 std::vector<std::pair<std::string, std::vector<std::string>>> mapperResp; 1385 mapperReply.read(mapperResp); 1386 1387 if (mapperResp.size() != encIdentifyObjectsSize) 1388 { 1389 log<level::ERR>( 1390 "Invalid number of enclosure identify objects.", 1391 entry("ENC_IDENTITY_OBJECTS_SIZE=%d", mapperResp.size())); 1392 elog<InternalFailure>(); 1393 } 1394 auto pair = mapperResp[encIdentifyObjectsSize - 1]; 1395 return pair.first; 1396 } 1397 1398 /** @brief Turn On/Off enclosure identify LED 1399 * 1400 * @param[in] flag - true to turn on LED, false to turn off 1401 * @return a IPMI return code 1402 */ 1403 void enclosureIdentifyLed(bool flag) 1404 { 1405 using namespace chassis::internal; 1406 std::string connection = std::move(getEnclosureIdentifyConnection()); 1407 auto msg = std::string("enclosureIdentifyLed(") + 1408 boost::lexical_cast<std::string>(flag) + ")"; 1409 log<level::DEBUG>(msg.c_str()); 1410 auto led = 1411 dbus.new_method_call(connection.c_str(), identify_led_object_name, 1412 "org.freedesktop.DBus.Properties", "Set"); 1413 led.append("xyz.openbmc_project.Led.Group", "Asserted", 1414 std::variant<bool>(flag)); 1415 auto ledReply = dbus.call(led); 1416 if (ledReply.is_method_error()) 1417 { 1418 log<level::ERR>("Chassis Identify: Error Setting State On/Off\n", 1419 entry("LED_STATE=%d", flag)); 1420 elog<InternalFailure>(); 1421 } 1422 } 1423 1424 /** @brief Callback method to turn off LED 1425 */ 1426 void enclosureIdentifyLedOff() 1427 { 1428 try 1429 { 1430 chassisIDState = ChassisIDState::off; 1431 enclosureIdentifyLed(false); 1432 } 1433 catch (const InternalFailure& e) 1434 { 1435 report<InternalFailure>(); 1436 } 1437 } 1438 1439 /** @brief Create timer to turn on and off the enclosure LED 1440 */ 1441 void createIdentifyTimer() 1442 { 1443 if (!identifyTimer) 1444 { 1445 identifyTimer = 1446 std::make_unique<phosphor::Timer>(enclosureIdentifyLedOff); 1447 } 1448 } 1449 1450 ipmi::RspType<> ipmiChassisIdentify(std::optional<uint8_t> interval, 1451 std::optional<uint8_t> force) 1452 { 1453 uint8_t identifyInterval = interval.value_or(DEFAULT_IDENTIFY_TIME_OUT); 1454 bool forceIdentify = force.value_or(0) & 0x01; 1455 1456 if (identifyInterval || forceIdentify) 1457 { 1458 // stop the timer if already started; 1459 // for force identify we should not turn off LED 1460 identifyTimer->stop(); 1461 try 1462 { 1463 chassisIDState = ChassisIDState::temporaryOn; 1464 enclosureIdentifyLed(true); 1465 } 1466 catch (const InternalFailure& e) 1467 { 1468 report<InternalFailure>(); 1469 return ipmi::responseResponseError(); 1470 } 1471 1472 if (forceIdentify) 1473 { 1474 chassisIDState = ChassisIDState::indefiniteOn; 1475 return ipmi::responseSuccess(); 1476 } 1477 // start the timer 1478 auto time = std::chrono::duration_cast<std::chrono::microseconds>( 1479 std::chrono::seconds(identifyInterval)); 1480 identifyTimer->start(time); 1481 } 1482 else if (!identifyInterval) 1483 { 1484 identifyTimer->stop(); 1485 enclosureIdentifyLedOff(); 1486 } 1487 return ipmi::responseSuccess(); 1488 } 1489 1490 namespace boot_options 1491 { 1492 1493 using namespace sdbusplus::xyz::openbmc_project::Control::Boot::server; 1494 using IpmiValue = uint8_t; 1495 constexpr auto ipmiDefault = 0; 1496 1497 std::map<IpmiValue, Type::Types> typeIpmiToDbus = {{0x00, Type::Types::Legacy}, 1498 {0x01, Type::Types::EFI}}; 1499 1500 std::map<IpmiValue, Source::Sources> sourceIpmiToDbus = { 1501 {0x01, Source::Sources::Network}, 1502 {0x02, Source::Sources::Disk}, 1503 {0x05, Source::Sources::ExternalMedia}, 1504 {0x0f, Source::Sources::RemovableMedia}, 1505 {ipmiDefault, Source::Sources::Default}}; 1506 1507 std::map<IpmiValue, Mode::Modes> modeIpmiToDbus = { 1508 #ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT 1509 {0x03, Mode::Modes::Safe}, 1510 #endif // ENABLE_BOOT_SAFE_MODE_SUPPORT 1511 {0x06, Mode::Modes::Setup}, 1512 {ipmiDefault, Mode::Modes::Regular}}; 1513 1514 std::map<Type::Types, IpmiValue> typeDbusToIpmi = {{Type::Types::Legacy, 0x00}, 1515 {Type::Types::EFI, 0x01}}; 1516 1517 std::map<Source::Sources, IpmiValue> sourceDbusToIpmi = { 1518 {Source::Sources::Network, 0x01}, 1519 {Source::Sources::Disk, 0x02}, 1520 {Source::Sources::ExternalMedia, 0x05}, 1521 {Source::Sources::RemovableMedia, 0x0f}, 1522 {Source::Sources::Default, ipmiDefault}}; 1523 1524 std::map<Mode::Modes, IpmiValue> modeDbusToIpmi = { 1525 #ifdef ENABLE_BOOT_FLAG_SAFE_MODE_SUPPORT 1526 {Mode::Modes::Safe, 0x03}, 1527 #endif // ENABLE_BOOT_SAFE_MODE_SUPPORT 1528 {Mode::Modes::Setup, 0x06}, 1529 {Mode::Modes::Regular, ipmiDefault}}; 1530 1531 } // namespace boot_options 1532 1533 /** @brief Get the property value for boot source 1534 * @param[in] ctx - context pointer 1535 * @param[out] source - boot source value 1536 * @return On failure return IPMI error. 1537 */ 1538 static ipmi::Cc getBootSource(ipmi::Context::ptr& ctx, Source::Sources& source) 1539 { 1540 using namespace chassis::internal; 1541 std::string result; 1542 std::string service; 1543 boost::system::error_code ec = 1544 getService(ctx, bootSourceIntf, bootSettingsPath, service); 1545 if (!ec) 1546 { 1547 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, 1548 bootSourceIntf, "BootSource", result); 1549 if (!ec) 1550 { 1551 source = Source::convertSourcesFromString(result); 1552 return ipmi::ccSuccess; 1553 } 1554 } 1555 log<level::ERR>("Error in BootSource Get", 1556 entry("ERROR=%s", ec.message().c_str())); 1557 return ipmi::ccUnspecifiedError; 1558 } 1559 1560 /** @brief Set the property value for boot source 1561 * @param[in] ctx - context pointer 1562 * @param[in] source - boot source value 1563 * @return On failure return IPMI error. 1564 */ 1565 static ipmi::Cc setBootSource(ipmi::Context::ptr& ctx, 1566 const Source::Sources& source) 1567 { 1568 using namespace chassis::internal; 1569 std::string service; 1570 boost::system::error_code ec = 1571 getService(ctx, bootSourceIntf, bootSettingsPath, service); 1572 if (!ec) 1573 { 1574 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, 1575 bootSourceIntf, "BootSource", 1576 convertForMessage(source)); 1577 if (!ec) 1578 { 1579 return ipmi::ccSuccess; 1580 } 1581 } 1582 log<level::ERR>("Error in BootSource Set", 1583 entry("ERROR=%s", ec.message().c_str())); 1584 return ipmi::ccUnspecifiedError; 1585 } 1586 1587 /** @brief Get the property value for boot mode 1588 * @param[in] ctx - context pointer 1589 * @param[out] mode - boot mode value 1590 * @return On failure return IPMI error. 1591 */ 1592 static ipmi::Cc getBootMode(ipmi::Context::ptr& ctx, Mode::Modes& mode) 1593 { 1594 using namespace chassis::internal; 1595 std::string result; 1596 std::string service; 1597 boost::system::error_code ec = 1598 getService(ctx, bootModeIntf, bootSettingsPath, service); 1599 if (!ec) 1600 { 1601 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootModeIntf, 1602 "BootMode", result); 1603 if (!ec) 1604 { 1605 mode = Mode::convertModesFromString(result); 1606 return ipmi::ccSuccess; 1607 } 1608 } 1609 log<level::ERR>("Error in BootMode Get", 1610 entry("ERROR=%s", ec.message().c_str())); 1611 return ipmi::ccUnspecifiedError; 1612 } 1613 1614 /** @brief Set the property value for boot mode 1615 * @param[in] ctx - context pointer 1616 * @param[in] mode - boot mode value 1617 * @return On failure return IPMI error. 1618 */ 1619 static ipmi::Cc setBootMode(ipmi::Context::ptr& ctx, const Mode::Modes& mode) 1620 { 1621 using namespace chassis::internal; 1622 std::string service; 1623 boost::system::error_code ec = 1624 getService(ctx, bootModeIntf, bootSettingsPath, service); 1625 if (!ec) 1626 { 1627 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootModeIntf, 1628 "BootMode", convertForMessage(mode)); 1629 if (!ec) 1630 { 1631 return ipmi::ccSuccess; 1632 } 1633 } 1634 log<level::ERR>("Error in BootMode Set", 1635 entry("ERROR=%s", ec.message().c_str())); 1636 return ipmi::ccUnspecifiedError; 1637 } 1638 1639 /** @brief Get the property value for boot type 1640 * @param[in] ctx - context pointer 1641 * @param[out] type - boot type value 1642 * @return On failure return IPMI error. 1643 */ 1644 static ipmi::Cc getBootType(ipmi::Context::ptr& ctx, Type::Types& type) 1645 { 1646 using namespace chassis::internal; 1647 std::string result; 1648 std::string service; 1649 boost::system::error_code ec = 1650 getService(ctx, bootTypeIntf, bootSettingsPath, service); 1651 1652 // Don't throw error if BootType interface is not present. 1653 // This interface is not relevant for some Host architectures 1654 // (for example POWER). In this case we don't won't IPMI to 1655 // return an error, but simply return bootType as EFI. 1656 type = Type::Types::EFI; 1657 if (!ec) 1658 { 1659 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf, 1660 "BootType", result); 1661 if (ec) 1662 { 1663 log<level::ERR>("Error in BootType Get", 1664 entry("ERROR=%s", ec.message().c_str())); 1665 return ipmi::ccUnspecifiedError; 1666 } 1667 type = Type::convertTypesFromString(result); 1668 } 1669 1670 return ipmi::ccSuccess; 1671 } 1672 1673 /** @brief Set the property value for boot type 1674 * @param[in] ctx - context pointer 1675 * @param[in] type - boot type value 1676 * @return On failure return IPMI error. 1677 */ 1678 static ipmi::Cc setBootType(ipmi::Context::ptr& ctx, const Type::Types& type) 1679 { 1680 using namespace chassis::internal; 1681 std::string service; 1682 boost::system::error_code ec = 1683 getService(ctx, bootTypeIntf, bootSettingsPath, service); 1684 if (!ec) 1685 { 1686 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, bootTypeIntf, 1687 "BootType", convertForMessage(type)); 1688 if (ec) 1689 { 1690 log<level::ERR>("Error in BootType Set", 1691 entry("ERROR=%s", ec.message().c_str())); 1692 return ipmi::ccUnspecifiedError; 1693 } 1694 } 1695 // Don't throw error if BootType interface is not present. 1696 // This interface is not relevant for some Host architectures 1697 // (for example POWER). In this case we don't won't IPMI to 1698 // return an error, but want to just skip this function. 1699 return ipmi::ccSuccess; 1700 } 1701 1702 /** @brief Get the property value for boot override enable 1703 * @param[in] ctx - context pointer 1704 * @param[out] enable - boot override enable 1705 * @return On failure return IPMI error. 1706 */ 1707 static ipmi::Cc getBootEnable(ipmi::Context::ptr& ctx, bool& enable) 1708 { 1709 using namespace chassis::internal; 1710 std::string result; 1711 std::string service; 1712 boost::system::error_code ec = 1713 getService(ctx, bootEnableIntf, bootSettingsPath, service); 1714 if (!ec) 1715 { 1716 ec = ipmi::getDbusProperty(ctx, service, bootSettingsPath, 1717 bootEnableIntf, "Enabled", enable); 1718 if (!ec) 1719 { 1720 return ipmi::ccSuccess; 1721 } 1722 } 1723 log<level::ERR>("Error in Boot Override Enable Get", 1724 entry("ERROR=%s", ec.message().c_str())); 1725 return ipmi::ccUnspecifiedError; 1726 } 1727 1728 /** @brief Set the property value for boot override enable 1729 * @param[in] ctx - context pointer 1730 * @param[in] enable - boot override enable 1731 * @return On failure return IPMI error. 1732 */ 1733 static ipmi::Cc setBootEnable(ipmi::Context::ptr& ctx, const bool& enable) 1734 { 1735 using namespace chassis::internal; 1736 std::string service; 1737 boost::system::error_code ec = 1738 getService(ctx, bootEnableIntf, bootSettingsPath, service); 1739 if (!ec) 1740 { 1741 ec = ipmi::setDbusProperty(ctx, service, bootSettingsPath, 1742 bootEnableIntf, "Enabled", enable); 1743 if (!ec) 1744 { 1745 return ipmi::ccSuccess; 1746 } 1747 } 1748 log<level::ERR>("Error in Boot Source Override Enable Set", 1749 entry("ERROR=%s", ec.message().c_str())); 1750 return ipmi::ccUnspecifiedError; 1751 } 1752 1753 /** @brief Get the property value for boot override one-time 1754 * @param[in] ctx - context pointer 1755 * @param[out] onetime - boot override one-time 1756 * @return On failure return IPMI error. 1757 */ 1758 static ipmi::Cc getBootOneTime(ipmi::Context::ptr& ctx, bool& onetime) 1759 { 1760 using namespace chassis::internal; 1761 std::string result; 1762 std::string service; 1763 boost::system::error_code ec = 1764 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service); 1765 if (!ec) 1766 { 1767 ec = ipmi::getDbusProperty(ctx, service, bootSettingsOneTimePath, 1768 bootOneTimeIntf, "Enabled", onetime); 1769 if (!ec) 1770 { 1771 return ipmi::ccSuccess; 1772 } 1773 } 1774 log<level::ERR>("Error in Boot Override OneTime Get", 1775 entry("ERROR=%s", ec.message().c_str())); 1776 return ipmi::ccUnspecifiedError; 1777 } 1778 1779 /** @brief Set the property value for boot override one-time 1780 * @param[in] ctx - context pointer 1781 * @param[in] onetime - boot override one-time 1782 * @return On failure return IPMI error. 1783 */ 1784 static ipmi::Cc setBootOneTime(ipmi::Context::ptr& ctx, const bool& onetime) 1785 { 1786 using namespace chassis::internal; 1787 std::string service; 1788 boost::system::error_code ec = 1789 getService(ctx, bootOneTimeIntf, bootSettingsOneTimePath, service); 1790 if (!ec) 1791 { 1792 ec = ipmi::setDbusProperty(ctx, service, bootSettingsOneTimePath, 1793 bootOneTimeIntf, "Enabled", onetime); 1794 if (!ec) 1795 { 1796 return ipmi::ccSuccess; 1797 } 1798 } 1799 log<level::ERR>("Error in Boot Source Override OneTime Set", 1800 entry("ERROR=%s", ec.message().c_str())); 1801 return ipmi::ccUnspecifiedError; 1802 } 1803 1804 static constexpr uint8_t setComplete = 0x0; 1805 static constexpr uint8_t setInProgress = 0x1; 1806 static uint8_t transferStatus = setComplete; 1807 static uint8_t bootFlagValidBitClr = 0; 1808 static uint5_t bootInitiatorAckData = 0x0; 1809 static bool cmosClear = false; 1810 1811 /** @brief implements the Get Chassis system boot option 1812 * @param ctx - context pointer 1813 * @param bootOptionParameter - boot option parameter selector 1814 * @param reserved1 - reserved bit 1815 * @param setSelector - selects a particular block or set of parameters 1816 * under the given parameter selector 1817 * write as 00h if parameter doesn't use a setSelector 1818 * @param blockSelector- selects a particular block within a set of 1819 * parameters write as 00h if parameter doesn't use a 1820 * blockSelector 1821 * 1822 * @return IPMI completion code plus response data 1823 * @return Payload contains below parameters: 1824 * version - parameter version 1825 * bootOptionParameter - boot option parameter selector 1826 * parmIndicator - parameter valid/invalid indicator 1827 * data - configuration parameter data 1828 */ 1829 ipmi::RspType<ipmi::message::Payload> 1830 ipmiChassisGetSysBootOptions(ipmi::Context::ptr ctx, 1831 uint7_t bootOptionParameter, bool reserved1, 1832 1833 uint8_t setSelector, uint8_t blockSelector) 1834 { 1835 ipmi::Cc rc; 1836 if (reserved1) 1837 { 1838 return ipmi::responseInvalidFieldRequest(); 1839 } 1840 1841 constexpr uint4_t version = 0x01; 1842 ipmi::message::Payload response; 1843 response.pack(version, uint4_t{}); 1844 using namespace boot_options; 1845 1846 IpmiValue bootOption = ipmiDefault; 1847 1848 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) == 1849 BootOptionParameter::setInProgress) 1850 { 1851 response.pack(bootOptionParameter, reserved1, transferStatus); 1852 return ipmi::responseSuccess(std::move(response)); 1853 } 1854 1855 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) == 1856 BootOptionParameter::bootInfo) 1857 { 1858 constexpr uint8_t writeMask = 0; 1859 response.pack(bootOptionParameter, reserved1, writeMask, 1860 bootInitiatorAckData); 1861 return ipmi::responseSuccess(std::move(response)); 1862 } 1863 1864 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) == 1865 BootOptionParameter::bootFlagValidClr) 1866 { 1867 response.pack(bootOptionParameter, reserved1, 1868 uint5_t{bootFlagValidBitClr}, uint3_t{}); 1869 return ipmi::responseSuccess(std::move(response)); 1870 } 1871 1872 /* 1873 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc. 1874 * This is the only parameter used by petitboot. 1875 */ 1876 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) == 1877 BootOptionParameter::bootFlags) 1878 { 1879 using namespace chassis::internal; 1880 using namespace chassis::internal::cache; 1881 1882 try 1883 { 1884 Source::Sources bootSource; 1885 rc = getBootSource(ctx, bootSource); 1886 if (rc != ipmi::ccSuccess) 1887 { 1888 return ipmi::response(rc); 1889 } 1890 1891 Type::Types bootType; 1892 rc = getBootType(ctx, bootType); 1893 if (rc != ipmi::ccSuccess) 1894 { 1895 return ipmi::response(rc); 1896 } 1897 1898 Mode::Modes bootMode; 1899 rc = getBootMode(ctx, bootMode); 1900 if (rc != ipmi::ccSuccess) 1901 { 1902 return ipmi::response(rc); 1903 } 1904 1905 bootOption = sourceDbusToIpmi.at(bootSource); 1906 if ((Mode::Modes::Regular == bootMode) && 1907 (Source::Sources::Default == bootSource)) 1908 { 1909 bootOption = ipmiDefault; 1910 } 1911 else if (Source::Sources::Default == bootSource) 1912 { 1913 bootOption = modeDbusToIpmi.at(bootMode); 1914 } 1915 1916 IpmiValue biosBootType = typeDbusToIpmi.at(bootType); 1917 1918 bool oneTimeEnabled; 1919 rc = getBootOneTime(ctx, oneTimeEnabled); 1920 if (rc != ipmi::ccSuccess) 1921 { 1922 return ipmi::response(rc); 1923 } 1924 1925 uint1_t permanent = oneTimeEnabled ? 0 : 1; 1926 1927 bool valid; 1928 rc = getBootEnable(ctx, valid); 1929 if (rc != ipmi::ccSuccess) 1930 { 1931 return ipmi::response(rc); 1932 } 1933 1934 uint1_t validFlag = valid ? 1 : 0; 1935 1936 response.pack(bootOptionParameter, reserved1, uint5_t{}, 1937 uint1_t{biosBootType}, uint1_t{permanent}, 1938 uint1_t{validFlag}, uint2_t{}, uint4_t{bootOption}, 1939 uint1_t{}, cmosClear, uint8_t{}, uint8_t{}, 1940 uint8_t{}); 1941 return ipmi::responseSuccess(std::move(response)); 1942 } 1943 catch (const InternalFailure& e) 1944 { 1945 cache::objectsPtr.reset(); 1946 report<InternalFailure>(); 1947 return ipmi::responseUnspecifiedError(); 1948 } 1949 } 1950 else 1951 { 1952 if ((bootOptionParameter >= oemParmStart) && 1953 (bootOptionParameter <= oemParmEnd)) 1954 { 1955 if (types::enum_cast<BootOptionParameter>(bootOptionParameter) == 1956 BootOptionParameter::opalNetworkSettings) 1957 { 1958 response.pack(bootOptionParameter, reserved1); 1959 int ret = getHostNetworkData(response); 1960 if (ret < 0) 1961 { 1962 response.trailingOk = true; 1963 log<level::ERR>( 1964 "getHostNetworkData failed for GetSysBootOptions."); 1965 return ipmi::responseUnspecifiedError(); 1966 } 1967 else 1968 { 1969 return ipmi::responseSuccess(std::move(response)); 1970 } 1971 } 1972 else 1973 { 1974 log<level::ERR>( 1975 "ipmiChassisGetSysBootOptions: Unsupported parameter", 1976 entry("PARAM=0x%x", 1977 static_cast<uint8_t>(bootOptionParameter))); 1978 return ipmi::responseParmNotSupported(); 1979 } 1980 } 1981 else 1982 { 1983 log<level::ERR>( 1984 "ipmiChassisGetSysBootOptions: Unsupported parameter", 1985 entry("PARAM=0x%x", static_cast<uint8_t>(bootOptionParameter))); 1986 return ipmi::responseParmNotSupported(); 1987 } 1988 } 1989 return ipmi::responseUnspecifiedError(); 1990 } 1991 1992 ipmi::RspType<> ipmiChassisSetSysBootOptions(ipmi::Context::ptr ctx, 1993 uint7_t parameterSelector, 1994 bool parameterIsValid, 1995 ipmi::message::Payload& data) 1996 { 1997 using namespace boot_options; 1998 ipmi::Cc rc; 1999 2000 if (types::enum_cast<BootOptionParameter>(parameterSelector) == 2001 BootOptionParameter::setInProgress) 2002 { 2003 uint2_t setInProgressFlag; 2004 uint6_t rsvd; 2005 if (data.unpack(setInProgressFlag, rsvd) != 0 || !data.fullyUnpacked()) 2006 { 2007 return ipmi::responseReqDataLenInvalid(); 2008 } 2009 if (rsvd) 2010 { 2011 return ipmi::responseInvalidFieldRequest(); 2012 } 2013 if ((transferStatus == setInProgress) && 2014 (static_cast<uint8_t>(setInProgressFlag) != setComplete)) 2015 { 2016 return ipmi::response(IPMI_CC_FAIL_SET_IN_PROGRESS); 2017 } 2018 transferStatus = static_cast<uint8_t>(setInProgressFlag); 2019 return ipmi::responseSuccess(); 2020 } 2021 2022 /* 000101 2023 * Parameter #5 means boot flags. Please refer to 28.13 of ipmi doc. 2024 * This is the only parameter used by petitboot. 2025 */ 2026 2027 if (types::enum_cast<BootOptionParameter>(parameterSelector) == 2028 BootOptionParameter::bootFlags) 2029 { 2030 uint5_t rsvd; 2031 bool validFlag; 2032 bool permanent; 2033 bool biosBootType; 2034 bool lockOutResetButton; 2035 bool screenBlank; 2036 uint4_t bootDeviceSelector; 2037 bool lockKeyboard; 2038 uint8_t data3; 2039 uint4_t biosInfo; 2040 uint4_t rsvd1; 2041 uint5_t deviceInstance; 2042 uint3_t rsvd2; 2043 2044 if (data.unpack(rsvd, biosBootType, permanent, validFlag, 2045 lockOutResetButton, screenBlank, bootDeviceSelector, 2046 lockKeyboard, cmosClear, data3, biosInfo, rsvd1, 2047 deviceInstance, rsvd2) != 0 || 2048 !data.fullyUnpacked()) 2049 { 2050 return ipmi::responseReqDataLenInvalid(); 2051 } 2052 if (rsvd || rsvd1 || rsvd2) 2053 { 2054 return ipmi::responseInvalidFieldRequest(); 2055 } 2056 2057 using namespace chassis::internal; 2058 using namespace chassis::internal::cache; 2059 2060 try 2061 { 2062 rc = setBootOneTime(ctx, !permanent); 2063 if (rc != ipmi::ccSuccess) 2064 { 2065 return ipmi::response(rc); 2066 } 2067 2068 rc = setBootEnable(ctx, validFlag); 2069 if (rc != ipmi::ccSuccess) 2070 { 2071 return ipmi::response(rc); 2072 } 2073 2074 auto modeItr = 2075 modeIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector)); 2076 auto typeItr = 2077 typeIpmiToDbus.find(static_cast<uint8_t>(biosBootType)); 2078 auto sourceItr = 2079 sourceIpmiToDbus.find(static_cast<uint8_t>(bootDeviceSelector)); 2080 if (sourceIpmiToDbus.end() != sourceItr) 2081 { 2082 rc = setBootSource(ctx, sourceItr->second); 2083 if (rc != ipmi::ccSuccess) 2084 { 2085 return ipmi::response(rc); 2086 } 2087 // If a set boot device is mapping to a boot source, then reset 2088 // the boot mode D-Bus property to default. 2089 // This way the ipmid code can determine which property is not 2090 // at the default value 2091 if (sourceItr->second != Source::Sources::Default) 2092 { 2093 rc = setBootMode(ctx, Mode::Modes::Regular); 2094 if (rc != ipmi::ccSuccess) 2095 { 2096 return ipmi::response(rc); 2097 } 2098 } 2099 } 2100 2101 if (typeIpmiToDbus.end() != typeItr) 2102 { 2103 rc = setBootType(ctx, typeItr->second); 2104 if (rc != ipmi::ccSuccess) 2105 { 2106 return ipmi::response(rc); 2107 } 2108 } 2109 2110 if (modeIpmiToDbus.end() != modeItr) 2111 { 2112 rc = setBootMode(ctx, modeItr->second); 2113 if (rc != ipmi::ccSuccess) 2114 { 2115 return ipmi::response(rc); 2116 } 2117 // If a set boot device is mapping to a boot mode, then reset 2118 // the boot source D-Bus property to default. 2119 // This way the ipmid code can determine which property is not 2120 // at the default value 2121 if (modeItr->second != Mode::Modes::Regular) 2122 { 2123 rc = setBootSource(ctx, Source::Sources::Default); 2124 if (rc != ipmi::ccSuccess) 2125 { 2126 return ipmi::response(rc); 2127 } 2128 } 2129 } 2130 if ((modeIpmiToDbus.end() == modeItr) && 2131 (typeIpmiToDbus.end() == typeItr) && 2132 (sourceIpmiToDbus.end() == sourceItr)) 2133 { 2134 // return error if boot option is not supported 2135 log<level::ERR>( 2136 "ipmiChassisSetSysBootOptions: Boot option not supported"); 2137 return ipmi::responseInvalidFieldRequest(); 2138 } 2139 } 2140 catch (const sdbusplus::exception_t& e) 2141 { 2142 objectsPtr.reset(); 2143 report<InternalFailure>(); 2144 log<level::ERR>( 2145 "ipmiChassisSetSysBootOptions: Error in setting Boot " 2146 "flag parameters"); 2147 return ipmi::responseUnspecifiedError(); 2148 } 2149 } 2150 else if (types::enum_cast<BootOptionParameter>(parameterSelector) == 2151 BootOptionParameter::bootInfo) 2152 { 2153 uint8_t writeMak; 2154 uint5_t bootInfoAck; 2155 uint3_t rsvd; 2156 2157 if (data.unpack(writeMak, bootInfoAck, rsvd) != 0 || 2158 !data.fullyUnpacked()) 2159 { 2160 return ipmi::responseReqDataLenInvalid(); 2161 } 2162 if (rsvd) 2163 { 2164 return ipmi::responseInvalidFieldRequest(); 2165 } 2166 bootInitiatorAckData &= ~writeMak; 2167 bootInitiatorAckData |= (writeMak & bootInfoAck); 2168 log<level::INFO>("ipmiChassisSetSysBootOptions: bootInfo parameter set " 2169 "successfully"); 2170 data.trailingOk = true; 2171 return ipmi::responseSuccess(); 2172 } 2173 else if (types::enum_cast<BootOptionParameter>(parameterSelector) == 2174 BootOptionParameter::bootFlagValidClr) 2175 { 2176 uint5_t bootFlagValidClr; 2177 uint3_t rsvd; 2178 2179 if (data.unpack(bootFlagValidClr, rsvd) != 0 || !data.fullyUnpacked()) 2180 { 2181 return ipmi::responseReqDataLenInvalid(); 2182 } 2183 if (rsvd) 2184 { 2185 return ipmi::responseInvalidFieldRequest(); 2186 } 2187 // store boot flag valid bits clear value 2188 bootFlagValidBitClr = static_cast<uint8_t>(bootFlagValidClr); 2189 log<level::INFO>( 2190 "ipmiChassisSetSysBootOptions: bootFlagValidBits parameter set " 2191 "successfully", 2192 entry("value=0x%x", bootFlagValidBitClr)); 2193 return ipmi::responseSuccess(); 2194 } 2195 else 2196 { 2197 if ((parameterSelector >= static_cast<uint7_t>(oemParmStart)) && 2198 (parameterSelector <= static_cast<uint7_t>(oemParmEnd))) 2199 { 2200 if (types::enum_cast<BootOptionParameter>(parameterSelector) == 2201 BootOptionParameter::opalNetworkSettings) 2202 { 2203 ipmi::Cc ret = setHostNetworkData(data); 2204 if (ret != ipmi::ccSuccess) 2205 { 2206 log<level::ERR>("ipmiChassisSetSysBootOptions: Error in " 2207 "setHostNetworkData"); 2208 data.trailingOk = true; 2209 return ipmi::response(ret); 2210 } 2211 data.trailingOk = true; 2212 return ipmi::responseSuccess(); 2213 } 2214 else 2215 { 2216 log<level::ERR>( 2217 "ipmiChassisSetSysBootOptions: Unsupported parameters", 2218 entry("PARAM=0x%x", 2219 static_cast<uint8_t>(parameterSelector))); 2220 data.trailingOk = true; 2221 return ipmi::responseParmNotSupported(); 2222 } 2223 } 2224 data.trailingOk = true; 2225 return ipmi::responseParmNotSupported(); 2226 } 2227 return ipmi::responseSuccess(); 2228 } 2229 2230 /** @brief implements Get POH counter command 2231 * @parameter 2232 * - none 2233 * @returns IPMI completion code plus response data 2234 * - minPerCount - Minutes per count 2235 * - counterReading - counter reading 2236 */ 2237 ipmi::RspType<uint8_t, // Minutes per count 2238 uint32_t // Counter reading 2239 > 2240 ipmiGetPOHCounter() 2241 { 2242 // sd_bus error 2243 try 2244 { 2245 return ipmi::responseSuccess(static_cast<uint8_t>(poh::minutesPerCount), 2246 getPOHCounter()); 2247 } 2248 catch (const std::exception& e) 2249 { 2250 log<level::ERR>(e.what()); 2251 return ipmi::responseUnspecifiedError(); 2252 } 2253 } 2254 2255 ipmi::RspType<uint3_t, // policy support 2256 uint5_t // reserved 2257 > 2258 ipmiChassisSetPowerRestorePolicy(boost::asio::yield_context yield, 2259 uint3_t policy, uint5_t reserved) 2260 { 2261 power_policy::DbusValue value = 2262 power_policy::RestorePolicy::Policy::AlwaysOff; 2263 2264 if (reserved || (policy > power_policy::noChange)) 2265 { 2266 phosphor::logging::log<level::ERR>( 2267 "Reserved request parameter", 2268 entry("REQ=0x%x", static_cast<int>(policy))); 2269 return ipmi::responseInvalidFieldRequest(); 2270 } 2271 2272 if (policy == power_policy::noChange) 2273 { 2274 // just return the supported policy 2275 return ipmi::responseSuccess(power_policy::allSupport, reserved); 2276 } 2277 2278 for (auto const& it : power_policy::dbusToIpmi) 2279 { 2280 if (it.second == policy) 2281 { 2282 value = it.first; 2283 break; 2284 } 2285 } 2286 2287 try 2288 { 2289 settings::Objects& objects = chassis::internal::cache::getObjects(); 2290 const settings::Path& powerRestoreSetting = 2291 objects.map.at(chassis::internal::powerRestoreIntf).front(); 2292 std::variant<std::string> property = convertForMessage(value); 2293 2294 auto sdbusp = getSdBus(); 2295 boost::system::error_code ec; 2296 sdbusp->yield_method_call<void>( 2297 yield, ec, 2298 objects 2299 .service(powerRestoreSetting, 2300 chassis::internal::powerRestoreIntf) 2301 .c_str(), 2302 powerRestoreSetting, ipmi::PROP_INTF, "Set", 2303 chassis::internal::powerRestoreIntf, "PowerRestorePolicy", 2304 property); 2305 if (ec) 2306 { 2307 phosphor::logging::log<level::ERR>("Unspecified Error"); 2308 return ipmi::responseUnspecifiedError(); 2309 } 2310 } 2311 catch (const InternalFailure& e) 2312 { 2313 chassis::internal::cache::objectsPtr.reset(); 2314 report<InternalFailure>(); 2315 return ipmi::responseUnspecifiedError(); 2316 } 2317 2318 return ipmi::responseSuccess(power_policy::allSupport, reserved); 2319 } 2320 2321 ipmi::RspType<> ipmiSetFrontPanelButtonEnables( 2322 ipmi::Context::ptr ctx, bool disablePowerButton, bool disableResetButton, 2323 bool disableDiagButton, bool disableSleepButton, uint4_t reserved) 2324 { 2325 using namespace chassis::internal; 2326 2327 // set power button Enabled property 2328 bool success = setButtonEnabled(ctx, powerButtonPath, powerButtonIntf, 2329 !disablePowerButton); 2330 2331 // set reset button Enabled property 2332 success &= setButtonEnabled(ctx, resetButtonPath, resetButtonIntf, 2333 !disableResetButton); 2334 2335 if (!success) 2336 { 2337 // not all buttons were successfully set 2338 return ipmi::responseUnspecifiedError(); 2339 } 2340 return ipmi::responseSuccess(); 2341 } 2342 2343 void register_netfn_chassis_functions() 2344 { 2345 createIdentifyTimer(); 2346 2347 // Get Chassis Capabilities 2348 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2349 ipmi::chassis::cmdGetChassisCapabilities, 2350 ipmi::Privilege::User, ipmiGetChassisCap); 2351 2352 // Set Front Panel Button Enables 2353 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2354 ipmi::chassis::cmdSetFrontPanelButtonEnables, 2355 ipmi::Privilege::Admin, 2356 ipmiSetFrontPanelButtonEnables); 2357 2358 // Set Chassis Capabilities 2359 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2360 ipmi::chassis::cmdSetChassisCapabilities, 2361 ipmi::Privilege::User, ipmiSetChassisCap); 2362 2363 // <Get System Boot Options> 2364 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2365 ipmi::chassis::cmdGetSystemBootOptions, 2366 ipmi::Privilege::Operator, 2367 ipmiChassisGetSysBootOptions); 2368 2369 // <Get Chassis Status> 2370 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2371 ipmi::chassis::cmdGetChassisStatus, 2372 ipmi::Privilege::User, ipmiGetChassisStatus); 2373 2374 // <Chassis Get System Restart Cause> 2375 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2376 ipmi::chassis::cmdGetSystemRestartCause, 2377 ipmi::Privilege::User, ipmiGetSystemRestartCause); 2378 2379 // <Chassis Control> 2380 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2381 ipmi::chassis::cmdChassisControl, 2382 ipmi::Privilege::Operator, ipmiChassisControl); 2383 2384 // <Chassis Identify> 2385 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2386 ipmi::chassis::cmdChassisIdentify, 2387 ipmi::Privilege::Operator, ipmiChassisIdentify); 2388 2389 // <Set System Boot Options> 2390 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2391 ipmi::chassis::cmdSetSystemBootOptions, 2392 ipmi::Privilege::Operator, 2393 ipmiChassisSetSysBootOptions); 2394 2395 // <Get POH Counter> 2396 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2397 ipmi::chassis::cmdGetPohCounter, 2398 ipmi::Privilege::User, ipmiGetPOHCounter); 2399 2400 // <Set Power Restore Policy> 2401 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnChassis, 2402 ipmi::chassis::cmdSetPowerRestorePolicy, 2403 ipmi::Privilege::Operator, 2404 ipmiChassisSetPowerRestorePolicy); 2405 } 2406