nbgl_types.h

Go to the documentation of this file.

 
#ifndef NBGL_TYPES_H
#define NBGL_TYPES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include "app_config.h"
#include "bolos_target.h"
 
/*********************
 *      DEFINES
 *********************/
#ifdef SCREEN_SIZE_WALLET
#if defined(TARGET_STAX)
#define SCREEN_WIDTH        400
#define SCREEN_HEIGHT       672
#define SMALL_ICON_SIZE     32
#define LARGE_ICON_SIZE     64
// height of the smallest used font
#define SMALL_FONT_HEIGHT   24
// radius of circle used for controls (buttons)
#define COMMON_RADIUS       40
// radius for small buttons
#define SMALL_BUTTON_RADIUS 32
// HW vertical alignment
#define VERTICAL_ALIGNMENT  4
// Number of color bits
#define NB_COLOR_BITS       4
#elif defined(TARGET_FLEX)
#define SCREEN_WIDTH        480
#define SCREEN_HEIGHT       600
#define SMALL_ICON_SIZE     40
#define LARGE_ICON_SIZE     64
// height of the smallest used font
#define SMALL_FONT_HEIGHT   28
// radius of circle used for controls (buttons)
#define COMMON_RADIUS       44
// radius for small buttons
#define SMALL_BUTTON_RADIUS 32
// HW vertical alignment
#define VERTICAL_ALIGNMENT  4
// Number of color bits
#define NB_COLOR_BITS       4
#elif defined(TARGET_APEX)
#define SCREEN_WIDTH        300
#define SCREEN_HEIGHT       400
#define SMALL_ICON_SIZE     24
#define LARGE_ICON_SIZE     48
// height of the smallest used font
#define SMALL_FONT_HEIGHT   18
// radius of corners used for controls (buttons)
#define COMMON_RADIUS       28
// radius for small buttons
#define SMALL_BUTTON_RADIUS 20
// HW vertical alignment
#define VERTICAL_ALIGNMENT  8
// Number of color bits
#define NB_COLOR_BITS       1
#endif  // TARGETS
#else   // SCREEN_SIZE_WALLET
#define SCREEN_WIDTH       128
#define SCREEN_HEIGHT      64
// height of the smallest used font
#define SMALL_FONT_HEIGHT  11
// HW vertical alignment
#define VERTICAL_ALIGNMENT 1
// Number of color bits
#define NB_COLOR_BITS      1
#endif  // SCREEN_SIZE_WALLET
 
#define NO_TRANSFORMATION 0
 
#define VERTICAL_MIRROR 0x2
 
#define ROTATE_90_CLOCKWISE 0x4
 
#define INVALID_COLOR_MAP 0x0
 
#define NBGL_LOWER_ALIGN(__y) ((__y) & ~(VERTICAL_ALIGNMENT - 1))
#define NBGL_UPPER_ALIGN(__y) (((__y) + VERTICAL_ALIGNMENT - 1) & ~(VERTICAL_ALIGNMENT - 1))
 
/**********************
 *      TYPEDEFS
 **********************/
#ifndef MIN
#define MIN(x, y) ((x) < (y) ? (x) : (y))
#endif
#ifndef MAX
#define MAX(x, y) ((x) > (y) ? (x) : (y))
#endif
 
#ifdef LINUX_SIMU
#define PACKED__
#else  // LINUX_SIMU
#define PACKED__ __attribute__((packed))
#endif  // LINUX_SIMU
#ifdef BICOLOR_MODE
 
typedef enum {
    BLACK      = 0,
    DARK_GRAY  = 0,
    LIGHT_GRAY = 0,
    WHITE      = 3
} color_t;
 
#else
 
typedef enum {
    BLACK = 0,
    DARK_GRAY,
    LIGHT_GRAY,
    WHITE,
    NB_NBGL_COLOR
} color_t;
 
#endif
 
typedef enum {
    SCREEN,          
    CONTAINER,       
    IMAGE,           
    LINE,            
    TEXT_AREA,       
    BUTTON,          
    SWITCH,          
    PAGE_INDICATOR,  
    PROGRESS_BAR,    
    RADIO_BUTTON,    
    QR_CODE,         
    KEYBOARD,        
    KEYPAD,          
    SPINNER,         
    IMAGE_FILE,      
    TEXT_ENTRY,      
    MASK_CONTROL,    
    NB_OBJ_TYPES
} nbgl_obj_type_t;
 
typedef enum {
    NO_ALIGNMENT,  
    TOP_LEFT,
    TOP_MIDDLE,
    TOP_RIGHT,
    MID_LEFT,
    CENTER,
    MID_RIGHT,
    BOTTOM_LEFT,
    BOTTOM_MIDDLE,
    BOTTOM_RIGHT,
    LEFT_TOP,      
    LEFT_BOTTOM,   
    RIGHT_TOP,     
    RIGHT_BOTTOM,  
} nbgl_aligment_t;
 
