Merge pull request #328 from LedgerHQ/nbgl-on-nano_fixes

Nbgl on nano fixes

Author: iartemov-ledger

glyphs/bitcoin_logo.gif

@@ -0,0 +1 @@
+../icons/nanox_app_bitcoin.gif

glyphs/bitcoin_logo_inv.gif

@@ -30,6 +30,8 @@ extern dispatcher_context_t G_dispatcher_context;
 
 extern bool G_was_processing_screen_shown;
 
+extern char const *G_processing_screen_text;
+
 // Private state that is not made accessible from the dispatcher context
 struct {
     void (*termination_cb)(void);
@@ -161,7 +163,7 @@ void apdu_dispatcher(command_descriptor_t const cmd_descriptors[],
         handler(&G_dispatcher_context, cmd->p2);
     }
 
-    // Here a response (either success or error) should have been send.
+    // Here a response (either success or error) should have been sent.
     // Failure to do so indicates a bug in the last command processors.
     if (G_dispatcher_state.sw == 0) {
         PRINTF("No response before terminating\n");
@@ -173,8 +175,12 @@ void apdu_dispatcher(command_descriptor_t const cmd_descriptors[],
     // - background processing took long enough that the "Processing..." screen was shown.
     bool is_ux_dirty = G_dispatcher_state.had_ux_flow || G_was_processing_screen_shown;
     if (G_dispatcher_state.termination_cb != NULL && is_ux_dirty) {
+        G_dispatcher_state.termination_cb();
         G_was_processing_screen_shown = 0;
     }
 
     io_clear_processing_timeout();
+
+    /* Resetting loading information screen */
+    G_processing_screen_text = NULL;
 }

icons/nanox_app_bitcoin.gif

@@ -31,6 +31,7 @@
 
 #include "dispatcher.h"
 #include "../swap/swap_globals.h"
+#include "../ui/display.h"
 
 uint16_t G_output_len = 0;
 
@@ -78,7 +79,7 @@ void io_show_processing_screen() {
     if (!G_was_processing_screen_shown) {
         G_was_processing_screen_shown = true;
         if (!G_swap_state.called_from_swap) {
-            nbgl_useCaseSpinner("Processing");
+            nbgl_useCaseSpinner(ui_get_processing_screen_text());
         }
     }
 }

src/boilerplate/dispatcher.c

@@ -33,6 +33,8 @@
 #define MAX_DISPLAYBLE_CHUNK_NUMBER \
     (5 * MESSAGE_CHUNK_PER_DISPLAY)  // If the message is too long we will not display it
 
+extern const char GA_LOADING_MESSAGE[];
+
 static unsigned char const BSM_SIGN_MAGIC[] = {'\x18', 'B', 'i', 't', 'c', 'o', 'i', 'n', ' ',
                                                'S',    'i', 'g', 'n', 'e', 'd', ' ', 'M', 'e',
                                                's',    's', 'a', 'g', 'e', ':', '\n'};
@@ -123,6 +125,9 @@ void handler_sign_message(dispatcher_context_t* dc, uint8_t protocol_version) {
         return;
     }
 
+    /* Setting message loading information screen */
+    ui_set_processing_screen_text(GA_LOADING_MESSAGE);
+
     char path_str[MAX_SERIALIZED_BIP32_PATH_LENGTH + 1] = "(Master key)";
     if (bip32_path_len > 0) {
         bip32_path_format(bip32_path, bip32_path_len, path_str, sizeof(path_str));

src/boilerplate/io.c

@@ -84,6 +84,8 @@ typedef struct {
     uint32_t key_origin[MAX_BIP32_PATH_STEPS];
 } derivation_info_t;
 
+extern const char GA_LOADING_TRANSACTION[];
+
 // Convenience function to share common logic when parsing the
 // PSBT_{IN|OUT}_{TAP}?_BIP32_DERIVATION fields from inputs or outputs.
 // Note: This function must return -1 only on errors (causing signing to abort).
@@ -2092,6 +2094,9 @@ sign_psbt_cache_t G_sign_psbt_cache;
 void handler_sign_psbt(dispatcher_context_t *dc, uint8_t protocol_version) {
     LOG_PROCESSOR(__FILE__, __LINE__, __func__);
 
+    /* Setting transaction loading information screen */
+    ui_set_processing_screen_text(GA_LOADING_TRANSACTION);
+
     sign_psbt_state_t st;
     memset(&st, 0, sizeof(st));
 
@@ -2113,7 +2118,7 @@ void handler_sign_psbt(dispatcher_context_t *dc, uint8_t protocol_version) {
 
     /** Inputs verification flow
      *
-     *  Go though all the inputs:
+     *  Go through all the inputs:
      *  - verify the non_witness_utxo
      *  - compute value spent
      *  - detect internal inputs that should be signed, and if there are external inputs or unusual

src/handler/sign_message.c

@@ -24,6 +24,13 @@ extern dispatcher_context_t G_dispatcher_context;
 
 ui_state_t g_ui_state;
 
+/*
+ * Pointer to the text to be shown when processing.
+ * If set to NULL, a default message is shown,
+ * otherwise it must be a pointer to a valid 0-terminated string.
+ */
+char const *G_processing_screen_text;
+
 void send_deny_sw(dispatcher_context_t *dc) {
     SEND_SW(dc, SW_DENY);
 }
@@ -392,3 +399,11 @@ bool ui_post_processing_confirm_message(dispatcher_context_t *context, bool succ
 void ui_pre_processing_message(void) {
     ui_set_display_prompt();
 }
+
+char const *ui_get_processing_screen_text(void) {
+    return (G_processing_screen_text != NULL) ? G_processing_screen_text : "Loading";
+}
+
+void ui_set_processing_screen_text(const char *text) {
+    G_processing_screen_text = text;
+}

src/handler/sign_psbt.c

@@ -22,10 +22,12 @@
 
 #ifdef SCREEN_SIZE_WALLET
 #define ICON_APP_IMPORTANT C_Important_Circle_64px
-#define ICON_APP_LOGO      C_Bitcoin_64px
+#define ICON_APP_HOME      C_Bitcoin_64px
+#define ICON_APP_ACTION    C_Bitcoin_64px
 #else
 #define ICON_APP_IMPORTANT C_icon_warning
-#define ICON_APP_LOGO      C_bitcoin_logo
+#define ICON_APP_HOME      C_bitcoin_logo
+#define ICON_APP_ACTION    C_bitcoin_logo_inv
 #endif
 
 typedef struct tx_ux_warning_s {
@@ -252,3 +254,9 @@ uint8_t get_streaming_index(void);
 void reset_streaming_index(void);
 void increase_streaming_index(void);
 void decrease_streaming_index(void);
+
+/**
+ * Functions to get and set the text to be shown when processing.
+ */
+char const *ui_get_processing_screen_text(void);
+void ui_set_processing_screen_text(const char *text);

src/ui/display.c

@@ -27,6 +27,8 @@ const char GA_REGISTER_ACCOUNT[] = "Register account";
 const char GA_UNVERIFIED_INPUTS[] = "Unverified inputs\nUpdate your wallet software";
 const char GA_REVIEW_TRANSACTION[] = "Review transaction\nto send Bitcoin";
 const char GA_REVIEW_MESSAGE[] = "Review message";
+const char GA_LOADING_TRANSACTION[] = "Loading transaction";
+const char GA_LOADING_MESSAGE[] = "Loading message";
 
 #define N_UX_PAIRS 18
 
@@ -89,7 +91,7 @@ static void status_address_callback(bool confirm) {
 static void start_processing_transaction_callback(bool confirm) {
     if (confirm) {
         G_was_processing_screen_shown = true;
-        nbgl_useCaseSpinner("Processing");
+        nbgl_useCaseSpinner(ui_get_processing_screen_text());
         ux_flow_response_true();
     } else {
         status_transaction_cancel();
@@ -99,7 +101,7 @@ static void start_processing_transaction_callback(bool confirm) {
 static void start_processing_message_callback(bool confirm) {
     if (confirm) {
         G_was_processing_screen_shown = true;
-        nbgl_useCaseSpinner("Processing");
+        nbgl_useCaseSpinner(ui_get_processing_screen_text());
         ux_flow_response_true();
     } else {
         status_message_cancel();
@@ -232,7 +234,7 @@ void ui_accept_transaction_simplified_flow(void) {
 
     nbgl_useCaseReview(TYPE_TRANSACTION,
                        &pairList,
-                       &ICON_APP_LOGO,
+                       &ICON_APP_ACTION,
                        GA_REVIEW_TRANSACTION,
                        NULL,
                        GA_SIGN_TRANSACTION,
@@ -241,7 +243,7 @@ void ui_accept_transaction_simplified_flow(void) {
 
 void ui_display_transaction_prompt(void) {
     nbgl_useCaseReviewStreamingStart(TYPE_TRANSACTION,
-                                     &ICON_APP_LOGO,
+                                     &ICON_APP_ACTION,
                                      GA_REVIEW_TRANSACTION,
                                      NULL,
                                      start_transaction_callback);
@@ -305,7 +307,7 @@ void ui_display_pubkey_flow(void) {
 
     nbgl_useCaseReviewLight(TYPE_OPERATION,
                             &pairList,
-                            &ICON_APP_LOGO,
+                            &ICON_APP_ACTION,
                             "Confirm public key",
                             NULL,
                             "Approve public key",
@@ -324,7 +326,7 @@ void ui_display_receive_in_wallet_flow(void) {
 
     nbgl_useCaseAddressReview(g_ui_state.wallet.address,
                               &pairList,
-                              &ICON_APP_LOGO,
+                              &ICON_APP_ACTION,
                               "Verify Bitcoin\naddress",
                               NULL,
                               status_address_callback);
@@ -370,7 +372,7 @@ void ui_display_register_wallet_policy_flow(void) {
 
     nbgl_useCaseReviewLight(TYPE_OPERATION,
                             &pairList,
-                            &ICON_APP_LOGO,
+                            &ICON_APP_ACTION,
                             "Review account\nto register",
                             NULL,
                             GA_REGISTER_ACCOUNT,
@@ -393,7 +395,7 @@ void ui_display_pubkey_suspicious_flow(void) {
     pairList.pairs = pairs;
 
     contentList[0].type = CENTERED_INFO;
-    contentList[0].content.centeredInfo.icon = &ICON_APP_LOGO;
+    contentList[0].content.centeredInfo.icon = &ICON_APP_ACTION;
     contentList[0].content.centeredInfo.text1 = "Confirm public key";
     contentList[0].content.centeredInfo.text2 = NULL;
 #ifdef SCREEN_SIZE_WALLET
@@ -424,7 +426,7 @@ void ui_display_pubkey_suspicious_flow(void) {
 
     contentList[3].type = INFO_BUTTON;
     contentList[3].content.infoButton.text = "Approve public key";
-    contentList[3].content.infoButton.icon = &ICON_APP_LOGO;
+    contentList[3].content.infoButton.icon = &ICON_APP_ACTION;
 #ifdef SCREEN_SIZE_WALLET
     contentList[3].content.infoButton.buttonText = "Approve";
 #else
@@ -508,7 +510,7 @@ void ui_sign_message_content_flow(void) {
     if (show_message_start_page == true) {
         show_message_start_page = false;
         nbgl_useCaseReviewStreamingStart(TYPE_MESSAGE,
-                                         &ICON_APP_LOGO,
+                                         &ICON_APP_ACTION,
                                          GA_REVIEW_MESSAGE,
                                          NULL,
                                          message_display_content);
@@ -519,7 +521,7 @@ void ui_sign_message_content_flow(void) {
 
 void ui_sign_message_path_hash_and_confirm_flow(void) {
     nbgl_useCaseReviewStreamingStart(TYPE_MESSAGE,
-                                     &ICON_APP_LOGO,
+                                     &ICON_APP_ACTION,
                                      GA_REVIEW_MESSAGE,
                                      NULL,
                                      message_display_path);
@@ -548,7 +550,7 @@ void ui_display_spend_from_wallet_flow(void) {
 
     nbgl_useCaseReviewLight(TYPE_OPERATION,
                             &pairList,
-                            &ICON_APP_LOGO,
+                            &ICON_APP_ACTION,
                             "Spend from\nknown account",
                             NULL,
                             "Confirm account name",
@@ -559,7 +561,7 @@ void ui_display_spend_from_wallet_flow(void) {
 void ui_display_default_wallet_address_flow(void) {
     nbgl_useCaseAddressReview(g_ui_state.wallet.address,
                               NULL,
-                              &ICON_APP_LOGO,
+                              &ICON_APP_ACTION,
                               "Verify Bitcoin\naddress",
                               NULL,
                               status_address_callback);