Add missing API or feature for Nano on NBGL (API_LEVEL_22)

.github/workflows/build_rust_sdk.yml

@@ -18,7 +18,6 @@ jobs:
               uses: actions/checkout@v4
               with:
                 path: c_sdk
-                ref: master
             - name: Clone Rust SDK
               uses: actions/checkout@v4
               with:

.github/workflows/check_clang_static_analyzer.yml

@@ -38,7 +38,7 @@ jobs:
           make scan-build -j ENABLE_SDK_WERROR=1 DEBUG=${{ matrix.debug }}
 
       - name: Upload scan result
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: scan-build

.github/workflows/unit_tests.yml

@@ -52,7 +52,7 @@ jobs:
           genhtml coverage.info -o coverage
 
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: code-coverage
           path: unit-tests/lib_*/coverage

Makefile.defines

@@ -20,7 +20,7 @@ __MAKEFILE_DEFINES__ := 1
 
 include $(BOLOS_SDK)/Makefile.target
 
-API_LEVEL := 0
+API_LEVEL := 22
 
 # APPNAME exposed to the app as a CFLAG because it might contain spaces
 CFLAGS += -DAPPNAME=\"$(APPNAME)\"
@@ -50,23 +50,23 @@ endif
 
 SYSROOT = $(shell $(GCCPATH)arm-none-eabi-gcc -print-sysroot)
 ifeq ($(SYSROOT),)
-CFLAGS   += -I/usr/include
-else
-CFLAGS   += --sysroot="$(SYSROOT)"
+    # path for Debian-based systems
+    SYSROOT = /usr/lib/arm-none-eabi
 endif
+CFLAGS   += --sysroot="$(SYSROOT)"
 
-# optimization and debug levels
+# optimization and debugging levels
 ifneq ($(DEBUG),0)
-OPTI_LVL  = -Og
-OPTI_ALVL = $(OPTI_LVL)
-DBG_LVL   = -g3
+    OPTI_LVL  = g
+    # any higher won't work with LLVM >= 14
+    # will be fixed in LLVM 20 : https://github.com/llvm/llvm-project/pull/116956
+    DBG_LVL   = 1
 else
-OPTI_LVL  = -Oz
-OPTI_ALVL = -Os # assembler does not handle -Oz, use -Os instead
-DBG_LVL   = -g0
+    OPTI_LVL  = z
+    DBG_LVL   = 0
 endif
+CFLAGS   += -O$(OPTI_LVL) -g$(DBG_LVL)
 
-CFLAGS   += $(OPTI_LVL) $(DBG_LVL)
 CFLAGS   += -fomit-frame-pointer -momit-leaf-frame-pointer
 
 CFLAGS   += -fno-common -mlittle-endian
@@ -91,9 +91,6 @@ CFLAGS   += -fropi
 CFLAGS   += -fno-jump-tables # avoid jump tables for switch to avoid problems with invalid PIC access
 CFLAGS   += -nostdlib -nodefaultlibs
 
-AFLAGS   += $(OPTI_ALVL) $(DBG_LVL) -fno-common
-
-LDFLAGS  += $(OPTI_LVL) $(DBG_LVL)
 LDFLAGS  += -fomit-frame-pointer
 LDFLAGS  += -Wall
 LDFLAGS  += -fno-common -ffunction-sections -fdata-sections -fwhole-program
@@ -103,7 +100,7 @@ LDFLAGS  += -Wl,--gc-sections -Wl,-Map,$(DBG_DIR)/app.map
 ifeq ($(TARGET_NAME),$(filter $(TARGET_NAME),TARGET_NANOS))
 CFLAGS   += --target=armv6m-none-eabi -mthumb
 CFLAGS   += -mcpu=cortex-m0plus -mthumb  -mtune=cortex-m0plus
