Merge pull request #421 from LedgerHQ/standard_make

Migration to standard makefile, main, io and swap [step 2]

Author: iartemov-ledger

Makefile

@@ -19,11 +19,11 @@ ifeq ($(BOLOS_SDK),)
 $(error Environment variable BOLOS_SDK is not set)
 endif
 
-# Application allowed derivation curves.
-CURVE_APP_LOAD_PARAMS = secp256k1
+include $(BOLOS_SDK)/Makefile.target
 
-# Allowed SLIP21 paths
-PATH_SLIP21_APP_LOAD_PARAMS = "LEDGER-Wallet policy"
+########################################
+#        Mandatory configuration       #
+########################################
 
 # Application version
 APPVERSION_M = 2
@@ -37,12 +37,22 @@ else
 APPVERSION = "$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)-$(strip $(APPVERSION_SUFFIX))"
 endif
 
-# If set, the app will automatically approve all requests without user interaction. Useful for performance tests.
-# It is critical that no such app is ever deployed in production.
-AUTOAPPROVE_FOR_PERF_TESTS ?= 0
-ifneq ($(AUTOAPPROVE_FOR_PERF_TESTS),0)
-    DEFINES += HAVE_AUTOAPPROVE_FOR_PERF_TESTS
-endif
+# Application source files
+APP_SOURCE_PATH += src
+
+# Application icons following guidelines:
+# https://developers.ledger.com/docs/embedded-app/design-requirements/#device-icon
+ICON_NANOX = icons/nanox_app_bitcoin.gif
+ICON_NANOSP = icons/nanox_app_bitcoin.gif
+ICON_STAX = icons/stax_app_bitcoin.gif
+ICON_FLEX = icons/flex_app_bitcoin.gif
+ICON_APEX_P = icons/apex_p_app_bitcoin.png
+
+# Application allowed derivation curves.
+CURVE_APP_LOAD_PARAMS = secp256k1
+
+# Allowed SLIP21 paths
+PATH_SLIP21_APP_LOAD_PARAMS = "LEDGER-Wallet policy"
 
 # Setting to allow building variant applications
 VARIANT_PARAM = COIN
@@ -53,58 +63,32 @@ ifndef COIN
 COIN=bitcoin_testnet
 endif
 
-########################################
-#     Application custom permissions   #
-########################################
-HAVE_APPLICATION_FLAG_GLOBAL_PIN = 1
-HAVE_APPLICATION_FLAG_BOLOS_SETTINGS = 1
-HAVE_APPLICATION_FLAG_LIBRARY = 1
-
+# Coin-specific configuration
 ifeq ($(COIN),bitcoin_testnet)
-    # Application allowed derivation paths (testnet) + exception for Electrum + BIP-45 whole tree
-    PATH_APP_LOAD_PARAMS = "*/1'" "4541509'" "45'"
-
     # Bitcoin testnet, no legacy support
     DEFINES   += BIP32_PUBKEY_VERSION=0x043587CF
     DEFINES   += BIP44_COIN_TYPE=1
     DEFINES   += COIN_P2PKH_VERSION=111
     DEFINES   += COIN_P2SH_VERSION=196
     DEFINES   += COIN_NATIVE_SEGWIT_PREFIX=\"tb\"
     DEFINES   += COIN_COINID_SHORT=\"TEST\"
-
     APPNAME = "Bitcoin Test"
+    # Application allowed derivation paths (testnet) + exception for Electrum + BIP-45 whole tree
+    PATH_APP_LOAD_PARAMS = "*/1'" "4541509'" "45'"
 
 else ifeq ($(COIN),bitcoin)
-    # Application allowed derivation paths (mainnet) + exception for Electrum + BIP-45 whole tree
-    PATH_APP_LOAD_PARAMS = "*/0'" "4541509'" "45'"
-
-    # the version for performance tests automatically approves all requests
-    # there is no reason to ever compile the mainnet app with this flag
-    ifneq ($(AUTOAPPROVE_FOR_PERF_TESTS),0)
-        $(error Use testnet app for performance tests)
-    endif
-
     # Bitcoin mainnet, no legacy support
     DEFINES   += BIP32_PUBKEY_VERSION=0x0488B21E
     DEFINES   += BIP44_COIN_TYPE=0
     DEFINES   += COIN_P2PKH_VERSION=0
     DEFINES   += COIN_P2SH_VERSION=5
     DEFINES   += COIN_NATIVE_SEGWIT_PREFIX=\"bc\"
     DEFINES   += COIN_COINID_SHORT=\"BTC\"
