blob: a20d61ab1df888258a3bc55422a9e339de4deecc [file] [log] [blame]
Patrick Venture0b02be92018-08-31 11:55:55 -07001#include <arpa/inet.h>
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05302#include <fcntl.h>
Xo Wang87651332017-08-11 10:17:59 -07003#include <limits.h>
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05304#include <linux/i2c-dev.h>
5#include <linux/i2c.h>
Patrick Venture0b02be92018-08-31 11:55:55 -07006#include <mapper.h>
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05307#include <sys/ioctl.h>
8#include <sys/stat.h>
9#include <sys/types.h>
Patrick Venture0b02be92018-08-31 11:55:55 -070010#include <systemd/sd-bus.h>
Xo Wang87651332017-08-11 10:17:59 -070011#include <unistd.h>
Patrick Venture0b02be92018-08-31 11:55:55 -070012
Patrick Venture3a5071a2018-09-12 13:27:42 -070013#include <algorithm>
Vernon Mauery0120b682019-03-25 13:08:54 -070014#include <app/channel.hpp>
15#include <app/watchdog.hpp>
16#include <apphandler.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070017#include <array>
18#include <cstddef>
Vernon Mauery0120b682019-03-25 13:08:54 -070019#include <cstdint>
Vernon Mauerybdda8002019-02-26 10:18:51 -080020#include <filesystem>
Patrick Venture3a5071a2018-09-12 13:27:42 -070021#include <fstream>
Vernon Mauery0120b682019-03-25 13:08:54 -070022#include <ipmid/api.hpp>
Rajashekar Gade Reddye7023922019-07-10 16:54:55 +000023#include <ipmid/sessiondef.hpp>
24#include <ipmid/sessionhelper.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070025#include <ipmid/types.hpp>
Vernon Mauery6a98fe72019-03-11 15:57:48 -070026#include <ipmid/utils.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070027#include <memory>
Patrick Venture46470a32018-09-07 19:26:25 -070028#include <nlohmann/json.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070029#include <phosphor-logging/elog-errors.hpp>
30#include <phosphor-logging/log.hpp>
William A. Kennington III4c008022018-10-12 17:18:14 -070031#include <sdbusplus/message/types.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070032#include <string>
Vernon Mauery0120b682019-03-25 13:08:54 -070033#include <sys_info_param.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070034#include <tuple>
35#include <vector>
36#include <xyz/openbmc_project/Common/error.hpp>
Yong Li18d77262018-10-09 01:59:45 +080037#include <xyz/openbmc_project/Control/Power/ACPIPowerState/server.hpp>
Patrick Venture3a5071a2018-09-12 13:27:42 -070038#include <xyz/openbmc_project/Software/Activation/server.hpp>
39#include <xyz/openbmc_project/Software/Version/server.hpp>
40#include <xyz/openbmc_project/State/BMC/server.hpp>
Ratan Guptab8e99552017-07-27 07:07:48 +053041
Patrick Venture0b02be92018-08-31 11:55:55 -070042extern sd_bus* bus;
vishwabmcba0bd5f2015-09-30 16:50:23 +053043
Alexander Amelkinba19c182018-09-04 15:49:36 +030044constexpr auto bmc_state_interface = "xyz.openbmc_project.State.BMC";
45constexpr auto bmc_state_property = "CurrentBMCState";
Marri Devender Rao5e007a52018-01-08 06:18:36 -060046
Nagaraju Goruganti744398d2018-02-20 09:52:00 -060047static constexpr auto redundancyIntf =
48 "xyz.openbmc_project.Software.RedundancyPriority";
Patrick Venture0b02be92018-08-31 11:55:55 -070049static constexpr auto versionIntf = "xyz.openbmc_project.Software.Version";
Nagaraju Goruganti744398d2018-02-20 09:52:00 -060050static constexpr auto activationIntf =
51 "xyz.openbmc_project.Software.Activation";
52static constexpr auto softwareRoot = "/xyz/openbmc_project/software";
53
Chris Austen6caf28b2015-10-13 12:40:40 -050054void register_netfn_app_functions() __attribute__((constructor));
vishwabmcba0bd5f2015-09-30 16:50:23 +053055
Ratan Guptab8e99552017-07-27 07:07:48 +053056using namespace phosphor::logging;
57using namespace sdbusplus::xyz::openbmc_project::Common::Error;
Nagaraju Goruganti744398d2018-02-20 09:52:00 -060058using Version = sdbusplus::xyz::openbmc_project::Software::server::Version;
59using Activation =
60 sdbusplus::xyz::openbmc_project::Software::server::Activation;
Alexander Amelkinba19c182018-09-04 15:49:36 +030061using BMC = sdbusplus::xyz::openbmc_project::State::server::BMC;
Vernon Mauery185b9f82018-07-20 10:52:36 -070062namespace fs = std::filesystem;
Ratan Guptab8e99552017-07-27 07:07:48 +053063
Yong Libd0503a2019-08-22 17:17:17 +080064#ifdef ENABLE_I2C_WHITELIST_CHECK
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +053065typedef struct
66{
67 uint8_t busId;
68 uint8_t slaveAddr;
69 uint8_t slaveAddrMask;
70 std::vector<uint8_t> data;
71 std::vector<uint8_t> dataMask;
72} i2cMasterWRWhitelist;
73
74static std::vector<i2cMasterWRWhitelist>& getWRWhitelist()
75{
76 static std::vector<i2cMasterWRWhitelist> wrWhitelist;
77 return wrWhitelist;
78}
79
80static constexpr const char* i2cMasterWRWhitelistFile =
81 "/usr/share/ipmi-providers/master_write_read_white_list.json";
82
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +053083static constexpr const char* filtersStr = "filters";
84static constexpr const char* busIdStr = "busId";
85static constexpr const char* slaveAddrStr = "slaveAddr";
86static constexpr const char* slaveAddrMaskStr = "slaveAddrMask";
87static constexpr const char* cmdStr = "command";
88static constexpr const char* cmdMaskStr = "commandMask";
89static constexpr int base_16 = 16;
Yong Libd0503a2019-08-22 17:17:17 +080090#endif // ENABLE_I2C_WHITELIST_CHECK
Joshi-Mansi7fd91fa2021-06-11 07:18:15 +053091static constexpr uint8_t maxIPMIWriteReadSize = 255;
jayaprakash Mutyala3c5e4132020-04-27 23:00:05 +000092static constexpr uint8_t oemCmdStart = 192;
93static constexpr uint8_t oemCmdEnd = 255;
94static constexpr uint8_t invalidParamSelectorStart = 8;
95static constexpr uint8_t invalidParamSelectorEnd = 191;
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +053096
Nagaraju Goruganti744398d2018-02-20 09:52:00 -060097/**
98 * @brief Returns the Version info from primary s/w object
99 *
100 * Get the Version info from the active s/w object which is having high
101 * "Priority" value(a smaller number is a higher priority) and "Purpose"
102 * is "BMC" from the list of all s/w objects those are implementing
103 * RedundancyPriority interface from the given softwareRoot path.
104 *
105 * @return On success returns the Version info from primary s/w object.
106 *
107 */
Vernon Maueryea1c4012019-05-24 13:26:16 -0700108std::string getActiveSoftwareVersionInfo(ipmi::Context::ptr ctx)
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600109{
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600110 std::string revision{};
Vernon Mauery86a50822019-03-25 13:11:36 -0700111 ipmi::ObjectTree objectTree;
112 try
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600113 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700114 objectTree =
Vernon Maueryea1c4012019-05-24 13:26:16 -0700115 ipmi::getAllDbusObjects(*ctx->bus, softwareRoot, redundancyIntf);
Vernon Mauery86a50822019-03-25 13:11:36 -0700116 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500117 catch (const sdbusplus::exception::exception& e)
Vernon Mauery86a50822019-03-25 13:11:36 -0700118 {
119 log<level::ERR>("Failed to fetch redundancy object from dbus",
120 entry("INTERFACE=%s", redundancyIntf),
121 entry("ERRMSG=%s", e.what()));
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600122 elog<InternalFailure>();
123 }
124
125 auto objectFound = false;
126 for (auto& softObject : objectTree)
127 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700128 auto service =
Vernon Maueryea1c4012019-05-24 13:26:16 -0700129 ipmi::getService(*ctx->bus, redundancyIntf, softObject.first);
Vernon Mauery86a50822019-03-25 13:11:36 -0700130 auto objValueTree =
Vernon Maueryea1c4012019-05-24 13:26:16 -0700131 ipmi::getManagedObjects(*ctx->bus, service, softwareRoot);
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600132
133 auto minPriority = 0xFF;
134 for (const auto& objIter : objValueTree)
135 {
136 try
137 {
138 auto& intfMap = objIter.second;
139 auto& redundancyPriorityProps = intfMap.at(redundancyIntf);
140 auto& versionProps = intfMap.at(versionIntf);
141 auto& activationProps = intfMap.at(activationIntf);
Vernon Maueryf442e112019-04-09 11:44:36 -0700142 auto priority =
143 std::get<uint8_t>(redundancyPriorityProps.at("Priority"));
William A. Kennington III4c008022018-10-12 17:18:14 -0700144 auto purpose =
Vernon Maueryf442e112019-04-09 11:44:36 -0700145 std::get<std::string>(versionProps.at("Purpose"));
146 auto activation =
147 std::get<std::string>(activationProps.at("Activation"));
William A. Kennington III4c008022018-10-12 17:18:14 -0700148 auto version =
Vernon Maueryf442e112019-04-09 11:44:36 -0700149 std::get<std::string>(versionProps.at("Version"));
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600150 if ((Version::convertVersionPurposeFromString(purpose) ==
151 Version::VersionPurpose::BMC) &&
152 (Activation::convertActivationsFromString(activation) ==
153 Activation::Activations::Active))
154 {
155 if (priority < minPriority)
156 {
157 minPriority = priority;
158 objectFound = true;
159 revision = std::move(version);
160 }
161 }
162 }
163 catch (const std::exception& e)
164 {
165 log<level::ERR>(e.what());
166 }
167 }
168 }
169
170 if (!objectFound)
171 {
172 log<level::ERR>("Could not found an BMC software Object");
173 elog<InternalFailure>();
174 }
175
176 return revision;
177}
178
Alexander Amelkinba19c182018-09-04 15:49:36 +0300179bool getCurrentBmcState()
180{
181 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
182
183 // Get the Inventory object implementing the BMC interface
184 ipmi::DbusObjectInfo bmcObject =
185 ipmi::getDbusObject(bus, bmc_state_interface);
186 auto variant =
187 ipmi::getDbusProperty(bus, bmcObject.second, bmcObject.first,
188 bmc_state_interface, bmc_state_property);
189
Vernon Maueryf442e112019-04-09 11:44:36 -0700190 return std::holds_alternative<std::string>(variant) &&
191 BMC::convertBMCStateFromString(std::get<std::string>(variant)) ==
192 BMC::BMCState::Ready;
Alexander Amelkinba19c182018-09-04 15:49:36 +0300193}
194
Patrick Venture94930a12019-04-30 10:01:58 -0700195bool getCurrentBmcStateWithFallback(const bool fallbackAvailability)
196{
197 try
198 {
199 return getCurrentBmcState();
200 }
201 catch (...)
202 {
203 // Nothing provided the BMC interface, therefore return whatever was
204 // configured as the default.
205 return fallbackAvailability;
206 }
207}
208
Yong Li18d77262018-10-09 01:59:45 +0800209namespace acpi_state
210{
211using namespace sdbusplus::xyz::openbmc_project::Control::Power::server;
212
213const static constexpr char* acpiObjPath =
214 "/xyz/openbmc_project/control/host0/acpi_power_state";
215const static constexpr char* acpiInterface =
216 "xyz.openbmc_project.Control.Power.ACPIPowerState";
217const static constexpr char* sysACPIProp = "SysACPIStatus";
218const static constexpr char* devACPIProp = "DevACPIStatus";
219
220enum class PowerStateType : uint8_t
221{
222 sysPowerState = 0x00,
223 devPowerState = 0x01,
224};
225
226// Defined in 20.6 of ipmi doc
227enum class PowerState : uint8_t
228{
229 s0G0D0 = 0x00,
230 s1D1 = 0x01,
231 s2D2 = 0x02,
232 s3D3 = 0x03,
233 s4 = 0x04,
234 s5G2 = 0x05,
235 s4S5 = 0x06,
236 g3 = 0x07,
237 sleep = 0x08,
238 g1Sleep = 0x09,
239 override = 0x0a,
240 legacyOn = 0x20,
241 legacyOff = 0x21,
242 unknown = 0x2a,
243 noChange = 0x7f,
244};
245
246static constexpr uint8_t stateChanged = 0x80;
247
Yong Li18d77262018-10-09 01:59:45 +0800248std::map<ACPIPowerState::ACPI, PowerState> dbusToIPMI = {
249 {ACPIPowerState::ACPI::S0_G0_D0, PowerState::s0G0D0},
250 {ACPIPowerState::ACPI::S1_D1, PowerState::s1D1},
251 {ACPIPowerState::ACPI::S2_D2, PowerState::s2D2},
252 {ACPIPowerState::ACPI::S3_D3, PowerState::s3D3},
253 {ACPIPowerState::ACPI::S4, PowerState::s4},
254 {ACPIPowerState::ACPI::S5_G2, PowerState::s5G2},
255 {ACPIPowerState::ACPI::S4_S5, PowerState::s4S5},
256 {ACPIPowerState::ACPI::G3, PowerState::g3},
257 {ACPIPowerState::ACPI::SLEEP, PowerState::sleep},
258 {ACPIPowerState::ACPI::G1_SLEEP, PowerState::g1Sleep},
259 {ACPIPowerState::ACPI::OVERRIDE, PowerState::override},
260 {ACPIPowerState::ACPI::LEGACY_ON, PowerState::legacyOn},
261 {ACPIPowerState::ACPI::LEGACY_OFF, PowerState::legacyOff},
262 {ACPIPowerState::ACPI::Unknown, PowerState::unknown}};
263
264bool isValidACPIState(acpi_state::PowerStateType type, uint8_t state)
265{
266 if (type == acpi_state::PowerStateType::sysPowerState)
267 {
268 if ((state <= static_cast<uint8_t>(acpi_state::PowerState::override)) ||
269 (state == static_cast<uint8_t>(acpi_state::PowerState::legacyOn)) ||
270 (state ==
271 static_cast<uint8_t>(acpi_state::PowerState::legacyOff)) ||
272 (state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) ||
273 (state == static_cast<uint8_t>(acpi_state::PowerState::noChange)))
274 {
275 return true;
276 }
277 else
278 {
279 return false;
280 }
281 }
282 else if (type == acpi_state::PowerStateType::devPowerState)
283 {
284 if ((state <= static_cast<uint8_t>(acpi_state::PowerState::s3D3)) ||
285 (state == static_cast<uint8_t>(acpi_state::PowerState::unknown)) ||
286 (state == static_cast<uint8_t>(acpi_state::PowerState::noChange)))
287 {
288 return true;
289 }
290 else
291 {
292 return false;
293 }
294 }
295 else
296 {
297 return false;
298 }
299 return false;
300}
301} // namespace acpi_state
302
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000303/** @brief implements Set ACPI Power State command
304 * @param sysAcpiState - ACPI system power state to set
305 * @param devAcpiState - ACPI device power state to set
306 *
307 * @return IPMI completion code on success
308 **/
309ipmi::RspType<> ipmiSetAcpiPowerState(uint8_t sysAcpiState,
310 uint8_t devAcpiState)
Chris Austen6caf28b2015-10-13 12:40:40 -0500311{
Yong Li18d77262018-10-09 01:59:45 +0800312 auto s = static_cast<uint8_t>(acpi_state::PowerState::unknown);
Yong Li18d77262018-10-09 01:59:45 +0800313
314 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
315
316 auto value = acpi_state::ACPIPowerState::ACPI::Unknown;
317
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000318 if (sysAcpiState & acpi_state::stateChanged)
Yong Li18d77262018-10-09 01:59:45 +0800319 {
320 // set system power state
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000321 s = sysAcpiState & ~acpi_state::stateChanged;
Yong Li18d77262018-10-09 01:59:45 +0800322
323 if (!acpi_state::isValidACPIState(
324 acpi_state::PowerStateType::sysPowerState, s))
325 {
326 log<level::ERR>("set_acpi_power sys invalid input",
327 entry("S=%x", s));
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000328 return ipmi::responseParmOutOfRange();
Yong Li18d77262018-10-09 01:59:45 +0800329 }
330
331 // valid input
332 if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange))
333 {
334 log<level::DEBUG>("No change for system power state");
335 }
336 else
337 {
338 auto found = std::find_if(
339 acpi_state::dbusToIPMI.begin(), acpi_state::dbusToIPMI.end(),
340 [&s](const auto& iter) {
341 return (static_cast<uint8_t>(iter.second) == s);
342 });
343
344 value = found->first;
345
346 try
347 {
348 auto acpiObject =
349 ipmi::getDbusObject(bus, acpi_state::acpiInterface);
350 ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first,
351 acpi_state::acpiInterface,
352 acpi_state::sysACPIProp,
353 convertForMessage(value));
354 }
355 catch (const InternalFailure& e)
356 {
357 log<level::ERR>("Failed in set ACPI system property",
358 entry("EXCEPTION=%s", e.what()));
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000359 return ipmi::responseUnspecifiedError();
Yong Li18d77262018-10-09 01:59:45 +0800360 }
361 }
362 }
363 else
364 {
365 log<level::DEBUG>("Do not change system power state");
366 }
367
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000368 if (devAcpiState & acpi_state::stateChanged)
Yong Li18d77262018-10-09 01:59:45 +0800369 {
370 // set device power state
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000371 s = devAcpiState & ~acpi_state::stateChanged;
Yong Li18d77262018-10-09 01:59:45 +0800372 if (!acpi_state::isValidACPIState(
373 acpi_state::PowerStateType::devPowerState, s))
374 {
375 log<level::ERR>("set_acpi_power dev invalid input",
376 entry("S=%x", s));
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000377 return ipmi::responseParmOutOfRange();
Yong Li18d77262018-10-09 01:59:45 +0800378 }
379
380 // valid input
381 if (s == static_cast<uint8_t>(acpi_state::PowerState::noChange))
382 {
383 log<level::DEBUG>("No change for device power state");
384 }
385 else
386 {
387 auto found = std::find_if(
388 acpi_state::dbusToIPMI.begin(), acpi_state::dbusToIPMI.end(),
389 [&s](const auto& iter) {
390 return (static_cast<uint8_t>(iter.second) == s);
391 });
392
393 value = found->first;
394
395 try
396 {
397 auto acpiObject =
398 ipmi::getDbusObject(bus, acpi_state::acpiInterface);
399 ipmi::setDbusProperty(bus, acpiObject.second, acpiObject.first,
400 acpi_state::acpiInterface,
401 acpi_state::devACPIProp,
402 convertForMessage(value));
403 }
404 catch (const InternalFailure& e)
405 {
406 log<level::ERR>("Failed in set ACPI device property",
407 entry("EXCEPTION=%s", e.what()));
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000408 return ipmi::responseUnspecifiedError();
Yong Li18d77262018-10-09 01:59:45 +0800409 }
410 }
411 }
412 else
413 {
414 log<level::DEBUG>("Do not change device power state");
415 }
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +0000416 return ipmi::responseSuccess();
Yong Li18d77262018-10-09 01:59:45 +0800417}
418
Deepak Kumar Sahu4e6d2572019-05-07 19:53:37 +0000419/**
420 * @brief implements the get ACPI power state command
421 *
422 * @return IPMI completion code plus response data on success.
423 * - ACPI system power state
424 * - ACPI device power state
425 **/
426ipmi::RspType<uint8_t, // acpiSystemPowerState
427 uint8_t // acpiDevicePowerState
428 >
429 ipmiGetAcpiPowerState()
Yong Li18d77262018-10-09 01:59:45 +0800430{
Deepak Kumar Sahu4e6d2572019-05-07 19:53:37 +0000431 uint8_t sysAcpiState;
432 uint8_t devAcpiState;
Yong Li18d77262018-10-09 01:59:45 +0800433
434 sdbusplus::bus::bus bus{ipmid_get_sd_bus_connection()};
435
Yong Li18d77262018-10-09 01:59:45 +0800436 try
437 {
438 auto acpiObject = ipmi::getDbusObject(bus, acpi_state::acpiInterface);
439
440 auto sysACPIVal = ipmi::getDbusProperty(
441 bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface,
442 acpi_state::sysACPIProp);
443 auto sysACPI = acpi_state::ACPIPowerState::convertACPIFromString(
Vernon Maueryf442e112019-04-09 11:44:36 -0700444 std::get<std::string>(sysACPIVal));
Deepak Kumar Sahu4e6d2572019-05-07 19:53:37 +0000445 sysAcpiState = static_cast<uint8_t>(acpi_state::dbusToIPMI.at(sysACPI));
Yong Li18d77262018-10-09 01:59:45 +0800446
447 auto devACPIVal = ipmi::getDbusProperty(
448 bus, acpiObject.second, acpiObject.first, acpi_state::acpiInterface,
449 acpi_state::devACPIProp);
450 auto devACPI = acpi_state::ACPIPowerState::convertACPIFromString(
Vernon Maueryf442e112019-04-09 11:44:36 -0700451 std::get<std::string>(devACPIVal));
Deepak Kumar Sahu4e6d2572019-05-07 19:53:37 +0000452 devAcpiState = static_cast<uint8_t>(acpi_state::dbusToIPMI.at(devACPI));
Yong Li18d77262018-10-09 01:59:45 +0800453 }
454 catch (const InternalFailure& e)
455 {
Deepak Kumar Sahu4e6d2572019-05-07 19:53:37 +0000456 return ipmi::responseUnspecifiedError();
Yong Li18d77262018-10-09 01:59:45 +0800457 }
Deepak Kumar Sahu4e6d2572019-05-07 19:53:37 +0000458
459 return ipmi::responseSuccess(sysAcpiState, devAcpiState);
Chris Austen6caf28b2015-10-13 12:40:40 -0500460}
461
Chris Austen7303bdc2016-04-17 11:50:54 -0500462typedef struct
463{
464 char major;
465 char minor;
Chris Austen176c9652016-04-30 16:32:17 -0500466 uint16_t d[2];
Vernon Mauery86a50822019-03-25 13:11:36 -0700467} Revision;
Chris Austen7303bdc2016-04-17 11:50:54 -0500468
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600469/* Currently supports the vx.x-x-[-x] and v1.x.x-x-[-x] format. It will */
470/* return -1 if not in those formats, this routine knows how to parse */
Chris Austen7303bdc2016-04-17 11:50:54 -0500471/* version = v0.6-19-gf363f61-dirty */
472/* ^ ^ ^^ ^ */
473/* | | |----------|-- additional details */
474/* | |---------------- Minor */
475/* |------------------ Major */
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600476/* and version = v1.99.10-113-g65edf7d-r3-0-g9e4f715 */
477/* ^ ^ ^^ ^ */
478/* | | |--|---------- additional details */
479/* | |---------------- Minor */
480/* |------------------ Major */
Chris Austen7303bdc2016-04-17 11:50:54 -0500481/* Additional details : If the option group exists it will force Auxiliary */
482/* Firmware Revision Information 4th byte to 1 indicating the build was */
483/* derived with additional edits */
Vernon Mauery86a50822019-03-25 13:11:36 -0700484int convertVersion(std::string s, Revision& rev)
Chris Austen7303bdc2016-04-17 11:50:54 -0500485{
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600486 std::string token;
Chris Austen176c9652016-04-30 16:32:17 -0500487 uint16_t commits;
Chris Austen7303bdc2016-04-17 11:50:54 -0500488
Patrick Venture0b02be92018-08-31 11:55:55 -0700489 auto location = s.find_first_of('v');
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600490 if (location != std::string::npos)
491 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700492 s = s.substr(location + 1);
Chris Austen176c9652016-04-30 16:32:17 -0500493 }
Chris Austen7303bdc2016-04-17 11:50:54 -0500494
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600495 if (!s.empty())
496 {
497 location = s.find_first_of(".");
498 if (location != std::string::npos)
499 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700500 rev.major =
Patrick Venture0b02be92018-08-31 11:55:55 -0700501 static_cast<char>(std::stoi(s.substr(0, location), 0, 16));
502 token = s.substr(location + 1);
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600503 }
Chris Austen176c9652016-04-30 16:32:17 -0500504
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600505 if (!token.empty())
506 {
507 location = token.find_first_of(".-");
508 if (location != std::string::npos)
509 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700510 rev.minor = static_cast<char>(
Patrick Venture0b02be92018-08-31 11:55:55 -0700511 std::stoi(token.substr(0, location), 0, 16));
512 token = token.substr(location + 1);
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600513 }
514 }
Chris Austen7303bdc2016-04-17 11:50:54 -0500515
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600516 // Capture the number of commits on top of the minor tag.
517 // I'm using BE format like the ipmi spec asked for
518 location = token.find_first_of(".-");
519 if (!token.empty())
520 {
521 commits = std::stoi(token.substr(0, location), 0, 16);
Vernon Mauery86a50822019-03-25 13:11:36 -0700522 rev.d[0] = (commits >> 8) | (commits << 8);
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600523
524 // commit number we skip
525 location = token.find_first_of(".-");
526 if (location != std::string::npos)
527 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700528 token = token.substr(location + 1);
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600529 }
530 }
Patrick Venture0b02be92018-08-31 11:55:55 -0700531 else
532 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700533 rev.d[0] = 0;
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600534 }
535
536 if (location != std::string::npos)
537 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700538 token = token.substr(location + 1);
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600539 }
540
541 // Any value of the optional parameter forces it to 1
542 location = token.find_first_of(".-");
543 if (location != std::string::npos)
544 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700545 token = token.substr(location + 1);
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600546 }
547 commits = (!token.empty()) ? 1 : 0;
548
Patrick Venture0b02be92018-08-31 11:55:55 -0700549 // We do this operation to get this displayed in least significant bytes
550 // of ipmitool device id command.
Vernon Mauery86a50822019-03-25 13:11:36 -0700551 rev.d[1] = (commits >> 8) | (commits << 8);
Dinesh Chinari2b7e07d2017-11-08 15:38:50 -0600552 }
553
Chris Austen7303bdc2016-04-17 11:50:54 -0500554 return 0;
555}
556
Vernon Maueryea1c4012019-05-24 13:26:16 -0700557/* @brief: Implement the Get Device ID IPMI command per the IPMI spec
558 * @param[in] ctx - shared_ptr to an IPMI context struct
559 *
560 * @returns IPMI completion code plus response data
561 * - Device ID (manufacturer defined)
562 * - Device revision[4 bits]; reserved[3 bits]; SDR support[1 bit]
563 * - FW revision major[7 bits] (binary encoded); available[1 bit]
564 * - FW Revision minor (BCD encoded)
565 * - IPMI version (0x02 for IPMI 2.0)
566 * - device support (bitfield of supported options)
567 * - MFG IANA ID (3 bytes)
568 * - product ID (2 bytes)
569 * - AUX info (4 bytes)
570 */
571ipmi::RspType<uint8_t, // Device ID
572 uint8_t, // Device Revision
573 uint8_t, // Firmware Revision Major
574 uint8_t, // Firmware Revision minor
575 uint8_t, // IPMI version
576 uint8_t, // Additional device support
577 uint24_t, // MFG ID
578 uint16_t, // Product ID
579 uint32_t // AUX info
580 >
581 ipmiAppGetDeviceId(ipmi::Context::ptr ctx)
Chris Austen6caf28b2015-10-13 12:40:40 -0500582{
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600583 int r = -1;
Vernon Mauery86a50822019-03-25 13:11:36 -0700584 Revision rev = {0};
585 static struct
586 {
587 uint8_t id;
588 uint8_t revision;
589 uint8_t fw[2];
590 uint8_t ipmiVer;
591 uint8_t addnDevSupport;
592 uint24_t manufId;
593 uint16_t prodId;
594 uint32_t aux;
595 } devId;
David Cobbleya1adb072017-11-21 15:58:13 -0800596 static bool dev_id_initialized = false;
Patrick Venture94930a12019-04-30 10:01:58 -0700597 static bool defaultActivationSetting = true;
David Cobbleya1adb072017-11-21 15:58:13 -0800598 const char* filename = "/usr/share/ipmi-providers/dev_id.json";
Alexander Amelkinba19c182018-09-04 15:49:36 +0300599 constexpr auto ipmiDevIdStateShift = 7;
600 constexpr auto ipmiDevIdFw1Mask = ~(1 << ipmiDevIdStateShift);
Chris Austen6caf28b2015-10-13 12:40:40 -0500601
David Cobbleya1adb072017-11-21 15:58:13 -0800602 if (!dev_id_initialized)
603 {
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600604 try
605 {
Vernon Maueryea1c4012019-05-24 13:26:16 -0700606 auto version = getActiveSoftwareVersionInfo(ctx);
Vernon Mauery86a50822019-03-25 13:11:36 -0700607 r = convertVersion(version, rev);
David Cobbleya1adb072017-11-21 15:58:13 -0800608 }
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600609 catch (const std::exception& e)
610 {
611 log<level::ERR>(e.what());
612 }
Nan Liee0cb902016-07-11 15:38:03 +0800613
Patrick Venture0b02be92018-08-31 11:55:55 -0700614 if (r >= 0)
615 {
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600616 // bit7 identifies if the device is available
617 // 0=normal operation
618 // 1=device firmware, SDR update,
619 // or self-initialization in progress.
Alexander Amelkinba19c182018-09-04 15:49:36 +0300620 // The availability may change in run time, so mask here
621 // and initialize later.
Vernon Mauery86a50822019-03-25 13:11:36 -0700622 devId.fw[0] = rev.major & ipmiDevIdFw1Mask;
Nagaraju Goruganti744398d2018-02-20 09:52:00 -0600623
624 rev.minor = (rev.minor > 99 ? 99 : rev.minor);
Vernon Mauery86a50822019-03-25 13:11:36 -0700625 devId.fw[1] = rev.minor % 10 + (rev.minor / 10) * 16;
626 std::memcpy(&devId.aux, rev.d, 4);
David Cobbleya1adb072017-11-21 15:58:13 -0800627 }
Nan Liee0cb902016-07-11 15:38:03 +0800628
David Cobbleya1adb072017-11-21 15:58:13 -0800629 // IPMI Spec version 2.0
Vernon Mauery86a50822019-03-25 13:11:36 -0700630 devId.ipmiVer = 2;
Adriana Kobylak0e912642016-06-22 16:54:39 -0500631
Vernon Mauery86a50822019-03-25 13:11:36 -0700632 std::ifstream devIdFile(filename);
633 if (devIdFile.is_open())
David Cobbleya1adb072017-11-21 15:58:13 -0800634 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700635 auto data = nlohmann::json::parse(devIdFile, nullptr, false);
David Cobbleya1adb072017-11-21 15:58:13 -0800636 if (!data.is_discarded())
637 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700638 devId.id = data.value("id", 0);
639 devId.revision = data.value("revision", 0);
640 devId.addnDevSupport = data.value("addn_dev_support", 0);
641 devId.manufId = data.value("manuf_id", 0);
642 devId.prodId = data.value("prod_id", 0);
643 devId.aux = data.value("aux", 0);
David Cobbleya1adb072017-11-21 15:58:13 -0800644
Patrick Venture94930a12019-04-30 10:01:58 -0700645 // Set the availablitity of the BMC.
646 defaultActivationSetting = data.value("availability", true);
647
Patrick Venture0b02be92018-08-31 11:55:55 -0700648 // Don't read the file every time if successful
David Cobbleya1adb072017-11-21 15:58:13 -0800649 dev_id_initialized = true;
650 }
651 else
652 {
653 log<level::ERR>("Device ID JSON parser failure");
Vernon Maueryf2587fc2019-04-09 14:28:15 -0700654 return ipmi::responseUnspecifiedError();
David Cobbleya1adb072017-11-21 15:58:13 -0800655 }
656 }
657 else
658 {
659 log<level::ERR>("Device ID file not found");
Vernon Maueryf2587fc2019-04-09 14:28:15 -0700660 return ipmi::responseUnspecifiedError();
Chris Austen7303bdc2016-04-17 11:50:54 -0500661 }
662 }
Chris Austen6caf28b2015-10-13 12:40:40 -0500663
Alexander Amelkinba19c182018-09-04 15:49:36 +0300664 // Set availability to the actual current BMC state
Vernon Mauery86a50822019-03-25 13:11:36 -0700665 devId.fw[0] &= ipmiDevIdFw1Mask;
Patrick Venture94930a12019-04-30 10:01:58 -0700666 if (!getCurrentBmcStateWithFallback(defaultActivationSetting))
Alexander Amelkinba19c182018-09-04 15:49:36 +0300667 {
Vernon Mauery86a50822019-03-25 13:11:36 -0700668 devId.fw[0] |= (1 << ipmiDevIdStateShift);
Alexander Amelkinba19c182018-09-04 15:49:36 +0300669 }
670
Vernon Mauery86a50822019-03-25 13:11:36 -0700671 return ipmi::responseSuccess(
672 devId.id, devId.revision, devId.fw[0], devId.fw[1], devId.ipmiVer,
673 devId.addnDevSupport, devId.manufId, devId.prodId, devId.aux);
Chris Austen6caf28b2015-10-13 12:40:40 -0500674}
675
Vernon Maueryb84a5282019-03-25 13:39:03 -0700676auto ipmiAppGetSelfTestResults() -> ipmi::RspType<uint8_t, uint8_t>
Nan Li41fa24a2016-11-10 20:12:37 +0800677{
Nan Li41fa24a2016-11-10 20:12:37 +0800678 // Byte 2:
679 // 55h - No error.
Gunnar Mills8991dd62017-10-25 17:11:29 -0500680 // 56h - Self Test function not implemented in this controller.
Nan Li41fa24a2016-11-10 20:12:37 +0800681 // 57h - Corrupted or inaccesssible data or devices.
682 // 58h - Fatal hardware error.
683 // FFh - reserved.
684 // all other: Device-specific 'internal failure'.
685 // Byte 3:
686 // For byte 2 = 55h, 56h, FFh: 00h
687 // For byte 2 = 58h, all other: Device-specific
688 // For byte 2 = 57h: self-test error bitfield.
689 // Note: returning 57h does not imply that all test were run.
690 // [7] 1b = Cannot access SEL device.
691 // [6] 1b = Cannot access SDR Repository.
692 // [5] 1b = Cannot access BMC FRU device.
693 // [4] 1b = IPMB signal lines do not respond.
694 // [3] 1b = SDR Repository empty.
695 // [2] 1b = Internal Use Area of BMC FRU corrupted.
696 // [1] 1b = controller update 'boot block' firmware corrupted.
697 // [0] 1b = controller operational firmware corrupted.
Vernon Maueryb84a5282019-03-25 13:39:03 -0700698 constexpr uint8_t notImplemented = 0x56;
699 constexpr uint8_t zero = 0;
700 return ipmi::responseSuccess(notImplemented, zero);
Nan Li41fa24a2016-11-10 20:12:37 +0800701}
702
Vernon Mauery15541322019-03-25 13:33:03 -0700703static constexpr size_t uuidBinaryLength = 16;
704static std::array<uint8_t, uuidBinaryLength> rfc4122ToIpmi(std::string rfc4122)
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500705{
Vernon Mauery15541322019-03-25 13:33:03 -0700706 using Argument = xyz::openbmc_project::Common::InvalidArgument;
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500707 // UUID is in RFC4122 format. Ex: 61a39523-78f2-11e5-9862-e6402cfc3223
Patrick Ventured2117022018-02-06 08:54:37 -0800708 // Per IPMI Spec 2.0 need to convert to 16 hex bytes and reverse the byte
709 // order
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500710 // Ex: 0x2332fc2c40e66298e511f2782395a361
Vernon Mauery15541322019-03-25 13:33:03 -0700711 constexpr size_t uuidHexLength = (2 * uuidBinaryLength);
712 constexpr size_t uuidRfc4122Length = (uuidHexLength + 4);
713 std::array<uint8_t, uuidBinaryLength> uuid;
714 if (rfc4122.size() == uuidRfc4122Length)
Patrick Venture0b02be92018-08-31 11:55:55 -0700715 {
Vernon Mauery15541322019-03-25 13:33:03 -0700716 rfc4122.erase(std::remove(rfc4122.begin(), rfc4122.end(), '-'),
717 rfc4122.end());
Sergey Solomineb9b8142016-08-23 09:07:28 -0500718 }
Vernon Mauery15541322019-03-25 13:33:03 -0700719 if (rfc4122.size() != uuidHexLength)
vishwa1eaea4f2016-02-26 11:57:40 -0600720 {
Vernon Mauery15541322019-03-25 13:33:03 -0700721 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"),
722 Argument::ARGUMENT_VALUE(rfc4122.c_str()));
vishwa1eaea4f2016-02-26 11:57:40 -0600723 }
Vernon Mauery15541322019-03-25 13:33:03 -0700724 for (size_t ind = 0; ind < uuidHexLength; ind += 2)
vishwa1eaea4f2016-02-26 11:57:40 -0600725 {
Vernon Mauery15541322019-03-25 13:33:03 -0700726 char v[3];
727 v[0] = rfc4122[ind];
728 v[1] = rfc4122[ind + 1];
729 v[2] = 0;
730 size_t err;
731 long b;
732 try
Emily Shafferedb8bb02018-09-27 14:50:15 -0700733 {
Vernon Mauery15541322019-03-25 13:33:03 -0700734 b = std::stoul(v, &err, 16);
Emily Shafferedb8bb02018-09-27 14:50:15 -0700735 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500736 catch (const std::exception& e)
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500737 {
Vernon Mauery15541322019-03-25 13:33:03 -0700738 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"),
739 Argument::ARGUMENT_VALUE(rfc4122.c_str()));
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500740 }
Vernon Mauery15541322019-03-25 13:33:03 -0700741 // check that exactly two ascii bytes were converted
742 if (err != 2)
743 {
744 elog<InvalidArgument>(Argument::ARGUMENT_NAME("rfc4122"),
745 Argument::ARGUMENT_VALUE(rfc4122.c_str()));
746 }
747 uuid[uuidBinaryLength - (ind / 2) - 1] = static_cast<uint8_t>(b);
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500748 }
Vernon Mauery15541322019-03-25 13:33:03 -0700749 return uuid;
750}
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500751
Vernon Mauery15541322019-03-25 13:33:03 -0700752auto ipmiAppGetDeviceGuid()
753 -> ipmi::RspType<std::array<uint8_t, uuidBinaryLength>>
754{
755 // return a fixed GUID based on /etc/machine-id
756 // This should match the /redfish/v1/Managers/bmc's UUID data
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500757
Vernon Mauery15541322019-03-25 13:33:03 -0700758 // machine specific application ID (for BMC ID)
759 // generated by systemd-id128 -p new as per man page
760 static constexpr sd_id128_t bmcUuidAppId = SD_ID128_MAKE(
761 e0, e1, 73, 76, 64, 61, 47, da, a5, 0c, d0, cc, 64, 12, 45, 78);
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500762
Vernon Mauery15541322019-03-25 13:33:03 -0700763 sd_id128_t bmcUuid;
764 // create the UUID from /etc/machine-id via the systemd API
765 sd_id128_get_machine_app_specific(bmcUuidAppId, &bmcUuid);
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500766
Vernon Mauery15541322019-03-25 13:33:03 -0700767 char bmcUuidCstr[SD_ID128_STRING_MAX];
768 std::string systemUuid = sd_id128_to_string(bmcUuid, bmcUuidCstr);
769
770 std::array<uint8_t, uuidBinaryLength> uuid = rfc4122ToIpmi(systemUuid);
771 return ipmi::responseSuccess(uuid);
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500772}
Chris Austen6caf28b2015-10-13 12:40:40 -0500773
Vernon Mauerycc99ba42019-03-25 13:40:11 -0700774auto ipmiAppGetBtCapabilities()
775 -> ipmi::RspType<uint8_t, uint8_t, uint8_t, uint8_t, uint8_t>
vishwabmcba0bd5f2015-09-30 16:50:23 +0530776{
Adriana Kobylak88ad8152016-12-13 10:09:08 -0600777 // Per IPMI 2.0 spec, the input and output buffer size must be the max
778 // buffer size minus one byte to allocate space for the length byte.
Vernon Mauerycc99ba42019-03-25 13:40:11 -0700779 constexpr uint8_t nrOutstanding = 0x01;
780 constexpr uint8_t inputBufferSize = MAX_IPMI_BUFFER - 1;
781 constexpr uint8_t outputBufferSize = MAX_IPMI_BUFFER - 1;
782 constexpr uint8_t transactionTime = 0x0A;
783 constexpr uint8_t nrRetries = 0x01;
vishwabmcba0bd5f2015-09-30 16:50:23 +0530784
Vernon Mauerycc99ba42019-03-25 13:40:11 -0700785 return ipmi::responseSuccess(nrOutstanding, inputBufferSize,
786 outputBufferSize, transactionTime, nrRetries);
vishwabmcba0bd5f2015-09-30 16:50:23 +0530787}
788
Vernon Maueryb90a5322019-03-25 13:36:55 -0700789auto ipmiAppGetSystemGuid() -> ipmi::RspType<std::array<uint8_t, 16>>
Marri Devender Rao5e007a52018-01-08 06:18:36 -0600790{
Vernon Maueryb90a5322019-03-25 13:36:55 -0700791 static constexpr auto bmcInterface =
792 "xyz.openbmc_project.Inventory.Item.Bmc";
793 static constexpr auto uuidInterface = "xyz.openbmc_project.Common.UUID";
794 static constexpr auto uuidProperty = "UUID";
Marri Devender Rao5e007a52018-01-08 06:18:36 -0600795
Vernon Maueryb90a5322019-03-25 13:36:55 -0700796 ipmi::Value propValue;
Marri Devender Rao5e007a52018-01-08 06:18:36 -0600797 try
798 {
799 // Get the Inventory object implementing BMC interface
Vernon Maueryb90a5322019-03-25 13:36:55 -0700800 auto busPtr = getSdBus();
801 auto objectInfo = ipmi::getDbusObject(*busPtr, bmcInterface);
Marri Devender Rao5e007a52018-01-08 06:18:36 -0600802
803 // Read UUID property value from bmcObject
804 // UUID is in RFC4122 format Ex: 61a39523-78f2-11e5-9862-e6402cfc3223
Vernon Maueryb90a5322019-03-25 13:36:55 -0700805 propValue =
806 ipmi::getDbusProperty(*busPtr, objectInfo.second, objectInfo.first,
807 uuidInterface, uuidProperty);
Marri Devender Rao5e007a52018-01-08 06:18:36 -0600808 }
809 catch (const InternalFailure& e)
810 {
811 log<level::ERR>("Failed in reading BMC UUID property",
Vernon Maueryb90a5322019-03-25 13:36:55 -0700812 entry("INTERFACE=%s", uuidInterface),
813 entry("PROPERTY=%s", uuidProperty));
814 return ipmi::responseUnspecifiedError();
Marri Devender Rao5e007a52018-01-08 06:18:36 -0600815 }
Vernon Maueryb90a5322019-03-25 13:36:55 -0700816 std::array<uint8_t, 16> uuid;
817 std::string rfc4122Uuid = std::get<std::string>(propValue);
818 try
819 {
820 // convert to IPMI format
821 uuid = rfc4122ToIpmi(rfc4122Uuid);
822 }
823 catch (const InvalidArgument& e)
824 {
825 log<level::ERR>("Failed in parsing BMC UUID property",
826 entry("INTERFACE=%s", uuidInterface),
827 entry("PROPERTY=%s", uuidProperty),
828 entry("VALUE=%s", rfc4122Uuid.c_str()));
829 return ipmi::responseUnspecifiedError();
830 }
831 return ipmi::responseSuccess(uuid);
Marri Devender Rao5e007a52018-01-08 06:18:36 -0600832}
833
Rajashekar Gade Reddye7023922019-07-10 16:54:55 +0000834/**
835 * @brief set the session state as teardown
836 *
837 * This function is to set the session state to tear down in progress if the
838 * state is active.
839 *
840 * @param[in] busp - Dbus obj
841 * @param[in] service - service name
842 * @param[in] obj - object path
843 *
844 * @return success completion code if it sets the session state to
845 * tearDownInProgress else return the corresponding error completion code.
846 **/
847uint8_t setSessionState(std::shared_ptr<sdbusplus::asio::connection>& busp,
848 const std::string& service, const std::string& obj)
849{
850 try
851 {
852 uint8_t sessionState = std::get<uint8_t>(ipmi::getDbusProperty(
853 *busp, service, obj, session::sessionIntf, "State"));
854
855 if (sessionState == static_cast<uint8_t>(session::State::active))
856 {
857 ipmi::setDbusProperty(
858 *busp, service, obj, session::sessionIntf, "State",
859 static_cast<uint8_t>(session::State::tearDownInProgress));
860 return ipmi::ccSuccess;
861 }
862 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500863 catch (const std::exception& e)
Rajashekar Gade Reddye7023922019-07-10 16:54:55 +0000864 {
865 log<level::ERR>("Failed in getting session state property",
866 entry("service=%s", service.c_str()),
867 entry("object path=%s", obj.c_str()),
868 entry("interface=%s", session::sessionIntf));
869 return ipmi::ccUnspecifiedError;
870 }
871
872 return ipmi::ccInvalidFieldRequest;
873}
874
875ipmi::RspType<> ipmiAppCloseSession(uint32_t reqSessionId,
876 std::optional<uint8_t> requestSessionHandle)
877{
878 auto busp = getSdBus();
879 uint8_t reqSessionHandle =
880 requestSessionHandle.value_or(session::defaultSessionHandle);
881
882 if (reqSessionId == session::sessionZero &&
883 reqSessionHandle == session::defaultSessionHandle)
884 {
885 return ipmi::response(session::ccInvalidSessionId);
886 }
887
888 if (reqSessionId == session::sessionZero &&
889 reqSessionHandle == session::invalidSessionHandle)
890 {
891 return ipmi::response(session::ccInvalidSessionHandle);
892 }
893
894 if (reqSessionId != session::sessionZero &&
895 reqSessionHandle != session::defaultSessionHandle)
896 {
897 return ipmi::response(ipmi::ccInvalidFieldRequest);
898 }
899
900 try
901 {
902 ipmi::ObjectTree objectTree = ipmi::getAllDbusObjects(
903 *busp, session::sessionManagerRootPath, session::sessionIntf);
904
905 for (auto& objectTreeItr : objectTree)
906 {
907 const std::string obj = objectTreeItr.first;
908
909 if (isSessionObjectMatched(obj, reqSessionId, reqSessionHandle))
910 {
911 auto& serviceMap = objectTreeItr.second;
912
913 // Session id and session handle are unique for each session.
914 // Session id and handler are retrived from the object path and
915 // object path will be unique for each session. Checking if
916 // multiple objects exist with same object path under multiple
917 // services.
918 if (serviceMap.size() != 1)
919 {
920 return ipmi::responseUnspecifiedError();
921 }
922
923 auto itr = serviceMap.begin();
924 const std::string service = itr->first;
925 return ipmi::response(setSessionState(busp, service, obj));
926 }
927 }
928 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500929 catch (const sdbusplus::exception::exception& e)
Rajashekar Gade Reddye7023922019-07-10 16:54:55 +0000930 {
931 log<level::ERR>("Failed to fetch object from dbus",
932 entry("INTERFACE=%s", session::sessionIntf),
933 entry("ERRMSG=%s", e.what()));
934 return ipmi::responseUnspecifiedError();
935 }
936
937 return ipmi::responseInvalidFieldRequest();
938}
939
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +0000940uint8_t getTotalSessionCount()
941{
Meera-Kattac1789482021-05-18 09:53:26 +0000942 uint8_t count = 0, ch = 0;
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +0000943
944 while (ch < ipmi::maxIpmiChannels &&
945 count < session::maxNetworkInstanceSupported)
946 {
Jayaprakash Mutyala80207e62020-07-04 16:34:15 +0000947 ipmi::ChannelInfo chInfo{};
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +0000948 ipmi::getChannelInfo(ch, chInfo);
949 if (static_cast<ipmi::EChannelMediumType>(chInfo.mediumType) ==
950 ipmi::EChannelMediumType::lan8032)
951 {
952 count++;
953 }
954 ch++;
955 }
956 return count * session::maxSessionCountPerChannel;
957}
958
959/**
960 * @brief get session info request data.
961 *
962 * This function validates the request data and retrive request session id,
963 * session handle.
964 *
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530965 * @param[in] ctx - context of current session.
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +0000966 * @param[in] sessionIndex - request session index
967 * @param[in] payload - input payload
968 * @param[in] reqSessionId - unpacked session Id will be asigned
969 * @param[in] reqSessionHandle - unpacked session handle will be asigned
970 *
971 * @return success completion code if request data is valid
972 * else return the correcponding error completion code.
973 **/
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530974uint8_t getSessionInfoRequestData(const ipmi::Context::ptr ctx,
975 const uint8_t sessionIndex,
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +0000976 ipmi::message::Payload& payload,
977 uint32_t& reqSessionId,
978 uint8_t& reqSessionHandle)
979{
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530980 if ((sessionIndex > session::maxSessionCountPerChannel) &&
981 (sessionIndex < session::searchSessionByHandle))
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +0000982 {
983 return ipmi::ccInvalidFieldRequest;
984 }
985
986 switch (sessionIndex)
987 {
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530988 case session::searchCurrentSession:
989
990 ipmi::ChannelInfo chInfo;
991 ipmi::getChannelInfo(ctx->channel, chInfo);
992
993 if (static_cast<ipmi::EChannelMediumType>(chInfo.mediumType) !=
994 ipmi::EChannelMediumType::lan8032)
995 {
996 return ipmi::ccInvalidFieldRequest;
997 }
998
999 if (!payload.fullyUnpacked())
1000 {
1001 return ipmi::ccReqDataLenInvalid;
1002 }
1003 // Check if current sessionId is 0, sessionId 0 is reserved.
1004 if (ctx->sessionId == session::sessionZero)
1005 {
1006 return session::ccInvalidSessionId;
1007 }
1008 reqSessionId = ctx->sessionId;
1009 break;
1010
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001011 case session::searchSessionByHandle:
1012
1013 if ((payload.unpack(reqSessionHandle)) ||
1014 (!payload.fullyUnpacked()))
1015 {
1016 return ipmi::ccReqDataLenInvalid;
1017 }
1018
1019 if ((reqSessionHandle == session::sessionZero) ||
1020 ((reqSessionHandle & session::multiIntfaceSessionHandleMask) >
1021 session::maxSessionCountPerChannel))
1022 {
1023 return session::ccInvalidSessionHandle;
1024 }
1025 break;
1026
1027 case session::searchSessionById:
1028
1029 if ((payload.unpack(reqSessionId)) || (!payload.fullyUnpacked()))
1030 {
1031 return ipmi::ccReqDataLenInvalid;
1032 }
1033
1034 if (reqSessionId == session::sessionZero)
1035 {
1036 return session::ccInvalidSessionId;
1037 }
1038 break;
1039
1040 default:
1041 if (!payload.fullyUnpacked())
1042 {
1043 return ipmi::ccReqDataLenInvalid;
1044 }
1045 break;
1046 }
1047 return ipmi::ccSuccess;
1048}
1049
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001050uint8_t getSessionState(ipmi::Context::ptr ctx, const std::string& service,
1051 const std::string& objPath, uint8_t& sessionState)
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001052{
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001053 boost::system::error_code ec = ipmi::getDbusProperty(
1054 ctx, service, objPath, session::sessionIntf, "State", sessionState);
1055 if (ec)
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001056 {
1057 log<level::ERR>("Failed to fetch state property ",
1058 entry("SERVICE=%s", service.c_str()),
1059 entry("OBJECTPATH=%s", objPath.c_str()),
1060 entry("INTERFACE=%s", session::sessionIntf),
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001061 entry("ERRMSG=%s", ec.message().c_str()));
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001062 return ipmi::ccUnspecifiedError;
1063 }
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001064 return ipmi::ccSuccess;
1065}
1066
1067static constexpr uint8_t macAddrLen = 6;
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001068/** Alias SessionDetails - contain the optional information about an
1069 * RMCP+ session.
1070 *
1071 * @param userID - uint6_t session user ID (0-63)
1072 * @param reserved - uint2_t reserved
1073 * @param privilege - uint4_t session privilege (0-5)
1074 * @param reserved - uint4_t reserved
1075 * @param channel - uint4_t session channel number
1076 * @param protocol - uint4_t session protocol
1077 * @param remoteIP - uint32_t remote IP address
1078 * @param macAddr - std::array<uint8_t, 6> mac address
1079 * @param port - uint16_t remote port
1080 */
1081using SessionDetails =
1082 std::tuple<uint2_t, uint6_t, uint4_t, uint4_t, uint4_t, uint4_t, uint32_t,
1083 std::array<uint8_t, macAddrLen>, uint16_t>;
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001084
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001085/** @brief get session details for a given session
1086 *
1087 * @param[in] ctx - ipmi::Context pointer for accessing D-Bus
1088 * @param[in] service - D-Bus service name to fetch details from
1089 * @param[in] objPath - D-Bus object path for session
1090 * @param[out] sessionHandle - return session handle for session
1091 * @param[out] sessionState - return session state for session
1092 * @param[out] details - return a SessionDetails tuple containing other
1093 * session info
1094 * @return - ipmi::Cc success or error code
1095 */
1096ipmi::Cc getSessionDetails(ipmi::Context::ptr ctx, const std::string& service,
1097 const std::string& objPath, uint8_t& sessionHandle,
1098 uint8_t& sessionState, SessionDetails& details)
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001099{
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001100 ipmi::PropertyMap sessionProps;
1101 boost::system::error_code ec = ipmi::getAllDbusProperties(
1102 ctx, service, objPath, session::sessionIntf, sessionProps);
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001103
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001104 if (ec)
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001105 {
1106 log<level::ERR>("Failed to fetch state property ",
1107 entry("SERVICE=%s", service.c_str()),
1108 entry("OBJECTPATH=%s", objPath.c_str()),
1109 entry("INTERFACE=%s", session::sessionIntf),
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001110 entry("ERRMSG=%s", ec.message().c_str()));
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001111 return ipmi::ccUnspecifiedError;
1112 }
1113
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001114 sessionState = ipmi::mappedVariant<uint8_t>(
1115 sessionProps, "State", static_cast<uint8_t>(session::State::inactive));
1116 if (sessionState == static_cast<uint8_t>(session::State::active))
1117 {
1118 sessionHandle =
1119 ipmi::mappedVariant<uint8_t>(sessionProps, "SessionHandle", 0);
1120 std::get<0>(details) =
1121 ipmi::mappedVariant<uint8_t>(sessionProps, "UserID", 0xff);
1122 // std::get<1>(details) = 0; // (default constructed to 0)
1123 std::get<2>(details) =
1124 ipmi::mappedVariant<uint8_t>(sessionProps, "CurrentPrivilege", 0);
1125 // std::get<3>(details) = 0; // (default constructed to 0)
1126 std::get<4>(details) =
1127 ipmi::mappedVariant<uint8_t>(sessionProps, "ChannelNum", 0xff);
1128 constexpr uint4_t rmcpPlusProtocol = 1;
1129 std::get<5>(details) = rmcpPlusProtocol;
1130 std::get<6>(details) =
1131 ipmi::mappedVariant<uint32_t>(sessionProps, "RemoteIPAddr", 0);
1132 // std::get<7>(details) = {{0}}; // default constructed to all 0
1133 std::get<8>(details) =
1134 ipmi::mappedVariant<uint16_t>(sessionProps, "RemotePort", 0);
1135 }
1136
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001137 return ipmi::ccSuccess;
1138}
1139
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001140ipmi::RspType<uint8_t, // session handle,
1141 uint8_t, // total session count
1142 uint8_t, // active session count
1143 std::optional<SessionDetails>>
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +05301144 ipmiAppGetSessionInfo(ipmi::Context::ptr ctx, uint8_t sessionIndex,
1145 ipmi::message::Payload& payload)
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001146{
1147 uint32_t reqSessionId = 0;
1148 uint8_t reqSessionHandle = session::defaultSessionHandle;
1149 // initializing state to 0xff as 0 represents state as inactive.
1150 uint8_t state = 0xFF;
1151
1152 uint8_t completionCode = getSessionInfoRequestData(
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +05301153 ctx, sessionIndex, payload, reqSessionId, reqSessionHandle);
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001154
1155 if (completionCode)
1156 {
1157 return ipmi::response(completionCode);
1158 }
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001159 ipmi::ObjectTree objectTree;
1160 boost::system::error_code ec = ipmi::getAllDbusObjects(
1161 ctx, session::sessionManagerRootPath, session::sessionIntf, objectTree);
1162 if (ec)
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001163 {
1164 log<level::ERR>("Failed to fetch object from dbus",
1165 entry("INTERFACE=%s", session::sessionIntf),
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001166 entry("ERRMSG=%s", ec.message().c_str()));
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001167 return ipmi::responseUnspecifiedError();
1168 }
1169
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001170 uint8_t totalSessionCount = getTotalSessionCount();
1171 uint8_t activeSessionCount = 0;
1172 uint8_t sessionHandle = session::defaultSessionHandle;
1173 std::optional<SessionDetails> maybeDetails;
1174 uint8_t index = 0;
1175 for (auto& objectTreeItr : objectTree)
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001176 {
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001177 uint32_t sessionId = 0;
1178 std::string objectPath = objectTreeItr.first;
1179
1180 if (!parseCloseSessionInputPayload(objectPath, sessionId,
1181 sessionHandle))
1182 {
1183 continue;
1184 }
1185 index++;
1186 auto& serviceMap = objectTreeItr.second;
1187 auto itr = serviceMap.begin();
1188
1189 if (serviceMap.size() != 1)
1190 {
1191 return ipmi::responseUnspecifiedError();
1192 }
1193
1194 std::string service = itr->first;
1195 uint8_t sessionState = 0;
1196 completionCode =
1197 getSessionState(ctx, service, objectPath, sessionState);
1198 if (completionCode)
1199 {
1200 return ipmi::response(completionCode);
1201 }
1202
1203 if (sessionState == static_cast<uint8_t>(session::State::active))
1204 {
1205 activeSessionCount++;
1206 }
1207
1208 if (index != sessionIndex && reqSessionId != sessionId &&
1209 reqSessionHandle != sessionHandle)
1210 {
1211 continue;
1212 }
1213
1214 SessionDetails details{};
1215 completionCode = getSessionDetails(ctx, service, objectPath,
1216 sessionHandle, state, details);
1217
1218 if (completionCode)
1219 {
1220 return ipmi::response(completionCode);
1221 }
1222 maybeDetails = std::move(details);
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001223 }
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001224
1225 if (state == static_cast<uint8_t>(session::State::active) ||
1226 state == static_cast<uint8_t>(session::State::tearDownInProgress))
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001227 {
Vernon Mauerye7e8b812019-10-28 16:00:34 -07001228 return ipmi::responseSuccess(sessionHandle, totalSessionCount,
1229 activeSessionCount, maybeDetails);
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001230 }
1231
1232 return ipmi::responseInvalidFieldRequest();
1233}
1234
Xo Wangf542e8b2017-08-09 15:34:16 -07001235static std::unique_ptr<SysInfoParamStore> sysInfoParamStore;
1236
Xo Wang87651332017-08-11 10:17:59 -07001237static std::string sysInfoReadSystemName()
1238{
1239 // Use the BMC hostname as the "System Name."
1240 char hostname[HOST_NAME_MAX + 1] = {};
1241 if (gethostname(hostname, HOST_NAME_MAX) != 0)
1242 {
1243 perror("System info parameter: system name");
1244 }
1245 return hostname;
1246}
1247
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001248static constexpr uint8_t paramRevision = 0x11;
1249static constexpr size_t configParameterLength = 16;
Xo Wangf542e8b2017-08-09 15:34:16 -07001250
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001251static constexpr size_t smallChunkSize = 14;
1252static constexpr size_t fullChunkSize = 16;
Jia, chunhui449f2162019-09-11 16:51:51 +08001253static constexpr uint8_t progressMask = 0x3;
Xo Wangf542e8b2017-08-09 15:34:16 -07001254
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001255static constexpr uint8_t setComplete = 0x0;
1256static constexpr uint8_t setInProgress = 0x1;
1257static constexpr uint8_t commitWrite = 0x2;
1258static uint8_t transferStatus = setComplete;
1259
Jia, chunhui449f2162019-09-11 16:51:51 +08001260static constexpr uint8_t configDataOverhead = 2;
1261
1262// For EFI based system, 256 bytes is recommended.
1263static constexpr size_t maxBytesPerParameter = 256;
1264
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001265namespace ipmi
1266{
1267constexpr Cc ccParmNotSupported = 0x80;
Jia, chunhui449f2162019-09-11 16:51:51 +08001268constexpr Cc ccSetInProgressActive = 0x81;
1269constexpr Cc ccSystemInfoParameterSetReadOnly = 0x82;
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001270
1271static inline auto responseParmNotSupported()
1272{
1273 return response(ccParmNotSupported);
Xo Wangf542e8b2017-08-09 15:34:16 -07001274}
Jia, chunhui449f2162019-09-11 16:51:51 +08001275static inline auto responseSetInProgressActive()
1276{
1277 return response(ccSetInProgressActive);
1278}
1279static inline auto responseSystemInfoParameterSetReadOnly()
1280{
1281 return response(ccSystemInfoParameterSetReadOnly);
1282}
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001283} // namespace ipmi
Xo Wangf542e8b2017-08-09 15:34:16 -07001284
Jia, chunhui449f2162019-09-11 16:51:51 +08001285ipmi::RspType<uint8_t, // Parameter revision
1286 std::optional<uint8_t>, // data1 / setSelector / ProgressStatus
1287 std::optional<std::vector<uint8_t>>> // data2-17
jayaprakash Mutyalac2566a92020-04-23 21:18:35 +00001288 ipmiAppGetSystemInfo(uint7_t reserved, bool getRevision,
1289 uint8_t paramSelector, uint8_t setSelector,
1290 uint8_t BlockSelector)
Xo Wangf542e8b2017-08-09 15:34:16 -07001291{
Snehalatha Va5ae7722020-05-02 18:18:57 +00001292 if (reserved || (paramSelector >= invalidParamSelectorStart &&
1293 paramSelector <= invalidParamSelectorEnd))
jayaprakash Mutyalac2566a92020-04-23 21:18:35 +00001294 {
1295 return ipmi::responseInvalidFieldRequest();
1296 }
Snehalatha Va5ae7722020-05-02 18:18:57 +00001297 if ((paramSelector >= oemCmdStart) && (paramSelector <= oemCmdEnd))
1298 {
1299 return ipmi::responseParmNotSupported();
1300 }
jayaprakash Mutyalac2566a92020-04-23 21:18:35 +00001301 if (getRevision)
Xo Wangf542e8b2017-08-09 15:34:16 -07001302 {
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001303 return ipmi::responseSuccess(paramRevision, std::nullopt, std::nullopt);
Xo Wangf542e8b2017-08-09 15:34:16 -07001304 }
1305
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001306 if (paramSelector == 0)
Xo Wangf542e8b2017-08-09 15:34:16 -07001307 {
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001308 return ipmi::responseSuccess(paramRevision, transferStatus,
1309 std::nullopt);
Xo Wangf542e8b2017-08-09 15:34:16 -07001310 }
1311
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001312 if (BlockSelector != 0) // 00h if parameter does not require a block number
Xo Wangf542e8b2017-08-09 15:34:16 -07001313 {
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001314 return ipmi::responseParmNotSupported();
Xo Wangf542e8b2017-08-09 15:34:16 -07001315 }
1316
1317 if (sysInfoParamStore == nullptr)
1318 {
1319 sysInfoParamStore = std::make_unique<SysInfoParamStore>();
Xo Wang87651332017-08-11 10:17:59 -07001320 sysInfoParamStore->update(IPMI_SYSINFO_SYSTEM_NAME,
1321 sysInfoReadSystemName);
Xo Wangf542e8b2017-08-09 15:34:16 -07001322 }
1323
1324 // Parameters other than Set In Progress are assumed to be strings.
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001325 std::tuple<bool, std::string> ret =
1326 sysInfoParamStore->lookup(paramSelector);
1327 bool found = std::get<0>(ret);
Xo Wangf542e8b2017-08-09 15:34:16 -07001328 if (!found)
1329 {
Snehalatha Va5ae7722020-05-02 18:18:57 +00001330 return ipmi::responseSensorInvalid();
Xo Wangf542e8b2017-08-09 15:34:16 -07001331 }
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001332 std::string& paramString = std::get<1>(ret);
Jia, chunhui449f2162019-09-11 16:51:51 +08001333 std::vector<uint8_t> configData;
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001334 size_t count = 0;
1335 if (setSelector == 0)
Jia, chunhui449f2162019-09-11 16:51:51 +08001336 { // First chunk has only 14 bytes.
1337 configData.emplace_back(0); // encoding
1338 configData.emplace_back(paramString.length()); // string length
1339 count = std::min(paramString.length(), smallChunkSize);
1340 configData.resize(count + configDataOverhead);
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001341 std::copy_n(paramString.begin(), count,
Snehalatha Va5ae7722020-05-02 18:18:57 +00001342 configData.begin() + configDataOverhead); // 14 bytes chunk
1343
1344 // Append zero's to remaining bytes
1345 if (configData.size() < configParameterLength)
1346 {
1347 std::fill_n(std::back_inserter(configData),
1348 configParameterLength - configData.size(), 0x00);
1349 }
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001350 }
1351 else
Xo Wangf542e8b2017-08-09 15:34:16 -07001352 {
Jia, chunhui449f2162019-09-11 16:51:51 +08001353 size_t offset = (setSelector * fullChunkSize) - configDataOverhead;
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001354 if (offset >= paramString.length())
1355 {
1356 return ipmi::responseParmOutOfRange();
1357 }
Jia, chunhui449f2162019-09-11 16:51:51 +08001358 count = std::min(paramString.length() - offset, fullChunkSize);
1359 configData.resize(count);
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001360 std::copy_n(paramString.begin() + offset, count,
1361 configData.begin()); // 16 bytes chunk
Xo Wangf542e8b2017-08-09 15:34:16 -07001362 }
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001363 return ipmi::responseSuccess(paramRevision, setSelector, configData);
Xo Wangf542e8b2017-08-09 15:34:16 -07001364}
1365
Jia, chunhui449f2162019-09-11 16:51:51 +08001366ipmi::RspType<> ipmiAppSetSystemInfo(uint8_t paramSelector, uint8_t data1,
1367 std::vector<uint8_t> configData)
1368{
jayaprakash Mutyala3c5e4132020-04-27 23:00:05 +00001369 if (paramSelector >= invalidParamSelectorStart &&
1370 paramSelector <= invalidParamSelectorEnd)
1371 {
1372 return ipmi::responseInvalidFieldRequest();
1373 }
1374 if ((paramSelector >= oemCmdStart) && (paramSelector <= oemCmdEnd))
1375 {
1376 return ipmi::responseParmNotSupported();
1377 }
1378
Jia, chunhui449f2162019-09-11 16:51:51 +08001379 if (paramSelector == 0)
1380 {
1381 // attempt to set the 'set in progress' value (in parameter #0)
1382 // when not in the set complete state.
1383 if ((transferStatus != setComplete) && (data1 == setInProgress))
1384 {
1385 return ipmi::responseSetInProgressActive();
1386 }
1387 // only following 2 states are supported
1388 if (data1 > setInProgress)
1389 {
1390 phosphor::logging::log<phosphor::logging::level::ERR>(
1391 "illegal SetInProgress status");
1392 return ipmi::responseInvalidFieldRequest();
1393 }
1394
1395 transferStatus = data1 & progressMask;
1396 return ipmi::responseSuccess();
1397 }
1398
1399 if (configData.size() > configParameterLength)
1400 {
1401 return ipmi::responseInvalidFieldRequest();
1402 }
1403
jayaprakash Mutyala3c5e4132020-04-27 23:00:05 +00001404 // Append zero's to remaining bytes
1405 if (configData.size() < configParameterLength)
1406 {
1407 fill_n(back_inserter(configData),
1408 (configParameterLength - configData.size()), 0x00);
1409 }
1410
Jia, chunhui449f2162019-09-11 16:51:51 +08001411 if (!sysInfoParamStore)
1412 {
1413 sysInfoParamStore = std::make_unique<SysInfoParamStore>();
1414 sysInfoParamStore->update(IPMI_SYSINFO_SYSTEM_NAME,
1415 sysInfoReadSystemName);
1416 }
1417
1418 // lookup
1419 std::tuple<bool, std::string> ret =
1420 sysInfoParamStore->lookup(paramSelector);
1421 bool found = std::get<0>(ret);
1422 std::string& paramString = std::get<1>(ret);
1423 if (!found)
1424 {
1425 // parameter does not exist. Init new
1426 paramString = "";
1427 }
1428
1429 uint8_t setSelector = data1;
1430 size_t count = 0;
1431 if (setSelector == 0) // First chunk has only 14 bytes.
1432 {
1433 size_t stringLen = configData.at(1); // string length
1434 // maxBytesPerParamter is 256. It will always be greater than stringLen
1435 // (unit8_t) if maxBytes changes in future, then following line is
1436 // needed.
1437 // stringLen = std::min(stringLen, maxBytesPerParameter);
1438 count = std::min(stringLen, smallChunkSize);
1439 count = std::min(count, configData.size());
1440 paramString.resize(stringLen); // reserve space
1441 std::copy_n(configData.begin() + configDataOverhead, count,
1442 paramString.begin());
1443 }
1444 else
1445 {
1446 size_t offset = (setSelector * fullChunkSize) - configDataOverhead;
1447 if (offset >= paramString.length())
1448 {
1449 return ipmi::responseParmOutOfRange();
1450 }
1451 count = std::min(paramString.length() - offset, configData.size());
1452 std::copy_n(configData.begin(), count, paramString.begin() + offset);
1453 }
1454 sysInfoParamStore->update(paramSelector, paramString);
1455 return ipmi::responseSuccess();
1456}
1457
Yong Libd0503a2019-08-22 17:17:17 +08001458#ifdef ENABLE_I2C_WHITELIST_CHECK
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301459inline std::vector<uint8_t> convertStringToData(const std::string& command)
1460{
1461 std::istringstream iss(command);
1462 std::string token;
1463 std::vector<uint8_t> dataValue;
1464 while (std::getline(iss, token, ' '))
1465 {
1466 dataValue.emplace_back(
1467 static_cast<uint8_t>(std::stoul(token, nullptr, base_16)));
1468 }
1469 return dataValue;
1470}
1471
1472static bool populateI2CMasterWRWhitelist()
1473{
1474 nlohmann::json data = nullptr;
1475 std::ifstream jsonFile(i2cMasterWRWhitelistFile);
1476
1477 if (!jsonFile.good())
1478 {
1479 log<level::WARNING>("i2c white list file not found!",
1480 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile));
1481 return false;
1482 }
1483
1484 try
1485 {
1486 data = nlohmann::json::parse(jsonFile, nullptr, false);
1487 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001488 catch (const nlohmann::json::parse_error& e)
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301489 {
1490 log<level::ERR>("Corrupted i2c white list config file",
1491 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile),
1492 entry("MSG: %s", e.what()));
1493 return false;
1494 }
1495
1496 try
1497 {
1498 // Example JSON Structure format
1499 // "filters": [
1500 // {
1501 // "Description": "Allow full read - ignore first byte write value
1502 // for 0x40 to 0x4F",
1503 // "busId": "0x01",
1504 // "slaveAddr": "0x40",
1505 // "slaveAddrMask": "0x0F",
1506 // "command": "0x00",
1507 // "commandMask": "0xFF"
1508 // },
1509 // {
1510 // "Description": "Allow full read - first byte match 0x05 and
1511 // ignore second byte",
1512 // "busId": "0x01",
1513 // "slaveAddr": "0x57",
1514 // "slaveAddrMask": "0x00",
1515 // "command": "0x05 0x00",
1516 // "commandMask": "0x00 0xFF"
1517 // },]
1518
1519 nlohmann::json filters = data[filtersStr].get<nlohmann::json>();
1520 std::vector<i2cMasterWRWhitelist>& whitelist = getWRWhitelist();
1521 for (const auto& it : filters.items())
1522 {
1523 nlohmann::json filter = it.value();
1524 if (filter.is_null())
1525 {
1526 log<level::ERR>(
1527 "Corrupted I2C master write read whitelist config file",
1528 entry("FILE_NAME: %s", i2cMasterWRWhitelistFile));
1529 return false;
1530 }
1531 const std::vector<uint8_t>& writeData =
1532 convertStringToData(filter[cmdStr].get<std::string>());
1533 const std::vector<uint8_t>& writeDataMask =
1534 convertStringToData(filter[cmdMaskStr].get<std::string>());
1535 if (writeDataMask.size() != writeData.size())
1536 {
1537 log<level::ERR>("I2C master write read whitelist filter "
1538 "mismatch for command & mask size");
1539 return false;
1540 }
1541 whitelist.push_back(
1542 {static_cast<uint8_t>(std::stoul(
1543 filter[busIdStr].get<std::string>(), nullptr, base_16)),
1544 static_cast<uint8_t>(
1545 std::stoul(filter[slaveAddrStr].get<std::string>(),
1546 nullptr, base_16)),
1547 static_cast<uint8_t>(
1548 std::stoul(filter[slaveAddrMaskStr].get<std::string>(),
1549 nullptr, base_16)),
1550 writeData, writeDataMask});
1551 }
1552 if (whitelist.size() != filters.size())
1553 {
1554 log<level::ERR>(
1555 "I2C master write read whitelist filter size mismatch");
1556 return false;
1557 }
1558 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -05001559 catch (const std::exception& e)
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301560 {
1561 log<level::ERR>("I2C master write read whitelist unexpected exception",
1562 entry("ERROR=%s", e.what()));
1563 return false;
1564 }
1565 return true;
1566}
1567
1568static inline bool isWriteDataWhitelisted(const std::vector<uint8_t>& data,
1569 const std::vector<uint8_t>& dataMask,
1570 const std::vector<uint8_t>& writeData)
1571{
1572 std::vector<uint8_t> processedDataBuf(data.size());
1573 std::vector<uint8_t> processedReqBuf(dataMask.size());
1574 std::transform(writeData.begin(), writeData.end(), dataMask.begin(),
1575 processedReqBuf.begin(), std::bit_or<uint8_t>());
1576 std::transform(data.begin(), data.end(), dataMask.begin(),
1577 processedDataBuf.begin(), std::bit_or<uint8_t>());
1578
1579 return (processedDataBuf == processedReqBuf);
1580}
1581
1582static bool isCmdWhitelisted(uint8_t busId, uint8_t slaveAddr,
1583 std::vector<uint8_t>& writeData)
1584{
1585 std::vector<i2cMasterWRWhitelist>& whiteList = getWRWhitelist();
1586 for (const auto& wlEntry : whiteList)
1587 {
1588 if ((busId == wlEntry.busId) &&
1589 ((slaveAddr | wlEntry.slaveAddrMask) ==
1590 (wlEntry.slaveAddr | wlEntry.slaveAddrMask)))
1591 {
1592 const std::vector<uint8_t>& dataMask = wlEntry.dataMask;
1593 // Skip as no-match, if requested write data is more than the
1594 // write data mask size
1595 if (writeData.size() > dataMask.size())
1596 {
1597 continue;
1598 }
1599 if (isWriteDataWhitelisted(wlEntry.data, dataMask, writeData))
1600 {
1601 return true;
1602 }
1603 }
1604 }
1605 return false;
1606}
Yong Libd0503a2019-08-22 17:17:17 +08001607#else
1608static bool populateI2CMasterWRWhitelist()
1609{
1610 log<level::INFO>(
1611 "I2C_WHITELIST_CHECK is disabled, do not populate whitelist");
1612 return true;
1613}
1614#endif // ENABLE_I2C_WHITELIST_CHECK
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301615
1616/** @brief implements master write read IPMI command which can be used for
1617 * low-level I2C/SMBus write, read or write-read access
1618 * @param isPrivateBus -to indicate private bus usage
1619 * @param busId - bus id
1620 * @param channelNum - channel number
1621 * @param reserved - skip 1 bit
1622 * @param slaveAddr - slave address
1623 * @param read count - number of bytes to be read
1624 * @param writeData - data to be written
1625 *
1626 * @returns IPMI completion code plus response data
1627 * - readData - i2c response data
1628 */
1629ipmi::RspType<std::vector<uint8_t>>
1630 ipmiMasterWriteRead(bool isPrivateBus, uint3_t busId, uint4_t channelNum,
1631 bool reserved, uint7_t slaveAddr, uint8_t readCount,
1632 std::vector<uint8_t> writeData)
1633{
Jayaprakash Mutyalac2af98b2021-09-14 09:19:11 +00001634 if (reserved)
1635 {
1636 return ipmi::responseInvalidFieldRequest();
1637 }
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301638 if (readCount > maxIPMIWriteReadSize)
1639 {
1640 log<level::ERR>("Master write read command: Read count exceeds limit");
1641 return ipmi::responseParmOutOfRange();
1642 }
1643 const size_t writeCount = writeData.size();
1644 if (!readCount && !writeCount)
1645 {
1646 log<level::ERR>("Master write read command: Read & write count are 0");
1647 return ipmi::responseInvalidFieldRequest();
1648 }
Yong Libd0503a2019-08-22 17:17:17 +08001649#ifdef ENABLE_I2C_WHITELIST_CHECK
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301650 if (!isCmdWhitelisted(static_cast<uint8_t>(busId),
1651 static_cast<uint8_t>(slaveAddr), writeData))
1652 {
1653 log<level::ERR>("Master write read request blocked!",
1654 entry("BUS=%d", static_cast<uint8_t>(busId)),
1655 entry("ADDR=0x%x", static_cast<uint8_t>(slaveAddr)));
1656 return ipmi::responseInvalidFieldRequest();
1657 }
Yong Libd0503a2019-08-22 17:17:17 +08001658#endif // ENABLE_I2C_WHITELIST_CHECK
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301659 std::vector<uint8_t> readBuf(readCount);
1660 std::string i2cBus =
1661 "/dev/i2c-" + std::to_string(static_cast<uint8_t>(busId));
1662
Yong Li7dc4ac02019-08-23 17:44:32 +08001663 ipmi::Cc ret = ipmi::i2cWriteRead(i2cBus, static_cast<uint8_t>(slaveAddr),
1664 writeData, readBuf);
1665 if (ret != ipmi::ccSuccess)
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301666 {
Yong Li7dc4ac02019-08-23 17:44:32 +08001667 return ipmi::response(ret);
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301668 }
1669 return ipmi::responseSuccess(readBuf);
1670}
1671
Chris Austen6caf28b2015-10-13 12:40:40 -05001672void register_netfn_app_functions()
vishwabmcba0bd5f2015-09-30 16:50:23 +05301673{
Vernon Mauery86a50822019-03-25 13:11:36 -07001674 // <Get Device ID>
1675 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1676 ipmi::app::cmdGetDeviceId, ipmi::Privilege::User,
1677 ipmiAppGetDeviceId);
1678
Tom05732372016-09-06 17:21:23 +05301679 // <Get BT Interface Capabilities>
Vernon Mauerycc99ba42019-03-25 13:40:11 -07001680 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1681 ipmi::app::cmdGetBtIfaceCapabilities,
1682 ipmi::Privilege::User, ipmiAppGetBtCapabilities);
Chris Austen6caf28b2015-10-13 12:40:40 -05001683
Tom05732372016-09-06 17:21:23 +05301684 // <Reset Watchdog Timer>
Vernon Mauery11df4f62019-03-25 14:17:54 -07001685 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1686 ipmi::app::cmdResetWatchdogTimer,
1687 ipmi::Privilege::Operator, ipmiAppResetWatchdogTimer);
Chris Austen6caf28b2015-10-13 12:40:40 -05001688
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001689 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
AppaRao Puli5a98ea62019-11-10 21:15:02 +05301690 ipmi::app::cmdGetSessionInfo, ipmi::Privilege::User,
1691 ipmiAppGetSessionInfo);
Rajashekar Gade Reddyf71444d2019-07-25 15:12:17 +00001692
Tom05732372016-09-06 17:21:23 +05301693 // <Set Watchdog Timer>
Deepak Kumar Sahucfae9482019-05-20 14:58:58 +00001694 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1695 ipmi::app::cmdSetWatchdogTimer,
1696 ipmi::Privilege::Operator, ipmiSetWatchdogTimer);
Chris Austen6caf28b2015-10-13 12:40:40 -05001697
Rajashekar Gade Reddye7023922019-07-10 16:54:55 +00001698 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1699 ipmi::app::cmdCloseSession, ipmi::Privilege::Callback,
1700 ipmiAppCloseSession);
1701
William A. Kennington III73f44512018-02-09 15:28:46 -08001702 // <Get Watchdog Timer>
Deepak Kumar Sahucfae9482019-05-20 14:58:58 +00001703 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
AppaRao Puli5a98ea62019-11-10 21:15:02 +05301704 ipmi::app::cmdGetWatchdogTimer, ipmi::Privilege::User,
1705 ipmiGetWatchdogTimer);
William A. Kennington III73f44512018-02-09 15:28:46 -08001706
Tom05732372016-09-06 17:21:23 +05301707 // <Get Self Test Results>
Vernon Maueryb84a5282019-03-25 13:39:03 -07001708 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1709 ipmi::app::cmdGetSelfTestResults,
1710 ipmi::Privilege::User, ipmiAppGetSelfTestResults);
Nan Li41fa24a2016-11-10 20:12:37 +08001711
Tom05732372016-09-06 17:21:23 +05301712 // <Get Device GUID>
Vernon Mauery15541322019-03-25 13:33:03 -07001713 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1714 ipmi::app::cmdGetDeviceGuid, ipmi::Privilege::User,
1715 ipmiAppGetDeviceGuid);
Adriana Kobylakd100ee52015-10-20 17:02:37 -05001716
Tom05732372016-09-06 17:21:23 +05301717 // <Set ACPI Power State>
Deepak Kumar Sahu520c1312019-05-17 18:14:09 +00001718 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1719 ipmi::app::cmdSetAcpiPowerState,
1720 ipmi::Privilege::Admin, ipmiSetAcpiPowerState);
Yong Li18d77262018-10-09 01:59:45 +08001721 // <Get ACPI Power State>
Deepak Kumar Sahu4e6d2572019-05-07 19:53:37 +00001722 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1723 ipmi::app::cmdGetAcpiPowerState,
AppaRao Puli5a98ea62019-11-10 21:15:02 +05301724 ipmi::Privilege::User, ipmiGetAcpiPowerState);
Yong Li18d77262018-10-09 01:59:45 +08001725
Richard Marian Thomaiyar84bf9be2019-04-26 22:59:16 +05301726 // Note: For security reason, this command will be registered only when
1727 // there are proper I2C Master write read whitelist
1728 if (populateI2CMasterWRWhitelist())
1729 {
1730 // Note: For security reasons, registering master write read as admin
1731 // privilege command, even though IPMI 2.0 specification allows it as
1732 // operator privilege.
1733 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1734 ipmi::app::cmdMasterWriteRead,
1735 ipmi::Privilege::Admin, ipmiMasterWriteRead);
1736 }
1737
Marri Devender Rao5e007a52018-01-08 06:18:36 -06001738 // <Get System GUID Command>
Vernon Maueryb90a5322019-03-25 13:36:55 -07001739 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1740 ipmi::app::cmdGetSystemGuid, ipmi::Privilege::User,
1741 ipmiAppGetSystemGuid);
Tom Joseph7cbe2282018-03-21 21:17:33 +05301742
1743 // <Get Channel Cipher Suites Command>
Ayushi Smriti5c3b72c2019-08-30 13:47:31 +00001744 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1745 ipmi::app::cmdGetChannelCipherSuites,
Vernon Mauery79b4eea2019-11-07 09:51:39 -08001746 ipmi::Privilege::None, getChannelCipherSuites);
Vernon Maueryd2a57de2019-03-25 12:45:28 -07001747
Xo Wangf542e8b2017-08-09 15:34:16 -07001748 // <Get System Info Command>
Jia, chunhui98b43ba2019-09-05 15:54:23 +08001749 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1750 ipmi::app::cmdGetSystemInfoParameters,
1751 ipmi::Privilege::User, ipmiAppGetSystemInfo);
Jia, chunhui449f2162019-09-11 16:51:51 +08001752 // <Set System Info Command>
1753 ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
1754 ipmi::app::cmdSetSystemInfoParameters,
1755 ipmi::Privilege::Admin, ipmiAppSetSystemInfo);
vishwabmcba0bd5f2015-09-30 16:50:23 +05301756 return;
1757}