ux.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 "seproxyhal_protocol.h"
#include "ux.h"
#include "nbgl_touch.h"
#include "nbgl_buttons.h"
#include "os_io.h"
#ifndef HAVE_BOLOS
// number of 100ms ticks since the start-up of the app
static uint32_t nbTicks;
 
static bool ux_forward_event(bool ignoring_app_if_ux_busy)
{
    G_ux_params.ux_id = BOLOS_UX_EVENT;
    G_ux_params.len   = 0;
    os_ux(&G_ux_params);
    G_ux_params.len = os_sched_last_status(TASK_BOLOS_UX);
    if (G_ux_params.len == BOLOS_UX_REDRAW) {
        // enable drawing according to UX decision
        nbgl_objAllowDrawing(true);
        nbgl_screenRedraw();
        nbgl_refresh();
    }
    else if (!ignoring_app_if_ux_busy
             || ((G_ux_params.len != BOLOS_UX_IGNORE) && (G_ux_params.len != BOLOS_UX_CONTINUE))) {
        return true;
    }
    return false;
}
 
#ifdef HAVE_SE_TOUCH
static nbgl_touchStatePosition_t pos;
 
void ux_process_finger_event(uint8_t seph_packet[])
{
    bool displayEnabled = ux_forward_event(true);
    // enable/disable drawing according to UX decision
    nbgl_objAllowDrawing(displayEnabled);
 
    // if the event is not fully consumed by UX, use it for NBGL
    if (displayEnabled) {
        pos.state = (seph_packet[3] == SEPROXYHAL_TAG_FINGER_EVENT_TOUCH) ? PRESSED : RELEASED;
        pos.x     = (seph_packet[4] << 8) + seph_packet[5];
        pos.y     = (seph_packet[6] << 8) + seph_packet[7];
#ifdef HAVE_HW_TOUCH_SWIPE
        pos.swipe = seph_packet[10];
#endif  // HAVE_HW_TOUCH_SWIPE
        nbgl_touchHandler(false, &pos, nbTicks * 100);
        nbgl_refresh();
    }
}
#else   // HAVE_SE_TOUCH
void ux_process_button_event(uint8_t seph_packet[])
{
    bool displayEnabled = ux_forward_event(true);
    // enable/disable drawing according to UX decision
    nbgl_objAllowDrawing(displayEnabled);
 
    // if the event is not fully consumed by UX, use it for NBGL
    if (displayEnabled) {
        uint8_t buttons_state = seph_packet[3] >> 1;
        nbgl_buttonsHandler(buttons_state, nbTicks * 100);
        nbgl_refresh();
    }
}
#endif  // HAVE_SE_TOUCH
 
void ux_process_ticker_event(void)
{
    nbTicks++;
    // forward to UX
    bool displayEnabled = ux_forward_event(true);
 
    // enable/disable drawing according to UX decision
    nbgl_objAllowDrawing(displayEnabled);
 
    // do not do any action on screens if display is disabled, because
    // UX has the hand
    if (!displayEnabled) {
        return;
    }
 
    // update ticker in NBGL
    nbgl_screenHandler(100);
 
#ifdef HAVE_SE_TOUCH
    // handle touch only if detected as pressed in last touch message
    if (pos.state == PRESSED) {
        io_touch_info_t touch_info;
        touch_get_last_info(&touch_info);
        pos.state = (touch_info.state == SEPROXYHAL_TAG_FINGER_EVENT_TOUCH) ? PRESSED : RELEASED;
        pos.x     = touch_info.x;
        pos.y     = touch_info.y;
        // Send current touch position to nbgl
        nbgl_touchHandler(false, &pos, nbTicks * 100);
    }
#endif  // HAVE_SE_TOUCH
    nbgl_refresh();
}
 
void ux_process_default_event(void)
{
    // forward to UX
    ux_forward_event(false);
}
 
#endif  // HAVE_BOLOS