blob: 84b6e9df2bdada48d2fa54fc5f1fe854a7756a3e [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
Vernon Mauerye08fbff2019-04-03 09:19:34 -070011#include <ipmid/api.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070012#include <ipmid/types.hpp>
Vernon Mauery6a98fe72019-03-11 15:57:48 -070013#include <ipmid/utils.hpp>
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -050014#include <phosphor-logging/elog-errors.hpp>
Patrick Venture0b02be92018-08-31 11:55:55 -070015#include <phosphor-logging/log.hpp>
William A. Kennington III4c008022018-10-12 17:18:14 -070016#include <sdbusplus/message/types.hpp>
Patrick Venture0b02be92018-08-31 11:55:55 -070017#include <xyz/openbmc_project/Common/error.hpp>
18#include <xyz/openbmc_project/Sensor/Value/server.hpp>
19
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050020#include <bitset>
21#include <cmath>
22#include <cstring>
23#include <set>
24
Ratan Guptae0cc8552018-01-22 14:23:04 +053025static constexpr uint8_t fruInventoryDevice = 0x10;
26static constexpr uint8_t IPMIFruInventory = 0x02;
27static constexpr uint8_t BMCSlaveAddress = 0x20;
28
Patrick Venture0b02be92018-08-31 11:55:55 -070029extern int updateSensorRecordFromSSRAESC(const void*);
30extern sd_bus* bus;
Patrick Venturedb0cbe62019-09-09 14:47:22 -070031
32namespace ipmi
33{
34namespace sensor
35{
36extern const IdInfoMap sensors;
37} // namespace sensor
38} // namespace ipmi
39
Ratan Guptae0cc8552018-01-22 14:23:04 +053040extern const FruMap frus;
41
Tom Josephbe703f72017-03-09 12:34:35 +053042using namespace phosphor::logging;
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -050043using InternalFailure =
44 sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
Chris Austenac4604a2015-10-13 12:43:27 -050045
Patrick Venture0b02be92018-08-31 11:55:55 -070046void register_netfn_sen_functions() __attribute__((constructor));
Chris Austenac4604a2015-10-13 12:43:27 -050047
Patrick Venture0b02be92018-08-31 11:55:55 -070048struct sensorTypemap_t
49{
Chris Austen0012e9b2015-10-22 01:37:46 -050050 uint8_t number;
Chris Austend7cf0e42015-11-07 14:27:12 -060051 uint8_t typecode;
Chris Austen0012e9b2015-10-22 01:37:46 -050052 char dbusname[32];
Patrick Venture0b02be92018-08-31 11:55:55 -070053};
Chris Austen0012e9b2015-10-22 01:37:46 -050054
Chris Austen0012e9b2015-10-22 01:37:46 -050055sensorTypemap_t g_SensorTypeMap[] = {
56
Chris Austend7cf0e42015-11-07 14:27:12 -060057 {0x01, 0x6F, "Temp"},
58 {0x0C, 0x6F, "DIMM"},
59 {0x0C, 0x6F, "MEMORY_BUFFER"},
60 {0x07, 0x6F, "PROC"},
61 {0x07, 0x6F, "CORE"},
62 {0x07, 0x6F, "CPU"},
63 {0x0F, 0x6F, "BootProgress"},
Patrick Venture0b02be92018-08-31 11:55:55 -070064 {0xe9, 0x09, "OccStatus"}, // E9 is an internal mapping to handle sensor
65 // type code os 0x09
Chris Austend7cf0e42015-11-07 14:27:12 -060066 {0xC3, 0x6F, "BootCount"},
67 {0x1F, 0x6F, "OperatingSystemStatus"},
Chris Austen800ba712015-12-03 15:31:00 -060068 {0x12, 0x6F, "SYSTEM_EVENT"},
69 {0xC7, 0x03, "SYSTEM"},
70 {0xC7, 0x03, "MAIN_PLANAR"},
Chris Austen10ccc0f2015-12-10 18:27:04 -060071 {0xC2, 0x6F, "PowerCap"},
Tom Joseph558184e2017-09-01 13:45:05 +053072 {0x0b, 0xCA, "PowerSupplyRedundancy"},
Jayanth Othayoth0661beb2017-03-22 06:00:58 -050073 {0xDA, 0x03, "TurboAllowed"},
Tom Joseph558184e2017-09-01 13:45:05 +053074 {0xD8, 0xC8, "PowerSupplyDerating"},
Chris Austend7cf0e42015-11-07 14:27:12 -060075 {0xFF, 0x00, ""},
Chris Austen0012e9b2015-10-22 01:37:46 -050076};
77
Patrick Venture0b02be92018-08-31 11:55:55 -070078struct sensor_data_t
79{
Chris Austenac4604a2015-10-13 12:43:27 -050080 uint8_t sennum;
Patrick Venture0b02be92018-08-31 11:55:55 -070081} __attribute__((packed));
Chris Austenac4604a2015-10-13 12:43:27 -050082
Lei YU14a47812021-09-17 15:58:04 +080083using SDRCacheMap = std::unordered_map<uint8_t, get_sdr::SensorDataFullRecord>;
84SDRCacheMap sdrCacheMap __attribute__((init_priority(101)));
85
86using SensorThresholdMap =
87 std::unordered_map<uint8_t, get_sdr::GetSensorThresholdsResponse>;
88SensorThresholdMap sensorThresholdMap __attribute__((init_priority(101)));
89
Lei YU962e68b2021-09-16 16:25:34 +080090#ifdef FEATURE_SENSORS_CACHE
Patrick Williams5d82f472022-07-22 19:26:53 -050091std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match_t>> sensorAddedMatches
92 __attribute__((init_priority(101)));
93std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match_t>> sensorUpdatedMatches
94 __attribute__((init_priority(101)));
95std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match_t>> sensorRemovedMatches
96 __attribute__((init_priority(101)));
97std::unique_ptr<sdbusplus::bus::match_t> sensorsOwnerMatch
Lei YU7f3a70f2021-12-07 16:40:40 +080098 __attribute__((init_priority(101)));
Lei YUbe5c6b22021-09-16 15:46:20 +080099
Lei YU97140502021-09-17 13:49:43 +0800100ipmi::sensor::SensorCacheMap sensorCacheMap __attribute__((init_priority(101)));
Lei YU8c2c0482021-09-16 17:28:28 +0800101
Lei YU7f3a70f2021-12-07 16:40:40 +0800102// It is needed to know which objects belong to which service, so that when a
103// service exits without interfacesRemoved signal, we could invaildate the cache
104// that is related to the service. It uses below two variables:
105// - idToServiceMap records which sensors are known to have a related service;
106// - serviceToIdMap maps a service to the sensors.
107using sensorIdToServiceMap = std::unordered_map<uint8_t, std::string>;
108sensorIdToServiceMap idToServiceMap __attribute__((init_priority(101)));
109
110using sensorServiceToIdMap = std::unordered_map<std::string, std::set<uint8_t>>;
111sensorServiceToIdMap serviceToIdMap __attribute__((init_priority(101)));
112
Willy Tu11d68892022-01-20 10:37:34 -0800113static void fillSensorIdServiceMap(const std::string&,
Lei YU7f3a70f2021-12-07 16:40:40 +0800114 const std::string& /*intf*/, uint8_t id,
115 const std::string& service)
116{
117 if (idToServiceMap.find(id) != idToServiceMap.end())
118 {
119 return;
120 }
121 idToServiceMap[id] = service;
122 serviceToIdMap[service].insert(id);
123}
124
125static void fillSensorIdServiceMap(const std::string& obj,
126 const std::string& intf, uint8_t id)
127{
128 if (idToServiceMap.find(id) != idToServiceMap.end())
129 {
130 return;
131 }
132 try
133 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500134 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lei YU7f3a70f2021-12-07 16:40:40 +0800135 auto service = ipmi::getService(bus, intf, obj);
136 idToServiceMap[id] = service;
137 serviceToIdMap[service].insert(id);
138 }
139 catch (...)
140 {
141 // Ignore
142 }
143}
144
Lei YUbe5c6b22021-09-16 15:46:20 +0800145void initSensorMatches()
146{
147 using namespace sdbusplus::bus::match::rules;
Patrick Williams5d82f472022-07-22 19:26:53 -0500148 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lei YUbe5c6b22021-09-16 15:46:20 +0800149 for (const auto& s : ipmi::sensor::sensors)
150 {
151 sensorAddedMatches.emplace(
152 s.first,
Patrick Williams5d82f472022-07-22 19:26:53 -0500153 std::make_unique<sdbusplus::bus::match_t>(
Lei YUbe5c6b22021-09-16 15:46:20 +0800154 bus, interfacesAdded() + argNpath(0, s.second.sensorPath),
Lei YU7f3a70f2021-12-07 16:40:40 +0800155 [id = s.first, obj = s.second.sensorPath,
156 intf = s.second.propertyInterfaces.begin()->first](
157 auto& /*msg*/) { fillSensorIdServiceMap(obj, intf, id); }));
158 sensorRemovedMatches.emplace(
159 s.first,
Patrick Williams5d82f472022-07-22 19:26:53 -0500160 std::make_unique<sdbusplus::bus::match_t>(
Lei YU7f3a70f2021-12-07 16:40:40 +0800161 bus, interfacesRemoved() + argNpath(0, s.second.sensorPath),
162 [id = s.first](auto& /*msg*/) {
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500163 // Ideally this should work.
164 // But when a service is terminated or crashed, it does not
165 // emit interfacesRemoved signal. In that case it's handled
166 // by sensorsOwnerMatch
167 sensorCacheMap[id].reset();
Lei YUbe5c6b22021-09-16 15:46:20 +0800168 }));
169 sensorUpdatedMatches.emplace(
Patrick Williams5d82f472022-07-22 19:26:53 -0500170 s.first, std::make_unique<sdbusplus::bus::match_t>(
Lei YU97140502021-09-17 13:49:43 +0800171 bus,
172 type::signal() + path(s.second.sensorPath) +
173 member("PropertiesChanged"s) +
174 interface("org.freedesktop.DBus.Properties"s),
175 [&s](auto& msg) {
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500176 fillSensorIdServiceMap(s.second.sensorPath,
177 s.second.propertyInterfaces.begin()->first,
178 s.first);
179 try
180 {
181 // This is signal callback
182 std::string interfaceName;
183 msg.read(interfaceName);
184 ipmi::PropertyMap props;
185 msg.read(props);
186 s.second.getFunc(s.first, s.second, props);
187 }
188 catch (const std::exception& e)
189 {
190 sensorCacheMap[s.first].reset();
191 }
Lei YU97140502021-09-17 13:49:43 +0800192 }));
Lei YUbe5c6b22021-09-16 15:46:20 +0800193 }
Jian Zhang4a105cd2022-08-05 22:26:42 +0800194 sensorsOwnerMatch = std::make_unique<sdbusplus::bus::match_t>(
195 bus, nameOwnerChanged(), [](auto& msg) {
196 std::string name;
197 std::string oldOwner;
198 std::string newOwner;
199 msg.read(name, oldOwner, newOwner);
200
201 if (!name.empty() && newOwner.empty())
202 {
203 // The service exits
204 const auto it = serviceToIdMap.find(name);
205 if (it == serviceToIdMap.end())
206 {
207 return;
208 }
209 for (const auto& id : it->second)
210 {
211 // Invalidate cache
212 sensorCacheMap[id].reset();
213 }
214 }
215 });
Lei YUbe5c6b22021-09-16 15:46:20 +0800216}
Lei YU962e68b2021-09-16 16:25:34 +0800217#endif
Lei YUbe5c6b22021-09-16 15:46:20 +0800218
Patrick Venture0b02be92018-08-31 11:55:55 -0700219int get_bus_for_path(const char* path, char** busname)
220{
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700221 return mapper_get_service(bus, path, busname);
222}
Tomd700e762016-09-20 18:24:13 +0530223
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700224// Use a lookup table to find the interface name of a specific sensor
225// This will be used until an alternative is found. this is the first
226// step for mapping IPMI
Patrick Venture0b02be92018-08-31 11:55:55 -0700227int find_openbmc_path(uint8_t num, dbus_interface_t* interface)
228{
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700229 int rc;
230
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700231 const auto& sensor_it = ipmi::sensor::sensors.find(num);
232 if (sensor_it == ipmi::sensor::sensors.end())
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700233 {
Adriana Kobylakba23ff72018-09-12 12:58:43 -0500234 // The sensor map does not contain the sensor requested
235 return -EINVAL;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700236 }
237
238 const auto& info = sensor_it->second;
239
Patrick Williams8451edf2017-06-13 09:01:06 -0500240 char* busname = nullptr;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700241 rc = get_bus_for_path(info.sensorPath.c_str(), &busname);
Patrick Venture0b02be92018-08-31 11:55:55 -0700242 if (rc < 0)
243 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700244 std::fprintf(stderr, "Failed to get %s busname: %s\n",
245 info.sensorPath.c_str(), busname);
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700246 goto final;
247 }
248
249 interface->sensortype = info.sensorType;
250 strcpy(interface->bus, busname);
251 strcpy(interface->path, info.sensorPath.c_str());
252 // Take the interface name from the beginning of the DbusInterfaceMap. This
253 // works for the Value interface but may not suffice for more complex
254 // sensors.
255 // tracked https://github.com/openbmc/phosphor-host-ipmid/issues/103
Patrick Venture0b02be92018-08-31 11:55:55 -0700256 strcpy(interface->interface,
257 info.propertyInterfaces.begin()->first.c_str());
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700258 interface->sensornumber = num;
259
260final:
261 free(busname);
262 return rc;
263}
264
Tomd700e762016-09-20 18:24:13 +0530265/////////////////////////////////////////////////////////////////////
266//
267// Routines used by ipmi commands wanting to interact on the dbus
268//
269/////////////////////////////////////////////////////////////////////
Patrick Venture0b02be92018-08-31 11:55:55 -0700270int set_sensor_dbus_state_s(uint8_t number, const char* method,
271 const char* value)
272{
Tomd700e762016-09-20 18:24:13 +0530273 dbus_interface_t a;
274 int r;
275 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700276 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530277
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700278 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530279
Patrick Venture0b02be92018-08-31 11:55:55 -0700280 if (r < 0)
281 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700282 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530283 return 0;
284 }
285
Patrick Venture0b02be92018-08-31 11:55:55 -0700286 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
287 method);
288 if (r < 0)
289 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700290 std::fprintf(stderr, "Failed to create a method call: %s",
291 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530292 goto final;
293 }
294
295 r = sd_bus_message_append(m, "v", "s", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700296 if (r < 0)
297 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700298 std::fprintf(stderr, "Failed to create a input parameter: %s",
299 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530300 goto final;
301 }
302
Tomd700e762016-09-20 18:24:13 +0530303 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700304 if (r < 0)
305 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700306 std::fprintf(stderr, "Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530307 }
308
309final:
310 sd_bus_error_free(&error);
311 m = sd_bus_message_unref(m);
312
313 return 0;
314}
Patrick Venture0b02be92018-08-31 11:55:55 -0700315int set_sensor_dbus_state_y(uint8_t number, const char* method,
316 const uint8_t value)
317{
Tomd700e762016-09-20 18:24:13 +0530318 dbus_interface_t a;
319 int r;
320 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700321 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530322
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700323 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530324
Patrick Venture0b02be92018-08-31 11:55:55 -0700325 if (r < 0)
326 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700327 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530328 return 0;
329 }
330
Patrick Venture0b02be92018-08-31 11:55:55 -0700331 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
332 method);
333 if (r < 0)
334 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700335 std::fprintf(stderr, "Failed to create a method call: %s",
336 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530337 goto final;
338 }
339
340 r = sd_bus_message_append(m, "v", "i", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700341 if (r < 0)
342 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700343 std::fprintf(stderr, "Failed to create a input parameter: %s",
344 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530345 goto final;
346 }
347
Tomd700e762016-09-20 18:24:13 +0530348 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700349 if (r < 0)
350 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700351 std::fprintf(stderr, "12 Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530352 }
353
354final:
355 sd_bus_error_free(&error);
356 m = sd_bus_message_unref(m);
357
358 return 0;
359}
360
Patrick Venture0b02be92018-08-31 11:55:55 -0700361uint8_t dbus_to_sensor_type(char* p)
362{
Patrick Venture0b02be92018-08-31 11:55:55 -0700363 sensorTypemap_t* s = g_SensorTypeMap;
364 char r = 0;
365 while (s->number != 0xFF)
366 {
367 if (!strcmp(s->dbusname, p))
368 {
Tom Joseph558184e2017-09-01 13:45:05 +0530369 r = s->typecode;
Patrick Venture0b02be92018-08-31 11:55:55 -0700370 break;
Chris Austenac4604a2015-10-13 12:43:27 -0500371 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500372 s++;
Chris Austenac4604a2015-10-13 12:43:27 -0500373 }
374
Chris Austen0012e9b2015-10-22 01:37:46 -0500375 if (s->number == 0xFF)
376 printf("Failed to find Sensor Type %s\n", p);
Chris Austenac4604a2015-10-13 12:43:27 -0500377
Chris Austen0012e9b2015-10-22 01:37:46 -0500378 return r;
Chris Austenac4604a2015-10-13 12:43:27 -0500379}
380
Patrick Venture0b02be92018-08-31 11:55:55 -0700381uint8_t get_type_from_interface(dbus_interface_t dbus_if)
382{
Brad Bishop56003452016-10-05 21:49:19 -0400383 uint8_t type;
Chris Austen0012e9b2015-10-22 01:37:46 -0500384
Chris Austen0012e9b2015-10-22 01:37:46 -0500385 // This is where sensors that do not exist in dbus but do
386 // exist in the host code stop. This should indicate it
387 // is not a supported sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700388 if (dbus_if.interface[0] == 0)
389 {
390 return 0;
391 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500392
Emily Shaffer71174412017-04-05 15:10:40 -0700393 // Fetch type from interface itself.
394 if (dbus_if.sensortype != 0)
395 {
396 type = dbus_if.sensortype;
Patrick Venture0b02be92018-08-31 11:55:55 -0700397 }
398 else
399 {
Chris Austen0012e9b2015-10-22 01:37:46 -0500400 // Non InventoryItems
Patrick Venture4491a462018-10-13 13:00:42 -0700401 char* p = strrchr(dbus_if.path, '/');
Patrick Venture0b02be92018-08-31 11:55:55 -0700402 type = dbus_to_sensor_type(p + 1);
Chris Austen0012e9b2015-10-22 01:37:46 -0500403 }
404
Brad Bishop56003452016-10-05 21:49:19 -0400405 return type;
Patrick Venture0b02be92018-08-31 11:55:55 -0700406}
Chris Austen0012e9b2015-10-22 01:37:46 -0500407
Emily Shaffer391f3302017-04-03 10:27:08 -0700408// Replaces find_sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700409uint8_t find_type_for_sensor_number(uint8_t num)
410{
Emily Shaffer391f3302017-04-03 10:27:08 -0700411 int r;
412 dbus_interface_t dbus_if;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700413 r = find_openbmc_path(num, &dbus_if);
Patrick Venture0b02be92018-08-31 11:55:55 -0700414 if (r < 0)
415 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700416 std::fprintf(stderr, "Could not find sensor %d\n", num);
Lei YU91875f72018-04-03 15:14:49 +0800417 return 0;
Emily Shaffer391f3302017-04-03 10:27:08 -0700418 }
419 return get_type_from_interface(dbus_if);
420}
421
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000422/**
423 * @brief implements the get sensor type command.
424 * @param - sensorNumber
425 *
426 * @return IPMI completion code plus response data on success.
427 * - sensorType
428 * - eventType
429 **/
430
431ipmi::RspType<uint8_t, // sensorType
432 uint8_t // eventType
433 >
434 ipmiGetSensorType(uint8_t sensorNumber)
Chris Austenac4604a2015-10-13 12:43:27 -0500435{
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000436 uint8_t sensorType = find_type_for_sensor_number(sensorNumber);
Chris Austenac4604a2015-10-13 12:43:27 -0500437
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000438 if (sensorType == 0)
Patrick Venture0b02be92018-08-31 11:55:55 -0700439 {
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000440 return ipmi::responseSensorInvalid();
Chris Austen0012e9b2015-10-22 01:37:46 -0500441 }
442
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000443 constexpr uint8_t eventType = 0x6F;
444 return ipmi::responseSuccess(sensorType, eventType);
Chris Austenac4604a2015-10-13 12:43:27 -0500445}
446
Patrick Venture0b02be92018-08-31 11:55:55 -0700447const std::set<std::string> analogSensorInterfaces = {
Emily Shaffercc941e12017-06-14 13:06:26 -0700448 "xyz.openbmc_project.Sensor.Value",
Patrick Venturee9a64052017-08-18 19:17:27 -0700449 "xyz.openbmc_project.Control.FanPwm",
Emily Shaffercc941e12017-06-14 13:06:26 -0700450};
451
452bool isAnalogSensor(const std::string& interface)
453{
454 return (analogSensorInterfaces.count(interface));
455}
456
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000457/**
458@brief This command is used to set sensorReading.
459
460@param
461 - sensorNumber
462 - operation
463 - reading
464 - assertOffset0_7
465 - assertOffset8_14
466 - deassertOffset0_7
467 - deassertOffset8_14
468 - eventData1
469 - eventData2
470 - eventData3
471
472@return completion code on success.
473**/
474
475ipmi::RspType<> ipmiSetSensorReading(uint8_t sensorNumber, uint8_t operation,
476 uint8_t reading, uint8_t assertOffset0_7,
477 uint8_t assertOffset8_14,
478 uint8_t deassertOffset0_7,
479 uint8_t deassertOffset8_14,
480 uint8_t eventData1, uint8_t eventData2,
481 uint8_t eventData3)
Tom Josephbe703f72017-03-09 12:34:35 +0530482{
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000483 log<level::DEBUG>("IPMI SET_SENSOR",
484 entry("SENSOR_NUM=0x%02x", sensorNumber));
485
Arun P. Mohanan0634e982021-08-30 15:21:33 +0530486 if (sensorNumber == 0xFF)
487 {
488 return ipmi::responseInvalidFieldRequest();
489 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000490 ipmi::sensor::SetSensorReadingReq cmdData;
491
492 cmdData.number = sensorNumber;
493 cmdData.operation = operation;
494 cmdData.reading = reading;
495 cmdData.assertOffset0_7 = assertOffset0_7;
496 cmdData.assertOffset8_14 = assertOffset8_14;
497 cmdData.deassertOffset0_7 = deassertOffset0_7;
498 cmdData.deassertOffset8_14 = deassertOffset8_14;
499 cmdData.eventData1 = eventData1;
500 cmdData.eventData2 = eventData2;
501 cmdData.eventData3 = eventData3;
Tom Josephbe703f72017-03-09 12:34:35 +0530502
503 // Check if the Sensor Number is present
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700504 const auto iter = ipmi::sensor::sensors.find(sensorNumber);
505 if (iter == ipmi::sensor::sensors.end())
Tom Josephbe703f72017-03-09 12:34:35 +0530506 {
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000507 updateSensorRecordFromSSRAESC(&sensorNumber);
508 return ipmi::responseSuccess();
Tom Josephbe703f72017-03-09 12:34:35 +0530509 }
510
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500511 try
512 {
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500513 if (ipmi::sensor::Mutability::Write !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700514 (iter->second.mutability & ipmi::sensor::Mutability::Write))
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500515 {
516 log<level::ERR>("Sensor Set operation is not allowed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000517 entry("SENSOR_NUM=%d", sensorNumber));
518 return ipmi::responseIllegalCommand();
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500519 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000520 auto ipmiRC = iter->second.updateFunc(cmdData, iter->second);
521 return ipmi::response(ipmiRC);
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500522 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500523 catch (const InternalFailure& e)
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500524 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700525 log<level::ERR>("Set sensor failed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000526 entry("SENSOR_NUM=%d", sensorNumber));
Patrick Venture0b02be92018-08-31 11:55:55 -0700527 commit<InternalFailure>();
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000528 return ipmi::responseUnspecifiedError();
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500529 }
Tom Joseph82024322017-09-28 20:07:29 +0530530 catch (const std::runtime_error& e)
531 {
532 log<level::ERR>(e.what());
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000533 return ipmi::responseUnspecifiedError();
Tom Joseph82024322017-09-28 20:07:29 +0530534 }
Chris Austenac4604a2015-10-13 12:43:27 -0500535}
536
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000537/** @brief implements the get sensor reading command
538 * @param sensorNum - sensor number
539 *
540 * @returns IPMI completion code plus response data
541 * - senReading - sensor reading
542 * - reserved
543 * - readState - sensor reading state enabled
544 * - senScanState - sensor scan state disabled
545 * - allEventMessageState - all Event message state disabled
546 * - assertionStatesLsb - threshold levels states
547 * - assertionStatesMsb - discrete reading sensor states
548 */
549ipmi::RspType<uint8_t, // sensor reading
Tom Joseph3ee668f2018-03-02 19:49:17 +0530550
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000551 uint5_t, // reserved
552 bool, // reading state
Sui Chen4cc42552019-09-11 10:28:35 -0700553 bool, // 0 = sensor scanning state disabled
554 bool, // 0 = all event messages disabled
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000555
556 uint8_t, // threshold levels states
557 uint8_t // discrete reading sensor states
558 >
Willy Tu11d68892022-01-20 10:37:34 -0800559 ipmiSensorGetSensorReading([[maybe_unused]] ipmi::Context::ptr& ctx,
560 uint8_t sensorNum)
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000561{
562 if (sensorNum == 0xFF)
563 {
564 return ipmi::responseInvalidFieldRequest();
565 }
566
567 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700568 if (iter == ipmi::sensor::sensors.end())
Tom Joseph3ee668f2018-03-02 19:49:17 +0530569 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000570 return ipmi::responseSensorInvalid();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530571 }
572 if (ipmi::sensor::Mutability::Read !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700573 (iter->second.mutability & ipmi::sensor::Mutability::Read))
Tom Joseph3ee668f2018-03-02 19:49:17 +0530574 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000575 return ipmi::responseIllegalCommand();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530576 }
577
578 try
579 {
Lei YU8c2c0482021-09-16 17:28:28 +0800580#ifdef FEATURE_SENSORS_CACHE
Lei YU8e8152c2021-12-06 20:11:08 +0800581 auto& sensorData = sensorCacheMap[sensorNum];
Lei YU97140502021-09-17 13:49:43 +0800582 if (!sensorData.has_value())
583 {
Lei YUa55e9ea2021-09-18 15:15:17 +0800584 // No cached value, try read it
Lei YU8e8152c2021-12-06 20:11:08 +0800585 std::string service;
586 boost::system::error_code ec;
Lei YUa55e9ea2021-09-18 15:15:17 +0800587 const auto& sensorInfo = iter->second;
Lei YU8e8152c2021-12-06 20:11:08 +0800588 ec = ipmi::getService(ctx, sensorInfo.sensorInterface,
589 sensorInfo.sensorPath, service);
590 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800591 {
Lei YU8e8152c2021-12-06 20:11:08 +0800592 return ipmi::responseUnspecifiedError();
Lei YUa55e9ea2021-09-18 15:15:17 +0800593 }
Lei YU7f3a70f2021-12-07 16:40:40 +0800594 fillSensorIdServiceMap(sensorInfo.sensorPath,
595 sensorInfo.propertyInterfaces.begin()->first,
596 iter->first, service);
Lei YU8e8152c2021-12-06 20:11:08 +0800597
598 ipmi::PropertyMap props;
599 ec = ipmi::getAllDbusProperties(
600 ctx, service, sensorInfo.sensorPath,
601 sensorInfo.propertyInterfaces.begin()->first, props);
602 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800603 {
Lei YU8e8152c2021-12-06 20:11:08 +0800604 fprintf(stderr, "Failed to get sensor %s, %d: %s\n",
605 sensorInfo.sensorPath.c_str(), ec.value(),
606 ec.message().c_str());
Lei YUa55e9ea2021-09-18 15:15:17 +0800607 // Intitilizing with default values
608 constexpr uint8_t senReading = 0;
609 constexpr uint5_t reserved{0};
610 constexpr bool readState = true;
611 constexpr bool senScanState = false;
612 constexpr bool allEventMessageState = false;
613 constexpr uint8_t assertionStatesLsb = 0;
614 constexpr uint8_t assertionStatesMsb = 0;
Lei YU97140502021-09-17 13:49:43 +0800615
Lei YUa55e9ea2021-09-18 15:15:17 +0800616 return ipmi::responseSuccess(senReading, reserved, readState,
617 senScanState, allEventMessageState,
618 assertionStatesLsb,
619 assertionStatesMsb);
620 }
Lei YU8e8152c2021-12-06 20:11:08 +0800621 sensorInfo.getFunc(sensorNum, sensorInfo, props);
Lei YU97140502021-09-17 13:49:43 +0800622 }
623 return ipmi::responseSuccess(
624 sensorData->response.reading, uint5_t(0),
625 sensorData->response.readingOrStateUnavailable,
626 sensorData->response.scanningEnabled,
627 sensorData->response.allEventMessagesEnabled,
628 sensorData->response.thresholdLevelsStates,
629 sensorData->response.discreteReadingSensorStates);
630
Lei YU8c2c0482021-09-16 17:28:28 +0800631#else
Sui Chen4cc42552019-09-11 10:28:35 -0700632 ipmi::sensor::GetSensorResponse getResponse =
633 iter->second.getFunc(iter->second);
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000634
Sui Chen4cc42552019-09-11 10:28:35 -0700635 return ipmi::responseSuccess(getResponse.reading, uint5_t(0),
636 getResponse.readingOrStateUnavailable,
637 getResponse.scanningEnabled,
638 getResponse.allEventMessagesEnabled,
639 getResponse.thresholdLevelsStates,
640 getResponse.discreteReadingSensorStates);
Lei YU8c2c0482021-09-16 17:28:28 +0800641#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530642 }
Brandon Kim9cf85622019-06-19 12:05:08 -0700643#ifdef UPDATE_FUNCTIONAL_ON_FAIL
644 catch (const SensorFunctionalError& e)
645 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000646 return ipmi::responseResponseError();
Brandon Kim9cf85622019-06-19 12:05:08 -0700647 }
648#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530649 catch (const std::exception& e)
650 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000651 // Intitilizing with default values
652 constexpr uint8_t senReading = 0;
653 constexpr uint5_t reserved{0};
654 constexpr bool readState = true;
655 constexpr bool senScanState = false;
656 constexpr bool allEventMessageState = false;
657 constexpr uint8_t assertionStatesLsb = 0;
658 constexpr uint8_t assertionStatesMsb = 0;
659
660 return ipmi::responseSuccess(senReading, reserved, readState,
661 senScanState, allEventMessageState,
662 assertionStatesLsb, assertionStatesMsb);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530663 }
664}
665
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300666get_sdr::GetSensorThresholdsResponse
667 getSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600668{
William A. Kennington III515bc372020-10-27 16:32:32 -0700669 get_sdr::GetSensorThresholdsResponse resp{};
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530670 constexpr auto warningThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600671 "xyz.openbmc_project.Sensor.Threshold.Warning";
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530672 constexpr auto criticalThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600673 "xyz.openbmc_project.Sensor.Threshold.Critical";
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600674
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700675 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530676 const auto info = iter->second;
677
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300678 std::string service;
679 boost::system::error_code ec;
680 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
681 if (ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530682 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300683 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530684 }
685
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300686 ipmi::PropertyMap warnThresholds;
687 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
688 warningThreshIntf, warnThresholds);
Willy Tu9154caa2021-12-02 02:28:54 -0800689 int32_t minClamp;
690 int32_t maxClamp;
691 int32_t rawData;
692 constexpr uint8_t sensorUnitsSignedBits = 2 << 6;
693 constexpr uint8_t signedDataFormat = 0x80;
694 if ((info.sensorUnits1 & sensorUnitsSignedBits) == signedDataFormat)
695 {
696 minClamp = std::numeric_limits<int8_t>::lowest();
697 maxClamp = std::numeric_limits<int8_t>::max();
698 }
699 else
700 {
701 minClamp = std::numeric_limits<uint8_t>::lowest();
702 maxClamp = std::numeric_limits<uint8_t>::max();
703 }
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300704 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530705 {
Hieu Huynh92079a22022-10-07 08:24:59 +0000706 double warnLow = ipmi::mappedVariant<double>(
707 warnThresholds, "WarningLow",
708 std::numeric_limits<double>::quiet_NaN());
709 double warnHigh = ipmi::mappedVariant<double>(
710 warnThresholds, "WarningHigh",
711 std::numeric_limits<double>::quiet_NaN());
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300712
713 if (std::isfinite(warnLow))
714 {
715 warnLow *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800716 rawData = round((warnLow - info.scaledOffset) / info.coefficientM);
717 resp.lowerNonCritical =
718 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300719 resp.validMask |= static_cast<uint8_t>(
720 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK);
721 }
722
723 if (std::isfinite(warnHigh))
724 {
725 warnHigh *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800726 rawData = round((warnHigh - info.scaledOffset) / info.coefficientM);
727 resp.upperNonCritical =
728 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300729 resp.validMask |= static_cast<uint8_t>(
730 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK);
731 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530732 }
733
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300734 ipmi::PropertyMap critThresholds;
735 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
736 criticalThreshIntf, critThresholds);
737 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530738 {
Hieu Huynh92079a22022-10-07 08:24:59 +0000739 double critLow = ipmi::mappedVariant<double>(
740 critThresholds, "CriticalLow",
741 std::numeric_limits<double>::quiet_NaN());
742 double critHigh = ipmi::mappedVariant<double>(
743 critThresholds, "CriticalHigh",
744 std::numeric_limits<double>::quiet_NaN());
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530745
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300746 if (std::isfinite(critLow))
747 {
748 critLow *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800749 rawData = round((critLow - info.scaledOffset) / info.coefficientM);
750 resp.lowerCritical =
751 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300752 resp.validMask |= static_cast<uint8_t>(
753 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK);
754 }
755
756 if (std::isfinite(critHigh))
757 {
758 critHigh *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800759 rawData = round((critHigh - info.scaledOffset) / info.coefficientM);
760 resp.upperCritical =
761 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300762 resp.validMask |= static_cast<uint8_t>(
763 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK);
764 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530765 }
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000766
767 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530768}
769
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000770/** @brief implements the get sensor thresholds command
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300771 * @param ctx - IPMI context pointer
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000772 * @param sensorNum - sensor number
773 *
774 * @returns IPMI completion code plus response data
775 * - validMask - threshold mask
776 * - lower non-critical threshold - IPMI messaging state
777 * - lower critical threshold - link authentication state
778 * - lower non-recoverable threshold - callback state
779 * - upper non-critical threshold
780 * - upper critical
781 * - upper non-recoverable
782 */
783ipmi::RspType<uint8_t, // validMask
784 uint8_t, // lowerNonCritical
785 uint8_t, // lowerCritical
786 uint8_t, // lowerNonRecoverable
787 uint8_t, // upperNonCritical
788 uint8_t, // upperCritical
789 uint8_t // upperNonRecoverable
790 >
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300791 ipmiSensorGetSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530792{
793 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
794
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700795 const auto iter = ipmi::sensor::sensors.find(sensorNum);
796 if (iter == ipmi::sensor::sensors.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600797 {
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000798 return ipmi::responseSensorInvalid();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600799 }
800
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530801 const auto info = iter->second;
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600802
Patrick Venture0b02be92018-08-31 11:55:55 -0700803 // Proceed only if the sensor value interface is implemented.
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530804 if (info.propertyInterfaces.find(valueInterface) ==
805 info.propertyInterfaces.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600806 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700807 // return with valid mask as 0
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000808 return ipmi::responseSuccess();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600809 }
810
Lei YU14a47812021-09-17 15:58:04 +0800811 auto it = sensorThresholdMap.find(sensorNum);
812 if (it == sensorThresholdMap.end())
813 {
814 sensorThresholdMap[sensorNum] = getSensorThresholds(ctx, sensorNum);
815 }
816
817 const auto& resp = sensorThresholdMap[sensorNum];
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600818
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000819 return ipmi::responseSuccess(resp.validMask, resp.lowerNonCritical,
820 resp.lowerCritical, resp.lowerNonRecoverable,
821 resp.upperNonCritical, resp.upperCritical,
822 resp.upperNonRecoverable);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600823}
824
Lotus Xuf93da662021-10-18 17:20:06 +0800825/** @brief implements the Set Sensor threshold command
826 * @param sensorNumber - sensor number
827 * @param lowerNonCriticalThreshMask
828 * @param lowerCriticalThreshMask
829 * @param lowerNonRecovThreshMask
830 * @param upperNonCriticalThreshMask
831 * @param upperCriticalThreshMask
832 * @param upperNonRecovThreshMask
833 * @param reserved
834 * @param lowerNonCritical - lower non-critical threshold
835 * @param lowerCritical - Lower critical threshold
836 * @param lowerNonRecoverable - Lower non recovarable threshold
837 * @param upperNonCritical - Upper non-critical threshold
838 * @param upperCritical - Upper critical
839 * @param upperNonRecoverable - Upper Non-recoverable
840 *
841 * @returns IPMI completion code
842 */
843ipmi::RspType<> ipmiSenSetSensorThresholds(
844 ipmi::Context::ptr& ctx, uint8_t sensorNum, bool lowerNonCriticalThreshMask,
845 bool lowerCriticalThreshMask, bool lowerNonRecovThreshMask,
846 bool upperNonCriticalThreshMask, bool upperCriticalThreshMask,
847 bool upperNonRecovThreshMask, uint2_t reserved, uint8_t lowerNonCritical,
Willy Tu11d68892022-01-20 10:37:34 -0800848 uint8_t lowerCritical, uint8_t, uint8_t upperNonCritical,
849 uint8_t upperCritical, uint8_t)
Lotus Xuf93da662021-10-18 17:20:06 +0800850{
851 if (reserved)
852 {
853 return ipmi::responseInvalidFieldRequest();
854 }
855
856 // lower nc and upper nc not suppported on any sensor
857 if (lowerNonRecovThreshMask || upperNonRecovThreshMask)
858 {
859 return ipmi::responseInvalidFieldRequest();
860 }
861
862 // if none of the threshold mask are set, nothing to do
863 if (!(lowerNonCriticalThreshMask | lowerCriticalThreshMask |
864 lowerNonRecovThreshMask | upperNonCriticalThreshMask |
865 upperCriticalThreshMask | upperNonRecovThreshMask))
866 {
867 return ipmi::responseSuccess();
868 }
869
870 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
871
872 const auto iter = ipmi::sensor::sensors.find(sensorNum);
873 if (iter == ipmi::sensor::sensors.end())
874 {
875 return ipmi::responseSensorInvalid();
876 }
877
878 const auto& info = iter->second;
879
880 // Proceed only if the sensor value interface is implemented.
881 if (info.propertyInterfaces.find(valueInterface) ==
882 info.propertyInterfaces.end())
883 {
884 // return with valid mask as 0
885 return ipmi::responseSuccess();
886 }
887
888 constexpr auto warningThreshIntf =
889 "xyz.openbmc_project.Sensor.Threshold.Warning";
890 constexpr auto criticalThreshIntf =
891 "xyz.openbmc_project.Sensor.Threshold.Critical";
892
893 std::string service;
894 boost::system::error_code ec;
895 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
896 if (ec)
897 {
898 return ipmi::responseResponseError();
899 }
900 // store a vector of property name, value to set, and interface
901 std::vector<std::tuple<std::string, uint8_t, std::string>> thresholdsToSet;
902
903 // define the indexes of the tuple
904 constexpr uint8_t propertyName = 0;
905 constexpr uint8_t thresholdValue = 1;
906 constexpr uint8_t interface = 2;
907 // verifiy all needed fields are present
908 if (lowerCriticalThreshMask || upperCriticalThreshMask)
909 {
Lotus Xuf93da662021-10-18 17:20:06 +0800910 ipmi::PropertyMap findThreshold;
911 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
912 criticalThreshIntf, findThreshold);
913
914 if (!ec)
915 {
916 if (lowerCriticalThreshMask)
917 {
918 auto findLower = findThreshold.find("CriticalLow");
919 if (findLower == findThreshold.end())
920 {
921 return ipmi::responseInvalidFieldRequest();
922 }
923 thresholdsToSet.emplace_back("CriticalLow", lowerCritical,
924 criticalThreshIntf);
925 }
926 if (upperCriticalThreshMask)
927 {
928 auto findUpper = findThreshold.find("CriticalHigh");
929 if (findUpper == findThreshold.end())
930 {
931 return ipmi::responseInvalidFieldRequest();
932 }
933 thresholdsToSet.emplace_back("CriticalHigh", upperCritical,
934 criticalThreshIntf);
935 }
936 }
937 }
938 if (lowerNonCriticalThreshMask || upperNonCriticalThreshMask)
939 {
940 ipmi::PropertyMap findThreshold;
941 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
942 warningThreshIntf, findThreshold);
943
944 if (!ec)
945 {
946 if (lowerNonCriticalThreshMask)
947 {
948 auto findLower = findThreshold.find("WarningLow");
949 if (findLower == findThreshold.end())
950 {
951 return ipmi::responseInvalidFieldRequest();
952 }
953 thresholdsToSet.emplace_back("WarningLow", lowerNonCritical,
954 warningThreshIntf);
955 }
956 if (upperNonCriticalThreshMask)
957 {
958 auto findUpper = findThreshold.find("WarningHigh");
959 if (findUpper == findThreshold.end())
960 {
961 return ipmi::responseInvalidFieldRequest();
962 }
963 thresholdsToSet.emplace_back("WarningHigh", upperNonCritical,
964 warningThreshIntf);
965 }
966 }
967 }
968 for (const auto& property : thresholdsToSet)
969 {
970 // from section 36.3 in the IPMI Spec, assume all linear
971 double valueToSet =
972 ((info.coefficientM * std::get<thresholdValue>(property)) +
973 (info.scaledOffset * std::pow(10.0, info.scale))) *
974 std::pow(10.0, info.exponentR);
975 ipmi::setDbusProperty(
976 ctx, service, info.sensorPath, std::get<interface>(property),
977 std::get<propertyName>(property), ipmi::Value(valueToSet));
978 }
979
Lei YU14a47812021-09-17 15:58:04 +0800980 // Invalidate the cache
981 sensorThresholdMap.erase(sensorNum);
Lotus Xuf93da662021-10-18 17:20:06 +0800982 return ipmi::responseSuccess();
983}
984
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000985/** @brief implements the get SDR Info command
986 * @param count - Operation
987 *
988 * @returns IPMI completion code plus response data
989 * - sdrCount - sensor/SDR count
990 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag
991 */
992ipmi::RspType<uint8_t, // respcount
993 uint8_t // dynamic population flags
994 >
995 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700996{
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000997 uint8_t sdrCount;
998 // multiple LUNs not supported.
999 constexpr uint8_t lunsAndDynamicPopulation = 1;
1000 constexpr uint8_t getSdrCount = 0x01;
1001 constexpr uint8_t getSensorCount = 0x00;
1002
1003 if (count.value_or(0) == getSdrCount)
Emily Shafferd06e0e72017-04-05 09:08:57 -07001004 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001005 // Get SDR count. This returns the total number of SDRs in the device.
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001006 const auto& entityRecords =
1007 ipmi::sensor::EntityInfoMapContainer::getContainer()
1008 ->getIpmiEntityRecords();
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001009 sdrCount = ipmi::sensor::sensors.size() + frus.size() +
1010 entityRecords.size();
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001011 }
1012 else if (count.value_or(0) == getSensorCount)
1013 {
1014 // Get Sensor count. This returns the number of sensors
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001015 sdrCount = ipmi::sensor::sensors.size();
Emily Shafferd06e0e72017-04-05 09:08:57 -07001016 }
1017 else
1018 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001019 return ipmi::responseInvalidCommandOnLun();
Emily Shafferd06e0e72017-04-05 09:08:57 -07001020 }
1021
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001022 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation);
Emily Shafferd06e0e72017-04-05 09:08:57 -07001023}
1024
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001025/** @brief implements the reserve SDR command
1026 * @returns IPMI completion code plus response data
1027 * - reservationID - reservation ID
1028 */
1029ipmi::RspType<uint16_t> ipmiSensorReserveSdr()
Emily Shaffera344afc2017-04-13 15:09:39 -07001030{
1031 // A constant reservation ID is okay until we implement add/remove SDR.
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001032 constexpr uint16_t reservationID = 1;
Emily Shaffera344afc2017-04-13 15:09:39 -07001033
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001034 return ipmi::responseSuccess(reservationID);
Emily Shaffera344afc2017-04-13 15:09:39 -07001035}
Chris Austenac4604a2015-10-13 12:43:27 -05001036
Patrick Venture0b02be92018-08-31 11:55:55 -07001037void setUnitFieldsForObject(const ipmi::sensor::Info* info,
1038 get_sdr::SensorDataFullRecordBody* body)
Emily Shaffercc941e12017-06-14 13:06:26 -07001039{
Tom Josephdc212b22018-02-16 09:59:57 +05301040 namespace server = sdbusplus::xyz::openbmc_project::Sensor::server;
1041 try
Emily Shaffercc941e12017-06-14 13:06:26 -07001042 {
Tom Josephdc212b22018-02-16 09:59:57 +05301043 auto unit = server::Value::convertUnitFromString(info->unit);
1044 // Unit strings defined in
1045 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml
1046 switch (unit)
Emily Shaffercc941e12017-06-14 13:06:26 -07001047 {
Tom Josephdc212b22018-02-16 09:59:57 +05301048 case server::Value::Unit::DegreesC:
1049 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C;
1050 break;
1051 case server::Value::Unit::RPMS:
Kirill Pakhomov812e44c2018-10-22 16:25:35 +03001052 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM;
Tom Josephdc212b22018-02-16 09:59:57 +05301053 break;
1054 case server::Value::Unit::Volts:
1055 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS;
1056 break;
1057 case server::Value::Unit::Meters:
1058 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS;
1059 break;
1060 case server::Value::Unit::Amperes:
1061 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES;
1062 break;
1063 case server::Value::Unit::Joules:
1064 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES;
1065 break;
1066 case server::Value::Unit::Watts:
1067 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS;
1068 break;
1069 default:
1070 // Cannot be hit.
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001071 std::fprintf(stderr, "Unknown value unit type: = %s\n",
1072 info->unit.c_str());
Emily Shaffercc941e12017-06-14 13:06:26 -07001073 }
1074 }
Patrick Venture64678b82018-10-13 13:11:32 -07001075 catch (const sdbusplus::exception::InvalidEnumString& e)
Emily Shaffercc941e12017-06-14 13:06:26 -07001076 {
Tom Josephdc212b22018-02-16 09:59:57 +05301077 log<level::WARNING>("Warning: no unit provided for sensor!");
Emily Shaffercc941e12017-06-14 13:06:26 -07001078 }
Emily Shaffercc941e12017-06-14 13:06:26 -07001079}
1080
Patrick Venture0b02be92018-08-31 11:55:55 -07001081ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body,
1082 const ipmi::sensor::Info* info,
Willy Tu11d68892022-01-20 10:37:34 -08001083 ipmi_data_len_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001084{
1085 /* Functional sensor case */
Emily Shaffercc941e12017-06-14 13:06:26 -07001086 if (isAnalogSensor(info->propertyInterfaces.begin()->first))
Emily Shafferbbef71c2017-05-08 16:36:17 -07001087 {
Tony Leec5324252019-10-31 17:24:16 +08001088 body->sensor_units_1 = info->sensorUnits1; // default is 0. unsigned, no
1089 // rate, no modifier, not a %
Emily Shafferbbef71c2017-05-08 16:36:17 -07001090 /* Unit info */
Tom Josephdc212b22018-02-16 09:59:57 +05301091 setUnitFieldsForObject(info, body);
Emily Shaffer10f49592017-05-10 12:01:10 -07001092
1093 get_sdr::body::set_b(info->coefficientB, body);
1094 get_sdr::body::set_m(info->coefficientM, body);
1095 get_sdr::body::set_b_exp(info->exponentB, body);
Tom Josephdc212b22018-02-16 09:59:57 +05301096 get_sdr::body::set_r_exp(info->exponentR, body);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001097 }
1098
Tom Joseph96423912018-01-25 00:14:34 +05301099 /* ID string */
Jeremy Kerrbe4ffa82020-08-10 16:17:37 +08001100 auto id_string = info->sensorName;
1101
1102 if (id_string.empty())
1103 {
1104 id_string = info->sensorNameFunc(*info);
1105 }
Tom Joseph96423912018-01-25 00:14:34 +05301106
1107 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH)
1108 {
1109 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body);
1110 }
1111 else
1112 {
1113 get_sdr::body::set_id_strlen(id_string.length(), body);
1114 }
Paul Fertser51136982022-08-18 12:36:41 +00001115 get_sdr::body::set_id_type(3, body); // "8-bit ASCII + Latin 1"
Tom Joseph96423912018-01-25 00:14:34 +05301116 strncpy(body->id_string, id_string.c_str(),
1117 get_sdr::body::get_id_strlen(body));
1118
Emily Shafferbbef71c2017-05-08 16:36:17 -07001119 return IPMI_CC_OK;
1120};
1121
Ratan Guptae0cc8552018-01-22 14:23:04 +05301122ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response,
1123 ipmi_data_len_t data_len)
1124{
1125 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1126 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
Patrick Venture0b02be92018-08-31 11:55:55 -07001127 get_sdr::SensorDataFruRecord record{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301128 auto dataLength = 0;
1129
1130 auto fru = frus.begin();
Patrick Venture0b02be92018-08-31 11:55:55 -07001131 uint8_t fruID{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301132 auto recordID = get_sdr::request::get_record_id(req);
1133
1134 fruID = recordID - FRU_RECORD_ID_START;
1135 fru = frus.find(fruID);
1136 if (fru == frus.end())
1137 {
1138 return IPMI_CC_SENSOR_INVALID;
1139 }
1140
1141 /* Header */
1142 get_sdr::header::set_record_id(recordID, &(record.header));
1143 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1144 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD;
1145 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1146
1147 /* Key */
1148 record.key.fruID = fruID;
1149 record.key.accessLun |= IPMI_LOGICAL_FRU;
1150 record.key.deviceAddress = BMCSlaveAddress;
1151
1152 /* Body */
1153 record.body.entityID = fru->second[0].entityID;
1154 record.body.entityInstance = fru->second[0].entityInstance;
1155 record.body.deviceType = fruInventoryDevice;
1156 record.body.deviceTypeModifier = IPMIFruInventory;
1157
1158 /* Device ID string */
Patrick Venture0b02be92018-08-31 11:55:55 -07001159 auto deviceID =
1160 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1,
1161 fru->second[0].path.length());
Ratan Guptae0cc8552018-01-22 14:23:04 +05301162
1163 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH)
1164 {
1165 get_sdr::body::set_device_id_strlen(
Patrick Venture0b02be92018-08-31 11:55:55 -07001166 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301167 }
1168 else
1169 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001170 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301171 }
1172
1173 strncpy(record.body.deviceID, deviceID.c_str(),
1174 get_sdr::body::get_device_id_strlen(&(record.body)));
1175
1176 if (++fru == frus.end())
1177 {
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001178 // we have reached till end of fru, so assign the next record id to
1179 // 512(Max fru ID = 511) + Entity Record ID(may start with 0).
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001180 const auto& entityRecords =
1181 ipmi::sensor::EntityInfoMapContainer::getContainer()
1182 ->getIpmiEntityRecords();
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001183 auto next_record_id = (entityRecords.size())
1184 ? entityRecords.begin()->first +
1185 ENTITY_RECORD_ID_START
1186 : END_OF_RECORD;
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001187 get_sdr::response::set_next_record_id(next_record_id, resp);
1188 }
1189 else
1190 {
1191 get_sdr::response::set_next_record_id(
1192 (FRU_RECORD_ID_START + fru->first), resp);
1193 }
1194
1195 // Check for invalid offset size
1196 if (req->offset > sizeof(record))
1197 {
1198 return IPMI_CC_PARM_OUT_OF_RANGE;
1199 }
1200
1201 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1202 sizeof(record) - req->offset);
1203
1204 std::memcpy(resp->record_data,
1205 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
1206
1207 *data_len = dataLength;
1208 *data_len += 2; // additional 2 bytes for next record ID
1209
1210 return IPMI_CC_OK;
1211}
1212
1213ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response,
1214 ipmi_data_len_t data_len)
1215{
1216 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1217 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
1218 get_sdr::SensorDataEntityRecord record{};
1219 auto dataLength = 0;
1220
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001221 const auto& entityRecords =
1222 ipmi::sensor::EntityInfoMapContainer::getContainer()
1223 ->getIpmiEntityRecords();
Patrick Venture83a0b842019-07-19 18:37:15 -07001224 auto entity = entityRecords.begin();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001225 uint8_t entityRecordID;
1226 auto recordID = get_sdr::request::get_record_id(req);
1227
1228 entityRecordID = recordID - ENTITY_RECORD_ID_START;
Patrick Venture83a0b842019-07-19 18:37:15 -07001229 entity = entityRecords.find(entityRecordID);
1230 if (entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001231 {
1232 return IPMI_CC_SENSOR_INVALID;
1233 }
1234
1235 /* Header */
1236 get_sdr::header::set_record_id(recordID, &(record.header));
1237 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1238 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD;
1239 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1240
1241 /* Key */
1242 record.key.containerEntityId = entity->second.containerEntityId;
1243 record.key.containerEntityInstance = entity->second.containerEntityInstance;
1244 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked,
1245 &(record.key));
1246 record.key.entityId1 = entity->second.containedEntities[0].first;
1247 record.key.entityInstance1 = entity->second.containedEntities[0].second;
1248
1249 /* Body */
1250 record.body.entityId2 = entity->second.containedEntities[1].first;
1251 record.body.entityInstance2 = entity->second.containedEntities[1].second;
1252 record.body.entityId3 = entity->second.containedEntities[2].first;
1253 record.body.entityInstance3 = entity->second.containedEntities[2].second;
1254 record.body.entityId4 = entity->second.containedEntities[3].first;
1255 record.body.entityInstance4 = entity->second.containedEntities[3].second;
1256
Patrick Venture83a0b842019-07-19 18:37:15 -07001257 if (++entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001258 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001259 get_sdr::response::set_next_record_id(END_OF_RECORD,
1260 resp); // last record
Ratan Guptae0cc8552018-01-22 14:23:04 +05301261 }
1262 else
1263 {
1264 get_sdr::response::set_next_record_id(
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001265 (ENTITY_RECORD_ID_START + entity->first), resp);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301266 }
1267
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001268 // Check for invalid offset size
1269 if (req->offset > sizeof(record))
Ratan Guptae0cc8552018-01-22 14:23:04 +05301270 {
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001271 return IPMI_CC_PARM_OUT_OF_RANGE;
Ratan Guptae0cc8552018-01-22 14:23:04 +05301272 }
1273
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001274 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1275 sizeof(record) - req->offset);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301276
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001277 std::memcpy(resp->record_data,
Jason M. Bills1cd85962018-10-05 12:04:01 -07001278 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301279
1280 *data_len = dataLength;
1281 *data_len += 2; // additional 2 bytes for next record ID
1282
1283 return IPMI_CC_OK;
1284}
1285
Willy Tu11d68892022-01-20 10:37:34 -08001286ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t request,
1287 ipmi_response_t response, ipmi_data_len_t data_len,
1288 ipmi_context_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001289{
1290 ipmi_ret_t ret = IPMI_CC_OK;
Patrick Venture0b02be92018-08-31 11:55:55 -07001291 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request;
1292 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response;
Patrick Venture38426dd2019-07-30 15:22:29 -07001293
1294 // Note: we use an iterator so we can provide the next ID at the end of
1295 // the call.
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001296 auto sensor = ipmi::sensor::sensors.begin();
Patrick Venture38426dd2019-07-30 15:22:29 -07001297 auto recordID = get_sdr::request::get_record_id(req);
1298
1299 // At the beginning of a scan, the host side will send us id=0.
1300 if (recordID != 0)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001301 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001302 // recordID 0 to 255 means it is a FULL record.
1303 // recordID 256 to 511 means it is a FRU record.
1304 // recordID greater then 511 means it is a Entity Association
1305 // record. Currently we are supporting three record types: FULL
1306 // record, FRU record and Enttiy Association record.
1307 if (recordID >= ENTITY_RECORD_ID_START)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001308 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001309 return ipmi_entity_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001310 }
Patrick Venture38426dd2019-07-30 15:22:29 -07001311 else if (recordID >= FRU_RECORD_ID_START &&
1312 recordID < ENTITY_RECORD_ID_START)
Jaghathiswari Rankappagounder Natarajan0780df12019-02-06 15:29:24 -08001313 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001314 return ipmi_fru_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001315 }
1316 else
1317 {
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001318 sensor = ipmi::sensor::sensors.find(recordID);
1319 if (sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001320 {
1321 return IPMI_CC_SENSOR_INVALID;
1322 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001323 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001324 }
1325
Patrick Venture38426dd2019-07-30 15:22:29 -07001326 uint8_t sensor_id = sensor->first;
1327
Lei YU14a47812021-09-17 15:58:04 +08001328 auto it = sdrCacheMap.find(sensor_id);
1329 if (it == sdrCacheMap.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001330 {
Lei YU14a47812021-09-17 15:58:04 +08001331 /* Header */
Willy Tu11d68892022-01-20 10:37:34 -08001332 get_sdr::SensorDataFullRecord record = {};
Lei YU14a47812021-09-17 15:58:04 +08001333 get_sdr::header::set_record_id(sensor_id, &(record.header));
1334 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1
1335 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
1336 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1337
1338 /* Key */
1339 get_sdr::key::set_owner_id_bmc(&(record.key));
1340 record.key.sensor_number = sensor_id;
1341
1342 /* Body */
1343 record.body.entity_id = sensor->second.entityType;
1344 record.body.sensor_type = sensor->second.sensorType;
1345 record.body.event_reading_type = sensor->second.sensorReadingType;
1346 record.body.entity_instance = sensor->second.instance;
1347 if (ipmi::sensor::Mutability::Write ==
1348 (sensor->second.mutability & ipmi::sensor::Mutability::Write))
1349 {
1350 get_sdr::body::init_settable_state(true, &(record.body));
1351 }
1352
1353 // Set the type-specific details given the DBus interface
1354 populate_record_from_dbus(&(record.body), &(sensor->second), data_len);
1355 sdrCacheMap[sensor_id] = std::move(record);
Patrick Venture38426dd2019-07-30 15:22:29 -07001356 }
1357
Lei YU14a47812021-09-17 15:58:04 +08001358 const auto& record = sdrCacheMap[sensor_id];
Patrick Venture38426dd2019-07-30 15:22:29 -07001359
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001360 if (++sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001361 {
1362 // we have reached till end of sensor, so assign the next record id
1363 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0).
1364 auto next_record_id = (frus.size())
1365 ? frus.begin()->first + FRU_RECORD_ID_START
1366 : END_OF_RECORD;
1367
1368 get_sdr::response::set_next_record_id(next_record_id, resp);
1369 }
1370 else
1371 {
1372 get_sdr::response::set_next_record_id(sensor->first, resp);
1373 }
1374
1375 if (req->offset > sizeof(record))
1376 {
1377 return IPMI_CC_PARM_OUT_OF_RANGE;
1378 }
1379
1380 // data_len will ultimately be the size of the record, plus
1381 // the size of the next record ID:
1382 *data_len = std::min(static_cast<size_t>(req->bytes_to_read),
1383 sizeof(record) - req->offset);
1384
1385 std::memcpy(resp->record_data,
Lei YU14a47812021-09-17 15:58:04 +08001386 reinterpret_cast<const uint8_t*>(&record) + req->offset,
1387 *data_len);
Patrick Venture38426dd2019-07-30 15:22:29 -07001388
1389 // data_len should include the LSB and MSB:
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001390 *data_len += sizeof(resp->next_record_id_lsb) +
1391 sizeof(resp->next_record_id_msb);
Patrick Venture38426dd2019-07-30 15:22:29 -07001392
Emily Shafferbbef71c2017-05-08 16:36:17 -07001393 return ret;
1394}
1395
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001396static bool isFromSystemChannel()
1397{
1398 // TODO we could not figure out where the request is from based on IPMI
1399 // command handler parameters. because of it, we can not differentiate
1400 // request from SMS/SMM or IPMB channel
1401 return true;
1402}
1403
Willy Tu11d68892022-01-20 10:37:34 -08001404ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t, ipmi_cmd_t,
1405 ipmi_request_t request, ipmi_response_t,
1406 ipmi_data_len_t dataLen, ipmi_context_t)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001407{
1408 uint16_t generatorID;
1409 size_t count;
1410 bool assert = true;
1411 std::string sensorPath;
1412 size_t paraLen = *dataLen;
1413 PlatformEventRequest* req;
1414 *dataLen = 0;
1415
1416 if ((paraLen < selSystemEventSizeWith1Bytes) ||
1417 (paraLen > selSystemEventSizeWith3Bytes))
1418 {
1419 return IPMI_CC_REQ_DATA_LEN_INVALID;
1420 }
1421
1422 if (isFromSystemChannel())
1423 { // first byte for SYSTEM Interface is Generator ID
1424 // +1 to get common struct
1425 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1);
1426 // Capture the generator ID
1427 generatorID = *reinterpret_cast<uint8_t*>(request);
1428 // Platform Event usually comes from other firmware, like BIOS.
1429 // Unlike BMC sensor, it does not have BMC DBUS sensor path.
1430 sensorPath = "System";
1431 }
1432 else
1433 {
1434 req = reinterpret_cast<PlatformEventRequest*>(request);
1435 // TODO GenratorID for IPMB is combination of RqSA and RqLUN
1436 generatorID = 0xff;
1437 sensorPath = "IPMB";
1438 }
1439 // Content of event data field depends on sensor class.
1440 // When data0 bit[5:4] is non-zero, valid data counts is 3.
1441 // When data0 bit[7:6] is non-zero, valid data counts is 2.
1442 if (((req->data[0] & byte3EnableMask) != 0 &&
1443 paraLen < selSystemEventSizeWith3Bytes) ||
1444 ((req->data[0] & byte2EnableMask) != 0 &&
1445 paraLen < selSystemEventSizeWith2Bytes))
1446 {
1447 return IPMI_CC_REQ_DATA_LEN_INVALID;
1448 }
1449
1450 // Count bytes of Event Data
1451 if ((req->data[0] & byte3EnableMask) != 0)
1452 {
1453 count = 3;
1454 }
1455 else if ((req->data[0] & byte2EnableMask) != 0)
1456 {
1457 count = 2;
1458 }
1459 else
1460 {
1461 count = 1;
1462 }
1463 assert = req->eventDirectionType & directionMask ? false : true;
1464 std::vector<uint8_t> eventData(req->data, req->data + count);
1465
Patrick Williams5d82f472022-07-22 19:26:53 -05001466 sdbusplus::bus_t dbus(bus);
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001467 std::string service = ipmi::getService(dbus, ipmiSELAddInterface,
1468 ipmiSELPath);
Patrick Williams5d82f472022-07-22 19:26:53 -05001469 sdbusplus::message_t writeSEL = dbus.new_method_call(
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001470 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd");
1471 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert,
1472 generatorID);
1473 try
1474 {
1475 dbus.call(writeSEL);
1476 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001477 catch (const sdbusplus::exception_t& e)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001478 {
1479 phosphor::logging::log<phosphor::logging::level::ERR>(e.what());
1480 return IPMI_CC_UNSPECIFIED_ERROR;
1481 }
1482 return IPMI_CC_OK;
1483}
1484
Chris Austenac4604a2015-10-13 12:43:27 -05001485void register_netfn_sen_functions()
1486{
Willy Tud351a722021-08-12 14:33:40 -07001487 // Handlers with dbus-sdr handler implementation.
1488 // Do not register the hander if it dynamic sensors stack is used.
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001489
Willy Tud351a722021-08-12 14:33:40 -07001490#ifndef FEATURE_DYNAMIC_SENSORS
Lei YUbe5c6b22021-09-16 15:46:20 +08001491
Lei YU962e68b2021-09-16 16:25:34 +08001492#ifdef FEATURE_SENSORS_CACHE
Lei YUbe5c6b22021-09-16 15:46:20 +08001493 // Initialize the sensor matches
1494 initSensorMatches();
Lei YU962e68b2021-09-16 16:25:34 +08001495#endif
Lei YUbe5c6b22021-09-16 15:46:20 +08001496
Tom05732372016-09-06 17:21:23 +05301497 // <Set Sensor Reading and Event Status>
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +00001498 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1499 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts,
1500 ipmi::Privilege::Operator, ipmiSetSensorReading);
Tom05732372016-09-06 17:21:23 +05301501 // <Get Sensor Reading>
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +00001502 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1503 ipmi::sensor_event::cmdGetSensorReading,
1504 ipmi::Privilege::User, ipmiSensorGetSensorReading);
Emily Shaffera344afc2017-04-13 15:09:39 -07001505
Tom Joseph5ca50952018-02-22 00:33:38 +05301506 // <Reserve Device SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001507 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1508 ipmi::sensor_event::cmdReserveDeviceSdrRepository,
1509 ipmi::Privilege::User, ipmiSensorReserveSdr);
Chris Austen10ccc0f2015-12-10 18:27:04 -06001510
Tom Joseph5ca50952018-02-22 00:33:38 +05301511 // <Get Device SDR Info>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001512 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1513 ipmi::sensor_event::cmdGetDeviceSdrInfo,
1514 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001515
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001516 // <Get Sensor Thresholds>
jayaprakash Mutyala996c9792019-05-03 15:56:48 +00001517 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1518 ipmi::sensor_event::cmdGetSensorThreshold,
1519 ipmi::Privilege::User, ipmiSensorGetSensorThresholds);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001520
Lotus Xuf93da662021-10-18 17:20:06 +08001521 // <Set Sensor Thresholds>
1522 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1523 ipmi::sensor_event::cmdSetSensorThreshold,
1524 ipmi::Privilege::User, ipmiSenSetSensorThresholds);
Vivekanand Veeracholand3d2fe22021-11-12 19:40:42 -08001525
1526 // <Get Device SDR>
1527 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr,
1528 ipmi_sen_get_sdr, PRIVILEGE_USER);
1529
Willy Tud351a722021-08-12 14:33:40 -07001530#endif
1531
1532 // Common Handers used by both implementation.
1533
1534 // <Platform Event Message>
1535 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr,
1536 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR);
1537
1538 // <Get Sensor Type>
1539 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1540 ipmi::sensor_event::cmdGetSensorType,
1541 ipmi::Privilege::User, ipmiGetSensorType);
1542
Chris Austenac4604a2015-10-13 12:43:27 -05001543 return;
1544}