Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Api level 15 support #454

Merged
merged 3 commits into from
Feb 20, 2024
Merged

Api level 15 support #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
878d934
API_LEVEL_15 support for STAX
PhilippeBonnaz Feb 16, 2024
0edec4b
Adapt font structure for API LEVEL 15 (different from 14)
nroggeman-ledger Feb 19, 2024
1359763
Apply formatting
PhilippeBonnaz Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added speculos/cxlib/stax-api-level-cx-15.elf
View file
Open in desktop
Binary file not shown.
Binary file added speculos/fonts/stax-fonts-15.bin
View file
Open in desktop
Binary file not shown.
65 changes: 55 additions & 10 deletions src/bolos/fonts_info.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@
#include "fonts.h"
#include "sdk.h"

#define MAX_BITMAP_CHAR (MAX_NB_FONTS * 128)
#define MAX_BITMAP_CHAR (MAX_NB_FONTS * 128)
#define MAX_BITMAP_CHAR_12 (MAX_NB_FONTS_12 * 128)

typedef struct {
const uint8_t *bitmap;
uint32_t character;
} BITMAP_CHAR;

BITMAP_CHAR bitmap_char[MAX_BITMAP_CHAR];
BITMAP_CHAR bitmap_char[MAX_BITMAP_CHAR_12];
uint32_t nb_bitmap_char;

