ux_layouts.h

Go to the documentation of this file.

 
/*******************************************************************************
 *   Ledger Nano S - Secure firmware
 *   (c) 2022 Ledger
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 ********************************************************************************/
 
#pragma once
 
#include "bolos_target.h"
 
#include "bagl.h"
 
#ifdef HAVE_UX_FLOW
 
#if (BAGL_WIDTH == 128 && BAGL_HEIGHT == 64)
/*********************************************************************************
 * 1 bold text line
 * 3 text lines
 */
 
typedef struct ux_layout_bnnn_params_s {
    const char *line1;
    const char *line2;
    const char *line3;
    const char *line4;
} ux_layout_bnnn_params_t;
 
/*********************************************************************************
 * 4 text lines
 */
 
typedef struct ux_layout_nnnn_params_s {
    const char *line1;
    const char *line2;
    const char *line3;
    const char *line4;
} ux_layout_nnnn_params_t;
 
/*********************************************************************************
 * 3 normal text lines
 */
 
typedef struct ux_layout_nnn_params_s {
    const char *line1;
    const char *line2;
    const char *line3;
} ux_layout_nnn_params_t;
 
/*********************************************************************************
 * 1 bold text lines
 * 2 normal text lines
 */
 
typedef struct ux_layout_bnn_params_s {
    const char *line1;
    const char *line2;
    const char *line3;
} ux_layout_bnn_params_t;
 
void ux_layout_bnnn_init(unsigned int stack_slot);
void ux_layout_nnnn_init(unsigned int stack_slot);
void ux_layout_nnn_init(unsigned int stack_slot);
void ux_layout_bnn_init(unsigned int stack_slot);
 
#endif  //(BAGL_WIDTH==128 && BAGL_HEIGHT==64)
 
/*********************************************************************************
 * 1 bold text line with the title
 * 1-3 text lines [nano s/nano x]
 */
#if (BAGL_WIDTH == 128 && BAGL_HEIGHT == 64)
#define UX_LAYOUT_PAGING_LINE_COUNT 3
#elif (BAGL_WIDTH == 128 && BAGL_HEIGHT == 32)
#define UX_LAYOUT_PAGING_LINE_COUNT 1
#else
#error "BAGL_WIDTH/BAGL_HEIGHT not defined"
#endif
 
#include "ux_layout_paging_compute.h"
 
typedef struct ux_layout_paging_params_s {
    const char *title;
    const char *text;
} ux_layout_paging_params_t;
 
void ux_layout_paging_init(unsigned int stack_slot);
 
// For paging layouts, the first n/b deals with the first line (the title),
// and the second n/b deals with the rest of the lines.
void ux_layout_nn_paging_init(unsigned int stack_slot);
void ux_layout_nb_paging_init(unsigned int stack_slot);
void ux_layout_bn_paging_init(unsigned int stack_slot);
void ux_layout_bb_paging_init(unsigned int stack_slot);
 
// The layout params are always the same independently of the boldness of the lines.
#define ux_layout_nn_paging_params_t ux_layout_paging_params_t
#define ux_layout_nb_paging_params_t ux_layout_paging_params_t
#define ux_layout_bn_paging_params_t ux_layout_paging_params_t
#define ux_layout_bb_paging_params_t ux_layout_paging_params_t
 
// Call to reset the paging component to the first page
void ux_layout_paging_reset(void);
 
// deprecation
#define ux_layout_bnnn_paging_params_t ux_layout_paging_params_t
#define ux_layout_bnnn_paging_init     ux_layout_bn_paging_init
#define ux_layout_bnnn_paging_reset    ux_layout_paging_reset
#define ux_layout_bn_paging_reset      ux_layout_paging_reset
 
/*********************************************************************************
 * 2 text lines
 * 1 bold text lines
 * 2 text lines
 */
 
typedef struct ux_layout_nnbnn_params_s {
    const char *line1;
    const char *line2;
    const char *line3;
    const char *line4;
    const char *line5;
} ux_layout_nnbnn_params_t;
 
/*********************************************************************************
 * ICON
 * 1 bold text line
 */
 
