From 5e71d7a4d710c35e91f1363fd4ef37c3f6784086 Mon Sep 17 00:00:00 2001
From: Robin Krahl <robin@nitrokey.com>
Date: Mon, 17 Jan 2022 16:31:50 +0100
Subject: [PATCH] nk3: Show bootloader error if firmware update fails
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This patch adds the bootloader error code and message to the output if
the firmware update fails.  Previously we only printed a generic “update
failed” error message.
---
 pynitrokey/cli/nk3/__init__.py            |  3 ++-
 pynitrokey/nk3/bootloader.py              | 10 ++++++++--
 pynitrokey/stubs/spsdk/mboot/__init__.pyi |  7 +++++++
 3 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/pynitrokey/cli/nk3/__init__.py b/pynitrokey/cli/nk3/__init__.py
index 0a25c217..b0e12b50 100644
--- a/pynitrokey/cli/nk3/__init__.py
+++ b/pynitrokey/cli/nk3/__init__.py
@@ -318,7 +318,8 @@ def _perform_update(device: Nitrokey3Bootloader, image: bytes) -> None:
             logger.debug("Firmware update finished successfully")
             device.reboot()
         else:
-            local_critical("Firmware update failed")
+            (code, message) = device.status
+            local_critical(f"Firmware update failed with status code {code}: {message}")
 
 
 @nk3.command()
diff --git a/pynitrokey/nk3/bootloader.py b/pynitrokey/nk3/bootloader.py
index f82628f7..952df9ff 100644
--- a/pynitrokey/nk3/bootloader.py
+++ b/pynitrokey/nk3/bootloader.py
@@ -10,9 +10,9 @@
 import logging
 import platform
 import sys
-from typing import List, Optional
+from typing import List, Optional, Tuple
 
-from spsdk.mboot import McuBoot
+from spsdk.mboot import McuBoot, StatusCode
 from spsdk.mboot.interfaces import RawHid
 from spsdk.mboot.properties import PropertyTag
 from spsdk.sbfile.images import BootImageV21
@@ -57,6 +57,12 @@ def path(self) -> str:
     def name(self) -> str:
         return "Nitrokey 3 Bootloader"
 
+    @property
+    def status(self) -> Tuple[int, str]:
+        code = self.device.status_code
+        message = StatusCode.desc(code)
+        return (code, message)
+
     def close(self) -> None:
         self.device.close()
 
diff --git a/pynitrokey/stubs/spsdk/mboot/__init__.pyi b/pynitrokey/stubs/spsdk/mboot/__init__.pyi
index d9c6fe5f..675519dc 100644
--- a/pynitrokey/stubs/spsdk/mboot/__init__.pyi
+++ b/pynitrokey/stubs/spsdk/mboot/__init__.pyi
@@ -7,13 +7,20 @@
 # http://opensource.org/licenses/MIT>, at your option. This file may not be
 # copied, modified, or distributed except according to those terms.
 
+from enum import Enum
 from typing import List, Optional
 
 from .interfaces import Interface
 from .properties import PropertyTag
 
+class StatusCode(int):
+    @classmethod
+    def desc(cls, key: int) -> str: ...
+
 class McuBoot:
     def __init__(self, device: Interface) -> None: ...
+    @property
+    def status_code(self) -> StatusCode: ...
     def open(self) -> None: ...
     def close(self) -> None: ...
     def receive_sb_file(self, data: bytes) -> bool: ...