-
     APPNAME = "Bitcoin"
+    # Application allowed derivation paths (mainnet) + exception for Electrum + BIP-45 whole tree
+    PATH_APP_LOAD_PARAMS = "*/0'" "4541509'" "45'"
 
 else ifeq ($(COIN),bitcoin_recovery)
-    # Application allowed derivation paths (all paths are permitted).
-    PATH_APP_LOAD_PARAMS = ""
-    HAVE_APPLICATION_FLAG_DERIVE_MASTER = 1
-
-    # the version for performance tests automatically approves all requests
-    # there is no reason to ever compile the mainnet app with this flag
-    ifneq ($(AUTOAPPROVE_FOR_PERF_TESTS),0)
-        $(error Use testnet app for performance tests)
-    endif
-
     # Bitcoin mainnet, no legacy support
     DEFINES   += BIP32_PUBKEY_VERSION=0x0488B21E
     DEFINES   += BIP44_COIN_TYPE=0
@@ -113,8 +97,10 @@ else ifeq ($(COIN),bitcoin_recovery)
     DEFINES   += COIN_NATIVE_SEGWIT_PREFIX=\"bc\"
     DEFINES   += COIN_COINID_SHORT=\"BTC\"
     DEFINES   += BITCOIN_RECOVERY
-
     APPNAME = "Bitcoin Recovery"
+    # Application allowed derivation paths (all paths are permitted).
+    PATH_APP_LOAD_PARAMS = ""
+    HAVE_APPLICATION_FLAG_DERIVE_MASTER = 1
 
 else
     ifeq ($(filter clean,$(MAKECMDGOALS)),)
@@ -128,40 +114,64 @@ ifneq (,$(filter-out clean,$(MAKECMDGOALS)))
   endif
 endif
 
-ENABLE_NBGL_FOR_NANO_DEVICES = 1
-
-# Application icons following guidelines:
-# https://developers.ledger.com/docs/embedded-app/design-requirements/#device-icon
-ICON_NANOX = icons/nanox_app_bitcoin.gif
-ICON_NANOSP = icons/nanox_app_bitcoin.gif
-ICON_STAX = icons/stax_app_bitcoin.gif
-ICON_FLEX = icons/flex_app_bitcoin.gif
-ICON_APEX_P = icons/apex_p_app_bitcoin.png
+########################################
+#     Application custom permissions   #
+########################################
+# See SDK `include/appflags.h` for the purpose of each permission
+HAVE_APPLICATION_FLAG_GLOBAL_PIN = 1
+HAVE_APPLICATION_FLAG_BOLOS_SETTINGS = 1
+HAVE_APPLICATION_FLAG_LIBRARY = 1
 
 ########################################
 # Application communication interfaces #
 ########################################
 ENABLE_BLUETOOTH = 1
+ENABLE_NBGL_FOR_NANO_DEVICES = 1
 
 ########################################
 #         NBGL custom features         #
 ########################################
 ENABLE_NBGL_QRCODE = 1
 
+########################################
+#       SWAP FEATURE FLAG      	       #
+# This flag enables the swap feature   #
+# in the Boilerplate application.      #
+########################################
+# Testing only SWAP flag
+# ENABLE_TESTING_SWAP = 1
+# Production enabled SWAP flag
+ENABLE_SWAP = 1
+
 ########################################
 #          Features disablers          #
 ########################################
 # Don't use standard app file to avoid conflicts for now
-DISABLE_STANDARD_APP_FILES = 1
+#DISABLE_STANDARD_APP_FILES = 1
 
 # Don't use default IO_SEPROXY_BUFFER_SIZE to use another
 # value for NANOS for an unknown reason.
-DISABLE_DEFAULT_IO_SEPROXY_BUFFER_SIZE = 1
+#DISABLE_DEFAULT_IO_SEPROXY_BUFFER_SIZE = 1
 
