SmbiosMdrv2Handler: Move MDRII_DATA_START, MDRII_DATA_DONE to new API.
Rewrite "cmd_mdr2_data_start" and "cmd_mdr2_data_done" command to use the newly introduced IPMI provider API.
Tested:
Verified using ipmitool MDRII_DATA_START, MDRII_DATA_DONE, behavior is same before and after the changes.
Test Result:
MDRII_DATA_START
Command = ipmitool raw 0x3e 0x3b 0x01 0x01 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 0x42 0x10 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x10 0x00 0x00 0x00
Output = 01 01 00
Command = ipmitool raw 0x3e 0x3b 0x01 0x01 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 0x42 0x10 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x10 0x00 0x00 0x00
Output = 01 02 00
Command = ipmitool raw 0x3e 0x3b 0x01 0x01 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 0x42 0x10 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x10 0x00 0x00 0x00
Output = 01 03 00
MDRII_DATA_DONE
Command = ipmitool raw 0x3e 0x3c 0x01 0x01 0x00 0x00
Output:
Signed-off-by: Deepak Kumar Sahu <deepakx.sahu@intel.com>
Change-Id: Ibc41d077a202bc3bfd27f284e6c80c29a63bb229
diff --git a/src/smbiosmdrv2handler.cpp b/src/smbiosmdrv2handler.cpp
index 1cac09a..a49213e 100644
--- a/src/smbiosmdrv2handler.cpp
+++ b/src/smbiosmdrv2handler.cpp
@@ -1167,35 +1167,31 @@
return IPMI_CC_OK;
}
-ipmi_ret_t cmd_mdr2_data_start(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
- ipmi_request_t request, ipmi_response_t response,
- ipmi_data_len_t data_len, ipmi_context_t context)
+/**
+@brief This command is executed after POST BIOS to get the session info.
+
+@param - agentId, dataInfo, dataLength, xferAddress, xferLength, timeout.
+
+@return xferStartAck and session on success.
+**/
+ipmi::RspType<uint8_t, uint16_t>
+ cmd_mdr2_data_start(uint16_t agentId, std::array<uint8_t, 16> dataInfo,
+ uint32_t dataLength, uint32_t xferAddress,
+ uint32_t xferLength, uint16_t timeout)
{
- auto requestData = reinterpret_cast<const MDRiiDataStartRequest *>(request);
- auto responseData = reinterpret_cast<MDRiiDataStartResponse *>(response);
- std::vector<uint8_t> idVector;
uint16_t session = 0;
- if (*data_len != sizeof(MDRiiDataStartRequest))
- {
- *data_len = 0;
- return IPMI_CC_REQ_DATA_LEN_INVALID;
- }
-
- *data_len = 0;
-
- if (requestData->dataLength > smbiosTableStorageSize)
+ if (dataLength > smbiosTableStorageSize)
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Requested data length is out of SMBIOS Table storage size.");
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ipmi::responseParmOutOfRange();
}
-
- if ((requestData->xferLength + requestData->xferAddress) > mdriiSMSize)
+ if ((xferLength + xferAddress) > mdriiSMSize)
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Invalid data address and size");
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ipmi::responseParmOutOfRange();
}
std::string service = ipmi::getService(bus, mdrv2Interface, mdrv2Path);
@@ -1205,41 +1201,38 @@
mdrv2 = std::make_unique<MDRV2>();
}
- int agentIndex = mdrv2->agentLookup(requestData->agentId);
+ int agentIndex = mdrv2->agentLookup(agentId);
if (agentIndex == -1)
{
phosphor::logging::log<phosphor::logging::level::ERR>(
- "Unknown agent id",
- phosphor::logging::entry("ID=%x", requestData->agentId));
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ "Unknown agent id", phosphor::logging::entry("ID=%x", agentId));
+ return ipmi::responseParmOutOfRange();
}
- int idIndex =
- mdrv2->findDataId(requestData->dataSetInfo.dataInfo,
- sizeof(requestData->dataSetInfo.dataInfo), service);
+ int idIndex = mdrv2->findDataId(dataInfo.data(), sizeof(dataInfo), service);
if ((idIndex < 0) || (idIndex >= maxDirEntries))
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Invalid Data ID", phosphor::logging::entry("IDINDEX=%x", idIndex));
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ipmi::responseParmOutOfRange();
}
- if (mdrv2->smbiosTryLock(1, idIndex, &session, requestData->timeout))
+ if (mdrv2->smbiosTryLock(1, idIndex, &session, timeout))
{
try
{
- mdrv2->area = std::make_unique<SharedMemoryArea>(
- requestData->xferAddress, requestData->xferLength);
+ mdrv2->area =
+ std::make_unique<SharedMemoryArea>(xferAddress, xferLength);
}
catch (const std::system_error &e)
{
mdrv2->smbiosUnlock(idIndex);
phosphor::logging::log<phosphor::logging::level::ERR>(
"Unable to access share memory");
- return IPMI_CC_UNSPECIFIED_ERROR;
+ return ipmi::responseUnspecifiedError();
}
- mdrv2->smbiosDir.dir[idIndex].common.size = requestData->dataLength;
+ mdrv2->smbiosDir.dir[idIndex].common.size = dataLength;
mdrv2->smbiosDir.dir[idIndex].lockHandle = session;
if (-1 ==
mdrv2->syncDirCommonData(
@@ -1247,65 +1240,58 @@
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Unable to sync data to service");
- return IPMI_CC_RESPONSE_ERROR;
+ return ipmi::responseResponseError();
}
}
else
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Canot lock smbios");
- return IPMI_CC_UNSPECIFIED_ERROR;
+ return ipmi::responseUnspecifiedError();
}
- responseData->sessionHandle = session;
- responseData->xferStartAck = 1;
+ static constexpr uint8_t xferStartAck = 1;
- *data_len = sizeof(MDRiiDataStartResponse);
- return IPMI_CC_OK;
+ return ipmi::responseSuccess(xferStartAck, session);
}
-ipmi_ret_t cmd_mdr2_data_done(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
- ipmi_request_t request, ipmi_response_t response,
- ipmi_data_len_t data_len, ipmi_context_t context)
+/**
+@brief This command is executed to close the session.
+
+@param - agentId, lockHandle.
+
+@return completion code on success.
+**/
+ipmi::RspType<> cmd_mdr2_data_done(uint16_t agentId, uint16_t lockHandle)
{
- auto requestData = reinterpret_cast<const MDRiiDataDoneRequest *>(request);
-
- if (*data_len != sizeof(MDRiiDataDoneRequest))
- {
- *data_len = 0;
- return IPMI_CC_REQ_DATA_LEN_INVALID;
- }
-
- *data_len = 0;
if (mdrv2 == nullptr)
{
mdrv2 = std::make_unique<MDRV2>();
}
- int agentIndex = mdrv2->agentLookup(requestData->agentId);
+ int agentIndex = mdrv2->agentLookup(agentId);
if (agentIndex == -1)
{
phosphor::logging::log<phosphor::logging::level::ERR>(
- "Unknown agent id",
- phosphor::logging::entry("ID=%x", requestData->agentId));
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ "Unknown agent id", phosphor::logging::entry("ID=%x", agentId));
+ return ipmi::responseParmOutOfRange();
}
- int idIndex = mdrv2->findLockHandle(requestData->lockHandle);
+ int idIndex = mdrv2->findLockHandle(lockHandle);
if ((idIndex < 0) || (idIndex >= maxDirEntries))
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Invalid Data ID", phosphor::logging::entry("IDINDEX=%x", idIndex));
- return IPMI_CC_PARM_OUT_OF_RANGE;
+ return ipmi::responseParmOutOfRange();
}
if (!mdrv2->smbiosUnlock(idIndex))
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Send data done failed - cannot unlock idIndex");
- return IPMI_CC_DESTINATION_UNAVAILABLE;
+ return ipmi::responseDestinationUnavailable();
}
mdrv2->area.reset(nullptr);
@@ -1329,9 +1315,8 @@
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"MDR2 Store data to flash failed");
- return IPMI_CC_DESTINATION_UNAVAILABLE;
+ return ipmi::responseDestinationUnavailable();
}
-
bool status = false;
std::string service = ipmi::getService(bus, mdrv2Interface, mdrv2Path);
sdbusplus::message::message method = bus.new_method_call(
@@ -1348,17 +1333,17 @@
"Error Sync data with service",
phosphor::logging::entry("SERVICE=%s", service.c_str()),
phosphor::logging::entry("PATH=%s", mdrv2Path));
- return IPMI_CC_RESPONSE_ERROR;
+ return ipmi::responseResponseError();
}
if (!status)
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"Sync data with service failure");
- return IPMI_CC_UNSPECIFIED_ERROR;
+ return ipmi::responseUnspecifiedError();
}
- return IPMI_CC_OK;
+ return ipmi::responseSuccess();
}
static void register_netfn_smbiosmdrv2_functions(void)
@@ -1416,12 +1401,12 @@
NULL, cmd_mdr2_unlock_data, PRIVILEGE_OPERATOR);
// <Send MDRII Data Start>
- ipmi_register_callback(NETFUN_INTEL_APP_OEM,
- IPMI_NETFN_INTEL_OEM_APP_CMD::MDRII_DATA_START, NULL,
- cmd_mdr2_data_start, PRIVILEGE_OPERATOR);
+ ipmi::registerHandler(ipmi::prioOemBase, NETFUN_INTEL_APP_OEM,
+ IPMI_NETFN_INTEL_OEM_APP_CMD::MDRII_DATA_START,
+ ipmi::Privilege::Operator, cmd_mdr2_data_start);
// <Send MDRII Data Done>
- ipmi_register_callback(NETFUN_INTEL_APP_OEM,
- IPMI_NETFN_INTEL_OEM_APP_CMD::MDRII_DATA_DONE, NULL,
- cmd_mdr2_data_done, PRIVILEGE_OPERATOR);
+ ipmi::registerHandler(ipmi::prioOemBase, NETFUN_INTEL_APP_OEM,
+ IPMI_NETFN_INTEL_OEM_APP_CMD::MDRII_DATA_DONE,
+ ipmi::Privilege::Operator, cmd_mdr2_data_done);
}