diff options
| author | Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com> | 2018-11-29 06:29:21 +0530 |
|---|---|---|
| committer | Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com> | 2018-12-19 01:11:45 +0000 |
| commit | 6e1ba9effa687791170858cf10aa1c26c0742b75 (patch) | |
| tree | 916ac96453a1a8e4d791bb43e3393eadc8a5c8ac /user_channel/user_layer.hpp | |
| parent | 43cb12895039d972e640b992bacf9c13146876ee (diff) | |
| download | phosphor-host-ipmid-6e1ba9effa687791170858cf10aa1c26c0742b75.tar.gz phosphor-host-ipmid-6e1ba9effa687791170858cf10aa1c26c0742b75.zip | |
Doxygen comments for enum & structure
Added doxygen comments for enums & structures for user & channel
layers.
Unit-test:
verified build.
Change-Id: Ie5af8d6cdd4c04cb396869b7a3dc44f84efedd19
Signed-off-by: Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com>
Diffstat (limited to 'user_channel/user_layer.hpp')
| -rw-r--r-- | user_channel/user_layer.hpp | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/user_channel/user_layer.hpp b/user_channel/user_layer.hpp index 956c925..ce985df 100644 --- a/user_channel/user_layer.hpp +++ b/user_channel/user_layer.hpp @@ -22,6 +22,9 @@ namespace ipmi { // TODO: Has to be replaced with proper channel number assignment logic +/** + * @enum Channel Id + */ enum class EChannelID : uint8_t { chanLan1 = 0x01 @@ -33,6 +36,11 @@ static constexpr uint8_t ipmiMaxUserName = 16; static constexpr uint8_t ipmiMaxUsers = 15; static constexpr uint8_t ipmiMaxChannels = 16; +/** @struct PrivAccess + * + * User privilege related access data as per IPMI specification.(refer spec + * sec 22.26) + */ struct PrivAccess { #if BYTE_ORDER == LITTLE_ENDIAN |
