Added support in "Basic" Mode for MCUboot Bootloader Update

In Basic Mode, we now support ZIP files with multiple bootloader images. This change also adds "Bootloader Slot" to the Device Status list.
NordicSemiconductor · Jan 8, 2025 · b00be8f · b00be8f
1 parent f2d812d
commit b00be8f
Show file tree

Hide file tree

Showing 7 changed files with 186 additions and 17 deletions.
diff --git a/Example/Example/Base.lproj/Main.storyboard b/Example/Example/Base.lproj/Main.storyboard
diff --git a/Example/Example/View Controllers/Manager/BaseViewController.swift b/Example/Example/View Controllers/Manager/BaseViewController.swift
@@ -14,6 +14,7 @@ protocol DeviceStatusDelegate: AnyObject {
     func connectionStateDidChange(_ state: PeripheralState)
     func bootloaderNameReceived(_ name: String)
     func bootloaderModeReceived(_ mode: BootloaderInfoResponse.Mode)
+    func bootloaderSlotReceived(_ slot: UInt64)
     func appInfoReceived(_ output: String)
     func mcuMgrParamsReceived(buffers: Int, size: Int)
 }
@@ -32,6 +33,9 @@ final class BaseViewController: UITabBarController {
             if let bootloaderMode {
                 deviceStatusDelegate?.bootloaderModeReceived(bootloaderMode)
             }
+            if let bootloaderSlot {
+                deviceStatusDelegate?.bootloaderSlotReceived(bootloaderSlot)
+            }
             if let appInfoOutput {
                 deviceStatusDelegate?.appInfoReceived(appInfoOutput)
             }
@@ -71,6 +75,13 @@ final class BaseViewController: UITabBarController {
             }
         }
     }
+    private var bootloaderSlot: UInt64? {
+        didSet {
+            if let bootloaderSlot {
+                deviceStatusDelegate?.bootloaderSlotReceived(bootloaderSlot)
+            }
+        }
+    }
     private var appInfoOutput: String? {
         didSet {
             if let appInfoOutput {
@@ -132,6 +143,10 @@ extension BaseViewController: PeripheralDelegate {
                         defaultManager.bootloaderInfo(query: .mode) { [weak self] response, error in
                             self?.bootloaderMode = response?.mode
                         }
+
+                        defaultManager.bootloaderInfo(query: .slot) { [weak self] response, error in
+                            self?.bootloaderSlot = response?.activeSlot
+                        }
                     }
                 }
             }

diff --git a/Example/Example/View Controllers/Manager/DeviceController.swift b/Example/Example/View Controllers/Manager/DeviceController.swift
@@ -17,6 +17,7 @@ class DeviceController: UITableViewController, UITextFieldDelegate {
     @IBOutlet weak var mcuMgrParams: UILabel!
     @IBOutlet weak var bootloaderName: UILabel!
     @IBOutlet weak var bootloaderMode: UILabel!
+    @IBOutlet weak var bootloaderSlot: UILabel!
     @IBOutlet weak var kernel: UILabel!
     @IBOutlet weak var actionSend: UIButton!
     @IBOutlet weak var message: UITextField!
@@ -145,6 +146,10 @@ extension DeviceController: DeviceStatusDelegate {
         bootloaderMode.text = mode.description
     }
 
+    func bootloaderSlotReceived(_ slot: UInt64) {
+        bootloaderSlot.text = "\(slot)"
+    }
+
     func appInfoReceived(_ output: String) {
         kernel.text = output
     }

diff --git a/Example/Example/View Controllers/Manager/FilesController.swift b/Example/Example/View Controllers/Manager/FilesController.swift
@@ -18,6 +18,7 @@ class FilesController: UITableViewController {
     @IBOutlet weak var mcuMgrParams: UILabel!
     @IBOutlet weak var bootloaderName: UILabel!
     @IBOutlet weak var bootloaderMode: UILabel!
+    @IBOutlet weak var bootloaderSlot: UILabel!
     @IBOutlet weak var kernel: UILabel!
 
     var fileDownloadViewController: FileDownloadViewController!
@@ -105,6 +106,10 @@ extension FilesController: DeviceStatusDelegate {
         bootloaderMode.text = mode.description
     }
 
+    func bootloaderSlotReceived(_ slot: UInt64) {
+        bootloaderSlot.text = "\(slot)"
+    }
+
     func appInfoReceived(_ output: String) {
         kernel.text = output
     }

diff --git a/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift b/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift
@@ -66,7 +66,12 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
             // (We use modes in the code only, but SUIT has no concept of upload modes)
             startFirmwareUpgrade(package: package)
         } else {
-            selectMode(for: package)
+            if package.images.count > 1, package.images.contains(where: { $0.content == .mcuboot }) {
+                // Force user to select which 'image' to use for bootloader update.
+                selectBootloaderImage(for: package)
+            } else {
+                selectMode(for: package)
+            }
         }
     }
 
@@ -157,6 +162,8 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
         updateEraseApplicationSettings(to: sender.isOn)
     }
 
