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/usercommands.cpp | |
| 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/usercommands.cpp')
| -rw-r--r-- | user_channel/usercommands.cpp | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/user_channel/usercommands.cpp b/user_channel/usercommands.cpp index f81c093..b0997d5 100644 --- a/user_channel/usercommands.cpp +++ b/user_channel/usercommands.cpp @@ -37,6 +37,10 @@ static constexpr uint8_t enableUser = 0x01; static constexpr uint8_t setPassword = 0x02; static constexpr uint8_t testPassword = 0x03; +/** @struct SetUserAccessReq + * + * Structure for set user access request command (refer spec sec 22.26) + */ struct SetUserAccessReq { #if BYTE_ORDER == LITTLE_ENDIAN @@ -68,6 +72,10 @@ struct SetUserAccessReq } __attribute__((packed)); +/** @struct GetUserAccessReq + * + * Structure for get user access request command (refer spec sec 22.27) + */ struct GetUserAccessReq { #if BYTE_ORDER == LITTLE_ENDIAN @@ -84,6 +92,10 @@ struct GetUserAccessReq #endif } __attribute__((packed)); +/** @struct GetUserAccessResp + * + * Structure for get user access response command (refer spec sec 22.27) + */ struct GetUserAccessResp { #if BYTE_ORDER == LITTLE_ENDIAN @@ -105,6 +117,10 @@ struct GetUserAccessResp PrivAccess privAccess; } __attribute__((packed)); +/** @struct SetUserNameReq + * + * Structure for set user name request command (refer spec sec 22.28) + */ struct SetUserNameReq { #if BYTE_ORDER == LITTLE_ENDIAN @@ -118,6 +134,10 @@ struct SetUserNameReq uint8_t userName[16]; } __attribute__((packed)); +/** @struct GetUserNameReq + * + * Structure for get user name request command (refer spec sec 22.29) + */ struct GetUserNameReq { #if BYTE_ORDER == LITTLE_ENDIAN @@ -130,11 +150,19 @@ struct GetUserNameReq #endif } __attribute__((packed)); +/** @struct GetUserNameResp + * + * Structure for get user name response command (refer spec sec 22.29) + */ struct GetUserNameResp { uint8_t userName[16]; } __attribute__((packed)); +/** @struct SetUserPasswordReq + * + * Structure for set user password request command (refer spec sec 22.30) + */ struct SetUserPasswordReq { #if BYTE_ORDER == LITTLE_ENDIAN |
