Add NBGL use cases (settings and choice) and NVM management

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0] - 2023-10-06
+
+### Changed
+
+- Improving the settings use case in order to be able to use app settings parameters stored in NVM
+- add a NBGL use case choice when a setting switch is toggled
+
+
 ## [2.0.0] - 2023-07-10
 
 ### Added

Makefile

@@ -29,7 +29,7 @@ APPNAME = "Boilerplate"
 
 # Application version
 APPVERSION_M = 2
-APPVERSION_N = 0
+APPVERSION_N = 1
 APPVERSION_P = 0
 APPVERSION = "$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)"
 

src/app_main.c

@@ -30,6 +30,8 @@
 
 global_ctx_t G_context;
 
+const internal_storage_t N_storage_real;
+
 /**
  * Handle APDU command received and send back APDU response using handlers.
  */
@@ -46,6 +48,15 @@ void app_main() {
  // Reset context
  explicit_bzero(&G_context, sizeof(G_context));
 
+ // Initialize the NVM data if required
+ if (N_storage.initialized != 0x01) {
+ internal_storage_t storage;
+ storage.dummy1_allowed = 0x00;
+ storage.dummy2_allowed = 0x00;
+ storage.initialized = 0x01;
+ nvm_write((void *) &N_storage, &storage, sizeof(internal_storage_t));
+ }
+
  for (;;) {
  // Receive command bytes in G_io_apdu_buffer
  if ((input_len = io_recv_command()) < 0) {

src/globals.h

@@ -27,3 +27,15 @@ extern bolos_ux_params_t G_ux_params;
  * Global context for user requests.
  */
 extern global_ctx_t G_context;
+
+/**
+ * Global structure for NVM data storage.
+ */
+typedef struct internal_storage_t {
+ uint8_t dummy1_allowed;
+ uint8_t dummy2_allowed;
+ uint8_t initialized;
+} internal_storage_t;
+
+extern const internal_storage_t N_storage_real;
+#define N_storage (*(volatile internal_storage_t *) PIC(&N_storage_real))

src/ui/menu.h

@@ -5,6 +5,11 @@
  */
 void ui_menu_main(void);
 
+/**
+ * Show settings menu (App version, developer name and settings).
+ */
+void ui_menu_settings(void);
+
 /**
  * Show about submenu (copyright, date).
  */

src/ui/menu_nbgl.c

@@ -25,46 +25,136 @@
 #include "../globals.h"
 #include "menu.h"
 
+// -----------------------------------------------------------
+// ----------------------- HOME PAGE -------------------------
+// -----------------------------------------------------------
+
 void app_quit(void) {
  // exit app here
  os_sched_exit(-1);
 }
 
+// home page definition
 void ui_menu_main(void) {
-#define SETTINGS_BUTTON_DISABLED (false)
+// This parameter shall be set to false if the settings page contains only information
+// about the application (version , developer name, ...). It shall be set to
+// true if the settings page also contains user configurable parameters related to the
+// operation of the application.
+#define SETTINGS_BUTTON_ENABLED (true)
+
  nbgl_useCaseHome(APPNAME,
  &C_app_boilerplate_64px,
  NULL,
- SETTINGS_BUTTON_DISABLED,
- ui_menu_about,
+ SETTINGS_BUTTON_ENABLED,
+ ui_menu_settings,
  app_quit);
 }
 
-// 'About' menu
+// -----------------------------------------------------------
+// --------------------- SETTINGS MENU -----------------------
+// -----------------------------------------------------------
 
 static const char* const INFO_TYPES[] = {"Version", "Developer"};
 static const char* const INFO_CONTENTS[] = {APPVERSION, "Ledger"};
 
+// settings switches definitions
+enum { DUMMY_SWITCH_1_TOKEN = FIRST_USER_TOKEN, DUMMY_SWITCH_2_TOKEN };
+enum { DUMMY_SWITCH_1_ID = 0, DUMMY_SWITCH_2_ID, SETTINGS_SWITCHES_NB };
+
+static nbgl_layoutSwitch_t switches[SETTINGS_SWITCHES_NB] = {0};
+
 static bool nav_callback(uint8_t page, nbgl_pageContent_t* content) {
  UNUSED(page);
- content->type = INFOS_LIST;
- content->infosList.nbInfos = 2;
- content->infosList.infoTypes = (const char**) INFO_TYPES;
- content->infosList.infoContents = (const char**) INFO_CONTENTS;
+
+ // the first settings page contains only the version and the developer name
+ // of the app (shall be always on the first setting page)
+ if (page == 0) {
+ content->type = INFOS_LIST;
+ content->infosList.nbInfos = 2;
+ content->infosList.infoTypes = INFO_TYPES;
+ content->infosList.infoContents = INFO_CONTENTS;
+ }
+ // the second settings page contains 2 toggle setting switches
+ else if (page == 1) {
+ switches[DUMMY_SWITCH_1_ID].initState = (nbgl_state_t) N_storage.dummy1_allowed;
+ switches[DUMMY_SWITCH_1_ID].text = "Dummy 1";
+ switches[DUMMY_SWITCH_1_ID].subText = "Allow dummy 1\nin transactions";
+ switches[DUMMY_SWITCH_1_ID].token = DUMMY_SWITCH_1_TOKEN;
+ switches[DUMMY_SWITCH_1_ID].tuneId = TUNE_TAP_CASUAL;
+
+ switches[DUMMY_SWITCH_2_ID].initState = (nbgl_state_t) N_storage.dummy2_allowed;
+ switches[DUMMY_SWITCH_2_ID].text = "Dummy 2";
+ switches[DUMMY_SWITCH_2_ID].subText = "Allow dummy 2\nin transactions";
+ switches[DUMMY_SWITCH_2_ID].token = DUMMY_SWITCH_2_TOKEN;
+ switches[DUMMY_SWITCH_2_ID].tuneId = TUNE_TAP_CASUAL;
+
+ content->type = SWITCHES_LIST;
+ content->switchesList.nbSwitches = SETTINGS_SWITCHES_NB;
+ content->switchesList.switches = (nbgl_layoutSwitch_t*) switches;
+ } else {
+ return false;
+ }
+ // valid page so return true
  return true;
 }
 
-void ui_menu_about() {
-#define TOTAL_PAGE_NB (1)
-#define INIT_PAGE_INDEX (0)
+// callback for setting warning choice
+static void review_warning_choice(bool confirm) {
+ uint8_t switch_value;
+ if (confirm) {
+ // toggle the switch value
+ switch_value = !N_storage.dummy2_allowed;
+ // store the new setting value in NVM
+ nvm_write((void*) &N_storage.dummy2_allowed, &switch_value, 1);
+ }
+
+ // return to the settings menu
+ ui_menu_settings();
+}
+
+static void controls_callback(int token, uint8_t index) {
+ UNUSED(index);
+ uint8_t switch_value;
+ if (token == DUMMY_SWITCH_1_TOKEN) {
+ // Dummy 1 switch touched
+ // toggle the switch value
+ switch_value = !N_storage.dummy1_allowed;
+ // store the new setting value in NVM
+ nvm_write((void*) &N_storage.dummy1_allowed, &switch_value, 1);
+ } else if (token == DUMMY_SWITCH_2_TOKEN) {
+ // Dummy 2 switch touched
+
+ // in this example we display a warning when the user wants
+ // to activate the dummy 2 setting
+ if (!N_storage.dummy2_allowed) {
+ // Display the warning message and ask the user to confirm
+ nbgl_useCaseChoice(&C_warning64px,
+ "Dummy 2",
+ "Are you sure to\nallow dummy 2\nin transactions?",
+ "I understand, confirm",
+ "Cancel",
+ review_warning_choice);
+ } else {
+ // toggle the switch value
+ switch_value = !N_storage.dummy2_allowed;
+ // store the new setting value in NVM
+ nvm_write((void*) &N_storage.dummy2_allowed, &switch_value, 1);
+ }
+ }
+}
+
+// settings menu definition
+void ui_menu_settings() {
+#define TOTAL_SETTINGS_PAGE (2)
+#define INIT_SETTINGS_PAGE (0)
 #define DISABLE_SUB_SETTINGS (false)
  nbgl_useCaseSettings(APPNAME,
- INIT_PAGE_INDEX,
- TOTAL_PAGE_NB,
+ INIT_SETTINGS_PAGE,
+ TOTAL_SETTINGS_PAGE,
  DISABLE_SUB_SETTINGS,
  ui_menu_main,
  nav_callback,
- NULL);
+ controls_callback);
 }
 
 #endif

tests/test_app_mainmenu.py

@@ -1,4 +1,4 @@
-from ragger.navigator import NavInsID
+from ragger.navigator import NavInsID, NavIns
 
 from utils import ROOT_SCREENSHOT_PATH
 
@@ -14,8 +14,16 @@ def test_app_mainmenu(firmware, navigator, test_name):
  ]
  else:
  instructions = [
- NavInsID.USE_CASE_HOME_INFO,
- NavInsID.USE_CASE_SETTINGS_SINGLE_PAGE_EXIT
+ NavInsID.USE_CASE_HOME_SETTINGS,
+ NavInsID.USE_CASE_SETTINGS_NEXT,
+ NavIns(NavInsID.TOUCH, (200, 113)),
+ NavIns(NavInsID.TOUCH, (200, 261)),
+ NavInsID.USE_CASE_CHOICE_CONFIRM,
+ NavInsID.USE_CASE_SETTINGS_NEXT,
+ NavIns(NavInsID.TOUCH, (200, 261)),
+ NavIns(NavInsID.TOUCH, (200, 261)),
+ NavInsID.USE_CASE_CHOICE_REJECT,
+ NavInsID.USE_CASE_SETTINGS_MULTI_PAGE_EXIT
  ]
  navigator.navigate_and_compare(ROOT_SCREENSHOT_PATH, test_name, instructions,
  screen_change_before_first_instruction=False)

tests/test_name_version.py

@@ -12,4 +12,4 @@ def test_get_app_and_version(backend, backend_name):
  app_name, version = unpack_get_app_and_version_response(response.data)
 
  assert app_name == "Boilerplate"
- assert version == "2.0.0"
+ assert version == "2.1.0"

tests/test_version_cmd.py

@@ -3,7 +3,7 @@
 
 # Taken from the Makefile, to update every time the Makefile version is bumped
 MAJOR = 2
-MINOR = 0
+MINOR = 1
 PATCH = 0
 
 # In this test we check the behavior of the device when asked to provide the app version