summaryrefslogtreecommitdiff
path: root/include/mts/MTS_IO_ICellularRadio.h
diff options
context:
space:
mode:
authorSerhii Kostiuk <serhii.o.kostiuk@globallogic.com>2020-05-28 14:51:31 +0300
committerSerhii Kostiuk <serhii.o.kostiuk@globallogic.com>2020-05-30 11:38:47 +0300
commit26f6e69e9d5c7049d42559259933482b35559889 (patch)
tree8ca06d0dbe77a4ca8eab4dce4cdd3bf6928a4e6c /include/mts/MTS_IO_ICellularRadio.h
parent9a78ce7478a507337bc78967e7ed244c5179b45c (diff)
downloadlibmts-io-26f6e69e9d5c7049d42559259933482b35559889.tar.gz
libmts-io-26f6e69e9d5c7049d42559259933482b35559889.tar.bz2
libmts-io-26f6e69e9d5c7049d42559259933482b35559889.zip
Quectel Delta Radio Firmware Upgrade support - libmts-io implementation
Declared base interface and added stub implementation for the Delta Radio Firmware Upgrade support in libmts-io.
Diffstat (limited to 'include/mts/MTS_IO_ICellularRadio.h')
-rw-r--r--include/mts/MTS_IO_ICellularRadio.h50
1 files changed, 50 insertions, 0 deletions
diff --git a/include/mts/MTS_IO_ICellularRadio.h b/include/mts/MTS_IO_ICellularRadio.h
index 58d5076..5123ba1 100644
--- a/include/mts/MTS_IO_ICellularRadio.h
+++ b/include/mts/MTS_IO_ICellularRadio.h
@@ -405,6 +405,56 @@ namespace MTS {
*/
virtual CODE updateFumo(const Json::Value& jArgs, UpdateCb& stepCb) = 0;
+ /**
+ * @brief uploadDeltaFirmwareFile - upload delta file to the radio's internal memory.
+ *
+ * This command uploads (injects) the whole delta firmware image to some place that
+ * can be later used by the radio to perform the Delta Radio Firmware Upgrade.
+ *
+ * This delta firmware image is NOT validated on the firmware image upload step.
+ *
+ * @param fd - file sescriptor of a file that shall be uploaded to the radio.
+ * @param stepCb - the callback to receive status updates during the upload.
+ * @return CODE::SUCCESS when the file was successfully uploaded,
+ * CODE::INVALID_ARGS when the file can't be opened for reading,
+ * CODE::NOT_APPLICABLE when not supported by this radio,
+ * CODE::ERROR otherwise.
+ */
+ virtual CODE uploadDeltaFirmwareFile(int fd, UpdateCb& stepCb) = 0;
+
+ /**
+ * @brief removeDeltaFirmwareFile - remove the delta file from the radio's internal memory.
+ *
+ * This command allows to remove the old delta firmware image from the radio's internal
+ * memory for cases when it's no longer needed.
+ *
+ * @param fd - file sescriptor of a file that shall be uploaded to the radio.
+ * @return CODE::SUCCESS when the file was successfully deleted,
+ * CODE::FAILURE when the file can't be deleted (i.e. no such file),
+ * CODE::NOT_APPLICABLE when not supported by this radio,
+ * CODE::ERROR otherwise.
+ */
+ virtual CODE removeDeltaFirmwareFile() = 0;
+
+ /**
+ * @brief applyDeltaFirmwareFile - apply the delta file that was previously uploaded.
+ *
+ * This commands initializes and tracks the progress of the delta firmware upgrade
+ * procedure using the delta firmware image file that was previously uploaded
+ * into internal radio's memory.
+ *
+ * See ICellularRadio::removeDeltaFirmwareFile to upload the file and prepare
+ * for the upgrade.
+ *
+ * @param fd - file sescriptor of a file that shall be uploaded to the radio.
+ * @param stepCb - the callback to receive status updates during the upgrade.
+ * @return CODE::SUCCESS when the file was successfully deleted,
+ * CODE::FAILURE when the file can't be deleted (i.e. no such file),
+ * CODE::NOT_APPLICABLE when not supported by this radio,
+ * CODE::ERROR otherwise.
+ */
+ virtual CODE applyDeltaFirmwareFile(UpdateCb& stepCb) = 0;
+
/*
* jArgs = {
* "msl" : "Master Subsidy Lock (Sprint): STRING"