+########################################
+#        Application defines           #
+########################################
 DEFINES   += HAVE_BOLOS_APP_STACK_CANARY
 
-
-DEFINES   += IO_SEPROXYHAL_BUFFER_SIZE_B=300
+# If set, the app will automatically approve all requests without user interaction. Useful for performance tests.
+# It is critical that no such app is ever deployed in production.
+AUTOAPPROVE_FOR_PERF_TESTS ?= 0
+ifneq ($(AUTOAPPROVE_FOR_PERF_TESTS),0)
+    DEFINES += HAVE_AUTOAPPROVE_FOR_PERF_TESTS
+    # the version for performance tests automatically approves all requests
+    # there is no reason to ever compile the mainnet app with this flag
+    ifeq ($(COIN),bitcoin)
+        $(error Use testnet app for performance tests)
+    endif
+    ifeq ($(COIN),bitcoin_recovery)
+        $(error Use testnet app for performance tests)
+    endif
+endif
 
 # debugging helper functions and macros
 CFLAGS    += -include debug-helpers/debug.h
@@ -175,21 +185,6 @@ endif
 
 # Needed to be able to include the definition of G_cx
 INCLUDES_PATH += $(BOLOS_SDK)/lib_cxng/src
-INCLUDES_PATH += $(BOLOS_SDK)/lib_standard_app
-
-# Application source files
-APP_SOURCE_PATH += src
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/base58.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/bip32.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/buffer.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/format.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/parser.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/read.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/varint.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/write.c
-
-# Allow usage of function from lib_standard_app/crypto_helpers.c
-APP_SOURCE_FILES += ${BOLOS_SDK}/lib_standard_app/crypto_helpers.c
 
 ########################################
 #          Features enablers           #

src/boilerplate/dispatcher.c

@@ -22,10 +22,10 @@
 
 /* SDK headers */
 #include "buffer.h"
+#include "io.h"
 
 /* Local headers */
 #include "constants.h"
-#include "globals.h"
 #include "io_ext.h"
 #include "sw.h"
 
