blob: c9cf08dabebfa683e4007aa500f427f75ea21bd5 [file] [log] [blame]
Patrick Williams768730d2023-09-06 16:27:20 -05001#include "config.h"
2
Patrick Venture3a5071a2018-09-12 13:27:42 -07003#include "fruread.hpp"
4#include "read_fru_data.hpp"
5#include "selutility.hpp"
6#include "sensorhandler.hpp"
7#include "storageaddsel.hpp"
Patrick Venture3a5071a2018-09-12 13:27:42 -07008
Lei YU52d91242017-10-17 22:52:28 +08009#include <arpa/inet.h>
Patrick Venture3a5071a2018-09-12 13:27:42 -070010#include <systemd/sd-bus.h>
Patrick Venture0b02be92018-08-31 11:55:55 -070011
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050012#include <ipmid/api.hpp>
Vernon Mauery9cf08382023-04-28 14:00:11 -070013#include <ipmid/entity_map_json.hpp>
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050014#include <ipmid/utils.hpp>
15#include <phosphor-logging/elog-errors.hpp>
16#include <phosphor-logging/elog.hpp>
George Liu51856e62024-07-17 19:46:03 +080017#include <phosphor-logging/lg2.hpp>
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050018#include <sdbusplus/server.hpp>
19#include <xyz/openbmc_project/Common/error.hpp>
20#include <xyz/openbmc_project/Logging/SEL/error.hpp>
21
Patrick Venture0b02be92018-08-31 11:55:55 -070022#include <algorithm>
Lei YU52d91242017-10-17 22:52:28 +080023#include <chrono>
24#include <cstdio>
Patrick Ventureb51bf9c2018-09-10 15:53:14 -070025#include <cstring>
Vernon Mauerybdda8002019-02-26 10:18:51 -080026#include <filesystem>
Lei YUa0bb2a32021-09-24 11:03:56 +080027#include <optional>
Patrick Venture3a5071a2018-09-12 13:27:42 -070028#include <string>
Vernon Mauery16b86932019-05-01 08:36:11 -070029#include <variant>
Patrick Venture3a5071a2018-09-12 13:27:42 -070030
George Liu5087b072025-03-11 19:28:17 +080031void registerNetFnStorageFunctions() __attribute__((constructor));
Chris Austenb4f5b922015-10-13 12:44:43 -050032
Patrick Venture0b02be92018-08-31 11:55:55 -070033unsigned int g_sel_time = 0xFFFFFFFF;
Patrick Venturedb0cbe62019-09-09 14:47:22 -070034namespace ipmi
35{
36namespace sensor
37{
38extern const IdInfoMap sensors;
39} // namespace sensor
40} // namespace ipmi
Lotus Xu57d35572021-01-24 11:13:13 +080041extern const ipmi::sensor::InvObjectIDMap invSensors;
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -060042extern const FruMap frus;
anil kumar appana2c7db1d2019-05-28 11:20:19 +000043constexpr uint8_t eventDataSize = 3;
Patrick Venture0b02be92018-08-31 11:55:55 -070044namespace
45{
shamim ali071d00c2022-03-02 15:42:46 +053046constexpr auto SystemdTimeService = "org.freedesktop.timedate1";
47constexpr auto SystemdTimePath = "/org/freedesktop/timedate1";
48constexpr auto SystemdTimeInterface = "org.freedesktop.timedate1";
49
Lei YUe8939392017-06-15 10:45:05 +080050constexpr auto TIME_INTERFACE = "xyz.openbmc_project.Time.EpochTime";
George Liu4d623e92020-05-25 16:51:57 +080051constexpr auto BMC_TIME_PATH = "/xyz/openbmc_project/time/bmc";
Lei YUe8939392017-06-15 10:45:05 +080052constexpr auto DBUS_PROPERTIES = "org.freedesktop.DBus.Properties";
Patrick Venture0b02be92018-08-31 11:55:55 -070053constexpr auto PROPERTY_ELAPSED = "Elapsed";
Patrick Venture0b02be92018-08-31 11:55:55 -070054} // namespace
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +053055
Tom Joseph6f7deaa2017-06-30 19:03:54 +053056using InternalFailure =
Willy Tu523e2d12023-09-05 11:36:48 -070057 sdbusplus::error::xyz::openbmc_project::common::InternalFailure;
Tom Joseph6f7deaa2017-06-30 19:03:54 +053058using namespace phosphor::logging;
Marri Devender Raocac383b2017-07-03 13:24:27 -050059using namespace ipmi::fru;
Willy Tu523e2d12023-09-05 11:36:48 -070060using namespace xyz::openbmc_project::logging::sel;
Lotus Xu57d35572021-01-24 11:13:13 +080061using SELCreated =
Willy Tu523e2d12023-09-05 11:36:48 -070062 sdbusplus::error::xyz::openbmc_project::logging::sel::Created;
Marri Devender Raocac383b2017-07-03 13:24:27 -050063
Lei YUd9e57662021-09-14 18:06:28 +080064using SELRecordID = uint16_t;
65using SELEntry = ipmi::sel::SELEventRecordFormat;
66using SELCacheMap = std::map<SELRecordID, SELEntry>;
67
68SELCacheMap selCacheMap __attribute__((init_priority(101)));
Lei YU3df36612021-09-15 11:41:11 +080069bool selCacheMapInitialized;
Patrick Williams5d82f472022-07-22 19:26:53 -050070std::unique_ptr<sdbusplus::bus::match_t> selAddedMatch
Lei YUd9555252021-09-14 20:30:41 +080071 __attribute__((init_priority(101)));
Patrick Williams5d82f472022-07-22 19:26:53 -050072std::unique_ptr<sdbusplus::bus::match_t> selRemovedMatch
Lei YUb6b72b02021-09-14 21:06:05 +080073 __attribute__((init_priority(101)));
Patrick Williams5d82f472022-07-22 19:26:53 -050074std::unique_ptr<sdbusplus::bus::match_t> selUpdatedMatch
Lei YU4106e422021-09-15 10:55:51 +080075 __attribute__((init_priority(101)));
Lei YUd9e57662021-09-14 18:06:28 +080076
Lei YUb6b72b02021-09-14 21:06:05 +080077static inline uint16_t getLoggingId(const std::string& p)
Lei YUd9e57662021-09-14 18:06:28 +080078{
79 namespace fs = std::filesystem;
80 fs::path entryPath(p);
Lei YUb6b72b02021-09-14 21:06:05 +080081 return std::stoul(entryPath.filename().string());
82}
83
Lei YUeba8e9a2021-09-15 13:16:17 +080084static inline std::string getLoggingObjPath(uint16_t id)
85{
86 return std::string(ipmi::sel::logBasePath) + "/" + std::to_string(id);
87}
88
Patrick Williams69b4c282025-03-03 11:19:13 -050089std::optional<std::pair<uint16_t, SELEntry>> parseLoggingEntry(
90 const std::string& p)
Lei YUb6b72b02021-09-14 21:06:05 +080091{
Lei YU3df36612021-09-15 11:41:11 +080092 try
93 {
Lei YUa0bb2a32021-09-24 11:03:56 +080094 auto id = getLoggingId(p);
95 ipmi::sel::GetSELEntryResponse record{};
Lei YU3df36612021-09-15 11:41:11 +080096 record = ipmi::sel::convertLogEntrytoSEL(p);
Lei YUa0bb2a32021-09-24 11:03:56 +080097 return std::pair<uint16_t, SELEntry>({id, std::move(record.event)});
Lei YU3df36612021-09-15 11:41:11 +080098 }
99 catch (const std::exception& e)
100 {
101 fprintf(stderr, "Failed to convert %s to SEL: %s\n", p.c_str(),
102 e.what());
103 }
Lei YUa0bb2a32021-09-24 11:03:56 +0800104 return std::nullopt;
Lei YUd9e57662021-09-14 18:06:28 +0800105}
106
Patrick Williams5d82f472022-07-22 19:26:53 -0500107static void selAddedCallback(sdbusplus::message_t& m)
Lei YUd9555252021-09-14 20:30:41 +0800108{
109 sdbusplus::message::object_path objPath;
110 try
111 {
112 m.read(objPath);
113 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500114 catch (const sdbusplus::exception_t& e)
Lei YUd9555252021-09-14 20:30:41 +0800115 {
George Liu51856e62024-07-17 19:46:03 +0800116 lg2::error("Failed to read object path");
Lei YUd9555252021-09-14 20:30:41 +0800117 return;
118 }
119 std::string p = objPath;
Lei YUa0bb2a32021-09-24 11:03:56 +0800120 auto entry = parseLoggingEntry(p);
121 if (entry)
122 {
123 selCacheMap.insert(std::move(*entry));
124 }
Lei YUd9555252021-09-14 20:30:41 +0800125}
126
Patrick Williams5d82f472022-07-22 19:26:53 -0500127static void selRemovedCallback(sdbusplus::message_t& m)
Lei YUb6b72b02021-09-14 21:06:05 +0800128{
129 sdbusplus::message::object_path objPath;
130 try
131 {
132 m.read(objPath);
133 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500134 catch (const sdbusplus::exception_t& e)
Lei YUb6b72b02021-09-14 21:06:05 +0800135 {
George Liu51856e62024-07-17 19:46:03 +0800136 lg2::error("Failed to read object path");
Lei YUb6b72b02021-09-14 21:06:05 +0800137 }
Lei YUa0bb2a32021-09-24 11:03:56 +0800138 try
139 {
140 std::string p = objPath;
141 selCacheMap.erase(getLoggingId(p));
142 }
143 catch (const std::invalid_argument& e)
144 {
George Liu51856e62024-07-17 19:46:03 +0800145 lg2::error("Invalid logging entry ID");
Lei YUa0bb2a32021-09-24 11:03:56 +0800146 }
Lei YUb6b72b02021-09-14 21:06:05 +0800147}
148
Patrick Williams5d82f472022-07-22 19:26:53 -0500149static void selUpdatedCallback(sdbusplus::message_t& m)
Lei YU4106e422021-09-15 10:55:51 +0800150{
151 std::string p = m.get_path();
152 auto entry = parseLoggingEntry(p);
Lei YUa0bb2a32021-09-24 11:03:56 +0800153 if (entry)
154 {
155 selCacheMap.insert_or_assign(entry->first, std::move(entry->second));
156 }
Lei YU4106e422021-09-15 10:55:51 +0800157}
158
Lei YUd9555252021-09-14 20:30:41 +0800159void registerSelCallbackHandler()
160{
161 using namespace sdbusplus::bus::match::rules;
Patrick Williams5d82f472022-07-22 19:26:53 -0500162 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lei YUd9555252021-09-14 20:30:41 +0800163 if (!selAddedMatch)
164 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500165 selAddedMatch = std::make_unique<sdbusplus::bus::match_t>(
George Liu656ae3c2024-08-23 16:44:22 +0800166 bus, interfacesAdded(ipmi::sel::logWatchPath),
Lei YUd9555252021-09-14 20:30:41 +0800167 std::bind(selAddedCallback, std::placeholders::_1));
168 }
Lei YUb6b72b02021-09-14 21:06:05 +0800169 if (!selRemovedMatch)
170 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500171 selRemovedMatch = std::make_unique<sdbusplus::bus::match_t>(
George Liu656ae3c2024-08-23 16:44:22 +0800172 bus, interfacesRemoved(ipmi::sel::logWatchPath),
Lei YUb6b72b02021-09-14 21:06:05 +0800173 std::bind(selRemovedCallback, std::placeholders::_1));
174 }
Lei YU4106e422021-09-15 10:55:51 +0800175 if (!selUpdatedMatch)
176 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500177 selUpdatedMatch = std::make_unique<sdbusplus::bus::match_t>(
Lei YU4106e422021-09-15 10:55:51 +0800178 bus,
179 type::signal() + member("PropertiesChanged"s) +
180 interface("org.freedesktop.DBus.Properties"s) +
George Liu656ae3c2024-08-23 16:44:22 +0800181 argN(0, ipmi::sel::logEntryIntf),
Lei YU4106e422021-09-15 10:55:51 +0800182 std::bind(selUpdatedCallback, std::placeholders::_1));
183 }
Lei YUd9555252021-09-14 20:30:41 +0800184}
185
Lei YUd9e57662021-09-14 18:06:28 +0800186void initSELCache()
187{
Lei YUc10cda12022-01-06 16:01:57 +0800188 registerSelCallbackHandler();
Lei YUeba8e9a2021-09-15 13:16:17 +0800189 ipmi::sel::ObjectPaths paths;
Lei YUd9e57662021-09-14 18:06:28 +0800190 try
191 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800192 ipmi::sel::readLoggingObjectPaths(paths);
Lei YUd9e57662021-09-14 18:06:28 +0800193 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500194 catch (const sdbusplus::exception_t& e)
Lei YUd9e57662021-09-14 18:06:28 +0800195 {
George Liu51856e62024-07-17 19:46:03 +0800196 lg2::error("Failed to get logging object paths");
Lei YUd9e57662021-09-14 18:06:28 +0800197 return;
198 }
Lei YUeba8e9a2021-09-15 13:16:17 +0800199 for (const auto& p : paths)
Lei YUd9e57662021-09-14 18:06:28 +0800200 {
Lei YUa0bb2a32021-09-24 11:03:56 +0800201 auto entry = parseLoggingEntry(p);
202 if (entry)
203 {
204 selCacheMap.insert(std::move(*entry));
205 }
Lei YUd9e57662021-09-14 18:06:28 +0800206 }
Lei YU3df36612021-09-15 11:41:11 +0800207 selCacheMapInitialized = true;
Lei YUd9e57662021-09-14 18:06:28 +0800208}
209
Marri Devender Raocac383b2017-07-03 13:24:27 -0500210/**
211 * @enum Device access mode
212 */
213enum class AccessMode
214{
215 bytes, ///< Device is accessed by bytes
216 words ///< Device is accessed by words
217};
218
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000219/** @brief implements the get SEL Info command
220 * @returns IPMI completion code plus response data
221 * - selVersion - SEL revision
222 * - entries - Number of log entries in SEL.
223 * - freeSpace - Free Space in bytes.
224 * - addTimeStamp - Most recent addition timestamp
225 * - eraseTimeStamp - Most recent erase timestamp
226 * - operationSupport - Reserve & Delete SEL operations supported
227 */
228
229ipmi::RspType<uint8_t, // SEL revision.
230 uint16_t, // number of log entries in SEL.
231 uint16_t, // free Space in bytes.
232 uint32_t, // most recent addition timestamp
233 uint32_t, // most recent erase timestamp.
234
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500235 bool, // SEL allocation info supported
236 bool, // reserve SEL supported
237 bool, // partial Add SEL Entry supported
238 bool, // delete SEL supported
239 uint3_t, // reserved
240 bool // overflow flag
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000241 >
242 ipmiStorageGetSelInfo()
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530243{
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000244 uint16_t entries = 0;
245 // Most recent addition timestamp.
246 uint32_t addTimeStamp = ipmi::sel::invalidTimeStamp;
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530247
Lei YUeba8e9a2021-09-15 13:16:17 +0800248 if (!selCacheMapInitialized)
Tom Josephe59abfb2018-08-06 18:46:27 +0530249 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800250 // In case the initSELCache() fails, try it again
251 initSELCache();
Tom Josephe59abfb2018-08-06 18:46:27 +0530252 }
Lei YUeba8e9a2021-09-15 13:16:17 +0800253 if (!selCacheMap.empty())
Tom Josephe59abfb2018-08-06 18:46:27 +0530254 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800255 entries = static_cast<uint16_t>(selCacheMap.size());
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530256
257 try
258 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800259 auto objPath = getLoggingObjPath(selCacheMap.rbegin()->first);
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000260 addTimeStamp = static_cast<uint32_t>(
Lei YUeba8e9a2021-09-15 13:16:17 +0800261 (ipmi::sel::getEntryTimeStamp(objPath).count()));
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530262 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500263 catch (const InternalFailure& e)
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500264 {}
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530265 catch (const std::runtime_error& e)
266 {
George Liu51856e62024-07-17 19:46:03 +0800267 lg2::error("runtime error: {ERROR}", "ERROR", e);
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530268 }
269 }
270
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000271 constexpr uint8_t selVersion = ipmi::sel::selVersion;
272 constexpr uint16_t freeSpace = 0xFFFF;
273 constexpr uint32_t eraseTimeStamp = ipmi::sel::invalidTimeStamp;
274 constexpr uint3_t reserved{0};
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530275
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000276 return ipmi::responseSuccess(
277 selVersion, entries, freeSpace, addTimeStamp, eraseTimeStamp,
278 ipmi::sel::operationSupport::getSelAllocationInfo,
279 ipmi::sel::operationSupport::reserveSel,
280 ipmi::sel::operationSupport::partialAddSelEntry,
281 ipmi::sel::operationSupport::deleteSel, reserved,
282 ipmi::sel::operationSupport::overflow);
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530283}
284
George Liue7592702025-07-03 15:48:02 +0800285ipmi::RspType<uint16_t, // Next Record ID
286 std::vector<uint8_t> // SEL data
287 >
288 getSELEntry(uint16_t reservationID, uint16_t selRecordID, uint8_t offset,
289 uint8_t readLength)
Tom Josepha4953392017-06-30 19:09:47 +0530290{
George Liue7592702025-07-03 15:48:02 +0800291 if (reservationID != 0)
Jason M. Bills851acb12019-02-04 14:06:57 -0800292 {
George Liue7592702025-07-03 15:48:02 +0800293 if (!checkSELReservation(reservationID))
Tom Josepha4953392017-06-30 19:09:47 +0530294 {
George Liue7592702025-07-03 15:48:02 +0800295 return ipmi::responseInvalidReservationId();
Tom Josepha4953392017-06-30 19:09:47 +0530296 }
297 }
298
Lei YU3df36612021-09-15 11:41:11 +0800299 if (!selCacheMapInitialized)
300 {
301 // In case the initSELCache() fails, try it again
302 initSELCache();
303 }
304
305 if (selCacheMap.empty())
Tom Josepha4953392017-06-30 19:09:47 +0530306 {
George Liue7592702025-07-03 15:48:02 +0800307 return ipmi::responseSensorInvalid();
Tom Josepha4953392017-06-30 19:09:47 +0530308 }
309
Lei YU3df36612021-09-15 11:41:11 +0800310 SELCacheMap::const_iterator iter;
Tom Josepha4953392017-06-30 19:09:47 +0530311
312 // Check for the requested SEL Entry.
George Liue7592702025-07-03 15:48:02 +0800313 if (selRecordID == ipmi::sel::firstEntry)
Tom Josepha4953392017-06-30 19:09:47 +0530314 {
Lei YU3df36612021-09-15 11:41:11 +0800315 iter = selCacheMap.begin();
Tom Josepha4953392017-06-30 19:09:47 +0530316 }
George Liue7592702025-07-03 15:48:02 +0800317 else if (selRecordID == ipmi::sel::lastEntry)
Tom Josepha4953392017-06-30 19:09:47 +0530318 {
Lei YU3df36612021-09-15 11:41:11 +0800319 if (selCacheMap.size() > 1)
320 {
321 iter = selCacheMap.end();
322 --iter;
323 }
324 else
325 {
326 // Only one entry exists, return the first
327 iter = selCacheMap.begin();
328 }
Tom Josepha4953392017-06-30 19:09:47 +0530329 }
330 else
331 {
George Liue7592702025-07-03 15:48:02 +0800332 iter = selCacheMap.find(selRecordID);
Lei YU3df36612021-09-15 11:41:11 +0800333 if (iter == selCacheMap.end())
Tom Josepha4953392017-06-30 19:09:47 +0530334 {
George Liue7592702025-07-03 15:48:02 +0800335 return ipmi::responseSensorInvalid();
Tom Josepha4953392017-06-30 19:09:47 +0530336 }
337 }
338
Lei YU3df36612021-09-15 11:41:11 +0800339 ipmi::sel::GetSELEntryResponse record{0, iter->second};
Tom Josepha4953392017-06-30 19:09:47 +0530340 // Identify the next SEL record ID
Lei YU3df36612021-09-15 11:41:11 +0800341 ++iter;
342 if (iter == selCacheMap.end())
Tom Josepha4953392017-06-30 19:09:47 +0530343 {
Lei YU3df36612021-09-15 11:41:11 +0800344 record.nextRecordID = ipmi::sel::lastEntry;
Tom Josepha4953392017-06-30 19:09:47 +0530345 }
346 else
347 {
Lei YU3df36612021-09-15 11:41:11 +0800348 record.nextRecordID = iter->first;
Tom Josepha4953392017-06-30 19:09:47 +0530349 }
350
George Liue7592702025-07-03 15:48:02 +0800351 uint16_t nextRecordID = record.nextRecordID;
352 std::vector<uint8_t> buffer;
353 if (readLength == ipmi::sel::entireRecord)
Tom Josepha4953392017-06-30 19:09:47 +0530354 {
George Liue7592702025-07-03 15:48:02 +0800355 buffer.resize(sizeof(record));
356 std::memcpy(buffer.data(), &record.event, sizeof(record.event));
Tom Josepha4953392017-06-30 19:09:47 +0530357 }
358 else
359 {
George Liue7592702025-07-03 15:48:02 +0800360 if (offset >= ipmi::sel::selRecordSize ||
361 readLength > ipmi::sel::selRecordSize)
Tom Josepha4953392017-06-30 19:09:47 +0530362 {
George Liue7592702025-07-03 15:48:02 +0800363 return ipmi::responseInvalidFieldRequest();
Tom Josepha4953392017-06-30 19:09:47 +0530364 }
365
George Liue7592702025-07-03 15:48:02 +0800366 auto diff = ipmi::sel::selRecordSize - offset;
367 auto minReadLength = std::min(diff, static_cast<int>(readLength));
Tom Josepha4953392017-06-30 19:09:47 +0530368
George Liue7592702025-07-03 15:48:02 +0800369 buffer.resize(minReadLength);
Lei YU3ad19712025-01-27 05:23:03 +0000370 const ipmi::sel::SELEventRecordFormat* evt = &record.event;
George Liue7592702025-07-03 15:48:02 +0800371 std::memcpy(buffer.data(),
372 reinterpret_cast<const uint8_t*>(evt) + offset,
373 minReadLength);
Tom Josepha4953392017-06-30 19:09:47 +0530374 }
375
George Liue7592702025-07-03 15:48:02 +0800376 return ipmi::responseSuccess(nextRecordID, buffer);
Tom Josepha4953392017-06-30 19:09:47 +0530377}
378
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000379/** @brief implements the delete SEL entry command
380 * @request
381 * - reservationID; // reservation ID.
382 * - selRecordID; // SEL record ID.
383 *
384 * @returns ipmi completion code plus response data
385 * - Record ID of the deleted record
386 */
387ipmi::RspType<uint16_t // deleted record ID
388 >
389 deleteSELEntry(uint16_t reservationID, uint16_t selRecordID)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530390{
Brad Bishop1a4117b2018-11-21 15:48:18 -0500391 namespace fs = std::filesystem;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530392
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000393 if (!checkSELReservation(reservationID))
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530394 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000395 return ipmi::responseInvalidReservationId();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530396 }
397
Jason M. Bills13e67c82018-09-10 14:12:16 -0700398 // Per the IPMI spec, need to cancel the reservation when a SEL entry is
399 // deleted
400 cancelSELReservation();
401
Lei YUeba8e9a2021-09-15 13:16:17 +0800402 if (!selCacheMapInitialized)
Tom Josephe59abfb2018-08-06 18:46:27 +0530403 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800404 // In case the initSELCache() fails, try it again
405 initSELCache();
Tom Josephe59abfb2018-08-06 18:46:27 +0530406 }
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530407
Lei YUeba8e9a2021-09-15 13:16:17 +0800408 if (selCacheMap.empty())
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530409 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000410 return ipmi::responseSensorInvalid();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530411 }
412
Lei YUeba8e9a2021-09-15 13:16:17 +0800413 SELCacheMap::const_iterator iter;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530414 uint16_t delRecordID = 0;
415
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000416 if (selRecordID == ipmi::sel::firstEntry)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530417 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800418 delRecordID = selCacheMap.begin()->first;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530419 }
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000420 else if (selRecordID == ipmi::sel::lastEntry)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530421 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800422 delRecordID = selCacheMap.rbegin()->first;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530423 }
424 else
425 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000426 delRecordID = selRecordID;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530427 }
428
Jian7d5f4812022-02-23 19:30:27 +0800429 iter = selCacheMap.find(delRecordID);
430 if (iter == selCacheMap.end())
431 {
432 return ipmi::responseSensorInvalid();
433 }
434
Patrick Williams5d82f472022-07-22 19:26:53 -0500435 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530436 std::string service;
437
Lei YUeba8e9a2021-09-15 13:16:17 +0800438 auto objPath = getLoggingObjPath(iter->first);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530439 try
440 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800441 service = ipmi::getService(bus, ipmi::sel::logDeleteIntf, objPath);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530442 }
443 catch (const std::runtime_error& e)
444 {
George Liu51856e62024-07-17 19:46:03 +0800445 lg2::error("runtime error: {ERROR}", "ERROR", e);
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000446 return ipmi::responseUnspecifiedError();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530447 }
448
Lei YUeba8e9a2021-09-15 13:16:17 +0800449 auto methodCall = bus.new_method_call(service.c_str(), objPath.c_str(),
Patrick Venture0b02be92018-08-31 11:55:55 -0700450 ipmi::sel::logDeleteIntf, "Delete");
George Liu3e3cc352023-07-26 15:59:31 +0800451 try
452 {
453 auto reply = bus.call(methodCall);
454 }
455 catch (const std::exception& e)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530456 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000457 return ipmi::responseUnspecifiedError();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530458 }
459
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000460 return ipmi::responseSuccess(delRecordID);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530461}
462
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000463/** @brief implements the Clear SEL command
464 * @request
465 * - reservationID // Reservation ID.
466 * - clr // char array { 'C'(0x43h), 'L'(0x4Ch), 'R'(0x52h) }
467 * - eraseOperation; // requested operation.
468 *
469 * @returns ipmi completion code plus response data
470 * - erase status
471 */
472
473ipmi::RspType<uint8_t // erase status
474 >
475 clearSEL(uint16_t reservationID, const std::array<char, 3>& clr,
476 uint8_t eraseOperation)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530477{
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000478 static constexpr std::array<char, 3> clrOk = {'C', 'L', 'R'};
479 if (clr != clrOk)
Jason M. Bills851acb12019-02-04 14:06:57 -0800480 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000481 return ipmi::responseInvalidFieldRequest();
Jason M. Bills851acb12019-02-04 14:06:57 -0800482 }
483
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000484 if (!checkSELReservation(reservationID))
Tom Joseph2f05bb52017-06-30 19:14:49 +0530485 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000486 return ipmi::responseInvalidReservationId();
Tom Joseph2f05bb52017-06-30 19:14:49 +0530487 }
488
Tom Joseph2f05bb52017-06-30 19:14:49 +0530489 /*
490 * Erasure status cannot be fetched from DBUS, so always return erasure
491 * status as `erase completed`.
492 */
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000493 if (eraseOperation == ipmi::sel::getEraseStatus)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530494 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000495 return ipmi::responseSuccess(
496 static_cast<uint8_t>(ipmi::sel::eraseComplete));
Tom Joseph2f05bb52017-06-30 19:14:49 +0530497 }
498
Xiaoyu Ma73d07772024-02-04 10:31:37 +0800499 // Check that initiate erase is correct
500 if (eraseOperation != ipmi::sel::initiateErase)
501 {
502 return ipmi::responseInvalidFieldRequest();
503 }
504
Jason M. Bills13e67c82018-09-10 14:12:16 -0700505 // Per the IPMI spec, need to cancel any reservation when the SEL is cleared
506 cancelSELReservation();
507
Patrick Williams5d82f472022-07-22 19:26:53 -0500508 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lotus Xu78fe1b12021-05-23 17:26:56 +0800509 auto service = ipmi::getService(bus, ipmi::sel::logIntf, ipmi::sel::logObj);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400510 auto method =
511 bus.new_method_call(service.c_str(), ipmi::sel::logObj,
512 ipmi::sel::logIntf, ipmi::sel::logDeleteAllMethod);
Tom Josephe59abfb2018-08-06 18:46:27 +0530513 try
Tom Joseph2f05bb52017-06-30 19:14:49 +0530514 {
Lotus Xu78fe1b12021-05-23 17:26:56 +0800515 bus.call_noreply(method);
Tom Josephe59abfb2018-08-06 18:46:27 +0530516 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500517 catch (const sdbusplus::exception_t& e)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530518 {
George Liu51856e62024-07-17 19:46:03 +0800519 lg2::error("Error eraseAll: {ERROR}", "ERROR", e);
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000520 return ipmi::responseUnspecifiedError();
Tom Joseph2f05bb52017-06-30 19:14:49 +0530521 }
522
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000523 return ipmi::responseSuccess(
524 static_cast<uint8_t>(ipmi::sel::eraseComplete));
Tom Joseph2f05bb52017-06-30 19:14:49 +0530525}
526
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000527/** @brief implements the get SEL time command
528 * @returns IPMI completion code plus response data
529 * -current time
530 */
531ipmi::RspType<uint32_t> // current time
532 ipmiStorageGetSelTime()
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500533{
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530534 using namespace std::chrono;
George Liu4d623e92020-05-25 16:51:57 +0800535 uint64_t bmc_time_usec = 0;
536 std::stringstream bmcTime;
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500537
Lei YUe8939392017-06-15 10:45:05 +0800538 try
539 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500540 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
George Liu4d623e92020-05-25 16:51:57 +0800541 auto service = ipmi::getService(bus, TIME_INTERFACE, BMC_TIME_PATH);
George Liu42f64ef2024-02-05 15:03:18 +0800542 auto propValue = ipmi::getDbusProperty(
543 bus, service, BMC_TIME_PATH, TIME_INTERFACE, PROPERTY_ELAPSED);
544 bmc_time_usec = std::get<uint64_t>(propValue);
Lei YUe8939392017-06-15 10:45:05 +0800545 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500546 catch (const InternalFailure& e)
Lei YUe8939392017-06-15 10:45:05 +0800547 {
George Liu51856e62024-07-17 19:46:03 +0800548 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000549 return ipmi::responseUnspecifiedError();
Lei YUe8939392017-06-15 10:45:05 +0800550 }
Tom Joseph30fd0a12019-09-24 06:53:22 +0530551 catch (const std::exception& e)
Lei YUe8939392017-06-15 10:45:05 +0800552 {
George Liu51856e62024-07-17 19:46:03 +0800553 lg2::error("exception message: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000554 return ipmi::responseUnspecifiedError();
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530555 }
556
George Liu51856e62024-07-17 19:46:03 +0800557 lg2::debug("BMC time: {BMC_TIME}", "BMC_TIME",
558 duration_cast<seconds>(microseconds(bmc_time_usec)).count());
Nagaraju Goruganti8960b7c2018-04-29 22:38:40 -0500559
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530560 // Time is really long int but IPMI wants just uint32. This works okay until
561 // the number of seconds since 1970 overflows uint32 size.. Still a whole
562 // lot of time here to even think about that.
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000563 return ipmi::responseSuccess(
George Liu4d623e92020-05-25 16:51:57 +0800564 duration_cast<seconds>(microseconds(bmc_time_usec)).count());
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500565}
566
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000567/** @brief implements the set SEL time command
568 * @param selDeviceTime - epoch time
569 * -local time as the number of seconds from 00:00:00, January 1, 1970
570 * @returns IPMI completion code
571 */
572ipmi::RspType<> ipmiStorageSetSelTime(uint32_t selDeviceTime)
Chris Austenb4f5b922015-10-13 12:44:43 -0500573{
Lei YUe8939392017-06-15 10:45:05 +0800574 using namespace std::chrono;
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000575 microseconds usec{seconds(selDeviceTime)};
Norman James82330442015-11-19 16:53:26 -0600576
Lei YUe8939392017-06-15 10:45:05 +0800577 try
578 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500579 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
shamim ali071d00c2022-03-02 15:42:46 +0530580 bool ntp = std::get<bool>(
581 ipmi::getDbusProperty(bus, SystemdTimeService, SystemdTimePath,
582 SystemdTimeInterface, "NTP"));
583 if (ntp)
584 {
585 return ipmi::responseCommandNotAvailable();
586 }
587
George Liu4d623e92020-05-25 16:51:57 +0800588 auto service = ipmi::getService(bus, TIME_INTERFACE, BMC_TIME_PATH);
Andrew Geissler6467ed22020-05-16 16:03:53 -0500589 std::variant<uint64_t> value{(uint64_t)usec.count()};
Lei YUe8939392017-06-15 10:45:05 +0800590
George Liu4d623e92020-05-25 16:51:57 +0800591 // Set bmc time
592 auto method = bus.new_method_call(service.c_str(), BMC_TIME_PATH,
Patrick Venture0b02be92018-08-31 11:55:55 -0700593 DBUS_PROPERTIES, "Set");
Lei YUe8939392017-06-15 10:45:05 +0800594
595 method.append(TIME_INTERFACE, PROPERTY_ELAPSED, value);
596 auto reply = bus.call(method);
Norman James82330442015-11-19 16:53:26 -0600597 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500598 catch (const InternalFailure& e)
Lei YUe8939392017-06-15 10:45:05 +0800599 {
George Liu51856e62024-07-17 19:46:03 +0800600 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000601 return ipmi::responseUnspecifiedError();
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530602 }
Tom Joseph30fd0a12019-09-24 06:53:22 +0530603 catch (const std::exception& e)
Lei YUe8939392017-06-15 10:45:05 +0800604 {
George Liu51856e62024-07-17 19:46:03 +0800605 lg2::error("exception message: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000606 return ipmi::responseUnspecifiedError();
Norman James82330442015-11-19 16:53:26 -0600607 }
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530608
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000609 return ipmi::responseSuccess();
Chris Austenb4f5b922015-10-13 12:44:43 -0500610}
611
Xiaochao Maf020c442022-10-31 11:09:38 +0800612/** @brief implements the get SEL timezone command
613 * @returns IPMI completion code plus response data
614 * -current timezone
615 */
616ipmi::RspType<int16_t> ipmiStorageGetSelTimeUtcOffset()
617{
618 time_t timep;
619 struct tm* gmTime;
620 struct tm* localTime;
621
622 time(&timep);
623 localTime = localtime(&timep);
624 auto validLocalTime = mktime(localTime);
625 gmTime = gmtime(&timep);
626 auto validGmTime = mktime(gmTime);
627 auto timeEquation = (validLocalTime - validGmTime) / 60;
628
629 return ipmi::responseSuccess(timeEquation);
630}
631
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000632/** @brief implements the reserve SEL command
633 * @returns IPMI completion code plus response data
634 * - SEL reservation ID.
635 */
636ipmi::RspType<uint16_t> ipmiStorageReserveSel()
Chris Austenb4f5b922015-10-13 12:44:43 -0500637{
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000638 return ipmi::responseSuccess(reserveSel());
Chris Austenb4f5b922015-10-13 12:44:43 -0500639}
640
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000641/** @brief implements the Add SEL entry command
642 * @request
643 *
644 * - recordID ID used for SEL Record access
645 * - recordType Record Type
646 * - timeStamp Time when event was logged. LS byte first
647 * - generatorID software ID if event was generated from
648 * system software
649 * - evmRev event message format version
650 * - sensorType sensor type code for service that generated
651 * the event
652 * - sensorNumber number of sensors that generated the event
653 * - eventDir event dir
654 * - eventData event data field contents
655 *
656 * @returns ipmi completion code plus response data
657 * - RecordID of the Added SEL entry
658 */
659ipmi::RspType<uint16_t // recordID of the Added SEL entry
660 >
Willy Tu11d68892022-01-20 10:37:34 -0800661 ipmiStorageAddSEL(uint16_t recordID, uint8_t recordType,
662 [[maybe_unused]] uint32_t timeStamp, uint16_t generatorID,
Patrick Williams32aece12025-01-24 10:06:55 -0500663 [[maybe_unused]] uint8_t evmRev,
664 [[maybe_unused]] uint8_t sensorType, uint8_t sensorNumber,
665 uint8_t eventDir,
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000666 std::array<uint8_t, eventDataSize> eventData)
Chris Austenb4f5b922015-10-13 12:44:43 -0500667{
Lotus Xu57d35572021-01-24 11:13:13 +0800668 std::string objpath;
669 static constexpr auto systemRecordType = 0x02;
Patrick Williams32aece12025-01-24 10:06:55 -0500670#ifdef OPEN_POWER_SUPPORT
Tom Josephb647d5b2017-10-31 17:25:33 +0530671 // Hostboot sends SEL with OEM record type 0xDE to indicate that there is
672 // a maintenance procedure associated with eSEL record.
673 static constexpr auto procedureType = 0xDE;
Patrick Williams32aece12025-01-24 10:06:55 -0500674#endif
Lotus Xu57d35572021-01-24 11:13:13 +0800675 cancelSELReservation();
676 if (recordType == systemRecordType)
677 {
Lotus Xu57d35572021-01-24 11:13:13 +0800678 for (const auto& it : invSensors)
679 {
680 if (it.second.sensorID == sensorNumber)
681 {
682 objpath = it.first;
683 break;
684 }
685 }
686 auto selDataStr = ipmi::sel::toHexStr(eventData);
687
688 bool assert = (eventDir & 0x80) ? false : true;
689
Patrick Williams1318a5e2024-08-16 15:19:54 -0400690 recordID = report<SELCreated>(
691 Created::RECORD_TYPE(recordType),
692 Created::GENERATOR_ID(generatorID),
693 Created::SENSOR_DATA(selDataStr.c_str()),
694 Created::EVENT_DIR(assert), Created::SENSOR_PATH(objpath.c_str()));
Lotus Xu57d35572021-01-24 11:13:13 +0800695 }
Patrick Williams768730d2023-09-06 16:27:20 -0500696#ifdef OPEN_POWER_SUPPORT
Lotus Xu57d35572021-01-24 11:13:13 +0800697 else if (recordType == procedureType)
Tom Josephb647d5b2017-10-31 17:25:33 +0530698 {
699 // In the OEM record type 0xDE, byte 11 in the SEL record indicate the
700 // procedure number.
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000701 createProcedureLogEntry(sensorType);
Tom Josephb647d5b2017-10-31 17:25:33 +0530702 }
Patrick Williams768730d2023-09-06 16:27:20 -0500703#endif
Chris Austenb4f5b922015-10-13 12:44:43 -0500704
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000705 return ipmi::responseSuccess(recordID);
Chris Austenb4f5b922015-10-13 12:44:43 -0500706}
707
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300708bool isFruPresent(ipmi::Context::ptr& ctx, const std::string& fruPath)
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300709{
710 using namespace ipmi::fru;
711
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300712 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400713 boost::system::error_code ec =
714 getService(ctx, invItemInterface, invObjPath + fruPath, service);
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300715 if (!ec)
716 {
717 bool result;
718 ec = ipmi::getDbusProperty(ctx, service, invObjPath + fruPath,
719 invItemInterface, itemPresentProp, result);
720 if (!ec)
721 {
722 return result;
723 }
724 }
Konstantin Aladyshevc7e4b042021-12-24 15:30:47 +0300725
726 ipmi::ObjectValueTree managedObjects;
Nan Zhou947da1b2022-09-20 20:40:59 +0000727 ec = getManagedObjects(ctx, "xyz.openbmc_project.EntityManager",
728 "/xyz/openbmc_project/inventory", managedObjects);
Konstantin Aladyshevc7e4b042021-12-24 15:30:47 +0300729 if (!ec)
730 {
731 auto connection = managedObjects.find(fruPath);
732 if (connection != managedObjects.end())
733 {
734 return true;
735 }
736 }
737
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300738 return false;
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300739}
740
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000741/** @brief implements the get FRU Inventory Area Info command
742 *
743 * @returns IPMI completion code plus response data
744 * - FRU Inventory area size in bytes,
745 * - access bit
746 **/
747ipmi::RspType<uint16_t, // FRU Inventory area size in bytes,
748 uint8_t // access size (bytes / words)
749 >
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300750 ipmiStorageGetFruInvAreaInfo(ipmi::Context::ptr ctx, uint8_t fruID)
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500751{
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000752 auto iter = frus.find(fruID);
Tom Joseph187f5642018-03-29 13:49:06 +0530753 if (iter == frus.end())
754 {
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000755 return ipmi::responseSensorInvalid();
Tom Joseph187f5642018-03-29 13:49:06 +0530756 }
757
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300758 auto path = iter->second[0].path;
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300759 if (!isFruPresent(ctx, path))
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300760 {
761 return ipmi::responseSensorInvalid();
762 }
763
Marri Devender Raocac383b2017-07-03 13:24:27 -0500764 try
765 {
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000766 return ipmi::responseSuccess(
767 static_cast<uint16_t>(getFruAreaData(fruID).size()),
768 static_cast<uint8_t>(AccessMode::bytes));
Marri Devender Raocac383b2017-07-03 13:24:27 -0500769 }
Patrick Venture0b02be92018-08-31 11:55:55 -0700770 catch (const InternalFailure& e)
Marri Devender Raocac383b2017-07-03 13:24:27 -0500771 {
George Liu51856e62024-07-17 19:46:03 +0800772 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000773 return ipmi::responseUnspecifiedError();
Marri Devender Raocac383b2017-07-03 13:24:27 -0500774 }
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500775}
776
anil kumar appana5b7c3262019-05-27 18:10:23 +0000777/**@brief implements the Read FRU Data command
778 * @param fruDeviceId - FRU device ID. FFh = reserved
779 * @param offset - FRU inventory offset to read
780 * @param readCount - count to read
781 *
782 * @return IPMI completion code plus response data
783 * - returnCount - response data count.
784 * - data - response data
785 */
786ipmi::RspType<uint8_t, // count returned
787 std::vector<uint8_t>> // FRU data
788 ipmiStorageReadFruData(uint8_t fruDeviceId, uint16_t offset,
789 uint8_t readCount)
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500790{
anil kumar appana5b7c3262019-05-27 18:10:23 +0000791 if (fruDeviceId == 0xFF)
Tom Joseph187f5642018-03-29 13:49:06 +0530792 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000793 return ipmi::responseInvalidFieldRequest();
Tom Joseph187f5642018-03-29 13:49:06 +0530794 }
795
anil kumar appana5b7c3262019-05-27 18:10:23 +0000796 auto iter = frus.find(fruDeviceId);
797 if (iter == frus.end())
798 {
799 return ipmi::responseSensorInvalid();
800 }
801
Marri Devender Raocac383b2017-07-03 13:24:27 -0500802 try
803 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000804 const auto& fruArea = getFruAreaData(fruDeviceId);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500805 auto size = fruArea.size();
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500806
Tom Josephefcd68b2018-04-26 18:46:27 +0530807 if (offset >= size)
808 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000809 return ipmi::responseParmOutOfRange();
Tom Josephefcd68b2018-04-26 18:46:27 +0530810 }
811
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500812 // Write the count of response data.
anil kumar appana5b7c3262019-05-27 18:10:23 +0000813 uint8_t returnCount;
814 if ((offset + readCount) <= size)
Marri Devender Raocac383b2017-07-03 13:24:27 -0500815 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000816 returnCount = readCount;
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500817 }
818 else
819 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000820 returnCount = size - offset;
Marri Devender Raocac383b2017-07-03 13:24:27 -0500821 }
Ratan Gupta2848d602018-01-31 20:39:20 +0530822
anil kumar appana5b7c3262019-05-27 18:10:23 +0000823 std::vector<uint8_t> fruData((fruArea.begin() + offset),
824 (fruArea.begin() + offset + returnCount));
Ratan Gupta2848d602018-01-31 20:39:20 +0530825
anil kumar appana5b7c3262019-05-27 18:10:23 +0000826 return ipmi::responseSuccess(returnCount, fruData);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500827 }
828 catch (const InternalFailure& e)
829 {
George Liu51856e62024-07-17 19:46:03 +0800830 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
anil kumar appana5b7c3262019-05-27 18:10:23 +0000831 return ipmi::responseUnspecifiedError();
Marri Devender Raocac383b2017-07-03 13:24:27 -0500832 }
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500833}
834
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000835ipmi::RspType<uint8_t, // SDR version
836 uint16_t, // record count LS first
837 uint16_t, // free space in bytes, LS first
838 uint32_t, // addition timestamp LS first
839 uint32_t, // deletion timestamp LS first
840 uint8_t> // operation Support
841 ipmiGetRepositoryInfo()
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600842{
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000843 constexpr uint8_t sdrVersion = 0x51;
844 constexpr uint16_t freeSpace = 0xFFFF;
845 constexpr uint32_t additionTimestamp = 0x0;
846 constexpr uint32_t deletionTimestamp = 0x0;
847 constexpr uint8_t operationSupport = 0;
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600848
Willy Tu0ca3bfe2022-01-28 09:40:18 -0800849 // Get SDR count. This returns the total number of SDRs in the device.
850 const auto& entityRecords =
851 ipmi::sensor::EntityInfoMapContainer::getContainer()
852 ->getIpmiEntityRecords();
Patrick Williams1318a5e2024-08-16 15:19:54 -0400853 uint16_t records =
854 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size();
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600855
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000856 return ipmi::responseSuccess(sdrVersion, records, freeSpace,
857 additionTimestamp, deletionTimestamp,
858 operationSupport);
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600859}
Chris Austenb4f5b922015-10-13 12:44:43 -0500860
George Liu5087b072025-03-11 19:28:17 +0800861void registerNetFnStorageFunctions()
Chris Austenb4f5b922015-10-13 12:44:43 -0500862{
Lei YU3df36612021-09-15 11:41:11 +0800863 selCacheMapInitialized = false;
Lei YUd9e57662021-09-14 18:06:28 +0800864 initSELCache();
Willy Tud351a722021-08-12 14:33:40 -0700865 // Handlers with dbus-sdr handler implementation.
866 // Do not register the hander if it dynamic sensors stack is used.
867
868#ifndef FEATURE_DYNAMIC_SENSORS
Thang Tran292c9172023-06-26 10:03:04 +0700869
870#ifndef FEATURE_DYNAMIC_STORAGES_ONLY
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530871 // <Get SEL Info>
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000872 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
873 ipmi::storage::cmdGetSelInfo, ipmi::Privilege::User,
874 ipmiStorageGetSelInfo);
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530875
Xiaochao Maf020c442022-10-31 11:09:38 +0800876 // <Get SEL Timezone>
877 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
878 ipmi::storage::cmdGetSelTimeUtcOffset,
879 ipmi::Privilege::User,
880 ipmiStorageGetSelTimeUtcOffset);
881
Tom Josepha4953392017-06-30 19:09:47 +0530882 // <Get SEL Entry>
George Liue7592702025-07-03 15:48:02 +0800883 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
884 ipmi::storage::cmdGetSelEntry, ipmi::Privilege::User,
885 getSELEntry);
Tom Josepha4953392017-06-30 19:09:47 +0530886
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530887 // <Delete SEL Entry>
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000888 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
889 ipmi::storage::cmdDeleteSelEntry,
890 ipmi::Privilege::Operator, deleteSELEntry);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530891
Tom05732372016-09-06 17:21:23 +0530892 // <Add SEL Entry>
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000893 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
894 ipmi::storage::cmdAddSelEntry,
895 ipmi::Privilege::Operator, ipmiStorageAddSEL);
896
Tom Joseph2f05bb52017-06-30 19:14:49 +0530897 // <Clear SEL>
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000898 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
899 ipmi::storage::cmdClearSel, ipmi::Privilege::Operator,
900 clearSEL);
901
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500902 // <Get FRU Inventory Area Info>
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000903 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
904 ipmi::storage::cmdGetFruInventoryAreaInfo,
905 ipmi::Privilege::User, ipmiStorageGetFruInvAreaInfo);
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500906
Jason M. Billsb5248c92019-06-24 15:53:08 -0700907 // <READ FRU Data>
anil kumar appana5b7c3262019-05-27 18:10:23 +0000908 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
909 ipmi::storage::cmdReadFruData,
910 ipmi::Privilege::Operator, ipmiStorageReadFruData);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500911
Thang Tran292c9172023-06-26 10:03:04 +0700912#endif // FEATURE_DYNAMIC_STORAGES_ONLY
913
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600914 // <Get Repository Info>
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000915 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
916 ipmi::storage::cmdGetSdrRepositoryInfo,
917 ipmi::Privilege::User, ipmiGetRepositoryInfo);
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600918
Tom Joseph5ca50952018-02-22 00:33:38 +0530919 // <Reserve SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000920 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
921 ipmi::storage::cmdReserveSdrRepository,
922 ipmi::Privilege::User, ipmiSensorReserveSdr);
Tom Joseph5ca50952018-02-22 00:33:38 +0530923
924 // <Get SDR>
George Liuae30d812025-04-03 09:56:47 +0800925 ipmi_register_callback(ipmi::netFnStorage, ipmi::storage::cmdGetSdr,
926 nullptr, ipmi_sen_get_sdr, PRIVILEGE_USER);
Tom Joseph5ca50952018-02-22 00:33:38 +0530927
Willy Tud351a722021-08-12 14:33:40 -0700928#endif
929
930 // Common Handers used by both implementation.
931
932 // <Reserve SEL>
933 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
934 ipmi::storage::cmdReserveSel, ipmi::Privilege::User,
935 ipmiStorageReserveSel);
936
Thang Trandbf66e12023-09-21 13:07:24 +0700937 // <Get SEL Time>
938 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
939 ipmi::storage::cmdGetSelTime, ipmi::Privilege::User,
940 ipmiStorageGetSelTime);
941
942 // <Set SEL Time>
943 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
944 ipmi::storage::cmdSetSelTime,
945 ipmi::Privilege::Operator, ipmiStorageSetSelTime);
946
Marri Devender Rao908f7502017-07-10 01:49:54 -0500947 ipmi::fru::registerCallbackHandler();
Chris Austenb4f5b922015-10-13 12:44:43 -0500948 return;
949}