blob: 7cbd2f85cdcdf18aae0be6a3d770bd8b302bada0 [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 Williamsfbc6c9d2023-05-10 07:50:16 -0500162 // 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();
Patrick Williams369824e2023-10-20 11:18:23 -0500167 }));
Lei YUbe5c6b22021-09-16 15:46:20 +0800168 sensorUpdatedMatches.emplace(
Patrick Williams5d82f472022-07-22 19:26:53 -0500169 s.first, std::make_unique<sdbusplus::bus::match_t>(
Lei YU97140502021-09-17 13:49:43 +0800170 bus,
171 type::signal() + path(s.second.sensorPath) +
172 member("PropertiesChanged"s) +
173 interface("org.freedesktop.DBus.Properties"s),
174 [&s](auto& msg) {
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500175 fillSensorIdServiceMap(s.second.sensorPath,
176 s.second.propertyInterfaces.begin()->first,
177 s.first);
178 try
179 {
180 // This is signal callback
181 std::string interfaceName;
182 msg.read(interfaceName);
183 ipmi::PropertyMap props;
184 msg.read(props);
185 s.second.getFunc(s.first, s.second, props);
186 }
187 catch (const std::exception& e)
188 {
189 sensorCacheMap[s.first].reset();
190 }
Patrick Williams369824e2023-10-20 11:18:23 -0500191 }));
Lei YUbe5c6b22021-09-16 15:46:20 +0800192 }
Jian Zhang4a105cd2022-08-05 22:26:42 +0800193 sensorsOwnerMatch = std::make_unique<sdbusplus::bus::match_t>(
194 bus, nameOwnerChanged(), [](auto& msg) {
Patrick Williams369824e2023-10-20 11:18:23 -0500195 std::string name;
196 std::string oldOwner;
197 std::string newOwner;
198 msg.read(name, oldOwner, newOwner);
Jian Zhang4a105cd2022-08-05 22:26:42 +0800199
Patrick Williams369824e2023-10-20 11:18:23 -0500200 if (!name.empty() && newOwner.empty())
201 {
202 // The service exits
203 const auto it = serviceToIdMap.find(name);
204 if (it == serviceToIdMap.end())
Jian Zhang4a105cd2022-08-05 22:26:42 +0800205 {
Patrick Williams369824e2023-10-20 11:18:23 -0500206 return;
Jian Zhang4a105cd2022-08-05 22:26:42 +0800207 }
Patrick Williams369824e2023-10-20 11:18:23 -0500208 for (const auto& id : it->second)
209 {
210 // Invalidate cache
211 sensorCacheMap[id].reset();
212 }
213 }
214 });
Lei YUbe5c6b22021-09-16 15:46:20 +0800215}
Lei YU962e68b2021-09-16 16:25:34 +0800216#endif
Lei YUbe5c6b22021-09-16 15:46:20 +0800217
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700218// Use a lookup table to find the interface name of a specific sensor
219// This will be used until an alternative is found. this is the first
220// step for mapping IPMI
Patrick Venture0b02be92018-08-31 11:55:55 -0700221int find_openbmc_path(uint8_t num, dbus_interface_t* interface)
222{
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700223 const auto& sensor_it = ipmi::sensor::sensors.find(num);
224 if (sensor_it == ipmi::sensor::sensors.end())
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700225 {
Adriana Kobylakba23ff72018-09-12 12:58:43 -0500226 // The sensor map does not contain the sensor requested
227 return -EINVAL;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700228 }
229
230 const auto& info = sensor_it->second;
231
George Liua0088712024-01-30 13:03:23 +0800232 std::string serviceName{};
233 try
234 {
235 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
236 serviceName = ipmi::getService(bus, info.sensorInterface,
237 info.sensorPath);
238 }
239 catch (const sdbusplus::exception_t&)
Patrick Venture0b02be92018-08-31 11:55:55 -0700240 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700241 std::fprintf(stderr, "Failed to get %s busname: %s\n",
George Liua0088712024-01-30 13:03:23 +0800242 info.sensorPath.c_str(), serviceName.c_str());
243 return -EINVAL;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700244 }
245
246 interface->sensortype = info.sensorType;
George Liua0088712024-01-30 13:03:23 +0800247 strcpy(interface->bus, serviceName.c_str());
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700248 strcpy(interface->path, info.sensorPath.c_str());
249 // Take the interface name from the beginning of the DbusInterfaceMap. This
250 // works for the Value interface but may not suffice for more complex
251 // sensors.
252 // tracked https://github.com/openbmc/phosphor-host-ipmid/issues/103
Patrick Venture0b02be92018-08-31 11:55:55 -0700253 strcpy(interface->interface,
254 info.propertyInterfaces.begin()->first.c_str());
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700255 interface->sensornumber = num;
256
George Liua0088712024-01-30 13:03:23 +0800257 return 0;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700258}
259
Tomd700e762016-09-20 18:24:13 +0530260/////////////////////////////////////////////////////////////////////
261//
262// Routines used by ipmi commands wanting to interact on the dbus
263//
264/////////////////////////////////////////////////////////////////////
Patrick Venture0b02be92018-08-31 11:55:55 -0700265int set_sensor_dbus_state_s(uint8_t number, const char* method,
266 const char* value)
267{
Tomd700e762016-09-20 18:24:13 +0530268 dbus_interface_t a;
269 int r;
270 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700271 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530272
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700273 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530274
Patrick Venture0b02be92018-08-31 11:55:55 -0700275 if (r < 0)
276 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700277 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530278 return 0;
279 }
280
Patrick Venture0b02be92018-08-31 11:55:55 -0700281 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
282 method);
283 if (r < 0)
284 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700285 std::fprintf(stderr, "Failed to create a method call: %s",
286 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530287 goto final;
288 }
289
290 r = sd_bus_message_append(m, "v", "s", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700291 if (r < 0)
292 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700293 std::fprintf(stderr, "Failed to create a input parameter: %s",
294 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530295 goto final;
296 }
297
Tomd700e762016-09-20 18:24:13 +0530298 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700299 if (r < 0)
300 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700301 std::fprintf(stderr, "Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530302 }
303
304final:
305 sd_bus_error_free(&error);
306 m = sd_bus_message_unref(m);
307
308 return 0;
309}
Patrick Venture0b02be92018-08-31 11:55:55 -0700310int set_sensor_dbus_state_y(uint8_t number, const char* method,
311 const uint8_t value)
312{
Tomd700e762016-09-20 18:24:13 +0530313 dbus_interface_t a;
314 int r;
315 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700316 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530317
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700318 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530319
Patrick Venture0b02be92018-08-31 11:55:55 -0700320 if (r < 0)
321 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700322 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530323 return 0;
324 }
325
Patrick Venture0b02be92018-08-31 11:55:55 -0700326 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
327 method);
328 if (r < 0)
329 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700330 std::fprintf(stderr, "Failed to create a method call: %s",
331 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530332 goto final;
333 }
334
335 r = sd_bus_message_append(m, "v", "i", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700336 if (r < 0)
337 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700338 std::fprintf(stderr, "Failed to create a input parameter: %s",
339 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530340 goto final;
341 }
342
Tomd700e762016-09-20 18:24:13 +0530343 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700344 if (r < 0)
345 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700346 std::fprintf(stderr, "12 Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530347 }
348
349final:
350 sd_bus_error_free(&error);
351 m = sd_bus_message_unref(m);
352
353 return 0;
354}
355
Patrick Venture0b02be92018-08-31 11:55:55 -0700356uint8_t dbus_to_sensor_type(char* p)
357{
Patrick Venture0b02be92018-08-31 11:55:55 -0700358 sensorTypemap_t* s = g_SensorTypeMap;
359 char r = 0;
360 while (s->number != 0xFF)
361 {
362 if (!strcmp(s->dbusname, p))
363 {
Tom Joseph558184e2017-09-01 13:45:05 +0530364 r = s->typecode;
Patrick Venture0b02be92018-08-31 11:55:55 -0700365 break;
Chris Austenac4604a2015-10-13 12:43:27 -0500366 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500367 s++;
Chris Austenac4604a2015-10-13 12:43:27 -0500368 }
369
Chris Austen0012e9b2015-10-22 01:37:46 -0500370 if (s->number == 0xFF)
371 printf("Failed to find Sensor Type %s\n", p);
Chris Austenac4604a2015-10-13 12:43:27 -0500372
Chris Austen0012e9b2015-10-22 01:37:46 -0500373 return r;
Chris Austenac4604a2015-10-13 12:43:27 -0500374}
375
Patrick Venture0b02be92018-08-31 11:55:55 -0700376uint8_t get_type_from_interface(dbus_interface_t dbus_if)
377{
Brad Bishop56003452016-10-05 21:49:19 -0400378 uint8_t type;
Chris Austen0012e9b2015-10-22 01:37:46 -0500379
Chris Austen0012e9b2015-10-22 01:37:46 -0500380 // This is where sensors that do not exist in dbus but do
381 // exist in the host code stop. This should indicate it
382 // is not a supported sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700383 if (dbus_if.interface[0] == 0)
384 {
385 return 0;
386 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500387
Emily Shaffer71174412017-04-05 15:10:40 -0700388 // Fetch type from interface itself.
389 if (dbus_if.sensortype != 0)
390 {
391 type = dbus_if.sensortype;
Patrick Venture0b02be92018-08-31 11:55:55 -0700392 }
393 else
394 {
Chris Austen0012e9b2015-10-22 01:37:46 -0500395 // Non InventoryItems
Patrick Venture4491a462018-10-13 13:00:42 -0700396 char* p = strrchr(dbus_if.path, '/');
Patrick Venture0b02be92018-08-31 11:55:55 -0700397 type = dbus_to_sensor_type(p + 1);
Chris Austen0012e9b2015-10-22 01:37:46 -0500398 }
399
Brad Bishop56003452016-10-05 21:49:19 -0400400 return type;
Patrick Venture0b02be92018-08-31 11:55:55 -0700401}
Chris Austen0012e9b2015-10-22 01:37:46 -0500402
Emily Shaffer391f3302017-04-03 10:27:08 -0700403// Replaces find_sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700404uint8_t find_type_for_sensor_number(uint8_t num)
405{
Emily Shaffer391f3302017-04-03 10:27:08 -0700406 int r;
407 dbus_interface_t dbus_if;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700408 r = find_openbmc_path(num, &dbus_if);
Patrick Venture0b02be92018-08-31 11:55:55 -0700409 if (r < 0)
410 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700411 std::fprintf(stderr, "Could not find sensor %d\n", num);
Lei YU91875f72018-04-03 15:14:49 +0800412 return 0;
Emily Shaffer391f3302017-04-03 10:27:08 -0700413 }
414 return get_type_from_interface(dbus_if);
415}
416
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000417/**
418 * @brief implements the get sensor type command.
419 * @param - sensorNumber
420 *
421 * @return IPMI completion code plus response data on success.
422 * - sensorType
423 * - eventType
424 **/
425
426ipmi::RspType<uint8_t, // sensorType
427 uint8_t // eventType
428 >
429 ipmiGetSensorType(uint8_t sensorNumber)
Chris Austenac4604a2015-10-13 12:43:27 -0500430{
Wang Xiaohua64b76212022-08-11 13:23:53 +0800431 const auto it = ipmi::sensor::sensors.find(sensorNumber);
432 if (it == ipmi::sensor::sensors.end())
Patrick Venture0b02be92018-08-31 11:55:55 -0700433 {
Wang Xiaohua64b76212022-08-11 13:23:53 +0800434 // The sensor map does not contain the sensor requested
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000435 return ipmi::responseSensorInvalid();
Chris Austen0012e9b2015-10-22 01:37:46 -0500436 }
437
Wang Xiaohua64b76212022-08-11 13:23:53 +0800438 const auto& info = it->second;
439 uint8_t sensorType = info.sensorType;
440 uint8_t eventType = info.sensorReadingType;
441
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000442 return ipmi::responseSuccess(sensorType, eventType);
Chris Austenac4604a2015-10-13 12:43:27 -0500443}
444
Patrick Venture0b02be92018-08-31 11:55:55 -0700445const std::set<std::string> analogSensorInterfaces = {
Emily Shaffercc941e12017-06-14 13:06:26 -0700446 "xyz.openbmc_project.Sensor.Value",
Patrick Venturee9a64052017-08-18 19:17:27 -0700447 "xyz.openbmc_project.Control.FanPwm",
Emily Shaffercc941e12017-06-14 13:06:26 -0700448};
449
450bool isAnalogSensor(const std::string& interface)
451{
452 return (analogSensorInterfaces.count(interface));
453}
454
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000455/**
456@brief This command is used to set sensorReading.
457
458@param
459 - sensorNumber
460 - operation
461 - reading
462 - assertOffset0_7
463 - assertOffset8_14
464 - deassertOffset0_7
465 - deassertOffset8_14
466 - eventData1
467 - eventData2
468 - eventData3
469
470@return completion code on success.
471**/
472
473ipmi::RspType<> ipmiSetSensorReading(uint8_t sensorNumber, uint8_t operation,
474 uint8_t reading, uint8_t assertOffset0_7,
475 uint8_t assertOffset8_14,
476 uint8_t deassertOffset0_7,
477 uint8_t deassertOffset8_14,
478 uint8_t eventData1, uint8_t eventData2,
479 uint8_t eventData3)
Tom Josephbe703f72017-03-09 12:34:35 +0530480{
George Liu3b1071a2024-07-17 20:26:14 +0800481 lg2::debug("IPMI SET_SENSOR, sensorNumber: {SENSOR_NUM}", "SENSOR_NUM",
482 lg2::hex, sensorNumber);
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000483
Arun P. Mohanan0634e982021-08-30 15:21:33 +0530484 if (sensorNumber == 0xFF)
485 {
486 return ipmi::responseInvalidFieldRequest();
487 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000488 ipmi::sensor::SetSensorReadingReq cmdData;
489
490 cmdData.number = sensorNumber;
491 cmdData.operation = operation;
492 cmdData.reading = reading;
493 cmdData.assertOffset0_7 = assertOffset0_7;
494 cmdData.assertOffset8_14 = assertOffset8_14;
495 cmdData.deassertOffset0_7 = deassertOffset0_7;
496 cmdData.deassertOffset8_14 = deassertOffset8_14;
497 cmdData.eventData1 = eventData1;
498 cmdData.eventData2 = eventData2;
499 cmdData.eventData3 = eventData3;
Tom Josephbe703f72017-03-09 12:34:35 +0530500
501 // Check if the Sensor Number is present
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700502 const auto iter = ipmi::sensor::sensors.find(sensorNumber);
503 if (iter == ipmi::sensor::sensors.end())
Tom Josephbe703f72017-03-09 12:34:35 +0530504 {
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000505 updateSensorRecordFromSSRAESC(&sensorNumber);
506 return ipmi::responseSuccess();
Tom Josephbe703f72017-03-09 12:34:35 +0530507 }
508
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500509 try
510 {
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500511 if (ipmi::sensor::Mutability::Write !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700512 (iter->second.mutability & ipmi::sensor::Mutability::Write))
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500513 {
George Liu3b1071a2024-07-17 20:26:14 +0800514 lg2::error("Sensor Set operation is not allowed, "
515 "sensorNumber: {SENSOR_NUM}",
516 "SENSOR_NUM", lg2::hex, sensorNumber);
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000517 return ipmi::responseIllegalCommand();
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500518 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000519 auto ipmiRC = iter->second.updateFunc(cmdData, iter->second);
520 return ipmi::response(ipmiRC);
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500521 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500522 catch (const InternalFailure& e)
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500523 {
George Liu3b1071a2024-07-17 20:26:14 +0800524 lg2::error("Set sensor failed, sensorNumber: {SENSOR_NUM}",
525 "SENSOR_NUM", lg2::hex, sensorNumber);
Patrick Venture0b02be92018-08-31 11:55:55 -0700526 commit<InternalFailure>();
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000527 return ipmi::responseUnspecifiedError();
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500528 }
Tom Joseph82024322017-09-28 20:07:29 +0530529 catch (const std::runtime_error& e)
530 {
George Liu3b1071a2024-07-17 20:26:14 +0800531 lg2::error("runtime error: {ERROR}", "ERROR", e);
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000532 return ipmi::responseUnspecifiedError();
Tom Joseph82024322017-09-28 20:07:29 +0530533 }
Chris Austenac4604a2015-10-13 12:43:27 -0500534}
535
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000536/** @brief implements the get sensor reading command
537 * @param sensorNum - sensor number
538 *
539 * @returns IPMI completion code plus response data
540 * - senReading - sensor reading
541 * - reserved
542 * - readState - sensor reading state enabled
543 * - senScanState - sensor scan state disabled
544 * - allEventMessageState - all Event message state disabled
545 * - assertionStatesLsb - threshold levels states
546 * - assertionStatesMsb - discrete reading sensor states
547 */
548ipmi::RspType<uint8_t, // sensor reading
Tom Joseph3ee668f2018-03-02 19:49:17 +0530549
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000550 uint5_t, // reserved
551 bool, // reading state
Sui Chen4cc42552019-09-11 10:28:35 -0700552 bool, // 0 = sensor scanning state disabled
553 bool, // 0 = all event messages disabled
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000554
555 uint8_t, // threshold levels states
556 uint8_t // discrete reading sensor states
557 >
Willy Tu11d68892022-01-20 10:37:34 -0800558 ipmiSensorGetSensorReading([[maybe_unused]] ipmi::Context::ptr& ctx,
559 uint8_t sensorNum)
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000560{
561 if (sensorNum == 0xFF)
562 {
563 return ipmi::responseInvalidFieldRequest();
564 }
565
566 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700567 if (iter == ipmi::sensor::sensors.end())
Tom Joseph3ee668f2018-03-02 19:49:17 +0530568 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000569 return ipmi::responseSensorInvalid();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530570 }
571 if (ipmi::sensor::Mutability::Read !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700572 (iter->second.mutability & ipmi::sensor::Mutability::Read))
Tom Joseph3ee668f2018-03-02 19:49:17 +0530573 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000574 return ipmi::responseIllegalCommand();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530575 }
576
577 try
578 {
Lei YU8c2c0482021-09-16 17:28:28 +0800579#ifdef FEATURE_SENSORS_CACHE
Lei YU8e8152c2021-12-06 20:11:08 +0800580 auto& sensorData = sensorCacheMap[sensorNum];
Lei YU97140502021-09-17 13:49:43 +0800581 if (!sensorData.has_value())
582 {
Lei YUa55e9ea2021-09-18 15:15:17 +0800583 // No cached value, try read it
Lei YU8e8152c2021-12-06 20:11:08 +0800584 std::string service;
585 boost::system::error_code ec;
Lei YUa55e9ea2021-09-18 15:15:17 +0800586 const auto& sensorInfo = iter->second;
Lei YU8e8152c2021-12-06 20:11:08 +0800587 ec = ipmi::getService(ctx, sensorInfo.sensorInterface,
588 sensorInfo.sensorPath, service);
589 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800590 {
Lei YU8e8152c2021-12-06 20:11:08 +0800591 return ipmi::responseUnspecifiedError();
Lei YUa55e9ea2021-09-18 15:15:17 +0800592 }
Lei YU7f3a70f2021-12-07 16:40:40 +0800593 fillSensorIdServiceMap(sensorInfo.sensorPath,
594 sensorInfo.propertyInterfaces.begin()->first,
595 iter->first, service);
Lei YU8e8152c2021-12-06 20:11:08 +0800596
597 ipmi::PropertyMap props;
598 ec = ipmi::getAllDbusProperties(
599 ctx, service, sensorInfo.sensorPath,
600 sensorInfo.propertyInterfaces.begin()->first, props);
601 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800602 {
Lei YU8e8152c2021-12-06 20:11:08 +0800603 fprintf(stderr, "Failed to get sensor %s, %d: %s\n",
604 sensorInfo.sensorPath.c_str(), ec.value(),
605 ec.message().c_str());
Lei YUa55e9ea2021-09-18 15:15:17 +0800606 // Intitilizing with default values
607 constexpr uint8_t senReading = 0;
608 constexpr uint5_t reserved{0};
609 constexpr bool readState = true;
610 constexpr bool senScanState = false;
611 constexpr bool allEventMessageState = false;
612 constexpr uint8_t assertionStatesLsb = 0;
613 constexpr uint8_t assertionStatesMsb = 0;
Lei YU97140502021-09-17 13:49:43 +0800614
Lei YUa55e9ea2021-09-18 15:15:17 +0800615 return ipmi::responseSuccess(senReading, reserved, readState,
616 senScanState, allEventMessageState,
617 assertionStatesLsb,
618 assertionStatesMsb);
619 }
Lei YU8e8152c2021-12-06 20:11:08 +0800620 sensorInfo.getFunc(sensorNum, sensorInfo, props);
Lei YU97140502021-09-17 13:49:43 +0800621 }
622 return ipmi::responseSuccess(
623 sensorData->response.reading, uint5_t(0),
624 sensorData->response.readingOrStateUnavailable,
625 sensorData->response.scanningEnabled,
626 sensorData->response.allEventMessagesEnabled,
627 sensorData->response.thresholdLevelsStates,
628 sensorData->response.discreteReadingSensorStates);
629
Lei YU8c2c0482021-09-16 17:28:28 +0800630#else
Sui Chen4cc42552019-09-11 10:28:35 -0700631 ipmi::sensor::GetSensorResponse getResponse =
632 iter->second.getFunc(iter->second);
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000633
Sui Chen4cc42552019-09-11 10:28:35 -0700634 return ipmi::responseSuccess(getResponse.reading, uint5_t(0),
635 getResponse.readingOrStateUnavailable,
636 getResponse.scanningEnabled,
637 getResponse.allEventMessagesEnabled,
638 getResponse.thresholdLevelsStates,
639 getResponse.discreteReadingSensorStates);
Lei YU8c2c0482021-09-16 17:28:28 +0800640#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530641 }
Brandon Kim9cf85622019-06-19 12:05:08 -0700642#ifdef UPDATE_FUNCTIONAL_ON_FAIL
643 catch (const SensorFunctionalError& e)
644 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000645 return ipmi::responseResponseError();
Brandon Kim9cf85622019-06-19 12:05:08 -0700646 }
647#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530648 catch (const std::exception& e)
649 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000650 // Intitilizing with default values
651 constexpr uint8_t senReading = 0;
652 constexpr uint5_t reserved{0};
653 constexpr bool readState = true;
654 constexpr bool senScanState = false;
655 constexpr bool allEventMessageState = false;
656 constexpr uint8_t assertionStatesLsb = 0;
657 constexpr uint8_t assertionStatesMsb = 0;
658
659 return ipmi::responseSuccess(senReading, reserved, readState,
660 senScanState, allEventMessageState,
661 assertionStatesLsb, assertionStatesMsb);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530662 }
663}
664
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300665get_sdr::GetSensorThresholdsResponse
666 getSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600667{
William A. Kennington III515bc372020-10-27 16:32:32 -0700668 get_sdr::GetSensorThresholdsResponse resp{};
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530669 constexpr auto warningThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600670 "xyz.openbmc_project.Sensor.Threshold.Warning";
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530671 constexpr auto criticalThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600672 "xyz.openbmc_project.Sensor.Threshold.Critical";
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600673
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700674 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530675 const auto info = iter->second;
676
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300677 std::string service;
678 boost::system::error_code ec;
679 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
680 if (ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530681 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300682 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530683 }
684
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300685 ipmi::PropertyMap warnThresholds;
686 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
687 warningThreshIntf, warnThresholds);
Willy Tu9154caa2021-12-02 02:28:54 -0800688 int32_t minClamp;
689 int32_t maxClamp;
690 int32_t rawData;
691 constexpr uint8_t sensorUnitsSignedBits = 2 << 6;
692 constexpr uint8_t signedDataFormat = 0x80;
693 if ((info.sensorUnits1 & sensorUnitsSignedBits) == signedDataFormat)
694 {
695 minClamp = std::numeric_limits<int8_t>::lowest();
696 maxClamp = std::numeric_limits<int8_t>::max();
697 }
698 else
699 {
700 minClamp = std::numeric_limits<uint8_t>::lowest();
701 maxClamp = std::numeric_limits<uint8_t>::max();
702 }
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300703 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530704 {
Hieu Huynh92079a22022-10-07 08:24:59 +0000705 double warnLow = ipmi::mappedVariant<double>(
706 warnThresholds, "WarningLow",
707 std::numeric_limits<double>::quiet_NaN());
708 double warnHigh = ipmi::mappedVariant<double>(
709 warnThresholds, "WarningHigh",
710 std::numeric_limits<double>::quiet_NaN());
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300711
712 if (std::isfinite(warnLow))
713 {
714 warnLow *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800715 rawData = round((warnLow - info.scaledOffset) / info.coefficientM);
716 resp.lowerNonCritical =
717 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300718 resp.validMask |= static_cast<uint8_t>(
719 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK);
720 }
721
722 if (std::isfinite(warnHigh))
723 {
724 warnHigh *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800725 rawData = round((warnHigh - info.scaledOffset) / info.coefficientM);
726 resp.upperNonCritical =
727 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300728 resp.validMask |= static_cast<uint8_t>(
729 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK);
730 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530731 }
732
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300733 ipmi::PropertyMap critThresholds;
734 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
735 criticalThreshIntf, critThresholds);
736 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530737 {
Hieu Huynh92079a22022-10-07 08:24:59 +0000738 double critLow = ipmi::mappedVariant<double>(
739 critThresholds, "CriticalLow",
740 std::numeric_limits<double>::quiet_NaN());
741 double critHigh = ipmi::mappedVariant<double>(
742 critThresholds, "CriticalHigh",
743 std::numeric_limits<double>::quiet_NaN());
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530744
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300745 if (std::isfinite(critLow))
746 {
747 critLow *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800748 rawData = round((critLow - info.scaledOffset) / info.coefficientM);
749 resp.lowerCritical =
750 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300751 resp.validMask |= static_cast<uint8_t>(
752 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK);
753 }
754
755 if (std::isfinite(critHigh))
756 {
757 critHigh *= std::pow(10, info.scale - info.exponentR);
Willy Tu9154caa2021-12-02 02:28:54 -0800758 rawData = round((critHigh - info.scaledOffset) / info.coefficientM);
759 resp.upperCritical =
760 static_cast<uint8_t>(std::clamp(rawData, minClamp, maxClamp));
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300761 resp.validMask |= static_cast<uint8_t>(
762 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK);
763 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530764 }
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000765
766 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530767}
768
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000769/** @brief implements the get sensor thresholds command
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300770 * @param ctx - IPMI context pointer
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000771 * @param sensorNum - sensor number
772 *
773 * @returns IPMI completion code plus response data
774 * - validMask - threshold mask
775 * - lower non-critical threshold - IPMI messaging state
776 * - lower critical threshold - link authentication state
777 * - lower non-recoverable threshold - callback state
778 * - upper non-critical threshold
779 * - upper critical
780 * - upper non-recoverable
781 */
782ipmi::RspType<uint8_t, // validMask
783 uint8_t, // lowerNonCritical
784 uint8_t, // lowerCritical
785 uint8_t, // lowerNonRecoverable
786 uint8_t, // upperNonCritical
787 uint8_t, // upperCritical
788 uint8_t // upperNonRecoverable
789 >
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300790 ipmiSensorGetSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530791{
792 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
793
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700794 const auto iter = ipmi::sensor::sensors.find(sensorNum);
795 if (iter == ipmi::sensor::sensors.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600796 {
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000797 return ipmi::responseSensorInvalid();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600798 }
799
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530800 const auto info = iter->second;
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600801
Patrick Venture0b02be92018-08-31 11:55:55 -0700802 // Proceed only if the sensor value interface is implemented.
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530803 if (info.propertyInterfaces.find(valueInterface) ==
804 info.propertyInterfaces.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600805 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700806 // return with valid mask as 0
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000807 return ipmi::responseSuccess();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600808 }
809
Lei YU14a47812021-09-17 15:58:04 +0800810 auto it = sensorThresholdMap.find(sensorNum);
811 if (it == sensorThresholdMap.end())
812 {
813 sensorThresholdMap[sensorNum] = getSensorThresholds(ctx, sensorNum);
814 }
815
816 const auto& resp = sensorThresholdMap[sensorNum];
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600817
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000818 return ipmi::responseSuccess(resp.validMask, resp.lowerNonCritical,
819 resp.lowerCritical, resp.lowerNonRecoverable,
820 resp.upperNonCritical, resp.upperCritical,
821 resp.upperNonRecoverable);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600822}
823
Lotus Xuf93da662021-10-18 17:20:06 +0800824/** @brief implements the Set Sensor threshold command
825 * @param sensorNumber - sensor number
826 * @param lowerNonCriticalThreshMask
827 * @param lowerCriticalThreshMask
828 * @param lowerNonRecovThreshMask
829 * @param upperNonCriticalThreshMask
830 * @param upperCriticalThreshMask
831 * @param upperNonRecovThreshMask
832 * @param reserved
833 * @param lowerNonCritical - lower non-critical threshold
834 * @param lowerCritical - Lower critical threshold
835 * @param lowerNonRecoverable - Lower non recovarable threshold
836 * @param upperNonCritical - Upper non-critical threshold
837 * @param upperCritical - Upper critical
838 * @param upperNonRecoverable - Upper Non-recoverable
839 *
840 * @returns IPMI completion code
841 */
842ipmi::RspType<> ipmiSenSetSensorThresholds(
843 ipmi::Context::ptr& ctx, uint8_t sensorNum, bool lowerNonCriticalThreshMask,
844 bool lowerCriticalThreshMask, bool lowerNonRecovThreshMask,
845 bool upperNonCriticalThreshMask, bool upperCriticalThreshMask,
846 bool upperNonRecovThreshMask, uint2_t reserved, uint8_t lowerNonCritical,
Willy Tu11d68892022-01-20 10:37:34 -0800847 uint8_t lowerCritical, uint8_t, uint8_t upperNonCritical,
848 uint8_t upperCritical, uint8_t)
Lotus Xuf93da662021-10-18 17:20:06 +0800849{
850 if (reserved)
851 {
852 return ipmi::responseInvalidFieldRequest();
853 }
854
855 // lower nc and upper nc not suppported on any sensor
856 if (lowerNonRecovThreshMask || upperNonRecovThreshMask)
857 {
858 return ipmi::responseInvalidFieldRequest();
859 }
860
861 // if none of the threshold mask are set, nothing to do
862 if (!(lowerNonCriticalThreshMask | lowerCriticalThreshMask |
863 lowerNonRecovThreshMask | upperNonCriticalThreshMask |
864 upperCriticalThreshMask | upperNonRecovThreshMask))
865 {
866 return ipmi::responseSuccess();
867 }
868
869 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
870
871 const auto iter = ipmi::sensor::sensors.find(sensorNum);
872 if (iter == ipmi::sensor::sensors.end())
873 {
874 return ipmi::responseSensorInvalid();
875 }
876
877 const auto& info = iter->second;
878
879 // Proceed only if the sensor value interface is implemented.
880 if (info.propertyInterfaces.find(valueInterface) ==
881 info.propertyInterfaces.end())
882 {
883 // return with valid mask as 0
884 return ipmi::responseSuccess();
885 }
886
887 constexpr auto warningThreshIntf =
888 "xyz.openbmc_project.Sensor.Threshold.Warning";
889 constexpr auto criticalThreshIntf =
890 "xyz.openbmc_project.Sensor.Threshold.Critical";
891
892 std::string service;
893 boost::system::error_code ec;
894 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
895 if (ec)
896 {
897 return ipmi::responseResponseError();
898 }
899 // store a vector of property name, value to set, and interface
900 std::vector<std::tuple<std::string, uint8_t, std::string>> thresholdsToSet;
901
902 // define the indexes of the tuple
903 constexpr uint8_t propertyName = 0;
904 constexpr uint8_t thresholdValue = 1;
905 constexpr uint8_t interface = 2;
906 // verifiy all needed fields are present
907 if (lowerCriticalThreshMask || upperCriticalThreshMask)
908 {
Lotus Xuf93da662021-10-18 17:20:06 +0800909 ipmi::PropertyMap findThreshold;
910 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
911 criticalThreshIntf, findThreshold);
912
913 if (!ec)
914 {
915 if (lowerCriticalThreshMask)
916 {
917 auto findLower = findThreshold.find("CriticalLow");
918 if (findLower == findThreshold.end())
919 {
920 return ipmi::responseInvalidFieldRequest();
921 }
922 thresholdsToSet.emplace_back("CriticalLow", lowerCritical,
923 criticalThreshIntf);
924 }
925 if (upperCriticalThreshMask)
926 {
927 auto findUpper = findThreshold.find("CriticalHigh");
928 if (findUpper == findThreshold.end())
929 {
930 return ipmi::responseInvalidFieldRequest();
931 }
932 thresholdsToSet.emplace_back("CriticalHigh", upperCritical,
933 criticalThreshIntf);
934 }
935 }
936 }
937 if (lowerNonCriticalThreshMask || upperNonCriticalThreshMask)
938 {
939 ipmi::PropertyMap findThreshold;
940 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
941 warningThreshIntf, findThreshold);
942
943 if (!ec)
944 {
945 if (lowerNonCriticalThreshMask)
946 {
947 auto findLower = findThreshold.find("WarningLow");
948 if (findLower == findThreshold.end())
949 {
950 return ipmi::responseInvalidFieldRequest();
951 }
952 thresholdsToSet.emplace_back("WarningLow", lowerNonCritical,
953 warningThreshIntf);
954 }
955 if (upperNonCriticalThreshMask)
956 {
957 auto findUpper = findThreshold.find("WarningHigh");
958 if (findUpper == findThreshold.end())
959 {
960 return ipmi::responseInvalidFieldRequest();
961 }
962 thresholdsToSet.emplace_back("WarningHigh", upperNonCritical,
963 warningThreshIntf);
964 }
965 }
966 }
967 for (const auto& property : thresholdsToSet)
968 {
969 // from section 36.3 in the IPMI Spec, assume all linear
970 double valueToSet =
971 ((info.coefficientM * std::get<thresholdValue>(property)) +
972 (info.scaledOffset * std::pow(10.0, info.scale))) *
973 std::pow(10.0, info.exponentR);
974 ipmi::setDbusProperty(
975 ctx, service, info.sensorPath, std::get<interface>(property),
976 std::get<propertyName>(property), ipmi::Value(valueToSet));
977 }
978
Lei YU14a47812021-09-17 15:58:04 +0800979 // Invalidate the cache
980 sensorThresholdMap.erase(sensorNum);
Lotus Xuf93da662021-10-18 17:20:06 +0800981 return ipmi::responseSuccess();
982}
983
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000984/** @brief implements the get SDR Info command
985 * @param count - Operation
986 *
987 * @returns IPMI completion code plus response data
988 * - sdrCount - sensor/SDR count
989 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag
990 */
991ipmi::RspType<uint8_t, // respcount
992 uint8_t // dynamic population flags
993 >
994 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700995{
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000996 uint8_t sdrCount;
997 // multiple LUNs not supported.
998 constexpr uint8_t lunsAndDynamicPopulation = 1;
999 constexpr uint8_t getSdrCount = 0x01;
1000 constexpr uint8_t getSensorCount = 0x00;
1001
1002 if (count.value_or(0) == getSdrCount)
Emily Shafferd06e0e72017-04-05 09:08:57 -07001003 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001004 // Get SDR count. This returns the total number of SDRs in the device.
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001005 const auto& entityRecords =
1006 ipmi::sensor::EntityInfoMapContainer::getContainer()
1007 ->getIpmiEntityRecords();
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001008 sdrCount = ipmi::sensor::sensors.size() + frus.size() +
1009 entityRecords.size();
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001010 }
1011 else if (count.value_or(0) == getSensorCount)
1012 {
1013 // Get Sensor count. This returns the number of sensors
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001014 sdrCount = ipmi::sensor::sensors.size();
Emily Shafferd06e0e72017-04-05 09:08:57 -07001015 }
1016 else
1017 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001018 return ipmi::responseInvalidCommandOnLun();
Emily Shafferd06e0e72017-04-05 09:08:57 -07001019 }
1020
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001021 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation);
Emily Shafferd06e0e72017-04-05 09:08:57 -07001022}
1023
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001024/** @brief implements the reserve SDR command
1025 * @returns IPMI completion code plus response data
1026 * - reservationID - reservation ID
1027 */
1028ipmi::RspType<uint16_t> ipmiSensorReserveSdr()
Emily Shaffera344afc2017-04-13 15:09:39 -07001029{
1030 // A constant reservation ID is okay until we implement add/remove SDR.
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001031 constexpr uint16_t reservationID = 1;
Emily Shaffera344afc2017-04-13 15:09:39 -07001032
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001033 return ipmi::responseSuccess(reservationID);
Emily Shaffera344afc2017-04-13 15:09:39 -07001034}
Chris Austenac4604a2015-10-13 12:43:27 -05001035
Patrick Venture0b02be92018-08-31 11:55:55 -07001036void setUnitFieldsForObject(const ipmi::sensor::Info* info,
1037 get_sdr::SensorDataFullRecordBody* body)
Emily Shaffercc941e12017-06-14 13:06:26 -07001038{
Willy Tu523e2d12023-09-05 11:36:48 -07001039 namespace server = sdbusplus::server::xyz::openbmc_project::sensor;
Tom Josephdc212b22018-02-16 09:59:57 +05301040 try
Emily Shaffercc941e12017-06-14 13:06:26 -07001041 {
Tom Josephdc212b22018-02-16 09:59:57 +05301042 auto unit = server::Value::convertUnitFromString(info->unit);
1043 // Unit strings defined in
1044 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml
1045 switch (unit)
Emily Shaffercc941e12017-06-14 13:06:26 -07001046 {
Tom Josephdc212b22018-02-16 09:59:57 +05301047 case server::Value::Unit::DegreesC:
1048 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C;
1049 break;
1050 case server::Value::Unit::RPMS:
Kirill Pakhomov812e44c2018-10-22 16:25:35 +03001051 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM;
Tom Josephdc212b22018-02-16 09:59:57 +05301052 break;
1053 case server::Value::Unit::Volts:
1054 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS;
1055 break;
1056 case server::Value::Unit::Meters:
1057 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS;
1058 break;
1059 case server::Value::Unit::Amperes:
1060 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES;
1061 break;
1062 case server::Value::Unit::Joules:
1063 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES;
1064 break;
1065 case server::Value::Unit::Watts:
1066 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS;
1067 break;
1068 default:
1069 // Cannot be hit.
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001070 std::fprintf(stderr, "Unknown value unit type: = %s\n",
1071 info->unit.c_str());
Emily Shaffercc941e12017-06-14 13:06:26 -07001072 }
1073 }
Patrick Venture64678b82018-10-13 13:11:32 -07001074 catch (const sdbusplus::exception::InvalidEnumString& e)
Emily Shaffercc941e12017-06-14 13:06:26 -07001075 {
George Liu3b1071a2024-07-17 20:26:14 +08001076 lg2::warning("Warning: no unit provided for sensor!");
Emily Shaffercc941e12017-06-14 13:06:26 -07001077 }
Emily Shaffercc941e12017-06-14 13:06:26 -07001078}
1079
Patrick Venture0b02be92018-08-31 11:55:55 -07001080ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body,
1081 const ipmi::sensor::Info* info,
Willy Tu11d68892022-01-20 10:37:34 -08001082 ipmi_data_len_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001083{
1084 /* Functional sensor case */
Emily Shaffercc941e12017-06-14 13:06:26 -07001085 if (isAnalogSensor(info->propertyInterfaces.begin()->first))
Emily Shafferbbef71c2017-05-08 16:36:17 -07001086 {
Tony Leec5324252019-10-31 17:24:16 +08001087 body->sensor_units_1 = info->sensorUnits1; // default is 0. unsigned, no
1088 // rate, no modifier, not a %
Emily Shafferbbef71c2017-05-08 16:36:17 -07001089 /* Unit info */
Tom Josephdc212b22018-02-16 09:59:57 +05301090 setUnitFieldsForObject(info, body);
Emily Shaffer10f49592017-05-10 12:01:10 -07001091
1092 get_sdr::body::set_b(info->coefficientB, body);
1093 get_sdr::body::set_m(info->coefficientM, body);
1094 get_sdr::body::set_b_exp(info->exponentB, body);
Tom Josephdc212b22018-02-16 09:59:57 +05301095 get_sdr::body::set_r_exp(info->exponentR, body);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001096 }
1097
Tom Joseph96423912018-01-25 00:14:34 +05301098 /* ID string */
Jeremy Kerrbe4ffa82020-08-10 16:17:37 +08001099 auto id_string = info->sensorName;
1100
1101 if (id_string.empty())
1102 {
1103 id_string = info->sensorNameFunc(*info);
1104 }
Tom Joseph96423912018-01-25 00:14:34 +05301105
1106 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH)
1107 {
1108 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body);
1109 }
1110 else
1111 {
1112 get_sdr::body::set_id_strlen(id_string.length(), body);
1113 }
Paul Fertser51136982022-08-18 12:36:41 +00001114 get_sdr::body::set_id_type(3, body); // "8-bit ASCII + Latin 1"
Tom Joseph96423912018-01-25 00:14:34 +05301115 strncpy(body->id_string, id_string.c_str(),
1116 get_sdr::body::get_id_strlen(body));
1117
Emily Shafferbbef71c2017-05-08 16:36:17 -07001118 return IPMI_CC_OK;
1119};
1120
Ratan Guptae0cc8552018-01-22 14:23:04 +05301121ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response,
1122 ipmi_data_len_t data_len)
1123{
1124 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1125 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
Patrick Venture0b02be92018-08-31 11:55:55 -07001126 get_sdr::SensorDataFruRecord record{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301127 auto dataLength = 0;
1128
1129 auto fru = frus.begin();
Patrick Venture0b02be92018-08-31 11:55:55 -07001130 uint8_t fruID{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301131 auto recordID = get_sdr::request::get_record_id(req);
1132
1133 fruID = recordID - FRU_RECORD_ID_START;
1134 fru = frus.find(fruID);
1135 if (fru == frus.end())
1136 {
1137 return IPMI_CC_SENSOR_INVALID;
1138 }
1139
1140 /* Header */
1141 get_sdr::header::set_record_id(recordID, &(record.header));
1142 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1143 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD;
1144 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1145
1146 /* Key */
1147 record.key.fruID = fruID;
1148 record.key.accessLun |= IPMI_LOGICAL_FRU;
Matt Simmering68d9d402023-11-09 14:22:11 -08001149 record.key.deviceAddress = BMCTargetAddress;
Ratan Guptae0cc8552018-01-22 14:23:04 +05301150
1151 /* Body */
1152 record.body.entityID = fru->second[0].entityID;
1153 record.body.entityInstance = fru->second[0].entityInstance;
1154 record.body.deviceType = fruInventoryDevice;
1155 record.body.deviceTypeModifier = IPMIFruInventory;
1156
1157 /* Device ID string */
Patrick Venture0b02be92018-08-31 11:55:55 -07001158 auto deviceID =
1159 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1,
1160 fru->second[0].path.length());
Ratan Guptae0cc8552018-01-22 14:23:04 +05301161
1162 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH)
1163 {
1164 get_sdr::body::set_device_id_strlen(
Patrick Venture0b02be92018-08-31 11:55:55 -07001165 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301166 }
1167 else
1168 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001169 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301170 }
1171
1172 strncpy(record.body.deviceID, deviceID.c_str(),
1173 get_sdr::body::get_device_id_strlen(&(record.body)));
1174
1175 if (++fru == frus.end())
1176 {
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001177 // we have reached till end of fru, so assign the next record id to
1178 // 512(Max fru ID = 511) + Entity Record ID(may start with 0).
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001179 const auto& entityRecords =
1180 ipmi::sensor::EntityInfoMapContainer::getContainer()
1181 ->getIpmiEntityRecords();
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001182 auto next_record_id = (entityRecords.size())
1183 ? entityRecords.begin()->first +
1184 ENTITY_RECORD_ID_START
1185 : END_OF_RECORD;
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001186 get_sdr::response::set_next_record_id(next_record_id, resp);
1187 }
1188 else
1189 {
1190 get_sdr::response::set_next_record_id(
1191 (FRU_RECORD_ID_START + fru->first), resp);
1192 }
1193
1194 // Check for invalid offset size
1195 if (req->offset > sizeof(record))
1196 {
1197 return IPMI_CC_PARM_OUT_OF_RANGE;
1198 }
1199
1200 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1201 sizeof(record) - req->offset);
1202
1203 std::memcpy(resp->record_data,
1204 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
1205
1206 *data_len = dataLength;
1207 *data_len += 2; // additional 2 bytes for next record ID
1208
1209 return IPMI_CC_OK;
1210}
1211
1212ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response,
1213 ipmi_data_len_t data_len)
1214{
1215 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1216 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
1217 get_sdr::SensorDataEntityRecord record{};
1218 auto dataLength = 0;
1219
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001220 const auto& entityRecords =
1221 ipmi::sensor::EntityInfoMapContainer::getContainer()
1222 ->getIpmiEntityRecords();
Patrick Venture83a0b842019-07-19 18:37:15 -07001223 auto entity = entityRecords.begin();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001224 uint8_t entityRecordID;
1225 auto recordID = get_sdr::request::get_record_id(req);
1226
1227 entityRecordID = recordID - ENTITY_RECORD_ID_START;
Patrick Venture83a0b842019-07-19 18:37:15 -07001228 entity = entityRecords.find(entityRecordID);
1229 if (entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001230 {
1231 return IPMI_CC_SENSOR_INVALID;
1232 }
1233
1234 /* Header */
1235 get_sdr::header::set_record_id(recordID, &(record.header));
1236 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1237 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD;
1238 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1239
1240 /* Key */
1241 record.key.containerEntityId = entity->second.containerEntityId;
1242 record.key.containerEntityInstance = entity->second.containerEntityInstance;
1243 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked,
1244 &(record.key));
1245 record.key.entityId1 = entity->second.containedEntities[0].first;
1246 record.key.entityInstance1 = entity->second.containedEntities[0].second;
1247
1248 /* Body */
1249 record.body.entityId2 = entity->second.containedEntities[1].first;
1250 record.body.entityInstance2 = entity->second.containedEntities[1].second;
1251 record.body.entityId3 = entity->second.containedEntities[2].first;
1252 record.body.entityInstance3 = entity->second.containedEntities[2].second;
1253 record.body.entityId4 = entity->second.containedEntities[3].first;
1254 record.body.entityInstance4 = entity->second.containedEntities[3].second;
1255
Patrick Venture83a0b842019-07-19 18:37:15 -07001256 if (++entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001257 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001258 get_sdr::response::set_next_record_id(END_OF_RECORD,
1259 resp); // last record
Ratan Guptae0cc8552018-01-22 14:23:04 +05301260 }
1261 else
1262 {
1263 get_sdr::response::set_next_record_id(
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001264 (ENTITY_RECORD_ID_START + entity->first), resp);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301265 }
1266
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001267 // Check for invalid offset size
1268 if (req->offset > sizeof(record))
Ratan Guptae0cc8552018-01-22 14:23:04 +05301269 {
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001270 return IPMI_CC_PARM_OUT_OF_RANGE;
Ratan Guptae0cc8552018-01-22 14:23:04 +05301271 }
1272
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001273 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1274 sizeof(record) - req->offset);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301275
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001276 std::memcpy(resp->record_data,
Jason M. Bills1cd85962018-10-05 12:04:01 -07001277 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301278
1279 *data_len = dataLength;
1280 *data_len += 2; // additional 2 bytes for next record ID
1281
1282 return IPMI_CC_OK;
1283}
1284
Willy Tu11d68892022-01-20 10:37:34 -08001285ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t request,
1286 ipmi_response_t response, ipmi_data_len_t data_len,
1287 ipmi_context_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001288{
1289 ipmi_ret_t ret = IPMI_CC_OK;
Patrick Venture0b02be92018-08-31 11:55:55 -07001290 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request;
1291 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response;
Patrick Venture38426dd2019-07-30 15:22:29 -07001292
1293 // Note: we use an iterator so we can provide the next ID at the end of
1294 // the call.
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001295 auto sensor = ipmi::sensor::sensors.begin();
Patrick Venture38426dd2019-07-30 15:22:29 -07001296 auto recordID = get_sdr::request::get_record_id(req);
1297
1298 // At the beginning of a scan, the host side will send us id=0.
1299 if (recordID != 0)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001300 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001301 // recordID 0 to 255 means it is a FULL record.
1302 // recordID 256 to 511 means it is a FRU record.
1303 // recordID greater then 511 means it is a Entity Association
1304 // record. Currently we are supporting three record types: FULL
1305 // record, FRU record and Enttiy Association record.
1306 if (recordID >= ENTITY_RECORD_ID_START)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001307 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001308 return ipmi_entity_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001309 }
Patrick Venture38426dd2019-07-30 15:22:29 -07001310 else if (recordID >= FRU_RECORD_ID_START &&
1311 recordID < ENTITY_RECORD_ID_START)
Jaghathiswari Rankappagounder Natarajan0780df12019-02-06 15:29:24 -08001312 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001313 return ipmi_fru_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001314 }
1315 else
1316 {
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001317 sensor = ipmi::sensor::sensors.find(recordID);
1318 if (sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001319 {
1320 return IPMI_CC_SENSOR_INVALID;
1321 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001322 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001323 }
1324
Patrick Venture38426dd2019-07-30 15:22:29 -07001325 uint8_t sensor_id = sensor->first;
1326
Lei YU14a47812021-09-17 15:58:04 +08001327 auto it = sdrCacheMap.find(sensor_id);
1328 if (it == sdrCacheMap.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001329 {
Lei YU14a47812021-09-17 15:58:04 +08001330 /* Header */
Willy Tu11d68892022-01-20 10:37:34 -08001331 get_sdr::SensorDataFullRecord record = {};
Lei YU14a47812021-09-17 15:58:04 +08001332 get_sdr::header::set_record_id(sensor_id, &(record.header));
1333 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1
1334 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
1335 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1336
1337 /* Key */
1338 get_sdr::key::set_owner_id_bmc(&(record.key));
1339 record.key.sensor_number = sensor_id;
1340
1341 /* Body */
1342 record.body.entity_id = sensor->second.entityType;
1343 record.body.sensor_type = sensor->second.sensorType;
1344 record.body.event_reading_type = sensor->second.sensorReadingType;
1345 record.body.entity_instance = sensor->second.instance;
1346 if (ipmi::sensor::Mutability::Write ==
1347 (sensor->second.mutability & ipmi::sensor::Mutability::Write))
1348 {
1349 get_sdr::body::init_settable_state(true, &(record.body));
1350 }
1351
1352 // Set the type-specific details given the DBus interface
1353 populate_record_from_dbus(&(record.body), &(sensor->second), data_len);
1354 sdrCacheMap[sensor_id] = std::move(record);
Patrick Venture38426dd2019-07-30 15:22:29 -07001355 }
1356
Lei YU14a47812021-09-17 15:58:04 +08001357 const auto& record = sdrCacheMap[sensor_id];
Patrick Venture38426dd2019-07-30 15:22:29 -07001358
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001359 if (++sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001360 {
1361 // we have reached till end of sensor, so assign the next record id
1362 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0).
1363 auto next_record_id = (frus.size())
1364 ? frus.begin()->first + FRU_RECORD_ID_START
1365 : END_OF_RECORD;
1366
1367 get_sdr::response::set_next_record_id(next_record_id, resp);
1368 }
1369 else
1370 {
1371 get_sdr::response::set_next_record_id(sensor->first, resp);
1372 }
1373
1374 if (req->offset > sizeof(record))
1375 {
1376 return IPMI_CC_PARM_OUT_OF_RANGE;
1377 }
1378
1379 // data_len will ultimately be the size of the record, plus
1380 // the size of the next record ID:
1381 *data_len = std::min(static_cast<size_t>(req->bytes_to_read),
1382 sizeof(record) - req->offset);
1383
1384 std::memcpy(resp->record_data,
Lei YU14a47812021-09-17 15:58:04 +08001385 reinterpret_cast<const uint8_t*>(&record) + req->offset,
1386 *data_len);
Patrick Venture38426dd2019-07-30 15:22:29 -07001387
1388 // data_len should include the LSB and MSB:
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001389 *data_len += sizeof(resp->next_record_id_lsb) +
1390 sizeof(resp->next_record_id_msb);
Patrick Venture38426dd2019-07-30 15:22:29 -07001391
Emily Shafferbbef71c2017-05-08 16:36:17 -07001392 return ret;
1393}
1394
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001395static bool isFromSystemChannel()
1396{
1397 // TODO we could not figure out where the request is from based on IPMI
1398 // command handler parameters. because of it, we can not differentiate
1399 // request from SMS/SMM or IPMB channel
1400 return true;
1401}
1402
Willy Tu11d68892022-01-20 10:37:34 -08001403ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t, ipmi_cmd_t,
1404 ipmi_request_t request, ipmi_response_t,
1405 ipmi_data_len_t dataLen, ipmi_context_t)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001406{
1407 uint16_t generatorID;
1408 size_t count;
1409 bool assert = true;
1410 std::string sensorPath;
1411 size_t paraLen = *dataLen;
1412 PlatformEventRequest* req;
1413 *dataLen = 0;
1414
1415 if ((paraLen < selSystemEventSizeWith1Bytes) ||
1416 (paraLen > selSystemEventSizeWith3Bytes))
1417 {
1418 return IPMI_CC_REQ_DATA_LEN_INVALID;
1419 }
1420
1421 if (isFromSystemChannel())
1422 { // first byte for SYSTEM Interface is Generator ID
1423 // +1 to get common struct
1424 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1);
1425 // Capture the generator ID
1426 generatorID = *reinterpret_cast<uint8_t*>(request);
1427 // Platform Event usually comes from other firmware, like BIOS.
1428 // Unlike BMC sensor, it does not have BMC DBUS sensor path.
1429 sensorPath = "System";
1430 }
1431 else
1432 {
1433 req = reinterpret_cast<PlatformEventRequest*>(request);
1434 // TODO GenratorID for IPMB is combination of RqSA and RqLUN
1435 generatorID = 0xff;
1436 sensorPath = "IPMB";
1437 }
1438 // Content of event data field depends on sensor class.
1439 // When data0 bit[5:4] is non-zero, valid data counts is 3.
1440 // When data0 bit[7:6] is non-zero, valid data counts is 2.
1441 if (((req->data[0] & byte3EnableMask) != 0 &&
1442 paraLen < selSystemEventSizeWith3Bytes) ||
1443 ((req->data[0] & byte2EnableMask) != 0 &&
1444 paraLen < selSystemEventSizeWith2Bytes))
1445 {
1446 return IPMI_CC_REQ_DATA_LEN_INVALID;
1447 }
1448
1449 // Count bytes of Event Data
1450 if ((req->data[0] & byte3EnableMask) != 0)
1451 {
1452 count = 3;
1453 }
1454 else if ((req->data[0] & byte2EnableMask) != 0)
1455 {
1456 count = 2;
1457 }
1458 else
1459 {
1460 count = 1;
1461 }
1462 assert = req->eventDirectionType & directionMask ? false : true;
1463 std::vector<uint8_t> eventData(req->data, req->data + count);
1464
Patrick Williams5d82f472022-07-22 19:26:53 -05001465 sdbusplus::bus_t dbus(bus);
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -05001466 std::string service = ipmi::getService(dbus, ipmiSELAddInterface,
1467 ipmiSELPath);
Patrick Williams5d82f472022-07-22 19:26:53 -05001468 sdbusplus::message_t writeSEL = dbus.new_method_call(
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001469 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd");
1470 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert,
1471 generatorID);
1472 try
1473 {
1474 dbus.call(writeSEL);
1475 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001476 catch (const sdbusplus::exception_t& e)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001477 {
George Liu3b1071a2024-07-17 20:26:14 +08001478 lg2::error("exception message: {ERROR}", "ERROR", e);
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001479 return IPMI_CC_UNSPECIFIED_ERROR;
1480 }
1481 return IPMI_CC_OK;
1482}
1483
Chris Austenac4604a2015-10-13 12:43:27 -05001484void register_netfn_sen_functions()
1485{
Willy Tud351a722021-08-12 14:33:40 -07001486 // Handlers with dbus-sdr handler implementation.
1487 // Do not register the hander if it dynamic sensors stack is used.
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001488
Willy Tud351a722021-08-12 14:33:40 -07001489#ifndef FEATURE_DYNAMIC_SENSORS
Lei YUbe5c6b22021-09-16 15:46:20 +08001490
Lei YU962e68b2021-09-16 16:25:34 +08001491#ifdef FEATURE_SENSORS_CACHE
Lei YUbe5c6b22021-09-16 15:46:20 +08001492 // Initialize the sensor matches
1493 initSensorMatches();
Lei YU962e68b2021-09-16 16:25:34 +08001494#endif
Lei YUbe5c6b22021-09-16 15:46:20 +08001495
Tom05732372016-09-06 17:21:23 +05301496 // <Set Sensor Reading and Event Status>
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +00001497 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1498 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts,
1499 ipmi::Privilege::Operator, ipmiSetSensorReading);
Tom05732372016-09-06 17:21:23 +05301500 // <Get Sensor Reading>
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +00001501 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1502 ipmi::sensor_event::cmdGetSensorReading,
1503 ipmi::Privilege::User, ipmiSensorGetSensorReading);
Emily Shaffera344afc2017-04-13 15:09:39 -07001504
Tom Joseph5ca50952018-02-22 00:33:38 +05301505 // <Reserve Device SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001506 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1507 ipmi::sensor_event::cmdReserveDeviceSdrRepository,
1508 ipmi::Privilege::User, ipmiSensorReserveSdr);
Chris Austen10ccc0f2015-12-10 18:27:04 -06001509
Tom Joseph5ca50952018-02-22 00:33:38 +05301510 // <Get Device SDR Info>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001511 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1512 ipmi::sensor_event::cmdGetDeviceSdrInfo,
1513 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001514
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001515 // <Get Sensor Thresholds>
jayaprakash Mutyala996c9792019-05-03 15:56:48 +00001516 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1517 ipmi::sensor_event::cmdGetSensorThreshold,
1518 ipmi::Privilege::User, ipmiSensorGetSensorThresholds);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001519
Lotus Xuf93da662021-10-18 17:20:06 +08001520 // <Set Sensor Thresholds>
1521 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1522 ipmi::sensor_event::cmdSetSensorThreshold,
1523 ipmi::Privilege::User, ipmiSenSetSensorThresholds);
Vivekanand Veeracholand3d2fe22021-11-12 19:40:42 -08001524
1525 // <Get Device SDR>
1526 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr,
1527 ipmi_sen_get_sdr, PRIVILEGE_USER);
1528
Willy Tud351a722021-08-12 14:33:40 -07001529#endif
1530
1531 // Common Handers used by both implementation.
1532
1533 // <Platform Event Message>
1534 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr,
1535 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR);
1536
1537 // <Get Sensor Type>
1538 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1539 ipmi::sensor_event::cmdGetSensorType,
1540 ipmi::Privilege::User, ipmiGetSensorType);
1541
Chris Austenac4604a2015-10-13 12:43:27 -05001542 return;
1543}