ux_layout_pbb.c

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.
 ********************************************************************************/
 
#include "ux.h"
#include "os_utils.h"
 
#ifdef HAVE_UX_FLOW
 
#include <string.h>
 
/*********************************************************************************
 * 4 text lines
 */
 
// clang-format off
const bagl_element_t ux_layout_pbb_elements[] = {
#if (BAGL_WIDTH==128 && BAGL_HEIGHT==64)
  // erase
  {{BAGL_RECTANGLE                      , 0x00,   0,   0, 128,  64, 0, 0, BAGL_FILL, 0x000000, 0xFFFFFF, 0, 0}, .text=NULL},
 
  // left/right icons
  {{BAGL_ICON                           , 0x01,   2,  28,   4,   7, 0, 0, 0        , 0xFFFFFF, 0x000000, 0, 0  }, .text=(const char*)&C_icon_left},
  {{BAGL_ICON                           , 0x02, 122,  28,   4,   7, 0, 0, 0        , 0xFFFFFF, 0x000000, 0, 0  }, .text=(const char*)&C_icon_right},
 
  {{BAGL_ICON                           , 0x0F,   57,  10, 14,  14, 0, 0, 0        , 0xFFFFFF, 0x000000, BAGL_FONT_OPEN_SANS_REGULAR_11px|BAGL_FONT_ALIGNMENT_CENTER, 0  }, .text=NULL},
  {{BAGL_LABELINE                       , 0x10,   6,  37, 116,  32, 0, 0, 0        , 0xFFFFFF, 0x000000, BAGL_FONT_OPEN_SANS_EXTRABOLD_11px|BAGL_FONT_ALIGNMENT_CENTER, 0  }, .text=NULL},
  {{BAGL_LABELINE                       , 0x11,   6,  51, 116,  32, 0, 0, 0        , 0xFFFFFF, 0x000000, BAGL_FONT_OPEN_SANS_EXTRABOLD_11px|BAGL_FONT_ALIGNMENT_CENTER, 0  }, .text=NULL},
#elif (BAGL_WIDTH==128 && BAGL_HEIGHT==32)
  // erase
  {{BAGL_RECTANGLE                      , 0x00,   0,   0, 128,  32, 0, 0, BAGL_FILL, 0x000000, 0xFFFFFF, 0, 0}, .text=NULL},
 
  // left/right icons
  {{BAGL_ICON                           , 0x01,   2,  12,   4,   7, 0, 0, 0        , 0xFFFFFF, 0x000000, 0, 0  }, .text=(const char*)&C_icon_left},
  {{BAGL_ICON                           , 0x02, 122,  12,   4,   7, 0, 0, 0        , 0xFFFFFF, 0x000000, 0, 0  }, .text=(const char*)&C_icon_right},
 
  {{BAGL_ICON                           , 0x0F,  16,   8,  16,  16, 0, 0, 0        , 0xFFFFFF, 0x000000, 0, 0  }, .text=NULL},
  {{BAGL_LABELINE                       , 0x10,  41,  12, 128,  32, 0, 0, 0        , 0xFFFFFF, 0x000000, BAGL_FONT_OPEN_SANS_EXTRABOLD_11px, 0  }, .text=NULL},
  {{BAGL_LABELINE                       , 0x11,  41,  26, 128,  32, 0, 0, 0        , 0xFFFFFF, 0x000000, BAGL_FONT_OPEN_SANS_EXTRABOLD_11px, 0  }, .text=NULL},
#else
  #error "BAGL_WIDTH/BAGL_HEIGHT not defined"
#endif
};
// clang-format on
 
const bagl_element_t *ux_layout_pbb_prepro(const bagl_element_t *element)
{
    // don't display if null
    const void *params = ux_stack_get_current_step_params();
 
    // copy element before any mod
    memmove(&G_ux.tmp_element, element, sizeof(bagl_element_t));
 
    // for dashboard, setup the current application's name
    switch (element->component.userid) {
        case 0x01:
            if (ux_flow_is_first()) {
                return NULL;
            }
            break;
 
        case 0x02:
            if (ux_flow_is_last()) {
                return NULL;
            }
            break;
 
        case 0x0F:
#if defined(HAVE_INDEXED_STRINGS)
            G_ux.tmp_element.text
                = (const char *) (((const ux_loc_layout_icon_params_t *) params)->icon);
#else   // defined(HAVE_INDEXED_STRINGS)
            G_ux.tmp_element.text
                = (const char *) (((const ux_layout_icon_strings_params_t *) params)->icon);
#endif  // defined(HAVE_INDEXED_STRINGS)
            break;
 
        case 0x10:
        case 0x11: {
#if defined(HAVE_INDEXED_STRINGS)
            UX_LOC_STRINGS_INDEX index = ((const ux_loc_layout_icon_params_t *) params)->index
                                         + (G_ux.tmp_element.component.userid & 0xF);
            G_ux.tmp_element.text = get_ux_loc_string(index);
#else   // defined(HAVE_INDEXED_STRINGS)
            G_ux.tmp_element.text = ((const ux_layout_icon_strings_params_t *) params)
                                        ->lines[G_ux.tmp_element.component.userid & 0xF];
#endif  // defined(HAVE_INDEXED_STRINGS)
            break;
        }
    }
    return &G_ux.tmp_element;
}
 
void ux_layout_pbb_init_common(unsigned int stack_slot)
{
    ux_stack_init(stack_slot);
    G_ux.stack[stack_slot].element_arrays[0].element_array       = ux_layout_pbb_elements;
    G_ux.stack[stack_slot].element_arrays[0].element_array_count = ARRAYLEN(ux_layout_pbb_elements);
    G_ux.stack[stack_slot].element_arrays_count                  = 1;
    G_ux.stack[stack_slot].button_push_callback                  = ux_flow_button_callback;
}
 
void ux_layout_pbb_init(unsigned int stack_slot)
{
    ux_layout_pbb_init_common(stack_slot);
    G_ux.stack[stack_slot].screen_before_element_display_callback = ux_layout_pbb_prepro;
    ux_stack_display(stack_slot);
}
 
#endif  // HAVE_UX_FLOW