blob: dc7cf39dd8198cc6fd5544b1d8594bec56404a34 [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
Chris Austenb4f5b922015-10-13 12:44:43 -050031void register_netfn_storage_functions() __attribute__((constructor));
32
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
Lei YUa0bb2a32021-09-24 11:03:56 +080089std::optional<std::pair<uint16_t, SELEntry>>
90 parseLoggingEntry(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
Willy Tu11d68892022-01-20 10:37:34 -0800285ipmi_ret_t getSELEntry(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t request,
286 ipmi_response_t response, ipmi_data_len_t data_len,
287 ipmi_context_t)
Tom Josepha4953392017-06-30 19:09:47 +0530288{
Jason M. Bills851acb12019-02-04 14:06:57 -0800289 if (*data_len != sizeof(ipmi::sel::GetSELEntryRequest))
290 {
291 *data_len = 0;
292 return IPMI_CC_REQ_DATA_LEN_INVALID;
293 }
294
Patrick Venture0b02be92018-08-31 11:55:55 -0700295 auto requestData =
296 reinterpret_cast<const ipmi::sel::GetSELEntryRequest*>(request);
Tom Josepha4953392017-06-30 19:09:47 +0530297
298 if (requestData->reservationID != 0)
299 {
Jason M. Bills13e67c82018-09-10 14:12:16 -0700300 if (!checkSELReservation(requestData->reservationID))
Tom Josepha4953392017-06-30 19:09:47 +0530301 {
302 *data_len = 0;
303 return IPMI_CC_INVALID_RESERVATION_ID;
304 }
305 }
306
Lei YU3df36612021-09-15 11:41:11 +0800307 if (!selCacheMapInitialized)
308 {
309 // In case the initSELCache() fails, try it again
310 initSELCache();
311 }
312
313 if (selCacheMap.empty())
Tom Josepha4953392017-06-30 19:09:47 +0530314 {
315 *data_len = 0;
316 return IPMI_CC_SENSOR_INVALID;
317 }
318
Lei YU3df36612021-09-15 11:41:11 +0800319 SELCacheMap::const_iterator iter;
Tom Josepha4953392017-06-30 19:09:47 +0530320
321 // Check for the requested SEL Entry.
322 if (requestData->selRecordID == ipmi::sel::firstEntry)
323 {
Lei YU3df36612021-09-15 11:41:11 +0800324 iter = selCacheMap.begin();
Tom Josepha4953392017-06-30 19:09:47 +0530325 }
326 else if (requestData->selRecordID == ipmi::sel::lastEntry)
327 {
Lei YU3df36612021-09-15 11:41:11 +0800328 if (selCacheMap.size() > 1)
329 {
330 iter = selCacheMap.end();
331 --iter;
332 }
333 else
334 {
335 // Only one entry exists, return the first
336 iter = selCacheMap.begin();
337 }
Tom Josepha4953392017-06-30 19:09:47 +0530338 }
339 else
340 {
Lei YU3df36612021-09-15 11:41:11 +0800341 iter = selCacheMap.find(requestData->selRecordID);
342 if (iter == selCacheMap.end())
Tom Josepha4953392017-06-30 19:09:47 +0530343 {
344 *data_len = 0;
345 return IPMI_CC_SENSOR_INVALID;
346 }
347 }
348
Lei YU3df36612021-09-15 11:41:11 +0800349 ipmi::sel::GetSELEntryResponse record{0, iter->second};
Tom Josepha4953392017-06-30 19:09:47 +0530350 // Identify the next SEL record ID
Lei YU3df36612021-09-15 11:41:11 +0800351 ++iter;
352 if (iter == selCacheMap.end())
Tom Josepha4953392017-06-30 19:09:47 +0530353 {
Lei YU3df36612021-09-15 11:41:11 +0800354 record.nextRecordID = ipmi::sel::lastEntry;
Tom Josepha4953392017-06-30 19:09:47 +0530355 }
356 else
357 {
Lei YU3df36612021-09-15 11:41:11 +0800358 record.nextRecordID = iter->first;
Tom Josepha4953392017-06-30 19:09:47 +0530359 }
360
361 if (requestData->readLength == ipmi::sel::entireRecord)
362 {
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700363 std::memcpy(response, &record, sizeof(record));
Tom Josepha4953392017-06-30 19:09:47 +0530364 *data_len = sizeof(record);
365 }
366 else
367 {
368 if (requestData->offset >= ipmi::sel::selRecordSize ||
369 requestData->readLength > ipmi::sel::selRecordSize)
370 {
371 *data_len = 0;
372 return IPMI_CC_INVALID_FIELD_REQUEST;
373 }
374
375 auto diff = ipmi::sel::selRecordSize - requestData->offset;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400376 auto readLength =
377 std::min(diff, static_cast<int>(requestData->readLength));
Tom Josepha4953392017-06-30 19:09:47 +0530378
Patrick Ventureb51bf9c2018-09-10 15:53:14 -0700379 std::memcpy(response, &record.nextRecordID,
380 sizeof(record.nextRecordID));
381 std::memcpy(static_cast<uint8_t*>(response) +
382 sizeof(record.nextRecordID),
Lei YUaf378fa2020-12-02 16:28:57 +0800383 &record.event.eventRecord.recordID + requestData->offset,
384 readLength);
Tom Josepha4953392017-06-30 19:09:47 +0530385 *data_len = sizeof(record.nextRecordID) + readLength;
386 }
387
388 return IPMI_CC_OK;
389}
390
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000391/** @brief implements the delete SEL entry command
392 * @request
393 * - reservationID; // reservation ID.
394 * - selRecordID; // SEL record ID.
395 *
396 * @returns ipmi completion code plus response data
397 * - Record ID of the deleted record
398 */
399ipmi::RspType<uint16_t // deleted record ID
400 >
401 deleteSELEntry(uint16_t reservationID, uint16_t selRecordID)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530402{
Brad Bishop1a4117b2018-11-21 15:48:18 -0500403 namespace fs = std::filesystem;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530404
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000405 if (!checkSELReservation(reservationID))
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530406 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000407 return ipmi::responseInvalidReservationId();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530408 }
409
Jason M. Bills13e67c82018-09-10 14:12:16 -0700410 // Per the IPMI spec, need to cancel the reservation when a SEL entry is
411 // deleted
412 cancelSELReservation();
413
Lei YUeba8e9a2021-09-15 13:16:17 +0800414 if (!selCacheMapInitialized)
Tom Josephe59abfb2018-08-06 18:46:27 +0530415 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800416 // In case the initSELCache() fails, try it again
417 initSELCache();
Tom Josephe59abfb2018-08-06 18:46:27 +0530418 }
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530419
Lei YUeba8e9a2021-09-15 13:16:17 +0800420 if (selCacheMap.empty())
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530421 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000422 return ipmi::responseSensorInvalid();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530423 }
424
Lei YUeba8e9a2021-09-15 13:16:17 +0800425 SELCacheMap::const_iterator iter;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530426 uint16_t delRecordID = 0;
427
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000428 if (selRecordID == ipmi::sel::firstEntry)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530429 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800430 delRecordID = selCacheMap.begin()->first;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530431 }
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000432 else if (selRecordID == ipmi::sel::lastEntry)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530433 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800434 delRecordID = selCacheMap.rbegin()->first;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530435 }
436 else
437 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000438 delRecordID = selRecordID;
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530439 }
440
Jian7d5f4812022-02-23 19:30:27 +0800441 iter = selCacheMap.find(delRecordID);
442 if (iter == selCacheMap.end())
443 {
444 return ipmi::responseSensorInvalid();
445 }
446
Patrick Williams5d82f472022-07-22 19:26:53 -0500447 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530448 std::string service;
449
Lei YUeba8e9a2021-09-15 13:16:17 +0800450 auto objPath = getLoggingObjPath(iter->first);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530451 try
452 {
Lei YUeba8e9a2021-09-15 13:16:17 +0800453 service = ipmi::getService(bus, ipmi::sel::logDeleteIntf, objPath);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530454 }
455 catch (const std::runtime_error& e)
456 {
George Liu51856e62024-07-17 19:46:03 +0800457 lg2::error("runtime error: {ERROR}", "ERROR", e);
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000458 return ipmi::responseUnspecifiedError();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530459 }
460
Lei YUeba8e9a2021-09-15 13:16:17 +0800461 auto methodCall = bus.new_method_call(service.c_str(), objPath.c_str(),
Patrick Venture0b02be92018-08-31 11:55:55 -0700462 ipmi::sel::logDeleteIntf, "Delete");
George Liu3e3cc352023-07-26 15:59:31 +0800463 try
464 {
465 auto reply = bus.call(methodCall);
466 }
467 catch (const std::exception& e)
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530468 {
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000469 return ipmi::responseUnspecifiedError();
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530470 }
471
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000472 return ipmi::responseSuccess(delRecordID);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530473}
474
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000475/** @brief implements the Clear SEL command
476 * @request
477 * - reservationID // Reservation ID.
478 * - clr // char array { 'C'(0x43h), 'L'(0x4Ch), 'R'(0x52h) }
479 * - eraseOperation; // requested operation.
480 *
481 * @returns ipmi completion code plus response data
482 * - erase status
483 */
484
485ipmi::RspType<uint8_t // erase status
486 >
487 clearSEL(uint16_t reservationID, const std::array<char, 3>& clr,
488 uint8_t eraseOperation)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530489{
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000490 static constexpr std::array<char, 3> clrOk = {'C', 'L', 'R'};
491 if (clr != clrOk)
Jason M. Bills851acb12019-02-04 14:06:57 -0800492 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000493 return ipmi::responseInvalidFieldRequest();
Jason M. Bills851acb12019-02-04 14:06:57 -0800494 }
495
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000496 if (!checkSELReservation(reservationID))
Tom Joseph2f05bb52017-06-30 19:14:49 +0530497 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000498 return ipmi::responseInvalidReservationId();
Tom Joseph2f05bb52017-06-30 19:14:49 +0530499 }
500
Tom Joseph2f05bb52017-06-30 19:14:49 +0530501 /*
502 * Erasure status cannot be fetched from DBUS, so always return erasure
503 * status as `erase completed`.
504 */
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000505 if (eraseOperation == ipmi::sel::getEraseStatus)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530506 {
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000507 return ipmi::responseSuccess(
508 static_cast<uint8_t>(ipmi::sel::eraseComplete));
Tom Joseph2f05bb52017-06-30 19:14:49 +0530509 }
510
Xiaoyu Ma73d07772024-02-04 10:31:37 +0800511 // Check that initiate erase is correct
512 if (eraseOperation != ipmi::sel::initiateErase)
513 {
514 return ipmi::responseInvalidFieldRequest();
515 }
516
Jason M. Bills13e67c82018-09-10 14:12:16 -0700517 // Per the IPMI spec, need to cancel any reservation when the SEL is cleared
518 cancelSELReservation();
519
Patrick Williams5d82f472022-07-22 19:26:53 -0500520 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
Lotus Xu78fe1b12021-05-23 17:26:56 +0800521 auto service = ipmi::getService(bus, ipmi::sel::logIntf, ipmi::sel::logObj);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400522 auto method =
523 bus.new_method_call(service.c_str(), ipmi::sel::logObj,
524 ipmi::sel::logIntf, ipmi::sel::logDeleteAllMethod);
Tom Josephe59abfb2018-08-06 18:46:27 +0530525 try
Tom Joseph2f05bb52017-06-30 19:14:49 +0530526 {
Lotus Xu78fe1b12021-05-23 17:26:56 +0800527 bus.call_noreply(method);
Tom Josephe59abfb2018-08-06 18:46:27 +0530528 }
Patrick Williams5d82f472022-07-22 19:26:53 -0500529 catch (const sdbusplus::exception_t& e)
Tom Joseph2f05bb52017-06-30 19:14:49 +0530530 {
George Liu51856e62024-07-17 19:46:03 +0800531 lg2::error("Error eraseAll: {ERROR}", "ERROR", e);
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000532 return ipmi::responseUnspecifiedError();
Tom Joseph2f05bb52017-06-30 19:14:49 +0530533 }
534
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000535 return ipmi::responseSuccess(
536 static_cast<uint8_t>(ipmi::sel::eraseComplete));
Tom Joseph2f05bb52017-06-30 19:14:49 +0530537}
538
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000539/** @brief implements the get SEL time command
540 * @returns IPMI completion code plus response data
541 * -current time
542 */
543ipmi::RspType<uint32_t> // current time
544 ipmiStorageGetSelTime()
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500545{
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530546 using namespace std::chrono;
George Liu4d623e92020-05-25 16:51:57 +0800547 uint64_t bmc_time_usec = 0;
548 std::stringstream bmcTime;
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500549
Lei YUe8939392017-06-15 10:45:05 +0800550 try
551 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500552 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
George Liu4d623e92020-05-25 16:51:57 +0800553 auto service = ipmi::getService(bus, TIME_INTERFACE, BMC_TIME_PATH);
George Liu42f64ef2024-02-05 15:03:18 +0800554 auto propValue = ipmi::getDbusProperty(
555 bus, service, BMC_TIME_PATH, TIME_INTERFACE, PROPERTY_ELAPSED);
556 bmc_time_usec = std::get<uint64_t>(propValue);
Lei YUe8939392017-06-15 10:45:05 +0800557 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500558 catch (const InternalFailure& e)
Lei YUe8939392017-06-15 10:45:05 +0800559 {
George Liu51856e62024-07-17 19:46:03 +0800560 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000561 return ipmi::responseUnspecifiedError();
Lei YUe8939392017-06-15 10:45:05 +0800562 }
Tom Joseph30fd0a12019-09-24 06:53:22 +0530563 catch (const std::exception& e)
Lei YUe8939392017-06-15 10:45:05 +0800564 {
George Liu51856e62024-07-17 19:46:03 +0800565 lg2::error("exception message: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000566 return ipmi::responseUnspecifiedError();
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530567 }
568
George Liu51856e62024-07-17 19:46:03 +0800569 lg2::debug("BMC time: {BMC_TIME}", "BMC_TIME",
570 duration_cast<seconds>(microseconds(bmc_time_usec)).count());
Nagaraju Goruganti8960b7c2018-04-29 22:38:40 -0500571
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530572 // Time is really long int but IPMI wants just uint32. This works okay until
573 // the number of seconds since 1970 overflows uint32 size.. Still a whole
574 // lot of time here to even think about that.
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000575 return ipmi::responseSuccess(
George Liu4d623e92020-05-25 16:51:57 +0800576 duration_cast<seconds>(microseconds(bmc_time_usec)).count());
Adriana Kobylak8e30f2a2015-10-20 10:23:51 -0500577}
578
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000579/** @brief implements the set SEL time command
580 * @param selDeviceTime - epoch time
581 * -local time as the number of seconds from 00:00:00, January 1, 1970
582 * @returns IPMI completion code
583 */
584ipmi::RspType<> ipmiStorageSetSelTime(uint32_t selDeviceTime)
Chris Austenb4f5b922015-10-13 12:44:43 -0500585{
Lei YUe8939392017-06-15 10:45:05 +0800586 using namespace std::chrono;
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000587 microseconds usec{seconds(selDeviceTime)};
Norman James82330442015-11-19 16:53:26 -0600588
Lei YUe8939392017-06-15 10:45:05 +0800589 try
590 {
Patrick Williams5d82f472022-07-22 19:26:53 -0500591 sdbusplus::bus_t bus{ipmid_get_sd_bus_connection()};
shamim ali071d00c2022-03-02 15:42:46 +0530592 bool ntp = std::get<bool>(
593 ipmi::getDbusProperty(bus, SystemdTimeService, SystemdTimePath,
594 SystemdTimeInterface, "NTP"));
595 if (ntp)
596 {
597 return ipmi::responseCommandNotAvailable();
598 }
599
George Liu4d623e92020-05-25 16:51:57 +0800600 auto service = ipmi::getService(bus, TIME_INTERFACE, BMC_TIME_PATH);
Andrew Geissler6467ed22020-05-16 16:03:53 -0500601 std::variant<uint64_t> value{(uint64_t)usec.count()};
Lei YUe8939392017-06-15 10:45:05 +0800602
George Liu4d623e92020-05-25 16:51:57 +0800603 // Set bmc time
604 auto method = bus.new_method_call(service.c_str(), BMC_TIME_PATH,
Patrick Venture0b02be92018-08-31 11:55:55 -0700605 DBUS_PROPERTIES, "Set");
Lei YUe8939392017-06-15 10:45:05 +0800606
607 method.append(TIME_INTERFACE, PROPERTY_ELAPSED, value);
608 auto reply = bus.call(method);
Norman James82330442015-11-19 16:53:26 -0600609 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500610 catch (const InternalFailure& e)
Lei YUe8939392017-06-15 10:45:05 +0800611 {
George Liu51856e62024-07-17 19:46:03 +0800612 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000613 return ipmi::responseUnspecifiedError();
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530614 }
Tom Joseph30fd0a12019-09-24 06:53:22 +0530615 catch (const std::exception& e)
Lei YUe8939392017-06-15 10:45:05 +0800616 {
George Liu51856e62024-07-17 19:46:03 +0800617 lg2::error("exception message: {ERROR}", "ERROR", e);
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000618 return ipmi::responseUnspecifiedError();
Norman James82330442015-11-19 16:53:26 -0600619 }
Vishwanatha Subbanna5fba7a62016-09-01 14:06:07 +0530620
jayaprakash Mutyaladb2e8c42019-05-03 01:38:01 +0000621 return ipmi::responseSuccess();
Chris Austenb4f5b922015-10-13 12:44:43 -0500622}
623
Xiaochao Maf020c442022-10-31 11:09:38 +0800624/** @brief implements the get SEL timezone command
625 * @returns IPMI completion code plus response data
626 * -current timezone
627 */
628ipmi::RspType<int16_t> ipmiStorageGetSelTimeUtcOffset()
629{
630 time_t timep;
631 struct tm* gmTime;
632 struct tm* localTime;
633
634 time(&timep);
635 localTime = localtime(&timep);
636 auto validLocalTime = mktime(localTime);
637 gmTime = gmtime(&timep);
638 auto validGmTime = mktime(gmTime);
639 auto timeEquation = (validLocalTime - validGmTime) / 60;
640
641 return ipmi::responseSuccess(timeEquation);
642}
643
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000644/** @brief implements the reserve SEL command
645 * @returns IPMI completion code plus response data
646 * - SEL reservation ID.
647 */
648ipmi::RspType<uint16_t> ipmiStorageReserveSel()
Chris Austenb4f5b922015-10-13 12:44:43 -0500649{
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000650 return ipmi::responseSuccess(reserveSel());
Chris Austenb4f5b922015-10-13 12:44:43 -0500651}
652
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000653/** @brief implements the Add SEL entry command
654 * @request
655 *
656 * - recordID ID used for SEL Record access
657 * - recordType Record Type
658 * - timeStamp Time when event was logged. LS byte first
659 * - generatorID software ID if event was generated from
660 * system software
661 * - evmRev event message format version
662 * - sensorType sensor type code for service that generated
663 * the event
664 * - sensorNumber number of sensors that generated the event
665 * - eventDir event dir
666 * - eventData event data field contents
667 *
668 * @returns ipmi completion code plus response data
669 * - RecordID of the Added SEL entry
670 */
671ipmi::RspType<uint16_t // recordID of the Added SEL entry
672 >
Willy Tu11d68892022-01-20 10:37:34 -0800673 ipmiStorageAddSEL(uint16_t recordID, uint8_t recordType,
674 [[maybe_unused]] uint32_t timeStamp, uint16_t generatorID,
Patrick Williams32aece12025-01-24 10:06:55 -0500675 [[maybe_unused]] uint8_t evmRev,
676 [[maybe_unused]] uint8_t sensorType, uint8_t sensorNumber,
677 uint8_t eventDir,
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000678 std::array<uint8_t, eventDataSize> eventData)
Chris Austenb4f5b922015-10-13 12:44:43 -0500679{
Lotus Xu57d35572021-01-24 11:13:13 +0800680 std::string objpath;
681 static constexpr auto systemRecordType = 0x02;
Patrick Williams32aece12025-01-24 10:06:55 -0500682#ifdef OPEN_POWER_SUPPORT
Tom Josephb647d5b2017-10-31 17:25:33 +0530683 // Hostboot sends SEL with OEM record type 0xDE to indicate that there is
684 // a maintenance procedure associated with eSEL record.
685 static constexpr auto procedureType = 0xDE;
Patrick Williams32aece12025-01-24 10:06:55 -0500686#endif
Lotus Xu57d35572021-01-24 11:13:13 +0800687 cancelSELReservation();
688 if (recordType == systemRecordType)
689 {
Lotus Xu57d35572021-01-24 11:13:13 +0800690 for (const auto& it : invSensors)
691 {
692 if (it.second.sensorID == sensorNumber)
693 {
694 objpath = it.first;
695 break;
696 }
697 }
698 auto selDataStr = ipmi::sel::toHexStr(eventData);
699
700 bool assert = (eventDir & 0x80) ? false : true;
701
Patrick Williams1318a5e2024-08-16 15:19:54 -0400702 recordID = report<SELCreated>(
703 Created::RECORD_TYPE(recordType),
704 Created::GENERATOR_ID(generatorID),
705 Created::SENSOR_DATA(selDataStr.c_str()),
706 Created::EVENT_DIR(assert), Created::SENSOR_PATH(objpath.c_str()));
Lotus Xu57d35572021-01-24 11:13:13 +0800707 }
Patrick Williams768730d2023-09-06 16:27:20 -0500708#ifdef OPEN_POWER_SUPPORT
Lotus Xu57d35572021-01-24 11:13:13 +0800709 else if (recordType == procedureType)
Tom Josephb647d5b2017-10-31 17:25:33 +0530710 {
711 // In the OEM record type 0xDE, byte 11 in the SEL record indicate the
712 // procedure number.
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000713 createProcedureLogEntry(sensorType);
Tom Josephb647d5b2017-10-31 17:25:33 +0530714 }
Patrick Williams768730d2023-09-06 16:27:20 -0500715#endif
Chris Austenb4f5b922015-10-13 12:44:43 -0500716
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000717 return ipmi::responseSuccess(recordID);
Chris Austenb4f5b922015-10-13 12:44:43 -0500718}
719
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300720bool isFruPresent(ipmi::Context::ptr& ctx, const std::string& fruPath)
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300721{
722 using namespace ipmi::fru;
723
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300724 std::string service;
Patrick Williams1318a5e2024-08-16 15:19:54 -0400725 boost::system::error_code ec =
726 getService(ctx, invItemInterface, invObjPath + fruPath, service);
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300727 if (!ec)
728 {
729 bool result;
730 ec = ipmi::getDbusProperty(ctx, service, invObjPath + fruPath,
731 invItemInterface, itemPresentProp, result);
732 if (!ec)
733 {
734 return result;
735 }
736 }
Konstantin Aladyshevc7e4b042021-12-24 15:30:47 +0300737
738 ipmi::ObjectValueTree managedObjects;
Nan Zhou947da1b2022-09-20 20:40:59 +0000739 ec = getManagedObjects(ctx, "xyz.openbmc_project.EntityManager",
740 "/xyz/openbmc_project/inventory", managedObjects);
Konstantin Aladyshevc7e4b042021-12-24 15:30:47 +0300741 if (!ec)
742 {
743 auto connection = managedObjects.find(fruPath);
744 if (connection != managedObjects.end())
745 {
746 return true;
747 }
748 }
749
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300750 return false;
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300751}
752
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000753/** @brief implements the get FRU Inventory Area Info command
754 *
755 * @returns IPMI completion code plus response data
756 * - FRU Inventory area size in bytes,
757 * - access bit
758 **/
759ipmi::RspType<uint16_t, // FRU Inventory area size in bytes,
760 uint8_t // access size (bytes / words)
761 >
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300762 ipmiStorageGetFruInvAreaInfo(ipmi::Context::ptr ctx, uint8_t fruID)
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500763{
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000764 auto iter = frus.find(fruID);
Tom Joseph187f5642018-03-29 13:49:06 +0530765 if (iter == frus.end())
766 {
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000767 return ipmi::responseSensorInvalid();
Tom Joseph187f5642018-03-29 13:49:06 +0530768 }
769
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300770 auto path = iter->second[0].path;
Konstantin Aladyshev69e3cd42021-11-26 16:46:17 +0300771 if (!isFruPresent(ctx, path))
Kirill Pakhomovfa6e2092020-04-24 18:57:15 +0300772 {
773 return ipmi::responseSensorInvalid();
774 }
775
Marri Devender Raocac383b2017-07-03 13:24:27 -0500776 try
777 {
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000778 return ipmi::responseSuccess(
779 static_cast<uint16_t>(getFruAreaData(fruID).size()),
780 static_cast<uint8_t>(AccessMode::bytes));
Marri Devender Raocac383b2017-07-03 13:24:27 -0500781 }
Patrick Venture0b02be92018-08-31 11:55:55 -0700782 catch (const InternalFailure& e)
Marri Devender Raocac383b2017-07-03 13:24:27 -0500783 {
George Liu51856e62024-07-17 19:46:03 +0800784 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000785 return ipmi::responseUnspecifiedError();
Marri Devender Raocac383b2017-07-03 13:24:27 -0500786 }
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500787}
788
anil kumar appana5b7c3262019-05-27 18:10:23 +0000789/**@brief implements the Read FRU Data command
790 * @param fruDeviceId - FRU device ID. FFh = reserved
791 * @param offset - FRU inventory offset to read
792 * @param readCount - count to read
793 *
794 * @return IPMI completion code plus response data
795 * - returnCount - response data count.
796 * - data - response data
797 */
798ipmi::RspType<uint8_t, // count returned
799 std::vector<uint8_t>> // FRU data
800 ipmiStorageReadFruData(uint8_t fruDeviceId, uint16_t offset,
801 uint8_t readCount)
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500802{
anil kumar appana5b7c3262019-05-27 18:10:23 +0000803 if (fruDeviceId == 0xFF)
Tom Joseph187f5642018-03-29 13:49:06 +0530804 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000805 return ipmi::responseInvalidFieldRequest();
Tom Joseph187f5642018-03-29 13:49:06 +0530806 }
807
anil kumar appana5b7c3262019-05-27 18:10:23 +0000808 auto iter = frus.find(fruDeviceId);
809 if (iter == frus.end())
810 {
811 return ipmi::responseSensorInvalid();
812 }
813
Marri Devender Raocac383b2017-07-03 13:24:27 -0500814 try
815 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000816 const auto& fruArea = getFruAreaData(fruDeviceId);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500817 auto size = fruArea.size();
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500818
Tom Josephefcd68b2018-04-26 18:46:27 +0530819 if (offset >= size)
820 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000821 return ipmi::responseParmOutOfRange();
Tom Josephefcd68b2018-04-26 18:46:27 +0530822 }
823
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500824 // Write the count of response data.
anil kumar appana5b7c3262019-05-27 18:10:23 +0000825 uint8_t returnCount;
826 if ((offset + readCount) <= size)
Marri Devender Raocac383b2017-07-03 13:24:27 -0500827 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000828 returnCount = readCount;
Nagaraju Goruganti7f2d7c92018-03-21 11:18:30 -0500829 }
830 else
831 {
anil kumar appana5b7c3262019-05-27 18:10:23 +0000832 returnCount = size - offset;
Marri Devender Raocac383b2017-07-03 13:24:27 -0500833 }
Ratan Gupta2848d602018-01-31 20:39:20 +0530834
anil kumar appana5b7c3262019-05-27 18:10:23 +0000835 std::vector<uint8_t> fruData((fruArea.begin() + offset),
836 (fruArea.begin() + offset + returnCount));
Ratan Gupta2848d602018-01-31 20:39:20 +0530837
anil kumar appana5b7c3262019-05-27 18:10:23 +0000838 return ipmi::responseSuccess(returnCount, fruData);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500839 }
840 catch (const InternalFailure& e)
841 {
George Liu51856e62024-07-17 19:46:03 +0800842 lg2::error("Internal Failure: {ERROR}", "ERROR", e);
anil kumar appana5b7c3262019-05-27 18:10:23 +0000843 return ipmi::responseUnspecifiedError();
Marri Devender Raocac383b2017-07-03 13:24:27 -0500844 }
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500845}
846
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000847ipmi::RspType<uint8_t, // SDR version
848 uint16_t, // record count LS first
849 uint16_t, // free space in bytes, LS first
850 uint32_t, // addition timestamp LS first
851 uint32_t, // deletion timestamp LS first
852 uint8_t> // operation Support
853 ipmiGetRepositoryInfo()
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600854{
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000855 constexpr uint8_t sdrVersion = 0x51;
856 constexpr uint16_t freeSpace = 0xFFFF;
857 constexpr uint32_t additionTimestamp = 0x0;
858 constexpr uint32_t deletionTimestamp = 0x0;
859 constexpr uint8_t operationSupport = 0;
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600860
Willy Tu0ca3bfe2022-01-28 09:40:18 -0800861 // Get SDR count. This returns the total number of SDRs in the device.
862 const auto& entityRecords =
863 ipmi::sensor::EntityInfoMapContainer::getContainer()
864 ->getIpmiEntityRecords();
Patrick Williams1318a5e2024-08-16 15:19:54 -0400865 uint16_t records =
866 ipmi::sensor::sensors.size() + frus.size() + entityRecords.size();
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600867
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000868 return ipmi::responseSuccess(sdrVersion, records, freeSpace,
869 additionTimestamp, deletionTimestamp,
870 operationSupport);
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600871}
Chris Austenb4f5b922015-10-13 12:44:43 -0500872
Chris Austenb4f5b922015-10-13 12:44:43 -0500873void register_netfn_storage_functions()
874{
Lei YU3df36612021-09-15 11:41:11 +0800875 selCacheMapInitialized = false;
Lei YUd9e57662021-09-14 18:06:28 +0800876 initSELCache();
Willy Tud351a722021-08-12 14:33:40 -0700877 // Handlers with dbus-sdr handler implementation.
878 // Do not register the hander if it dynamic sensors stack is used.
879
880#ifndef FEATURE_DYNAMIC_SENSORS
Thang Tran292c9172023-06-26 10:03:04 +0700881
882#ifndef FEATURE_DYNAMIC_STORAGES_ONLY
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530883 // <Get SEL Info>
jayaprakash Mutyalab7557722019-05-02 21:13:30 +0000884 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
885 ipmi::storage::cmdGetSelInfo, ipmi::Privilege::User,
886 ipmiStorageGetSelInfo);
Tom Joseph6f7deaa2017-06-30 19:03:54 +0530887
Xiaochao Maf020c442022-10-31 11:09:38 +0800888 // <Get SEL Timezone>
889 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
890 ipmi::storage::cmdGetSelTimeUtcOffset,
891 ipmi::Privilege::User,
892 ipmiStorageGetSelTimeUtcOffset);
893
Tom Josepha4953392017-06-30 19:09:47 +0530894 // <Get SEL Entry>
George Liue6cd4df2024-12-05 17:07:59 +0800895 ipmi_register_callback(NETFUN_STORAGE, ipmi::storage::cmdGetSelEntry, NULL,
Patrick Venture0b02be92018-08-31 11:55:55 -0700896 getSELEntry, PRIVILEGE_USER);
Tom Josepha4953392017-06-30 19:09:47 +0530897
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530898 // <Delete SEL Entry>
Pradeep Kumar00a18d02019-04-26 17:04:28 +0000899 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
900 ipmi::storage::cmdDeleteSelEntry,
901 ipmi::Privilege::Operator, deleteSELEntry);
Tom Joseph8f4a2aa2017-06-30 19:12:49 +0530902
Tom05732372016-09-06 17:21:23 +0530903 // <Add SEL Entry>
anil kumar appana2c7db1d2019-05-28 11:20:19 +0000904 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
905 ipmi::storage::cmdAddSelEntry,
906 ipmi::Privilege::Operator, ipmiStorageAddSEL);
907
Tom Joseph2f05bb52017-06-30 19:14:49 +0530908 // <Clear SEL>
Pradeep Kumar4a5a99a2019-04-26 15:22:39 +0000909 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
910 ipmi::storage::cmdClearSel, ipmi::Privilege::Operator,
911 clearSEL);
912
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500913 // <Get FRU Inventory Area Info>
Pradeep Kumarb0c794d2019-05-02 13:09:14 +0000914 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
915 ipmi::storage::cmdGetFruInventoryAreaInfo,
916 ipmi::Privilege::User, ipmiStorageGetFruInvAreaInfo);
Marri Devender Raofa7b4e22017-07-03 00:52:20 -0500917
Jason M. Billsb5248c92019-06-24 15:53:08 -0700918 // <READ FRU Data>
anil kumar appana5b7c3262019-05-27 18:10:23 +0000919 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
920 ipmi::storage::cmdReadFruData,
921 ipmi::Privilege::Operator, ipmiStorageReadFruData);
Marri Devender Raocac383b2017-07-03 13:24:27 -0500922
Thang Tran292c9172023-06-26 10:03:04 +0700923#endif // FEATURE_DYNAMIC_STORAGES_ONLY
924
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600925 // <Get Repository Info>
Pradeep Kumarb60e8402019-05-06 15:17:01 +0000926 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
927 ipmi::storage::cmdGetSdrRepositoryInfo,
928 ipmi::Privilege::User, ipmiGetRepositoryInfo);
Dhruvaraj Subhashchandrane66c3b02018-02-07 01:21:56 -0600929
Tom Joseph5ca50952018-02-22 00:33:38 +0530930 // <Reserve SDR Repository>
jayaprakash Mutyalad9578232019-05-13 20:22:50 +0000931 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
932 ipmi::storage::cmdReserveSdrRepository,
933 ipmi::Privilege::User, ipmiSensorReserveSdr);
Tom Joseph5ca50952018-02-22 00:33:38 +0530934
935 // <Get SDR>
George Liue6cd4df2024-12-05 17:07:59 +0800936 ipmi_register_callback(NETFUN_STORAGE, ipmi::storage::cmdGetSdr, nullptr,
Patrick Venture0b02be92018-08-31 11:55:55 -0700937 ipmi_sen_get_sdr, PRIVILEGE_USER);
Tom Joseph5ca50952018-02-22 00:33:38 +0530938
Willy Tud351a722021-08-12 14:33:40 -0700939#endif
940
941 // Common Handers used by both implementation.
942
943 // <Reserve SEL>
944 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
945 ipmi::storage::cmdReserveSel, ipmi::Privilege::User,
946 ipmiStorageReserveSel);
947
Thang Trandbf66e12023-09-21 13:07:24 +0700948 // <Get SEL Time>
949 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
950 ipmi::storage::cmdGetSelTime, ipmi::Privilege::User,
951 ipmiStorageGetSelTime);
952
953 // <Set SEL Time>
954 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnStorage,
955 ipmi::storage::cmdSetSelTime,
956 ipmi::Privilege::Operator, ipmiStorageSetSelTime);
957
Marri Devender Rao908f7502017-07-10 01:49:54 -0500958 ipmi::fru::registerCallbackHandler();
Chris Austenb4f5b922015-10-13 12:44:43 -0500959 return;
960}