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