-AFLAGS   += -mcpu=cortex-m0plus -mtune=cortex-m0plus -mthumb
+AFLAGS   += -mcpu=cortex-m0plus -mthumb
 LDFLAGS  += -mcpu=cortex-m0plus -mthumb
 LDFLAGS  += -nostartfiles --specs=nano.specs
 endif
@@ -117,7 +114,7 @@ LDFLAGS  += -mtune=cortex-m0plus -mlittle-endian  -mcpu=cortex-m0plus
 LDFLAGS  += -nostdlib -nodefaultlibs #-nostartfiles
 LDFLAGS  += -mno-movt
 LDFLAGS  += -L$(BOLOS_SDK)/arch/st33/lib/
-AFLAGS   += -mcpu=cortex-m0plus -mtune=cortex-m0plus -mthumb
+AFLAGS   += -mcpu=cortex-m0plus -mthumb
 endif
 
 ifeq ($(TARGET_NAME),$(filter $(TARGET_NAME),TARGET_STAX TARGET_FLEX TARGET_NANOS2))

Makefile.rules_generic

@@ -92,11 +92,11 @@ $(OBJ_DIR)/app/%.o: $(APP_DIR)/%.c $(BUILD_DEPENDENCIES) prepare
 
 $(OBJ_DIR)/app/%.o: $(APP_DIR)/%.s $(BUILD_DEPENDENCIES) prepare
 	@echo "[AS]   $@"
-	$(L)$(call as_cmdline,$(INCLUDES_PATH), $(DEFINES),$<,$@)
+	$(L)$(call as_cmdline,$(INCLUDES_PATH),$<,$@)
 
 $(OBJ_DIR)/app/%.o: $(APP_DIR)/%.S $(BUILD_DEPENDENCIES) prepare
 	@echo "[AS]   $@"
-	$(L)$(call as_cmdline,$(INCLUDES_PATH), $(DEFINES),$<,$@)
+	$(L)$(call as_cmdline,$(INCLUDES_PATH),$<,$@)
 
 # SDK files targets
 $(OBJ_DIR)/sdk/%.o: $(BOLOS_SDK)/%.c $(BUILD_DEPENDENCIES) prepare
@@ -105,11 +105,11 @@ $(OBJ_DIR)/sdk/%.o: $(BOLOS_SDK)/%.c $(BUILD_DEPENDENCIES) prepare
 
 $(OBJ_DIR)/sdk/%.o: $(BOLOS_SDK)/%.s $(BUILD_DEPENDENCIES) prepare
 	@echo "[AS]   $@"
-	$(L)$(call as_cmdline,$(INCLUDES_PATH), $(DEFINES),$<,$@)
+	$(L)$(call as_cmdline,$(INCLUDES_PATH),$<,$@)
 
 $(OBJ_DIR)/sdk/%.o: $(BOLOS_SDK)/%.S $(BUILD_DEPENDENCIES) prepare
 	@echo "[AS]   $@"
-	$(L)$(call as_cmdline,$(INCLUDES_PATH), $(DEFINES),$<,$@)
+	$(L)$(call as_cmdline,$(INCLUDES_PATH),$<,$@)
 
 # Generic targets
 $(OBJ_DIR)/%.o: %.c $(BUILD_DEPENDENCIES) prepare
@@ -118,11 +118,11 @@ $(OBJ_DIR)/%.o: %.c $(BUILD_DEPENDENCIES) prepare
 
 $(OBJ_DIR)/%.o: %.s $(BUILD_DEPENDENCIES) prepare
 	@echo "[AS]   $@"
-	$(L)$(call as_cmdline,$(INCLUDES_PATH), $(DEFINES),$<,$@)
+	$(L)$(call as_cmdline,$(INCLUDES_PATH),$<,$@)
 
 $(OBJ_DIR)/%.o: %.S $(BUILD_DEPENDENCIES) prepare
 	@echo "[AS]   $@"