+    // MARK: selectMode(for:)
+
     private func selectMode(for package: McuMgrPackage) {
         let alertController = UIAlertController(title: "Select Mode", message: nil, preferredStyle: .actionSheet)
         FirmwareUpgradeMode.allCases.forEach { upgradeMode in
@@ -170,6 +177,21 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
         present(alertController, addingCancelAction: true)
     }
 
+    // MARK: selectBootloaderImage(for:)
+
+    private func selectBootloaderImage(for package: McuMgrPackage) {
+        let alertController = buildSelectImageController()
+        for image in package.images {
+            alertController.addAction(UIAlertAction(title: image.imageName(), style: .default) { [weak self]
+                action in
+                self?.dfuManagerConfiguration.eraseAppSettings = false
+                self?.dfuManagerConfiguration.upgradeMode = .confirmOnly
+                self?.startFirmwareUpgrade(images: [image])
+            })
+        }
+        present(alertController, animated: true)
+    }
+
     // MARK: updateEstimatedSwapTime(to:)
 
     private func updateEstimatedSwapTime(to numberOfSeconds: Int, updatingUserDefaults: Bool = true) {
@@ -223,6 +245,8 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
         present(alertViewController, animated: true)
     }
 
+    // MARK: startFirmwareUpgrade
+
     private func startFirmwareUpgrade(package: McuMgrPackage) {
         do {
             try dfuManager.start(package: package, using: dfuManagerConfiguration)
@@ -232,6 +256,16 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
             actionStart.isEnabled = false
         }
     }
+
+    private func startFirmwareUpgrade(images: [ImageManager.Image]) {
+        do {
+            try dfuManager.start(images: images, using: dfuManagerConfiguration)
+        } catch {
+            status.textColor = .systemRed
+            status.text = error.localizedDescription
+            actionStart.isEnabled = false
+        }
+    }
 }
 
 // MARK: - UserDefaults Keys

diff --git a/Example/Example/View Controllers/Manager/ImageController.swift b/Example/Example/View Controllers/Manager/ImageController.swift
@@ -11,7 +11,8 @@ class ImageController: UITableViewController {
     @IBOutlet weak var connectionStatus: UILabel!
     @IBOutlet weak var mcuMgrParams: UILabel!
     @IBOutlet weak var bootloaderName: UILabel!
-    @IBOutlet weak var bootloaderMode: UILabel!    
+    @IBOutlet weak var bootloaderMode: UILabel!
+    @IBOutlet weak var bootloaderSlot: UILabel!
     @IBOutlet weak var kernel: UILabel!
     /// Instance if Images View Controller, required to get its
     /// height when data are obtained and height changes.
@@ -112,6 +113,10 @@ extension ImageController: DeviceStatusDelegate {
         bootloaderMode.text = mode.description
     }
 
+    func bootloaderSlotReceived(_ slot: UInt64) {
+        bootloaderSlot.text = "\(slot)"
+    }
+
     func appInfoReceived(_ output: String) {
         kernel.text = output
     }

diff --git a/Example/Example/View Controllers/Manager/LogsStatsController.swift b/Example/Example/View Controllers/Manager/LogsStatsController.swift
@@ -12,6 +12,7 @@ class LogsStatsController: UITableViewController {
     @IBOutlet weak var mcuMgrParams: UILabel!
     @IBOutlet weak var bootloaderName: UILabel!
     @IBOutlet weak var bootloaderMode: UILabel!
+    @IBOutlet weak var bootloaderSlot: UILabel!
     @IBOutlet weak var kernel: UILabel!
     @IBOutlet weak var stats: UILabel!
     @IBOutlet weak var refreshAction: UIButton!
@@ -98,6 +99,10 @@ extension LogsStatsController: DeviceStatusDelegate {
         bootloaderMode.text = mode.description
     }
 
+    func bootloaderSlotReceived(_ slot: UInt64) {
+        bootloaderSlot.text = "\(slot)"
+    }
+
     func appInfoReceived(_ output: String) {
         kernel.text = output
     }