blob: 7c5aa069ed67356097796b1cacd6fb777e131b83 [file] [log] [blame]
Brandon Kim9cf85622019-06-19 12:05:08 -07001#include "config.h"
2
Patrick Venture46470a32018-09-07 19:26:25 -07003#include "sensorhandler.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07004
Patrick Venture99bf1c42019-08-23 09:02:13 -07005#include "entity_map_json.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07006#include "fruread.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07007
Tomd700e762016-09-20 18:24:13 +05308#include <mapper.h>
Chris Austen10ccc0f2015-12-10 18:27:04 -06009#include <systemd/sd-bus.h>
Patrick Venture0b02be92018-08-31 11:55:55 -070010
11#include <bitset>
Patrick Venture586d35b2018-09-07 19:56:18 -070012#include <cmath>
Patrick Ventureb51bf9c2018-09-10 15:53:14 -070013#include <cstring>
Vernon Mauerye08fbff2019-04-03 09:19:34 -070014#include <ipmid/api.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070015#include <ipmid/types.hpp>
Vernon Mauery6a98fe72019-03-11 15:57:48 -070016#include <ipmid/utils.hpp>
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -050017#include <phosphor-logging/elog-errors.hpp>
Patrick Venture0b02be92018-08-31 11:55:55 -070018#include <phosphor-logging/log.hpp>
William A. Kennington III4c008022018-10-12 17:18:14 -070019#include <sdbusplus/message/types.hpp>
Patrick Venture0b02be92018-08-31 11:55:55 -070020#include <set>
21#include <xyz/openbmc_project/Common/error.hpp>
22#include <xyz/openbmc_project/Sensor/Value/server.hpp>
23
Ratan Guptae0cc8552018-01-22 14:23:04 +053024static constexpr uint8_t fruInventoryDevice = 0x10;
25static constexpr uint8_t IPMIFruInventory = 0x02;
26static constexpr uint8_t BMCSlaveAddress = 0x20;
27
Patrick Venture0b02be92018-08-31 11:55:55 -070028extern int updateSensorRecordFromSSRAESC(const void*);
29extern sd_bus* bus;
Patrick Venturedb0cbe62019-09-09 14:47:22 -070030
31namespace ipmi
32{
33namespace sensor
34{
35extern const IdInfoMap sensors;
36} // namespace sensor
37} // namespace ipmi
38
Ratan Guptae0cc8552018-01-22 14:23:04 +053039extern const FruMap frus;
40
Tom Josephbe703f72017-03-09 12:34:35 +053041using namespace phosphor::logging;
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -050042using InternalFailure =
43 sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
Chris Austenac4604a2015-10-13 12:43:27 -050044
Patrick Venture0b02be92018-08-31 11:55:55 -070045void register_netfn_sen_functions() __attribute__((constructor));
Chris Austenac4604a2015-10-13 12:43:27 -050046
Patrick Venture0b02be92018-08-31 11:55:55 -070047struct sensorTypemap_t
48{
Chris Austen0012e9b2015-10-22 01:37:46 -050049 uint8_t number;
Chris Austend7cf0e42015-11-07 14:27:12 -060050 uint8_t typecode;
Chris Austen0012e9b2015-10-22 01:37:46 -050051 char dbusname[32];
Patrick Venture0b02be92018-08-31 11:55:55 -070052};
Chris Austen0012e9b2015-10-22 01:37:46 -050053
Chris Austen0012e9b2015-10-22 01:37:46 -050054sensorTypemap_t g_SensorTypeMap[] = {
55
Chris Austend7cf0e42015-11-07 14:27:12 -060056 {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"},
Patrick Venture0b02be92018-08-31 11:55:55 -070063 {0xe9, 0x09, "OccStatus"}, // E9 is an internal mapping to handle sensor
64 // type code os 0x09
Chris Austend7cf0e42015-11-07 14:27:12 -060065 {0xC3, 0x6F, "BootCount"},
66 {0x1F, 0x6F, "OperatingSystemStatus"},
Chris Austen800ba712015-12-03 15:31:00 -060067 {0x12, 0x6F, "SYSTEM_EVENT"},
68 {0xC7, 0x03, "SYSTEM"},
69 {0xC7, 0x03, "MAIN_PLANAR"},
Chris Austen10ccc0f2015-12-10 18:27:04 -060070 {0xC2, 0x6F, "PowerCap"},
Tom Joseph558184e2017-09-01 13:45:05 +053071 {0x0b, 0xCA, "PowerSupplyRedundancy"},
Jayanth Othayoth0661beb2017-03-22 06:00:58 -050072 {0xDA, 0x03, "TurboAllowed"},
Tom Joseph558184e2017-09-01 13:45:05 +053073 {0xD8, 0xC8, "PowerSupplyDerating"},
Chris Austend7cf0e42015-11-07 14:27:12 -060074 {0xFF, 0x00, ""},
Chris Austen0012e9b2015-10-22 01:37:46 -050075};
76
Patrick Venture0b02be92018-08-31 11:55:55 -070077struct sensor_data_t
78{
Chris Austenac4604a2015-10-13 12:43:27 -050079 uint8_t sennum;
Patrick Venture0b02be92018-08-31 11:55:55 -070080} __attribute__((packed));
Chris Austenac4604a2015-10-13 12:43:27 -050081
Patrick Venture0b02be92018-08-31 11:55:55 -070082int get_bus_for_path(const char* path, char** busname)
83{
Emily Shaffer2ae09b92017-04-05 15:09:41 -070084 return mapper_get_service(bus, path, busname);
85}
Tomd700e762016-09-20 18:24:13 +053086
Emily Shaffer2ae09b92017-04-05 15:09:41 -070087// 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
Patrick Venture0b02be92018-08-31 11:55:55 -070090int find_openbmc_path(uint8_t num, dbus_interface_t* interface)
91{
Emily Shaffer2ae09b92017-04-05 15:09:41 -070092 int rc;
93
Patrick Venturedb0cbe62019-09-09 14:47:22 -070094 const auto& sensor_it = ipmi::sensor::sensors.find(num);
95 if (sensor_it == ipmi::sensor::sensors.end())
Emily Shaffer2ae09b92017-04-05 15:09:41 -070096 {
Adriana Kobylakba23ff72018-09-12 12:58:43 -050097 // The sensor map does not contain the sensor requested
98 return -EINVAL;
Emily Shaffer2ae09b92017-04-05 15:09:41 -070099 }
100
101 const auto& info = sensor_it->second;
102
Patrick Williams8451edf2017-06-13 09:01:06 -0500103 char* busname = nullptr;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700104 rc = get_bus_for_path(info.sensorPath.c_str(), &busname);
Patrick Venture0b02be92018-08-31 11:55:55 -0700105 if (rc < 0)
106 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700107 std::fprintf(stderr, "Failed to get %s busname: %s\n",
108 info.sensorPath.c_str(), busname);
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700109 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
Patrick Venture0b02be92018-08-31 11:55:55 -0700119 strcpy(interface->interface,
120 info.propertyInterfaces.begin()->first.c_str());
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700121 interface->sensornumber = num;
122
123final:
124 free(busname);
125 return rc;
126}
127
Tomd700e762016-09-20 18:24:13 +0530128/////////////////////////////////////////////////////////////////////
129//
130// Routines used by ipmi commands wanting to interact on the dbus
131//
132/////////////////////////////////////////////////////////////////////
Patrick Venture0b02be92018-08-31 11:55:55 -0700133int set_sensor_dbus_state_s(uint8_t number, const char* method,
134 const char* value)
135{
Tomd700e762016-09-20 18:24:13 +0530136
137 dbus_interface_t a;
138 int r;
139 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700140 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530141
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700142 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530143
Patrick Venture0b02be92018-08-31 11:55:55 -0700144 if (r < 0)
145 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700146 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530147 return 0;
148 }
149
Patrick Venture0b02be92018-08-31 11:55:55 -0700150 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
151 method);
152 if (r < 0)
153 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700154 std::fprintf(stderr, "Failed to create a method call: %s",
155 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530156 goto final;
157 }
158
159 r = sd_bus_message_append(m, "v", "s", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700160 if (r < 0)
161 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700162 std::fprintf(stderr, "Failed to create a input parameter: %s",
163 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530164 goto final;
165 }
166
Tomd700e762016-09-20 18:24:13 +0530167 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700168 if (r < 0)
169 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700170 std::fprintf(stderr, "Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530171 }
172
173final:
174 sd_bus_error_free(&error);
175 m = sd_bus_message_unref(m);
176
177 return 0;
178}
Patrick Venture0b02be92018-08-31 11:55:55 -0700179int set_sensor_dbus_state_y(uint8_t number, const char* method,
180 const uint8_t value)
181{
Tomd700e762016-09-20 18:24:13 +0530182
183 dbus_interface_t a;
184 int r;
185 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700186 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530187
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700188 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530189
Patrick Venture0b02be92018-08-31 11:55:55 -0700190 if (r < 0)
191 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700192 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530193 return 0;
194 }
195
Patrick Venture0b02be92018-08-31 11:55:55 -0700196 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
197 method);
198 if (r < 0)
199 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700200 std::fprintf(stderr, "Failed to create a method call: %s",
201 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530202 goto final;
203 }
204
205 r = sd_bus_message_append(m, "v", "i", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700206 if (r < 0)
207 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700208 std::fprintf(stderr, "Failed to create a input parameter: %s",
209 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530210 goto final;
211 }
212
Tomd700e762016-09-20 18:24:13 +0530213 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700214 if (r < 0)
215 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700216 std::fprintf(stderr, "12 Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530217 }
218
219final:
220 sd_bus_error_free(&error);
221 m = sd_bus_message_unref(m);
222
223 return 0;
224}
225
Patrick Venture0b02be92018-08-31 11:55:55 -0700226uint8_t dbus_to_sensor_type(char* p)
227{
Chris Austenac4604a2015-10-13 12:43:27 -0500228
Patrick Venture0b02be92018-08-31 11:55:55 -0700229 sensorTypemap_t* s = g_SensorTypeMap;
230 char r = 0;
231 while (s->number != 0xFF)
232 {
233 if (!strcmp(s->dbusname, p))
234 {
Tom Joseph558184e2017-09-01 13:45:05 +0530235 r = s->typecode;
Patrick Venture0b02be92018-08-31 11:55:55 -0700236 break;
Chris Austenac4604a2015-10-13 12:43:27 -0500237 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500238 s++;
Chris Austenac4604a2015-10-13 12:43:27 -0500239 }
240
Chris Austen0012e9b2015-10-22 01:37:46 -0500241 if (s->number == 0xFF)
242 printf("Failed to find Sensor Type %s\n", p);
Chris Austenac4604a2015-10-13 12:43:27 -0500243
Chris Austen0012e9b2015-10-22 01:37:46 -0500244 return r;
Chris Austenac4604a2015-10-13 12:43:27 -0500245}
246
Patrick Venture0b02be92018-08-31 11:55:55 -0700247uint8_t get_type_from_interface(dbus_interface_t dbus_if)
248{
Chris Austen0012e9b2015-10-22 01:37:46 -0500249
Brad Bishop56003452016-10-05 21:49:19 -0400250 uint8_t type;
Chris Austen0012e9b2015-10-22 01:37:46 -0500251
Chris Austen0012e9b2015-10-22 01:37:46 -0500252 // 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
Patrick Venture0b02be92018-08-31 11:55:55 -0700255 if (dbus_if.interface[0] == 0)
256 {
257 return 0;
258 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500259
Emily Shaffer71174412017-04-05 15:10:40 -0700260 // Fetch type from interface itself.
261 if (dbus_if.sensortype != 0)
262 {
263 type = dbus_if.sensortype;
Patrick Venture0b02be92018-08-31 11:55:55 -0700264 }
265 else
266 {
Chris Austen0012e9b2015-10-22 01:37:46 -0500267 // Non InventoryItems
Patrick Venture4491a462018-10-13 13:00:42 -0700268 char* p = strrchr(dbus_if.path, '/');
Patrick Venture0b02be92018-08-31 11:55:55 -0700269 type = dbus_to_sensor_type(p + 1);
Chris Austen0012e9b2015-10-22 01:37:46 -0500270 }
271
Brad Bishop56003452016-10-05 21:49:19 -0400272 return type;
Patrick Venture0b02be92018-08-31 11:55:55 -0700273}
Chris Austen0012e9b2015-10-22 01:37:46 -0500274
Emily Shaffer391f3302017-04-03 10:27:08 -0700275// Replaces find_sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700276uint8_t find_type_for_sensor_number(uint8_t num)
277{
Emily Shaffer391f3302017-04-03 10:27:08 -0700278 int r;
279 dbus_interface_t dbus_if;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700280 r = find_openbmc_path(num, &dbus_if);
Patrick Venture0b02be92018-08-31 11:55:55 -0700281 if (r < 0)
282 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700283 std::fprintf(stderr, "Could not find sensor %d\n", num);
Lei YU91875f72018-04-03 15:14:49 +0800284 return 0;
Emily Shaffer391f3302017-04-03 10:27:08 -0700285 }
286 return get_type_from_interface(dbus_if);
287}
288
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000289/**
290 * @brief implements the get sensor type command.
291 * @param - sensorNumber
292 *
293 * @return IPMI completion code plus response data on success.
294 * - sensorType
295 * - eventType
296 **/
297
298ipmi::RspType<uint8_t, // sensorType
299 uint8_t // eventType
300 >
301 ipmiGetSensorType(uint8_t sensorNumber)
Chris Austenac4604a2015-10-13 12:43:27 -0500302{
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000303 uint8_t sensorType = find_type_for_sensor_number(sensorNumber);
Chris Austenac4604a2015-10-13 12:43:27 -0500304
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000305 if (sensorType == 0)
Patrick Venture0b02be92018-08-31 11:55:55 -0700306 {
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000307 return ipmi::responseSensorInvalid();
Chris Austen0012e9b2015-10-22 01:37:46 -0500308 }
309
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000310 constexpr uint8_t eventType = 0x6F;
311 return ipmi::responseSuccess(sensorType, eventType);
Chris Austenac4604a2015-10-13 12:43:27 -0500312}
313
Patrick Venture0b02be92018-08-31 11:55:55 -0700314const std::set<std::string> analogSensorInterfaces = {
Emily Shaffercc941e12017-06-14 13:06:26 -0700315 "xyz.openbmc_project.Sensor.Value",
Patrick Venturee9a64052017-08-18 19:17:27 -0700316 "xyz.openbmc_project.Control.FanPwm",
Emily Shaffercc941e12017-06-14 13:06:26 -0700317};
318
319bool isAnalogSensor(const std::string& interface)
320{
321 return (analogSensorInterfaces.count(interface));
322}
323
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000324/**
325@brief This command is used to set sensorReading.
326
327@param
328 - sensorNumber
329 - operation
330 - reading
331 - assertOffset0_7
332 - assertOffset8_14
333 - deassertOffset0_7
334 - deassertOffset8_14
335 - eventData1
336 - eventData2
337 - eventData3
338
339@return completion code on success.
340**/
341
342ipmi::RspType<> ipmiSetSensorReading(uint8_t sensorNumber, uint8_t operation,
343 uint8_t reading, uint8_t assertOffset0_7,
344 uint8_t assertOffset8_14,
345 uint8_t deassertOffset0_7,
346 uint8_t deassertOffset8_14,
347 uint8_t eventData1, uint8_t eventData2,
348 uint8_t eventData3)
Tom Josephbe703f72017-03-09 12:34:35 +0530349{
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000350 log<level::DEBUG>("IPMI SET_SENSOR",
351 entry("SENSOR_NUM=0x%02x", sensorNumber));
352
Arun P. Mohanan0634e982021-08-30 15:21:33 +0530353 if (sensorNumber == 0xFF)
354 {
355 return ipmi::responseInvalidFieldRequest();
356 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000357 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;
Tom Josephbe703f72017-03-09 12:34:35 +0530369
370 // Check if the Sensor Number is present
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700371 const auto iter = ipmi::sensor::sensors.find(sensorNumber);
372 if (iter == ipmi::sensor::sensors.end())
Tom Josephbe703f72017-03-09 12:34:35 +0530373 {
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000374 updateSensorRecordFromSSRAESC(&sensorNumber);
375 return ipmi::responseSuccess();
Tom Josephbe703f72017-03-09 12:34:35 +0530376 }
377
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500378 try
379 {
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500380 if (ipmi::sensor::Mutability::Write !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700381 (iter->second.mutability & ipmi::sensor::Mutability::Write))
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500382 {
383 log<level::ERR>("Sensor Set operation is not allowed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000384 entry("SENSOR_NUM=%d", sensorNumber));
385 return ipmi::responseIllegalCommand();
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500386 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000387 auto ipmiRC = iter->second.updateFunc(cmdData, iter->second);
388 return ipmi::response(ipmiRC);
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500389 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500390 catch (const InternalFailure& e)
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500391 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700392 log<level::ERR>("Set sensor failed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000393 entry("SENSOR_NUM=%d", sensorNumber));
Patrick Venture0b02be92018-08-31 11:55:55 -0700394 commit<InternalFailure>();
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000395 return ipmi::responseUnspecifiedError();
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500396 }
Tom Joseph82024322017-09-28 20:07:29 +0530397 catch (const std::runtime_error& e)
398 {
399 log<level::ERR>(e.what());
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000400 return ipmi::responseUnspecifiedError();
Tom Joseph82024322017-09-28 20:07:29 +0530401 }
Chris Austenac4604a2015-10-13 12:43:27 -0500402}
403
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000404/** @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 */
416ipmi::RspType<uint8_t, // sensor reading
Tom Joseph3ee668f2018-03-02 19:49:17 +0530417
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000418 uint5_t, // reserved
419 bool, // reading state
Sui Chen4cc42552019-09-11 10:28:35 -0700420 bool, // 0 = sensor scanning state disabled
421 bool, // 0 = all event messages disabled
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000422
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);
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700434 if (iter == ipmi::sensor::sensors.end())
Tom Joseph3ee668f2018-03-02 19:49:17 +0530435 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000436 return ipmi::responseSensorInvalid();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530437 }
438 if (ipmi::sensor::Mutability::Read !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700439 (iter->second.mutability & ipmi::sensor::Mutability::Read))
Tom Joseph3ee668f2018-03-02 19:49:17 +0530440 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000441 return ipmi::responseIllegalCommand();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530442 }
443
444 try
445 {
Sui Chen4cc42552019-09-11 10:28:35 -0700446 ipmi::sensor::GetSensorResponse getResponse =
447 iter->second.getFunc(iter->second);
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000448
Sui Chen4cc42552019-09-11 10:28:35 -0700449 return ipmi::responseSuccess(getResponse.reading, uint5_t(0),
450 getResponse.readingOrStateUnavailable,
451 getResponse.scanningEnabled,
452 getResponse.allEventMessagesEnabled,
453 getResponse.thresholdLevelsStates,
454 getResponse.discreteReadingSensorStates);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530455 }
Brandon Kim9cf85622019-06-19 12:05:08 -0700456#ifdef UPDATE_FUNCTIONAL_ON_FAIL
457 catch (const SensorFunctionalError& e)
458 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000459 return ipmi::responseResponseError();
Brandon Kim9cf85622019-06-19 12:05:08 -0700460 }
461#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530462 catch (const std::exception& e)
463 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000464 // 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);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530476 }
477}
478
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300479get_sdr::GetSensorThresholdsResponse
480 getSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600481{
William A. Kennington III515bc372020-10-27 16:32:32 -0700482 get_sdr::GetSensorThresholdsResponse resp{};
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530483 constexpr auto warningThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600484 "xyz.openbmc_project.Sensor.Threshold.Warning";
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530485 constexpr auto criticalThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600486 "xyz.openbmc_project.Sensor.Threshold.Critical";
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600487
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700488 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530489 const auto info = iter->second;
490
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300491 std::string service;
492 boost::system::error_code ec;
493 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
494 if (ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530495 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300496 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530497 }
498
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300499 ipmi::PropertyMap warnThresholds;
500 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
501 warningThreshIntf, warnThresholds);
502 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530503 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300504 double warnLow = std::visit(ipmi::VariantToDoubleVisitor(),
505 warnThresholds["WarningLow"]);
506 double warnHigh = std::visit(ipmi::VariantToDoubleVisitor(),
507 warnThresholds["WarningHigh"]);
508
509 if (std::isfinite(warnLow))
510 {
511 warnLow *= std::pow(10, info.scale - info.exponentR);
512 resp.lowerNonCritical = static_cast<uint8_t>(
513 (warnLow - info.scaledOffset) / info.coefficientM);
514 resp.validMask |= static_cast<uint8_t>(
515 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK);
516 }
517
518 if (std::isfinite(warnHigh))
519 {
520 warnHigh *= std::pow(10, info.scale - info.exponentR);
521 resp.upperNonCritical = static_cast<uint8_t>(
522 (warnHigh - info.scaledOffset) / info.coefficientM);
523 resp.validMask |= static_cast<uint8_t>(
524 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK);
525 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530526 }
527
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300528 ipmi::PropertyMap critThresholds;
529 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
530 criticalThreshIntf, critThresholds);
531 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530532 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300533 double critLow = std::visit(ipmi::VariantToDoubleVisitor(),
534 critThresholds["CriticalLow"]);
535 double critHigh = std::visit(ipmi::VariantToDoubleVisitor(),
536 critThresholds["CriticalHigh"]);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530537
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300538 if (std::isfinite(critLow))
539 {
540 critLow *= std::pow(10, info.scale - info.exponentR);
541 resp.lowerCritical = static_cast<uint8_t>(
542 (critLow - info.scaledOffset) / info.coefficientM);
543 resp.validMask |= static_cast<uint8_t>(
544 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK);
545 }
546
547 if (std::isfinite(critHigh))
548 {
549 critHigh *= std::pow(10, info.scale - info.exponentR);
550 resp.upperCritical = static_cast<uint8_t>(
551 (critHigh - info.scaledOffset) / info.coefficientM);
552 resp.validMask |= static_cast<uint8_t>(
553 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK);
554 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530555 }
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000556
557 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530558}
559
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000560/** @brief implements the get sensor thresholds command
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300561 * @param ctx - IPMI context pointer
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000562 * @param sensorNum - sensor number
563 *
564 * @returns IPMI completion code plus response data
565 * - validMask - threshold mask
566 * - lower non-critical threshold - IPMI messaging state
567 * - lower critical threshold - link authentication state
568 * - lower non-recoverable threshold - callback state
569 * - upper non-critical threshold
570 * - upper critical
571 * - upper non-recoverable
572 */
573ipmi::RspType<uint8_t, // validMask
574 uint8_t, // lowerNonCritical
575 uint8_t, // lowerCritical
576 uint8_t, // lowerNonRecoverable
577 uint8_t, // upperNonCritical
578 uint8_t, // upperCritical
579 uint8_t // upperNonRecoverable
580 >
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300581 ipmiSensorGetSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530582{
583 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
584
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700585 const auto iter = ipmi::sensor::sensors.find(sensorNum);
586 if (iter == ipmi::sensor::sensors.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600587 {
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000588 return ipmi::responseSensorInvalid();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600589 }
590
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530591 const auto info = iter->second;
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600592
Patrick Venture0b02be92018-08-31 11:55:55 -0700593 // Proceed only if the sensor value interface is implemented.
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530594 if (info.propertyInterfaces.find(valueInterface) ==
595 info.propertyInterfaces.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600596 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700597 // return with valid mask as 0
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000598 return ipmi::responseSuccess();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600599 }
600
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000601 get_sdr::GetSensorThresholdsResponse resp{};
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300602 resp = getSensorThresholds(ctx, sensorNum);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600603
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000604 return ipmi::responseSuccess(resp.validMask, resp.lowerNonCritical,
605 resp.lowerCritical, resp.lowerNonRecoverable,
606 resp.upperNonCritical, resp.upperCritical,
607 resp.upperNonRecoverable);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600608}
609
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000610/** @brief implements the get SDR Info command
611 * @param count - Operation
612 *
613 * @returns IPMI completion code plus response data
614 * - sdrCount - sensor/SDR count
615 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag
616 */
617ipmi::RspType<uint8_t, // respcount
618 uint8_t // dynamic population flags
619 >
620 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700621{
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000622 uint8_t sdrCount;
623 // multiple LUNs not supported.
624 constexpr uint8_t lunsAndDynamicPopulation = 1;
625 constexpr uint8_t getSdrCount = 0x01;
626 constexpr uint8_t getSensorCount = 0x00;
627
628 if (count.value_or(0) == getSdrCount)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700629 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000630 // Get SDR count. This returns the total number of SDRs in the device.
Patrick Venture87fd2cd2019-08-19 12:07:18 -0700631 const auto& entityRecords =
632 ipmi::sensor::EntityInfoMapContainer::getContainer()
633 ->getIpmiEntityRecords();
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700634 sdrCount =
635 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size();
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000636 }
637 else if (count.value_or(0) == getSensorCount)
638 {
639 // Get Sensor count. This returns the number of sensors
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700640 sdrCount = ipmi::sensor::sensors.size();
Emily Shafferd06e0e72017-04-05 09:08:57 -0700641 }
642 else
643 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000644 return ipmi::responseInvalidCommandOnLun();
Emily Shafferd06e0e72017-04-05 09:08:57 -0700645 }
646
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000647 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation);
Emily Shafferd06e0e72017-04-05 09:08:57 -0700648}
649
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000650/** @brief implements the reserve SDR command
651 * @returns IPMI completion code plus response data
652 * - reservationID - reservation ID
653 */
654ipmi::RspType<uint16_t> ipmiSensorReserveSdr()
Emily Shaffera344afc2017-04-13 15:09:39 -0700655{
656 // A constant reservation ID is okay until we implement add/remove SDR.
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000657 constexpr uint16_t reservationID = 1;
Emily Shaffera344afc2017-04-13 15:09:39 -0700658
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000659 return ipmi::responseSuccess(reservationID);
Emily Shaffera344afc2017-04-13 15:09:39 -0700660}
Chris Austenac4604a2015-10-13 12:43:27 -0500661
Patrick Venture0b02be92018-08-31 11:55:55 -0700662void setUnitFieldsForObject(const ipmi::sensor::Info* info,
663 get_sdr::SensorDataFullRecordBody* body)
Emily Shaffercc941e12017-06-14 13:06:26 -0700664{
Tom Josephdc212b22018-02-16 09:59:57 +0530665 namespace server = sdbusplus::xyz::openbmc_project::Sensor::server;
666 try
Emily Shaffercc941e12017-06-14 13:06:26 -0700667 {
Tom Josephdc212b22018-02-16 09:59:57 +0530668 auto unit = server::Value::convertUnitFromString(info->unit);
669 // Unit strings defined in
670 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml
671 switch (unit)
Emily Shaffercc941e12017-06-14 13:06:26 -0700672 {
Tom Josephdc212b22018-02-16 09:59:57 +0530673 case server::Value::Unit::DegreesC:
674 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C;
675 break;
676 case server::Value::Unit::RPMS:
Kirill Pakhomov812e44c2018-10-22 16:25:35 +0300677 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM;
Tom Josephdc212b22018-02-16 09:59:57 +0530678 break;
679 case server::Value::Unit::Volts:
680 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS;
681 break;
682 case server::Value::Unit::Meters:
683 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS;
684 break;
685 case server::Value::Unit::Amperes:
686 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES;
687 break;
688 case server::Value::Unit::Joules:
689 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES;
690 break;
691 case server::Value::Unit::Watts:
692 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS;
693 break;
694 default:
695 // Cannot be hit.
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700696 std::fprintf(stderr, "Unknown value unit type: = %s\n",
697 info->unit.c_str());
Emily Shaffercc941e12017-06-14 13:06:26 -0700698 }
699 }
Patrick Venture64678b82018-10-13 13:11:32 -0700700 catch (const sdbusplus::exception::InvalidEnumString& e)
Emily Shaffercc941e12017-06-14 13:06:26 -0700701 {
Tom Josephdc212b22018-02-16 09:59:57 +0530702 log<level::WARNING>("Warning: no unit provided for sensor!");
Emily Shaffercc941e12017-06-14 13:06:26 -0700703 }
Emily Shaffercc941e12017-06-14 13:06:26 -0700704}
705
Patrick Venture0b02be92018-08-31 11:55:55 -0700706ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body,
707 const ipmi::sensor::Info* info,
Emily Shafferbbef71c2017-05-08 16:36:17 -0700708 ipmi_data_len_t data_len)
709{
710 /* Functional sensor case */
Emily Shaffercc941e12017-06-14 13:06:26 -0700711 if (isAnalogSensor(info->propertyInterfaces.begin()->first))
Emily Shafferbbef71c2017-05-08 16:36:17 -0700712 {
Tony Leec5324252019-10-31 17:24:16 +0800713 body->sensor_units_1 = info->sensorUnits1; // default is 0. unsigned, no
714 // rate, no modifier, not a %
Emily Shafferbbef71c2017-05-08 16:36:17 -0700715 /* Unit info */
Tom Josephdc212b22018-02-16 09:59:57 +0530716 setUnitFieldsForObject(info, body);
Emily Shaffer10f49592017-05-10 12:01:10 -0700717
718 get_sdr::body::set_b(info->coefficientB, body);
719 get_sdr::body::set_m(info->coefficientM, body);
720 get_sdr::body::set_b_exp(info->exponentB, body);
Tom Josephdc212b22018-02-16 09:59:57 +0530721 get_sdr::body::set_r_exp(info->exponentR, body);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700722
Emily Shafferbbef71c2017-05-08 16:36:17 -0700723 get_sdr::body::set_id_type(0b00, body); // 00 = unicode
Emily Shafferbbef71c2017-05-08 16:36:17 -0700724 }
725
Tom Joseph96423912018-01-25 00:14:34 +0530726 /* ID string */
Jeremy Kerrbe4ffa82020-08-10 16:17:37 +0800727 auto id_string = info->sensorName;
728
729 if (id_string.empty())
730 {
731 id_string = info->sensorNameFunc(*info);
732 }
Tom Joseph96423912018-01-25 00:14:34 +0530733
734 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH)
735 {
736 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body);
737 }
738 else
739 {
740 get_sdr::body::set_id_strlen(id_string.length(), body);
741 }
742 strncpy(body->id_string, id_string.c_str(),
743 get_sdr::body::get_id_strlen(body));
744
Emily Shafferbbef71c2017-05-08 16:36:17 -0700745 return IPMI_CC_OK;
746};
747
Ratan Guptae0cc8552018-01-22 14:23:04 +0530748ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response,
749 ipmi_data_len_t data_len)
750{
751 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
752 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
Patrick Venture0b02be92018-08-31 11:55:55 -0700753 get_sdr::SensorDataFruRecord record{};
Ratan Guptae0cc8552018-01-22 14:23:04 +0530754 auto dataLength = 0;
755
756 auto fru = frus.begin();
Patrick Venture0b02be92018-08-31 11:55:55 -0700757 uint8_t fruID{};
Ratan Guptae0cc8552018-01-22 14:23:04 +0530758 auto recordID = get_sdr::request::get_record_id(req);
759
760 fruID = recordID - FRU_RECORD_ID_START;
761 fru = frus.find(fruID);
762 if (fru == frus.end())
763 {
764 return IPMI_CC_SENSOR_INVALID;
765 }
766
767 /* Header */
768 get_sdr::header::set_record_id(recordID, &(record.header));
769 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
770 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD;
771 record.header.record_length = sizeof(record.key) + sizeof(record.body);
772
773 /* Key */
774 record.key.fruID = fruID;
775 record.key.accessLun |= IPMI_LOGICAL_FRU;
776 record.key.deviceAddress = BMCSlaveAddress;
777
778 /* Body */
779 record.body.entityID = fru->second[0].entityID;
780 record.body.entityInstance = fru->second[0].entityInstance;
781 record.body.deviceType = fruInventoryDevice;
782 record.body.deviceTypeModifier = IPMIFruInventory;
783
784 /* Device ID string */
Patrick Venture0b02be92018-08-31 11:55:55 -0700785 auto deviceID =
786 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1,
787 fru->second[0].path.length());
Ratan Guptae0cc8552018-01-22 14:23:04 +0530788
789 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH)
790 {
791 get_sdr::body::set_device_id_strlen(
Patrick Venture0b02be92018-08-31 11:55:55 -0700792 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +0530793 }
794 else
795 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700796 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +0530797 }
798
799 strncpy(record.body.deviceID, deviceID.c_str(),
800 get_sdr::body::get_device_id_strlen(&(record.body)));
801
802 if (++fru == frus.end())
803 {
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800804 // we have reached till end of fru, so assign the next record id to
805 // 512(Max fru ID = 511) + Entity Record ID(may start with 0).
Patrick Venture87fd2cd2019-08-19 12:07:18 -0700806 const auto& entityRecords =
807 ipmi::sensor::EntityInfoMapContainer::getContainer()
808 ->getIpmiEntityRecords();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800809 auto next_record_id =
Patrick Venture83a0b842019-07-19 18:37:15 -0700810 (entityRecords.size())
811 ? entityRecords.begin()->first + ENTITY_RECORD_ID_START
812 : END_OF_RECORD;
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800813 get_sdr::response::set_next_record_id(next_record_id, resp);
814 }
815 else
816 {
817 get_sdr::response::set_next_record_id(
818 (FRU_RECORD_ID_START + fru->first), resp);
819 }
820
821 // Check for invalid offset size
822 if (req->offset > sizeof(record))
823 {
824 return IPMI_CC_PARM_OUT_OF_RANGE;
825 }
826
827 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
828 sizeof(record) - req->offset);
829
830 std::memcpy(resp->record_data,
831 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
832
833 *data_len = dataLength;
834 *data_len += 2; // additional 2 bytes for next record ID
835
836 return IPMI_CC_OK;
837}
838
839ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response,
840 ipmi_data_len_t data_len)
841{
842 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
843 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
844 get_sdr::SensorDataEntityRecord record{};
845 auto dataLength = 0;
846
Patrick Venture87fd2cd2019-08-19 12:07:18 -0700847 const auto& entityRecords =
848 ipmi::sensor::EntityInfoMapContainer::getContainer()
849 ->getIpmiEntityRecords();
Patrick Venture83a0b842019-07-19 18:37:15 -0700850 auto entity = entityRecords.begin();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800851 uint8_t entityRecordID;
852 auto recordID = get_sdr::request::get_record_id(req);
853
854 entityRecordID = recordID - ENTITY_RECORD_ID_START;
Patrick Venture83a0b842019-07-19 18:37:15 -0700855 entity = entityRecords.find(entityRecordID);
856 if (entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800857 {
858 return IPMI_CC_SENSOR_INVALID;
859 }
860
861 /* Header */
862 get_sdr::header::set_record_id(recordID, &(record.header));
863 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
864 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD;
865 record.header.record_length = sizeof(record.key) + sizeof(record.body);
866
867 /* Key */
868 record.key.containerEntityId = entity->second.containerEntityId;
869 record.key.containerEntityInstance = entity->second.containerEntityInstance;
870 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked,
871 &(record.key));
872 record.key.entityId1 = entity->second.containedEntities[0].first;
873 record.key.entityInstance1 = entity->second.containedEntities[0].second;
874
875 /* Body */
876 record.body.entityId2 = entity->second.containedEntities[1].first;
877 record.body.entityInstance2 = entity->second.containedEntities[1].second;
878 record.body.entityId3 = entity->second.containedEntities[2].first;
879 record.body.entityInstance3 = entity->second.containedEntities[2].second;
880 record.body.entityId4 = entity->second.containedEntities[3].first;
881 record.body.entityInstance4 = entity->second.containedEntities[3].second;
882
Patrick Venture83a0b842019-07-19 18:37:15 -0700883 if (++entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800884 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700885 get_sdr::response::set_next_record_id(END_OF_RECORD,
886 resp); // last record
Ratan Guptae0cc8552018-01-22 14:23:04 +0530887 }
888 else
889 {
890 get_sdr::response::set_next_record_id(
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800891 (ENTITY_RECORD_ID_START + entity->first), resp);
Ratan Guptae0cc8552018-01-22 14:23:04 +0530892 }
893
Emily Shaffer0fbdbce2018-09-27 09:30:41 -0700894 // Check for invalid offset size
895 if (req->offset > sizeof(record))
Ratan Guptae0cc8552018-01-22 14:23:04 +0530896 {
Emily Shaffer0fbdbce2018-09-27 09:30:41 -0700897 return IPMI_CC_PARM_OUT_OF_RANGE;
Ratan Guptae0cc8552018-01-22 14:23:04 +0530898 }
899
Emily Shaffer0fbdbce2018-09-27 09:30:41 -0700900 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
901 sizeof(record) - req->offset);
Ratan Guptae0cc8552018-01-22 14:23:04 +0530902
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700903 std::memcpy(resp->record_data,
Jason M. Bills1cd85962018-10-05 12:04:01 -0700904 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
Ratan Guptae0cc8552018-01-22 14:23:04 +0530905
906 *data_len = dataLength;
907 *data_len += 2; // additional 2 bytes for next record ID
908
909 return IPMI_CC_OK;
910}
911
Emily Shafferbbef71c2017-05-08 16:36:17 -0700912ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
913 ipmi_request_t request, ipmi_response_t response,
914 ipmi_data_len_t data_len, ipmi_context_t context)
915{
916 ipmi_ret_t ret = IPMI_CC_OK;
Patrick Venture0b02be92018-08-31 11:55:55 -0700917 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request;
918 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700919 get_sdr::SensorDataFullRecord record = {0};
Patrick Venture38426dd2019-07-30 15:22:29 -0700920
921 // Note: we use an iterator so we can provide the next ID at the end of
922 // the call.
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700923 auto sensor = ipmi::sensor::sensors.begin();
Patrick Venture38426dd2019-07-30 15:22:29 -0700924 auto recordID = get_sdr::request::get_record_id(req);
925
926 // At the beginning of a scan, the host side will send us id=0.
927 if (recordID != 0)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700928 {
Patrick Venture38426dd2019-07-30 15:22:29 -0700929 // recordID 0 to 255 means it is a FULL record.
930 // recordID 256 to 511 means it is a FRU record.
931 // recordID greater then 511 means it is a Entity Association
932 // record. Currently we are supporting three record types: FULL
933 // record, FRU record and Enttiy Association record.
934 if (recordID >= ENTITY_RECORD_ID_START)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700935 {
Patrick Venture38426dd2019-07-30 15:22:29 -0700936 return ipmi_entity_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700937 }
Patrick Venture38426dd2019-07-30 15:22:29 -0700938 else if (recordID >= FRU_RECORD_ID_START &&
939 recordID < ENTITY_RECORD_ID_START)
Jaghathiswari Rankappagounder Natarajan0780df12019-02-06 15:29:24 -0800940 {
Patrick Venture38426dd2019-07-30 15:22:29 -0700941 return ipmi_fru_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700942 }
943 else
944 {
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700945 sensor = ipmi::sensor::sensors.find(recordID);
946 if (sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -0700947 {
948 return IPMI_CC_SENSOR_INVALID;
949 }
Emily Shafferbbef71c2017-05-08 16:36:17 -0700950 }
Emily Shafferbbef71c2017-05-08 16:36:17 -0700951 }
952
Patrick Venture38426dd2019-07-30 15:22:29 -0700953 uint8_t sensor_id = sensor->first;
954
955 /* Header */
956 get_sdr::header::set_record_id(sensor_id, &(record.header));
957 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1
958 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
Patrick Venture158ac702021-03-25 20:02:54 -0700959 record.header.record_length = sizeof(record.key) + sizeof(record.body);
Patrick Venture38426dd2019-07-30 15:22:29 -0700960
961 /* Key */
962 get_sdr::key::set_owner_id_bmc(&(record.key));
963 record.key.sensor_number = sensor_id;
964
965 /* Body */
966 record.body.entity_id = sensor->second.entityType;
967 record.body.sensor_type = sensor->second.sensorType;
968 record.body.event_reading_type = sensor->second.sensorReadingType;
969 record.body.entity_instance = sensor->second.instance;
970 if (ipmi::sensor::Mutability::Write ==
971 (sensor->second.mutability & ipmi::sensor::Mutability::Write))
972 {
973 get_sdr::body::init_settable_state(true, &(record.body));
974 }
975
976 // Set the type-specific details given the DBus interface
977 ret =
978 populate_record_from_dbus(&(record.body), &(sensor->second), data_len);
979
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700980 if (++sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -0700981 {
982 // we have reached till end of sensor, so assign the next record id
983 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0).
984 auto next_record_id = (frus.size())
985 ? frus.begin()->first + FRU_RECORD_ID_START
986 : END_OF_RECORD;
987
988 get_sdr::response::set_next_record_id(next_record_id, resp);
989 }
990 else
991 {
992 get_sdr::response::set_next_record_id(sensor->first, resp);
993 }
994
995 if (req->offset > sizeof(record))
996 {
997 return IPMI_CC_PARM_OUT_OF_RANGE;
998 }
999
1000 // data_len will ultimately be the size of the record, plus
1001 // the size of the next record ID:
1002 *data_len = std::min(static_cast<size_t>(req->bytes_to_read),
1003 sizeof(record) - req->offset);
1004
1005 std::memcpy(resp->record_data,
1006 reinterpret_cast<uint8_t*>(&record) + req->offset, *data_len);
1007
1008 // data_len should include the LSB and MSB:
1009 *data_len +=
1010 sizeof(resp->next_record_id_lsb) + sizeof(resp->next_record_id_msb);
1011
Emily Shafferbbef71c2017-05-08 16:36:17 -07001012 return ret;
1013}
1014
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001015static bool isFromSystemChannel()
1016{
1017 // TODO we could not figure out where the request is from based on IPMI
1018 // command handler parameters. because of it, we can not differentiate
1019 // request from SMS/SMM or IPMB channel
1020 return true;
1021}
1022
1023ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
1024 ipmi_request_t request,
1025 ipmi_response_t response,
1026 ipmi_data_len_t dataLen, ipmi_context_t context)
1027{
1028 uint16_t generatorID;
1029 size_t count;
1030 bool assert = true;
1031 std::string sensorPath;
1032 size_t paraLen = *dataLen;
1033 PlatformEventRequest* req;
1034 *dataLen = 0;
1035
1036 if ((paraLen < selSystemEventSizeWith1Bytes) ||
1037 (paraLen > selSystemEventSizeWith3Bytes))
1038 {
1039 return IPMI_CC_REQ_DATA_LEN_INVALID;
1040 }
1041
1042 if (isFromSystemChannel())
1043 { // first byte for SYSTEM Interface is Generator ID
1044 // +1 to get common struct
1045 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1);
1046 // Capture the generator ID
1047 generatorID = *reinterpret_cast<uint8_t*>(request);
1048 // Platform Event usually comes from other firmware, like BIOS.
1049 // Unlike BMC sensor, it does not have BMC DBUS sensor path.
1050 sensorPath = "System";
1051 }
1052 else
1053 {
1054 req = reinterpret_cast<PlatformEventRequest*>(request);
1055 // TODO GenratorID for IPMB is combination of RqSA and RqLUN
1056 generatorID = 0xff;
1057 sensorPath = "IPMB";
1058 }
1059 // Content of event data field depends on sensor class.
1060 // When data0 bit[5:4] is non-zero, valid data counts is 3.
1061 // When data0 bit[7:6] is non-zero, valid data counts is 2.
1062 if (((req->data[0] & byte3EnableMask) != 0 &&
1063 paraLen < selSystemEventSizeWith3Bytes) ||
1064 ((req->data[0] & byte2EnableMask) != 0 &&
1065 paraLen < selSystemEventSizeWith2Bytes))
1066 {
1067 return IPMI_CC_REQ_DATA_LEN_INVALID;
1068 }
1069
1070 // Count bytes of Event Data
1071 if ((req->data[0] & byte3EnableMask) != 0)
1072 {
1073 count = 3;
1074 }
1075 else if ((req->data[0] & byte2EnableMask) != 0)
1076 {
1077 count = 2;
1078 }
1079 else
1080 {
1081 count = 1;
1082 }
1083 assert = req->eventDirectionType & directionMask ? false : true;
1084 std::vector<uint8_t> eventData(req->data, req->data + count);
1085
1086 sdbusplus::bus::bus dbus(bus);
1087 std::string service =
1088 ipmi::getService(dbus, ipmiSELAddInterface, ipmiSELPath);
1089 sdbusplus::message::message writeSEL = dbus.new_method_call(
1090 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd");
1091 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert,
1092 generatorID);
1093 try
1094 {
1095 dbus.call(writeSEL);
1096 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001097 catch (const sdbusplus::exception_t& e)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001098 {
1099 phosphor::logging::log<phosphor::logging::level::ERR>(e.what());
1100 return IPMI_CC_UNSPECIFIED_ERROR;
1101 }
1102 return IPMI_CC_OK;
1103}
1104
Chris Austenac4604a2015-10-13 12:43:27 -05001105void register_netfn_sen_functions()
1106{
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001107 // <Platform Event Message>
1108 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr,
1109 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR);
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001110
Tom05732372016-09-06 17:21:23 +05301111 // <Get Sensor Type>
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001112 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1113 ipmi::sensor_event::cmdGetSensorType,
1114 ipmi::Privilege::User, ipmiGetSensorType);
Chris Austenac4604a2015-10-13 12:43:27 -05001115
Tom05732372016-09-06 17:21:23 +05301116 // <Set Sensor Reading and Event Status>
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +00001117 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1118 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts,
1119 ipmi::Privilege::Operator, ipmiSetSensorReading);
Tom05732372016-09-06 17:21:23 +05301120 // <Get Sensor Reading>
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +00001121 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1122 ipmi::sensor_event::cmdGetSensorReading,
1123 ipmi::Privilege::User, ipmiSensorGetSensorReading);
Emily Shaffera344afc2017-04-13 15:09:39 -07001124
Tom Joseph5ca50952018-02-22 00:33:38 +05301125 // <Reserve Device SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001126 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1127 ipmi::sensor_event::cmdReserveDeviceSdrRepository,
1128 ipmi::Privilege::User, ipmiSensorReserveSdr);
Chris Austen10ccc0f2015-12-10 18:27:04 -06001129
Tom Joseph5ca50952018-02-22 00:33:38 +05301130 // <Get Device SDR Info>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001131 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1132 ipmi::sensor_event::cmdGetDeviceSdrInfo,
1133 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001134
Tom Joseph5ca50952018-02-22 00:33:38 +05301135 // <Get Device SDR>
Patrick Venture0b02be92018-08-31 11:55:55 -07001136 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr,
1137 ipmi_sen_get_sdr, PRIVILEGE_USER);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001138
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001139 // <Get Sensor Thresholds>
jayaprakash Mutyala996c9792019-05-03 15:56:48 +00001140 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1141 ipmi::sensor_event::cmdGetSensorThreshold,
1142 ipmi::Privilege::User, ipmiSensorGetSensorThresholds);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001143
Chris Austenac4604a2015-10-13 12:43:27 -05001144 return;
1145}