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