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 ipmi_ret_t ipmi_sen_get_sensor_type(ipmi_netfn_t netfn, ipmi_cmd_t cmd, 290 ipmi_request_t request, 291 ipmi_response_t response, 292 ipmi_data_len_t data_len, 293 ipmi_context_t context) 294 { 295 auto reqptr = static_cast<sensor_data_t*>(request); 296 ipmi_ret_t rc = IPMI_CC_OK; 297 298 printf("IPMI GET_SENSOR_TYPE [0x%02X]\n", reqptr->sennum); 299 300 // TODO Not sure what the System-event-sensor is suppose to return 301 // need to ask Hostboot team 302 unsigned char buf[] = {0x00, 0x6F}; 303 304 buf[0] = find_type_for_sensor_number(reqptr->sennum); 305 306 // HACK UNTIL Dbus gets updated or we find a better way 307 if (buf[0] == 0) 308 { 309 rc = IPMI_CC_SENSOR_INVALID; 310 } 311 312 *data_len = sizeof(buf); 313 std::memcpy(response, &buf, *data_len); 314 315 return rc; 316 } 317 318 const std::set<std::string> analogSensorInterfaces = { 319 "xyz.openbmc_project.Sensor.Value", 320 "xyz.openbmc_project.Control.FanPwm", 321 }; 322 323 bool isAnalogSensor(const std::string& interface) 324 { 325 return (analogSensorInterfaces.count(interface)); 326 } 327 328 /** 329 @brief This command is used to set sensorReading. 330 331 @param 332 - sensorNumber 333 - operation 334 - reading 335 - assertOffset0_7 336 - assertOffset8_14 337 - deassertOffset0_7 338 - deassertOffset8_14 339 - eventData1 340 - eventData2 341 - eventData3 342 343 @return completion code on success. 344 **/ 345 346 ipmi::RspType<> ipmiSetSensorReading(uint8_t sensorNumber, uint8_t operation, 347 uint8_t reading, uint8_t assertOffset0_7, 348 uint8_t assertOffset8_14, 349 uint8_t deassertOffset0_7, 350 uint8_t deassertOffset8_14, 351 uint8_t eventData1, uint8_t eventData2, 352 uint8_t eventData3) 353 { 354 log<level::DEBUG>("IPMI SET_SENSOR", 355 entry("SENSOR_NUM=0x%02x", sensorNumber)); 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 (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 getSensorThresholds(uint8_t sensorNum) 480 { 481 get_sdr::GetSensorThresholdsResponse resp; 482 constexpr auto warningThreshIntf = 483 "xyz.openbmc_project.Sensor.Threshold.Warning"; 484 constexpr auto criticalThreshIntf = 485 "xyz.openbmc_project.Sensor.Threshold.Critical"; 486 487 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()}; 488 489 const auto iter = ipmi::sensor::sensors.find(sensorNum); 490 const auto info = iter->second; 491 492 auto service = ipmi::getService(bus, info.sensorInterface, info.sensorPath); 493 494 auto warnThresholds = ipmi::getAllDbusProperties( 495 bus, service, info.sensorPath, warningThreshIntf); 496 497 double warnLow = std::visit(ipmi::VariantToDoubleVisitor(), 498 warnThresholds["WarningLow"]); 499 double warnHigh = std::visit(ipmi::VariantToDoubleVisitor(), 500 warnThresholds["WarningHigh"]); 501 502 if (warnLow != 0) 503 { 504 warnLow *= std::pow(10, info.scale - info.exponentR); 505 resp.lowerNonCritical = static_cast<uint8_t>( 506 (warnLow - info.scaledOffset) / info.coefficientM); 507 resp.validMask |= static_cast<uint8_t>( 508 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK); 509 } 510 511 if (warnHigh != 0) 512 { 513 warnHigh *= std::pow(10, info.scale - info.exponentR); 514 resp.upperNonCritical = static_cast<uint8_t>( 515 (warnHigh - info.scaledOffset) / info.coefficientM); 516 resp.validMask |= static_cast<uint8_t>( 517 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK); 518 } 519 520 auto critThresholds = ipmi::getAllDbusProperties( 521 bus, service, info.sensorPath, criticalThreshIntf); 522 double critLow = std::visit(ipmi::VariantToDoubleVisitor(), 523 critThresholds["CriticalLow"]); 524 double critHigh = std::visit(ipmi::VariantToDoubleVisitor(), 525 critThresholds["CriticalHigh"]); 526 527 if (critLow != 0) 528 { 529 critLow *= std::pow(10, info.scale - info.exponentR); 530 resp.lowerCritical = static_cast<uint8_t>( 531 (critLow - info.scaledOffset) / info.coefficientM); 532 resp.validMask |= static_cast<uint8_t>( 533 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK); 534 } 535 536 if (critHigh != 0) 537 { 538 critHigh *= std::pow(10, info.scale - info.exponentR); 539 resp.upperCritical = static_cast<uint8_t>( 540 (critHigh - info.scaledOffset) / info.coefficientM); 541 resp.validMask |= static_cast<uint8_t>( 542 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK); 543 } 544 545 return resp; 546 } 547 548 /** @brief implements the get sensor thresholds command 549 * @param sensorNum - sensor number 550 * 551 * @returns IPMI completion code plus response data 552 * - validMask - threshold mask 553 * - lower non-critical threshold - IPMI messaging state 554 * - lower critical threshold - link authentication state 555 * - lower non-recoverable threshold - callback state 556 * - upper non-critical threshold 557 * - upper critical 558 * - upper non-recoverable 559 */ 560 ipmi::RspType<uint8_t, // validMask 561 uint8_t, // lowerNonCritical 562 uint8_t, // lowerCritical 563 uint8_t, // lowerNonRecoverable 564 uint8_t, // upperNonCritical 565 uint8_t, // upperCritical 566 uint8_t // upperNonRecoverable 567 > 568 ipmiSensorGetSensorThresholds(uint8_t sensorNum) 569 { 570 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value"; 571 572 const auto iter = ipmi::sensor::sensors.find(sensorNum); 573 if (iter == ipmi::sensor::sensors.end()) 574 { 575 return ipmi::responseSensorInvalid(); 576 } 577 578 const auto info = iter->second; 579 580 // Proceed only if the sensor value interface is implemented. 581 if (info.propertyInterfaces.find(valueInterface) == 582 info.propertyInterfaces.end()) 583 { 584 // return with valid mask as 0 585 return ipmi::responseSuccess(); 586 } 587 588 get_sdr::GetSensorThresholdsResponse resp{}; 589 try 590 { 591 resp = getSensorThresholds(sensorNum); 592 } 593 catch (std::exception& e) 594 { 595 // Mask if the property is not present 596 } 597 598 return ipmi::responseSuccess(resp.validMask, resp.lowerNonCritical, 599 resp.lowerCritical, resp.lowerNonRecoverable, 600 resp.upperNonCritical, resp.upperCritical, 601 resp.upperNonRecoverable); 602 } 603 604 ipmi_ret_t ipmi_sen_wildcard(ipmi_netfn_t netfn, ipmi_cmd_t cmd, 605 ipmi_request_t request, ipmi_response_t response, 606 ipmi_data_len_t data_len, ipmi_context_t context) 607 { 608 ipmi_ret_t rc = IPMI_CC_INVALID; 609 610 printf("IPMI S/E Wildcard Netfn:[0x%X], Cmd:[0x%X]\n", netfn, cmd); 611 *data_len = 0; 612 613 return rc; 614 } 615 616 /** @brief implements the get SDR Info command 617 * @param count - Operation 618 * 619 * @returns IPMI completion code plus response data 620 * - sdrCount - sensor/SDR count 621 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag 622 */ 623 ipmi::RspType<uint8_t, // respcount 624 uint8_t // dynamic population flags 625 > 626 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count) 627 { 628 uint8_t sdrCount; 629 // multiple LUNs not supported. 630 constexpr uint8_t lunsAndDynamicPopulation = 1; 631 constexpr uint8_t getSdrCount = 0x01; 632 constexpr uint8_t getSensorCount = 0x00; 633 634 if (count.value_or(0) == getSdrCount) 635 { 636 // Get SDR count. This returns the total number of SDRs in the device. 637 const auto& entityRecords = 638 ipmi::sensor::EntityInfoMapContainer::getContainer() 639 ->getIpmiEntityRecords(); 640 sdrCount = 641 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size(); 642 } 643 else if (count.value_or(0) == getSensorCount) 644 { 645 // Get Sensor count. This returns the number of sensors 646 sdrCount = ipmi::sensor::sensors.size(); 647 } 648 else 649 { 650 return ipmi::responseInvalidCommandOnLun(); 651 } 652 653 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation); 654 } 655 656 /** @brief implements the reserve SDR command 657 * @returns IPMI completion code plus response data 658 * - reservationID - reservation ID 659 */ 660 ipmi::RspType<uint16_t> ipmiSensorReserveSdr() 661 { 662 // A constant reservation ID is okay until we implement add/remove SDR. 663 constexpr uint16_t reservationID = 1; 664 665 return ipmi::responseSuccess(reservationID); 666 } 667 668 void setUnitFieldsForObject(const ipmi::sensor::Info* info, 669 get_sdr::SensorDataFullRecordBody* body) 670 { 671 namespace server = sdbusplus::xyz::openbmc_project::Sensor::server; 672 try 673 { 674 auto unit = server::Value::convertUnitFromString(info->unit); 675 // Unit strings defined in 676 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml 677 switch (unit) 678 { 679 case server::Value::Unit::DegreesC: 680 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C; 681 break; 682 case server::Value::Unit::RPMS: 683 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM; 684 break; 685 case server::Value::Unit::Volts: 686 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS; 687 break; 688 case server::Value::Unit::Meters: 689 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS; 690 break; 691 case server::Value::Unit::Amperes: 692 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES; 693 break; 694 case server::Value::Unit::Joules: 695 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES; 696 break; 697 case server::Value::Unit::Watts: 698 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS; 699 break; 700 default: 701 // Cannot be hit. 702 std::fprintf(stderr, "Unknown value unit type: = %s\n", 703 info->unit.c_str()); 704 } 705 } 706 catch (const sdbusplus::exception::InvalidEnumString& e) 707 { 708 log<level::WARNING>("Warning: no unit provided for sensor!"); 709 } 710 } 711 712 ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body, 713 const ipmi::sensor::Info* info, 714 ipmi_data_len_t data_len) 715 { 716 /* Functional sensor case */ 717 if (isAnalogSensor(info->propertyInterfaces.begin()->first)) 718 { 719 720 body->sensor_units_1 = 0; // unsigned, no rate, no modifier, not a % 721 722 /* Unit info */ 723 setUnitFieldsForObject(info, body); 724 725 get_sdr::body::set_b(info->coefficientB, body); 726 get_sdr::body::set_m(info->coefficientM, body); 727 get_sdr::body::set_b_exp(info->exponentB, body); 728 get_sdr::body::set_r_exp(info->exponentR, body); 729 730 get_sdr::body::set_id_type(0b00, body); // 00 = unicode 731 } 732 733 /* ID string */ 734 auto id_string = info->sensorNameFunc(*info); 735 736 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH) 737 { 738 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body); 739 } 740 else 741 { 742 get_sdr::body::set_id_strlen(id_string.length(), body); 743 } 744 strncpy(body->id_string, id_string.c_str(), 745 get_sdr::body::get_id_strlen(body)); 746 747 return IPMI_CC_OK; 748 }; 749 750 ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response, 751 ipmi_data_len_t data_len) 752 { 753 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request); 754 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response); 755 get_sdr::SensorDataFruRecord record{}; 756 auto dataLength = 0; 757 758 auto fru = frus.begin(); 759 uint8_t fruID{}; 760 auto recordID = get_sdr::request::get_record_id(req); 761 762 fruID = recordID - FRU_RECORD_ID_START; 763 fru = frus.find(fruID); 764 if (fru == frus.end()) 765 { 766 return IPMI_CC_SENSOR_INVALID; 767 } 768 769 /* Header */ 770 get_sdr::header::set_record_id(recordID, &(record.header)); 771 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1 772 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD; 773 record.header.record_length = sizeof(record.key) + sizeof(record.body); 774 775 /* Key */ 776 record.key.fruID = fruID; 777 record.key.accessLun |= IPMI_LOGICAL_FRU; 778 record.key.deviceAddress = BMCSlaveAddress; 779 780 /* Body */ 781 record.body.entityID = fru->second[0].entityID; 782 record.body.entityInstance = fru->second[0].entityInstance; 783 record.body.deviceType = fruInventoryDevice; 784 record.body.deviceTypeModifier = IPMIFruInventory; 785 786 /* Device ID string */ 787 auto deviceID = 788 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1, 789 fru->second[0].path.length()); 790 791 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH) 792 { 793 get_sdr::body::set_device_id_strlen( 794 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body)); 795 } 796 else 797 { 798 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body)); 799 } 800 801 strncpy(record.body.deviceID, deviceID.c_str(), 802 get_sdr::body::get_device_id_strlen(&(record.body))); 803 804 if (++fru == frus.end()) 805 { 806 // we have reached till end of fru, so assign the next record id to 807 // 512(Max fru ID = 511) + Entity Record ID(may start with 0). 808 const auto& entityRecords = 809 ipmi::sensor::EntityInfoMapContainer::getContainer() 810 ->getIpmiEntityRecords(); 811 auto next_record_id = 812 (entityRecords.size()) 813 ? entityRecords.begin()->first + ENTITY_RECORD_ID_START 814 : END_OF_RECORD; 815 get_sdr::response::set_next_record_id(next_record_id, resp); 816 } 817 else 818 { 819 get_sdr::response::set_next_record_id( 820 (FRU_RECORD_ID_START + fru->first), resp); 821 } 822 823 // Check for invalid offset size 824 if (req->offset > sizeof(record)) 825 { 826 return IPMI_CC_PARM_OUT_OF_RANGE; 827 } 828 829 dataLength = std::min(static_cast<size_t>(req->bytes_to_read), 830 sizeof(record) - req->offset); 831 832 std::memcpy(resp->record_data, 833 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength); 834 835 *data_len = dataLength; 836 *data_len += 2; // additional 2 bytes for next record ID 837 838 return IPMI_CC_OK; 839 } 840 841 ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response, 842 ipmi_data_len_t data_len) 843 { 844 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request); 845 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response); 846 get_sdr::SensorDataEntityRecord record{}; 847 auto dataLength = 0; 848 849 const auto& entityRecords = 850 ipmi::sensor::EntityInfoMapContainer::getContainer() 851 ->getIpmiEntityRecords(); 852 auto entity = entityRecords.begin(); 853 uint8_t entityRecordID; 854 auto recordID = get_sdr::request::get_record_id(req); 855 856 entityRecordID = recordID - ENTITY_RECORD_ID_START; 857 entity = entityRecords.find(entityRecordID); 858 if (entity == entityRecords.end()) 859 { 860 return IPMI_CC_SENSOR_INVALID; 861 } 862 863 /* Header */ 864 get_sdr::header::set_record_id(recordID, &(record.header)); 865 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1 866 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD; 867 record.header.record_length = sizeof(record.key) + sizeof(record.body); 868 869 /* Key */ 870 record.key.containerEntityId = entity->second.containerEntityId; 871 record.key.containerEntityInstance = entity->second.containerEntityInstance; 872 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked, 873 &(record.key)); 874 record.key.entityId1 = entity->second.containedEntities[0].first; 875 record.key.entityInstance1 = entity->second.containedEntities[0].second; 876 877 /* Body */ 878 record.body.entityId2 = entity->second.containedEntities[1].first; 879 record.body.entityInstance2 = entity->second.containedEntities[1].second; 880 record.body.entityId3 = entity->second.containedEntities[2].first; 881 record.body.entityInstance3 = entity->second.containedEntities[2].second; 882 record.body.entityId4 = entity->second.containedEntities[3].first; 883 record.body.entityInstance4 = entity->second.containedEntities[3].second; 884 885 if (++entity == entityRecords.end()) 886 { 887 get_sdr::response::set_next_record_id(END_OF_RECORD, 888 resp); // last record 889 } 890 else 891 { 892 get_sdr::response::set_next_record_id( 893 (ENTITY_RECORD_ID_START + entity->first), resp); 894 } 895 896 // Check for invalid offset size 897 if (req->offset > sizeof(record)) 898 { 899 return IPMI_CC_PARM_OUT_OF_RANGE; 900 } 901 902 dataLength = std::min(static_cast<size_t>(req->bytes_to_read), 903 sizeof(record) - req->offset); 904 905 std::memcpy(resp->record_data, 906 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength); 907 908 *data_len = dataLength; 909 *data_len += 2; // additional 2 bytes for next record ID 910 911 return IPMI_CC_OK; 912 } 913 914 ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t netfn, ipmi_cmd_t cmd, 915 ipmi_request_t request, ipmi_response_t response, 916 ipmi_data_len_t data_len, ipmi_context_t context) 917 { 918 ipmi_ret_t ret = IPMI_CC_OK; 919 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request; 920 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response; 921 get_sdr::SensorDataFullRecord record = {0}; 922 923 // Note: we use an iterator so we can provide the next ID at the end of 924 // the call. 925 auto sensor = ipmi::sensor::sensors.begin(); 926 auto recordID = get_sdr::request::get_record_id(req); 927 928 // At the beginning of a scan, the host side will send us id=0. 929 if (recordID != 0) 930 { 931 // recordID 0 to 255 means it is a FULL record. 932 // recordID 256 to 511 means it is a FRU record. 933 // recordID greater then 511 means it is a Entity Association 934 // record. Currently we are supporting three record types: FULL 935 // record, FRU record and Enttiy Association record. 936 if (recordID >= ENTITY_RECORD_ID_START) 937 { 938 return ipmi_entity_get_sdr(request, response, data_len); 939 } 940 else if (recordID >= FRU_RECORD_ID_START && 941 recordID < ENTITY_RECORD_ID_START) 942 { 943 return ipmi_fru_get_sdr(request, response, data_len); 944 } 945 else 946 { 947 sensor = ipmi::sensor::sensors.find(recordID); 948 if (sensor == ipmi::sensor::sensors.end()) 949 { 950 return IPMI_CC_SENSOR_INVALID; 951 } 952 } 953 } 954 955 uint8_t sensor_id = sensor->first; 956 957 /* Header */ 958 get_sdr::header::set_record_id(sensor_id, &(record.header)); 959 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1 960 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD; 961 record.header.record_length = sizeof(get_sdr::SensorDataFullRecord); 962 963 /* Key */ 964 get_sdr::key::set_owner_id_bmc(&(record.key)); 965 record.key.sensor_number = sensor_id; 966 967 /* Body */ 968 record.body.entity_id = sensor->second.entityType; 969 record.body.sensor_type = sensor->second.sensorType; 970 record.body.event_reading_type = sensor->second.sensorReadingType; 971 record.body.entity_instance = sensor->second.instance; 972 if (ipmi::sensor::Mutability::Write == 973 (sensor->second.mutability & ipmi::sensor::Mutability::Write)) 974 { 975 get_sdr::body::init_settable_state(true, &(record.body)); 976 } 977 978 // Set the type-specific details given the DBus interface 979 ret = 980 populate_record_from_dbus(&(record.body), &(sensor->second), data_len); 981 982 if (++sensor == ipmi::sensor::sensors.end()) 983 { 984 // we have reached till end of sensor, so assign the next record id 985 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0). 986 auto next_record_id = (frus.size()) 987 ? frus.begin()->first + FRU_RECORD_ID_START 988 : END_OF_RECORD; 989 990 get_sdr::response::set_next_record_id(next_record_id, resp); 991 } 992 else 993 { 994 get_sdr::response::set_next_record_id(sensor->first, resp); 995 } 996 997 if (req->offset > sizeof(record)) 998 { 999 return IPMI_CC_PARM_OUT_OF_RANGE; 1000 } 1001 1002 // data_len will ultimately be the size of the record, plus 1003 // the size of the next record ID: 1004 *data_len = std::min(static_cast<size_t>(req->bytes_to_read), 1005 sizeof(record) - req->offset); 1006 1007 std::memcpy(resp->record_data, 1008 reinterpret_cast<uint8_t*>(&record) + req->offset, *data_len); 1009 1010 // data_len should include the LSB and MSB: 1011 *data_len += 1012 sizeof(resp->next_record_id_lsb) + sizeof(resp->next_record_id_msb); 1013 1014 return ret; 1015 } 1016 1017 static bool isFromSystemChannel() 1018 { 1019 // TODO we could not figure out where the request is from based on IPMI 1020 // command handler parameters. because of it, we can not differentiate 1021 // request from SMS/SMM or IPMB channel 1022 return true; 1023 } 1024 1025 ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t netfn, ipmi_cmd_t cmd, 1026 ipmi_request_t request, 1027 ipmi_response_t response, 1028 ipmi_data_len_t dataLen, ipmi_context_t context) 1029 { 1030 uint16_t generatorID; 1031 size_t count; 1032 bool assert = true; 1033 std::string sensorPath; 1034 size_t paraLen = *dataLen; 1035 PlatformEventRequest* req; 1036 *dataLen = 0; 1037 1038 if ((paraLen < selSystemEventSizeWith1Bytes) || 1039 (paraLen > selSystemEventSizeWith3Bytes)) 1040 { 1041 return IPMI_CC_REQ_DATA_LEN_INVALID; 1042 } 1043 1044 if (isFromSystemChannel()) 1045 { // first byte for SYSTEM Interface is Generator ID 1046 // +1 to get common struct 1047 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1); 1048 // Capture the generator ID 1049 generatorID = *reinterpret_cast<uint8_t*>(request); 1050 // Platform Event usually comes from other firmware, like BIOS. 1051 // Unlike BMC sensor, it does not have BMC DBUS sensor path. 1052 sensorPath = "System"; 1053 } 1054 else 1055 { 1056 req = reinterpret_cast<PlatformEventRequest*>(request); 1057 // TODO GenratorID for IPMB is combination of RqSA and RqLUN 1058 generatorID = 0xff; 1059 sensorPath = "IPMB"; 1060 } 1061 // Content of event data field depends on sensor class. 1062 // When data0 bit[5:4] is non-zero, valid data counts is 3. 1063 // When data0 bit[7:6] is non-zero, valid data counts is 2. 1064 if (((req->data[0] & byte3EnableMask) != 0 && 1065 paraLen < selSystemEventSizeWith3Bytes) || 1066 ((req->data[0] & byte2EnableMask) != 0 && 1067 paraLen < selSystemEventSizeWith2Bytes)) 1068 { 1069 return IPMI_CC_REQ_DATA_LEN_INVALID; 1070 } 1071 1072 // Count bytes of Event Data 1073 if ((req->data[0] & byte3EnableMask) != 0) 1074 { 1075 count = 3; 1076 } 1077 else if ((req->data[0] & byte2EnableMask) != 0) 1078 { 1079 count = 2; 1080 } 1081 else 1082 { 1083 count = 1; 1084 } 1085 assert = req->eventDirectionType & directionMask ? false : true; 1086 std::vector<uint8_t> eventData(req->data, req->data + count); 1087 1088 sdbusplus::bus::bus dbus(bus); 1089 std::string service = 1090 ipmi::getService(dbus, ipmiSELAddInterface, ipmiSELPath); 1091 sdbusplus::message::message writeSEL = dbus.new_method_call( 1092 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd"); 1093 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert, 1094 generatorID); 1095 try 1096 { 1097 dbus.call(writeSEL); 1098 } 1099 catch (sdbusplus::exception_t& e) 1100 { 1101 phosphor::logging::log<phosphor::logging::level::ERR>(e.what()); 1102 return IPMI_CC_UNSPECIFIED_ERROR; 1103 } 1104 return IPMI_CC_OK; 1105 } 1106 1107 void register_netfn_sen_functions() 1108 { 1109 // <Wildcard Command> 1110 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_WILDCARD, nullptr, 1111 ipmi_sen_wildcard, PRIVILEGE_USER); 1112 1113 // <Platform Event Message> 1114 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr, 1115 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR); 1116 // <Get Sensor Type> 1117 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_SENSOR_TYPE, nullptr, 1118 ipmi_sen_get_sensor_type, PRIVILEGE_USER); 1119 1120 // <Set Sensor Reading and Event Status> 1121 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1122 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts, 1123 ipmi::Privilege::Operator, ipmiSetSensorReading); 1124 // <Get Sensor Reading> 1125 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1126 ipmi::sensor_event::cmdGetSensorReading, 1127 ipmi::Privilege::User, ipmiSensorGetSensorReading); 1128 1129 // <Reserve Device SDR Repository> 1130 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1131 ipmi::sensor_event::cmdReserveDeviceSdrRepository, 1132 ipmi::Privilege::User, ipmiSensorReserveSdr); 1133 1134 // <Get Device SDR Info> 1135 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1136 ipmi::sensor_event::cmdGetDeviceSdrInfo, 1137 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo); 1138 1139 // <Get Device SDR> 1140 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr, 1141 ipmi_sen_get_sdr, PRIVILEGE_USER); 1142 1143 // <Get Sensor Thresholds> 1144 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor, 1145 ipmi::sensor_event::cmdGetSensorThreshold, 1146 ipmi::Privilege::User, ipmiSensorGetSensorThresholds); 1147 1148 return; 1149 } 1150