summaryrefslogtreecommitdiffstats
path: root/user_channel/channel_mgmt.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'user_channel/channel_mgmt.hpp')
-rw-r--r--user_channel/channel_mgmt.hpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/user_channel/channel_mgmt.hpp b/user_channel/channel_mgmt.hpp
index 09d2a71..8cdb9c7 100644
--- a/user_channel/channel_mgmt.hpp
+++ b/user_channel/channel_mgmt.hpp
@@ -38,12 +38,22 @@ static constexpr const char* ipmiChannelMutex = "ipmi_channel_mutex";
static constexpr const char* ipmiChMutexCleanupLockFile =
"/var/lib/ipmi/ipmi_channel_mutex_cleanup";
+/** @struct ChannelAccessData
+ *
+ * Structure to store both non-volatile and volatile channel access information
+ * as used by IPMI specification (refer spec sec 22.22 to 22.24)
+ */
struct ChannelAccessData
{
ChannelAccess chNonVolatileData;
ChannelAccess chVolatileData;
};
+/** @struct ChannelData
+ *
+ * Structure for channel information - base structure to get all information
+ * about the channel.(refer spec sec 22.22 to 22.24)
+ */
struct ChannelData
{
std::string chName;
OpenPOWER on IntegriCloud