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