typedef enum {
    OFF_STATE,
    ON_STATE
} nbgl_state_t;
 
typedef enum {
    VERTICAL,   
    HORIZONTAL  
} nbgl_direction_t;
 
typedef enum {
    NO_STYLE,  
#ifdef SCREEN_SIZE_NANO
    INVERTED_COLORS  
#endif               // SCREEN_SIZE_NANO
} nbgl_style_t;
 
typedef enum {
    QRCODE_V4 = 0,   
    QRCODE_V10,      
    QRCODE_V4_SMALL  
} nbgl_qrcode_version_t;
 
typedef enum {
    RELEASED,  
    PRESSED,   
} nbgl_touchState_t;
 
typedef enum {
    HARDWARE_SWIPE_UP,
    HARDWARE_SWIPE_DOWN,
    HARDWARE_SWIPE_RIGHT,
    HARDWARE_SWIPE_LEFT,
    NO_HARDWARE_SWIPE,
} nbgl_hardwareSwipe_t;
 
typedef enum {
    TOUCHED,  
    LONG_TOUCHED,  
    TOUCHING,      
    OUT_OF_TOUCH,  
    TOUCH_PRESSED,   
    TOUCH_RELEASED,  
    VALUE_CHANGED,   
    SWIPED_UP,
    SWIPED_DOWN,
    SWIPED_RIGHT,
    SWIPED_LEFT,
    NB_TOUCH_TYPES
} nbgl_touchType_t;
 
typedef enum {
    NBGL_BPP_1 = 0,  
    NBGL_BPP_2,      
    NBGL_BPP_4,      
    NB_NBGL_BPP,     
} nbgl_bpp_t;
 
typedef enum {
    NBGL_NO_COMPRESSION = 0,  
    NBGL_GZLIB_COMPRESSION,   
    NBGL_RLE_COMPRESSION,     
    NB_NBGL_COMPRESSION       
} nbgl_compression_t;
 
#define GZLIB_UNCOMPRESSED_CHUNK 2049
 
typedef struct PACKED__ nbgl_area_s {
    int16_t x0;  
    int16_t y0;  
    uint16_t   width;            
    uint16_t   height;           
    color_t    backgroundColor;  
    nbgl_bpp_t bpp;              
} nbgl_area_t;
 
typedef enum {
    FULL_COLOR_REFRESH,          
    FULL_COLOR_PARTIAL_REFRESH,  
    FULL_COLOR_CLEAN_REFRESH,  
    BLACK_AND_WHITE_REFRESH,   
    BLACK_AND_WHITE_FAST_REFRESH,  
    INIT_REFRESH,                  
    NB_REFRESH_MODES
} nbgl_refresh_mode_t;
 
typedef enum nbgl_post_refresh_t {
    POST_REFRESH_FORCE_POWER_OFF,               
    POST_REFRESH_FORCE_POWER_ON,                
    POST_REFRESH_FORCE_POWER_ON_WITH_PIPELINE,  
    POST_REFRESH_KEEP_POWER_STATE,              
} nbgl_post_refresh_t;
 
typedef enum {
#ifdef SCREEN_SIZE_WALLET
    RADIUS_20_PIXELS = 0,
    RADIUS_28_PIXELS,
    RADIUS_32_PIXELS,
    RADIUS_40_PIXELS,
    RADIUS_44_PIXELS,
    RADIUS_MAX = RADIUS_44_PIXELS,
#else                        // SCREEN_SIZE_WALLET
    RADIUS_1_PIXEL = 0,  
    RADIUS_3_PIXELS,     
    RADIUS_MAX = RADIUS_3_PIXELS,
#endif                       // SCREEN_SIZE_WALLET
    RADIUS_0_PIXELS = 0xFF,  
} nbgl_radius_t;
 
typedef uint8_t nbgl_transformation_t;
 
typedef uint8_t nbgl_color_map_t;
 
typedef struct PACKED__ nbgl_icon_details_s {
    uint16_t       width;   
    uint16_t       height;  
    nbgl_bpp_t     bpp;     
    bool           isFile;  
    const uint8_t *bitmap;  
} nbgl_icon_details_t;
 
typedef enum {
    LOOP_PARSING,           
    BACK_AND_FORTH_PARSING  
} nbgl_parsingType_t;
 
typedef struct nbgl_animation_s {
    const nbgl_icon_details_t **icons;    
    uint8_t                     nbIcons;  
    nbgl_parsingType_t          parsing;  // type of parsing of icons
    uint16_t                    delayMs;  
} nbgl_animation_t;
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NBGL_TYPES_H */