typedef struct ux_layout_pb_params_s {
    const bagl_icon_details_t *icon;
    const char                *line1;
} ux_layout_pb_params_t;
 
/*********************************************************************************
 * 2 bold text line
 */
 
typedef struct ux_layout_bb_params_s {
    const char *line1;
    const char *line2;
} ux_layout_bb_params_t;
 
/*********************************************************************************
 * 1 text line
 * 1 bold text line
 */
 
typedef struct ux_layout_bn_params_s {
    const char *line1;
    const char *line2;
} ux_layout_bn_params_t;
 
/*********************************************************************************
 * ICON
 * 2 bold text lines
 */
 
typedef struct ux_layout_pbb_params_s {
    const bagl_icon_details_t *icon;
    const char                *line1;
    const char                *line2;
} ux_layout_pbb_params_t;
 
void ux_layout_nnbnn_init(unsigned int stack_slot);
void ux_layout_pb_init(unsigned int stack_slot);
void ux_layout_bb_init(unsigned int stack_slot);
void ux_layout_bn_init(unsigned int stack_slot);
void ux_layout_pbb_init(unsigned int stack_slot);
/*********************************************************************************
 * ICON
 * 2 normal text lines
 */
 
typedef struct ux_layout_pnn_params_s {
    const bagl_icon_details_t *icon;
    const char                *line1;
    const char                *line2;
} ux_layout_pnn_params_t;
 
/*********************************************************************************
 * ICON
 * 1 bold text lines
 * 1 normal text lines
 */
 
typedef struct ux_layout_pbn_params_s {
    const bagl_icon_details_t *icon;
    const char                *line1;
    const char                *line2;
} ux_layout_pbn_params_t;
 
/*********************************************************************************
 * ICON
 * 1 normal text lines
 */
 
typedef struct ux_layout_pn_params_s {
    const bagl_icon_details_t *icon;
    const char                *line1;
} ux_layout_pn_params_t;
 
/*********************************************************************************
 * 2 normal text lines
 */
 
typedef struct ux_layout_nn_params_s {
    const char *line1;
    const char *line2;
} ux_layout_nn_params_t;
 
void ux_layout_nnbnn_init(unsigned int stack_slot);
void ux_layout_pb_init(unsigned int stack_slot);
void ux_layout_bb_init(unsigned int stack_slot);
void ux_layout_bn_init(unsigned int stack_slot);
void ux_layout_pbb_init(unsigned int stack_slot);
void ux_layout_pnn_init(unsigned int stack_slot);
void ux_layout_pbn_init(unsigned int stack_slot);
void ux_layout_pn_init(unsigned int stack_slot);
void ux_layout_nn_init(unsigned int stack_slot);
 
/*********************************************************************************
 * Browsable component
 */
 
// activate an item by index, do nothing when item_idx is invalid
typedef void (*list_item_select_t)(unsigned int item_idx);
 
// return NULL when item_idx is invalid
typedef const char *(*list_item_value_t)(unsigned int item_idx);
 
void ux_menulist_init(unsigned int       stack_slot,
                      list_item_value_t  getter,
                      list_item_select_t selector);
void ux_menulist_init_select(unsigned int       stack_slot,
                             list_item_value_t  getter,
                             list_item_select_t selector,
                             unsigned int       selected_item_idx);
 
#define UX_STEP_MENULIST(stepname, getter, selector)    \
    void stepname##_init(unsigned int stack_slot)       \
    {                                                   \
        ux_menulist_init(stack_slot, getter, selector); \
    }                                                   \
    const ux_flow_step_t stepname = {                   \
        stepname##_init,                                \
        &G_ux.menulist_params,                          \
        NULL,                                           \
        NULL,                                           \
    }
 
#define UX_STEP_MENULIST_INIT(stepname, initfunc) \
    const ux_flow_step_t stepname = {             \
        initfunc,                                 \
        &G_ux.menulist_params,                    \
        NULL,                                     \
        NULL,                                     \
    }
 
/*********************************************************************************
 * Utilities
 */
 
void ux_layout_set_timeout(unsigned int stack_slot, unsigned int ms);
 
#endif  // HAVE_UX_FLOW