trezor-firmware/core/embed/gfx/terminal.c

/*
 * This file is part of the Trezor project, https://trezor.io/
 *
 * Copyright (c) SatoshiLabs
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <trezor_model.h>
#include <trezor_rtl.h>

#include <gfx/gfx_draw.h>
#include <gfx/terminal.h>
#include <io/display.h>
#include <rtl/mini_printf.h>

#include "fonts/font_bitmap.h"

#ifndef TERMINAL_FONT_SCALE
#define TERMINAL_FONT_SCALE 1
#endif

#ifndef TERMINAL_X_PADDING
#define TERMINAL_X_PADDING 0
#endif

#ifndef TERMINAL_Y_PADDING
#define TERMINAL_Y_PADDING 0
#endif

#define TERMINAL_GLYPH_WIDTH (6 * TERMINAL_FONT_SCALE)
#define TERMINAL_GLYPH_HEIGHT (8 * TERMINAL_FONT_SCALE)

#define TERMINAL_COLS \
  ((DISPLAY_RESX - 2 * TERMINAL_X_PADDING) / TERMINAL_GLYPH_WIDTH)
#define TERMINAL_ROWS \
  ((DISPLAY_RESY - 2 * TERMINAL_Y_PADDING) / TERMINAL_GLYPH_HEIGHT)

static char terminal_fb[TERMINAL_ROWS][TERMINAL_COLS];
static gfx_color_t terminal_fgcolor = COLOR_WHITE;
static gfx_color_t terminal_bgcolor = COLOR_BLACK;

// set colors for display_print function
void term_set_color(gfx_color_t fgcolor, gfx_color_t bgcolor) {
  terminal_fgcolor = fgcolor;
  terminal_bgcolor = bgcolor;
}

typedef struct {
#if (TERMINAL_FONT_SCALE == 1)
  // 6x8 bitmap
  uint8_t bytes[TERMINAL_GLYPH_HEIGHT];
#elif (TERMINAL_FONT_SCALE == 2)
  // 12x16 bitmap
  uint16_t words[TERMINAL_GLYPH_HEIGHT];
#endif
} term_glyph_bits_t;

// Font_Bitmap contains 96 (0x20 - 0x7F) 5x7 glyphs
// Each glyph consists of 5 bytes (each byte represents one column)
//
// This function converts the glyph into the format compatible
// with `display_copy_mono1p()` functions.

#if (TERMINAL_FONT_SCALE == 1)
static term_glyph_bits_t term_glyph_bits(char ch) {
  term_glyph_bits_t result = {0};

  if (ch > 32 && (uint8_t)ch < 128) {
    const uint8_t *b = &Font_Bitmap[(ch - ' ') * 5];

    for (int y = 0; y < 7; y++) {
      uint8_t mask = 1 << y;
      result.bytes[y] |= ((b[0] & mask) ? 128 : 0) + ((b[1] & mask) ? 64 : 0) +
                         ((b[2] & mask) ? 32 : 0) + ((b[3] & mask) ? 16 : 0) +
                         ((b[4] & mask) ? 8 : 0);
    }
  }
  return result;
}
#endif

#if (TERMINAL_FONT_SCALE == 2)
static term_glyph_bits_t term_glyph_bits(char ch) {
  term_glyph_bits_t result = {0};

  if (ch > 32 && (uint8_t)ch < 128) {
    const uint8_t *b = &Font_Bitmap[(ch - ' ') * 5];

    for (int y = 0; y < 7; y++) {
      uint8_t mask = 1 << y;

      result.words[2 * y] |= ((b[0] & mask) ? 0b11000000 << 0 : 0) +
                             ((b[1] & mask) ? 0b00110000 << 0 : 0) +
                             ((b[2] & mask) ? 0b00001100 << 0 : 0) +
                             ((b[3] & mask) ? 0b00000011 << 0 : 0) +
                             ((b[4] & mask) ? 0b11000000 << 8 : 0);
    }

    // Duplicate rows
    for (int y = 0; y < 7; y++) {
      result.words[2 * y + 1] = result.words[2 * y];
    }
  }
  return result;
}
#endif

// Redraws specified rows to the display
static void term_redraw_rows(int start_row, int row_count) {
  term_glyph_bits_t glyph_bits = {0};
  gfx_bitblt_t bb = {
      .height = TERMINAL_GLYPH_HEIGHT,
      .width = TERMINAL_GLYPH_WIDTH,
      .dst_row = NULL,
      .dst_x = 0,
      .dst_y = 0,
      .dst_stride = 0,

      .src_row = &glyph_bits,
      .src_x = 0,
      .src_y = 0,
      .src_stride = ((TERMINAL_GLYPH_WIDTH - 1) | 0x07) + 1,
      .src_fg = terminal_fgcolor,
      .src_bg = terminal_bgcolor,
      .src_alpha = 255,
  };

  for (int y = start_row; y < start_row + row_count; y++) {
    bb.dst_y = y * TERMINAL_GLYPH_HEIGHT + TERMINAL_Y_PADDING;
    for (int x = 0; x < TERMINAL_COLS; x++) {
      glyph_bits = term_glyph_bits(terminal_fb[y][x]);
      bb.dst_x = x * TERMINAL_GLYPH_WIDTH + TERMINAL_X_PADDING;
      display_copy_mono1p(&bb);
    }
  }
}

// display text using bitmap font
void term_print(const char *text, int textlen) {
  static uint8_t row = 0, col = 0;

  // determine text length if not provided
  if (textlen < 0) {
    textlen = strlen(text);
  }

  // print characters to internal buffer (terminal_fb)
  for (int i = 0; i < textlen; i++) {
    switch (text[i]) {
      case '\r':
        break;
      case '\n':
        row++;
        col = 0;
        break;
      default:
        terminal_fb[row][col] = text[i];
        col++;
        break;
    }

    if (col >= TERMINAL_COLS) {
      col = 0;
      row++;
    }

    if (row >= TERMINAL_ROWS) {
      for (int j = 0; j < TERMINAL_ROWS - 1; j++) {
        memcpy(terminal_fb[j], terminal_fb[j + 1], TERMINAL_COLS);
      }
      memset(terminal_fb[TERMINAL_ROWS - 1], 0, TERMINAL_COLS);
      row = TERMINAL_ROWS - 1;
    }
  }

  term_redraw_rows(0, TERMINAL_ROWS);

  gfx_rect_t r;

  // redraw residual area of the display top side
  r = gfx_rect_wh(0, 0, DISPLAY_RESX, TERMINAL_Y_PADDING);
  gfx_draw_bar(r, terminal_bgcolor);

  // redraw residual area of the display bottom side
  r.y0 += TERMINAL_ROWS * TERMINAL_GLYPH_HEIGHT;
  r.y1 = DISPLAY_RESY;
  gfx_draw_bar(r, terminal_bgcolor);

  // redraw residual area of the display left side
  r = gfx_rect_wh(0, 0, TERMINAL_X_PADDING, DISPLAY_RESY);
  gfx_draw_bar(r, terminal_bgcolor);

  // redraw residual area of the display right side
  r.x0 += TERMINAL_COLS * TERMINAL_GLYPH_WIDTH;
  r.x1 = DISPLAY_RESX;
  gfx_draw_bar(r, terminal_bgcolor);

  display_refresh();
}

// variadic term_print
void term_printf(const char *fmt, ...) {
  if (!strchr(fmt, '%')) {
    term_print(fmt, strlen(fmt));
  } else {
    va_list va;
    va_start(va, fmt);
    char buf[256] = {0};
    int len = mini_vsnprintf(buf, sizeof(buf), fmt, va);
    term_print(buf, len);
    va_end(va);
  }
}