blob: edd48060da828e95dcf23b1d77cbaa92d29e7edf [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
353 ipmi::sensor::SetSensorReadingReq cmdData;
354
355 cmdData.number = sensorNumber;
356 cmdData.operation = operation;
357 cmdData.reading = reading;
358 cmdData.assertOffset0_7 = assertOffset0_7;
359 cmdData.assertOffset8_14 = assertOffset8_14;
360 cmdData.deassertOffset0_7 = deassertOffset0_7;
361 cmdData.deassertOffset8_14 = deassertOffset8_14;
362 cmdData.eventData1 = eventData1;
363 cmdData.eventData2 = eventData2;
364 cmdData.eventData3 = eventData3;
Tom Josephbe703f72017-03-09 12:34:35 +0530365
366 // Check if the Sensor Number is present
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700367 const auto iter = ipmi::sensor::sensors.find(sensorNumber);
368 if (iter == ipmi::sensor::sensors.end())
Tom Josephbe703f72017-03-09 12:34:35 +0530369 {
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000370 updateSensorRecordFromSSRAESC(&sensorNumber);
371 return ipmi::responseSuccess();
Tom Josephbe703f72017-03-09 12:34:35 +0530372 }
373
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500374 try
375 {
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500376 if (ipmi::sensor::Mutability::Write !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700377 (iter->second.mutability & ipmi::sensor::Mutability::Write))
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500378 {
379 log<level::ERR>("Sensor Set operation is not allowed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000380 entry("SENSOR_NUM=%d", sensorNumber));
381 return ipmi::responseIllegalCommand();
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500382 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000383 auto ipmiRC = iter->second.updateFunc(cmdData, iter->second);
384 return ipmi::response(ipmiRC);
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500385 }
386 catch (InternalFailure& e)
387 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700388 log<level::ERR>("Set sensor failed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000389 entry("SENSOR_NUM=%d", sensorNumber));
Patrick Venture0b02be92018-08-31 11:55:55 -0700390 commit<InternalFailure>();
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000391 return ipmi::responseUnspecifiedError();
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500392 }
Tom Joseph82024322017-09-28 20:07:29 +0530393 catch (const std::runtime_error& e)
394 {
395 log<level::ERR>(e.what());
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000396 return ipmi::responseUnspecifiedError();
Tom Joseph82024322017-09-28 20:07:29 +0530397 }
Chris Austenac4604a2015-10-13 12:43:27 -0500398}
399
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000400/** @brief implements the get sensor reading command
401 * @param sensorNum - sensor number
402 *
403 * @returns IPMI completion code plus response data
404 * - senReading - sensor reading
405 * - reserved
406 * - readState - sensor reading state enabled
407 * - senScanState - sensor scan state disabled
408 * - allEventMessageState - all Event message state disabled
409 * - assertionStatesLsb - threshold levels states
410 * - assertionStatesMsb - discrete reading sensor states
411 */
412ipmi::RspType<uint8_t, // sensor reading
Tom Joseph3ee668f2018-03-02 19:49:17 +0530413
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000414 uint5_t, // reserved
415 bool, // reading state
Sui Chen4cc42552019-09-11 10:28:35 -0700416 bool, // 0 = sensor scanning state disabled
417 bool, // 0 = all event messages disabled
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000418
419 uint8_t, // threshold levels states
420 uint8_t // discrete reading sensor states
421 >
422 ipmiSensorGetSensorReading(uint8_t sensorNum)
423{
424 if (sensorNum == 0xFF)
425 {
426 return ipmi::responseInvalidFieldRequest();
427 }
428
429 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700430 if (iter == ipmi::sensor::sensors.end())
Tom Joseph3ee668f2018-03-02 19:49:17 +0530431 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000432 return ipmi::responseSensorInvalid();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530433 }
434 if (ipmi::sensor::Mutability::Read !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700435 (iter->second.mutability & ipmi::sensor::Mutability::Read))
Tom Joseph3ee668f2018-03-02 19:49:17 +0530436 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000437 return ipmi::responseIllegalCommand();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530438 }
439
440 try
441 {
Sui Chen4cc42552019-09-11 10:28:35 -0700442 ipmi::sensor::GetSensorResponse getResponse =
443 iter->second.getFunc(iter->second);
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000444
Sui Chen4cc42552019-09-11 10:28:35 -0700445 return ipmi::responseSuccess(getResponse.reading, uint5_t(0),
446 getResponse.readingOrStateUnavailable,
447 getResponse.scanningEnabled,
448 getResponse.allEventMessagesEnabled,
449 getResponse.thresholdLevelsStates,
450 getResponse.discreteReadingSensorStates);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530451 }
Brandon Kim9cf85622019-06-19 12:05:08 -0700452#ifdef UPDATE_FUNCTIONAL_ON_FAIL
453 catch (const SensorFunctionalError& e)
454 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000455 return ipmi::responseResponseError();
Brandon Kim9cf85622019-06-19 12:05:08 -0700456 }
457#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530458 catch (const std::exception& e)
459 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000460 // Intitilizing with default values
461 constexpr uint8_t senReading = 0;
462 constexpr uint5_t reserved{0};
463 constexpr bool readState = true;
464 constexpr bool senScanState = false;
465 constexpr bool allEventMessageState = false;
466 constexpr uint8_t assertionStatesLsb = 0;
467 constexpr uint8_t assertionStatesMsb = 0;
468
469 return ipmi::responseSuccess(senReading, reserved, readState,
470 senScanState, allEventMessageState,
471 assertionStatesLsb, assertionStatesMsb);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530472 }
473}
474
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300475get_sdr::GetSensorThresholdsResponse
476 getSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600477{
William A. Kennington III515bc372020-10-27 16:32:32 -0700478 get_sdr::GetSensorThresholdsResponse resp{};
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530479 constexpr auto warningThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600480 "xyz.openbmc_project.Sensor.Threshold.Warning";
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530481 constexpr auto criticalThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600482 "xyz.openbmc_project.Sensor.Threshold.Critical";
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600483
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700484 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530485 const auto info = iter->second;
486
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300487 std::string service;
488 boost::system::error_code ec;
489 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
490 if (ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530491 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300492 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530493 }
494
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300495 ipmi::PropertyMap warnThresholds;
496 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
497 warningThreshIntf, warnThresholds);
498 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530499 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300500 double warnLow = std::visit(ipmi::VariantToDoubleVisitor(),
501 warnThresholds["WarningLow"]);
502 double warnHigh = std::visit(ipmi::VariantToDoubleVisitor(),
503 warnThresholds["WarningHigh"]);
504
505 if (std::isfinite(warnLow))
506 {
507 warnLow *= std::pow(10, info.scale - info.exponentR);
508 resp.lowerNonCritical = static_cast<uint8_t>(
509 (warnLow - info.scaledOffset) / info.coefficientM);
510 resp.validMask |= static_cast<uint8_t>(
511 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK);
512 }
513
514 if (std::isfinite(warnHigh))
515 {
516 warnHigh *= std::pow(10, info.scale - info.exponentR);
517 resp.upperNonCritical = static_cast<uint8_t>(
518 (warnHigh - info.scaledOffset) / info.coefficientM);
519 resp.validMask |= static_cast<uint8_t>(
520 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK);
521 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530522 }
523
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300524 ipmi::PropertyMap critThresholds;
525 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
526 criticalThreshIntf, critThresholds);
527 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530528 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300529 double critLow = std::visit(ipmi::VariantToDoubleVisitor(),
530 critThresholds["CriticalLow"]);
531 double critHigh = std::visit(ipmi::VariantToDoubleVisitor(),
532 critThresholds["CriticalHigh"]);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530533
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300534 if (std::isfinite(critLow))
535 {
536 critLow *= std::pow(10, info.scale - info.exponentR);
537 resp.lowerCritical = static_cast<uint8_t>(
538 (critLow - info.scaledOffset) / info.coefficientM);
539 resp.validMask |= static_cast<uint8_t>(
540 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK);
541 }
542
543 if (std::isfinite(critHigh))
544 {
545 critHigh *= std::pow(10, info.scale - info.exponentR);
546 resp.upperCritical = static_cast<uint8_t>(
547 (critHigh - info.scaledOffset) / info.coefficientM);
548 resp.validMask |= static_cast<uint8_t>(
549 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK);
550 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530551 }
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000552
553 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530554}
555
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000556/** @brief implements the get sensor thresholds command
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300557 * @param ctx - IPMI context pointer
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000558 * @param sensorNum - sensor number
559 *
560 * @returns IPMI completion code plus response data
561 * - validMask - threshold mask
562 * - lower non-critical threshold - IPMI messaging state
563 * - lower critical threshold - link authentication state
564 * - lower non-recoverable threshold - callback state
565 * - upper non-critical threshold
566 * - upper critical
567 * - upper non-recoverable
568 */
569ipmi::RspType<uint8_t, // validMask
570 uint8_t, // lowerNonCritical
571 uint8_t, // lowerCritical
572 uint8_t, // lowerNonRecoverable
573 uint8_t, // upperNonCritical
574 uint8_t, // upperCritical
575 uint8_t // upperNonRecoverable
576 >
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300577 ipmiSensorGetSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530578{
579 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
580
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700581 const auto iter = ipmi::sensor::sensors.find(sensorNum);
582 if (iter == ipmi::sensor::sensors.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600583 {
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000584 return ipmi::responseSensorInvalid();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600585 }
586
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530587 const auto info = iter->second;
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600588
Patrick Venture0b02be92018-08-31 11:55:55 -0700589 // Proceed only if the sensor value interface is implemented.
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530590 if (info.propertyInterfaces.find(valueInterface) ==
591 info.propertyInterfaces.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600592 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700593 // return with valid mask as 0
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000594 return ipmi::responseSuccess();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600595 }
596
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000597 get_sdr::GetSensorThresholdsResponse resp{};
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300598 resp = getSensorThresholds(ctx, sensorNum);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600599
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000600 return ipmi::responseSuccess(resp.validMask, resp.lowerNonCritical,
601 resp.lowerCritical, resp.lowerNonRecoverable,
602 resp.upperNonCritical, resp.upperCritical,
603 resp.upperNonRecoverable);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600604}
605
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000606/** @brief implements the get SDR Info command
607 * @param count - Operation
608 *
609 * @returns IPMI completion code plus response data
610 * - sdrCount - sensor/SDR count
611 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag
612 */
613ipmi::RspType<uint8_t, // respcount
614 uint8_t // dynamic population flags
615 >
616 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700617{
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000618 uint8_t sdrCount;
619 // multiple LUNs not supported.
620 constexpr uint8_t lunsAndDynamicPopulation = 1;
621 constexpr uint8_t getSdrCount = 0x01;
622 constexpr uint8_t getSensorCount = 0x00;
623
624 if (count.value_or(0) == getSdrCount)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700625 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000626 // Get SDR count. This returns the total number of SDRs in the device.
Patrick Venture87fd2cd2019-08-19 12:07:18 -0700627 const auto& entityRecords =
628 ipmi::sensor::EntityInfoMapContainer::getContainer()
629 ->getIpmiEntityRecords();
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700630 sdrCount =
631 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size();
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000632 }
633 else if (count.value_or(0) == getSensorCount)
634 {
635 // Get Sensor count. This returns the number of sensors
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700636 sdrCount = ipmi::sensor::sensors.size();
Emily Shafferd06e0e72017-04-05 09:08:57 -0700637 }
638 else
639 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000640 return ipmi::responseInvalidCommandOnLun();
Emily Shafferd06e0e72017-04-05 09:08:57 -0700641 }
642
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000643 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation);
Emily Shafferd06e0e72017-04-05 09:08:57 -0700644}
645
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000646/** @brief implements the reserve SDR command
647 * @returns IPMI completion code plus response data
648 * - reservationID - reservation ID
649 */
650ipmi::RspType<uint16_t> ipmiSensorReserveSdr()
Emily Shaffera344afc2017-04-13 15:09:39 -0700651{
652 // A constant reservation ID is okay until we implement add/remove SDR.
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000653 constexpr uint16_t reservationID = 1;
Emily Shaffera344afc2017-04-13 15:09:39 -0700654
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000655 return ipmi::responseSuccess(reservationID);
Emily Shaffera344afc2017-04-13 15:09:39 -0700656}
Chris Austenac4604a2015-10-13 12:43:27 -0500657
Patrick Venture0b02be92018-08-31 11:55:55 -0700658void setUnitFieldsForObject(const ipmi::sensor::Info* info,
659 get_sdr::SensorDataFullRecordBody* body)
Emily Shaffercc941e12017-06-14 13:06:26 -0700660{
Tom Josephdc212b22018-02-16 09:59:57 +0530661 namespace server = sdbusplus::xyz::openbmc_project::Sensor::server;
662 try
Emily Shaffercc941e12017-06-14 13:06:26 -0700663 {
Tom Josephdc212b22018-02-16 09:59:57 +0530664 auto unit = server::Value::convertUnitFromString(info->unit);
665 // Unit strings defined in
666 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml
667 switch (unit)
Emily Shaffercc941e12017-06-14 13:06:26 -0700668 {
Tom Josephdc212b22018-02-16 09:59:57 +0530669 case server::Value::Unit::DegreesC:
670 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C;
671 break;
672 case server::Value::Unit::RPMS:
Kirill Pakhomov812e44c2018-10-22 16:25:35 +0300673 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM;
Tom Josephdc212b22018-02-16 09:59:57 +0530674 break;
675 case server::Value::Unit::Volts:
676 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS;
677 break;
678 case server::Value::Unit::Meters:
679 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS;
680 break;
681 case server::Value::Unit::Amperes:
682 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES;
683 break;
684 case server::Value::Unit::Joules:
685 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES;
686 break;
687 case server::Value::Unit::Watts:
688 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS;
689 break;
690 default:
691 // Cannot be hit.
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700692 std::fprintf(stderr, "Unknown value unit type: = %s\n",
693 info->unit.c_str());
Emily Shaffercc941e12017-06-14 13:06:26 -0700694 }
695 }
Patrick Venture64678b82018-10-13 13:11:32 -0700696 catch (const sdbusplus::exception::InvalidEnumString& e)
Emily Shaffercc941e12017-06-14 13:06:26 -0700697 {
Tom Josephdc212b22018-02-16 09:59:57 +0530698 log<level::WARNING>("Warning: no unit provided for sensor!");
Emily Shaffercc941e12017-06-14 13:06:26 -0700699 }
Emily Shaffercc941e12017-06-14 13:06:26 -0700700}
701
Patrick Venture0b02be92018-08-31 11:55:55 -0700702ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body,
703 const ipmi::sensor::Info* info,
Emily Shafferbbef71c2017-05-08 16:36:17 -0700704 ipmi_data_len_t data_len)
705{
706 /* Functional sensor case */
Emily Shaffercc941e12017-06-14 13:06:26 -0700707 if (isAnalogSensor(info->propertyInterfaces.begin()->first))
Emily Shafferbbef71c2017-05-08 16:36:17 -0700708 {
Emily Shafferbbef71c2017-05-08 16:36:17 -0700709
710 body->sensor_units_1 = 0; // unsigned, no rate, no modifier, not a %
711
712 /* Unit info */
Tom Josephdc212b22018-02-16 09:59:57 +0530713 setUnitFieldsForObject(info, body);
Emily Shaffer10f49592017-05-10 12:01:10 -0700714
715 get_sdr::body::set_b(info->coefficientB, body);
716 get_sdr::body::set_m(info->coefficientM, body);
717 get_sdr::body::set_b_exp(info->exponentB, body);
Tom Josephdc212b22018-02-16 09:59:57 +0530718 get_sdr::body::set_r_exp(info->exponentR, body);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700719
Emily Shafferbbef71c2017-05-08 16:36:17 -0700720 get_sdr::body::set_id_type(0b00, body); // 00 = unicode
Emily Shafferbbef71c2017-05-08 16:36:17 -0700721 }
722
Tom Joseph96423912018-01-25 00:14:34 +0530723 /* ID string */
Jeremy Kerrbe4ffa82020-08-10 16:17:37 +0800724 auto id_string = info->sensorName;
725
726 if (id_string.empty())
727 {
728 id_string = info->sensorNameFunc(*info);
729 }
Tom Joseph96423912018-01-25 00:14:34 +0530730
731 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH)
732 {
733 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body);
734 }
735 else
736 {
737 get_sdr::body::set_id_strlen(id_string.length(), body);
738 }
739 strncpy(body->id_string, id_string.c_str(),
740 get_sdr::body::get_id_strlen(body));
741
Emily Shafferbbef71c2017-05-08 16:36:17 -0700742 return IPMI_CC_OK;
743};
744
Ratan Guptae0cc8552018-01-22 14:23:04 +0530745ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response,
746 ipmi_data_len_t data_len)
747{
748 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
749 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
Patrick Venture0b02be92018-08-31 11:55:55 -0700750 get_sdr::SensorDataFruRecord record{};
Ratan Guptae0cc8552018-01-22 14:23:04 +0530751 auto dataLength = 0;
752
753 auto fru = frus.begin();
Patrick Venture0b02be92018-08-31 11:55:55 -0700754 uint8_t fruID{};
Ratan Guptae0cc8552018-01-22 14:23:04 +0530755 auto recordID = get_sdr::request::get_record_id(req);
756
757 fruID = recordID - FRU_RECORD_ID_START;
758 fru = frus.find(fruID);
759 if (fru == frus.end())
760 {
761 return IPMI_CC_SENSOR_INVALID;
762 }
763
764 /* Header */
765 get_sdr::header::set_record_id(recordID, &(record.header));
766 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
767 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD;
768 record.header.record_length = sizeof(record.key) + sizeof(record.body);
769
770 /* Key */
771 record.key.fruID = fruID;
772 record.key.accessLun |= IPMI_LOGICAL_FRU;
773 record.key.deviceAddress = BMCSlaveAddress;
774
775 /* Body */
776 record.body.entityID = fru->second[0].entityID;
777 record.body.entityInstance = fru->second[0].entityInstance;
778 record.body.deviceType = fruInventoryDevice;
779 record.body.deviceTypeModifier = IPMIFruInventory;
780
781 /* Device ID string */
Patrick Venture0b02be92018-08-31 11:55:55 -0700782 auto deviceID =
783 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1,
784 fru->second[0].path.length());
Ratan Guptae0cc8552018-01-22 14:23:04 +0530785
786 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH)
787 {
788 get_sdr::body::set_device_id_strlen(
Patrick Venture0b02be92018-08-31 11:55:55 -0700789 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +0530790 }
791 else
792 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700793 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +0530794 }
795
796 strncpy(record.body.deviceID, deviceID.c_str(),
797 get_sdr::body::get_device_id_strlen(&(record.body)));
798
799 if (++fru == frus.end())
800 {
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800801 // we have reached till end of fru, so assign the next record id to
802 // 512(Max fru ID = 511) + Entity Record ID(may start with 0).
Patrick Venture87fd2cd2019-08-19 12:07:18 -0700803 const auto& entityRecords =
804 ipmi::sensor::EntityInfoMapContainer::getContainer()
805 ->getIpmiEntityRecords();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800806 auto next_record_id =
Patrick Venture83a0b842019-07-19 18:37:15 -0700807 (entityRecords.size())
808 ? entityRecords.begin()->first + ENTITY_RECORD_ID_START
809 : END_OF_RECORD;
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800810 get_sdr::response::set_next_record_id(next_record_id, resp);
811 }
812 else
813 {
814 get_sdr::response::set_next_record_id(
815 (FRU_RECORD_ID_START + fru->first), resp);
816 }
817
818 // Check for invalid offset size
819 if (req->offset > sizeof(record))
820 {
821 return IPMI_CC_PARM_OUT_OF_RANGE;
822 }
823
824 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
825 sizeof(record) - req->offset);
826
827 std::memcpy(resp->record_data,
828 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
829
830 *data_len = dataLength;
831 *data_len += 2; // additional 2 bytes for next record ID
832
833 return IPMI_CC_OK;
834}
835
836ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response,
837 ipmi_data_len_t data_len)
838{
839 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
840 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
841 get_sdr::SensorDataEntityRecord record{};
842 auto dataLength = 0;
843
Patrick Venture87fd2cd2019-08-19 12:07:18 -0700844 const auto& entityRecords =
845 ipmi::sensor::EntityInfoMapContainer::getContainer()
846 ->getIpmiEntityRecords();
Patrick Venture83a0b842019-07-19 18:37:15 -0700847 auto entity = entityRecords.begin();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800848 uint8_t entityRecordID;
849 auto recordID = get_sdr::request::get_record_id(req);
850
851 entityRecordID = recordID - ENTITY_RECORD_ID_START;
Patrick Venture83a0b842019-07-19 18:37:15 -0700852 entity = entityRecords.find(entityRecordID);
853 if (entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800854 {
855 return IPMI_CC_SENSOR_INVALID;
856 }
857
858 /* Header */
859 get_sdr::header::set_record_id(recordID, &(record.header));
860 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
861 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD;
862 record.header.record_length = sizeof(record.key) + sizeof(record.body);
863
864 /* Key */
865 record.key.containerEntityId = entity->second.containerEntityId;
866 record.key.containerEntityInstance = entity->second.containerEntityInstance;
867 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked,
868 &(record.key));
869 record.key.entityId1 = entity->second.containedEntities[0].first;
870 record.key.entityInstance1 = entity->second.containedEntities[0].second;
871
872 /* Body */
873 record.body.entityId2 = entity->second.containedEntities[1].first;
874 record.body.entityInstance2 = entity->second.containedEntities[1].second;
875 record.body.entityId3 = entity->second.containedEntities[2].first;
876 record.body.entityInstance3 = entity->second.containedEntities[2].second;
877 record.body.entityId4 = entity->second.containedEntities[3].first;
878 record.body.entityInstance4 = entity->second.containedEntities[3].second;
879
Patrick Venture83a0b842019-07-19 18:37:15 -0700880 if (++entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800881 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700882 get_sdr::response::set_next_record_id(END_OF_RECORD,
883 resp); // last record
Ratan Guptae0cc8552018-01-22 14:23:04 +0530884 }
885 else
886 {
887 get_sdr::response::set_next_record_id(
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800888 (ENTITY_RECORD_ID_START + entity->first), resp);
Ratan Guptae0cc8552018-01-22 14:23:04 +0530889 }
890
Emily Shaffer0fbdbce2018-09-27 09:30:41 -0700891 // Check for invalid offset size
892 if (req->offset > sizeof(record))
Ratan Guptae0cc8552018-01-22 14:23:04 +0530893 {
Emily Shaffer0fbdbce2018-09-27 09:30:41 -0700894 return IPMI_CC_PARM_OUT_OF_RANGE;
Ratan Guptae0cc8552018-01-22 14:23:04 +0530895 }
896
Emily Shaffer0fbdbce2018-09-27 09:30:41 -0700897 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
898 sizeof(record) - req->offset);
Ratan Guptae0cc8552018-01-22 14:23:04 +0530899
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700900 std::memcpy(resp->record_data,
Jason M. Bills1cd85962018-10-05 12:04:01 -0700901 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
Ratan Guptae0cc8552018-01-22 14:23:04 +0530902
903 *data_len = dataLength;
904 *data_len += 2; // additional 2 bytes for next record ID
905
906 return IPMI_CC_OK;
907}
908
Emily Shafferbbef71c2017-05-08 16:36:17 -0700909ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
910 ipmi_request_t request, ipmi_response_t response,
911 ipmi_data_len_t data_len, ipmi_context_t context)
912{
913 ipmi_ret_t ret = IPMI_CC_OK;
Patrick Venture0b02be92018-08-31 11:55:55 -0700914 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request;
915 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700916 get_sdr::SensorDataFullRecord record = {0};
Patrick Venture38426dd2019-07-30 15:22:29 -0700917
918 // Note: we use an iterator so we can provide the next ID at the end of
919 // the call.
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700920 auto sensor = ipmi::sensor::sensors.begin();
Patrick Venture38426dd2019-07-30 15:22:29 -0700921 auto recordID = get_sdr::request::get_record_id(req);
922
923 // At the beginning of a scan, the host side will send us id=0.
924 if (recordID != 0)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700925 {
Patrick Venture38426dd2019-07-30 15:22:29 -0700926 // recordID 0 to 255 means it is a FULL record.
927 // recordID 256 to 511 means it is a FRU record.
928 // recordID greater then 511 means it is a Entity Association
929 // record. Currently we are supporting three record types: FULL
930 // record, FRU record and Enttiy Association record.
931 if (recordID >= ENTITY_RECORD_ID_START)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700932 {
Patrick Venture38426dd2019-07-30 15:22:29 -0700933 return ipmi_entity_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700934 }
Patrick Venture38426dd2019-07-30 15:22:29 -0700935 else if (recordID >= FRU_RECORD_ID_START &&
936 recordID < ENTITY_RECORD_ID_START)
Jaghathiswari Rankappagounder Natarajan0780df12019-02-06 15:29:24 -0800937 {
Patrick Venture38426dd2019-07-30 15:22:29 -0700938 return ipmi_fru_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700939 }
940 else
941 {
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700942 sensor = ipmi::sensor::sensors.find(recordID);
943 if (sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -0700944 {
945 return IPMI_CC_SENSOR_INVALID;
946 }
Emily Shafferbbef71c2017-05-08 16:36:17 -0700947 }
Emily Shafferbbef71c2017-05-08 16:36:17 -0700948 }
949
Patrick Venture38426dd2019-07-30 15:22:29 -0700950 uint8_t sensor_id = sensor->first;
951
952 /* Header */
953 get_sdr::header::set_record_id(sensor_id, &(record.header));
954 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1
955 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
Patrick Venture158ac702021-03-25 20:02:54 -0700956 record.header.record_length = sizeof(record.key) + sizeof(record.body);
Patrick Venture38426dd2019-07-30 15:22:29 -0700957
958 /* Key */
959 get_sdr::key::set_owner_id_bmc(&(record.key));
960 record.key.sensor_number = sensor_id;
961
962 /* Body */
963 record.body.entity_id = sensor->second.entityType;
964 record.body.sensor_type = sensor->second.sensorType;
965 record.body.event_reading_type = sensor->second.sensorReadingType;
966 record.body.entity_instance = sensor->second.instance;
967 if (ipmi::sensor::Mutability::Write ==
968 (sensor->second.mutability & ipmi::sensor::Mutability::Write))
969 {
970 get_sdr::body::init_settable_state(true, &(record.body));
971 }
972
973 // Set the type-specific details given the DBus interface
974 ret =
975 populate_record_from_dbus(&(record.body), &(sensor->second), data_len);
976
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700977 if (++sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -0700978 {
979 // we have reached till end of sensor, so assign the next record id
980 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0).
981 auto next_record_id = (frus.size())
982 ? frus.begin()->first + FRU_RECORD_ID_START
983 : END_OF_RECORD;
984
985 get_sdr::response::set_next_record_id(next_record_id, resp);
986 }
987 else
988 {
989 get_sdr::response::set_next_record_id(sensor->first, resp);
990 }
991
992 if (req->offset > sizeof(record))
993 {
994 return IPMI_CC_PARM_OUT_OF_RANGE;
995 }
996
997 // data_len will ultimately be the size of the record, plus
998 // the size of the next record ID:
999 *data_len = std::min(static_cast<size_t>(req->bytes_to_read),
1000 sizeof(record) - req->offset);
1001
1002 std::memcpy(resp->record_data,
1003 reinterpret_cast<uint8_t*>(&record) + req->offset, *data_len);
1004
1005 // data_len should include the LSB and MSB:
1006 *data_len +=
1007 sizeof(resp->next_record_id_lsb) + sizeof(resp->next_record_id_msb);
1008
Emily Shafferbbef71c2017-05-08 16:36:17 -07001009 return ret;
1010}
1011
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001012static bool isFromSystemChannel()
1013{
1014 // TODO we could not figure out where the request is from based on IPMI
1015 // command handler parameters. because of it, we can not differentiate
1016 // request from SMS/SMM or IPMB channel
1017 return true;
1018}
1019
1020ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
1021 ipmi_request_t request,
1022 ipmi_response_t response,
1023 ipmi_data_len_t dataLen, ipmi_context_t context)
1024{
1025 uint16_t generatorID;
1026 size_t count;
1027 bool assert = true;
1028 std::string sensorPath;
1029 size_t paraLen = *dataLen;
1030 PlatformEventRequest* req;
1031 *dataLen = 0;
1032
1033 if ((paraLen < selSystemEventSizeWith1Bytes) ||
1034 (paraLen > selSystemEventSizeWith3Bytes))
1035 {
1036 return IPMI_CC_REQ_DATA_LEN_INVALID;
1037 }
1038
1039 if (isFromSystemChannel())
1040 { // first byte for SYSTEM Interface is Generator ID
1041 // +1 to get common struct
1042 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1);
1043 // Capture the generator ID
1044 generatorID = *reinterpret_cast<uint8_t*>(request);
1045 // Platform Event usually comes from other firmware, like BIOS.
1046 // Unlike BMC sensor, it does not have BMC DBUS sensor path.
1047 sensorPath = "System";
1048 }
1049 else
1050 {
1051 req = reinterpret_cast<PlatformEventRequest*>(request);
1052 // TODO GenratorID for IPMB is combination of RqSA and RqLUN
1053 generatorID = 0xff;
1054 sensorPath = "IPMB";
1055 }
1056 // Content of event data field depends on sensor class.
1057 // When data0 bit[5:4] is non-zero, valid data counts is 3.
1058 // When data0 bit[7:6] is non-zero, valid data counts is 2.
1059 if (((req->data[0] & byte3EnableMask) != 0 &&
1060 paraLen < selSystemEventSizeWith3Bytes) ||
1061 ((req->data[0] & byte2EnableMask) != 0 &&
1062 paraLen < selSystemEventSizeWith2Bytes))
1063 {
1064 return IPMI_CC_REQ_DATA_LEN_INVALID;
1065 }
1066
1067 // Count bytes of Event Data
1068 if ((req->data[0] & byte3EnableMask) != 0)
1069 {
1070 count = 3;
1071 }
1072 else if ((req->data[0] & byte2EnableMask) != 0)
1073 {
1074 count = 2;
1075 }
1076 else
1077 {
1078 count = 1;
1079 }
1080 assert = req->eventDirectionType & directionMask ? false : true;
1081 std::vector<uint8_t> eventData(req->data, req->data + count);
1082
1083 sdbusplus::bus::bus dbus(bus);
1084 std::string service =
1085 ipmi::getService(dbus, ipmiSELAddInterface, ipmiSELPath);
1086 sdbusplus::message::message writeSEL = dbus.new_method_call(
1087 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd");
1088 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert,
1089 generatorID);
1090 try
1091 {
1092 dbus.call(writeSEL);
1093 }
1094 catch (sdbusplus::exception_t& e)
1095 {
1096 phosphor::logging::log<phosphor::logging::level::ERR>(e.what());
1097 return IPMI_CC_UNSPECIFIED_ERROR;
1098 }
1099 return IPMI_CC_OK;
1100}
1101
Chris Austenac4604a2015-10-13 12:43:27 -05001102void register_netfn_sen_functions()
1103{
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001104 // <Platform Event Message>
1105 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr,
1106 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR);
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001107
Tom05732372016-09-06 17:21:23 +05301108 // <Get Sensor Type>
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001109 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1110 ipmi::sensor_event::cmdGetSensorType,
1111 ipmi::Privilege::User, ipmiGetSensorType);
Chris Austenac4604a2015-10-13 12:43:27 -05001112
Tom05732372016-09-06 17:21:23 +05301113 // <Set Sensor Reading and Event Status>
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +00001114 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1115 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts,
1116 ipmi::Privilege::Operator, ipmiSetSensorReading);
Tom05732372016-09-06 17:21:23 +05301117 // <Get Sensor Reading>
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +00001118 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1119 ipmi::sensor_event::cmdGetSensorReading,
1120 ipmi::Privilege::User, ipmiSensorGetSensorReading);
Emily Shaffera344afc2017-04-13 15:09:39 -07001121
Tom Joseph5ca50952018-02-22 00:33:38 +05301122 // <Reserve Device SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001123 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1124 ipmi::sensor_event::cmdReserveDeviceSdrRepository,
1125 ipmi::Privilege::User, ipmiSensorReserveSdr);
Chris Austen10ccc0f2015-12-10 18:27:04 -06001126
Tom Joseph5ca50952018-02-22 00:33:38 +05301127 // <Get Device SDR Info>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001128 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1129 ipmi::sensor_event::cmdGetDeviceSdrInfo,
1130 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001131
Tom Joseph5ca50952018-02-22 00:33:38 +05301132 // <Get Device SDR>
Patrick Venture0b02be92018-08-31 11:55:55 -07001133 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr,
1134 ipmi_sen_get_sdr, PRIVILEGE_USER);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001135
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001136 // <Get Sensor Thresholds>
jayaprakash Mutyala996c9792019-05-03 15:56:48 +00001137 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1138 ipmi::sensor_event::cmdGetSensorThreshold,
1139 ipmi::Privilege::User, ipmiSensorGetSensorThresholds);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001140
Chris Austenac4604a2015-10-13 12:43:27 -05001141 return;
1142}