-	$(L)$(call as_cmdline,$(INCLUDES_PATH), $(DEFINES),$<,$@)
+	$(L)$(call as_cmdline,$(INCLUDES_PATH),$<,$@)
 
 ifeq (,$(filter $(DEFINES),BOLOS_OS_UPGRADER_APP))
 ifneq ($(SCRIPT_LD),)
@@ -197,7 +197,7 @@ endif
 # dependency files are generated along the object file
 cc_cmdline = $(CC) -c $(CFLAGS) -MMD -MT $(4) -MF $(subst $(OBJ_DIR), $(DEP_DIR), $(addsuffix .d, $(basename $(4)))) $(addprefix -D,$(2)) $(addprefix -I,$(1)) -o $(4) $(3)
 
-as_cmdline = $(AS) -c $(AFLAGS) $(addprefix -D,$(2)) $(addprefix -I,$(1)) -o $(4) $(3)
+as_cmdline = $(AS) -c $(AFLAGS) $(addprefix -I,$(1)) -o $(3) $(2)
 
 ### END GCC COMPILER RULES
 

Makefile.standard_app

@@ -218,8 +218,11 @@ APP_FLAGS_APP_LOAD_PARAMS = $(shell printf '0x%x' $$(( $(STANDARD_APP_FLAGS) + $
 #                         COMPILER SETTINGS                         #
 #####################################################################
 CC      := $(CLANGPATH)clang
-AS      := $(GCCPATH)arm-none-eabi-gcc
-LD      := $(GCCPATH)arm-none-eabi-gcc
+AS      := $(CLANGPATH)clang
+LD      := $(CLANGPATH)clang
+ifeq ($(AS),$(CLANGPATH)clang)
+    AFLAGS  += --target=arm-arm-none-eabi
+endif
 LDLIBS  += -lm -lgcc -lc
 
 #####################################################################

README.md

@@ -55,34 +55,23 @@ In short, to build an app for an OS, you should:
 
 ## About API_LEVEL branches
 
-This list the API_LEVEL branches with their purposed (corresponding OS) and state if they should still be patched or not (OS not “active” anymore).
-OS release candidates are only kept in the list when a corresponding OS release production might be released on the same API_LEVEL.
-
-| Name    | Related OS                                                                                                                    | Active
-|---------|-------------------------------------------------------------------------------------------------------------------------------|-------------------
-| LNS     | <br/> nanos_2.1.0                                                                                                             | :heavy_check_mark:
-| 1       | nanox_2.1.0 <br/> nanos+_1.1.0                                                                                                | :x:
-| 2       | only rc releases                                                                                                              | :x:
-| 3       | only rc releases                                                                                                              | :x:
-| 4       | only rc releases                                                                                                              | :x:
-| 5       | nanox_2.2.{0, 1, 2, 3} <br/> nanos+ 1.1.1                                                                                     | :heavy_check_mark:
-| 6       | only rc releases                                                                                                              | :x:
-| 7 / 7.1 | only rc releases                                                                                                              | :x:
-| 7.2     | only rc releases<br/> (not compatible due <br/> to font update)                                                               | :x:
-| 8       | stax_1.0.0                                                                                                                    | :x:
-| 9       | only rc releases                                                                                                              | :x:
-| 10      | stax_1.1.0                                                                                                                    | :x:
-| 11      | stax_1.2.0 <br/> stax_1.2.1                                                                                                   | :x:
-| 12      | nanox_2.3.0-rc2 <br/> nanos+_1.2.0-rc2                                                                                        | :x:
-| 13      | stax_1.3.0                                                                                                                    | :x:
-| 14      | only rc releases                                                                                                              | :x:
-| 15      | stax_1.4.0                                                                                                                    | :heavy_check_mark:
-| 16      | europa_0.1.0-re1                                                                                                              | :x:
-| 17      | europa_0.1.0-re2                                                                                                              | :x:
-| 18      | europa_0.1.0-re3 <br/> flex_0.2.0-rc1 <br /> flex_0.2.0-rc2 <br /> nanox_2.3.0-rc5 <br/> nanos+_1.2.0-rc5  <br/> nanos+_1.2.0 | :heavy_check_mark:
-| 19      | flex_1.0.0-rc1 <br/> flex_1.0.0-rc2 <br/> flex_1.0.0 <br/> flex_1.0.1 <br/>                                                   | :x:
-| 20      | stax_1.5.0-rc1 <br/> flex_1.1.0-rc1                                                                                           | :x:
-| 21      | stax_1.5.0-rc2 <br/> flex_1.1.0-rc2 <br/> stax_1.5.0 <br/> flex_1.1.0 <br/> flex_1.1.1 <br/>                                  | :heavy_check_mark:
+This list the main API_LEVEL branches with their purposed (corresponding OS) and state if they should still be patched or not (OS not “active” anymore).
+
+The full mapping of API_LEVEL branches, including OS release candidates, is available [here](api_levels.json).
+
+| Name | Related OS                                         | Active             |
+| ---- | -------------------------------------------------- | ------------------ |
+| LNS  | <br/> nanos_2.1.0                                  | :heavy_check_mark: |
+| 1    | nanox_2.1.0 <br/> nanos+_1.1.0                     | :x:                |
+| 5    | nanox_2.2.{0, 1, 2, 3} <br/> nanos+ 1.1.1          | :heavy_check_mark: |
+| 8    | stax_1.0.0                                         | :x:                |
+| 10   | stax_1.1.0                                         | :x:                |
+| 11   | stax_1.2.0 <br/> stax_1.2.1                        | :x:                |
+| 13   | stax_1.3.0                                         | :x:                |
+| 15   | stax_1.4.0                                         | :x:                |
+| 18   | nanos+_1.2.0                                       | :heavy_check_mark: |
+| 19   | flex_1.0.0 <br/> flex_1.0.1 <br/>                  | :x:                |
+| 21   | stax_1.5.0 <br/> flex_1.1.0 <br/> flex_1.1.1 <br/> | :heavy_check_mark: |
 
 ### Cherry-picking process:
 

api_levels.json

@@ -0,0 +1,98 @@
+{
+    "LNS": [
+        "nanos_2.1.0"
+    ],
+    "1": [
+        "nanox_2.1.0",
+        "nanos+_1.1.0"
+    ],
+    "2": [
+        "only rc releases"
+    ],
+    "3": [
+        "only rc releases"
+    ],
+    "4": [
+        "only rc releases"
+    ],
+    "5": [
+        "nanox_2.2.0",
+        "nanox_2.2.1",
+        "nanox_2.2.2",
+        "nanox_2.2.3",
+        "nanos+_1.1.1"
+    ],
+    "6": [
+        "only rc releases"
+    ],
+    "7": [
+        "only rc releases"
+    ],
+    "7.1": [
+        "only rc releases"
+    ],
+    "7.2": [
+        "only rc releases"
+    ],
+    "8": [
+        "stax_1.0.0"
+    ],
+    "9": [
+        "only rc releases"
+    ],
+    "10": [
+        "stax_1.1.0"
+    ],
+    "11": [
+        "stax_1.2.0",
+        "stax_1.2.1"
+    ],
+    "12": [
+        "nanox_2.3.0-rc2",
+        "nanos+_1.2.0-rc2"
+    ],
+    "13": [
+        "stax_1.3.0"
+    ],
+    "14": [
+        "only rc releases"
+    ],
+    "15": [
+        "stax_1.4.0"
+    ],
+    "16": [
+        "europa_0.1.0-re1"
+    ],
+    "17": [
+        "europa_0.1.0-re2"
+    ],
+    "18": [
+        "europa_0.1.0-re3",
+        "flex_0.2.0-rc1",
+        "flex_0.2.0-rc2",
+        "nanox_2.3.0-rc5",
+        "nanos+_1.2.0-rc5",
+        "nanos+_1.2.0"
+    ],
+    "19": [
+        "flex_1.0.0-rc1",
+        "flex_1.0.0-rc2",
+        "flex_1.0.0",
+        "flex_1.0.1"
+    ],
+    "20": [
+        "stax_1.5.0-rc1",
+        "flex_1.1.0-rc1"
+    ],
+    "21": [
+        "stax_1.5.0-rc2",
+        "flex_1.1.0-rc2",
+        "stax_1.5.0",
+        "flex_1.1.0",
+        "flex_1.1.1",
+        "nanos+_1.3.0-rc1",
+        "nanox_2.4.0-rc1",
+        "stax_1.6.0-rc1",
+        "flex_1.2.0-rc1"
+    ]
+}

doc/Doxyfile

@@ -263,12 +263,6 @@ TAB_SIZE               = 4
 
 ALIASES                =
 
-# This tag can be used to specify a number of word-keyword mappings (TCL only).
-# A mapping has the form "name=value". For example adding "class=itcl::class"
-# will allow you to use the command class in the itcl::class meaning.
-
-TCL_SUBST              =
-
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
 # instance, some of the names that are used will be different. The list of all
@@ -1182,13 +1176,6 @@ CLANG_DATABASE_PATH    =
 
 ALPHABETICAL_INDEX     = YES
 
-# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
-# which the alphabetical index list will be split.
-# Minimum value: 1, maximum value: 20, default value: 5.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
-COLS_IN_ALPHA_INDEX    = 5
-
 # In case all classes in a project start with a common prefix, all classes will
 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
 # can be used to specify a prefix (or a list of prefixes) that should be ignored

doc/mainpage.dox

@@ -3,7 +3,7 @@
 @section mainpage_intro Introduction
 
 This documentation describes the different interfaces of Embedded SDK,
-for \b Nano X, \b Nano S+ and \b Stax applications development.
+for \b Nano X, \b Nano S+ \b Stax and \b Flex applications development.
 
 @section ble_presentation BlueTooth Low-Energy Interface
 
@@ -16,7 +16,7 @@ The @subpage cxng_mainpage page contains all information necessary to understand
 @section nbgl_presentation Screen drawing API
 
 The @subpage nbgl_mainpage page contains all information necessary to understand the Graphical Library for
-\b Stax, \b NanoX and \b NanoS+ applications development.
+\b Stax, \b Flex, \b NanoX and \b NanoS+ applications development.
 
 @section nfc_presentation NFC Interface
 
@@ -50,7 +50,7 @@ The @subpage ux_mainpage page contains all information necessary to user the Use
 @subsection ux_nbgl_presentation User eXperience on Applications using \b NBGL
 
 The @subpage ux_nbgl_mainpage page contains all information necessary to user the User eXperience for
-\b Stax, \b NanoX and \b NanoS+ applications development using \b NBGL (most recent ones).
+\b Stax, \b Flex, \b NanoX and \b NanoS+ applications development using \b NBGL (most recent ones).
 
 
 */

include/cx_stubs.h

@@ -145,3 +145,4 @@
 #define _NR_cx_cmac_start                        0x8d
 #define _NR_cx_cmac_update                       0x8e
 #define _NR_cx_cmac_finish                       0x8f
+#define _NR_cx_aes_siv_reset                     0x90

include/os_app.h

@@ -28,6 +28,9 @@ typedef void (*appmain_t)(void);
 
 // application slot description
 typedef struct application_s {
+    // special flags for this application
+    uint64_t flags;
+
     // nvram start address for this application (to check overlap when loading, and mpu lock)
     unsigned char *nvram_begin;
     // nvram stop address (exclusive) for this application (to check overlap when loading, and mpu
@@ -38,9 +41,6 @@ typedef struct application_s {
     // into Thumb code
     appmain_t main;
 
-    // special flags for this application
-    uint64_t flags;
-
     // Memory organization: [ code (RX) |alignpage| data (RW) |alignpage| install params (R) ]
 
     // length of the code section of the application (RX)