// Return the real addr depending on where the app was loaded
Expand All @@ -31,9 +32,16 @@ static void *remap_addr(void *code, uint32_t addr, uint32_t text_load_addr)
// Store bitmap/character pair
static void add_bitmap_character(uint8_t *bitmap, uint32_t character)
{
if (nb_bitmap_char >= MAX_BITMAP_CHAR) {
fprintf(stdout, "ERROR: we reached MAX_BITMAP_CHAR!\n");
return;
if (sdk_version > SDK_API_LEVEL_14) {
if (nb_bitmap_char >= MAX_BITMAP_CHAR) {
fprintf(stdout, "ERROR: we reached MAX_BITMAP_CHAR!\n");
return;
}
} else {
if (nb_bitmap_char >= MAX_BITMAP_CHAR_12) {
fprintf(stdout, "ERROR: we reached MAX_BITMAP_CHAR_12!\n");
return;
}
}
// Space character is empty and have no bitmap -> erase it with next character
if (nb_bitmap_char && bitmap_char[nb_bitmap_char - 1].bitmap == bitmap) {
Expand Down Expand Up @@ -81,6 +89,25 @@ static void parse_nbgl_font(nbgl_font_t *nbgl_font)
uint8_t *bitmap = nbgl_font->bitmap;
nbgl_font_character_t *characters = nbgl_font->characters;

for (uint32_t c = nbgl_font->first_char; c <= nbgl_font->last_char;
c++, characters++) {
// Be sure data is coherent
if (characters->bitmap_offset >= nbgl_font->bitmap_len) {
fprintf(stdout, "bitmap_offset (%u) is >= bitmap_len (%u)!\n",
characters->bitmap_offset, nbgl_font->bitmap_len);
return;
}
uint8_t *ptr = bitmap + characters->bitmap_offset;
add_bitmap_character(ptr, c);
}
}

// Parse provided NBGL font and add bitmap/character pairs
static void parse_nbgl_font_14(nbgl_font_t_14 *nbgl_font)
{
uint8_t *bitmap = nbgl_font->bitmap;
nbgl_font_character_t_14 *characters = nbgl_font->characters;

for (uint32_t c = nbgl_font->first_char; c <= nbgl_font->last_char;
c++, characters++) {
// Be sure data is coherent
Expand Down Expand Up @@ -203,6 +230,7 @@ void parse_fonts(void *code, unsigned long text_load_addr,
case SDK_API_LEVEL_12:
case SDK_API_LEVEL_13:
case SDK_API_LEVEL_14:
case SDK_API_LEVEL_15:
break;
default:
// Unsupported API_LEVEL, will not parse fonts!
Expand All @@ -211,7 +239,11 @@ void parse_fonts(void *code, unsigned long text_load_addr,
// On Stax, fonts are loaded at a known location
if (hw_model == MODEL_STAX) {
fonts = (void *)STAX_FONTS_ARRAY_ADDR;
nb_fonts = STAX_NB_FONTS;
if (sdk_version > SDK_API_LEVEL_14) {
nb_fonts = STAX_NB_FONTS;
} else {
nb_fonts = STAX_NB_FONTS_12;
}
} else {
fonts = remap_addr(code, fonts_addr, text_load_addr);
nb_fonts = fonts_size / 4;
Expand All @@ -228,10 +260,20 @@ void parse_fonts(void *code, unsigned long text_load_addr,
nb_fonts, fonts[nb_fonts]);
return;
}
if (nb_fonts > MAX_NB_FONTS) {
fprintf(stdout, "ERROR: nb_fonts (%u) is bigger than MAX_NB_FONTS (%d)!\n",
nb_fonts, MAX_NB_FONTS);
return;
if (sdk_version > SDK_API_LEVEL_14) {
if (nb_fonts > MAX_NB_FONTS) {
fprintf(stdout,
"ERROR: nb_fonts (%u) is bigger than MAX_NB_FONTS (%d)!\n",
nb_fonts, MAX_NB_FONTS);
return;
}
} else {
if (nb_fonts > MAX_NB_FONTS_12) {
fprintf(stdout,
"ERROR: nb_fonts (%u) is bigger than MAX_NB_FONTS_12 (%d)!\n",
nb_fonts, MAX_NB_FONTS_12);
return;
}
}

// Parse all those fonts and add bitmap/character pairs
Expand All @@ -242,6 +284,9 @@ void parse_fonts(void *code, unsigned long text_load_addr,
case SDK_API_LEVEL_13:
parse_nbgl_font_12((void *)fonts[i]);
break;
case SDK_API_LEVEL_14:
parse_nbgl_font_14((void *)fonts[i]);
break;
default:
parse_nbgl_font((void *)fonts[i]);
break;
Expand Down
42 changes: 36 additions & 6 deletions src/fonts.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@
// ============================================================================

#define STAX_FONTS_ARRAY_ADDR 0x00805000
#define STAX_NB_FONTS 7
// Latest (starting from SDK_API_LEVEL_15)
#define STAX_NB_FONTS 6
// SDK_API_LEVEL_12 to SDK_API_LEVEL_14
#define STAX_NB_FONTS_12 7

#define MAX_NB_FONTS STAX_NB_FONTS
#define MAX_NB_FONTS STAX_NB_FONTS
#define MAX_NB_FONTS_12 STAX_NB_FONTS_12

// ============================================================================
// BAGL font related structures
Expand Down Expand Up @@ -81,7 +85,33 @@ typedef struct {
// (They are defined in the SDK, in lib_nbgl/include/nbgl_fonts.h
// ============================================================================

// Current API_LEVEL (14)
// Current API_LEVEL (15)
typedef struct {
uint32_t bitmap_offset;
uint32_t encoding : 1;
uint32_t width : 6;
uint32_t x_min_offset : 4;
uint32_t y_min_offset : 6;
uint32_t x_max_offset : 4;
uint32_t y_max_offset : 6;
} nbgl_font_character_t;

typedef struct {
uint32_t bitmap_len;
uint8_t font_id;
uint8_t bpp;
uint8_t height;
uint8_t line_height;
uint8_t char_kerning;
uint8_t crop;
uint8_t y_min;
uint8_t first_char;
uint8_t last_char;
nbgl_font_character_t *characters;
uint8_t *bitmap;
} nbgl_font_t;

// SDK_API_LEVEL_14
typedef struct {
uint32_t encoding : 1;
uint32_t bitmap_offset : 14;
Expand All @@ -90,7 +120,7 @@ typedef struct {
uint32_t y_min_offset : 3;
uint32_t x_max_offset : 2;
uint32_t y_max_offset : 3;
} nbgl_font_character_t;
} nbgl_font_character_t_14;

typedef struct {
uint32_t bitmap_len;
Expand All @@ -103,9 +133,9 @@ typedef struct {
uint8_t y_min;
uint8_t first_char;
uint8_t last_char;
nbgl_font_character_t *characters;
nbgl_font_character_t_14 *characters;
uint8_t *bitmap;
} nbgl_font_t;
} nbgl_font_t_14;

// SDK_API_LEVEL_12 and SDK_API_LEVEL_13
typedef struct {
Expand Down
2 changes: 1 addition & 1 deletion src/launcher.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,7 +791,7 @@ int main(int argc, char *argv[])
sdk_version != SDK_API_LEVEL_8 && sdk_version != SDK_API_LEVEL_9 &&
sdk_version != SDK_API_LEVEL_10 && sdk_version != SDK_API_LEVEL_11 &&
sdk_version != SDK_API_LEVEL_12 && sdk_version != SDK_API_LEVEL_13 &&
sdk_version != SDK_API_LEVEL_14) {
sdk_version != SDK_API_LEVEL_14 && sdk_version != SDK_API_LEVEL_15) {
errx(1, "invalid SDK version for the Ledger Stax");
}
break;
Expand Down
1 change: 1 addition & 0 deletions src/sdk.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ typedef enum {
SDK_API_LEVEL_12,
SDK_API_LEVEL_13,
SDK_API_LEVEL_14,
SDK_API_LEVEL_15,
SDK_COUNT
} sdk_version_t;

Expand Down
Loading