From 1599b30b109ff8ade79d6d4763767cc5aaad2021 Mon Sep 17 00:00:00 2001
From: Li Hua Qian <huaqian.li@siemens.com>
Date: Mon, 25 Mar 2024 14:00:38 +0800
Subject: [PATCH] iot2050-module-firmware-update: Add module firmware update

The IOT2050 features a customized external signal module, such as the
SM SENS DI. Unlike the standard PLC1200, this module is specifically
tailored to the IOT2050's requirements. As a result, it cannot be
upgraded within the conventional PLC ecosystem. However, we ensure to
provide a method to support firmware upgrades for these custom modules.

And the firmware update for the module should not be included with the
image. This is because the image becomes too large and cumbersome to
release when only the update tool needs to be released. Instead, the
module firmware update should be packaged separately in its own
Debian package for a more efficient and manageable release process.

Signed-off-by: Li Hua Qian <huaqian.li@siemens.com>
---
 kas/opt/module.yml                            | 16 ++++
 .../files/iot2050-module-firmware-update.tmpl | 76 +++++++++++++++++++
 .../iot2050-module-firmware-update_01.bb      | 26 +++++++
 recipes-core/images/iot2050-image-example.bb  |  5 ++
 4 files changed, 123 insertions(+)
 create mode 100644 kas/opt/module.yml
 create mode 100755 recipes-app/iot2050-module-firmware-update/files/iot2050-module-firmware-update.tmpl
 create mode 100644 recipes-app/iot2050-module-firmware-update/iot2050-module-firmware-update_01.bb

diff --git a/kas/opt/module.yml b/kas/opt/module.yml
new file mode 100644
index 000000000..dc715c301
--- /dev/null
+++ b/kas/opt/module.yml
@@ -0,0 +1,16 @@
+#
+# Copyright (c) Siemens AG, 2024
+#
+# Authors:
+#  Li Hua Qian <huaqian.li@siemens.com>
+#
+# This file is subject to the terms and conditions of the MIT License.  See
+# COPYING.MIT file in the top-level directory.
+#
+
+header:
+  version: 14
+
+local_conf_header:
+  no-eio: |
+    IOT2050_MODULE_FWU = "1"
diff --git a/recipes-app/iot2050-module-firmware-update/files/iot2050-module-firmware-update.tmpl b/recipes-app/iot2050-module-firmware-update/files/iot2050-module-firmware-update.tmpl
new file mode 100755
index 000000000..7c08f041e
--- /dev/null
+++ b/recipes-app/iot2050-module-firmware-update/files/iot2050-module-firmware-update.tmpl
@@ -0,0 +1,76 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) Siemens AG, 2024
+#
+# Authors:
+#  Li Hua Qian <huaqian.li@siemens.com>
+#
+# SPDX-License-Identifier: MIT
+
+import os
+import sys
+import argparse
+import textwrap
+
+def main(args):
+    description=textwrap.dedent('''\
+        Script for updating module firmware on IoT2050
+        Examples usage:
+          1. iot2050-module-firmware-update -s 1 -fwa firmwareA.bin
+          2. iot2050-module-firmware-update -s 1 -fwa firmwareA.bin -fwb firmwareB.bin
+         ''')
+    parser = argparse.ArgumentParser(
+        description=description,
+        formatter_class=argparse.RawDescriptionHelpFormatter
+    )
+    parser.add_argument(
+        "-s", "--slot",
+        type=int,
+        required=True,
+        help="Slot number"
+    )
+    parser.add_argument(
+        "-fwa", "--firmware-a",
+        help="Path to firmware A file",
+        type=argparse.FileType('rb')
+    )
+    parser.add_argument(
+        "-fwb", "--firmware-b",
+        help="Path to firmware B file",
+        type=argparse.FileType('rb')
+    )
+    args = parser.parse_args(args)
+
+    if not args.firmware_a and not args.firmware_b:
+        print("Error: No firmware file specified")
+        parser.print_help()
+        return 1
+
+    slot = args.slot
+    slot_path = f"/eiofs/controller/slot{slot}"
+    if args.firmware_a:
+        print("Updating firmware A ...")
+        try:
+            with open(slot_path + "/fwa", "wb") as f:
+                f.write(args.firmware_a.read())
+        except Exception as e:
+            print(f"Error: Failed to write firmware A, {e}")
+            return 1
+
+    if args.firmware_b:
+        print("Updating firmware B ...")
+        try:
+            with open(slot_path + "/fwb", "wb") as f:
+                f.write(args.firmware_b.read())
+        except Exception as e:
+            print(f"Error: Failed to write firmware B, {e}")
+            return 1
+
+    print("Firmware updated successfully")
+
+    return 0
+
+if __name__ == '__main__':
+    CODE = main(sys.argv[1:])
+    sys.exit(CODE)
+
diff --git a/recipes-app/iot2050-module-firmware-update/iot2050-module-firmware-update_01.bb b/recipes-app/iot2050-module-firmware-update/iot2050-module-firmware-update_01.bb
new file mode 100644
index 000000000..9365572fc
--- /dev/null
+++ b/recipes-app/iot2050-module-firmware-update/iot2050-module-firmware-update_01.bb
@@ -0,0 +1,26 @@
+#
+# Copyright (c) Siemens AG, 2024
+#
+# Authors:
+#  Li Hua Qian <huaqian.li@siemens.com>
+#
+# This file is subject to the terms and conditions of the MIT License.  See
+# COPYING.MIT file in the top-level directory.
+#
+
+DESCRIPTION = "IOT2050 Customized External Signal Module Firmware Update"
+MAINTAINER = "huaqian.li@siemens.com"
+
+SRC_URI = " \
+    file://iot2050-module-firmware-update.tmpl"
+
+TEMPLATE_FILES = "iot2050-module-firmware-update.tmpl"
+
+inherit dpkg-raw
+
+do_install() {
+    install -v -d ${D}/usr/sbin/
+    install -v -m 755 ${WORKDIR}/iot2050-module-firmware-update ${D}/usr/sbin/
+}
+
+do_deploy_deb[dirs] = "${DEPLOY_DIR_IMAGE}"
diff --git a/recipes-core/images/iot2050-image-example.bb b/recipes-core/images/iot2050-image-example.bb
index cc9fdae3c..9208b2189 100644
--- a/recipes-core/images/iot2050-image-example.bb
+++ b/recipes-core/images/iot2050-image-example.bb
@@ -58,3 +58,8 @@ IMAGE_INSTALL += "${@ ' \
     iot2050-eio-manager \
     iot2050-conf-webui \
     ' if d.getVar('IOT2050_EIO_SUPPORT') == '1' else ''}"
+
+IOT2050_MODULE_FWU ?= "0"
+IMAGE_INSTALL += "${@ ' \
+    iot2050-module-firmware-update \
+    ' if d.getVar('IOT2050_MODULE_FWU') == '1' else '' }"