1 #include "config.h" 2 3 #include <arpa/inet.h> 4 #include <fcntl.h> 5 #include <limits.h> 6 #include <linux/i2c-dev.h> 7 #include <linux/i2c.h> 8 #include <mapper.h> 9 #include <sys/ioctl.h> 10 #include <sys/stat.h> 11 #include <sys/types.h> 12 #include <systemd/sd-bus.h> 13 #include <unistd.h> 14 15 #include <app/channel.hpp> 16 #include <app/watchdog.hpp> 17 #include <apphandler.hpp> 18 #include <ipmid/api.hpp> 19 #include <ipmid/sessiondef.hpp> 20 #include <ipmid/sessionhelper.hpp> 21 #include <ipmid/types.hpp> 22 #include <ipmid/utils.hpp> 23 #include <nlohmann/json.hpp> 24 #include <phosphor-logging/elog-errors.hpp> 25 #include <phosphor-logging/log.hpp> 26 #include <sdbusplus/message/types.hpp> 27 #include <sys_info_param.hpp> 28 #include <xyz/openbmc_project/Common/error.hpp> 29 #include <xyz/openbmc_project/Control/Power/ACPIPowerState/server.hpp> 30 #include <xyz/openbmc_project/Software/Activation/server.hpp> 31 #include <xyz/openbmc_project/Software/Version/server.hpp> 32 #include <xyz/openbmc_project/State/BMC/server.hpp> 33 34 #include <algorithm> 35 #include <array> 36 #include <charconv> 37 #include <cstddef> 38 #include <cstdint> 39 #include <filesystem> 40 #include <fstream> 41 #include <memory> 42 #include <regex> 43 #include <string> 44 #include <string_view> 45 #include <tuple> 46 #include <vector> 47 48 extern sd_bus* bus; 49 50 constexpr auto bmc_state_interface = "xyz.openbmc_project.State.BMC"; 51 constexpr auto bmc_state_property = "CurrentBMCState"; 52 53 static constexpr auto redundancyIntf = 54 "xyz.openbmc_project.Software.RedundancyPriority"; 55 static constexpr auto versionIntf = "xyz.openbmc_project.Software.Version"; 56 static constexpr auto activationIntf = 57 "xyz.openbmc_project.Software.Activation"; 58 static constexpr auto softwareRoot = "/xyz/openbmc_project/software"; 59 60 void register_netfn_app_functions() __attribute__((constructor)); 61 62 using namespace phosphor::logging; 63 using namespace sdbusplus::xyz::openbmc_project::Common::Error; 64 using Version = sdbusplus::xyz::openbmc_project::Software::server::Version; 65 using Activation = 66 sdbusplus::xyz::openbmc_project::Software::server::Activation; 67 using BMC = sdbusplus::xyz::openbmc_project::State::server::BMC; 68 namespace fs = std::filesystem; 69 70 #ifdef ENABLE_I2C_WHITELIST_CHECK 71 typedef struct 72 { 73 uint8_t busId; 74 uint8_t slaveAddr; 75 uint8_t slaveAddrMask; 76 std::vector<uint8_t> data; 77 std::vector<uint8_t> dataMask; 78 } i2cMasterWRWhitelist; 79 80 static std::vector<i2cMasterWRWhitelist>& getWRWhitelist() 81 { 82 static std::vector<i2cMasterWRWhitelist> wrWhitelist; 83 return wrWhitelist; 84 } 85 86 static constexpr const char* i2cMasterWRWhitelistFile = 87 "/usr/share/ipmi-providers/master_write_read_white_list.json"; 88 89 static constexpr const char* filtersStr = "filters"; 90 static constexpr const char* busIdStr = "busId"; 91 static constexpr const char* slaveAddrStr = "slaveAddr"; 92 static constexpr const char* slaveAddrMaskStr = "slaveAddrMask"; 93 static constexpr const char* cmdStr = "command"; 94 static constexpr const char* cmdMaskStr = "commandMask"; 95 static constexpr int base_16 = 16; 96 #endif // ENABLE_I2C_WHITELIST_CHECK 97 static constexpr uint8_t maxIPMIWriteReadSize = 255; 98 static constexpr uint8_t oemCmdStart = 192; 99 static constexpr uint8_t oemCmdEnd = 255; 100 static constexpr uint8_t invalidParamSelectorStart = 8; 101 static constexpr uint8_t invalidParamSelectorEnd = 191; 102 103 /** 104 * @brief Returns the Version info from primary s/w object 105 * 106 * Get the Version info from the active s/w object which is having high 107 * "Priority" value(a smaller number is a higher priority) and "Purpose" 108 * is "BMC" from the list of all s/w objects those are implementing 109 * RedundancyPriority interface from the given softwareRoot path. 110 * 111 * @return On success returns the Version info from primary s/w object. 112 * 113 */ 114 std::string getActiveSoftwareVersionInfo(ipmi::Context::ptr ctx) 115 { 116 std::string revision{}; 117 ipmi::ObjectTree objectTree; 118 try 119 { 120 objectTree = ipmi::getAllDbusObjects(*ctx->bus, softwareRoot, 121 redundancyIntf); 122 } 123 catch (const sdbusplus::exception_t& e) 124 { 125 log<level::ERR>("Failed to fetch redundancy object from dbus", 126 entry("INTERFACE=%s", redundancyIntf), 127 entry("ERRMSG=%s", e.what())); 128 elog<InternalFailure>(); 129 } 130 131 auto objectFound = false; 132 for (auto& softObject : objectTree) 133 { 134 auto service = ipmi::getService(*ctx->bus, redundancyIntf, 135 softObject.first); 136 auto objValueTree = ipmi::getManagedObjects(*ctx->bus, service, 137 softwareRoot); 138 139 auto minPriority = 0xFF; 140 for (const auto& objIter : objValueTree) 141 { 142 try 143 { 144 auto& intfMap = objIter.second; 145 auto& redundancyPriorityProps = intfMap.at(redundancyIntf); 146 auto& versionProps = intfMap.at(versionIntf); 147 auto& activationProps = intfMap.at(activationIntf); 148 auto priority = 149 std::get<uint8_t>(redundancyPriorityProps.at("Priority")); 150 auto purpose = 151 std::get<std::string>(versionProps.at("Purpose")); 152 auto activation = 153 std::get<std::string>(activationProps.at("Activation")); 154 auto version = 155 std::get<std::string>(versionProps.at("Version")); 156 if ((Version::convertVersionPurposeFromString(purpose) == 157 Version::VersionPurpose::BMC) && 158 (Activation::convertActivationsFromString(activation) == 159 Activation::Activations::Active)) 160 { 161 if (priority < minPriority) 162 { 163 minPriority = priority; 164 objectFound = true; 165 revision = std::move(version); 166 } 167 } 168 } 169 catch (const std::exception& e) 170 { 171 log<level::ERR>(e.what()); 172 } 173 } 174 } 175 176 if (!objectFound) 177 { 178 log<level::ERR>("Could not found an BMC software Object"); 179 elog<InternalFailure>(); 180 } 181 182 return revision; 183 } 184 185 bool getCurrentBmcState() 186 { 187 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; 188 189 // Get the Inventory object implementing the BMC interface 190 ipmi::DbusObjectInfo bmcObject = ipmi::getDbusObject(bus, 191 bmc_state_interface); 192 auto variant = ipmi::getDbusProperty(bus, bmcObject.second, bmcObject.first, 193 bmc_state_interface, 194 bmc_state_property); 195 196 return std::holds_alternative<std::string>(variant) && 197 BMC::convertBMCStateFromString(std::get<std::string>(variant)) == 198 BMC::BMCState::Ready; 199 } 200 201 bool getCurrentBmcStateWithFallback(const bool fallbackAvailability) 202 { 203 try 204 { 205 return getCurrentBmcState(); 206 } 207 catch (...) 208 { 209 // Nothing provided the BMC interface, therefore return whatever was 210 // configured as the default. 211 return fallbackAvailability; 212 } 213 } 214 215 namespace acpi_state 216 { 217 using namespace sdbusplus::xyz::openbmc_project::Control::Power::server; 218 219 const static constexpr char* acpiObjPath = 220 "/xyz/openbmc_project/control/host0/acpi_power_state"; 221 const static constexpr char* acpiInterface = 222 "xyz.openbmc_project.Control.Power.ACPIPowerState"; 223 const static constexpr char* sysACPIProp = "SysACPIStatus"; 224 const static constexpr char* devACPIProp = "DevACPIStatus"; 225 226 enum class PowerStateType : uint8_t 227 { 228 sysPowerState = 0x00, 229 devPowerState = 0x01, 230 }; 231 232 // Defined in 20.6 of ipmi doc 233 enum class PowerState : uint8_t 234 { 235 s0G0D0 = 0x00, 236 s1D1 = 0x01, 237 s2D2 = 0x02, 238 s3D3 = 0x03, 239 s4 = 0x04, 240 s5G2 = 0x05, 241 s4S5 = 0x06, 242 g3 = 0x07, 243 sleep = 0x08, 244 g1Sleep = 0x09, 245 override = 0x0a, 246 legacyOn = 0x20, 247 legacyOff = 0x21, 248 unknown = 0x2a, 249 noChange = 0x7f, 250 }; 251 252 static constexpr uint8_t stateChanged = 0x80; 253 254 std::map<ACPIPowerState::ACPI, PowerState> dbusToIPMI = { 255 {ACPIPowerState::ACPI::S0_G0_D0, PowerState::s0G0D0}, 256 {ACPIPowerState::ACPI::S1_D1, PowerState::s1D1}, 257 {ACPIPowerState::ACPI::S2_D2, PowerState::s2D2}, 258 {ACPIPowerState::ACPI::S3_D3, PowerState::s3D3}, 259 {ACPIPowerState::ACPI::S4, PowerState::s4}, 260 {ACPIPowerState::ACPI::S5_G2, PowerState::s5G2}, 261 {ACPIPowerState::ACPI::S4_S5, PowerState::s4S5}, 262 {ACPIPowerState::ACPI::G3, PowerState::g3}, 263 {ACPIPowerState::ACPI::SLEEP, PowerState::sleep}, 264 {ACPIPowerState::ACPI::G1_SLEEP, PowerState::g1Sleep}, 265 {ACPIPowerState::ACPI::OVERRIDE, PowerState::override}, 266 {ACPIPowerState::ACPI::LEGACY_ON, PowerState::legacyOn}, 267 {ACPIPowerState::ACPI::LEGACY_OFF, PowerState::legacyOff}, 268 {ACPIPowerState::ACPI::Unknown, PowerState::unknown}}; 269 270 bool isValidACPIState(acpi_state::PowerStateType type, uint8_t state) 271 { 272 if (type == acpi_state::PowerStateType::sysPowerState) 273 { 274 if ((state <= static_cast<uint8_t>(acpi_state::PowerState::override)) || 275 (state == static_cast<uint8_t>(acpi_state::PowerState::legacyOn)) || 276 (state == 277 static_cast<uint8_t>(acpi_state::PowerState::legacyOff)) || 278 (state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) || 279 (state == static_cast<uint8_t>(acpi_state::PowerState::noChange))) 280 { 281 return true; 282 } 283 else 284 { 285 return false; 286 } 287 } 288 else if (type == acpi_state::PowerStateType::devPowerState) 289 { 290 if ((state <= static_cast<uint8_t>(acpi_state::PowerState::s3D3)) || 291 (state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) || 292 (state == static_cast<uint8_t>(acpi_state::PowerState::noChange))) 293 { 294 return true; 295 } 296 else 297 { 298 return false; 299 } 300 } 301 else 302 { 303 return false; 304 } 305 return false; 306 } 307 } // namespace acpi_state 308 309 /** @brief implements Set ACPI Power State command 310 * @param sysAcpiState - ACPI system power state to set 311 * @param devAcpiState - ACPI device power state to set 312 * 313 * @return IPMI completion code on success 314 **/ 315 ipmi::RspType<> ipmiSetAcpiPowerState(uint8_t sysAcpiState, 316 uint8_t devAcpiState) 317 { 318 auto s = static_cast<uint8_t>(acpi_state::PowerState::unknown); 319 320 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; 321 322 auto value = acpi_state::ACPIPowerState::ACPI::Unknown; 323 324 if (sysAcpiState & acpi_state::stateChanged) 325 { 326 // set system power state 327 s = sysAcpiState & ~acpi_state::stateChanged; 328 329 if (!acpi_state::isValidACPIState( 330 acpi_state::PowerStateType::sysPowerState, s)) 331 { 332 log<level::ERR>("set_acpi_power sys invalid input", 333 entry("S=%x", s)); 334 return ipmi::responseParmOutOfRange(); 335 } 336 337 // valid input 338 if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange)) 339 { 340 log<level::DEBUG>("No change for system power state"); 341 } 342 else 343 { 344 auto found = std::find_if(acpi_state::dbusToIPMI.begin(), 345 acpi_state::dbusToIPMI.end(), 346 [&s](const auto& iter) { 347 return (static_cast<uint8_t>(iter.second) == s); 348 }); 349 350 value = found->first; 351 352 try 353 { 354 auto acpiObject = 355 ipmi::getDbusObject(bus, acpi_state::acpiInterface); 356 ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first, 357 acpi_state::acpiInterface, 358 acpi_state::sysACPIProp, 359 convertForMessage(value)); 360 } 361 catch (const InternalFailure& e) 362 { 363 log<level::ERR>("Failed in set ACPI system property", 364 entry("EXCEPTION=%s", e.what())); 365 return ipmi::responseUnspecifiedError(); 366 } 367 } 368 } 369 else 370 { 371 log<level::DEBUG>("Do not change system power state"); 372 } 373 374 if (devAcpiState & acpi_state::stateChanged) 375 { 376 // set device power state 377 s = devAcpiState & ~acpi_state::stateChanged; 378 if (!acpi_state::isValidACPIState( 379 acpi_state::PowerStateType::devPowerState, s)) 380 { 381 log<level::ERR>("set_acpi_power dev invalid input", 382 entry("S=%x", s)); 383 return ipmi::responseParmOutOfRange(); 384 } 385 386 // valid input 387 if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange)) 388 { 389 log<level::DEBUG>("No change for device power state"); 390 } 391 else 392 { 393 auto found = std::find_if(acpi_state::dbusToIPMI.begin(), 394 acpi_state::dbusToIPMI.end(), 395 [&s](const auto& iter) { 396 return (static_cast<uint8_t>(iter.second) == s); 397 }); 398 399 value = found->first; 400 401 try 402 { 403 auto acpiObject = 404 ipmi::getDbusObject(bus, acpi_state::acpiInterface); 405 ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first, 406 acpi_state::acpiInterface, 407 acpi_state::devACPIProp, 408 convertForMessage(value)); 409 } 410 catch (const InternalFailure& e) 411 { 412 log<level::ERR>("Failed in set ACPI device property", 413 entry("EXCEPTION=%s", e.what())); 414 return ipmi::responseUnspecifiedError(); 415 } 416 } 417 } 418 else 419 { 420 log<level::DEBUG>("Do not change device power state"); 421 } 422 return ipmi::responseSuccess(); 423 } 424 425 /** 426 * @brief implements the get ACPI power state command 427 * 428 * @return IPMI completion code plus response data on success. 429 * - ACPI system power state 430 * - ACPI device power state 431 **/ 432 ipmi::RspType<uint8_t, // acpiSystemPowerState 433 uint8_t // acpiDevicePowerState 434 > 435 ipmiGetAcpiPowerState() 436 { 437 uint8_t sysAcpiState; 438 uint8_t devAcpiState; 439 440 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()}; 441 442 try 443 { 444 auto acpiObject = ipmi::getDbusObject(bus, acpi_state::acpiInterface); 445 446 auto sysACPIVal = ipmi::getDbusProperty( 447 bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface, 448 acpi_state::sysACPIProp); 449 auto sysACPI = acpi_state::ACPIPowerState::convertACPIFromString( 450 std::get<std::string>(sysACPIVal)); 451 sysAcpiState = static_cast<uint8_t>(acpi_state::dbusToIPMI.at(sysACPI)); 452 453 auto devACPIVal = ipmi::getDbusProperty( 454 bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface, 455 acpi_state::devACPIProp); 456 auto devACPI = acpi_state::ACPIPowerState::convertACPIFromString( 457 std::get<std::string>(devACPIVal)); 458 devAcpiState = static_cast<uint8_t>(acpi_state::dbusToIPMI.at(devACPI)); 459 } 460 catch (const InternalFailure& e) 461 { 462 return ipmi::responseUnspecifiedError(); 463 } 464 465 return ipmi::responseSuccess(sysAcpiState, devAcpiState); 466 } 467 468 typedef struct 469 { 470 char major; 471 char minor; 472 uint8_t aux[4]; 473 } Revision; 474 475 /* Use regular expression searching matched pattern X.Y, and convert it to */ 476 /* Major (X) and Minor (Y) version. */ 477 /* Example: */ 478 /* version = 2.14.0-dev */ 479 /* ^ ^ */ 480 /* | |---------------- Minor */ 481 /* |------------------ Major */ 482 /* */ 483 /* Default regex string only tries to match Major and Minor version. */ 484 /* */ 485 /* To match more firmware version info, platforms need to define it own */ 486 /* regex string to match more strings, and assign correct mapping index in */ 487 /* matches array. */ 488 /* */ 489 /* matches[0]: matched index for major ver */ 490 /* matches[1]: matched index for minor ver */ 491 /* matches[2]: matched index for aux[0] (set 0 to skip) */ 492 /* matches[3]: matched index for aux[1] (set 0 to skip) */ 493 /* matches[4]: matched index for aux[2] (set 0 to skip) */ 494 /* matches[5]: matched index for aux[3] (set 0 to skip) */ 495 /* Example: */ 496 /* regex = "([\d]+).([\d]+).([\d]+)-dev-([\d]+)-g([0-9a-fA-F]{2}) */ 497 /* ([0-9a-fA-F]{2})([0-9a-fA-F]{2})([0-9a-fA-F]{2})" */ 498 /* matches = {1,2,5,6,7,8} */ 499 /* version = 2.14.0-dev-750-g37a7c5ad1-dirty */ 500 /* ^ ^ ^ ^ ^ ^ ^ ^ */ 501 /* | | | | | | | | */ 502 /* | | | | | | | |-- Aux byte 3 (0xAD), index 8 */ 503 /* | | | | | | |---- Aux byte 2 (0xC5), index 7 */ 504 /* | | | | | |------ Aux byte 1 (0xA7), index 6 */ 505 /* | | | | |-------- Aux byte 0 (0x37), index 5 */ 506 /* | | | |------------- Not used, index 4 */ 507 /* | | |------------------- Not used, index 3 */ 508 /* | |---------------------- Minor (14), index 2 */ 509 /* |------------------------ Major (2), index 1 */ 510 int convertVersion(std::string s, Revision& rev) 511 { 512 static const std::vector<size_t> matches = { 513 MAJOR_MATCH_INDEX, MINOR_MATCH_INDEX, AUX_0_MATCH_INDEX, 514 AUX_1_MATCH_INDEX, AUX_2_MATCH_INDEX, AUX_3_MATCH_INDEX}; 515 std::regex fw_regex(FW_VER_REGEX); 516 std::smatch m; 517 Revision r = {0}; 518 size_t val; 519 520 if (std::regex_search(s, m, fw_regex)) 521 { 522 if (m.size() < *std::max_element(matches.begin(), matches.end())) 523 { // max index higher than match count 524 return -1; 525 } 526 527 // convert major 528 { 529 std::string_view str = m[matches[0]].str(); 530 auto [ptr, ec]{std::from_chars(str.begin(), str.end(), val)}; 531 if (ec != std::errc() || ptr != str.begin() + str.size()) 532 { // failed to convert major string 533 return -1; 534 } 535 r.major = val & 0x7F; 536 } 537 538 // convert minor 539 { 540 std::string_view str = m[matches[1]].str(); 541 auto [ptr, ec]{std::from_chars(str.begin(), str.end(), val)}; 542 if (ec != std::errc() || ptr != str.begin() + str.size()) 543 { // failed to convert minor string 544 return -1; 545 } 546 r.minor = val & 0xFF; 547 } 548 549 // convert aux bytes 550 { 551 size_t i; 552 for (i = 0; i < 4; i++) 553 { 554 if (matches[i + 2] == 0) 555 { 556 continue; 557 } 558 559 std::string_view str = m[matches[i + 2]].str(); 560 auto [ptr, 561 ec]{std::from_chars(str.begin(), str.end(), val, 16)}; 562 if (ec != std::errc() || ptr != str.begin() + str.size()) 563 { // failed to convert aux byte string 564 break; 565 } 566 567 r.aux[i] = val & 0xFF; 568 } 569 570 if (i != 4) 571 { // something wrong durign converting aux bytes 572 return -1; 573 } 574 } 575 576 // all matched 577 rev = r; 578 return 0; 579 } 580 581 return -1; 582 } 583 584 /* @brief: Implement the Get Device ID IPMI command per the IPMI spec 585 * @param[in] ctx - shared_ptr to an IPMI context struct 586 * 587 * @returns IPMI completion code plus response data 588 * - Device ID (manufacturer defined) 589 * - Device revision[4 bits]; reserved[3 bits]; SDR support[1 bit] 590 * - FW revision major[7 bits] (binary encoded); available[1 bit] 591 * - FW Revision minor (BCD encoded) 592 * - IPMI version (0x02 for IPMI 2.0) 593 * - device support (bitfield of supported options) 594 * - MFG IANA ID (3 bytes) 595 * - product ID (2 bytes) 596 * - AUX info (4 bytes) 597 */ 598 ipmi::RspType<uint8_t, // Device ID 599 uint8_t, // Device Revision 600 uint8_t, // Firmware Revision Major 601 uint8_t, // Firmware Revision minor 602 uint8_t, // IPMI version 603 uint8_t, // Additional device support 604 uint24_t, // MFG ID 605 uint16_t, // Product ID 606 uint32_t // AUX info 607 > 608 ipmiAppGetDeviceId([[maybe_unused]] ipmi::Context::ptr ctx) 609 { 610 static struct 611 { 612 uint8_t id; 613 uint8_t revision; 614 uint8_t fw[2]; 615 uint8_t ipmiVer; 616 uint8_t addnDevSupport; 617 uint24_t manufId; 618 uint16_t prodId; 619 uint32_t aux; 620 } devId; 621 static bool dev_id_initialized = false; 622 static bool defaultActivationSetting = true; 623 const char* filename = "/usr/share/ipmi-providers/dev_id.json"; 624 constexpr auto ipmiDevIdStateShift = 7; 625 constexpr auto ipmiDevIdFw1Mask = ~(1 << ipmiDevIdStateShift); 626 627 #ifdef GET_DBUS_ACTIVE_SOFTWARE 628 static bool haveBMCVersion = false; 629 if (!haveBMCVersion || !dev_id_initialized) 630 { 631 int r = -1; 632 Revision rev = {0, 0, 0, 0}; 633 try 634 { 635 auto version = getActiveSoftwareVersionInfo(ctx); 636 r = convertVersion(version, rev); 637 } 638 catch (const std::exception& e) 639 { 640 log<level::ERR>(e.what()); 641 } 642 643 if (r >= 0) 644 { 645 // bit7 identifies if the device is available 646 // 0=normal operation 647 // 1=device firmware, SDR update, 648 // or self-initialization in progress. 649 // The availability may change in run time, so mask here 650 // and initialize later. 651 devId.fw[0] = rev.major & ipmiDevIdFw1Mask; 652 653 rev.minor = (rev.minor > 99 ? 99 : rev.minor); 654 devId.fw[1] = rev.minor % 10 + (rev.minor / 10) * 16; 655 std::memcpy(&devId.aux, rev.aux, sizeof(rev.aux)); 656 haveBMCVersion = true; 657 } 658 } 659 #endif 660 if (!dev_id_initialized) 661 { 662 // IPMI Spec version 2.0 663 devId.ipmiVer = 2; 664 665 std::ifstream devIdFile(filename); 666 if (devIdFile.is_open()) 667 { 668 auto data = nlohmann::json::parse(devIdFile, nullptr, false); 669 if (!data.is_discarded()) 670 { 671 devId.id = data.value("id", 0); 672 devId.revision = data.value("revision", 0); 673 devId.addnDevSupport = data.value("addn_dev_support", 0); 674 devId.manufId = data.value("manuf_id", 0); 675 devId.prodId = data.value("prod_id", 0); 676 devId.aux = data.value("aux", 0); 677 678 if (data.contains("firmware_revision")) 679 { 680 const auto& firmwareRevision = data.at("firmware_revision"); 681 if (firmwareRevision.contains("major")) 682 { 683 firmwareRevision.at("major").get_to(devId.fw[0]); 684 } 685 if (firmwareRevision.contains("minor")) 686 { 687 firmwareRevision.at("minor").get_to(devId.fw[1]); 688 } 689 } 690 691 // Set the availablitity of the BMC. 692 defaultActivationSetting = data.value("availability", true); 693 694 // Don't read the file every time if successful 695 dev_id_initialized = true; 696 } 697 else 698 { 699 log<level::ERR>("Device ID JSON parser failure"); 700 return ipmi::responseUnspecifiedError(); 701 } 702 } 703 else 704 { 705 log<level::ERR>("Device ID file not found"); 706 return ipmi::responseUnspecifiedError(); 707 } 708 } 709 710 // Set availability to the actual current BMC state 711 devId.fw[0] &= ipmiDevIdFw1Mask; 712 if (!getCurrentBmcStateWithFallback(defaultActivationSetting)) 713 { 714 devId.fw[0] |= (1 << ipmiDevIdStateShift); 715 } 716 717 return ipmi::responseSuccess( 718 devId.id, devId.revision, devId.fw[0], devId.fw[1], devId.ipmiVer, 719 devId.addnDevSupport, devId.manufId, devId.prodId, devId.aux); 720 } 721 722 auto ipmiAppGetSelfTestResults() -> ipmi::RspType<uint8_t, uint8_t> 723 { 724 // Byte 2: 725 // 55h - No error. 726 // 56h - Self Test function not implemented in this controller. 727 // 57h - Corrupted or inaccesssible data or devices. 728 // 58h - Fatal hardware error. 729 // FFh - reserved. 730 // all other: Device-specific 'internal failure'. 731 // Byte 3: 732 // For byte 2 = 55h, 56h, FFh: 00h 733 // For byte 2 = 58h, all other: Device-specific 734 // For byte 2 = 57h: self-test error bitfield. 735 // Note: returning 57h does not imply that all test were run. 736 // [7] 1b = Cannot access SEL device. 737 // [6] 1b = Cannot access SDR Repository. 738 // [5] 1b = Cannot access BMC FRU device. 739 // [4] 1b = IPMB signal lines do not respond. 740 // [3] 1b = SDR Repository empty. 741 // [2] 1b = Internal Use Area of BMC FRU corrupted. 742 // [1] 1b = controller update 'boot block' firmware corrupted. 743 // [0] 1b = controller operational firmware corrupted. 744 constexpr uint8_t notImplemented = 0x56; 745 constexpr uint8_t zero = 0; 746 return ipmi::responseSuccess(notImplemented, zero); 747 } 748 749 static constexpr size_t uuidBinaryLength = 16; 750 static std::array<uint8_t, uuidBinaryLength> rfc4122ToIpmi(std::string rfc4122) 751 { 752 using Argument = xyz::openbmc_project::Common::InvalidArgument; 753 // UUID is in RFC4122 format. Ex: 61a39523-78f2-11e5-9862-e6402cfc3223 754 // Per IPMI Spec 2.0 need to convert to 16 hex bytes and reverse the byte 755 // order 756 // Ex: 0x2332fc2c40e66298e511f2782395a361 757 constexpr size_t uuidHexLength = (2 * uuidBinaryLength); 758 constexpr size_t uuidRfc4122Length = (uuidHexLength + 4); 759 std::array<uint8_t, uuidBinaryLength> uuid; 760 if (rfc4122.size() == uuidRfc4122Length) 761 { 762 rfc4122.erase(std::remove(rfc4122.begin(), rfc4122.end(), '-'), 763 rfc4122.end()); 764 } 765 if (rfc4122.size() != uuidHexLength) 766 { 767 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"), 768 Argument::ARGUMENT_VALUE(rfc4122.c_str())); 769 } 770 for (size_t ind = 0; ind < uuidHexLength; ind += 2) 771 { 772 char v[3]; 773 v[0] = rfc4122[ind]; 774 v[1] = rfc4122[ind + 1]; 775 v[2] = 0; 776 size_t err; 777 long b; 778 try 779 { 780 b = std::stoul(v, &err, 16); 781 } 782 catch (const std::exception& e) 783 { 784 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"), 785 Argument::ARGUMENT_VALUE(rfc4122.c_str())); 786 } 787 // check that exactly two ascii bytes were converted 788 if (err != 2) 789 { 790 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"), 791 Argument::ARGUMENT_VALUE(rfc4122.c_str())); 792 } 793 uuid[uuidBinaryLength - (ind / 2) - 1] = static_cast<uint8_t>(b); 794 } 795 return uuid; 796 } 797 798 auto ipmiAppGetDeviceGuid() 799 -> ipmi::RspType<std::array<uint8_t, uuidBinaryLength>> 800 { 801 // return a fixed GUID based on /etc/machine-id 802 // This should match the /redfish/v1/Managers/bmc's UUID data 803 804 // machine specific application ID (for BMC ID) 805 // generated by systemd-id128 -p new as per man page 806 static constexpr sd_id128_t bmcUuidAppId = SD_ID128_MAKE( 807 e0, e1, 73, 76, 64, 61, 47, da, a5, 0c, d0, cc, 64, 12, 45, 78); 808 809 sd_id128_t bmcUuid; 810 // create the UUID from /etc/machine-id via the systemd API 811 sd_id128_get_machine_app_specific(bmcUuidAppId, &bmcUuid); 812 813 char bmcUuidCstr[SD_ID128_STRING_MAX]; 814 std::string systemUuid = sd_id128_to_string(bmcUuid, bmcUuidCstr); 815 816 std::array<uint8_t, uuidBinaryLength> uuid = rfc4122ToIpmi(systemUuid); 817 return ipmi::responseSuccess(uuid); 818 } 819 820 auto ipmiAppGetBtCapabilities() 821 -> ipmi::RspType<uint8_t, uint8_t, uint8_t, uint8_t, uint8_t> 822 { 823 // Per IPMI 2.0 spec, the input and output buffer size must be the max 824 // buffer size minus one byte to allocate space for the length byte. 825 constexpr uint8_t nrOutstanding = 0x01; 826 constexpr uint8_t inputBufferSize = MAX_IPMI_BUFFER - 1; 827 constexpr uint8_t outputBufferSize = MAX_IPMI_BUFFER - 1; 828 constexpr uint8_t transactionTime = 0x0A; 829 constexpr uint8_t nrRetries = 0x01; 830 831 return ipmi::responseSuccess(nrOutstanding, inputBufferSize, 832 outputBufferSize, transactionTime, nrRetries); 833 } 834 835 auto ipmiAppGetSystemGuid(ipmi::Context::ptr& ctx) 836 -> ipmi::RspType<std::array<uint8_t, 16>> 837 { 838 static constexpr auto uuidInterface = "xyz.openbmc_project.Common.UUID"; 839 static constexpr auto uuidProperty = "UUID"; 840 841 // Get the Inventory object implementing BMC interface 842 ipmi::DbusObjectInfo objectInfo{}; 843 boost::system::error_code ec = ipmi::getDbusObject(ctx, uuidInterface, 844 objectInfo); 845 if (ec.value()) 846 { 847 log<level::ERR>("Failed to locate System UUID object", 848 entry("INTERFACE=%s", uuidInterface), 849 entry("ERROR=%s", ec.message().c_str())); 850 return ipmi::responseUnspecifiedError(); 851 } 852 853 // Read UUID property value from bmcObject 854 // UUID is in RFC4122 format Ex: 61a39523-78f2-11e5-9862-e6402cfc3223 855 std::string rfc4122Uuid{}; 856 ec = ipmi::getDbusProperty(ctx, objectInfo.second, objectInfo.first, 857 uuidInterface, uuidProperty, rfc4122Uuid); 858 if (ec.value()) 859 { 860 log<level::ERR>("Failed in reading BMC UUID property", 861 entry("INTERFACE=%s", uuidInterface), 862 entry("PROPERTY=%s", uuidProperty), 863 entry("ERROR=%s", ec.message().c_str())); 864 return ipmi::responseUnspecifiedError(); 865 } 866 std::array<uint8_t, 16> uuid; 867 try 868 { 869 // convert to IPMI format 870 uuid = rfc4122ToIpmi(rfc4122Uuid); 871 } 872 catch (const InvalidArgument& e) 873 { 874 log<level::ERR>("Failed in parsing BMC UUID property", 875 entry("INTERFACE=%s", uuidInterface), 876 entry("PROPERTY=%s", uuidProperty), 877 entry("VALUE=%s", rfc4122Uuid.c_str())); 878 return ipmi::responseUnspecifiedError(); 879 } 880 return ipmi::responseSuccess(uuid); 881 } 882 883 /** 884 * @brief set the session state as teardown 885 * 886 * This function is to set the session state to tear down in progress if the 887 * state is active. 888 * 889 * @param[in] busp - Dbus obj 890 * @param[in] service - service name 891 * @param[in] obj - object path 892 * 893 * @return success completion code if it sets the session state to 894 * tearDownInProgress else return the corresponding error completion code. 895 **/ 896 uint8_t setSessionState(std::shared_ptr<sdbusplus::asio::connection>& busp, 897 const std::string& service, const std::string& obj) 898 { 899 try 900 { 901 uint8_t sessionState = std::get<uint8_t>(ipmi::getDbusProperty( 902 *busp, service, obj, session::sessionIntf, "State")); 903 904 if (sessionState == static_cast<uint8_t>(session::State::active)) 905 { 906 ipmi::setDbusProperty( 907 *busp, service, obj, session::sessionIntf, "State", 908 static_cast<uint8_t>(session::State::tearDownInProgress)); 909 return ipmi::ccSuccess; 910 } 911 } 912 catch (const std::exception& e) 913 { 914 log<level::ERR>("Failed in getting session state property", 915 entry("service=%s", service.c_str()), 916 entry("object path=%s", obj.c_str()), 917 entry("interface=%s", session::sessionIntf)); 918 return ipmi::ccUnspecifiedError; 919 } 920 921 return ipmi::ccInvalidFieldRequest; 922 } 923 924 ipmi::RspType<> ipmiAppCloseSession(uint32_t reqSessionId, 925 std::optional<uint8_t> requestSessionHandle) 926 { 927 auto busp = getSdBus(); 928 uint8_t reqSessionHandle = 929 requestSessionHandle.value_or(session::defaultSessionHandle); 930 931 if (reqSessionId == session::sessionZero && 932 reqSessionHandle == session::defaultSessionHandle) 933 { 934 return ipmi::response(session::ccInvalidSessionId); 935 } 936 937 if (reqSessionId == session::sessionZero && 938 reqSessionHandle == session::invalidSessionHandle) 939 { 940 return ipmi::response(session::ccInvalidSessionHandle); 941 } 942 943 if (reqSessionId != session::sessionZero && 944 reqSessionHandle != session::defaultSessionHandle) 945 { 946 return ipmi::response(ipmi::ccInvalidFieldRequest); 947 } 948 949 try 950 { 951 ipmi::ObjectTree objectTree = ipmi::getAllDbusObjects( 952 *busp, session::sessionManagerRootPath, session::sessionIntf); 953 954 for (auto& objectTreeItr : objectTree) 955 { 956 const std::string obj = objectTreeItr.first; 957 958 if (isSessionObjectMatched(obj, reqSessionId, reqSessionHandle)) 959 { 960 auto& serviceMap = objectTreeItr.second; 961 962 // Session id and session handle are unique for each session. 963 // Session id and handler are retrived from the object path and 964 // object path will be unique for each session. Checking if 965 // multiple objects exist with same object path under multiple 966 // services. 967 if (serviceMap.size() != 1) 968 { 969 return ipmi::responseUnspecifiedError(); 970 } 971 972 auto itr = serviceMap.begin(); 973 const std::string service = itr->first; 974 return ipmi::response(setSessionState(busp, service, obj)); 975 } 976 } 977 } 978 catch (const sdbusplus::exception_t& e) 979 { 980 log<level::ERR>("Failed to fetch object from dbus", 981 entry("INTERFACE=%s", session::sessionIntf), 982 entry("ERRMSG=%s", e.what())); 983 return ipmi::responseUnspecifiedError(); 984 } 985 986 return ipmi::responseInvalidFieldRequest(); 987 } 988 989 uint8_t getTotalSessionCount() 990 { 991 uint8_t count = 0, ch = 0; 992 993 while (ch < ipmi::maxIpmiChannels && 994 count < session::maxNetworkInstanceSupported) 995 { 996 ipmi::ChannelInfo chInfo{}; 997 ipmi::getChannelInfo(ch, chInfo); 998 if (static_cast<ipmi::EChannelMediumType>(chInfo.mediumType) == 999 ipmi::EChannelMediumType::lan8032) 1000 { 1001 count++; 1002 } 1003 ch++; 1004 } 1005 return count * session::maxSessionCountPerChannel; 1006 } 1007 1008 /** 1009 * @brief get session info request data. 1010 * 1011 * This function validates the request data and retrive request session id, 1012 * session handle. 1013 * 1014 * @param[in] ctx - context of current session. 1015 * @param[in] sessionIndex - request session index 1016 * @param[in] payload - input payload 1017 * @param[in] reqSessionId - unpacked session Id will be asigned 1018 * @param[in] reqSessionHandle - unpacked session handle will be asigned 1019 * 1020 * @return success completion code if request data is valid 1021 * else return the correcponding error completion code. 1022 **/ 1023 uint8_t getSessionInfoRequestData(const ipmi::Context::ptr ctx, 1024 const uint8_t sessionIndex, 1025 ipmi::message::Payload& payload, 1026 uint32_t& reqSessionId, 1027 uint8_t& reqSessionHandle) 1028 { 1029 if ((sessionIndex > session::maxSessionCountPerChannel) && 1030 (sessionIndex < session::searchSessionByHandle)) 1031 { 1032 return ipmi::ccInvalidFieldRequest; 1033 } 1034 1035 switch (sessionIndex) 1036 { 1037 case session::searchCurrentSession: 1038 1039 ipmi::ChannelInfo chInfo; 1040 ipmi::getChannelInfo(ctx->channel, chInfo); 1041 1042 if (static_cast<ipmi::EChannelMediumType>(chInfo.mediumType) != 1043 ipmi::EChannelMediumType::lan8032) 1044 { 1045 return ipmi::ccInvalidFieldRequest; 1046 } 1047 1048 if (!payload.fullyUnpacked()) 1049 { 1050 return ipmi::ccReqDataLenInvalid; 1051 } 1052 // Check if current sessionId is 0, sessionId 0 is reserved. 1053 if (ctx->sessionId == session::sessionZero) 1054 { 1055 return session::ccInvalidSessionId; 1056 } 1057 reqSessionId = ctx->sessionId; 1058 break; 1059 1060 case session::searchSessionByHandle: 1061 1062 if ((payload.unpack(reqSessionHandle)) || 1063 (!payload.fullyUnpacked())) 1064 { 1065 return ipmi::ccReqDataLenInvalid; 1066 } 1067 1068 if ((reqSessionHandle == session::sessionZero) || 1069 ((reqSessionHandle & session::multiIntfaceSessionHandleMask) > 1070 session::maxSessionCountPerChannel)) 1071 { 1072 return session::ccInvalidSessionHandle; 1073 } 1074 break; 1075 1076 case session::searchSessionById: 1077 1078 if ((payload.unpack(reqSessionId)) || (!payload.fullyUnpacked())) 1079 { 1080 return ipmi::ccReqDataLenInvalid; 1081 } 1082 1083 if (reqSessionId == session::sessionZero) 1084 { 1085 return session::ccInvalidSessionId; 1086 } 1087 break; 1088 1089 default: 1090 if (!payload.fullyUnpacked()) 1091 { 1092 return ipmi::ccReqDataLenInvalid; 1093 } 1094 break; 1095 } 1096 return ipmi::ccSuccess; 1097 } 1098 1099 uint8_t getSessionState(ipmi::Context::ptr ctx, const std::string& service, 1100 const std::string& objPath, uint8_t& sessionState) 1101 { 1102 boost::system::error_code ec = ipmi::getDbusProperty( 1103 ctx, service, objPath, session::sessionIntf, "State", sessionState); 1104 if (ec) 1105 { 1106 log<level::ERR>("Failed to fetch state property ", 1107 entry("SERVICE=%s", service.c_str()), 1108 entry("OBJECTPATH=%s", objPath.c_str()), 1109 entry("INTERFACE=%s", session::sessionIntf), 1110 entry("ERRMSG=%s", ec.message().c_str())); 1111 return ipmi::ccUnspecifiedError; 1112 } 1113 return ipmi::ccSuccess; 1114 } 1115 1116 static constexpr uint8_t macAddrLen = 6; 1117 /** Alias SessionDetails - contain the optional information about an 1118 * RMCP+ session. 1119 * 1120 * @param userID - uint6_t session user ID (0-63) 1121 * @param reserved - uint2_t reserved 1122 * @param privilege - uint4_t session privilege (0-5) 1123 * @param reserved - uint4_t reserved 1124 * @param channel - uint4_t session channel number 1125 * @param protocol - uint4_t session protocol 1126 * @param remoteIP - uint32_t remote IP address 1127 * @param macAddr - std::array<uint8_t, 6> mac address 1128 * @param port - uint16_t remote port 1129 */ 1130 using SessionDetails = 1131 std::tuple<uint2_t, uint6_t, uint4_t, uint4_t, uint4_t, uint4_t, uint32_t, 1132 std::array<uint8_t, macAddrLen>, uint16_t>; 1133 1134 /** @brief get session details for a given session 1135 * 1136 * @param[in] ctx - ipmi::Context pointer for accessing D-Bus 1137 * @param[in] service - D-Bus service name to fetch details from 1138 * @param[in] objPath - D-Bus object path for session 1139 * @param[out] sessionHandle - return session handle for session 1140 * @param[out] sessionState - return session state for session 1141 * @param[out] details - return a SessionDetails tuple containing other 1142 * session info 1143 * @return - ipmi::Cc success or error code 1144 */ 1145 ipmi::Cc getSessionDetails(ipmi::Context::ptr ctx, const std::string& service, 1146 const std::string& objPath, uint8_t& sessionHandle, 1147 uint8_t& sessionState, SessionDetails& details) 1148 { 1149 ipmi::PropertyMap sessionProps; 1150 boost::system::error_code ec = ipmi::getAllDbusProperties( 1151 ctx, service, objPath, session::sessionIntf, sessionProps); 1152 1153 if (ec) 1154 { 1155 log<level::ERR>("Failed to fetch state property ", 1156 entry("SERVICE=%s", service.c_str()), 1157 entry("OBJECTPATH=%s", objPath.c_str()), 1158 entry("INTERFACE=%s", session::sessionIntf), 1159 entry("ERRMSG=%s", ec.message().c_str())); 1160 return ipmi::ccUnspecifiedError; 1161 } 1162 1163 sessionState = ipmi::mappedVariant<uint8_t>( 1164 sessionProps, "State", static_cast<uint8_t>(session::State::inactive)); 1165 if (sessionState == static_cast<uint8_t>(session::State::active)) 1166 { 1167 sessionHandle = ipmi::mappedVariant<uint8_t>(sessionProps, 1168 "SessionHandle", 0); 1169 std::get<0>(details) = ipmi::mappedVariant<uint8_t>(sessionProps, 1170 "UserID", 0xff); 1171 // std::get<1>(details) = 0; // (default constructed to 0) 1172 std::get<2>(details) = 1173 ipmi::mappedVariant<uint8_t>(sessionProps, "CurrentPrivilege", 0); 1174 // std::get<3>(details) = 0; // (default constructed to 0) 1175 std::get<4>(details) = ipmi::mappedVariant<uint8_t>(sessionProps, 1176 "ChannelNum", 0xff); 1177 constexpr uint4_t rmcpPlusProtocol = 1; 1178 std::get<5>(details) = rmcpPlusProtocol; 1179 std::get<6>(details) = ipmi::mappedVariant<uint32_t>(sessionProps, 1180 "RemoteIPAddr", 0); 1181 // std::get<7>(details) = {{0}}; // default constructed to all 0 1182 std::get<8>(details) = ipmi::mappedVariant<uint16_t>(sessionProps, 1183 "RemotePort", 0); 1184 } 1185 1186 return ipmi::ccSuccess; 1187 } 1188 1189 ipmi::RspType<uint8_t, // session handle, 1190 uint8_t, // total session count 1191 uint8_t, // active session count 1192 std::optional<SessionDetails>> 1193 ipmiAppGetSessionInfo(ipmi::Context::ptr ctx, uint8_t sessionIndex, 1194 ipmi::message::Payload& payload) 1195 { 1196 uint32_t reqSessionId = 0; 1197 uint8_t reqSessionHandle = session::defaultSessionHandle; 1198 // initializing state to 0xff as 0 represents state as inactive. 1199 uint8_t state = 0xFF; 1200 1201 uint8_t completionCode = getSessionInfoRequestData( 1202 ctx, sessionIndex, payload, reqSessionId, reqSessionHandle); 1203 1204 if (completionCode) 1205 { 1206 return ipmi::response(completionCode); 1207 } 1208 ipmi::ObjectTree objectTree; 1209 boost::system::error_code ec = ipmi::getAllDbusObjects( 1210 ctx, session::sessionManagerRootPath, session::sessionIntf, objectTree); 1211 if (ec) 1212 { 1213 log<level::ERR>("Failed to fetch object from dbus", 1214 entry("INTERFACE=%s", session::sessionIntf), 1215 entry("ERRMSG=%s", ec.message().c_str())); 1216 return ipmi::responseUnspecifiedError(); 1217 } 1218 1219 uint8_t totalSessionCount = getTotalSessionCount(); 1220 uint8_t activeSessionCount = 0; 1221 uint8_t sessionHandle = session::defaultSessionHandle; 1222 uint8_t activeSessionHandle = 0; 1223 std::optional<SessionDetails> maybeDetails; 1224 uint8_t index = 0; 1225 for (auto& objectTreeItr : objectTree) 1226 { 1227 uint32_t sessionId = 0; 1228 std::string objectPath = objectTreeItr.first; 1229 1230 if (!parseCloseSessionInputPayload(objectPath, sessionId, 1231 sessionHandle)) 1232 { 1233 continue; 1234 } 1235 index++; 1236 auto& serviceMap = objectTreeItr.second; 1237 auto itr = serviceMap.begin(); 1238 1239 if (serviceMap.size() != 1) 1240 { 1241 return ipmi::responseUnspecifiedError(); 1242 } 1243 1244 std::string service = itr->first; 1245 uint8_t sessionState = 0; 1246 completionCode = getSessionState(ctx, service, objectPath, 1247 sessionState); 1248 if (completionCode) 1249 { 1250 return ipmi::response(completionCode); 1251 } 1252 1253 if (sessionState == static_cast<uint8_t>(session::State::active)) 1254 { 1255 activeSessionCount++; 1256 } 1257 1258 if (index == sessionIndex || reqSessionId == sessionId || 1259 reqSessionHandle == sessionHandle) 1260 { 1261 SessionDetails details{}; 1262 completionCode = getSessionDetails(ctx, service, objectPath, 1263 sessionHandle, state, details); 1264 1265 if (completionCode) 1266 { 1267 return ipmi::response(completionCode); 1268 } 1269 activeSessionHandle = sessionHandle; 1270 maybeDetails = std::move(details); 1271 } 1272 } 1273 1274 if (state == static_cast<uint8_t>(session::State::active) || 1275 state == static_cast<uint8_t>(session::State::tearDownInProgress)) 1276 { 1277 return ipmi::responseSuccess(activeSessionHandle, totalSessionCount, 1278 activeSessionCount, maybeDetails); 1279 } 1280 1281 return ipmi::responseInvalidFieldRequest(); 1282 } 1283 1284 static std::unique_ptr<SysInfoParamStore> sysInfoParamStore; 1285 1286 static std::string sysInfoReadSystemName() 1287 { 1288 // Use the BMC hostname as the "System Name." 1289 char hostname[HOST_NAME_MAX + 1] = {}; 1290 if (gethostname(hostname, HOST_NAME_MAX) != 0) 1291 { 1292 perror("System info parameter: system name"); 1293 } 1294 return hostname; 1295 } 1296 1297 static constexpr uint8_t paramRevision = 0x11; 1298 static constexpr size_t configParameterLength = 16; 1299 1300 static constexpr size_t smallChunkSize = 14; 1301 static constexpr size_t fullChunkSize = 16; 1302 static constexpr uint8_t progressMask = 0x3; 1303 1304 static constexpr uint8_t setComplete = 0x0; 1305 static constexpr uint8_t setInProgress = 0x1; 1306 static constexpr uint8_t commitWrite = 0x2; 1307 static uint8_t transferStatus = setComplete; 1308 1309 static constexpr uint8_t configDataOverhead = 2; 1310 1311 // For EFI based system, 256 bytes is recommended. 1312 static constexpr size_t maxBytesPerParameter = 256; 1313 1314 namespace ipmi 1315 { 1316 constexpr Cc ccParmNotSupported = 0x80; 1317 constexpr Cc ccSetInProgressActive = 0x81; 1318 constexpr Cc ccSystemInfoParameterSetReadOnly = 0x82; 1319 1320 static inline auto responseParmNotSupported() 1321 { 1322 return response(ccParmNotSupported); 1323 } 1324 static inline auto responseSetInProgressActive() 1325 { 1326 return response(ccSetInProgressActive); 1327 } 1328 static inline auto responseSystemInfoParameterSetReadOnly() 1329 { 1330 return response(ccSystemInfoParameterSetReadOnly); 1331 } 1332 } // namespace ipmi 1333 1334 ipmi::RspType<uint8_t, // Parameter revision 1335 std::optional<uint8_t>, // data1 / setSelector / ProgressStatus 1336 std::optional<std::vector<uint8_t>>> // data2-17 1337 ipmiAppGetSystemInfo(uint7_t reserved, bool getRevision, 1338 uint8_t paramSelector, uint8_t setSelector, 1339 uint8_t BlockSelector) 1340 { 1341 if (reserved || (paramSelector >= invalidParamSelectorStart && 1342 paramSelector <= invalidParamSelectorEnd)) 1343 { 1344 return ipmi::responseInvalidFieldRequest(); 1345 } 1346 if ((paramSelector >= oemCmdStart) && (paramSelector <= oemCmdEnd)) 1347 { 1348 return ipmi::responseParmNotSupported(); 1349 } 1350 if (getRevision) 1351 { 1352 return ipmi::responseSuccess(paramRevision, std::nullopt, std::nullopt); 1353 } 1354 1355 if (paramSelector == 0) 1356 { 1357 return ipmi::responseSuccess(paramRevision, transferStatus, 1358 std::nullopt); 1359 } 1360 1361 if (BlockSelector != 0) // 00h if parameter does not require a block number 1362 { 1363 return ipmi::responseParmNotSupported(); 1364 } 1365 1366 if (sysInfoParamStore == nullptr) 1367 { 1368 sysInfoParamStore = std::make_unique<SysInfoParamStore>(); 1369 sysInfoParamStore->update(IPMI_SYSINFO_SYSTEM_NAME, 1370 sysInfoReadSystemName); 1371 } 1372 1373 // Parameters other than Set In Progress are assumed to be strings. 1374 std::tuple<bool, std::string> ret = 1375 sysInfoParamStore->lookup(paramSelector); 1376 bool found = std::get<0>(ret); 1377 if (!found) 1378 { 1379 return ipmi::responseSensorInvalid(); 1380 } 1381 std::string& paramString = std::get<1>(ret); 1382 std::vector<uint8_t> configData; 1383 size_t count = 0; 1384 if (setSelector == 0) 1385 { // First chunk has only 14 bytes. 1386 configData.emplace_back(0); // encoding 1387 configData.emplace_back(paramString.length()); // string length 1388 count = std::min(paramString.length(), smallChunkSize); 1389 configData.resize(count + configDataOverhead); 1390 std::copy_n(paramString.begin(), count, 1391 configData.begin() + configDataOverhead); // 14 bytes chunk 1392 1393 // Append zero's to remaining bytes 1394 if (configData.size() < configParameterLength) 1395 { 1396 std::fill_n(std::back_inserter(configData), 1397 configParameterLength - configData.size(), 0x00); 1398 } 1399 } 1400 else 1401 { 1402 size_t offset = (setSelector * fullChunkSize) - configDataOverhead; 1403 if (offset >= paramString.length()) 1404 { 1405 return ipmi::responseParmOutOfRange(); 1406 } 1407 count = std::min(paramString.length() - offset, fullChunkSize); 1408 configData.resize(count); 1409 std::copy_n(paramString.begin() + offset, count, 1410 configData.begin()); // 16 bytes chunk 1411 } 1412 return ipmi::responseSuccess(paramRevision, setSelector, configData); 1413 } 1414 1415 ipmi::RspType<> ipmiAppSetSystemInfo(uint8_t paramSelector, uint8_t data1, 1416 std::vector<uint8_t> configData) 1417 { 1418 if (paramSelector >= invalidParamSelectorStart && 1419 paramSelector <= invalidParamSelectorEnd) 1420 { 1421 return ipmi::responseInvalidFieldRequest(); 1422 } 1423 if ((paramSelector >= oemCmdStart) && (paramSelector <= oemCmdEnd)) 1424 { 1425 return ipmi::responseParmNotSupported(); 1426 } 1427 1428 if (paramSelector == 0) 1429 { 1430 // attempt to set the 'set in progress' value (in parameter #0) 1431 // when not in the set complete state. 1432 if ((transferStatus != setComplete) && (data1 == setInProgress)) 1433 { 1434 return ipmi::responseSetInProgressActive(); 1435 } 1436 // only following 2 states are supported 1437 if (data1 > setInProgress) 1438 { 1439 phosphor::logging::log<phosphor::logging::level::ERR>( 1440 "illegal SetInProgress status"); 1441 return ipmi::responseInvalidFieldRequest(); 1442 } 1443 1444 transferStatus = data1 & progressMask; 1445 return ipmi::responseSuccess(); 1446 } 1447 1448 if (configData.size() > configParameterLength) 1449 { 1450 return ipmi::responseInvalidFieldRequest(); 1451 } 1452 1453 // Append zero's to remaining bytes 1454 if (configData.size() < configParameterLength) 1455 { 1456 fill_n(back_inserter(configData), 1457 (configParameterLength - configData.size()), 0x00); 1458 } 1459 1460 if (!sysInfoParamStore) 1461 { 1462 sysInfoParamStore = std::make_unique<SysInfoParamStore>(); 1463 sysInfoParamStore->update(IPMI_SYSINFO_SYSTEM_NAME, 1464 sysInfoReadSystemName); 1465 } 1466 1467 // lookup 1468 std::tuple<bool, std::string> ret = 1469 sysInfoParamStore->lookup(paramSelector); 1470 bool found = std::get<0>(ret); 1471 std::string& paramString = std::get<1>(ret); 1472 if (!found) 1473 { 1474 // parameter does not exist. Init new 1475 paramString = ""; 1476 } 1477 1478 uint8_t setSelector = data1; 1479 size_t count = 0; 1480 if (setSelector == 0) // First chunk has only 14 bytes. 1481 { 1482 size_t stringLen = configData.at(1); // string length 1483 // maxBytesPerParamter is 256. It will always be greater than stringLen 1484 // (unit8_t) if maxBytes changes in future, then following line is 1485 // needed. 1486 // stringLen = std::min(stringLen, maxBytesPerParameter); 1487 count = std::min(stringLen, smallChunkSize); 1488 count = std::min(count, configData.size()); 1489 paramString.resize(stringLen); // reserve space 1490 std::copy_n(configData.begin() + configDataOverhead, count, 1491 paramString.begin()); 1492 } 1493 else 1494 { 1495 size_t offset = (setSelector * fullChunkSize) - configDataOverhead; 1496 if (offset >= paramString.length()) 1497 { 1498 return ipmi::responseParmOutOfRange(); 1499 } 1500 count = std::min(paramString.length() - offset, configData.size()); 1501 std::copy_n(configData.begin(), count, paramString.begin() + offset); 1502 } 1503 sysInfoParamStore->update(paramSelector, paramString); 1504 return ipmi::responseSuccess(); 1505 } 1506 1507 #ifdef ENABLE_I2C_WHITELIST_CHECK 1508 inline std::vector<uint8_t> convertStringToData(const std::string& command) 1509 { 1510 std::istringstream iss(command); 1511 std::string token; 1512 std::vector<uint8_t> dataValue; 1513 while (std::getline(iss, token, ' ')) 1514 { 1515 dataValue.emplace_back( 1516 static_cast<uint8_t>(std::stoul(token, nullptr, base_16))); 1517 } 1518 return dataValue; 1519 } 1520 1521 static bool populateI2CMasterWRWhitelist() 1522 { 1523 nlohmann::json data = nullptr; 1524 std::ifstream jsonFile(i2cMasterWRWhitelistFile); 1525 1526 if (!jsonFile.good()) 1527 { 1528 log<level::WARNING>("i2c white list file not found!", 1529 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile)); 1530 return false; 1531 } 1532 1533 try 1534 { 1535 data = nlohmann::json::parse(jsonFile, nullptr, false); 1536 } 1537 catch (const nlohmann::json::parse_error& e) 1538 { 1539 log<level::ERR>("Corrupted i2c white list config file", 1540 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile), 1541 entry("MSG: %s", e.what())); 1542 return false; 1543 } 1544 1545 try 1546 { 1547 // Example JSON Structure format 1548 // "filters": [ 1549 // { 1550 // "Description": "Allow full read - ignore first byte write value 1551 // for 0x40 to 0x4F", 1552 // "busId": "0x01", 1553 // "slaveAddr": "0x40", 1554 // "slaveAddrMask": "0x0F", 1555 // "command": "0x00", 1556 // "commandMask": "0xFF" 1557 // }, 1558 // { 1559 // "Description": "Allow full read - first byte match 0x05 and 1560 // ignore second byte", 1561 // "busId": "0x01", 1562 // "slaveAddr": "0x57", 1563 // "slaveAddrMask": "0x00", 1564 // "command": "0x05 0x00", 1565 // "commandMask": "0x00 0xFF" 1566 // },] 1567 1568 nlohmann::json filters = data[filtersStr].get<nlohmann::json>(); 1569 std::vector<i2cMasterWRWhitelist>& whitelist = getWRWhitelist(); 1570 for (const auto& it : filters.items()) 1571 { 1572 nlohmann::json filter = it.value(); 1573 if (filter.is_null()) 1574 { 1575 log<level::ERR>( 1576 "Corrupted I2C master write read whitelist config file", 1577 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile)); 1578 return false; 1579 } 1580 const std::vector<uint8_t>& writeData = 1581 convertStringToData(filter[cmdStr].get<std::string>()); 1582 const std::vector<uint8_t>& writeDataMask = 1583 convertStringToData(filter[cmdMaskStr].get<std::string>()); 1584 if (writeDataMask.size() != writeData.size()) 1585 { 1586 log<level::ERR>("I2C master write read whitelist filter " 1587 "mismatch for command & mask size"); 1588 return false; 1589 } 1590 whitelist.push_back( 1591 {static_cast<uint8_t>(std::stoul( 1592 filter[busIdStr].get<std::string>(), nullptr, base_16)), 1593 static_cast<uint8_t>( 1594 std::stoul(filter[slaveAddrStr].get<std::string>(), 1595 nullptr, base_16)), 1596 static_cast<uint8_t>( 1597 std::stoul(filter[slaveAddrMaskStr].get<std::string>(), 1598 nullptr, base_16)), 1599 writeData, writeDataMask}); 1600 } 1601 if (whitelist.size() != filters.size()) 1602 { 1603 log<level::ERR>( 1604 "I2C master write read whitelist filter size mismatch"); 1605 return false; 1606 } 1607 } 1608 catch (const std::exception& e) 1609 { 1610 log<level::ERR>("I2C master write read whitelist unexpected exception", 1611 entry("ERROR=%s", e.what())); 1612 return false; 1613 } 1614 return true; 1615 } 1616 1617 static inline bool isWriteDataWhitelisted(const std::vector<uint8_t>& data, 1618 const std::vector<uint8_t>& dataMask, 1619 const std::vector<uint8_t>& writeData) 1620 { 1621 std::vector<uint8_t> processedDataBuf(data.size()); 1622 std::vector<uint8_t> processedReqBuf(dataMask.size()); 1623 std::transform(writeData.begin(), writeData.end(), dataMask.begin(), 1624 processedReqBuf.begin(), std::bit_or<uint8_t>()); 1625 std::transform(data.begin(), data.end(), dataMask.begin(), 1626 processedDataBuf.begin(), std::bit_or<uint8_t>()); 1627 1628 return (processedDataBuf == processedReqBuf); 1629 } 1630 1631 static bool isCmdWhitelisted(uint8_t busId, uint8_t slaveAddr, 1632 std::vector<uint8_t>& writeData) 1633 { 1634 std::vector<i2cMasterWRWhitelist>& whiteList = getWRWhitelist(); 1635 for (const auto& wlEntry : whiteList) 1636 { 1637 if ((busId == wlEntry.busId) && 1638 ((slaveAddr | wlEntry.slaveAddrMask) == 1639 (wlEntry.slaveAddr | wlEntry.slaveAddrMask))) 1640 { 1641 const std::vector<uint8_t>& dataMask = wlEntry.dataMask; 1642 // Skip as no-match, if requested write data is more than the 1643 // write data mask size 1644 if (writeData.size() > dataMask.size()) 1645 { 1646 continue; 1647 } 1648 if (isWriteDataWhitelisted(wlEntry.data, dataMask, writeData)) 1649 { 1650 return true; 1651 } 1652 } 1653 } 1654 return false; 1655 } 1656 #else 1657 static bool populateI2CMasterWRWhitelist() 1658 { 1659 log<level::INFO>( 1660 "I2C_WHITELIST_CHECK is disabled, do not populate whitelist"); 1661 return true; 1662 } 1663 #endif // ENABLE_I2C_WHITELIST_CHECK 1664 1665 /** @brief implements master write read IPMI command which can be used for 1666 * low-level I2C/SMBus write, read or write-read access 1667 * @param isPrivateBus -to indicate private bus usage 1668 * @param busId - bus id 1669 * @param channelNum - channel number 1670 * @param reserved - skip 1 bit 1671 * @param slaveAddr - slave address 1672 * @param read count - number of bytes to be read 1673 * @param writeData - data to be written 1674 * 1675 * @returns IPMI completion code plus response data 1676 * - readData - i2c response data 1677 */ 1678 ipmi::RspType<std::vector<uint8_t>> 1679 ipmiMasterWriteRead([[maybe_unused]] bool isPrivateBus, uint3_t busId, 1680 [[maybe_unused]] uint4_t channelNum, bool reserved, 1681 uint7_t slaveAddr, uint8_t readCount, 1682 std::vector<uint8_t> writeData) 1683 { 1684 if (reserved) 1685 { 1686 return ipmi::responseInvalidFieldRequest(); 1687 } 1688 if (readCount > maxIPMIWriteReadSize) 1689 { 1690 log<level::ERR>("Master write read command: Read count exceeds limit"); 1691 return ipmi::responseParmOutOfRange(); 1692 } 1693 const size_t writeCount = writeData.size(); 1694 if (!readCount && !writeCount) 1695 { 1696 log<level::ERR>("Master write read command: Read & write count are 0"); 1697 return ipmi::responseInvalidFieldRequest(); 1698 } 1699 #ifdef ENABLE_I2C_WHITELIST_CHECK 1700 if (!isCmdWhitelisted(static_cast<uint8_t>(busId), 1701 static_cast<uint8_t>(slaveAddr), writeData)) 1702 { 1703 log<level::ERR>("Master write read request blocked!", 1704 entry("BUS=%d", static_cast<uint8_t>(busId)), 1705 entry("ADDR=0x%x", static_cast<uint8_t>(slaveAddr))); 1706 return ipmi::responseInvalidFieldRequest(); 1707 } 1708 #endif // ENABLE_I2C_WHITELIST_CHECK 1709 std::vector<uint8_t> readBuf(readCount); 1710 std::string i2cBus = "/dev/i2c-" + 1711 std::to_string(static_cast<uint8_t>(busId)); 1712 1713 ipmi::Cc ret = ipmi::i2cWriteRead(i2cBus, static_cast<uint8_t>(slaveAddr), 1714 writeData, readBuf); 1715 if (ret != ipmi::ccSuccess) 1716 { 1717 return ipmi::response(ret); 1718 } 1719 return ipmi::responseSuccess(readBuf); 1720 } 1721 1722 void register_netfn_app_functions() 1723 { 1724 // <Get Device ID> 1725 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1726 ipmi::app::cmdGetDeviceId, ipmi::Privilege::User, 1727 ipmiAppGetDeviceId); 1728 1729 // <Get BT Interface Capabilities> 1730 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1731 ipmi::app::cmdGetBtIfaceCapabilities, 1732 ipmi::Privilege::User, ipmiAppGetBtCapabilities); 1733 1734 // <Reset Watchdog Timer> 1735 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1736 ipmi::app::cmdResetWatchdogTimer, 1737 ipmi::Privilege::Operator, ipmiAppResetWatchdogTimer); 1738 1739 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1740 ipmi::app::cmdGetSessionInfo, ipmi::Privilege::User, 1741 ipmiAppGetSessionInfo); 1742 1743 // <Set Watchdog Timer> 1744 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1745 ipmi::app::cmdSetWatchdogTimer, 1746 ipmi::Privilege::Operator, ipmiSetWatchdogTimer); 1747 1748 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1749 ipmi::app::cmdCloseSession, ipmi::Privilege::Callback, 1750 ipmiAppCloseSession); 1751 1752 // <Get Watchdog Timer> 1753 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1754 ipmi::app::cmdGetWatchdogTimer, ipmi::Privilege::User, 1755 ipmiGetWatchdogTimer); 1756 1757 // <Get Self Test Results> 1758 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1759 ipmi::app::cmdGetSelfTestResults, 1760 ipmi::Privilege::User, ipmiAppGetSelfTestResults); 1761 1762 // <Get Device GUID> 1763 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1764 ipmi::app::cmdGetDeviceGuid, ipmi::Privilege::User, 1765 ipmiAppGetDeviceGuid); 1766 1767 // <Set ACPI Power State> 1768 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1769 ipmi::app::cmdSetAcpiPowerState, 1770 ipmi::Privilege::Admin, ipmiSetAcpiPowerState); 1771 // <Get ACPI Power State> 1772 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1773 ipmi::app::cmdGetAcpiPowerState, 1774 ipmi::Privilege::User, ipmiGetAcpiPowerState); 1775 1776 // Note: For security reason, this command will be registered only when 1777 // there are proper I2C Master write read whitelist 1778 if (populateI2CMasterWRWhitelist()) 1779 { 1780 // Note: For security reasons, registering master write read as admin 1781 // privilege command, even though IPMI 2.0 specification allows it as 1782 // operator privilege. 1783 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1784 ipmi::app::cmdMasterWriteRead, 1785 ipmi::Privilege::Admin, ipmiMasterWriteRead); 1786 } 1787 1788 // <Get System GUID Command> 1789 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1790 ipmi::app::cmdGetSystemGuid, ipmi::Privilege::User, 1791 ipmiAppGetSystemGuid); 1792 1793 // <Get Channel Cipher Suites Command> 1794 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1795 ipmi::app::cmdGetChannelCipherSuites, 1796 ipmi::Privilege::None, getChannelCipherSuites); 1797 1798 // <Get System Info Command> 1799 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1800 ipmi::app::cmdGetSystemInfoParameters, 1801 ipmi::Privilege::User, ipmiAppGetSystemInfo); 1802 // <Set System Info Command> 1803 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp, 1804 ipmi::app::cmdSetSystemInfoParameters, 1805 ipmi::Privilege::Admin, ipmiAppSetSystemInfo); 1806 return; 1807 } 1808