1 #include "config.h" 2 3 #include "sensorhandler.hpp" 4 5 #include "entity_map_json.hpp" 6 #include "fruread.hpp" 7 8 #include <mapper.h> 9 #include <systemd/sd-bus.h> 10 11 #include <bitset> 12 #include <cmath> 13 #include <cstring> 14 #include <ipmid/api.hpp> 15 #include <ipmid/types.hpp> 16 #include <ipmid/utils.hpp> 17 #include <phosphor-logging/elog-errors.hpp> 18 #include <phosphor-logging/log.hpp> 19 #include <sdbusplus/message/types.hpp> 20 #include <set> 21 #include <xyz/openbmc_project/Common/error.hpp> 22 #include <xyz/openbmc_project/Sensor/Value/server.hpp> 23 24 static constexpr uint8_t fruInventoryDevice = 0x10; 25 static constexpr uint8_t IPMIFruInventory = 0x02; 26 static constexpr uint8_t BMCSlaveAddress = 0x20; 27 28 extern int updateSensorRecordFromSSRAESC(const void*); 29 extern sd_bus* bus; 30 31 namespace ipmi 32 { 33 namespace sensor 34 { 35 extern const IdInfoMap sensors; 36 } // namespace sensor 37 } // namespace ipmi 38 39 extern const FruMap frus; 40 41 using namespace phosphor::logging; 42 using InternalFailure = 43 sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure; 44 45 void register_netfn_sen_functions() __attribute__((constructor)); 46 47 struct sensorTypemap_t 48 { 49 uint8_t number; 50 uint8_t typecode; 51 char dbusname[32]; 52 }; 53 54 sensorTypemap_t g_SensorTypeMap[] = { 55 56 {0x01, 0x6F, "Temp"}, 57 {0x0C, 0x6F, "DIMM"}, 58 {0x0C, 0x6F, "MEMORY_BUFFER"}, 59 {0x07, 0x6F, "PROC"}, 60 {0x07, 0x6F, "CORE"}, 61 {0x07, 0x6F, "CPU"}, 62 {0x0F, 0x6F, "BootProgress"}, 63 {0xe9, 0x09, "OccStatus"}, // E9 is an internal mapping to handle sensor 64 // type code os 0x09 65 {0xC3, 0x6F, "BootCount"}, 66 {0x1F, 0x6F, "OperatingSystemStatus"}, 67 {0x12, 0x6F, "SYSTEM_EVENT"}, 68 {0xC7, 0x03, "SYSTEM"}, 69 {0xC7, 0x03, "MAIN_PLANAR"}, 70 {0xC2, 0x6F, "PowerCap"}, 71 {0x0b, 0xCA, "PowerSupplyRedundancy"}, 72 {0xDA, 0x03, "TurboAllowed"}, 73 {0xD8, 0xC8, "PowerSupplyDerating"}, 74 {0xFF, 0x00, ""}, 75 }; 76 77 struct sensor_data_t 78 { 79 uint8_t sennum; 80 } __attribute__((packed)); 81 82 int get_bus_for_path(const char* path, char** busname) 83 { 84 return mapper_get_service(bus, path, busname); 85 } 86 87 // Use a lookup table to find the interface name of a specific sensor 88 // This will be used until an alternative is found. this is the first 89 // step for mapping IPMI 90 int find_openbmc_path(uint8_t num, dbus_interface_t* interface) 91 { 92 int rc; 93 94 const auto& sensor_it = ipmi::sensor::sensors.find(num); 95 if (sensor_it == ipmi::sensor::sensors.end()) 96 { 97 // The sensor map does not contain the sensor requested 98 return -EINVAL; 99 } 100 101 const auto& info = sensor_it->second; 102 103 char* busname = nullptr; 104 rc = get_bus_for_path(info.sensorPath.c_str(), &busname); 105 if (rc < 0) 106 { 107 std::fprintf(stderr, "Failed to get %s busname: %s\n", 108 info.sensorPath.c_str(), busname); 109 goto final; 110 } 111 112 interface->sensortype = info.sensorType; 113 strcpy(interface->bus, busname); 114 strcpy(interface->path, info.sensorPath.c_str()); 115 // Take the interface name from the beginning of the DbusInterfaceMap. This 116 // works for the Value interface but may not suffice for more complex 117 // sensors. 118 // tracked https://github.com/openbmc/phosphor-host-ipmid/issues/103 119 strcpy(interface->interface, 120 info.propertyInterfaces.begin()->first.c_str()); 121 interface->sensornumber = num; 122 123 final: 124 free(busname); 125 return rc; 126 } 127 128 ///////////////////////////////////////////////////////////////////// 129 // 130 // Routines used by ipmi commands wanting to interact on the dbus 131 // 132 ///////////////////////////////////////////////////////////////////// 133 int set_sensor_dbus_state_s(uint8_t number, const char* method, 134 const char* value) 135 { 136 137 dbus_interface_t a; 138 int r; 139 sd_bus_error error = SD_BUS_ERROR_NULL; 140 sd_bus_message* m = NULL; 141 142 r = find_openbmc_path(number, &a); 143 144 if (r < 0) 145 { 146 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number); 147 return 0; 148 } 149 150 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface, 151 method); 152 if (r < 0) 153 { 154 std::fprintf(stderr, "Failed to create a method call: %s", 155 strerror(-r)); 156 goto final; 157 } 158 159 r = sd_bus_message_append(m, "v", "s", value); 160 if (r < 0) 161 { 162 std::fprintf(stderr, "Failed to create a input parameter: %s", 163 strerror(-r)); 164 goto final; 165 } 166 167 r = sd_bus_call(bus, m, 0, &error, NULL); 168 if (r < 0) 169 { 170 std::fprintf(stderr, "Failed to call the method: %s", strerror(-r)); 171 } 172 173 final: 174 sd_bus_error_free(&error); 175 m = sd_bus_message_unref(m); 176 177 return 0; 178 } 179 int set_sensor_dbus_state_y(uint8_t number, const char* method, 180 const uint8_t value) 181 { 182 183 dbus_interface_t a; 184 int r; 185 sd_bus_error error = SD_BUS_ERROR_NULL; 186 sd_bus_message* m = NULL; 187 188 r = find_openbmc_path(number, &a); 189 190 if (r < 0) 191 { 192 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number); 193 return 0; 194 } 195 196 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface, 197 method); 198 if (r < 0) 199 { 200 std::fprintf(stderr, "Failed to create a method call: %s", 201 strerror(-r)); 202 goto final; 203 } 204 205 r = sd_bus_message_append(m, "v", "i", value); 206 if (r < 0) 207 { 208 std::fprintf(stderr, "Failed to create a input parameter: %s", 209 strerror(-r)); 210 goto final; 211 } 212 213 r = sd_bus_call(bus, m, 0, &error, NULL); 214 if (r < 0) 215 { 216 std::fprintf(stderr, "12 Failed to call the method: %s", strerror(-r)); 217 } 218 219 final: 220 sd_bus_error_free(&error); 221 m = sd_bus_message_unref(m); 222 223 return 0; 224 } 225 226 uint8_t dbus_to_sensor_type(char* p) 227 { 228 229 sensorTypemap_t* s = g_SensorTypeMap; 230 char r = 0; 231 while (s->number != 0xFF) 232 { 233 if (!strcmp(s->dbusname, p)) 234 { 235 r = s->typecode; 236 break; 237 } 238 s++; 239 } 240 241 if (s->number == 0xFF) 242 printf("Failed to find Sensor Type %s\n", p); 243 244 return r; 245 } 246 247 uint8_t get_type_from_interface(dbus_interface_t dbus_if) 248 { 249 250 uint8_t type; 251 252 // This is where sensors that do not exist in dbus but do 253 // exist in the host code stop. This should indicate it 254 // is not a supported sensor 255 if (dbus_if.interface[0] == 0) 256 { 257 return 0; 258 } 259 260 // Fetch type from interface itself. 261 if (dbus_if.sensortype != 0) 262 { 263 type = dbus_if.sensortype; 264 } 265 else 266 { 267 // Non InventoryItems 268 char* p = strrchr(dbus_if.path, '/'); 269 type = dbus_to_sensor_type(p + 1); 270 } 271 272 return type; 273 } 274 275 // Replaces find_sensor 276 uint8_t find_type_for_sensor_number(uint8_t num) 277 { 278 int r; 279 dbus_interface_t dbus_if; 280 r = find_openbmc_path(num, &dbus_if); 281 if (r < 0) 282 { 283 std::fprintf(stderr, "Could not find sensor %d\n", num); 284 return 0; 285 } 286 return get_type_from_interface(dbus_if); 287 } 288 289 /** 290 * @brief implements the get sensor type command. 291 * @param - sensorNumber 292 * 293 * @return IPMI completion code plus response data on success. 294 * - sensorType 295 * - eventType 296 **/ 297 298 ipmi::RspType<uint8_t, // sensorType 299 uint8_t // eventType 300 > 301 ipmiGetSensorType(uint8_t sensorNumber) 302 { 303 uint8_t sensorType = find_type_for_sensor_number(sensorNumber); 304 305 if (sensorType == 0) 306 { 307 return ipmi::responseSensorInvalid(); 308 } 309 310 constexpr uint8_t eventType = 0x6F; 311 return ipmi::responseSuccess(sensorType, eventType); 312 } 313 314 const std::set<std::string> analogSensorInterfaces = { 315 "xyz.openbmc_project.Sensor.Value", 316 "xyz.openbmc_project.Control.FanPwm", 317 }; 318 319 bool isAnalogSensor(const std::string& interface) 320 { 321 return (analogSensorInterfaces.count(interface)); 322 } 323 324 /** 325 @brief This command is used to set sensorReading. 326 327 @param 328 - sensorNumber 329 - operation 330 - reading 331 - assertOffset0_7 332 - assertOffset8_14 333 - deassertOffset0_7 334 - deassertOffset8_14 335 - eventData1 336 - eventData2 337 - eventData3 338 339 @return completion code on success. 340 **/ 341 342 ipmi::RspType<> ipmiSetSensorReading(uint8_t sensorNumber, uint8_t operation, 343 uint8_t reading, uint8_t assertOffset0_7, 344 uint8_t assertOffset8_14, 345 uint8_t deassertOffset0_7, 346 uint8_t deassertOffset8_14, 347 uint8_t eventData1, uint8_t eventData2, 348 uint8_t eventData3) 349 { 350 log<level::DEBUG>("IPMI SET_SENSOR", 351 entry("SENSOR_NUM=0x%02x", sensorNumber)); 352 353 if (sensorNumber == 0xFF) 354 { 355 return ipmi::responseInvalidFieldRequest(); 356 } 357 ipmi::sensor::SetSensorReadingReq cmdData; 358 359 cmdData.number = sensorNumber; 360 cmdData.operation = operation; 361 cmdData.reading = reading; 362 cmdData.assertOffset0_7 = assertOffset0_7; 363 cmdData.assertOffset8_14 = assertOffset8_14; 364 cmdData.deassertOffset0_7 = deassertOffset0_7; 365 cmdData.deassertOffset8_14 = deassertOffset8_14; 366 cmdData.eventData1 = eventData1; 367 cmdData.eventData2 = eventData2; 368 cmdData.eventData3 = eventData3; 369 370 // Check if the Sensor Number is present 371 const auto iter = ipmi::sensor::sensors.find(sensorNumber); 372 if (iter == ipmi::sensor::sensors.end()) 373 { 374 updateSensorRecordFromSSRAESC(&sensorNumber); 375 return ipmi::responseSuccess(); 376 } 377 378 try 379 { 380 if (ipmi::sensor::Mutability::Write != 381 (iter->second.mutability & ipmi::sensor::Mutability::Write)) 382 { 383 log<level::ERR>("Sensor Set operation is not allowed", 384 entry("SENSOR_NUM=%d", sensorNumber)); 385 return ipmi::responseIllegalCommand(); 386 } 387 auto ipmiRC = iter->second.updateFunc(cmdData, iter->second); 388 return ipmi::response(ipmiRC); 389 } 390 catch (const InternalFailure& e) 391 { 392 log<level::ERR>("Set sensor failed", 393 entry("SENSOR_NUM=%d", sensorNumber)); 394 commit<InternalFailure>(); 395 return ipmi::responseUnspecifiedError(); 396 } 397 catch (const std::runtime_error& e) 398 { 399 log<level::ERR>(e.what()); 400 return ipmi::responseUnspecifiedError(); 401 } 402 } 403 404 /** @brief implements the get sensor reading command 405 * @param sensorNum - sensor number 406 * 407 * @returns IPMI completion code plus response data 408 * - senReading - sensor reading 409 * - reserved 410 * - readState - sensor reading state enabled 411 * - senScanState - sensor scan state disabled 412 * - allEventMessageState - all Event message state disabled 413 * - assertionStatesLsb - threshold levels states 414 * - assertionStatesMsb - discrete reading sensor states 415 */ 416 ipmi::RspType<uint8_t, // sensor reading 417 418 uint5_t, // reserved 419 bool, // reading state 420 bool, // 0 = sensor scanning state disabled 421 bool, // 0 = all event messages disabled 422 423 uint8_t, // threshold levels states 424 uint8_t // discrete reading sensor states 425 > 426 ipmiSensorGetSensorReading(uint8_t sensorNum) 427 { 428 if (sensorNum == 0xFF) 429 { 430 return ipmi::responseInvalidFieldRequest(); 431 } 432 433 const auto iter = ipmi::sensor::sensors.find(sensorNum); 434 if (iter == ipmi::sensor::sensors.end()) 435 { 436 return ipmi::responseSensorInvalid(); 437 } 438 if (ipmi::sensor::Mutability::Read != 439 (iter->second.mutability & ipmi::sensor::Mutability::Read)) 440 { 441 return ipmi::responseIllegalCommand(); 442 } 443 444 try 445 { 446 ipmi::sensor::GetSensorResponse getResponse = 447 iter->second.getFunc(iter->second); 448 449 return ipmi::responseSuccess(getResponse.reading, uint5_t(0), 450 getResponse.readingOrStateUnavailable, 451 getResponse.scanningEnabled, 452 getResponse.allEventMessagesEnabled, 453 getResponse.thresholdLevelsStates, 454 getResponse.discreteReadingSensorStates); 455 } 456 #ifdef UPDATE_FUNCTIONAL_ON_FAIL 457 catch (const SensorFunctionalError& e) 458 { 459 return ipmi::responseResponseError(); 460 } 461 #endif 462 catch (const std::exception& e) 463 { 464 // Intitilizing with default values 465 constexpr uint8_t senReading = 0; 466 constexpr uint5_t reserved{0}; 467 constexpr bool readState = true; 468 constexpr bool senScanState = false; 469 constexpr bool allEventMessageState = false; 470 constexpr uint8_t assertionStatesLsb = 0; 471 constexpr uint8_t assertionStatesMsb = 0; 472 473 return ipmi::responseSuccess(senReading, reserved, readState, 474 senScanState, allEventMessageState, 475 assertionStatesLsb, assertionStatesMsb); 476 } 477 } 478 479 get_sdr::GetSensorThresholdsResponse 480 getSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum) 481 { 482 get_sdr::GetSensorThresholdsResponse resp{}; 483 constexpr auto warningThreshIntf = 484 "xyz.openbmc_project.Sensor.Threshold.Warning"; 485 constexpr auto criticalThreshIntf = 486 "xyz.openbmc_project.Sensor.Threshold.Critical"; 487 488 const auto iter = ipmi::sensor::sensors.find(sensorNum); 489 const auto info = iter->second; 490 491 std::string service; 492 boost::system::error_code ec; 493 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service); 494 if (ec) 495 { 496 return resp; 497 } 498 499 ipmi::PropertyMap warnThresholds; 500 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath, 501 warningThreshIntf, warnThresholds); 502 if (!ec) 503 { 504 double warnLow = std::visit(ipmi::VariantToDoubleVisitor(), 505 warnThresholds["WarningLow"]); 506 double warnHigh = std::visit(ipmi::VariantToDoubleVisitor(), 507 warnThresholds["WarningHigh"]); 508 509 if (std::isfinite(warnLow)) 510 { 511 warnLow *= std::pow(10, info.scale - info.exponentR); 512 resp.lowerNonCritical = static_cast<uint8_t>( 513 (warnLow - info.scaledOffset) / info.coefficientM); 514 resp.validMask |= static_cast<uint8_t>( 515 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK); 516 } 517 518 if (std::isfinite(warnHigh)) 519 { 520 warnHigh *= std::pow(10, info.scale - info.exponentR); 521 resp.upperNonCritical = static_cast<uint8_t>( 522 (warnHigh - info.scaledOffset) / info.coefficientM); 523 resp.validMask |= static_cast<uint8_t>( 524 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK); 525 } 526 } 527 528 ipmi::PropertyMap critThresholds; 529 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath, 530 criticalThreshIntf, critThresholds); 531 if (!ec) 532 { 533 double critLow = std::visit(ipmi::VariantToDoubleVisitor(), 534 critThresholds["CriticalLow"]); 535 double critHigh = std::visit(ipmi::VariantToDoubleVisitor(), 536 critThresholds["CriticalHigh"]); 537 538 if (std::isfinite(critLow)) 539 { 540 critLow *= std::pow(10, info.scale - info.exponentR); 541 resp.lowerCritical = static_cast<uint8_t>( 542 (critLow - info.scaledOffset) / info.coefficientM); 543 resp.validMask |= static_cast<uint8_t>( 544 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK); 545 } 546 547 if (std::isfinite(critHigh)) 548 { 549 critHigh *= std::pow(10, info.scale - info.exponentR); 550 resp.upperCritical = static_cast<uint8_t>( 551 (critHigh - info.scaledOffset) / info.coefficientM); 552 resp.validMask |= static_cast<uint8_t>( 553 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK); 554 } 555 } 556 557 return resp; 558 } 559 560 /** @brief implements the get sensor thresholds command 561 * @param ctx - IPMI context pointer 562 * @param sensorNum - sensor number 563 * 564 * @returns IPMI completion code plus response data 565 * - validMask - threshold mask 566 * - lower non-critical threshold - IPMI messaging state 567 * - lower critical threshold - link authentication state 568 * - lower non-recoverable threshold - callback state 569 * - upper non-critical threshold 570 * - upper critical 571 * - upper non-recoverable 572 */ 573 ipmi::RspType<uint8_t, // validMask 574 uint8_t, // lowerNonCritical 575 uint8_t, // lowerCritical 576 uint8_t, // lowerNonRecoverable 577 uint8_t, // upperNonCritical 578 uint8_t, // upperCritical 579 uint8_t // upperNonRecoverable 580 > 581 ipmiSensorGetSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum) 582 { 583 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value"; 584 585 const auto iter = ipmi::sensor::sensors.find(sensorNum); 586 if (iter == ipmi::sensor::sensors.end()) 587 { 588 return ipmi::responseSensorInvalid(); 589 } 590 591 const auto info = iter->second; 592 593 // Proceed only if the sensor value interface is implemented. 594 if (info.propertyInterfaces.find(valueInterface) == 595 info.propertyInterfaces.end()) 596 { 597 // return with valid mask as 0 598 return ipmi::responseSuccess(); 599 } 600 601 get_sdr::GetSensorThresholdsResponse resp{}; 602 resp = getSensorThresholds(ctx, sensorNum); 603 604 return ipmi::responseSuccess(resp.validMask, resp.lowerNonCritical, 605 resp.lowerCritical, resp.lowerNonRecoverable, 606 resp.upperNonCritical, resp.upperCritical, 607 resp.upperNonRecoverable); 608 } 609 610 /** @brief implements the get SDR Info command 611 * @param count - Operation 612 * 613 * @returns IPMI completion code plus response data 614 * - sdrCount - sensor/SDR count 615 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag 616 */ 617 ipmi::RspType<uint8_t, // respcount 618 uint8_t // dynamic population flags 619 > 620 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count) 621 { 622 uint8_t sdrCount; 623 // multiple LUNs not supported. 624 constexpr uint8_t lunsAndDynamicPopulation = 1; 625 constexpr uint8_t getSdrCount = 0x01; 626 constexpr uint8_t getSensorCount = 0x00; 627 628 if (count.value_or(0) == getSdrCount) 629 { 630 // Get SDR count. This returns the total number of SDRs in the device. 631 const auto& entityRecords = 632 ipmi::sensor::EntityInfoMapContainer::getContainer() 633 ->getIpmiEntityRecords(); 634 sdrCount = 635 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size(); 636 } 637 else if (count.value_or(0) == getSensorCount) 638 { 639 // Get Sensor count. This returns the number of sensors 640 sdrCount = ipmi::sensor::sensors.size(); 641 } 642 else 643 { 644 return ipmi::responseInvalidCommandOnLun(); 645 } 646 647 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation); 648 } 649 650 /** @brief implements the reserve SDR command 651 * @returns IPMI completion code plus response data 652 * - reservationID - reservation ID 653 */ 654 ipmi::RspType<uint16_t> ipmiSensorReserveSdr() 655 { 656 // A constant reservation ID is okay until we implement add/remove SDR. 657 constexpr uint16_t reservationID = 1; 658 659 return ipmi::responseSuccess(reservationID); 660 } 661 662 void setUnitFieldsForObject(const ipmi::sensor::Info* info, 663 get_sdr::SensorDataFullRecordBody* body) 664 { 665 namespace server = sdbusplus::xyz::openbmc_project::Sensor::server; 666 try 667 { 668 auto unit = server::Value::convertUnitFromString(info->unit); 669 // Unit strings defined in 670 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml 671 switch (unit) 672 { 673 case server::Value::Unit::DegreesC: 674 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C; 675 break; 676 case server::Value::Unit::RPMS: 677 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM; 678 break; 679 case server::Value::Unit::Volts: 680 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS; 681 break; 682 case server::Value::Unit::Meters: 683 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS; 684 break; 685 case server::Value::Unit::Amperes: 686 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES; 687 break; 688 case server::Value::Unit::Joules: 689 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES; 690 break; 691 case server::Value::Unit::Watts: 692 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS; 693 break; 694 default: 695 // Cannot be hit. 696 std::fprintf(stderr, "Unknown value unit type: = %s\n", 697 info->unit.c_str()); 698 } 699 } 700 catch (const sdbusplus::exception::InvalidEnumString& e) 701 { 702 log<level::WARNING>("Warning: no unit provided for sensor!"); 703 } 704 } 705 706 ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body, 707 const ipmi::sensor::Info* info, 708 ipmi_data_len_t data_len) 709 { 710 /* Functional sensor case */ 711 if (isAnalogSensor(info->propertyInterfaces.begin()->first)) 712 { 713 body->sensor_units_1 = info->sensorUnits1; // default is 0. unsigned, no 714 // rate, no modifier, not a % 715 /* Unit info */ 716 setUnitFieldsForObject(info, body); 717 718 get_sdr::body::set_b(info->coefficientB, body); 719 get_sdr::body::set_m(info->coefficientM, body); 720 get_sdr::body::set_b_exp(info->exponentB, body); 721 get_sdr::body::set_r_exp(info->exponentR, body); 722 723 get_sdr::body::set_id_type(0b00, body); // 00 = unicode 724 } 725 726 /* ID string */ 727 auto id_string = info->sensorName; 728 729 if (id_string.empty()) 730 { 731 id_string = info->sensorNameFunc(*info); 732 } 733 734 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH) 735 { 736 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body); 737 } 738 else 739 { 740 get_sdr::body::set_id_strlen(id_string.length(), body); 741 } 742 strncpy(body->id_string, id_string.c_str(), 743 get_sdr::body::get_id_strlen(body)); 744 745 return IPMI_CC_OK; 746 }; 747 748 ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response, 749 ipmi_data_len_t data_len) 750 { 751 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request); 752 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response); 753 get_sdr::SensorDataFruRecord record{}; 754 auto dataLength = 0; 755 756 auto fru = frus.begin(); 757 uint8_t fruID{}; 758 auto recordID = get_sdr::request::get_record_id(req); 759 760 fruID = recordID - FRU_RECORD_ID_START; 761 fru = frus.find(fruID); 762 if (fru == frus.end()) 763 { 764 return IPMI_CC_SENSOR_INVALID; 765 } 766 767 /* Header */ 768 get_sdr::header::set_record_id(recordID, &(record.header)); 769 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1 770 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD; 771 record.header.record_length = sizeof(record.key) + sizeof(record.body); 772 773 /* Key */ 774 record.key.fruID = fruID; 775 record.key.accessLun |= IPMI_LOGICAL_FRU; 776 record.key.deviceAddress = BMCSlaveAddress; 777 778 /* Body */ 779 record.body.entityID = fru->second[0].entityID; 780 record.body.entityInstance = fru->second[0].entityInstance; 781 record.body.deviceType = fruInventoryDevice; 782 record.body.deviceTypeModifier = IPMIFruInventory; 783 784 /* Device ID string */ 785 auto deviceID = 786 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1, 787 fru->second[0].path.length()); 788 789 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH) 790 { 791 get_sdr::body::set_device_id_strlen( 792 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body)); 793 } 794 else 795 { 796 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body)); 797 } 798 799 strncpy(record.body.deviceID, deviceID.c_str(), 800 get_sdr::body::get_device_id_strlen(&(record.body))); 801 802 if (++fru == frus.end()) 803 { 804 // we have reached till end of fru, so assign the next record id to 805 // 512(Max fru ID = 511) + Entity Record ID(may start with 0). 806 const auto& entityRecords = 807 ipmi::sensor::EntityInfoMapContainer::getContainer() 808 ->getIpmiEntityRecords(); 809 auto next_record_id = 810 (entityRecords.size()) 811 ? entityRecords.begin()->first + ENTITY_RECORD_ID_START 812 : END_OF_RECORD; 813 get_sdr::response::set_next_record_id(next_record_id, resp); 814 } 815 else 816 { 817 get_sdr::response::set_next_record_id( 818 (FRU_RECORD_ID_START + fru->first), resp); 819 } 820 821 // Check for invalid offset size 822 if (req->offset > sizeof(record)) 823 { 824 return IPMI_CC_PARM_OUT_OF_RANGE; 825 } 826 827 dataLength = std::min(static_cast<size_t>(req->bytes_to_read), 828 sizeof(record) - req->offset); 829 830 std::memcpy(resp->record_data, 831 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength); 832 833 *data_len = dataLength; 834 *data_len += 2; // additional 2 bytes for next record ID 835 836 return IPMI_CC_OK; 837 } 838 839 ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response, 840 ipmi_data_len_t data_len) 841 { 842 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request); 843 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response); 844 get_sdr::SensorDataEntityRecord record{}; 845 auto dataLength = 0; 846 847 const auto& entityRecords = 848 ipmi::sensor::EntityInfoMapContainer::getContainer() 849 ->getIpmiEntityRecords(); 850 auto entity = entityRecords.begin(); 851 uint8_t entityRecordID; 852 auto recordID = get_sdr::request::get_record_id(req); 853 854 entityRecordID = recordID - ENTITY_RECORD_ID_START; 855 entity = entityRecords.find(entityRecordID); 856 if (entity == entityRecords.end()) 857 { 858 return IPMI_CC_SENSOR_INVALID; 859 } 860 861 /* Header */ 862 get_sdr::header::set_record_id(recordID, &(record.header)); 863 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1 864 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD; 865 record.header.record_length = sizeof(record.key) + sizeof(record.body); 866 867 /* Key */ 868 record.key.containerEntityId = entity->second.containerEntityId; 869 record.key.containerEntityInstance = entity->second.containerEntityInstance; 870 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked, 871 &(record.key)); 872 record.key.entityId1 = entity->second.containedEntities[0].first; 873 record.key.entityInstance1 = entity->second.containedEntities[0].second; 874 875 /* Body */ 876 record.body.entityId2 = entity->second.containedEntities[1].first; 877 record.body.entityInstance2 = entity->second.containedEntities[1].second; 878 record.body.entityId3 = entity->second.containedEntities[2].first; 879 record.body.entityInstance3 = entity->second.containedEntities[2].second; 880 record.body.entityId4 = entity->second.containedEntities[3].first; 881 record.body.entityInstance4 = entity->second.containedEntities[3].second; 882 883 if (++entity == entityRecords.end()) 884 { 885 get_sdr::response::set_next_record_id(END_OF_RECORD, 886 resp); // last record 887 } 888 else 889 { 890 get_sdr::response::set_next_record_id( 891 (ENTITY_RECORD_ID_START + entity->first), resp); 892 } 893 894 // Check for invalid offset size 895 if (req->offset > sizeof(record)) 896 { 897 return IPMI_CC_PARM_OUT_OF_RANGE; 898 } 899 900 dataLength = std::min(static_cast<size_t>(req->bytes_to_read), 901 sizeof(record) - req->offset); 902 903 std::memcpy(resp->record_data, 904 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength); 905 906 *data_len = dataLength; 907 *data_len += 2; // additional 2 bytes for next record ID 908 909 return IPMI_CC_OK; 910 } 911 912 ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t netfn, ipmi_cmd_t cmd, 913 ipmi_request_t request, ipmi_response_t response, 914 ipmi_data_len_t data_len, ipmi_context_t context) 915 { 916 ipmi_ret_t ret = IPMI_CC_OK; 917 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request; 918 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response; 919 get_sdr::SensorDataFullRecord record = {0}; 920 921 // Note: we use an iterator so we can provide the next ID at the end of 922 // the call. 923 auto sensor = ipmi::sensor::sensors.begin(); 924 auto recordID = get_sdr::request::get_record_id(req); 925 926 // At the beginning of a scan, the host side will send us id=0. 927 if (recordID != 0) 928 { 929 // recordID 0 to 255 means it is a FULL record. 930 // recordID 256 to 511 means it is a FRU record. 931 // recordID greater then 511 means it is a Entity Association 932 // record. Currently we are supporting three record types: FULL 933 // record, FRU record and Enttiy Association record. 934 if (recordID >= ENTITY_RECORD_ID_START) 935 { 936 return ipmi_entity_get_sdr(request, response, data_len); 937 } 938 else if (recordID >= FRU_RECORD_ID_START && 939 recordID < ENTITY_RECORD_ID_START) 940 { 941 return ipmi_fru_get_sdr(request, response, data_len); 942 } 943 else 944 { 945 sensor = ipmi::sensor::sensors.find(recordID); 946 if (sensor == ipmi::sensor::sensors.end()) 947 { 948 return IPMI_CC_SENSOR_INVALID; 949 } 950 } 951 } 952 953 uint8_t sensor_id = sensor->first; 954 955 /* Header */ 956 get_sdr::header::set_record_id(sensor_id, &(record.header)); 957 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1 958 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD; 959 record.header.record_length = sizeof(record.key) + sizeof(record.body); 960 961 /* Key */ 962 get_sdr::key::set_owner_id_bmc(&(record.key)); 963 record.key.sensor_number = sensor_id; 964 965 /* Body */ 966 record.body.entity_id = sensor->second.entityType; 967 record.body.sensor_type = sensor->second.sensorType; 968 record.body.event_reading_type = sensor->second.sensorReadingType; 969 record.body.entity_instance = sensor->second.instance; 970 if (ipmi::sensor::Mutability::Write == 971 (sensor->second.mutability & ipmi::sensor::Mutability::Write)) 972 { 973 get_sdr::body::init_settable_state(true, &(record.body)); 974 } 975 976 // Set the type-specific details given the DBus interface 977 ret = 978 populate_record_from_dbus(&(record.body), &(sensor->second), data_len); 979 980 if (++sensor == ipmi::sensor::sensors.end()) 981 { 982 // we have reached till end of sensor, so assign the next record id 983 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0). 984 auto next_record_id = (frus.size()) 985 ? frus.begin()->first + FRU_RECORD_ID_START 986 : END_OF_RECORD; 987 988 get_sdr::response::set_next_record_id(next_record_id, resp); 989 } 990 else 991 { 992 get_sdr::response::set_next_record_id(sensor->first, resp); 993 } 994 995 if (req->offset > sizeof(record)) 996 { 997 return IPMI_CC_PARM_OUT_OF_RANGE; 998 } 999 1000 // data_len will ultimately be the size of the record, plus 1001 // the size of the next record ID: 1002 *data_len = std::min(static_cast<size_t>(req->bytes_to_read), 1003 sizeof(record) - req->offset); 1004 1005 std::memcpy(resp->record_data, 1006 reinterpret_cast<uint8_t*>(&record) + req->offset, *data_len); 1007 1008 // data_len should include the LSB and MSB: 1009 *data_len += 1010 sizeof(resp->next_record_id_lsb) + sizeof(resp->next_record_id_msb); 1011 1012 return ret; 1013 } 1014 1015 static bool isFromSystemChannel() 1016 { 1017 // TODO we could not figure out where the request is from based on IPMI 1018 // command handler parameters. because of it, we can not differentiate 1019 // request from SMS/SMM or IPMB channel 1020 return true; 1021 } 1022 1023 ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t netfn, ipmi_cmd_t cmd, 1024 ipmi_request_t request, 1025 ipmi_response_t response, 1026 ipmi_data_len_t dataLen, ipmi_context_t context) 1027 { 1028 uint16_t generatorID; 1029 size_t count; 1030 bool assert = true; 1031 std::string sensorPath; 1032 size_t paraLen = *dataLen; 1033 PlatformEventRequest* req; 1034 *dataLen = 0; 1035 1036 if ((paraLen < selSystemEventSizeWith1Bytes) || 1037 (paraLen > selSystemEventSizeWith3Bytes)) 1038 { 1039 return IPMI_CC_REQ_DATA_LEN_INVALID; 1040 } 1041 1042 if (isFromSystemChannel()) 1043 { // first byte for SYSTEM Interface is Generator ID 1044 // +1 to get common struct 1045 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1); 1046 // Capture the generator ID 1047 generatorID = *reinterpret_cast<uint8_t*>(request); 1048 // Platform Event usually comes from other firmware, like BIOS. 1049 // Unlike BMC sensor, it does not have BMC DBUS sensor path. 1050 sensorPath = "System"; 1051 } 1052 else 1053 { 1054 req = reinterpret_cast<PlatformEventRequest*>(request); 1055 // TODO GenratorID for IPMB is combination of RqSA and RqLUN 1056 generatorID = 0xff; 1057 sensorPath = "IPMB"; 1058 } 1059 // Content of event data field depends on sensor class. 1060 // When data0 bit[5:4] is non-zero, valid data counts is 3. 1061 // When data0 bit[7:6] is non-zero, valid data counts is 2. 1062 if (((req->data[0] & byte3EnableMask) != 0 && 1063 paraLen < selSystemEventSizeWith3Bytes) || 1064 ((req->data[0] & byte2EnableMask) != 0 && 1065 paraLen < selSystemEventSizeWith2Bytes)) 1066 { 1067 return IPMI_CC_REQ_DATA_LEN_INVALID; 1068 } 1069 1070 // Count bytes of Event Data 1071 if ((req->data[0] & byte3EnableMask) != 0) 1072 { 1073 count = 3; 1074 } 1075 else if ((req->data[0] & byte2EnableMask) != 0) 1076 { 1077 count = 2; 1078 } 1079 else 1080 { 1081 count = 1; 1082 } 1083 assert = req->eventDirectionType & directionMask ? false : true; 1084 std::vector<uint8_t> eventData(req->data, req->data + count); 1085 1086 sdbusplus::bus::bus dbus(bus); 1087 std::string service = 1088 ipmi::getService(dbus, ipmiSELAddInterface, ipmiSELPath); 1089 sdbusplus::message::message writeSEL = dbus.new_method_call( 1090 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd"); 1091 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert, 1092 generatorID); 1093 try 1094 { 1095 dbus.call(writeSEL); 1096 } 1097 catch (const sdbusplus::exception_t& e) 1098 { 1099 phosphor::logging::log<phosphor::logging::level::ERR>(e.what()); 1100 return IPMI_CC_UNSPECIFIED_ERROR; 1101 } 1102 return IPMI_CC_OK; 1103 } 1104 1105 void register_netfn_sen_functions() 1106 { 1107 // <Platform Event Message> 1108 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr, 1109 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR); 1110 1111 // <Get Sensor Type> 1112 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1113 ipmi::sensor_event::cmdGetSensorType, 1114 ipmi::Privilege::User, ipmiGetSensorType); 1115 1116 // <Set Sensor Reading and Event Status> 1117 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1118 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts, 1119 ipmi::Privilege::Operator, ipmiSetSensorReading); 1120 // <Get Sensor Reading> 1121 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1122 ipmi::sensor_event::cmdGetSensorReading, 1123 ipmi::Privilege::User, ipmiSensorGetSensorReading); 1124 1125 // <Reserve Device SDR Repository> 1126 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1127 ipmi::sensor_event::cmdReserveDeviceSdrRepository, 1128 ipmi::Privilege::User, ipmiSensorReserveSdr); 1129 1130 // <Get Device SDR Info> 1131 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1132 ipmi::sensor_event::cmdGetDeviceSdrInfo, 1133 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo); 1134 1135 // <Get Device SDR> 1136 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr, 1137 ipmi_sen_get_sdr, PRIVILEGE_USER); 1138 1139 // <Get Sensor Thresholds> 1140 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1141 ipmi::sensor_event::cmdGetSensorThreshold, 1142 ipmi::Privilege::User, ipmiSensorGetSensorThresholds); 1143 1144 return; 1145 } 1146