@@ -52,7 +52,7 @@ static void finalize_response(uint16_t sw) {
 }
 
 static void send_response() {
-    io_confirm_response();
+    io_send_response();
 }
 
 static void set_ui_dirty() {

src/boilerplate/io_ext.c

@@ -25,13 +25,13 @@
 #include "nbgl_touch.h"
 #include "nbgl_use_case.h"
 #include "os.h"
+#include "swap.h"
 #include "ux.h"
 #include "write.h"
 
 /* Local headers */
 #include "dispatcher.h"
 #include "display.h"
-#include "globals.h"
 #include "sw.h"
 #include "swap_globals.h"
 
@@ -80,89 +80,32 @@ void io_reset_timeouts() {
 void io_show_processing_screen() {
     if (!G_was_processing_screen_shown) {
         G_was_processing_screen_shown = true;
-        if (!G_swap_state.called_from_swap) {
+        if (!G_called_from_swap) {
             nbgl_useCaseSpinner(ui_get_processing_screen_text());
         }
     }
 }
 
-uint8_t io_event(uint8_t channel) {
-    UNUSED(channel);
-
-    switch (G_io_seproxyhal_spi_buffer[0]) {
-        case SEPROXYHAL_TAG_BUTTON_PUSH_EVENT:
-            UX_BUTTON_PUSH_EVENT(G_io_seproxyhal_spi_buffer);
-            break;
-        case SEPROXYHAL_TAG_STATUS_EVENT:
-            if (G_io_apdu_media == IO_APDU_MEDIA_USB_HID &&  //
-                !(U4BE(G_io_seproxyhal_spi_buffer, 3) &      //
-                  SEPROXYHAL_TAG_STATUS_EVENT_FLAG_USB_POWERED)) {
-                THROW(EXCEPTION_IO_RESET);
-            }
-            __attribute__((fallthrough));
-        case SEPROXYHAL_TAG_DISPLAY_PROCESSED_EVENT:
-            UX_DEFAULT_EVENT();
-            break;
-#ifdef SCREEN_SIZE_WALLET
-        case SEPROXYHAL_TAG_FINGER_EVENT:
-            UX_FINGER_EVENT(G_io_seproxyhal_spi_buffer);
-            break;
-#endif  // SCREEN_SIZE_WALLET
-        case SEPROXYHAL_TAG_TICKER_EVENT:
-            ++G_ticks;
-
-            if (G_is_timeout_active.processing &&
-                G_ticks - G_processing_timeout_start_tick >= PROCESSING_TIMEOUT_TICKS) {
-                io_clear_processing_timeout();
-
-                io_show_processing_screen();
-            }
-
-            if (G_is_timeout_active.interruption &&
-                G_ticks - G_interruption_timeout_start_tick >= INTERRUPTION_TIMEOUT_TICKS) {
-                io_clear_interruption_timeout();
-
-                // TODO: It would be better to have the dispatcher be notified somehow.
-                //       This would require some tampering with the io_exchange in
-                //       process_interruption.
-                THROW(EXCEPTION_IO_RESET);
-            }
-
-            UX_TICKER_EVENT(G_io_seproxyhal_spi_buffer, {});
-            break;
-        default:
-            UX_DEFAULT_EVENT();
-            break;
-    }
+// This function can be used to declare a callback to SEPROXYHAL_TAG_TICKER_EVENT in the application
+void app_ticker_event_callback(void) {
+    ++G_ticks;
+
+    if (G_is_timeout_active.processing &&
+        (uint16_t) (G_ticks - G_processing_timeout_start_tick) >= PROCESSING_TIMEOUT_TICKS) {
+        io_clear_processing_timeout();
 
-    if (!io_seproxyhal_spi_is_status_sent()) {
-        io_seproxyhal_general_status();
+        io_show_processing_screen();
     }
 
-    return 1;
-}
+    if (G_is_timeout_active.interruption &&
+        (uint16_t) (G_ticks - G_interruption_timeout_start_tick) >= INTERRUPTION_TIMEOUT_TICKS) {
+        io_clear_interruption_timeout();
 
-uint16_t io_exchange_al(uint8_t channel, uint16_t tx_len) {
-    switch (channel & ~(IO_FLAGS)) {
-        case CHANNEL_KEYBOARD:
-            break;
-        case CHANNEL_SPI:
-            if (tx_len) {
-                io_seproxyhal_spi_send(G_io_apdu_buffer, tx_len);
-
-                if (channel & IO_RESET_AFTER_REPLIED) {
-                    halt();
-                }
-
-                return 0;
-            } else {
-                return io_seproxyhal_spi_recv(G_io_apdu_buffer, sizeof(G_io_apdu_buffer), 0);
-            }
-        default:
-            THROW(INVALID_PARAMETER);
+        // TODO: It would be better to have the dispatcher be notified somehow.
+        //       This would require some tampering with the io_exchange in
+        //       process_interruption.
+        THROW(EXCEPTION_IO_RESET);
     }
-
-    return 0;
 }
 
 void io_add_to_response(const void *rdata, size_t rdata_len) {
@@ -188,19 +131,7 @@ void io_finalize_response(uint16_t sw) {
     }
 }
 
-void io_reset_response() {
-    G_output_len = 0;
-}
-
-void io_set_response(const void *rdata, size_t rdata_len, uint16_t sw) {
-    io_reset_response();
-    if (rdata != NULL) {
-        io_add_to_response(rdata, rdata_len);
-    }
-    io_finalize_response(sw);
-}
-
-int io_confirm_response() {
+int io_send_response() {
     int ret;
 
     ret = io_exchange(CHANNEL_APDU | IO_RETURN_AFTER_TX, G_output_len);
@@ -209,11 +140,8 @@ int io_confirm_response() {
     return ret;
 }
 
-int io_send_response(void *rdata, size_t rdata_len, uint16_t sw) {
-    io_set_response(rdata, rdata_len, sw);
-    return io_confirm_response();
-}
-
 int io_send_sw(uint16_t sw) {
-    return io_send_response(NULL, 0, sw);
+    G_output_len = 0;
+    io_finalize_response(sw);
+    return io_send_response();
 }