Added wait (-w) option to the Fw update command

Fw update command waits until ARS is complete and then proceeds with the
staging of FW.

Signed-off-by: Arun Thomas Karingada <[email protected]>

Author: Arun Thomas Karingada

src/cli/features/core/FieldSupportFeature.cpp

@@ -128,6 +128,8 @@ void cli::nvmcli::FieldSupportFeature::getPaths(cli::framework::CommandSpecList
 	updateFirmware.addOption(framework::OPTION_EXAMINE)
 			.helpText(TR("Verify the firmware image specified in the source option and return its version "
 					"without actually downloading the image to the specified " NVM_DIMM_NAME "(s)."));
+	updateFirmware.addOption(framework::OPTION_WAIT)
+			.helpText(TR("If any long-operations are pending, wait for them to complete and then continue the firmware update."));
 	updateFirmware.addTarget(TARGET_DIMM_R)
 			.valueText(DIMMIDS_STR)
 			.helpText(TR("Update the firmware on specific " NVM_DIMM_NAME "s by supplying one or more comma-separated "
@@ -340,7 +342,8 @@ cli::nvmcli::FieldSupportFeature::FieldSupportFeature() :
 		m_DumpSupport(wbemDumpSupport),
 		m_ClearSupport(wbemClearSupport),
 		m_getEvents(wbemGetEvents),
-		m_uidToDimmIdStr(wbem::physical_asset::NVDIMMFactory::uidToDimmIdStr)
+		m_uidToDimmIdStr(wbem::physical_asset::NVDIMMFactory::uidToDimmIdStr),
+		m_WaitForARSToComplete(wbemWaitForARSToComplete)
 {
 }
 
@@ -543,6 +546,8 @@ cli::framework::ResultBase *cli::nvmcli::FieldSupportFeature::updateFirmware(
 				!= parsedCommand.options.end();
 		bool examineOption = parsedCommand.options.find(framework::OPTION_EXAMINE.name)
 				!= parsedCommand.options.end();
+		bool waitOption = parsedCommand.options.find(framework::OPTION_WAIT.name)
+				!= parsedCommand.options.end();
 
 		std::vector<std::string> uids;
 		pResult = m_getDimms(parsedCommand, uids);
@@ -627,6 +632,10 @@ cli::framework::ResultBase *cli::nvmcli::FieldSupportFeature::updateFirmware(
 						}
 						else
 						{
+							if (waitOption)
+							{
+								m_WaitForARSToComplete(uids[i]);
+							}
 							m_InstallFromPath(uids[i], path, true);
 							pSimpleList->insert(prefix +
 									std::string(TRS(cli::framework::SUCCESS_MSG)) + TRS(UPDATEFIRMWARE_RESET_MSG));
@@ -682,6 +691,13 @@ int cli::nvmcli::FieldSupportFeature::wbemExamineFwImage(const std::string &devi
 	return provider.examineFwImage(deviceUid, path, fwVersion);
 }
 
+void cli::nvmcli::FieldSupportFeature::wbemWaitForARSToComplete(const std::string &deviceUid)
+{
+	LogEnterExit logging(__FUNCTION__, __FILE__, __LINE__);
+	wbem::software::NVDIMMSoftwareInstallationServiceFactory provider;
+	provider.waitForARSToComplete(deviceUid);
+}
+
 /*
  * cli command to dump the support data to a file
  */

src/cli/features/core/FieldSupportFeature.h

@@ -48,7 +48,7 @@ namespace cli
 namespace nvmcli
 {
 
-static const std::string UPDATEFIRMWARE_MSG = N_TR("Load FW on " NVM_DIMM_NAME " %s"); //!< update firmware success message
+static const std::string UPDATEFIRMWARE_MSG = N_TR("Load FW on " NVM_DIMM_NAME " %s"); //!< update firmware message
 static const std::string UPDATEFIRMWARE_RESET_MSG = N_TR(", a power cycle is required to activate the FW.");
 static const std::string UPDATEFIRMWARE_EXAMINE_VALID_MSG = N_TR(
 		"Valid"); //!< examine FW valid message
@@ -62,6 +62,7 @@ static const std::string UPDATEFIRMWARE_ERROR_MSG = N_TR(
 		"Load FW on " NVM_DIMM_NAME " (%s): Error - %s"); //!< update firmware error message
 static const std::string DOWNGRADE_FW_PROMPT = TR(
 		"Downgrade firmware on " NVM_DIMM_NAME " %s?"); //!< prompt for user if not forced
+
 static const std::string CREATESNAPSHOT_MSG = N_TR(
 		"Create support snapshot"); //!< create support snapshot success message
 static const std::string DUMPSUPPORT_MSG = N_TR(
@@ -219,6 +220,12 @@ class NVM_CLI_API FieldSupportFeature : public cli::nvmcli::VerboseFeatureBase
 	std::string (*m_uidToDimmIdStr)(const std::string &dimmUid)
 			throw (wbem::framework::Exception);
 
+	/*!
+	 * API for allowing ARS to complete
+	 * @param deviceUid
+	 */
+	void (*m_WaitForARSToComplete)(const std::string &deviceUid);
+
 	/*
 	 * Retrieve a list of supported preferences
 	 */
@@ -291,6 +298,13 @@ class NVM_CLI_API FieldSupportFeature : public cli::nvmcli::VerboseFeatureBase
 	static int wbemExamineFwImage(const std::string &deviceUid, const std::string &path,
 			std::string &fwVersion);
 
+	/*!
+	 * Wrapper around wbem waitForARSToComplete
+	 * @param deviceUid
+	 * @return
+	 */
+	static void wbemWaitForARSToComplete(const std::string &deviceUid);
+
 	/*!
 	 * Wrapper around wbem
 	 * @param path

src/core/device/DeviceService.cpp

@@ -155,6 +155,13 @@ std::string core::device::DeviceService::getFirmwareApiVersionByUid(const std::s
 	return m_lib.getDeviceDiscovery(deviceUid).fw_api_version;
 }
 
+NVM_UINT32 core::device::DeviceService::getHandleByUid(const std::string &deviceUid)
+{
+	LogEnterExit logging(__FUNCTION__, __FILE__, __LINE__);
+	return m_lib.getDeviceDiscovery(deviceUid).device_handle.handle;
+}
+
+
 void core::device::DeviceService::modifyDeviceSettings(const std::string& deviceUid,
 		const bool enableFirstFastRefresh, const bool enableViralPolicy)
 {

src/core/device/DeviceService.h

@@ -52,6 +52,7 @@ class NVM_CORE_API DeviceService
 	virtual DeviceCollection getAllDevices();
 	virtual Result<Device> getDevice(std::string uid);
 	virtual std::string getFirmwareApiVersionByUid(const std::string &deviceUid);
+	virtual NVM_UINT32 getHandleByUid(const std::string &deviceUid);
 
 	virtual void modifyDeviceSettings(const std::string &deviceUid,
 			const bool enableFirstFastRefresh, const bool enableViralPolicy);

src/lib/update_firmware.c

@@ -282,7 +282,6 @@ int update_firmware(const NVM_NFIT_DEVICE_HANDLE device_handle, const NVM_PATH p
 			{
 				nvm_sleep(1000); // 1 second
 			}
-
 			// Changing the state invalidates the device cache
 			invalidate_devices();
 		}

src/wbem/software/NVDIMMSoftwareInstallationServiceFactory.cpp

@@ -44,8 +44,11 @@
 #include "NVDIMMSoftwareInstallationServiceFactory.h"
 #include "NVDIMMCollectionFactory.h"
 
+
 #include <algorithm>
 #include <string.h>
+#include <string/s_str.h>
+
 
 #include <exception/NvmExceptionLibError.h>
 #include <NvmStrings.h>
@@ -54,7 +57,8 @@
 wbem::software::NVDIMMSoftwareInstallationServiceFactory::NVDIMMSoftwareInstallationServiceFactory()
 throw (wbem::framework::Exception) : m_UpdateDeviceFw(nvm_update_device_fw),
 m_ExamineFwImage(nvm_examine_device_fw),
-m_GetManageableDeviceUids(physical_asset::NVDIMMFactory::getManageableDeviceUids)
+m_GetManageableDeviceUids(physical_asset::NVDIMMFactory::getManageableDeviceUids),
+m_GetDeviceDetails(nvm_get_device_details)
 { }
 
 wbem::software::NVDIMMSoftwareInstallationServiceFactory::~NVDIMMSoftwareInstallationServiceFactory()
@@ -458,3 +462,49 @@ throw (framework::Exception)
 	version = fw_version;
 	return rc;
 }
+
+void wbem::software::NVDIMMSoftwareInstallationServiceFactory::waitForARSToComplete( ) const
+throw (framework::Exception)
+{
+	LogEnterExit logging(__FUNCTION__, __FILE__, __LINE__);
+
+	std::vector<std::string> devices = m_GetManageableDeviceUids();
+	for (size_t i = 0; i < devices.size(); i++)
+	{
+		waitForARSToComplete(devices[i]);
+	}
+}
+
+int wbem::software::NVDIMMSoftwareInstallationServiceFactory::waitForARSToComplete(
+		const std::string& deviceUid) const
+throw (framework::Exception)
+{
+	LogEnterExit logging(__FUNCTION__, __FILE__, __LINE__);
+
+	if (!core::device::isUidValid(deviceUid))
+	{
+		throw framework::ExceptionBadParameter("deviceUid");
+	}
+	struct device_status status;
+	NVM_UID lib_deviceUid;
+	int rc = NVM_SUCCESS;
+
+	core::Helper::stringToUid(deviceUid, lib_deviceUid);
+
+	rc = nvm_get_device_status(lib_deviceUid, &status);
+	if(status.ars_status == DEVICE_ARS_STATUS_INPROGRESS)
+	{
+		printf("Cannot stage FW while ARS is in Progress. Waiting for ARS Completion\n");
+
+	}
+
+	while (status.ars_status == DEVICE_ARS_STATUS_INPROGRESS)
+	{
+		nvm_sleep(1000); // 1 second
+		printf(".");
+		fflush(stdout);
+		rc = nvm_get_device_status(lib_deviceUid, &status);
+	}
+	printf("\n");
+	return rc;
+}

src/wbem/software/NVDIMMSoftwareInstallationServiceFactory.h

@@ -158,6 +158,22 @@ class NVM_CIM_API NVDIMMSoftwareInstallationServiceFactory : public framework_in
 				std::string &version) const
 		throw (framework::Exception);
 
+		/*!
+		 * Wait for ARS to complete
+		 * @param deviceUid
+		 *		Device to allow ARS for completion
+		 * @return
+		 */
+		int waitForARSToComplete(const std::string &deviceUid) const
+		throw (framework::Exception);
+
+		/*!
+		 * Wait for ARS to complete for all devices.
+		 * @return
+		 */
+		void waitForARSToComplete( ) const
+		throw (framework::Exception);
+
 		/*!
 		 * API indirection
 		 * @param device_uid
@@ -188,6 +204,14 @@ class NVM_CIM_API NVDIMMSoftwareInstallationServiceFactory : public framework_in
 		 */
 		std::vector<std::string> (*m_GetManageableDeviceUids)();
 
+		/*!
+		 * API for getting device details
+		 * @param device_uid
+		 * @return status of operation
+		 */
+		int (*m_GetDeviceDetails)(const NVM_UID device_uid,
+				struct device_details *p_details);
+
 	private:
 		void populateAttributeList(framework::attribute_names_t &attributes)
 			throw (framework::Exception);