blob: 32174125c3e68c73a627575f15cdae8ac7d5bbab [file] [log] [blame]
Brandon Kim9cf85622019-06-19 12:05:08 -07001#include "config.h"
2
Patrick Venture46470a32018-09-07 19:26:25 -07003#include "sensorhandler.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07004
Patrick Venture99bf1c42019-08-23 09:02:13 -07005#include "entity_map_json.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07006#include "fruread.hpp"
Patrick Venture0b02be92018-08-31 11:55:55 -07007
Tomd700e762016-09-20 18:24:13 +05308#include <mapper.h>
Chris Austen10ccc0f2015-12-10 18:27:04 -06009#include <systemd/sd-bus.h>
Patrick Venture0b02be92018-08-31 11:55:55 -070010
11#include <bitset>
Patrick Venture586d35b2018-09-07 19:56:18 -070012#include <cmath>
Patrick Ventureb51bf9c2018-09-10 15:53:14 -070013#include <cstring>
Vernon Mauerye08fbff2019-04-03 09:19:34 -070014#include <ipmid/api.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070015#include <ipmid/types.hpp>
Vernon Mauery6a98fe72019-03-11 15:57:48 -070016#include <ipmid/utils.hpp>
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -050017#include <phosphor-logging/elog-errors.hpp>
Patrick Venture0b02be92018-08-31 11:55:55 -070018#include <phosphor-logging/log.hpp>
William A. Kennington III4c008022018-10-12 17:18:14 -070019#include <sdbusplus/message/types.hpp>
Patrick Venture0b02be92018-08-31 11:55:55 -070020#include <set>
21#include <xyz/openbmc_project/Common/error.hpp>
22#include <xyz/openbmc_project/Sensor/Value/server.hpp>
23
Ratan Guptae0cc8552018-01-22 14:23:04 +053024static constexpr uint8_t fruInventoryDevice = 0x10;
25static constexpr uint8_t IPMIFruInventory = 0x02;
26static constexpr uint8_t BMCSlaveAddress = 0x20;
27
Patrick Venture0b02be92018-08-31 11:55:55 -070028extern int updateSensorRecordFromSSRAESC(const void*);
29extern sd_bus* bus;
Patrick Venturedb0cbe62019-09-09 14:47:22 -070030
31namespace ipmi
32{
33namespace sensor
34{
35extern const IdInfoMap sensors;
36} // namespace sensor
37} // namespace ipmi
38
Ratan Guptae0cc8552018-01-22 14:23:04 +053039extern const FruMap frus;
40
Tom Josephbe703f72017-03-09 12:34:35 +053041using namespace phosphor::logging;
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -050042using InternalFailure =
43 sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
Chris Austenac4604a2015-10-13 12:43:27 -050044
Patrick Venture0b02be92018-08-31 11:55:55 -070045void register_netfn_sen_functions() __attribute__((constructor));
Chris Austenac4604a2015-10-13 12:43:27 -050046
Patrick Venture0b02be92018-08-31 11:55:55 -070047struct sensorTypemap_t
48{
Chris Austen0012e9b2015-10-22 01:37:46 -050049 uint8_t number;
Chris Austend7cf0e42015-11-07 14:27:12 -060050 uint8_t typecode;
Chris Austen0012e9b2015-10-22 01:37:46 -050051 char dbusname[32];
Patrick Venture0b02be92018-08-31 11:55:55 -070052};
Chris Austen0012e9b2015-10-22 01:37:46 -050053
Chris Austen0012e9b2015-10-22 01:37:46 -050054sensorTypemap_t g_SensorTypeMap[] = {
55
Chris Austend7cf0e42015-11-07 14:27:12 -060056 {0x01, 0x6F, "Temp"},
57 {0x0C, 0x6F, "DIMM"},
58 {0x0C, 0x6F, "MEMORY_BUFFER"},
59 {0x07, 0x6F, "PROC"},
60 {0x07, 0x6F, "CORE"},
61 {0x07, 0x6F, "CPU"},
62 {0x0F, 0x6F, "BootProgress"},
Patrick Venture0b02be92018-08-31 11:55:55 -070063 {0xe9, 0x09, "OccStatus"}, // E9 is an internal mapping to handle sensor
64 // type code os 0x09
Chris Austend7cf0e42015-11-07 14:27:12 -060065 {0xC3, 0x6F, "BootCount"},
66 {0x1F, 0x6F, "OperatingSystemStatus"},
Chris Austen800ba712015-12-03 15:31:00 -060067 {0x12, 0x6F, "SYSTEM_EVENT"},
68 {0xC7, 0x03, "SYSTEM"},
69 {0xC7, 0x03, "MAIN_PLANAR"},
Chris Austen10ccc0f2015-12-10 18:27:04 -060070 {0xC2, 0x6F, "PowerCap"},
Tom Joseph558184e2017-09-01 13:45:05 +053071 {0x0b, 0xCA, "PowerSupplyRedundancy"},
Jayanth Othayoth0661beb2017-03-22 06:00:58 -050072 {0xDA, 0x03, "TurboAllowed"},
Tom Joseph558184e2017-09-01 13:45:05 +053073 {0xD8, 0xC8, "PowerSupplyDerating"},
Chris Austend7cf0e42015-11-07 14:27:12 -060074 {0xFF, 0x00, ""},
Chris Austen0012e9b2015-10-22 01:37:46 -050075};
76
Patrick Venture0b02be92018-08-31 11:55:55 -070077struct sensor_data_t
78{
Chris Austenac4604a2015-10-13 12:43:27 -050079 uint8_t sennum;
Patrick Venture0b02be92018-08-31 11:55:55 -070080} __attribute__((packed));
Chris Austenac4604a2015-10-13 12:43:27 -050081
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
Lei YUbe5c6b22021-09-16 15:46:20 +080090std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match::match>>
91 sensorAddedMatches __attribute__((init_priority(101)));
92std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match::match>>
93 sensorUpdatedMatches __attribute__((init_priority(101)));
Lei YU7f3a70f2021-12-07 16:40:40 +080094std::map<uint8_t, std::unique_ptr<sdbusplus::bus::match::match>>
95 sensorRemovedMatches __attribute__((init_priority(101)));
96std::unique_ptr<sdbusplus::bus::match::match> sensorsOwnerMatch
97 __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 {
133 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
134 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;
147 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
148 for (const auto& s : ipmi::sensor::sensors)
149 {
150 sensorAddedMatches.emplace(
151 s.first,
152 std::make_unique<sdbusplus::bus::match::match>(
153 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,
159 std::make_unique<sdbusplus::bus::match::match>(
160 bus, interfacesRemoved() + argNpath(0, s.second.sensorPath),
161 [id = s.first](auto& /*msg*/) {
162 // 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();
Lei YUbe5c6b22021-09-16 15:46:20 +0800167 }));
168 sensorUpdatedMatches.emplace(
Lei YU97140502021-09-17 13:49:43 +0800169 s.first, std::make_unique<sdbusplus::bus::match::match>(
170 bus,
171 type::signal() + path(s.second.sensorPath) +
172 member("PropertiesChanged"s) +
173 interface("org.freedesktop.DBus.Properties"s),
174 [&s](auto& msg) {
Lei YU7f3a70f2021-12-07 16:40:40 +0800175 fillSensorIdServiceMap(
176 s.second.sensorPath,
177 s.second.propertyInterfaces.begin()->first,
178 s.first);
Lei YU97140502021-09-17 13:49:43 +0800179 try
180 {
Lei YU8e8152c2021-12-06 20:11:08 +0800181 // 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);
Lei YU97140502021-09-17 13:49:43 +0800187 }
188 catch (const std::exception& e)
189 {
190 sensorCacheMap[s.first].reset();
191 }
192 }));
Lei YU7f3a70f2021-12-07 16:40:40 +0800193 sensorsOwnerMatch = std::make_unique<sdbusplus::bus::match::match>(
194 bus, nameOwnerChanged(), [](auto& msg) {
195 std::string name;
196 std::string oldOwner;
197 std::string newOwner;
198 msg.read(name, oldOwner, newOwner);
199
200 if (!name.empty() && newOwner.empty())
201 {
202 // The service exits
203 const auto it = serviceToIdMap.find(name);
204 if (it == serviceToIdMap.end())
205 {
206 return;
207 }
208 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 }
216}
Lei YU962e68b2021-09-16 16:25:34 +0800217#endif
Lei YUbe5c6b22021-09-16 15:46:20 +0800218
Patrick Venture0b02be92018-08-31 11:55:55 -0700219int get_bus_for_path(const char* path, char** busname)
220{
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700221 return mapper_get_service(bus, path, busname);
222}
Tomd700e762016-09-20 18:24:13 +0530223
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700224// Use a lookup table to find the interface name of a specific sensor
225// This will be used until an alternative is found. this is the first
226// step for mapping IPMI
Patrick Venture0b02be92018-08-31 11:55:55 -0700227int find_openbmc_path(uint8_t num, dbus_interface_t* interface)
228{
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700229 int rc;
230
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700231 const auto& sensor_it = ipmi::sensor::sensors.find(num);
232 if (sensor_it == ipmi::sensor::sensors.end())
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700233 {
Adriana Kobylakba23ff72018-09-12 12:58:43 -0500234 // The sensor map does not contain the sensor requested
235 return -EINVAL;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700236 }
237
238 const auto& info = sensor_it->second;
239
Patrick Williams8451edf2017-06-13 09:01:06 -0500240 char* busname = nullptr;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700241 rc = get_bus_for_path(info.sensorPath.c_str(), &busname);
Patrick Venture0b02be92018-08-31 11:55:55 -0700242 if (rc < 0)
243 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700244 std::fprintf(stderr, "Failed to get %s busname: %s\n",
245 info.sensorPath.c_str(), busname);
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700246 goto final;
247 }
248
249 interface->sensortype = info.sensorType;
250 strcpy(interface->bus, busname);
251 strcpy(interface->path, info.sensorPath.c_str());
252 // Take the interface name from the beginning of the DbusInterfaceMap. This
253 // works for the Value interface but may not suffice for more complex
254 // sensors.
255 // tracked https://github.com/openbmc/phosphor-host-ipmid/issues/103
Patrick Venture0b02be92018-08-31 11:55:55 -0700256 strcpy(interface->interface,
257 info.propertyInterfaces.begin()->first.c_str());
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700258 interface->sensornumber = num;
259
260final:
261 free(busname);
262 return rc;
263}
264
Tomd700e762016-09-20 18:24:13 +0530265/////////////////////////////////////////////////////////////////////
266//
267// Routines used by ipmi commands wanting to interact on the dbus
268//
269/////////////////////////////////////////////////////////////////////
Patrick Venture0b02be92018-08-31 11:55:55 -0700270int set_sensor_dbus_state_s(uint8_t number, const char* method,
271 const char* value)
272{
Tomd700e762016-09-20 18:24:13 +0530273
274 dbus_interface_t a;
275 int r;
276 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700277 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530278
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700279 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530280
Patrick Venture0b02be92018-08-31 11:55:55 -0700281 if (r < 0)
282 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700283 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530284 return 0;
285 }
286
Patrick Venture0b02be92018-08-31 11:55:55 -0700287 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
288 method);
289 if (r < 0)
290 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700291 std::fprintf(stderr, "Failed to create a method call: %s",
292 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530293 goto final;
294 }
295
296 r = sd_bus_message_append(m, "v", "s", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700297 if (r < 0)
298 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700299 std::fprintf(stderr, "Failed to create a input parameter: %s",
300 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530301 goto final;
302 }
303
Tomd700e762016-09-20 18:24:13 +0530304 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700305 if (r < 0)
306 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700307 std::fprintf(stderr, "Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530308 }
309
310final:
311 sd_bus_error_free(&error);
312 m = sd_bus_message_unref(m);
313
314 return 0;
315}
Patrick Venture0b02be92018-08-31 11:55:55 -0700316int set_sensor_dbus_state_y(uint8_t number, const char* method,
317 const uint8_t value)
318{
Tomd700e762016-09-20 18:24:13 +0530319
320 dbus_interface_t a;
321 int r;
322 sd_bus_error error = SD_BUS_ERROR_NULL;
Patrick Venture0b02be92018-08-31 11:55:55 -0700323 sd_bus_message* m = NULL;
Tomd700e762016-09-20 18:24:13 +0530324
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700325 r = find_openbmc_path(number, &a);
Tomd700e762016-09-20 18:24:13 +0530326
Patrick Venture0b02be92018-08-31 11:55:55 -0700327 if (r < 0)
328 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700329 std::fprintf(stderr, "Failed to find Sensor 0x%02x\n", number);
Tomd700e762016-09-20 18:24:13 +0530330 return 0;
331 }
332
Patrick Venture0b02be92018-08-31 11:55:55 -0700333 r = sd_bus_message_new_method_call(bus, &m, a.bus, a.path, a.interface,
334 method);
335 if (r < 0)
336 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700337 std::fprintf(stderr, "Failed to create a method call: %s",
338 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530339 goto final;
340 }
341
342 r = sd_bus_message_append(m, "v", "i", value);
Patrick Venture0b02be92018-08-31 11:55:55 -0700343 if (r < 0)
344 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700345 std::fprintf(stderr, "Failed to create a input parameter: %s",
346 strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530347 goto final;
348 }
349
Tomd700e762016-09-20 18:24:13 +0530350 r = sd_bus_call(bus, m, 0, &error, NULL);
Patrick Venture0b02be92018-08-31 11:55:55 -0700351 if (r < 0)
352 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700353 std::fprintf(stderr, "12 Failed to call the method: %s", strerror(-r));
Tomd700e762016-09-20 18:24:13 +0530354 }
355
356final:
357 sd_bus_error_free(&error);
358 m = sd_bus_message_unref(m);
359
360 return 0;
361}
362
Patrick Venture0b02be92018-08-31 11:55:55 -0700363uint8_t dbus_to_sensor_type(char* p)
364{
Chris Austenac4604a2015-10-13 12:43:27 -0500365
Patrick Venture0b02be92018-08-31 11:55:55 -0700366 sensorTypemap_t* s = g_SensorTypeMap;
367 char r = 0;
368 while (s->number != 0xFF)
369 {
370 if (!strcmp(s->dbusname, p))
371 {
Tom Joseph558184e2017-09-01 13:45:05 +0530372 r = s->typecode;
Patrick Venture0b02be92018-08-31 11:55:55 -0700373 break;
Chris Austenac4604a2015-10-13 12:43:27 -0500374 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500375 s++;
Chris Austenac4604a2015-10-13 12:43:27 -0500376 }
377
Chris Austen0012e9b2015-10-22 01:37:46 -0500378 if (s->number == 0xFF)
379 printf("Failed to find Sensor Type %s\n", p);
Chris Austenac4604a2015-10-13 12:43:27 -0500380
Chris Austen0012e9b2015-10-22 01:37:46 -0500381 return r;
Chris Austenac4604a2015-10-13 12:43:27 -0500382}
383
Patrick Venture0b02be92018-08-31 11:55:55 -0700384uint8_t get_type_from_interface(dbus_interface_t dbus_if)
385{
Chris Austen0012e9b2015-10-22 01:37:46 -0500386
Brad Bishop56003452016-10-05 21:49:19 -0400387 uint8_t type;
Chris Austen0012e9b2015-10-22 01:37:46 -0500388
Chris Austen0012e9b2015-10-22 01:37:46 -0500389 // This is where sensors that do not exist in dbus but do
390 // exist in the host code stop. This should indicate it
391 // is not a supported sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700392 if (dbus_if.interface[0] == 0)
393 {
394 return 0;
395 }
Chris Austen0012e9b2015-10-22 01:37:46 -0500396
Emily Shaffer71174412017-04-05 15:10:40 -0700397 // Fetch type from interface itself.
398 if (dbus_if.sensortype != 0)
399 {
400 type = dbus_if.sensortype;
Patrick Venture0b02be92018-08-31 11:55:55 -0700401 }
402 else
403 {
Chris Austen0012e9b2015-10-22 01:37:46 -0500404 // Non InventoryItems
Patrick Venture4491a462018-10-13 13:00:42 -0700405 char* p = strrchr(dbus_if.path, '/');
Patrick Venture0b02be92018-08-31 11:55:55 -0700406 type = dbus_to_sensor_type(p + 1);
Chris Austen0012e9b2015-10-22 01:37:46 -0500407 }
408
Brad Bishop56003452016-10-05 21:49:19 -0400409 return type;
Patrick Venture0b02be92018-08-31 11:55:55 -0700410}
Chris Austen0012e9b2015-10-22 01:37:46 -0500411
Emily Shaffer391f3302017-04-03 10:27:08 -0700412// Replaces find_sensor
Patrick Venture0b02be92018-08-31 11:55:55 -0700413uint8_t find_type_for_sensor_number(uint8_t num)
414{
Emily Shaffer391f3302017-04-03 10:27:08 -0700415 int r;
416 dbus_interface_t dbus_if;
Emily Shaffer2ae09b92017-04-05 15:09:41 -0700417 r = find_openbmc_path(num, &dbus_if);
Patrick Venture0b02be92018-08-31 11:55:55 -0700418 if (r < 0)
419 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700420 std::fprintf(stderr, "Could not find sensor %d\n", num);
Lei YU91875f72018-04-03 15:14:49 +0800421 return 0;
Emily Shaffer391f3302017-04-03 10:27:08 -0700422 }
423 return get_type_from_interface(dbus_if);
424}
425
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000426/**
427 * @brief implements the get sensor type command.
428 * @param - sensorNumber
429 *
430 * @return IPMI completion code plus response data on success.
431 * - sensorType
432 * - eventType
433 **/
434
435ipmi::RspType<uint8_t, // sensorType
436 uint8_t // eventType
437 >
438 ipmiGetSensorType(uint8_t sensorNumber)
Chris Austenac4604a2015-10-13 12:43:27 -0500439{
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000440 uint8_t sensorType = find_type_for_sensor_number(sensorNumber);
Chris Austenac4604a2015-10-13 12:43:27 -0500441
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000442 if (sensorType == 0)
Patrick Venture0b02be92018-08-31 11:55:55 -0700443 {
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000444 return ipmi::responseSensorInvalid();
Chris Austen0012e9b2015-10-22 01:37:46 -0500445 }
446
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +0000447 constexpr uint8_t eventType = 0x6F;
448 return ipmi::responseSuccess(sensorType, eventType);
Chris Austenac4604a2015-10-13 12:43:27 -0500449}
450
Patrick Venture0b02be92018-08-31 11:55:55 -0700451const std::set<std::string> analogSensorInterfaces = {
Emily Shaffercc941e12017-06-14 13:06:26 -0700452 "xyz.openbmc_project.Sensor.Value",
Patrick Venturee9a64052017-08-18 19:17:27 -0700453 "xyz.openbmc_project.Control.FanPwm",
Emily Shaffercc941e12017-06-14 13:06:26 -0700454};
455
456bool isAnalogSensor(const std::string& interface)
457{
458 return (analogSensorInterfaces.count(interface));
459}
460
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000461/**
462@brief This command is used to set sensorReading.
463
464@param
465 - sensorNumber
466 - operation
467 - reading
468 - assertOffset0_7
469 - assertOffset8_14
470 - deassertOffset0_7
471 - deassertOffset8_14
472 - eventData1
473 - eventData2
474 - eventData3
475
476@return completion code on success.
477**/
478
479ipmi::RspType<> ipmiSetSensorReading(uint8_t sensorNumber, uint8_t operation,
480 uint8_t reading, uint8_t assertOffset0_7,
481 uint8_t assertOffset8_14,
482 uint8_t deassertOffset0_7,
483 uint8_t deassertOffset8_14,
484 uint8_t eventData1, uint8_t eventData2,
485 uint8_t eventData3)
Tom Josephbe703f72017-03-09 12:34:35 +0530486{
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000487 log<level::DEBUG>("IPMI SET_SENSOR",
488 entry("SENSOR_NUM=0x%02x", sensorNumber));
489
Arun P. Mohanan0634e982021-08-30 15:21:33 +0530490 if (sensorNumber == 0xFF)
491 {
492 return ipmi::responseInvalidFieldRequest();
493 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000494 ipmi::sensor::SetSensorReadingReq cmdData;
495
496 cmdData.number = sensorNumber;
497 cmdData.operation = operation;
498 cmdData.reading = reading;
499 cmdData.assertOffset0_7 = assertOffset0_7;
500 cmdData.assertOffset8_14 = assertOffset8_14;
501 cmdData.deassertOffset0_7 = deassertOffset0_7;
502 cmdData.deassertOffset8_14 = deassertOffset8_14;
503 cmdData.eventData1 = eventData1;
504 cmdData.eventData2 = eventData2;
505 cmdData.eventData3 = eventData3;
Tom Josephbe703f72017-03-09 12:34:35 +0530506
507 // Check if the Sensor Number is present
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700508 const auto iter = ipmi::sensor::sensors.find(sensorNumber);
509 if (iter == ipmi::sensor::sensors.end())
Tom Josephbe703f72017-03-09 12:34:35 +0530510 {
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000511 updateSensorRecordFromSSRAESC(&sensorNumber);
512 return ipmi::responseSuccess();
Tom Josephbe703f72017-03-09 12:34:35 +0530513 }
514
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500515 try
516 {
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500517 if (ipmi::sensor::Mutability::Write !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700518 (iter->second.mutability & ipmi::sensor::Mutability::Write))
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500519 {
520 log<level::ERR>("Sensor Set operation is not allowed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000521 entry("SENSOR_NUM=%d", sensorNumber));
522 return ipmi::responseIllegalCommand();
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500523 }
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000524 auto ipmiRC = iter->second.updateFunc(cmdData, iter->second);
525 return ipmi::response(ipmiRC);
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500526 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500527 catch (const InternalFailure& e)
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500528 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700529 log<level::ERR>("Set sensor failed",
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000530 entry("SENSOR_NUM=%d", sensorNumber));
Patrick Venture0b02be92018-08-31 11:55:55 -0700531 commit<InternalFailure>();
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000532 return ipmi::responseUnspecifiedError();
Dhruvaraj Subhashchandran18e99992017-08-09 09:10:47 -0500533 }
Tom Joseph82024322017-09-28 20:07:29 +0530534 catch (const std::runtime_error& e)
535 {
536 log<level::ERR>(e.what());
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +0000537 return ipmi::responseUnspecifiedError();
Tom Joseph82024322017-09-28 20:07:29 +0530538 }
Chris Austenac4604a2015-10-13 12:43:27 -0500539}
540
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000541/** @brief implements the get sensor reading command
542 * @param sensorNum - sensor number
543 *
544 * @returns IPMI completion code plus response data
545 * - senReading - sensor reading
546 * - reserved
547 * - readState - sensor reading state enabled
548 * - senScanState - sensor scan state disabled
549 * - allEventMessageState - all Event message state disabled
550 * - assertionStatesLsb - threshold levels states
551 * - assertionStatesMsb - discrete reading sensor states
552 */
553ipmi::RspType<uint8_t, // sensor reading
Tom Joseph3ee668f2018-03-02 19:49:17 +0530554
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000555 uint5_t, // reserved
556 bool, // reading state
Sui Chen4cc42552019-09-11 10:28:35 -0700557 bool, // 0 = sensor scanning state disabled
558 bool, // 0 = all event messages disabled
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000559
560 uint8_t, // threshold levels states
561 uint8_t // discrete reading sensor states
562 >
Willy Tu11d68892022-01-20 10:37:34 -0800563 ipmiSensorGetSensorReading([[maybe_unused]] ipmi::Context::ptr& ctx,
564 uint8_t sensorNum)
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000565{
566 if (sensorNum == 0xFF)
567 {
568 return ipmi::responseInvalidFieldRequest();
569 }
570
571 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700572 if (iter == ipmi::sensor::sensors.end())
Tom Joseph3ee668f2018-03-02 19:49:17 +0530573 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000574 return ipmi::responseSensorInvalid();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530575 }
576 if (ipmi::sensor::Mutability::Read !=
Patrick Venture0b02be92018-08-31 11:55:55 -0700577 (iter->second.mutability & ipmi::sensor::Mutability::Read))
Tom Joseph3ee668f2018-03-02 19:49:17 +0530578 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000579 return ipmi::responseIllegalCommand();
Tom Joseph3ee668f2018-03-02 19:49:17 +0530580 }
581
582 try
583 {
Lei YU8c2c0482021-09-16 17:28:28 +0800584#ifdef FEATURE_SENSORS_CACHE
Lei YU8e8152c2021-12-06 20:11:08 +0800585 auto& sensorData = sensorCacheMap[sensorNum];
Lei YU97140502021-09-17 13:49:43 +0800586 if (!sensorData.has_value())
587 {
Lei YUa55e9ea2021-09-18 15:15:17 +0800588 // No cached value, try read it
Lei YU8e8152c2021-12-06 20:11:08 +0800589 std::string service;
590 boost::system::error_code ec;
Lei YUa55e9ea2021-09-18 15:15:17 +0800591 const auto& sensorInfo = iter->second;
Lei YU8e8152c2021-12-06 20:11:08 +0800592 ec = ipmi::getService(ctx, sensorInfo.sensorInterface,
593 sensorInfo.sensorPath, service);
594 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800595 {
Lei YU8e8152c2021-12-06 20:11:08 +0800596 return ipmi::responseUnspecifiedError();
Lei YUa55e9ea2021-09-18 15:15:17 +0800597 }
Lei YU7f3a70f2021-12-07 16:40:40 +0800598 fillSensorIdServiceMap(sensorInfo.sensorPath,
599 sensorInfo.propertyInterfaces.begin()->first,
600 iter->first, service);
Lei YU8e8152c2021-12-06 20:11:08 +0800601
602 ipmi::PropertyMap props;
603 ec = ipmi::getAllDbusProperties(
604 ctx, service, sensorInfo.sensorPath,
605 sensorInfo.propertyInterfaces.begin()->first, props);
606 if (ec)
Lei YUa55e9ea2021-09-18 15:15:17 +0800607 {
Lei YU8e8152c2021-12-06 20:11:08 +0800608 fprintf(stderr, "Failed to get sensor %s, %d: %s\n",
609 sensorInfo.sensorPath.c_str(), ec.value(),
610 ec.message().c_str());
Lei YUa55e9ea2021-09-18 15:15:17 +0800611 // Intitilizing with default values
612 constexpr uint8_t senReading = 0;
613 constexpr uint5_t reserved{0};
614 constexpr bool readState = true;
615 constexpr bool senScanState = false;
616 constexpr bool allEventMessageState = false;
617 constexpr uint8_t assertionStatesLsb = 0;
618 constexpr uint8_t assertionStatesMsb = 0;
Lei YU97140502021-09-17 13:49:43 +0800619
Lei YUa55e9ea2021-09-18 15:15:17 +0800620 return ipmi::responseSuccess(senReading, reserved, readState,
621 senScanState, allEventMessageState,
622 assertionStatesLsb,
623 assertionStatesMsb);
624 }
Lei YU8e8152c2021-12-06 20:11:08 +0800625 sensorInfo.getFunc(sensorNum, sensorInfo, props);
Lei YU97140502021-09-17 13:49:43 +0800626 }
627 return ipmi::responseSuccess(
628 sensorData->response.reading, uint5_t(0),
629 sensorData->response.readingOrStateUnavailable,
630 sensorData->response.scanningEnabled,
631 sensorData->response.allEventMessagesEnabled,
632 sensorData->response.thresholdLevelsStates,
633 sensorData->response.discreteReadingSensorStates);
634
Lei YU8c2c0482021-09-16 17:28:28 +0800635#else
Sui Chen4cc42552019-09-11 10:28:35 -0700636 ipmi::sensor::GetSensorResponse getResponse =
637 iter->second.getFunc(iter->second);
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000638
Sui Chen4cc42552019-09-11 10:28:35 -0700639 return ipmi::responseSuccess(getResponse.reading, uint5_t(0),
640 getResponse.readingOrStateUnavailable,
641 getResponse.scanningEnabled,
642 getResponse.allEventMessagesEnabled,
643 getResponse.thresholdLevelsStates,
644 getResponse.discreteReadingSensorStates);
Lei YU8c2c0482021-09-16 17:28:28 +0800645#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530646 }
Brandon Kim9cf85622019-06-19 12:05:08 -0700647#ifdef UPDATE_FUNCTIONAL_ON_FAIL
648 catch (const SensorFunctionalError& e)
649 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000650 return ipmi::responseResponseError();
Brandon Kim9cf85622019-06-19 12:05:08 -0700651 }
652#endif
Tom Joseph3ee668f2018-03-02 19:49:17 +0530653 catch (const std::exception& e)
654 {
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +0000655 // Intitilizing with default values
656 constexpr uint8_t senReading = 0;
657 constexpr uint5_t reserved{0};
658 constexpr bool readState = true;
659 constexpr bool senScanState = false;
660 constexpr bool allEventMessageState = false;
661 constexpr uint8_t assertionStatesLsb = 0;
662 constexpr uint8_t assertionStatesMsb = 0;
663
664 return ipmi::responseSuccess(senReading, reserved, readState,
665 senScanState, allEventMessageState,
666 assertionStatesLsb, assertionStatesMsb);
Tom Joseph3ee668f2018-03-02 19:49:17 +0530667 }
668}
669
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300670get_sdr::GetSensorThresholdsResponse
671 getSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600672{
William A. Kennington III515bc372020-10-27 16:32:32 -0700673 get_sdr::GetSensorThresholdsResponse resp{};
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530674 constexpr auto warningThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600675 "xyz.openbmc_project.Sensor.Threshold.Warning";
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530676 constexpr auto criticalThreshIntf =
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600677 "xyz.openbmc_project.Sensor.Threshold.Critical";
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600678
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700679 const auto iter = ipmi::sensor::sensors.find(sensorNum);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530680 const auto info = iter->second;
681
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300682 std::string service;
683 boost::system::error_code ec;
684 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
685 if (ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530686 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300687 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530688 }
689
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300690 ipmi::PropertyMap warnThresholds;
691 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
692 warningThreshIntf, warnThresholds);
693 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530694 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300695 double warnLow = std::visit(ipmi::VariantToDoubleVisitor(),
696 warnThresholds["WarningLow"]);
697 double warnHigh = std::visit(ipmi::VariantToDoubleVisitor(),
698 warnThresholds["WarningHigh"]);
699
700 if (std::isfinite(warnLow))
701 {
702 warnLow *= std::pow(10, info.scale - info.exponentR);
703 resp.lowerNonCritical = static_cast<uint8_t>(
704 (warnLow - info.scaledOffset) / info.coefficientM);
705 resp.validMask |= static_cast<uint8_t>(
706 ipmi::sensor::ThresholdMask::NON_CRITICAL_LOW_MASK);
707 }
708
709 if (std::isfinite(warnHigh))
710 {
711 warnHigh *= std::pow(10, info.scale - info.exponentR);
712 resp.upperNonCritical = static_cast<uint8_t>(
713 (warnHigh - info.scaledOffset) / info.coefficientM);
714 resp.validMask |= static_cast<uint8_t>(
715 ipmi::sensor::ThresholdMask::NON_CRITICAL_HIGH_MASK);
716 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530717 }
718
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300719 ipmi::PropertyMap critThresholds;
720 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
721 criticalThreshIntf, critThresholds);
722 if (!ec)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530723 {
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300724 double critLow = std::visit(ipmi::VariantToDoubleVisitor(),
725 critThresholds["CriticalLow"]);
726 double critHigh = std::visit(ipmi::VariantToDoubleVisitor(),
727 critThresholds["CriticalHigh"]);
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530728
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300729 if (std::isfinite(critLow))
730 {
731 critLow *= std::pow(10, info.scale - info.exponentR);
732 resp.lowerCritical = static_cast<uint8_t>(
733 (critLow - info.scaledOffset) / info.coefficientM);
734 resp.validMask |= static_cast<uint8_t>(
735 ipmi::sensor::ThresholdMask::CRITICAL_LOW_MASK);
736 }
737
738 if (std::isfinite(critHigh))
739 {
740 critHigh *= std::pow(10, info.scale - info.exponentR);
741 resp.upperCritical = static_cast<uint8_t>(
742 (critHigh - info.scaledOffset) / info.coefficientM);
743 resp.validMask |= static_cast<uint8_t>(
744 ipmi::sensor::ThresholdMask::CRITICAL_HIGH_MASK);
745 }
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530746 }
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000747
748 return resp;
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530749}
750
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000751/** @brief implements the get sensor thresholds command
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300752 * @param ctx - IPMI context pointer
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000753 * @param sensorNum - sensor number
754 *
755 * @returns IPMI completion code plus response data
756 * - validMask - threshold mask
757 * - lower non-critical threshold - IPMI messaging state
758 * - lower critical threshold - link authentication state
759 * - lower non-recoverable threshold - callback state
760 * - upper non-critical threshold
761 * - upper critical
762 * - upper non-recoverable
763 */
764ipmi::RspType<uint8_t, // validMask
765 uint8_t, // lowerNonCritical
766 uint8_t, // lowerCritical
767 uint8_t, // lowerNonRecoverable
768 uint8_t, // upperNonCritical
769 uint8_t, // upperCritical
770 uint8_t // upperNonRecoverable
771 >
Konstantin Aladyshev89a83b62021-05-12 18:59:27 +0300772 ipmiSensorGetSensorThresholds(ipmi::Context::ptr& ctx, uint8_t sensorNum)
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530773{
774 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
775
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700776 const auto iter = ipmi::sensor::sensors.find(sensorNum);
777 if (iter == ipmi::sensor::sensors.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600778 {
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000779 return ipmi::responseSensorInvalid();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600780 }
781
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530782 const auto info = iter->second;
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600783
Patrick Venture0b02be92018-08-31 11:55:55 -0700784 // Proceed only if the sensor value interface is implemented.
Tom Joseph0ac0dd22018-02-16 09:14:45 +0530785 if (info.propertyInterfaces.find(valueInterface) ==
786 info.propertyInterfaces.end())
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600787 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700788 // return with valid mask as 0
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000789 return ipmi::responseSuccess();
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600790 }
791
Lei YU14a47812021-09-17 15:58:04 +0800792 auto it = sensorThresholdMap.find(sensorNum);
793 if (it == sensorThresholdMap.end())
794 {
795 sensorThresholdMap[sensorNum] = getSensorThresholds(ctx, sensorNum);
796 }
797
798 const auto& resp = sensorThresholdMap[sensorNum];
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600799
jayaprakash Mutyala996c9792019-05-03 15:56:48 +0000800 return ipmi::responseSuccess(resp.validMask, resp.lowerNonCritical,
801 resp.lowerCritical, resp.lowerNonRecoverable,
802 resp.upperNonCritical, resp.upperCritical,
803 resp.upperNonRecoverable);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600804}
805
Lotus Xuf93da662021-10-18 17:20:06 +0800806/** @brief implements the Set Sensor threshold command
807 * @param sensorNumber - sensor number
808 * @param lowerNonCriticalThreshMask
809 * @param lowerCriticalThreshMask
810 * @param lowerNonRecovThreshMask
811 * @param upperNonCriticalThreshMask
812 * @param upperCriticalThreshMask
813 * @param upperNonRecovThreshMask
814 * @param reserved
815 * @param lowerNonCritical - lower non-critical threshold
816 * @param lowerCritical - Lower critical threshold
817 * @param lowerNonRecoverable - Lower non recovarable threshold
818 * @param upperNonCritical - Upper non-critical threshold
819 * @param upperCritical - Upper critical
820 * @param upperNonRecoverable - Upper Non-recoverable
821 *
822 * @returns IPMI completion code
823 */
824ipmi::RspType<> ipmiSenSetSensorThresholds(
825 ipmi::Context::ptr& ctx, uint8_t sensorNum, bool lowerNonCriticalThreshMask,
826 bool lowerCriticalThreshMask, bool lowerNonRecovThreshMask,
827 bool upperNonCriticalThreshMask, bool upperCriticalThreshMask,
828 bool upperNonRecovThreshMask, uint2_t reserved, uint8_t lowerNonCritical,
Willy Tu11d68892022-01-20 10:37:34 -0800829 uint8_t lowerCritical, uint8_t, uint8_t upperNonCritical,
830 uint8_t upperCritical, uint8_t)
Lotus Xuf93da662021-10-18 17:20:06 +0800831{
832 if (reserved)
833 {
834 return ipmi::responseInvalidFieldRequest();
835 }
836
837 // lower nc and upper nc not suppported on any sensor
838 if (lowerNonRecovThreshMask || upperNonRecovThreshMask)
839 {
840 return ipmi::responseInvalidFieldRequest();
841 }
842
843 // if none of the threshold mask are set, nothing to do
844 if (!(lowerNonCriticalThreshMask | lowerCriticalThreshMask |
845 lowerNonRecovThreshMask | upperNonCriticalThreshMask |
846 upperCriticalThreshMask | upperNonRecovThreshMask))
847 {
848 return ipmi::responseSuccess();
849 }
850
851 constexpr auto valueInterface = "xyz.openbmc_project.Sensor.Value";
852
853 const auto iter = ipmi::sensor::sensors.find(sensorNum);
854 if (iter == ipmi::sensor::sensors.end())
855 {
856 return ipmi::responseSensorInvalid();
857 }
858
859 const auto& info = iter->second;
860
861 // Proceed only if the sensor value interface is implemented.
862 if (info.propertyInterfaces.find(valueInterface) ==
863 info.propertyInterfaces.end())
864 {
865 // return with valid mask as 0
866 return ipmi::responseSuccess();
867 }
868
869 constexpr auto warningThreshIntf =
870 "xyz.openbmc_project.Sensor.Threshold.Warning";
871 constexpr auto criticalThreshIntf =
872 "xyz.openbmc_project.Sensor.Threshold.Critical";
873
874 std::string service;
875 boost::system::error_code ec;
876 ec = ipmi::getService(ctx, info.sensorInterface, info.sensorPath, service);
877 if (ec)
878 {
879 return ipmi::responseResponseError();
880 }
881 // store a vector of property name, value to set, and interface
882 std::vector<std::tuple<std::string, uint8_t, std::string>> thresholdsToSet;
883
884 // define the indexes of the tuple
885 constexpr uint8_t propertyName = 0;
886 constexpr uint8_t thresholdValue = 1;
887 constexpr uint8_t interface = 2;
888 // verifiy all needed fields are present
889 if (lowerCriticalThreshMask || upperCriticalThreshMask)
890 {
891
892 ipmi::PropertyMap findThreshold;
893 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
894 criticalThreshIntf, findThreshold);
895
896 if (!ec)
897 {
898 if (lowerCriticalThreshMask)
899 {
900 auto findLower = findThreshold.find("CriticalLow");
901 if (findLower == findThreshold.end())
902 {
903 return ipmi::responseInvalidFieldRequest();
904 }
905 thresholdsToSet.emplace_back("CriticalLow", lowerCritical,
906 criticalThreshIntf);
907 }
908 if (upperCriticalThreshMask)
909 {
910 auto findUpper = findThreshold.find("CriticalHigh");
911 if (findUpper == findThreshold.end())
912 {
913 return ipmi::responseInvalidFieldRequest();
914 }
915 thresholdsToSet.emplace_back("CriticalHigh", upperCritical,
916 criticalThreshIntf);
917 }
918 }
919 }
920 if (lowerNonCriticalThreshMask || upperNonCriticalThreshMask)
921 {
922 ipmi::PropertyMap findThreshold;
923 ec = ipmi::getAllDbusProperties(ctx, service, info.sensorPath,
924 warningThreshIntf, findThreshold);
925
926 if (!ec)
927 {
928 if (lowerNonCriticalThreshMask)
929 {
930 auto findLower = findThreshold.find("WarningLow");
931 if (findLower == findThreshold.end())
932 {
933 return ipmi::responseInvalidFieldRequest();
934 }
935 thresholdsToSet.emplace_back("WarningLow", lowerNonCritical,
936 warningThreshIntf);
937 }
938 if (upperNonCriticalThreshMask)
939 {
940 auto findUpper = findThreshold.find("WarningHigh");
941 if (findUpper == findThreshold.end())
942 {
943 return ipmi::responseInvalidFieldRequest();
944 }
945 thresholdsToSet.emplace_back("WarningHigh", upperNonCritical,
946 warningThreshIntf);
947 }
948 }
949 }
950 for (const auto& property : thresholdsToSet)
951 {
952 // from section 36.3 in the IPMI Spec, assume all linear
953 double valueToSet =
954 ((info.coefficientM * std::get<thresholdValue>(property)) +
955 (info.scaledOffset * std::pow(10.0, info.scale))) *
956 std::pow(10.0, info.exponentR);
957 ipmi::setDbusProperty(
958 ctx, service, info.sensorPath, std::get<interface>(property),
959 std::get<propertyName>(property), ipmi::Value(valueToSet));
960 }
961
Lei YU14a47812021-09-17 15:58:04 +0800962 // Invalidate the cache
963 sensorThresholdMap.erase(sensorNum);
Lotus Xuf93da662021-10-18 17:20:06 +0800964 return ipmi::responseSuccess();
965}
966
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000967/** @brief implements the get SDR Info command
968 * @param count - Operation
969 *
970 * @returns IPMI completion code plus response data
971 * - sdrCount - sensor/SDR count
972 * - lunsAndDynamicPopulation - static/Dynamic sensor population flag
973 */
974ipmi::RspType<uint8_t, // respcount
975 uint8_t // dynamic population flags
976 >
977 ipmiSensorGetDeviceSdrInfo(std::optional<uint8_t> count)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700978{
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000979 uint8_t sdrCount;
980 // multiple LUNs not supported.
981 constexpr uint8_t lunsAndDynamicPopulation = 1;
982 constexpr uint8_t getSdrCount = 0x01;
983 constexpr uint8_t getSensorCount = 0x00;
984
985 if (count.value_or(0) == getSdrCount)
Emily Shafferd06e0e72017-04-05 09:08:57 -0700986 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000987 // Get SDR count. This returns the total number of SDRs in the device.
Patrick Venture87fd2cd2019-08-19 12:07:18 -0700988 const auto& entityRecords =
989 ipmi::sensor::EntityInfoMapContainer::getContainer()
990 ->getIpmiEntityRecords();
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700991 sdrCount =
992 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size();
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000993 }
994 else if (count.value_or(0) == getSensorCount)
995 {
996 // Get Sensor count. This returns the number of sensors
Patrick Venturedb0cbe62019-09-09 14:47:22 -0700997 sdrCount = ipmi::sensor::sensors.size();
Emily Shafferd06e0e72017-04-05 09:08:57 -0700998 }
999 else
1000 {
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001001 return ipmi::responseInvalidCommandOnLun();
Emily Shafferd06e0e72017-04-05 09:08:57 -07001002 }
1003
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001004 return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation);
Emily Shafferd06e0e72017-04-05 09:08:57 -07001005}
1006
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001007/** @brief implements the reserve SDR command
1008 * @returns IPMI completion code plus response data
1009 * - reservationID - reservation ID
1010 */
1011ipmi::RspType<uint16_t> ipmiSensorReserveSdr()
Emily Shaffera344afc2017-04-13 15:09:39 -07001012{
1013 // A constant reservation ID is okay until we implement add/remove SDR.
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001014 constexpr uint16_t reservationID = 1;
Emily Shaffera344afc2017-04-13 15:09:39 -07001015
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001016 return ipmi::responseSuccess(reservationID);
Emily Shaffera344afc2017-04-13 15:09:39 -07001017}
Chris Austenac4604a2015-10-13 12:43:27 -05001018
Patrick Venture0b02be92018-08-31 11:55:55 -07001019void setUnitFieldsForObject(const ipmi::sensor::Info* info,
1020 get_sdr::SensorDataFullRecordBody* body)
Emily Shaffercc941e12017-06-14 13:06:26 -07001021{
Tom Josephdc212b22018-02-16 09:59:57 +05301022 namespace server = sdbusplus::xyz::openbmc_project::Sensor::server;
1023 try
Emily Shaffercc941e12017-06-14 13:06:26 -07001024 {
Tom Josephdc212b22018-02-16 09:59:57 +05301025 auto unit = server::Value::convertUnitFromString(info->unit);
1026 // Unit strings defined in
1027 // phosphor-dbus-interfaces/xyz/openbmc_project/Sensor/Value.interface.yaml
1028 switch (unit)
Emily Shaffercc941e12017-06-14 13:06:26 -07001029 {
Tom Josephdc212b22018-02-16 09:59:57 +05301030 case server::Value::Unit::DegreesC:
1031 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_DEGREES_C;
1032 break;
1033 case server::Value::Unit::RPMS:
Kirill Pakhomov812e44c2018-10-22 16:25:35 +03001034 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_RPM;
Tom Josephdc212b22018-02-16 09:59:57 +05301035 break;
1036 case server::Value::Unit::Volts:
1037 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_VOLTS;
1038 break;
1039 case server::Value::Unit::Meters:
1040 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_METERS;
1041 break;
1042 case server::Value::Unit::Amperes:
1043 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_AMPERES;
1044 break;
1045 case server::Value::Unit::Joules:
1046 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_JOULES;
1047 break;
1048 case server::Value::Unit::Watts:
1049 body->sensor_units_2_base = get_sdr::SENSOR_UNIT_WATTS;
1050 break;
1051 default:
1052 // Cannot be hit.
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001053 std::fprintf(stderr, "Unknown value unit type: = %s\n",
1054 info->unit.c_str());
Emily Shaffercc941e12017-06-14 13:06:26 -07001055 }
1056 }
Patrick Venture64678b82018-10-13 13:11:32 -07001057 catch (const sdbusplus::exception::InvalidEnumString& e)
Emily Shaffercc941e12017-06-14 13:06:26 -07001058 {
Tom Josephdc212b22018-02-16 09:59:57 +05301059 log<level::WARNING>("Warning: no unit provided for sensor!");
Emily Shaffercc941e12017-06-14 13:06:26 -07001060 }
Emily Shaffercc941e12017-06-14 13:06:26 -07001061}
1062
Patrick Venture0b02be92018-08-31 11:55:55 -07001063ipmi_ret_t populate_record_from_dbus(get_sdr::SensorDataFullRecordBody* body,
1064 const ipmi::sensor::Info* info,
Willy Tu11d68892022-01-20 10:37:34 -08001065 ipmi_data_len_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001066{
1067 /* Functional sensor case */
Emily Shaffercc941e12017-06-14 13:06:26 -07001068 if (isAnalogSensor(info->propertyInterfaces.begin()->first))
Emily Shafferbbef71c2017-05-08 16:36:17 -07001069 {
Tony Leec5324252019-10-31 17:24:16 +08001070 body->sensor_units_1 = info->sensorUnits1; // default is 0. unsigned, no
1071 // rate, no modifier, not a %
Emily Shafferbbef71c2017-05-08 16:36:17 -07001072 /* Unit info */
Tom Josephdc212b22018-02-16 09:59:57 +05301073 setUnitFieldsForObject(info, body);
Emily Shaffer10f49592017-05-10 12:01:10 -07001074
1075 get_sdr::body::set_b(info->coefficientB, body);
1076 get_sdr::body::set_m(info->coefficientM, body);
1077 get_sdr::body::set_b_exp(info->exponentB, body);
Tom Josephdc212b22018-02-16 09:59:57 +05301078 get_sdr::body::set_r_exp(info->exponentR, body);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001079
Emily Shafferbbef71c2017-05-08 16:36:17 -07001080 get_sdr::body::set_id_type(0b00, body); // 00 = unicode
Emily Shafferbbef71c2017-05-08 16:36:17 -07001081 }
1082
Tom Joseph96423912018-01-25 00:14:34 +05301083 /* ID string */
Jeremy Kerrbe4ffa82020-08-10 16:17:37 +08001084 auto id_string = info->sensorName;
1085
1086 if (id_string.empty())
1087 {
1088 id_string = info->sensorNameFunc(*info);
1089 }
Tom Joseph96423912018-01-25 00:14:34 +05301090
1091 if (id_string.length() > FULL_RECORD_ID_STR_MAX_LENGTH)
1092 {
1093 get_sdr::body::set_id_strlen(FULL_RECORD_ID_STR_MAX_LENGTH, body);
1094 }
1095 else
1096 {
1097 get_sdr::body::set_id_strlen(id_string.length(), body);
1098 }
1099 strncpy(body->id_string, id_string.c_str(),
1100 get_sdr::body::get_id_strlen(body));
1101
Emily Shafferbbef71c2017-05-08 16:36:17 -07001102 return IPMI_CC_OK;
1103};
1104
Ratan Guptae0cc8552018-01-22 14:23:04 +05301105ipmi_ret_t ipmi_fru_get_sdr(ipmi_request_t request, ipmi_response_t response,
1106 ipmi_data_len_t data_len)
1107{
1108 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1109 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
Patrick Venture0b02be92018-08-31 11:55:55 -07001110 get_sdr::SensorDataFruRecord record{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301111 auto dataLength = 0;
1112
1113 auto fru = frus.begin();
Patrick Venture0b02be92018-08-31 11:55:55 -07001114 uint8_t fruID{};
Ratan Guptae0cc8552018-01-22 14:23:04 +05301115 auto recordID = get_sdr::request::get_record_id(req);
1116
1117 fruID = recordID - FRU_RECORD_ID_START;
1118 fru = frus.find(fruID);
1119 if (fru == frus.end())
1120 {
1121 return IPMI_CC_SENSOR_INVALID;
1122 }
1123
1124 /* Header */
1125 get_sdr::header::set_record_id(recordID, &(record.header));
1126 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1127 record.header.record_type = get_sdr::SENSOR_DATA_FRU_RECORD;
1128 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1129
1130 /* Key */
1131 record.key.fruID = fruID;
1132 record.key.accessLun |= IPMI_LOGICAL_FRU;
1133 record.key.deviceAddress = BMCSlaveAddress;
1134
1135 /* Body */
1136 record.body.entityID = fru->second[0].entityID;
1137 record.body.entityInstance = fru->second[0].entityInstance;
1138 record.body.deviceType = fruInventoryDevice;
1139 record.body.deviceTypeModifier = IPMIFruInventory;
1140
1141 /* Device ID string */
Patrick Venture0b02be92018-08-31 11:55:55 -07001142 auto deviceID =
1143 fru->second[0].path.substr(fru->second[0].path.find_last_of('/') + 1,
1144 fru->second[0].path.length());
Ratan Guptae0cc8552018-01-22 14:23:04 +05301145
1146 if (deviceID.length() > get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH)
1147 {
1148 get_sdr::body::set_device_id_strlen(
Patrick Venture0b02be92018-08-31 11:55:55 -07001149 get_sdr::FRU_RECORD_DEVICE_ID_MAX_LENGTH, &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301150 }
1151 else
1152 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001153 get_sdr::body::set_device_id_strlen(deviceID.length(), &(record.body));
Ratan Guptae0cc8552018-01-22 14:23:04 +05301154 }
1155
1156 strncpy(record.body.deviceID, deviceID.c_str(),
1157 get_sdr::body::get_device_id_strlen(&(record.body)));
1158
1159 if (++fru == frus.end())
1160 {
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001161 // we have reached till end of fru, so assign the next record id to
1162 // 512(Max fru ID = 511) + Entity Record ID(may start with 0).
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001163 const auto& entityRecords =
1164 ipmi::sensor::EntityInfoMapContainer::getContainer()
1165 ->getIpmiEntityRecords();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001166 auto next_record_id =
Patrick Venture83a0b842019-07-19 18:37:15 -07001167 (entityRecords.size())
1168 ? entityRecords.begin()->first + ENTITY_RECORD_ID_START
1169 : END_OF_RECORD;
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001170 get_sdr::response::set_next_record_id(next_record_id, resp);
1171 }
1172 else
1173 {
1174 get_sdr::response::set_next_record_id(
1175 (FRU_RECORD_ID_START + fru->first), resp);
1176 }
1177
1178 // Check for invalid offset size
1179 if (req->offset > sizeof(record))
1180 {
1181 return IPMI_CC_PARM_OUT_OF_RANGE;
1182 }
1183
1184 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1185 sizeof(record) - req->offset);
1186
1187 std::memcpy(resp->record_data,
1188 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
1189
1190 *data_len = dataLength;
1191 *data_len += 2; // additional 2 bytes for next record ID
1192
1193 return IPMI_CC_OK;
1194}
1195
1196ipmi_ret_t ipmi_entity_get_sdr(ipmi_request_t request, ipmi_response_t response,
1197 ipmi_data_len_t data_len)
1198{
1199 auto req = reinterpret_cast<get_sdr::GetSdrReq*>(request);
1200 auto resp = reinterpret_cast<get_sdr::GetSdrResp*>(response);
1201 get_sdr::SensorDataEntityRecord record{};
1202 auto dataLength = 0;
1203
Patrick Venture87fd2cd2019-08-19 12:07:18 -07001204 const auto& entityRecords =
1205 ipmi::sensor::EntityInfoMapContainer::getContainer()
1206 ->getIpmiEntityRecords();
Patrick Venture83a0b842019-07-19 18:37:15 -07001207 auto entity = entityRecords.begin();
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001208 uint8_t entityRecordID;
1209 auto recordID = get_sdr::request::get_record_id(req);
1210
1211 entityRecordID = recordID - ENTITY_RECORD_ID_START;
Patrick Venture83a0b842019-07-19 18:37:15 -07001212 entity = entityRecords.find(entityRecordID);
1213 if (entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001214 {
1215 return IPMI_CC_SENSOR_INVALID;
1216 }
1217
1218 /* Header */
1219 get_sdr::header::set_record_id(recordID, &(record.header));
1220 record.header.sdr_version = SDR_VERSION; // Based on IPMI Spec v2.0 rev 1.1
1221 record.header.record_type = get_sdr::SENSOR_DATA_ENTITY_RECORD;
1222 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1223
1224 /* Key */
1225 record.key.containerEntityId = entity->second.containerEntityId;
1226 record.key.containerEntityInstance = entity->second.containerEntityInstance;
1227 get_sdr::key::set_flags(entity->second.isList, entity->second.isLinked,
1228 &(record.key));
1229 record.key.entityId1 = entity->second.containedEntities[0].first;
1230 record.key.entityInstance1 = entity->second.containedEntities[0].second;
1231
1232 /* Body */
1233 record.body.entityId2 = entity->second.containedEntities[1].first;
1234 record.body.entityInstance2 = entity->second.containedEntities[1].second;
1235 record.body.entityId3 = entity->second.containedEntities[2].first;
1236 record.body.entityInstance3 = entity->second.containedEntities[2].second;
1237 record.body.entityId4 = entity->second.containedEntities[3].first;
1238 record.body.entityInstance4 = entity->second.containedEntities[3].second;
1239
Patrick Venture83a0b842019-07-19 18:37:15 -07001240 if (++entity == entityRecords.end())
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001241 {
Patrick Venture0b02be92018-08-31 11:55:55 -07001242 get_sdr::response::set_next_record_id(END_OF_RECORD,
1243 resp); // last record
Ratan Guptae0cc8552018-01-22 14:23:04 +05301244 }
1245 else
1246 {
1247 get_sdr::response::set_next_record_id(
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -08001248 (ENTITY_RECORD_ID_START + entity->first), resp);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301249 }
1250
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001251 // Check for invalid offset size
1252 if (req->offset > sizeof(record))
Ratan Guptae0cc8552018-01-22 14:23:04 +05301253 {
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001254 return IPMI_CC_PARM_OUT_OF_RANGE;
Ratan Guptae0cc8552018-01-22 14:23:04 +05301255 }
1256
Emily Shaffer0fbdbce2018-09-27 09:30:41 -07001257 dataLength = std::min(static_cast<size_t>(req->bytes_to_read),
1258 sizeof(record) - req->offset);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301259
Patrick Ventureb51bf9c2018-09-10 15:53:14 -07001260 std::memcpy(resp->record_data,
Jason M. Bills1cd85962018-10-05 12:04:01 -07001261 reinterpret_cast<uint8_t*>(&record) + req->offset, dataLength);
Ratan Guptae0cc8552018-01-22 14:23:04 +05301262
1263 *data_len = dataLength;
1264 *data_len += 2; // additional 2 bytes for next record ID
1265
1266 return IPMI_CC_OK;
1267}
1268
Willy Tu11d68892022-01-20 10:37:34 -08001269ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t request,
1270 ipmi_response_t response, ipmi_data_len_t data_len,
1271 ipmi_context_t)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001272{
1273 ipmi_ret_t ret = IPMI_CC_OK;
Patrick Venture0b02be92018-08-31 11:55:55 -07001274 get_sdr::GetSdrReq* req = (get_sdr::GetSdrReq*)request;
1275 get_sdr::GetSdrResp* resp = (get_sdr::GetSdrResp*)response;
Patrick Venture38426dd2019-07-30 15:22:29 -07001276
1277 // Note: we use an iterator so we can provide the next ID at the end of
1278 // the call.
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001279 auto sensor = ipmi::sensor::sensors.begin();
Patrick Venture38426dd2019-07-30 15:22:29 -07001280 auto recordID = get_sdr::request::get_record_id(req);
1281
1282 // At the beginning of a scan, the host side will send us id=0.
1283 if (recordID != 0)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001284 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001285 // recordID 0 to 255 means it is a FULL record.
1286 // recordID 256 to 511 means it is a FRU record.
1287 // recordID greater then 511 means it is a Entity Association
1288 // record. Currently we are supporting three record types: FULL
1289 // record, FRU record and Enttiy Association record.
1290 if (recordID >= ENTITY_RECORD_ID_START)
Emily Shafferbbef71c2017-05-08 16:36:17 -07001291 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001292 return ipmi_entity_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001293 }
Patrick Venture38426dd2019-07-30 15:22:29 -07001294 else if (recordID >= FRU_RECORD_ID_START &&
1295 recordID < ENTITY_RECORD_ID_START)
Jaghathiswari Rankappagounder Natarajan0780df12019-02-06 15:29:24 -08001296 {
Patrick Venture38426dd2019-07-30 15:22:29 -07001297 return ipmi_fru_get_sdr(request, response, data_len);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001298 }
1299 else
1300 {
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001301 sensor = ipmi::sensor::sensors.find(recordID);
1302 if (sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001303 {
1304 return IPMI_CC_SENSOR_INVALID;
1305 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001306 }
Emily Shafferbbef71c2017-05-08 16:36:17 -07001307 }
1308
Patrick Venture38426dd2019-07-30 15:22:29 -07001309 uint8_t sensor_id = sensor->first;
1310
Lei YU14a47812021-09-17 15:58:04 +08001311 auto it = sdrCacheMap.find(sensor_id);
1312 if (it == sdrCacheMap.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001313 {
Lei YU14a47812021-09-17 15:58:04 +08001314 /* Header */
Willy Tu11d68892022-01-20 10:37:34 -08001315 get_sdr::SensorDataFullRecord record = {};
Lei YU14a47812021-09-17 15:58:04 +08001316 get_sdr::header::set_record_id(sensor_id, &(record.header));
1317 record.header.sdr_version = 0x51; // Based on IPMI Spec v2.0 rev 1.1
1318 record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
1319 record.header.record_length = sizeof(record.key) + sizeof(record.body);
1320
1321 /* Key */
1322 get_sdr::key::set_owner_id_bmc(&(record.key));
1323 record.key.sensor_number = sensor_id;
1324
1325 /* Body */
1326 record.body.entity_id = sensor->second.entityType;
1327 record.body.sensor_type = sensor->second.sensorType;
1328 record.body.event_reading_type = sensor->second.sensorReadingType;
1329 record.body.entity_instance = sensor->second.instance;
1330 if (ipmi::sensor::Mutability::Write ==
1331 (sensor->second.mutability & ipmi::sensor::Mutability::Write))
1332 {
1333 get_sdr::body::init_settable_state(true, &(record.body));
1334 }
1335
1336 // Set the type-specific details given the DBus interface
1337 populate_record_from_dbus(&(record.body), &(sensor->second), data_len);
1338 sdrCacheMap[sensor_id] = std::move(record);
Patrick Venture38426dd2019-07-30 15:22:29 -07001339 }
1340
Lei YU14a47812021-09-17 15:58:04 +08001341 const auto& record = sdrCacheMap[sensor_id];
Patrick Venture38426dd2019-07-30 15:22:29 -07001342
Patrick Venturedb0cbe62019-09-09 14:47:22 -07001343 if (++sensor == ipmi::sensor::sensors.end())
Patrick Venture38426dd2019-07-30 15:22:29 -07001344 {
1345 // we have reached till end of sensor, so assign the next record id
1346 // to 256(Max Sensor ID = 255) + FRU ID(may start with 0).
1347 auto next_record_id = (frus.size())
1348 ? frus.begin()->first + FRU_RECORD_ID_START
1349 : END_OF_RECORD;
1350
1351 get_sdr::response::set_next_record_id(next_record_id, resp);
1352 }
1353 else
1354 {
1355 get_sdr::response::set_next_record_id(sensor->first, resp);
1356 }
1357
1358 if (req->offset > sizeof(record))
1359 {
1360 return IPMI_CC_PARM_OUT_OF_RANGE;
1361 }
1362
1363 // data_len will ultimately be the size of the record, plus
1364 // the size of the next record ID:
1365 *data_len = std::min(static_cast<size_t>(req->bytes_to_read),
1366 sizeof(record) - req->offset);
1367
1368 std::memcpy(resp->record_data,
Lei YU14a47812021-09-17 15:58:04 +08001369 reinterpret_cast<const uint8_t*>(&record) + req->offset,
1370 *data_len);
Patrick Venture38426dd2019-07-30 15:22:29 -07001371
1372 // data_len should include the LSB and MSB:
1373 *data_len +=
1374 sizeof(resp->next_record_id_lsb) + sizeof(resp->next_record_id_msb);
1375
Emily Shafferbbef71c2017-05-08 16:36:17 -07001376 return ret;
1377}
1378
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001379static bool isFromSystemChannel()
1380{
1381 // TODO we could not figure out where the request is from based on IPMI
1382 // command handler parameters. because of it, we can not differentiate
1383 // request from SMS/SMM or IPMB channel
1384 return true;
1385}
1386
Willy Tu11d68892022-01-20 10:37:34 -08001387ipmi_ret_t ipmicmdPlatformEvent(ipmi_netfn_t, ipmi_cmd_t,
1388 ipmi_request_t request, ipmi_response_t,
1389 ipmi_data_len_t dataLen, ipmi_context_t)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001390{
1391 uint16_t generatorID;
1392 size_t count;
1393 bool assert = true;
1394 std::string sensorPath;
1395 size_t paraLen = *dataLen;
1396 PlatformEventRequest* req;
1397 *dataLen = 0;
1398
1399 if ((paraLen < selSystemEventSizeWith1Bytes) ||
1400 (paraLen > selSystemEventSizeWith3Bytes))
1401 {
1402 return IPMI_CC_REQ_DATA_LEN_INVALID;
1403 }
1404
1405 if (isFromSystemChannel())
1406 { // first byte for SYSTEM Interface is Generator ID
1407 // +1 to get common struct
1408 req = reinterpret_cast<PlatformEventRequest*>((uint8_t*)request + 1);
1409 // Capture the generator ID
1410 generatorID = *reinterpret_cast<uint8_t*>(request);
1411 // Platform Event usually comes from other firmware, like BIOS.
1412 // Unlike BMC sensor, it does not have BMC DBUS sensor path.
1413 sensorPath = "System";
1414 }
1415 else
1416 {
1417 req = reinterpret_cast<PlatformEventRequest*>(request);
1418 // TODO GenratorID for IPMB is combination of RqSA and RqLUN
1419 generatorID = 0xff;
1420 sensorPath = "IPMB";
1421 }
1422 // Content of event data field depends on sensor class.
1423 // When data0 bit[5:4] is non-zero, valid data counts is 3.
1424 // When data0 bit[7:6] is non-zero, valid data counts is 2.
1425 if (((req->data[0] & byte3EnableMask) != 0 &&
1426 paraLen < selSystemEventSizeWith3Bytes) ||
1427 ((req->data[0] & byte2EnableMask) != 0 &&
1428 paraLen < selSystemEventSizeWith2Bytes))
1429 {
1430 return IPMI_CC_REQ_DATA_LEN_INVALID;
1431 }
1432
1433 // Count bytes of Event Data
1434 if ((req->data[0] & byte3EnableMask) != 0)
1435 {
1436 count = 3;
1437 }
1438 else if ((req->data[0] & byte2EnableMask) != 0)
1439 {
1440 count = 2;
1441 }
1442 else
1443 {
1444 count = 1;
1445 }
1446 assert = req->eventDirectionType & directionMask ? false : true;
1447 std::vector<uint8_t> eventData(req->data, req->data + count);
1448
1449 sdbusplus::bus::bus dbus(bus);
1450 std::string service =
1451 ipmi::getService(dbus, ipmiSELAddInterface, ipmiSELPath);
1452 sdbusplus::message::message writeSEL = dbus.new_method_call(
1453 service.c_str(), ipmiSELPath, ipmiSELAddInterface, "IpmiSelAdd");
1454 writeSEL.append(ipmiSELAddMessage, sensorPath, eventData, assert,
1455 generatorID);
1456 try
1457 {
1458 dbus.call(writeSEL);
1459 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001460 catch (const sdbusplus::exception_t& e)
Jia, Chunhui3342a8e2018-12-29 13:32:26 +08001461 {
1462 phosphor::logging::log<phosphor::logging::level::ERR>(e.what());
1463 return IPMI_CC_UNSPECIFIED_ERROR;
1464 }
1465 return IPMI_CC_OK;
1466}
1467
Chris Austenac4604a2015-10-13 12:43:27 -05001468void register_netfn_sen_functions()
1469{
Willy Tud351a722021-08-12 14:33:40 -07001470 // Handlers with dbus-sdr handler implementation.
1471 // Do not register the hander if it dynamic sensors stack is used.
Deepak Kumar Sahua8be7dc2019-05-07 14:26:53 +00001472
Willy Tud351a722021-08-12 14:33:40 -07001473#ifndef FEATURE_DYNAMIC_SENSORS
Lei YUbe5c6b22021-09-16 15:46:20 +08001474
Lei YU962e68b2021-09-16 16:25:34 +08001475#ifdef FEATURE_SENSORS_CACHE
Lei YUbe5c6b22021-09-16 15:46:20 +08001476 // Initialize the sensor matches
1477 initSensorMatches();
Lei YU962e68b2021-09-16 16:25:34 +08001478#endif
Lei YUbe5c6b22021-09-16 15:46:20 +08001479
Tom05732372016-09-06 17:21:23 +05301480 // <Set Sensor Reading and Event Status>
Deepak Kumar Sahu9da3a752019-05-21 00:45:14 +00001481 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1482 ipmi::sensor_event::cmdSetSensorReadingAndEvtSts,
1483 ipmi::Privilege::Operator, ipmiSetSensorReading);
Tom05732372016-09-06 17:21:23 +05301484 // <Get Sensor Reading>
jayaprakash Mutyala4c3feba2019-07-16 00:14:35 +00001485 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1486 ipmi::sensor_event::cmdGetSensorReading,
1487 ipmi::Privilege::User, ipmiSensorGetSensorReading);
Emily Shaffera344afc2017-04-13 15:09:39 -07001488
Tom Joseph5ca50952018-02-22 00:33:38 +05301489 // <Reserve Device SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001490 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1491 ipmi::sensor_event::cmdReserveDeviceSdrRepository,
1492 ipmi::Privilege::User, ipmiSensorReserveSdr);
Chris Austen10ccc0f2015-12-10 18:27:04 -06001493
Tom Joseph5ca50952018-02-22 00:33:38 +05301494 // <Get Device SDR Info>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +00001495 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1496 ipmi::sensor_event::cmdGetDeviceSdrInfo,
1497 ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo);
Emily Shafferbbef71c2017-05-08 16:36:17 -07001498
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001499 // <Get Sensor Thresholds>
jayaprakash Mutyala996c9792019-05-03 15:56:48 +00001500 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1501 ipmi::sensor_event::cmdGetSensorThreshold,
1502 ipmi::Privilege::User, ipmiSensorGetSensorThresholds);
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -06001503
Lotus Xuf93da662021-10-18 17:20:06 +08001504 // <Set Sensor Thresholds>
1505 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1506 ipmi::sensor_event::cmdSetSensorThreshold,
1507 ipmi::Privilege::User, ipmiSenSetSensorThresholds);
Vivekanand Veeracholand3d2fe22021-11-12 19:40:42 -08001508
1509 // <Get Device SDR>
1510 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_GET_DEVICE_SDR, nullptr,
1511 ipmi_sen_get_sdr, PRIVILEGE_USER);
1512
Willy Tud351a722021-08-12 14:33:40 -07001513#endif
1514
1515 // Common Handers used by both implementation.
1516
1517 // <Platform Event Message>
1518 ipmi_register_callback(NETFUN_SENSOR, IPMI_CMD_PLATFORM_EVENT, nullptr,
1519 ipmicmdPlatformEvent, PRIVILEGE_OPERATOR);
1520
1521 // <Get Sensor Type>
1522 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
1523 ipmi::sensor_event::cmdGetSensorType,
1524 ipmi::Privilege::User, ipmiGetSensorType);
1525
Chris Austenac4604a2015-10-13 12:43:27 -05001526 return;
1527}