blob: a48b0f23c3d2ac79dcd9f2354ae28cd9439f739c [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
5#include "fruread.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07006
Chris Austen10ccc0f2015-12-10 18:27:04 -06007#include <systemd/sd-bus.h>
Patrick Venture0b02be92018-08-31 11:55:55 -07008
Vernon Mauerye08fbff2019-04-03 09:19:34 -07009#include <ipmid/api.hpp>
Vernon Mauery9cf08382023-04-28 14:00:11 -070010#include <ipmid/entity_map_json.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070011#include <ipmid/types.hpp>
Vernon Mauery6a98fe72019-03-11 15:57:48 -070012#include <ipmid/utils.hpp>
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -050013#include <phosphor-logging/elog-errors.hpp>
George Liu3b1071a2024-07-17 20:26:14 +080014#include <phosphor-logging/lg2.hpp>
William A. Kennington III4c008022018-10-12 17:18:14 -070015#include <sdbusplus/message/types.hpp>
Patrick Venture0b02be92018-08-31 11:55:55 -070016#include <xyz/openbmc_project/Common/error.hpp>
17#include <xyz/openbmc_project/Sensor/Value/server.hpp>
18
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050019#include <bitset>
20#include <cmath>
21#include <cstring>
22#include <set>
23
Ratan Guptae0cc8552018-01-22 14:23:04 +053024static constexpr uint8_t fruInventoryDevice = 0x10;
25static constexpr uint8_t IPMIFruInventory = 0x02;
Matt Simmering68d9d402023-11-09 14:22:11 -080026static constexpr uint8_t BMCTargetAddress = 0x20;
Ratan Guptae0cc8552018-01-22 14:23:04 +053027
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 =
Willy Tu523e2d12023-09-05 11:36:48 -070043 sdbusplus::error::xyz::openbmc_project::common::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
Lei YU14a47812021-09-17 15:58:04 +080082using SDRCacheMap = std::unordered_map<uint8_t, get_sdr::SensorDataFullRecord>;
83SDRCacheMap sdrCacheMap __attribute__((init_priority(101)));
84
85using SensorThresholdMap =
86 std::unordered_map<uint8_t, get_sdr::GetSensorThresholdsResponse>;
87SensorThresholdMap sensorThresholdMap __attribute__((init_priority(101)));
88
Lei YU962e68b2021-09-16 16:25:34 +080089#ifdef FEATURE_SENSORS_CACHE
Patrick Williams5d82f472022-07-22 19:26:53 -050090std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match_t>> sensorAddedMatches
91 __attribute__((init_priority(101)));
92std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match_t>> sensorUpdatedMatches
93 __attribute__((init_priority(101)));
94std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match_t>> sensorRemovedMatches
95 __attribute__((init_priority(101)));
96std::unique_ptr<sdbusplus::bus::match_t> sensorsOwnerMatch
Lei YU7f3a70f2021-12-07 16:40:40 +080097 __attribute__((init_priority(101)));
Lei YUbe5c6b22021-09-16 15:46:20 +080098
Lei YU97140502021-09-17 13:49:43 +080099ipmi::sensor::SensorCacheMap sensorCacheMap __attribute__((init_priority(101)));
Lei YU8c2c0482021-09-16 17:28:28 +0800100
Lei YU7f3a70f2021-12-07 16:40:40 +0800101// It is needed to know which objects belong to which service, so that when a
102// service exits without interfacesRemoved signal, we could invaildate the cache
103// that is related to the service. It uses below two variables:
104// - idToServiceMap records which sensors are known to have a related service;
105// - serviceToIdMap maps a service to the sensors.
106using sensorIdToServiceMap = std::unordered_map<uint8_t, std::string>;
107sensorIdToServiceMap idToServiceMap __attribute__((init_priority(101)));
108
109using sensorServiceToIdMap = std::unordered_map<std::string, std::set<uint8_t>>;
110sensorServiceToIdMap serviceToIdMap __attribute__((init_priority(101)));
111
Willy Tu11d68892022-01-20 10:37:34 -0800112static void fillSensorIdServiceMap(const std::string&,
Lei YU7f3a70f2021-12-07 16:40:40 +0800113 const std::string& /*intf*/, uint8_t id,
114 const std::string& service)
115{
116 if (idToServiceMap.find(id) != idToServiceMap.end())
117 {
118 return;
119 }
120 idToServiceMap[id] = service;
121 serviceToIdMap[service].insert(id);
122}
123
124static void fillSensorIdServiceMap(const std::string& obj,
125 const std::string& intf, uint8_t id)
126{
127 if (idToServiceMap.find(id) != idToServiceMap.end())
128 {
129 return;
130 }
131 try
132 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500133 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lei YU7f3a70f2021-12-07 16:40:40 +0800134 auto service = ipmi::getService(bus, intf, obj);
135 idToServiceMap[id] = service;
136 serviceToIdMap[service].insert(id);
137 }
138 catch (...)
139 {
140 // Ignore
141 }
142}
143
Lei YUbe5c6b22021-09-16 15:46:20 +0800144void initSensorMatches()
145{
146 using namespace sdbusplus::bus::match::rules;
Patrick Williams5d82f472022-07-22 19:26:53 -0500147 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lei YUbe5c6b22021-09-16 15:46:20 +0800148 for (const auto& s : ipmi::sensor::sensors)
149 {
150 sensorAddedMatches.emplace(
151 s.first,
Patrick Williams5d82f472022-07-22 19:26:53 -0500152 std::make_unique<sdbusplus::bus::match_t>(
Lei YUbe5c6b22021-09-16 15:46:20 +0800153 bus, interfacesAdded() + argNpath(0, s.second.sensorPath),
Lei YU7f3a70f2021-12-07 16:40:40 +0800154 [id = s.first, obj = s.second.sensorPath,
155 intf = s.second.propertyInterfaces.begin()->first](
156 auto& /*msg*/) { fillSensorIdServiceMap(obj, intf, id); }));
157 sensorRemovedMatches.emplace(
158 s.first,
Patrick Williams5d82f472022-07-22 19:26:53 -0500159 std::make_unique<sdbusplus::bus::match_t>(
Lei YU7f3a70f2021-12-07 16:40:40 +0800160 bus, interfacesRemoved() + argNpath(0, s.second.sensorPath),
161 [id = s.first](auto& /*msg*/) {
Patrick Williams1318a5e2024-08-16 15:19:54 -0400162 // Ideally this should work.
163 // But when a service is terminated or crashed, it does not
164 // emit interfacesRemoved signal. In that case it's handled
165 // by sensorsOwnerMatch
166 sensorCacheMap[id].reset();
167 }));
Lei YUbe5c6b22021-09-16 15:46:20 +0800168 sensorUpdatedMatches.emplace(
Patrick Williams1318a5e2024-08-16 15:19:54 -0400169 s.first,
170 std::make_unique<sdbusplus::bus::match_t>(
171 bus,
172 type::signal() + path(s.second.sensorPath) +
173 member("PropertiesChanged"s) +
174 interface("org.freedesktop.DBus.Properties"s),
175 [&s](auto& msg) {
176 fillSensorIdServiceMap(
177 s.second.sensorPath,
178 s.second.propertyInterfaces.begin()->first, 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 }
192 }));
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) {
Patrick Williams1318a5e2024-08-16 15:19:54 -0400196 std::string name;
197 std::string oldOwner;
198 std::string newOwner;
199 msg.read(name, oldOwner, newOwner);
Jian Zhang4a105cd2022-08-05 22:26:42 +0800200
Patrick Williams1318a5e2024-08-16 15:19:54 -0400201 if (!name.empty() && newOwner.empty())
Jian Zhang4a105cd2022-08-05 22:26:42 +0800202 {
Patrick Williams1318a5e2024-08-16 15:19:54 -0400203 // 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 }
Jian Zhang4a105cd2022-08-05 22:26:42 +0800214 }
Patrick Williams1318a5e2024-08-16 15:19:54 -0400215 });
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
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700219// Use a lookup table to find the interface name of a specific sensor
220// This will be used until an alternative is found. this is the first
221// step for mapping IPMI
Patrick Venture0b02be92018-08-31 11:55:55 -0700222int find_openbmc_path(uint8_t num, dbus_interface_t* interface)
223{
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700224 const auto& sensor_it = ipmi::sensor::sensors.find(num);
225 if (sensor_it == ipmi::sensor::sensors.end())
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700226 {
Adriana Kobylakba23ff72018-09-12 12:58:43 -0500227 // The sensor map does not contain the sensor requested
228 return -EINVAL;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700229 }
230
231 const auto& info = sensor_it->second;
232
George Liua0088712024-01-30 13:03:23 +0800233 std::string serviceName{};
234 try
235 {
236 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Patrick Williams1318a5e2024-08-16 15:19:54 -0400237 serviceName =
238 ipmi::getService(bus, info.sensorInterface, info.sensorPath);
George Liua0088712024-01-30 13:03:23 +0800239 }
240 catch (const sdbusplus::exception_t&)
Patrick Venture0b02be92018-08-31 11:55:55 -0700241 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700242 std::fprintf(stderr, "Failed to get %s busname: %s\n",
George Liua0088712024-01-30 13:03:23 +0800243 info.sensorPath.c_str(), serviceName.c_str());
244 return -EINVAL;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700245 }
246
247 interface->sensortype = info.sensorType;
George Liua0088712024-01-30 13:03:23 +0800248 strcpy(interface->bus, serviceName.c_str());
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700249 strcpy(interface->path, info.sensorPath.c_str());
250 // Take the interface name from the beginning of the DbusInterfaceMap. This
251 // works for the Value interface but may not suffice for more complex
252 // sensors.
253 // tracked https://github.com/openbmc/phosphor-host-ipmid/issues/103
Patrick Venture0b02be92018-08-31 11:55:55 -0700254 strcpy(interface->interface,
255 info.propertyInterfaces.begin()->first.c_str());
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700256 interface->sensornumber = num;
257
George Liua0088712024-01-30 13:03:23 +0800258 return 0;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700259}
260
Tomd700e762016-09-20 18:24:13 +0530261/////////////////////////////////////////////////////////////////////
262//
263// Routines used by ipmi commands wanting to interact on the dbus
264//
265/////////////////////////////////////////////////////////////////////
Patrick Venture0b02be92018-08-31 11:55:55 -0700266int set_sensor_dbus_state_s(uint8_t number, const char* method,
267 const char* value)
268{
Tomd700e762016-09-20 18:24:13 +0530269 dbus_interface_t a;
270 int r;
271 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700272 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530273
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700274 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530275
Patrick Venture0b02be92018-08-31 11:55:55 -0700276 if (r < 0)
277 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700278 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530279 return 0;
280 }
281
Patrick Venture0b02be92018-08-31 11:55:55 -0700282 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
283 method);
284 if (r < 0)
285 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700286 std::fprintf(stderr, "Failed to create a method call: %s",
287 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530288 goto final;
289 }
290
291 r = sd_bus_message_append(m, "v", "s", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700292 if (r < 0)
293 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700294 std::fprintf(stderr, "Failed to create a input parameter: %s",
295 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530296 goto final;
297 }
298
Tomd700e762016-09-20 18:24:13 +0530299 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700300 if (r < 0)
301 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700302 std::fprintf(stderr, "Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530303 }
304
305final:
306 sd_bus_error_free(&error);
307 m = sd_bus_message_unref(m);
308
309 return 0;
310}
Patrick Venture0b02be92018-08-31 11:55:55 -0700311int set_sensor_dbus_state_y(uint8_t number, const char* method,
312 const uint8_t value)
313{
Tomd700e762016-09-20 18:24:13 +0530314 dbus_interface_t a;
315 int r;
316 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700317 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530318
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700319 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530320
Patrick Venture0b02be92018-08-31 11:55:55 -0700321 if (r < 0)
322 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700323 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530324 return 0;
325 }
326
Patrick Venture0b02be92018-08-31 11:55:55 -0700327 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
328 method);
329 if (r < 0)
330 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700331 std::fprintf(stderr, "Failed to create a method call: %s",
332 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530333 goto final;
334 }
335
336 r = sd_bus_message_append(m, "v", "i", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700337 if (r < 0)
338 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700339 std::fprintf(stderr, "Failed to create a input parameter: %s",
340 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530341 goto final;
342 }
343
Tomd700e762016-09-20 18:24:13 +0530344 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700345 if (r < 0)
346 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700347 std::fprintf(stderr, "12 Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530348 }
349
350final:
351 sd_bus_error_free(&error);
352 m = sd_bus_message_unref(m);
353
354 return 0;
355}
356
Patrick Venture0b02be92018-08-31 11:55:55 -0700357uint8_t dbus_to_sensor_type(char* p)
358{
Patrick Venture0b02be92018-08-31 11:55:55 -0700359 sensorTypemap_t* s = g_SensorTypeMap;
360 char r = 0;
361 while (s->number != 0xFF)
362 {
363 if (!strcmp(s->dbusname, p))
364 {
Tom Joseph558184e2017-09-01 13:45:05 +0530365 r = s->typecode;
Patrick Venture0b02be92018-08-31 11:55:55 -0700366 break;
Chris Austenac4604a2015-10-13 12:43:27 -0500367 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500368 s++;
Chris Austenac4604a2015-10-13 12:43:27 -0500369 }
370
Chris Austen0012e9b2015-10-22 01:37:46 -0500371 if (s->number == 0xFF)
372 printf("Failed to find Sensor Type %s\n", p);
Chris Austenac4604a2015-10-13 12:43:27 -0500373
Chris Austen0012e9b2015-10-22 01:37:46 -0500374 return r;
Chris Austenac4604a2015-10-13 12:43:27 -0500375}
376
Patrick Venture0b02be92018-08-31 11:55:55 -0700377uint8_t get_type_from_interface(dbus_interface_t dbus_if)
378{
Brad Bishop56003452016-10-05 21:49:19 -0400379 uint8_t type;
Chris Austen0012e9b2015-10-22 01:37:46 -0500380
Chris Austen0012e9b2015-10-22 01:37:46 -0500381 // This is where sensors that do not exist in dbus but do
382 // exist in the host code stop. This should indicate it
383 // is not a supported sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700384 if (dbus_if.interface[0] == 0)
385 {
386 return 0;
387 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500388
Emily Shaffer71174412017-04-05 15:10:40 -0700389 // Fetch type from interface itself.
390 if (dbus_if.sensortype != 0)
391 {
392 type = dbus_if.sensortype;
Patrick Venture0b02be92018-08-31 11:55:55 -0700393 }
394 else
395 {
Chris Austen0012e9b2015-10-22 01:37:46 -0500396 // Non InventoryItems
Patrick Venture4491a462018-10-13 13:00:42 -0700397 char* p = strrchr(dbus_if.path, '/');
Patrick Venture0b02be92018-08-31 11:55:55 -0700398 type = dbus_to_sensor_type(p + 1);
Chris Austen0012e9b2015-10-22 01:37:46 -0500399 }
400
Brad Bishop56003452016-10-05 21:49:19 -0400401 return type;
Patrick Venture0b02be92018-08-31 11:55:55 -0700402}
Chris Austen0012e9b2015-10-22 01:37:46 -0500403
Emily Shaffer391f3302017-04-03 10:27:08 -0700404// Replaces find_sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700405uint8_t find_type_for_sensor_number(uint8_t num)
406{
Emily Shaffer391f3302017-04-03 10:27:08 -0700407 int r;
408 dbus_interface_t dbus_if;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700409 r = find_openbmc_path(num, &dbus_if);
Patrick Venture0b02be92018-08-31 11:55:55 -0700410 if (r < 0)
411 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700412 std::fprintf(stderr, "Could not find sensor %d\n", num);
Lei YU91875f72018-04-03 15:14:49 +0800413 return 0;
Emily Shaffer391f3302017-04-03 10:27:08 -0700414 }
415 return get_type_from_interface(dbus_if);
416}
417
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000418/**
419 * @brief implements the get sensor type command.
420 * @param - sensorNumber
421 *
422 * @return IPMI completion code plus response data on success.
423 * - sensorType
424 * - eventType
425 **/
426
427ipmi::RspType<uint8_t, // sensorType
428 uint8_t // eventType
429 >
430 ipmiGetSensorType(uint8_t sensorNumber)
Chris Austenac4604a2015-10-13 12:43:27 -0500431{
Wang Xiaohua64b76212022-08-11 13:23:53 +0800432 const auto it = ipmi::sensor::sensors.find(sensorNumber);
433 if (it == ipmi::sensor::sensors.end())
Patrick Venture0b02be92018-08-31 11:55:55 -0700434 {
Wang Xiaohua64b76212022-08-11 13:23:53 +0800435 // The sensor map does not contain the sensor requested
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000436 return ipmi::responseSensorInvalid();
Chris Austen0012e9b2015-10-22 01:37:46 -0500437 }
438
Wang Xiaohua64b76212022-08-11 13:23:53 +0800439 const auto& info = it->second;
440 uint8_t sensorType = info.sensorType;
441 uint8_t eventType = info.sensorReadingType;
442
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000443 return ipmi::responseSuccess(sensorType, eventType);
Chris Austenac4604a2015-10-13 12:43:27 -0500444}
445
Patrick Venture0b02be92018-08-31 11:55:55 -0700446const std::set<std::string> analogSensorInterfaces = {
Emily Shaffercc941e12017-06-14 13:06:26 -0700447 "xyz.openbmc_project.Sensor.Value",
Patrick Venturee9a64052017-08-18 19:17:27 -0700448 "xyz.openbmc_project.Control.FanPwm",
Emily Shaffercc941e12017-06-14 13:06:26 -0700449};
450
451bool isAnalogSensor(const std::string& interface)
452{
453 return (analogSensorInterfaces.count(interface));
454}
455
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000456/**
457@brief This command is used to set sensorReading.
458
459@param
460 - sensorNumber
461 - operation
462 - reading
463 - assertOffset0_7
464 - assertOffset8_14
465 - deassertOffset0_7
466 - deassertOffset8_14
467 - eventData1
468 - eventData2
469 - eventData3
470
471@return completion code on success.
472**/
473
Patrick Williams1318a5e2024-08-16 15:19:54 -0400474ipmi::RspType<> ipmiSetSensorReading(
475 uint8_t sensorNumber, uint8_t operation, uint8_t reading,
476 uint8_t assertOffset0_7, uint8_t assertOffset8_14,
477 uint8_t deassertOffset0_7, uint8_t deassertOffset8_14, uint8_t eventData1,
478 uint8_t eventData2, uint8_t eventData3)
Tom Josephbe703f72017-03-09 12:34:35 +0530479{
George Liu3b1071a2024-07-17 20:26:14 +0800480 lg2::debug("IPMI SET_SENSOR, sensorNumber: {SENSOR_NUM}", "SENSOR_NUM",
481 lg2::hex, sensorNumber);
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000482
Arun P. Mohanan0634e982021-08-30 15:21:33 +0530483 if (sensorNumber == 0xFF)
484 {
485 return ipmi::responseInvalidFieldRequest();
486 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000487 ipmi::sensor::SetSensorReadingReq cmdData;
488
489 cmdData.number = sensorNumber;
490 cmdData.operation = operation;
491 cmdData.reading = reading;
492 cmdData.assertOffset0_7 = assertOffset0_7;
493 cmdData.assertOffset8_14 = assertOffset8_14;
494 cmdData.deassertOffset0_7 = deassertOffset0_7;
495 cmdData.deassertOffset8_14 = deassertOffset8_14;
496 cmdData.eventData1 = eventData1;
497 cmdData.eventData2 = eventData2;
498 cmdData.eventData3 = eventData3;
Tom Josephbe703f72017-03-09 12:34:35 +0530499
500 // Check if the Sensor Number is present
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700501 const auto iter = ipmi::sensor::sensors.find(sensorNumber);
502 if (iter == ipmi::sensor::sensors.end())
Tom Josephbe703f72017-03-09 12:34:35 +0530503 {
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000504 updateSensorRecordFromSSRAESC(&sensorNumber);
505 return ipmi::responseSuccess();
Tom Josephbe703f72017-03-09 12:34:35 +0530506 }
507
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500508 try
509 {
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500510 if (ipmi::sensor::Mutability::Write !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700511 (iter->second.mutability & ipmi::sensor::Mutability::Write))
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500512 {
George Liu3b1071a2024-07-17 20:26:14 +0800513 lg2::error("Sensor Set operation is not allowed, "
514 "sensorNumber: {SENSOR_NUM}",
515 "SENSOR_NUM", lg2::hex, sensorNumber);
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000516 return ipmi::responseIllegalCommand();
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500517 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000518 auto ipmiRC = iter->second.updateFunc(cmdData, iter->second);
519 return ipmi::response(ipmiRC);
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500520 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500521 catch (const InternalFailure& e)
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500522 {
George Liu3b1071a2024-07-17 20:26:14 +0800523 lg2::error("Set sensor failed, sensorNumber: {SENSOR_NUM}",
524 "SENSOR_NUM", lg2::hex, sensorNumber);
Patrick Venture0b02be92018-08-31 11:55:55 -0700525 commit<InternalFailure>();
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000526 return ipmi::responseUnspecifiedError();
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500527 }
Tom Joseph82024322017-09-28 20:07:29 +0530528 catch (const std::runtime_error& e)
529 {
George Liu3b1071a2024-07-17 20:26:14 +0800530 lg2::error("runtime error: {ERROR}", "ERROR", e);
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000531 return ipmi::responseUnspecifiedError();
Tom Joseph82024322017-09-28 20:07:29 +0530532 }
Chris Austenac4604a2015-10-13 12:43:27 -0500533}
534
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000535/** @brief implements the get sensor reading command
536 * @param sensorNum - sensor number
537 *
538 * @returns IPMI completion code plus response data
539 * - senReading - sensor reading
540 * - reserved
541 * - readState - sensor reading state enabled
542 * - senScanState - sensor scan state disabled
543 * - allEventMessageState - all Event message state disabled
544 * - assertionStatesLsb - threshold levels states
545 * - assertionStatesMsb - discrete reading sensor states
546 */
547ipmi::RspType<uint8_t, // sensor reading
Tom Joseph3ee668f2018-03-02 19:49:17 +0530548
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000549 uint5_t, // reserved
550 bool, // reading state
Sui Chen4cc42552019-09-11 10:28:35 -0700551 bool, // 0 = sensor scanning state disabled
552 bool, // 0 = all event messages disabled
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000553
554 uint8_t, // threshold levels states
555 uint8_t // discrete reading sensor states
556 >
Willy Tu11d68892022-01-20 10:37:34 -0800557 ipmiSensorGetSensorReading([[maybe_unused]] ipmi::Context::ptr& ctx,
558 uint8_t sensorNum)
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000559{
560 if (sensorNum == 0xFF)
561 {
562 return ipmi::responseInvalidFieldRequest();
563 }
564
565 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700566 if (iter == ipmi::sensor::sensors.end())
Tom Joseph3ee668f2018-03-02 19:49:17 +0530567 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000568 return ipmi::responseSensorInvalid();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530569 }
570 if (ipmi::sensor::Mutability::Read !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700571 (iter->second.mutability & ipmi::sensor::Mutability::Read))
Tom Joseph3ee668f2018-03-02 19:49:17 +0530572 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000573 return ipmi::responseIllegalCommand();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530574 }
575
576 try
577 {
Lei YU8c2c0482021-09-16 17:28:28 +0800578#ifdef FEATURE_SENSORS_CACHE
Lei YU8e8152c2021-12-06 20:11:08 +0800579 auto& sensorData = sensorCacheMap[sensorNum];
Lei YU97140502021-09-17 13:49:43 +0800580 if (!sensorData.has_value())
581 {
Lei YUa55e9ea2021-09-18 15:15:17 +0800582 // No cached value, try read it
Lei YU8e8152c2021-12-06 20:11:08 +0800583 std::string service;
584 boost::system::error_code ec;
Lei YUa55e9ea2021-09-18 15:15:17 +0800585 const auto& sensorInfo = iter->second;
Lei YU8e8152c2021-12-06 20:11:08 +0800586 ec = ipmi::getService(ctx, sensorInfo.sensorInterface,
587 sensorInfo.sensorPath, service);
588 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800589 {
Lei YU8e8152c2021-12-06 20:11:08 +0800590 return ipmi::responseUnspecifiedError();
Lei YUa55e9ea2021-09-18 15:15:17 +0800591 }
Lei YU7f3a70f2021-12-07 16:40:40 +0800592 fillSensorIdServiceMap(sensorInfo.sensorPath,
593 sensorInfo.propertyInterfaces.begin()->first,
594 iter->first, service);
Lei YU8e8152c2021-12-06 20:11:08 +0800595
596 ipmi::PropertyMap props;
597 ec = ipmi::getAllDbusProperties(
598 ctx, service, sensorInfo.sensorPath,
599 sensorInfo.propertyInterfaces.begin()->first, props);
600 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800601 {
Lei YU8e8152c2021-12-06 20:11:08 +0800602 fprintf(stderr, "Failed to get sensor %s, %d: %s\n",
603 sensorInfo.sensorPath.c_str(), ec.value(),
604 ec.message().c_str());
Lei YUa55e9ea2021-09-18 15:15:17 +0800605 // Intitilizing with default values
606 constexpr uint8_t senReading = 0;
607 constexpr uint5_t reserved{0};
608 constexpr bool readState = true;
609 constexpr bool senScanState = false;
610 constexpr bool allEventMessageState = false;
611 constexpr uint8_t assertionStatesLsb = 0;
612 constexpr uint8_t assertionStatesMsb = 0;
Lei YU97140502021-09-17 13:49:43 +0800613
Patrick Williams1318a5e2024-08-16 15:19:54 -0400614 return ipmi::responseSuccess(
615 senReading, reserved, readState, senScanState,
616 allEventMessageState, assertionStatesLsb,
617 assertionStatesMsb);
Lei YUa55e9ea2021-09-18 15:15:17 +0800618 }
Lei YU8e8152c2021-12-06 20:11:08 +0800619 sensorInfo.getFunc(sensorNum, sensorInfo, props);
Lei YU97140502021-09-17 13:49:43 +0800620 }
621 return ipmi::responseSuccess(
622 sensorData->response.reading, uint5_t(0),
623 sensorData->response.readingOrStateUnavailable,
624 sensorData->response.scanningEnabled,
625 sensorData->response.allEventMessagesEnabled,
626 sensorData->response.thresholdLevelsStates,
627 sensorData->response.discreteReadingSensorStates);
628
Lei YU8c2c0482021-09-16 17:28:28 +0800629#else
Sui Chen4cc42552019-09-11 10:28:35 -0700630 ipmi::sensor::GetSensorResponse getResponse =
631 iter->second.getFunc(iter->second);
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000632
Patrick Williams1318a5e2024-08-16 15:19:54 -0400633 return ipmi::responseSuccess(
634 getResponse.reading, uint5_t(0),
635 getResponse.readingOrStateUnavailable, getResponse.scanningEnabled,
636 getResponse.allEventMessagesEnabled,
637 getResponse.thresholdLevelsStates,
638 getResponse.discreteReadingSensorStates);
Lei YU8c2c0482021-09-16 17:28:28 +0800639#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530640 }
Brandon Kim9cf85622019-06-19 12:05:08 -0700641#ifdef UPDATE_FUNCTIONAL_ON_FAIL
642 catch (const SensorFunctionalError& e)
643 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000644 return ipmi::responseResponseError();
Brandon Kim9cf85622019-06-19 12:05:08 -0700645 }
646#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530647 catch (const std::exception& e)
648 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000649 // Intitilizing with default values
650 constexpr uint8_t senReading = 0;
651 constexpr uint5_t reserved{0};
652 constexpr bool readState = true;
653 constexpr bool senScanState = false;
654 constexpr bool allEventMessageState = false;
655 constexpr uint8_t assertionStatesLsb = 0;
656 constexpr uint8_t assertionStatesMsb = 0;
657
658 return ipmi::responseSuccess(senReading, reserved, readState,
659 senScanState, allEventMessageState,
660 assertionStatesLsb, assertionStatesMsb);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530661 }
662}
663
George Liu402024a2024-07-16 14:36:31 +0800664void updateWarningThreshold(uint8_t lowerValue, uint8_t upperValue,
665 get_sdr::GetSensorThresholdsResponse& resp)
666{
667 resp.lowerNonCritical = lowerValue;
668 resp.upperNonCritical = upperValue;
669 if (lowerValue)
670 {
671 resp.validMask |= static_cast<uint8_t>(
672 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK);
673 }
674
675 if (upperValue)
676 {
677 resp.validMask |= static_cast<uint8_t>(
678 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK);
679 }
680}
681
682void updateCriticalThreshold(uint8_t lowerValue, uint8_t upperValue,
683 get_sdr::GetSensorThresholdsResponse& resp)
684{
685 resp.lowerCritical = lowerValue;
686 resp.upperCritical = upperValue;
687 if (lowerValue)
688 {
689 resp.validMask |= static_cast<uint8_t>(
690 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK);
691 }
692
693 if (upperValue)
694 {
695 resp.validMask |= static_cast<uint8_t>(
696 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK);
697 }
698}
699
700void updateNonRecoverableThreshold(uint8_t lowerValue, uint8_t upperValue,
701 get_sdr::GetSensorThresholdsResponse& resp)
702{
703 resp.lowerNonRecoverable = lowerValue;
704 resp.upperNonRecoverable = upperValue;
705 if (lowerValue)
706 {
707 resp.validMask |= static_cast<uint8_t>(
708 ipmi::sensor::ThresholdMask::NON_RECOVERABLE_LOW_MASK);
709 }
710
711 if (upperValue)
712 {
713 resp.validMask |= static_cast<uint8_t>(
714 ipmi::sensor::ThresholdMask::NON_RECOVERABLE_HIGH_MASK);
715 }
716}
717
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300718get_sdr::GetSensorThresholdsResponse
719 getSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600720{
William A. Kennington III515bc372020-10-27 16:32:32 -0700721 get_sdr::GetSensorThresholdsResponse resp{};
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700722 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530723 const auto info = iter->second;
724
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300725 std::string service;
726 boost::system::error_code ec;
727 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
728 if (ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530729 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300730 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530731 }
732
Willy Tu9154caa2021-12-02 02:28:54 -0800733 int32_t minClamp;
734 int32_t maxClamp;
735 int32_t rawData;
736 constexpr uint8_t sensorUnitsSignedBits = 2 << 6;
737 constexpr uint8_t signedDataFormat = 0x80;
738 if ((info.sensorUnits1 & sensorUnitsSignedBits) == signedDataFormat)
739 {
740 minClamp = std::numeric_limits<int8_t>::lowest();
741 maxClamp = std::numeric_limits<int8_t>::max();
742 }
743 else
744 {
745 minClamp = std::numeric_limits<uint8_t>::lowest();
746 maxClamp = std::numeric_limits<uint8_t>::max();
747 }
George Liu402024a2024-07-16 14:36:31 +0800748
749 static std::vector<std::string> thresholdNames{"Warning", "Critical",
750 "NonRecoverable"};
751
752 for (const auto& thresholdName : thresholdNames)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530753 {
George Liu402024a2024-07-16 14:36:31 +0800754 std::string thresholdInterface =
755 "xyz.openbmc_project.Sensor.Threshold." + thresholdName;
756 std::string thresholdLow = thresholdName + "Low";
757 std::string thresholdHigh = thresholdName + "High";
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300758
George Liu402024a2024-07-16 14:36:31 +0800759 ipmi::PropertyMap thresholds;
760 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
761 thresholdInterface, thresholds);
762 if (ec)
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300763 {
George Liu402024a2024-07-16 14:36:31 +0800764 continue;
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300765 }
766
George Liu402024a2024-07-16 14:36:31 +0800767 double lowValue = ipmi::mappedVariant<double>(
768 thresholds, thresholdLow, std::numeric_limits<double>::quiet_NaN());
769 double highValue = ipmi::mappedVariant<double>(
770 thresholds, thresholdHigh,
Hieu Huynh92079a22022-10-07 08:24:59 +0000771 std::numeric_limits<double>::quiet_NaN());
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530772
George Liu402024a2024-07-16 14:36:31 +0800773 uint8_t lowerValue = 0;
774 uint8_t upperValue = 0;
775 if (std::isfinite(lowValue))
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300776 {
George Liu402024a2024-07-16 14:36:31 +0800777 lowValue *= std::pow(10, info.scale - info.exponentR);
778 rawData = round((lowValue - info.scaledOffset) / info.coefficientM);
779 lowerValue =
Willy Tu9154caa2021-12-02 02:28:54 -0800780 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300781 }
782
George Liu402024a2024-07-16 14:36:31 +0800783 if (std::isfinite(highValue))
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300784 {
George Liu402024a2024-07-16 14:36:31 +0800785 highValue *= std::pow(10, info.scale - info.exponentR);
786 rawData =
787 round((highValue - info.scaledOffset) / info.coefficientM);
788 upperValue =
Willy Tu9154caa2021-12-02 02:28:54 -0800789 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
George Liu402024a2024-07-16 14:36:31 +0800790 }
791
792 if (thresholdName == "Warning")
793 {
794 updateWarningThreshold(lowerValue, upperValue, resp);
795 }
796 else if (thresholdName == "Critical")
797 {
798 updateCriticalThreshold(lowerValue, upperValue, resp);
799 }
800 else if (thresholdName == "NonRecoverable")
801 {
802 updateNonRecoverableThreshold(lowerValue, upperValue, resp);
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300803 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530804 }
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000805
806 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530807}
808
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000809/** @brief implements the get sensor thresholds command
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300810 * @param ctx - IPMI context pointer
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000811 * @param sensorNum - sensor number
812 *
813 * @returns IPMI completion code plus response data
814 * - validMask - threshold mask
815 * - lower non-critical threshold - IPMI messaging state
816 * - lower critical threshold - link authentication state
817 * - lower non-recoverable threshold - callback state
818 * - upper non-critical threshold
819 * - upper critical
820 * - upper non-recoverable
821 */
822ipmi::RspType<uint8_t, // validMask
823 uint8_t, // lowerNonCritical
824 uint8_t, // lowerCritical
825 uint8_t, // lowerNonRecoverable
826 uint8_t, // upperNonCritical
827 uint8_t, // upperCritical
828 uint8_t // upperNonRecoverable
829 >
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300830 ipmiSensorGetSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530831{
832 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
833
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700834 const auto iter = ipmi::sensor::sensors.find(sensorNum);
835 if (iter == ipmi::sensor::sensors.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600836 {
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000837 return ipmi::responseSensorInvalid();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600838 }
839
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530840 const auto info = iter->second;
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600841
Patrick Venture0b02be92018-08-31 11:55:55 -0700842 // Proceed only if the sensor value interface is implemented.
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530843 if (info.propertyInterfaces.find(valueInterface) ==
844 info.propertyInterfaces.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600845 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700846 // return with valid mask as 0
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000847 return ipmi::responseSuccess();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600848 }
849
Lei YU14a47812021-09-17 15:58:04 +0800850 auto it = sensorThresholdMap.find(sensorNum);
851 if (it == sensorThresholdMap.end())
852 {
George Liu7a34a6c2024-09-12 16:03:18 +0800853 auto resp = getSensorThresholds(ctx, sensorNum);
854 if (resp.validMask == 0)
855 {
856 return ipmi::responseSensorInvalid();
857 }
858 sensorThresholdMap[sensorNum] = std::move(resp);
Lei YU14a47812021-09-17 15:58:04 +0800859 }
860
861 const auto& resp = sensorThresholdMap[sensorNum];
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600862
Patrick Williams1318a5e2024-08-16 15:19:54 -0400863 return ipmi::responseSuccess(
864 resp.validMask, resp.lowerNonCritical, resp.lowerCritical,
865 resp.lowerNonRecoverable, resp.upperNonCritical, resp.upperCritical,
866 resp.upperNonRecoverable);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600867}
868
Lotus Xuf93da662021-10-18 17:20:06 +0800869/** @brief implements the Set Sensor threshold command
870 * @param sensorNumber - sensor number
871 * @param lowerNonCriticalThreshMask
872 * @param lowerCriticalThreshMask
873 * @param lowerNonRecovThreshMask
874 * @param upperNonCriticalThreshMask
875 * @param upperCriticalThreshMask
876 * @param upperNonRecovThreshMask
877 * @param reserved
878 * @param lowerNonCritical - lower non-critical threshold
879 * @param lowerCritical - Lower critical threshold
880 * @param lowerNonRecoverable - Lower non recovarable threshold
881 * @param upperNonCritical - Upper non-critical threshold
882 * @param upperCritical - Upper critical
883 * @param upperNonRecoverable - Upper Non-recoverable
884 *
885 * @returns IPMI completion code
886 */
887ipmi::RspType<> ipmiSenSetSensorThresholds(
888 ipmi::Context::ptr& ctx, uint8_t sensorNum, bool lowerNonCriticalThreshMask,
889 bool lowerCriticalThreshMask, bool lowerNonRecovThreshMask,
890 bool upperNonCriticalThreshMask, bool upperCriticalThreshMask,
891 bool upperNonRecovThreshMask, uint2_t reserved, uint8_t lowerNonCritical,
Willy Tu11d68892022-01-20 10:37:34 -0800892 uint8_t lowerCritical, uint8_t, uint8_t upperNonCritical,
893 uint8_t upperCritical, uint8_t)
Lotus Xuf93da662021-10-18 17:20:06 +0800894{
895 if (reserved)
896 {
897 return ipmi::responseInvalidFieldRequest();
898 }
899
900 // lower nc and upper nc not suppported on any sensor
901 if (lowerNonRecovThreshMask || upperNonRecovThreshMask)
902 {
903 return ipmi::responseInvalidFieldRequest();
904 }
905
906 // if none of the threshold mask are set, nothing to do
907 if (!(lowerNonCriticalThreshMask | lowerCriticalThreshMask |
908 lowerNonRecovThreshMask | upperNonCriticalThreshMask |
909 upperCriticalThreshMask | upperNonRecovThreshMask))
910 {
911 return ipmi::responseSuccess();
912 }
913
914 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
915
916 const auto iter = ipmi::sensor::sensors.find(sensorNum);
917 if (iter == ipmi::sensor::sensors.end())
918 {
919 return ipmi::responseSensorInvalid();
920 }
921
922 const auto& info = iter->second;
923
924 // Proceed only if the sensor value interface is implemented.
925 if (info.propertyInterfaces.find(valueInterface) ==
926 info.propertyInterfaces.end())
927 {
928 // return with valid mask as 0
929 return ipmi::responseSuccess();
930 }
931
932 constexpr auto warningThreshIntf =
933 "xyz.openbmc_project.Sensor.Threshold.Warning";
934 constexpr auto criticalThreshIntf =
935 "xyz.openbmc_project.Sensor.Threshold.Critical";
936
937 std::string service;
938 boost::system::error_code ec;
939 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
940 if (ec)
941 {
942 return ipmi::responseResponseError();
943 }
944 // store a vector of property name, value to set, and interface
945 std::vector<std::tuple<std::string, uint8_t, std::string>> thresholdsToSet;
946
947 // define the indexes of the tuple
948 constexpr uint8_t propertyName = 0;
949 constexpr uint8_t thresholdValue = 1;
950 constexpr uint8_t interface = 2;
951 // verifiy all needed fields are present
952 if (lowerCriticalThreshMask || upperCriticalThreshMask)
953 {
Lotus Xuf93da662021-10-18 17:20:06 +0800954 ipmi::PropertyMap findThreshold;
955 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
956 criticalThreshIntf, findThreshold);
957
958 if (!ec)
959 {
960 if (lowerCriticalThreshMask)
961 {
962 auto findLower = findThreshold.find("CriticalLow");
963 if (findLower == findThreshold.end())
964 {
965 return ipmi::responseInvalidFieldRequest();
966 }
967 thresholdsToSet.emplace_back("CriticalLow", lowerCritical,
968 criticalThreshIntf);
969 }
970 if (upperCriticalThreshMask)
971 {
972 auto findUpper = findThreshold.find("CriticalHigh");
973 if (findUpper == findThreshold.end())
974 {
975 return ipmi::responseInvalidFieldRequest();
976 }
977 thresholdsToSet.emplace_back("CriticalHigh", upperCritical,
978 criticalThreshIntf);
979 }
980 }
981 }
982 if (lowerNonCriticalThreshMask || upperNonCriticalThreshMask)
983 {
984 ipmi::PropertyMap findThreshold;
985 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
986 warningThreshIntf, findThreshold);
987
988 if (!ec)
989 {
990 if (lowerNonCriticalThreshMask)
991 {
992 auto findLower = findThreshold.find("WarningLow");
993 if (findLower == findThreshold.end())
994 {
995 return ipmi::responseInvalidFieldRequest();
996 }
997 thresholdsToSet.emplace_back("WarningLow", lowerNonCritical,
998 warningThreshIntf);
999 }
1000 if (upperNonCriticalThreshMask)
1001 {
1002 auto findUpper = findThreshold.find("WarningHigh");
1003 if (findUpper == findThreshold.end())
1004 {
1005 return ipmi::responseInvalidFieldRequest();
1006 }
1007 thresholdsToSet.emplace_back("WarningHigh", upperNonCritical,
1008 warningThreshIntf);
1009 }
1010 }
1011 }
1012 for (const auto& property : thresholdsToSet)
1013 {
1014 // from section 36.3 in the IPMI Spec, assume all linear
1015 double valueToSet =
1016 ((info.coefficientM * std::get<thresholdValue>(property)) +
1017 (info.scaledOffset * std::pow(10.0, info.scale))) *
1018 std::pow(10.0, info.exponentR);
1019 ipmi::setDbusProperty(
1020 ctx, service, info.sensorPath, std::get<interface>(property),
1021 std::get<propertyName>(property), ipmi::Value(valueToSet));
1022 }
1023
Lei YU14a47812021-09-17 15:58:04 +08001024 // Invalidate the cache
1025 sensorThresholdMap.erase(sensorNum);
Lotus Xuf93da662021-10-18 17:20:06 +08001026 return ipmi::responseSuccess();
1027}
1028
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001029/** @brief implements the get SDR Info command
1030 * @param count - Operation
1031 *
1032 * @returns IPMI completion code plus response data
1033 * - sdrCount - sensor/SDR count
1034 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag
1035 */
1036ipmi::RspType<uint8_t, // respcount
1037 uint8_t // dynamic population flags
1038 >
1039 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count)
Emily Shafferd06e0e72017-04-05 09:08:57 -07001040{
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001041 uint8_t sdrCount;
1042 // multiple LUNs not supported.
1043 constexpr uint8_t lunsAndDynamicPopulation = 1;
1044 constexpr uint8_t getSdrCount = 0x01;
1045 constexpr uint8_t getSensorCount = 0x00;
1046
1047 if (count.value_or(0) == getSdrCount)
Emily Shafferd06e0e72017-04-05 09:08:57 -07001048 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001049 // Get SDR count. This returns the total number of SDRs in the device.
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001050 const auto& entityRecords =
1051 ipmi::sensor::EntityInfoMapContainer::getContainer()
1052 ->getIpmiEntityRecords();
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001053 sdrCount = ipmi::sensor::sensors.size() + frus.size() +
1054 entityRecords.size();
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001055 }
1056 else if (count.value_or(0) == getSensorCount)
1057 {
1058 // Get Sensor count. This returns the number of sensors
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001059 sdrCount = ipmi::sensor::sensors.size();
Emily Shafferd06e0e72017-04-05 09:08:57 -07001060 }
1061 else
1062 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001063 return ipmi::responseInvalidCommandOnLun();
Emily Shafferd06e0e72017-04-05 09:08:57 -07001064 }
1065
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001066 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation);
Emily Shafferd06e0e72017-04-05 09:08:57 -07001067}
1068
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001069/** @brief implements the reserve SDR command
1070 * @returns IPMI completion code plus response data
1071 * - reservationID - reservation ID
1072 */
1073ipmi::RspType<uint16_t> ipmiSensorReserveSdr()
Emily Shaffera344afc2017-04-13 15:09:39 -07001074{
1075 // A constant reservation ID is okay until we implement add/remove SDR.
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001076 constexpr uint16_t reservationID = 1;
Emily Shaffera344afc2017-04-13 15:09:39 -07001077
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001078 return ipmi::responseSuccess(reservationID);
Emily Shaffera344afc2017-04-13 15:09:39 -07001079}
Chris Austenac4604a2015-10-13 12:43:27 -05001080
Patrick Venture0b02be92018-08-31 11:55:55 -07001081void setUnitFieldsForObject(const ipmi::sensor::Info* info,
1082 get_sdr::SensorDataFullRecordBody* body)
Emily Shaffercc941e12017-06-14 13:06:26 -07001083{
Willy Tu523e2d12023-09-05 11:36:48 -07001084 namespace server = sdbusplus::server::xyz::openbmc_project::sensor;
Tom Josephdc212b22018-02-16 09:59:57 +05301085 try
Emily Shaffercc941e12017-06-14 13:06:26 -07001086 {
Tom Josephdc212b22018-02-16 09:59:57 +05301087 auto unit = server::Value::convertUnitFromString(info->unit);
1088 // Unit strings defined in
1089 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml
1090 switch (unit)
Emily Shaffercc941e12017-06-14 13:06:26 -07001091 {
Tom Josephdc212b22018-02-16 09:59:57 +05301092 case server::Value::Unit::DegreesC:
1093 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C;
1094 break;
1095 case server::Value::Unit::RPMS:
Kirill Pakhomov812e44c2018-10-22 16:25:35 +03001096 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM;
Tom Josephdc212b22018-02-16 09:59:57 +05301097 break;
1098 case server::Value::Unit::Volts:
1099 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS;
1100 break;
1101 case server::Value::Unit::Meters:
1102 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS;
1103 break;
1104 case server::Value::Unit::Amperes:
1105 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES;
1106 break;
1107 case server::Value::Unit::Joules:
1108 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES;
1109 break;
1110 case server::Value::Unit::Watts:
1111 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS;
1112 break;
1113 default:
1114 // Cannot be hit.
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001115 std::fprintf(stderr, "Unknown value unit type: = %s\n",
1116 info->unit.c_str());
Emily Shaffercc941e12017-06-14 13:06:26 -07001117 }
1118 }
Patrick Venture64678b82018-10-13 13:11:32 -07001119 catch (const sdbusplus::exception::InvalidEnumString& e)
Emily Shaffercc941e12017-06-14 13:06:26 -07001120 {
George Liu3b1071a2024-07-17 20:26:14 +08001121 lg2::warning("Warning: no unit provided for sensor!");
Emily Shaffercc941e12017-06-14 13:06:26 -07001122 }
Emily Shaffercc941e12017-06-14 13:06:26 -07001123}
1124
Patrick Venture0b02be92018-08-31 11:55:55 -07001125ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body,
1126 const ipmi::sensor::Info* info,
Willy Tu11d68892022-01-20 10:37:34 -08001127 ipmi_data_len_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001128{
1129 /* Functional sensor case */
Emily Shaffercc941e12017-06-14 13:06:26 -07001130 if (isAnalogSensor(info->propertyInterfaces.begin()->first))
Emily Shafferbbef71c2017-05-08 16:36:17 -07001131 {
Tony Leec5324252019-10-31 17:24:16 +08001132 body->sensor_units_1 = info->sensorUnits1; // default is 0. unsigned, no
1133 // rate, no modifier, not a %
Emily Shafferbbef71c2017-05-08 16:36:17 -07001134 /* Unit info */
Tom Josephdc212b22018-02-16 09:59:57 +05301135 setUnitFieldsForObject(info, body);
Emily Shaffer10f49592017-05-10 12:01:10 -07001136
1137 get_sdr::body::set_b(info->coefficientB, body);
1138 get_sdr::body::set_m(info->coefficientM, body);
1139 get_sdr::body::set_b_exp(info->exponentB, body);
Tom Josephdc212b22018-02-16 09:59:57 +05301140 get_sdr::body::set_r_exp(info->exponentR, body);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001141 }
1142
Tom Joseph96423912018-01-25 00:14:34 +05301143 /* ID string */
Jeremy Kerrbe4ffa82020-08-10 16:17:37 +08001144 auto id_string = info->sensorName;
1145
1146 if (id_string.empty())
1147 {
1148 id_string = info->sensorNameFunc(*info);
1149 }
Tom Joseph96423912018-01-25 00:14:34 +05301150
1151 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH)
1152 {
1153 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body);
1154 }
1155 else
1156 {
1157 get_sdr::body::set_id_strlen(id_string.length(), body);
1158 }
Paul Fertser51136982022-08-18 12:36:41 +00001159 get_sdr::body::set_id_type(3, body); // "8-bit ASCII + Latin 1"
Tom Joseph96423912018-01-25 00:14:34 +05301160 strncpy(body->id_string, id_string.c_str(),
1161 get_sdr::body::get_id_strlen(body));
1162
Emily Shafferbbef71c2017-05-08 16:36:17 -07001163 return IPMI_CC_OK;
1164};
1165
Ratan Guptae0cc8552018-01-22 14:23:04 +05301166ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response,
1167 ipmi_data_len_t data_len)
1168{
1169 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1170 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
Patrick Venture0b02be92018-08-31 11:55:55 -07001171 get_sdr::SensorDataFruRecord record{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301172 auto dataLength = 0;
1173
1174 auto fru = frus.begin();
Patrick Venture0b02be92018-08-31 11:55:55 -07001175 uint8_t fruID{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301176 auto recordID = get_sdr::request::get_record_id(req);
1177
1178 fruID = recordID - FRU_RECORD_ID_START;
1179 fru = frus.find(fruID);
1180 if (fru == frus.end())
1181 {
1182 return IPMI_CC_SENSOR_INVALID;
1183 }
1184
1185 /* Header */
1186 get_sdr::header::set_record_id(recordID, &(record.header));
1187 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1188 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD;
1189 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1190
1191 /* Key */
1192 record.key.fruID = fruID;
1193 record.key.accessLun |= IPMI_LOGICAL_FRU;
Matt Simmering68d9d402023-11-09 14:22:11 -08001194 record.key.deviceAddress = BMCTargetAddress;
Ratan Guptae0cc8552018-01-22 14:23:04 +05301195
1196 /* Body */
1197 record.body.entityID = fru->second[0].entityID;
1198 record.body.entityInstance = fru->second[0].entityInstance;
1199 record.body.deviceType = fruInventoryDevice;
1200 record.body.deviceTypeModifier = IPMIFruInventory;
1201
1202 /* Device ID string */
Patrick Venture0b02be92018-08-31 11:55:55 -07001203 auto deviceID =
1204 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1,
1205 fru->second[0].path.length());
Ratan Guptae0cc8552018-01-22 14:23:04 +05301206
1207 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH)
1208 {
1209 get_sdr::body::set_device_id_strlen(
Patrick Venture0b02be92018-08-31 11:55:55 -07001210 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301211 }
1212 else
1213 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001214 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301215 }
1216
1217 strncpy(record.body.deviceID, deviceID.c_str(),
1218 get_sdr::body::get_device_id_strlen(&(record.body)));
1219
1220 if (++fru == frus.end())
1221 {
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001222 // we have reached till end of fru, so assign the next record id to
1223 // 512(Max fru ID = 511) + Entity Record ID(may start with 0).
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001224 const auto& entityRecords =
1225 ipmi::sensor::EntityInfoMapContainer::getContainer()
1226 ->getIpmiEntityRecords();
Patrick Williams1318a5e2024-08-16 15:19:54 -04001227 auto next_record_id =
1228 (entityRecords.size())
1229 ? entityRecords.begin()->first + ENTITY_RECORD_ID_START
1230 : END_OF_RECORD;
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001231 get_sdr::response::set_next_record_id(next_record_id, resp);
1232 }
1233 else
1234 {
1235 get_sdr::response::set_next_record_id(
1236 (FRU_RECORD_ID_START + fru->first), resp);
1237 }
1238
1239 // Check for invalid offset size
1240 if (req->offset > sizeof(record))
1241 {
1242 return IPMI_CC_PARM_OUT_OF_RANGE;
1243 }
1244
1245 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1246 sizeof(record) - req->offset);
1247
1248 std::memcpy(resp->record_data,
1249 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
1250
1251 *data_len = dataLength;
1252 *data_len += 2; // additional 2 bytes for next record ID
1253
1254 return IPMI_CC_OK;
1255}
1256
1257ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response,
1258 ipmi_data_len_t data_len)
1259{
1260 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1261 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
1262 get_sdr::SensorDataEntityRecord record{};
1263 auto dataLength = 0;
1264
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001265 const auto& entityRecords =
1266 ipmi::sensor::EntityInfoMapContainer::getContainer()
1267 ->getIpmiEntityRecords();
Patrick Venture83a0b842019-07-19 18:37:15 -07001268 auto entity = entityRecords.begin();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001269 uint8_t entityRecordID;
1270 auto recordID = get_sdr::request::get_record_id(req);
1271
1272 entityRecordID = recordID - ENTITY_RECORD_ID_START;
Patrick Venture83a0b842019-07-19 18:37:15 -07001273 entity = entityRecords.find(entityRecordID);
1274 if (entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001275 {
1276 return IPMI_CC_SENSOR_INVALID;
1277 }
1278
1279 /* Header */
1280 get_sdr::header::set_record_id(recordID, &(record.header));
1281 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1282 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD;
1283 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1284
1285 /* Key */
1286 record.key.containerEntityId = entity->second.containerEntityId;
1287 record.key.containerEntityInstance = entity->second.containerEntityInstance;
1288 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked,
1289 &(record.key));
1290 record.key.entityId1 = entity->second.containedEntities[0].first;
1291 record.key.entityInstance1 = entity->second.containedEntities[0].second;
1292
1293 /* Body */
1294 record.body.entityId2 = entity->second.containedEntities[1].first;
1295 record.body.entityInstance2 = entity->second.containedEntities[1].second;
1296 record.body.entityId3 = entity->second.containedEntities[2].first;
1297 record.body.entityInstance3 = entity->second.containedEntities[2].second;
1298 record.body.entityId4 = entity->second.containedEntities[3].first;
1299 record.body.entityInstance4 = entity->second.containedEntities[3].second;
1300
Patrick Venture83a0b842019-07-19 18:37:15 -07001301 if (++entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001302 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001303 get_sdr::response::set_next_record_id(END_OF_RECORD,
1304 resp); // last record
Ratan Guptae0cc8552018-01-22 14:23:04 +05301305 }
1306 else
1307 {
1308 get_sdr::response::set_next_record_id(
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001309 (ENTITY_RECORD_ID_START + entity->first), resp);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301310 }
1311
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001312 // Check for invalid offset size
1313 if (req->offset > sizeof(record))
Ratan Guptae0cc8552018-01-22 14:23:04 +05301314 {
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001315 return IPMI_CC_PARM_OUT_OF_RANGE;
Ratan Guptae0cc8552018-01-22 14:23:04 +05301316 }
1317
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001318 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1319 sizeof(record) - req->offset);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301320
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001321 std::memcpy(resp->record_data,
Jason M. Bills1cd85962018-10-05 12:04:01 -07001322 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301323
1324 *data_len = dataLength;
1325 *data_len += 2; // additional 2 bytes for next record ID
1326
1327 return IPMI_CC_OK;
1328}
1329
Willy Tu11d68892022-01-20 10:37:34 -08001330ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t request,
1331 ipmi_response_t response, ipmi_data_len_t data_len,
1332 ipmi_context_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001333{
1334 ipmi_ret_t ret = IPMI_CC_OK;
Patrick Venture0b02be92018-08-31 11:55:55 -07001335 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request;
1336 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response;
Patrick Venture38426dd2019-07-30 15:22:29 -07001337
1338 // Note: we use an iterator so we can provide the next ID at the end of
1339 // the call.
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001340 auto sensor = ipmi::sensor::sensors.begin();
Patrick Venture38426dd2019-07-30 15:22:29 -07001341 auto recordID = get_sdr::request::get_record_id(req);
1342
1343 // At the beginning of a scan, the host side will send us id=0.
1344 if (recordID != 0)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001345 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001346 // recordID 0 to 255 means it is a FULL record.
1347 // recordID 256 to 511 means it is a FRU record.
1348 // recordID greater then 511 means it is a Entity Association
1349 // record. Currently we are supporting three record types: FULL
1350 // record, FRU record and Enttiy Association record.
1351 if (recordID >= ENTITY_RECORD_ID_START)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001352 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001353 return ipmi_entity_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001354 }
Patrick Venture38426dd2019-07-30 15:22:29 -07001355 else if (recordID >= FRU_RECORD_ID_START &&
1356 recordID < ENTITY_RECORD_ID_START)
Jaghathiswari Rankappagounder Natarajan0780df12019-02-06 15:29:24 -08001357 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001358 return ipmi_fru_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001359 }
1360 else
1361 {
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001362 sensor = ipmi::sensor::sensors.find(recordID);
1363 if (sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001364 {
1365 return IPMI_CC_SENSOR_INVALID;
1366 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001367 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001368 }
1369
Patrick Venture38426dd2019-07-30 15:22:29 -07001370 uint8_t sensor_id = sensor->first;
1371
Lei YU14a47812021-09-17 15:58:04 +08001372 auto it = sdrCacheMap.find(sensor_id);
1373 if (it == sdrCacheMap.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001374 {
Lei YU14a47812021-09-17 15:58:04 +08001375 /* Header */
Willy Tu11d68892022-01-20 10:37:34 -08001376 get_sdr::SensorDataFullRecord record = {};
Lei YU14a47812021-09-17 15:58:04 +08001377 get_sdr::header::set_record_id(sensor_id, &(record.header));
1378 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1
1379 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
1380 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1381
1382 /* Key */
1383 get_sdr::key::set_owner_id_bmc(&(record.key));
1384 record.key.sensor_number = sensor_id;
1385
1386 /* Body */
1387 record.body.entity_id = sensor->second.entityType;
1388 record.body.sensor_type = sensor->second.sensorType;
1389 record.body.event_reading_type = sensor->second.sensorReadingType;
1390 record.body.entity_instance = sensor->second.instance;
1391 if (ipmi::sensor::Mutability::Write ==
1392 (sensor->second.mutability & ipmi::sensor::Mutability::Write))
1393 {
1394 get_sdr::body::init_settable_state(true, &(record.body));
1395 }
1396
1397 // Set the type-specific details given the DBus interface
1398 populate_record_from_dbus(&(record.body), &(sensor->second), data_len);
1399 sdrCacheMap[sensor_id] = std::move(record);
Patrick Venture38426dd2019-07-30 15:22:29 -07001400 }
1401
Lei YU14a47812021-09-17 15:58:04 +08001402 const auto& record = sdrCacheMap[sensor_id];
Patrick Venture38426dd2019-07-30 15:22:29 -07001403
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001404 if (++sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001405 {
1406 // we have reached till end of sensor, so assign the next record id
1407 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0).
1408 auto next_record_id = (frus.size())
1409 ? frus.begin()->first + FRU_RECORD_ID_START
1410 : END_OF_RECORD;
1411
1412 get_sdr::response::set_next_record_id(next_record_id, resp);
1413 }
1414 else
1415 {
1416 get_sdr::response::set_next_record_id(sensor->first, resp);
1417 }
1418
1419 if (req->offset > sizeof(record))
1420 {
1421 return IPMI_CC_PARM_OUT_OF_RANGE;
1422 }
1423
1424 // data_len will ultimately be the size of the record, plus
1425 // the size of the next record ID:
1426 *data_len = std::min(static_cast<size_t>(req->bytes_to_read),
1427 sizeof(record) - req->offset);
1428
1429 std::memcpy(resp->record_data,
Lei YU14a47812021-09-17 15:58:04 +08001430 reinterpret_cast<const uint8_t*>(&record) + req->offset,
1431 *data_len);
Patrick Venture38426dd2019-07-30 15:22:29 -07001432
1433 // data_len should include the LSB and MSB:
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001434 *data_len += sizeof(resp->next_record_id_lsb) +
1435 sizeof(resp->next_record_id_msb);
Patrick Venture38426dd2019-07-30 15:22:29 -07001436
Emily Shafferbbef71c2017-05-08 16:36:17 -07001437 return ret;
1438}
1439
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001440static bool isFromSystemChannel()
1441{
1442 // TODO we could not figure out where the request is from based on IPMI
1443 // command handler parameters. because of it, we can not differentiate
1444 // request from SMS/SMM or IPMB channel
1445 return true;
1446}
1447
Willy Tu11d68892022-01-20 10:37:34 -08001448ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t, ipmi_cmd_t,
1449 ipmi_request_t request, ipmi_response_t,
1450 ipmi_data_len_t dataLen, ipmi_context_t)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001451{
1452 uint16_t generatorID;
1453 size_t count;
1454 bool assert = true;
1455 std::string sensorPath;
1456 size_t paraLen = *dataLen;
1457 PlatformEventRequest* req;
1458 *dataLen = 0;
1459
1460 if ((paraLen < selSystemEventSizeWith1Bytes) ||
1461 (paraLen > selSystemEventSizeWith3Bytes))
1462 {
1463 return IPMI_CC_REQ_DATA_LEN_INVALID;
1464 }
1465
1466 if (isFromSystemChannel())
1467 { // first byte for SYSTEM Interface is Generator ID
1468 // +1 to get common struct
1469 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1);
1470 // Capture the generator ID
1471 generatorID = *reinterpret_cast<uint8_t*>(request);
1472 // Platform Event usually comes from other firmware, like BIOS.
1473 // Unlike BMC sensor, it does not have BMC DBUS sensor path.
1474 sensorPath = "System";
1475 }
1476 else
1477 {
1478 req = reinterpret_cast<PlatformEventRequest*>(request);
1479 // TODO GenratorID for IPMB is combination of RqSA and RqLUN
1480 generatorID = 0xff;
1481 sensorPath = "IPMB";
1482 }
1483 // Content of event data field depends on sensor class.
1484 // When data0 bit[5:4] is non-zero, valid data counts is 3.
1485 // When data0 bit[7:6] is non-zero, valid data counts is 2.
1486 if (((req->data[0] & byte3EnableMask) != 0 &&
1487 paraLen < selSystemEventSizeWith3Bytes) ||
1488 ((req->data[0] & byte2EnableMask) != 0 &&
1489 paraLen < selSystemEventSizeWith2Bytes))
1490 {
1491 return IPMI_CC_REQ_DATA_LEN_INVALID;
1492 }
1493
1494 // Count bytes of Event Data
1495 if ((req->data[0] & byte3EnableMask) != 0)
1496 {
1497 count = 3;
1498 }
1499 else if ((req->data[0] & byte2EnableMask) != 0)
1500 {
1501 count = 2;
1502 }
1503 else
1504 {
1505 count = 1;
1506 }
1507 assert = req->eventDirectionType & directionMask ? false : true;
1508 std::vector<uint8_t> eventData(req->data, req->data + count);
1509
Patrick Williams5d82f472022-07-22 19:26:53 -05001510 sdbusplus::bus_t dbus(bus);
Patrick Williams1318a5e2024-08-16 15:19:54 -04001511 std::string service =
1512 ipmi::getService(dbus, ipmiSELAddInterface, ipmiSELPath);
Patrick Williams5d82f472022-07-22 19:26:53 -05001513 sdbusplus::message_t writeSEL = dbus.new_method_call(
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001514 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd");
1515 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert,
1516 generatorID);
1517 try
1518 {
1519 dbus.call(writeSEL);
1520 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001521 catch (const sdbusplus::exception_t& e)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001522 {
George Liu3b1071a2024-07-17 20:26:14 +08001523 lg2::error("exception message: {ERROR}", "ERROR", e);
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001524 return IPMI_CC_UNSPECIFIED_ERROR;
1525 }
1526 return IPMI_CC_OK;
1527}
1528
Chris Austenac4604a2015-10-13 12:43:27 -05001529void register_netfn_sen_functions()
1530{
Willy Tud351a722021-08-12 14:33:40 -07001531 // Handlers with dbus-sdr handler implementation.
1532 // Do not register the hander if it dynamic sensors stack is used.
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001533
Willy Tud351a722021-08-12 14:33:40 -07001534#ifndef FEATURE_DYNAMIC_SENSORS
Lei YUbe5c6b22021-09-16 15:46:20 +08001535
Lei YU962e68b2021-09-16 16:25:34 +08001536#ifdef FEATURE_SENSORS_CACHE
Lei YUbe5c6b22021-09-16 15:46:20 +08001537 // Initialize the sensor matches
1538 initSensorMatches();
Lei YU962e68b2021-09-16 16:25:34 +08001539#endif
Lei YUbe5c6b22021-09-16 15:46:20 +08001540
Tom05732372016-09-06 17:21:23 +05301541 // <Set Sensor Reading and Event Status>
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +00001542 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1543 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts,
1544 ipmi::Privilege::Operator, ipmiSetSensorReading);
Tom05732372016-09-06 17:21:23 +05301545 // <Get Sensor Reading>
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +00001546 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1547 ipmi::sensor_event::cmdGetSensorReading,
1548 ipmi::Privilege::User, ipmiSensorGetSensorReading);
Emily Shaffera344afc2017-04-13 15:09:39 -07001549
Tom Joseph5ca50952018-02-22 00:33:38 +05301550 // <Reserve Device SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001551 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1552 ipmi::sensor_event::cmdReserveDeviceSdrRepository,
1553 ipmi::Privilege::User, ipmiSensorReserveSdr);
Chris Austen10ccc0f2015-12-10 18:27:04 -06001554
Tom Joseph5ca50952018-02-22 00:33:38 +05301555 // <Get Device SDR Info>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001556 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1557 ipmi::sensor_event::cmdGetDeviceSdrInfo,
1558 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001559
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001560 // <Get Sensor Thresholds>
jayaprakash Mutyala996c9792019-05-03 15:56:48 +00001561 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1562 ipmi::sensor_event::cmdGetSensorThreshold,
1563 ipmi::Privilege::User, ipmiSensorGetSensorThresholds);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001564
Lotus Xuf93da662021-10-18 17:20:06 +08001565 // <Set Sensor Thresholds>
1566 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1567 ipmi::sensor_event::cmdSetSensorThreshold,
1568 ipmi::Privilege::User, ipmiSenSetSensorThresholds);
Vivekanand Veeracholand3d2fe22021-11-12 19:40:42 -08001569
1570 // <Get Device SDR>
1571 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr,
1572 ipmi_sen_get_sdr, PRIVILEGE_USER);
1573
Willy Tud351a722021-08-12 14:33:40 -07001574#endif
1575
1576 // Common Handers used by both implementation.
1577
1578 // <Platform Event Message>
1579 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr,
1580 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR);
1581
1582 // <Get Sensor Type>
1583 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1584 ipmi::sensor_event::cmdGetSensorType,
1585 ipmi::Privilege::User, ipmiGetSensorType);
1586
Chris Austenac4604a2015-10-13 12:43:27 -05001587 return;
1588}