user_channel:Change fun ret&cmd cc as per New Std
Modified ipmi function return status code and
command completion codes as per new standard.
Tested:
verified using ipmitool commands.
1. create new user
Command : ipmitool user set name 5 user5
Response: //user created successfully
Command: ipmitool user set password 5 0penBmc\' //set password
Response: Set User Password command successful (user 5)
2. Set password
Command : ipmitool user set password 5 0penBmc\'
Response: Set User Password command successful (user 5)
3. set channel access
Command: ipmitool channel setaccess 1 5 callin=on ipmi=on link=on
privilege=4
Response: Set User Access (channel 1 id 5) successful.
4. get channel access
Command: ipmitool channel getaccess 1 5
Response:
Maximum User IDs : 15
Enabled User IDs : 5
User ID : 5
User Name : user5
Fixed Name : No
Access Available : call-in / callback
Link Authentication : enabled
IPMI Messaging : enabled
Privilege Level : ADMINISTRATOR
Enable Status : disabled
5. User list
Command: ipmitool user list 1
Response:
ID Name Callin Link Auth IPMI Msg Channel Priv Limit
1 root false true true ADMINISTRATOR
2 putty_operator true true true OPERATOR
3 ipmi_admin true true true ADMINISTRATOR
4 user2 false true true OPERATOR
5 user5 true true true ADMINISTRATOR
6 true false false NO ACCESS
7 true false false NO ACCESS
8 true false false NO ACCESS
9 true false false NO ACCESS
10 true false false NO ACCESS
11 true false false NO ACCESS
12 true false false NO ACCESS
13 true false false NO ACCESS
14 true false false NO ACCESS
15 true false false NO ACCESS
Signed-off-by: jayaprakash Mutyala <mutyalax.jayaprakash@intel.com>
Signed-off-by: NITIN SHARMA <nitin1x.sharma@intel.com>
Change-Id: I5f2c32f50edc2de204ac361364e21a61a4bcf237
diff --git a/user_channel/user_layer.cpp b/user_channel/user_layer.cpp
index b309e86..5e4aed7 100644
--- a/user_channel/user_layer.cpp
+++ b/user_channel/user_layer.cpp
@@ -27,10 +27,10 @@
namespace ipmi
{
-ipmi_ret_t ipmiUserInit()
+Cc ipmiUserInit()
{
getUserAccessObject();
- return IPMI_CC_OK;
+ return ccSuccess;
}
std::string ipmiUserGetPassword(const std::string& userName)
@@ -38,23 +38,23 @@
return passwdMgr.getPasswdByUserName(userName);
}
-ipmi_ret_t ipmiClearUserEntryPassword(const std::string& userName)
+Cc ipmiClearUserEntryPassword(const std::string& userName)
{
if (passwdMgr.updateUserEntry(userName, "") != 0)
{
- return IPMI_CC_UNSPECIFIED_ERROR;
+ return ccUnspecifiedError;
}
- return IPMI_CC_OK;
+ return ccSuccess;
}
-ipmi_ret_t ipmiRenameUserEntryPassword(const std::string& userName,
- const std::string& newUserName)
+Cc ipmiRenameUserEntryPassword(const std::string& userName,
+ const std::string& newUserName)
{
if (passwdMgr.updateUserEntry(userName, newUserName) != 0)
{
- return IPMI_CC_UNSPECIFIED_ERROR;
+ return ccUnspecifiedError;
}
- return IPMI_CC_OK;
+ return ccSuccess;
}
bool ipmiUserIsValidUserId(const uint8_t userId)
@@ -72,30 +72,29 @@
return getUserAccessObject().getUserId(userName);
}
-ipmi_ret_t ipmiUserSetUserName(const uint8_t userId, const char* userName)
+Cc ipmiUserSetUserName(const uint8_t userId, const char* userName)
{
return getUserAccessObject().setUserName(userId, userName);
}
-ipmi_ret_t ipmiUserGetUserName(const uint8_t userId, std::string& userName)
+Cc ipmiUserGetUserName(const uint8_t userId, std::string& userName)
{
return getUserAccessObject().getUserName(userId, userName);
}
-ipmi_ret_t ipmiUserSetUserPassword(const uint8_t userId,
- const char* userPassword)
+Cc ipmiUserSetUserPassword(const uint8_t userId, const char* userPassword)
{
return getUserAccessObject().setUserPassword(userId, userPassword);
}
-ipmi_ret_t ipmiSetSpecialUserPassword(const std::string& userName,
- const std::string& userPassword)
+Cc ipmiSetSpecialUserPassword(const std::string& userName,
+ const std::string& userPassword)
{
return getUserAccessObject().setSpecialUserPassword(userName, userPassword);
}
-ipmi_ret_t ipmiUserGetAllCounts(uint8_t& maxChUsers, uint8_t& enabledUsers,
- uint8_t& fixedUsers)
+Cc ipmiUserGetAllCounts(uint8_t& maxChUsers, uint8_t& enabledUsers,
+ uint8_t& fixedUsers)
{
maxChUsers = ipmiMaxUsers;
UsersTbl* userData = getUserAccessObject().getUsersTblPtr();
@@ -113,36 +112,36 @@
fixedUsers++;
}
}
- return IPMI_CC_OK;
+ return ccSuccess;
}
-ipmi_ret_t ipmiUserUpdateEnabledState(const uint8_t userId, const bool& state)
+Cc ipmiUserUpdateEnabledState(const uint8_t userId, const bool& state)
{
return getUserAccessObject().setUserEnabledState(userId, state);
}
-ipmi_ret_t ipmiUserCheckEnabled(const uint8_t userId, bool& state)
+Cc ipmiUserCheckEnabled(const uint8_t userId, bool& state)
{
if (!UserAccess::isValidUserId(userId))
{
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ccParmOutOfRange;
}
UserInfo* userInfo = getUserAccessObject().getUserInfo(userId);
state = userInfo->userEnabled;
- return IPMI_CC_OK;
+ return ccSuccess;
}
-ipmi_ret_t ipmiUserGetPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
- PrivAccess& privAccess)
+Cc ipmiUserGetPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
+ PrivAccess& privAccess)
{
if (!UserAccess::isValidChannel(chNum))
{
- return IPMI_CC_INVALID_FIELD_REQUEST;
+ return ccInvalidFieldRequest;
}
if (!UserAccess::isValidUserId(userId))
{
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ccParmOutOfRange;
}
UserInfo* userInfo = getUserAccessObject().getUserInfo(userId);
privAccess.privilege = userInfo->userPrivAccess[chNum].privilege;
@@ -150,13 +149,12 @@
privAccess.linkAuthEnabled =
userInfo->userPrivAccess[chNum].linkAuthEnabled;
privAccess.accessCallback = userInfo->userPrivAccess[chNum].accessCallback;
-
- return IPMI_CC_OK;
+ return ccSuccess;
}
-ipmi_ret_t ipmiUserSetPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
- const PrivAccess& privAccess,
- const bool& otherPrivUpdates)
+Cc ipmiUserSetPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
+ const PrivAccess& privAccess,
+ const bool& otherPrivUpdates)
{
UserPrivAccess userPrivAccess;
userPrivAccess.privilege = privAccess.privilege;
@@ -176,37 +174,35 @@
return pamUserCheckAuthenticate(userName, userPassword);
}
-ipmi_ret_t ipmiUserSetUserPayloadAccess(const uint8_t chNum,
- const uint8_t operation,
- const uint8_t userId,
- const PayloadAccess& payloadAccess)
+Cc ipmiUserSetUserPayloadAccess(const uint8_t chNum, const uint8_t operation,
+ const uint8_t userId,
+ const PayloadAccess& payloadAccess)
{
if (!UserAccess::isValidChannel(chNum))
{
- return IPMI_CC_INVALID_FIELD_REQUEST;
+ return ccInvalidFieldRequest;
}
if (!UserAccess::isValidUserId(userId))
{
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ccParmOutOfRange;
}
return getUserAccessObject().setUserPayloadAccess(chNum, operation, userId,
payloadAccess);
}
-ipmi_ret_t ipmiUserGetUserPayloadAccess(const uint8_t chNum,
- const uint8_t userId,
- PayloadAccess& payloadAccess)
+Cc ipmiUserGetUserPayloadAccess(const uint8_t chNum, const uint8_t userId,
+ PayloadAccess& payloadAccess)
{
if (!UserAccess::isValidChannel(chNum))
{
- return IPMI_CC_INVALID_FIELD_REQUEST;
+ return ccInvalidFieldRequest;
}
if (!UserAccess::isValidUserId(userId))
{
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ccParmOutOfRange;
}
UserInfo* userInfo = getUserAccessObject().getUserInfo(userId);
@@ -220,7 +216,7 @@
payloadAccess.oemPayloadEnables2Reserved =
userInfo->payloadAccess[chNum].oemPayloadEnables2Reserved;
- return IPMI_CC_OK;
+ return ccSuccess;
}
} // namespace ipmi