board_overlay.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_attributes.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum : uint32_t {
  k_overlay_led_count = 3U, 
} board_overlay_dims_t;

typedef enum : uint32_t {
  k_overlay_console_rows     = 18U,  
  k_overlay_line_cap         = 128U, 
  k_overlay_console_tabs_max = 16U,  
} board_overlay_console_t;

typedef enum : uint16_t {
  k_board_overlay_sidebar_width_px = 520U, 
  k_board_overlay_min_height_px    = 600U, 
} board_overlay_geometry_t;

typedef enum : uint32_t {
  k_board_overlay_btn_none     = 0U, 
  k_board_overlay_btn_sw1      = 1U, 
  k_board_overlay_btn_sw2      = 2U, 
  k_board_overlay_btn_console  = 3U, 
  k_board_overlay_btn_battery  = 4U, 
  k_board_overlay_btn_batt_chg = 5U, 
  k_board_overlay_btn_lowpower = 6U, 
} board_overlay_btn_t;

typedef struct {
  bool        on;    
  uint16_t    color; 
  const char* label; 
} board_led_status_t;

typedef struct {
  board_led_status_t leds[k_overlay_led_count]; 
  const char*        usb_state;                 
  const char*        uart_line;                 
  uint32_t           irq_total;                 
  uint32_t           irq0;                      
  uint32_t           irq1;                      
  bool               has_touch;                 
  uint16_t           touch_x;                   
  uint16_t           touch_y;                   
  bool               sw1_pressed;               
  bool               sw2_pressed;               
  uint8_t            battery_soc;               
  bool               battery_charging;          
  bool               low_power;                 
  bool               core_is_m33;               
  const char*        app_name;                  
  bool               sd_attached;               
  uint64_t           sd_bytes;                  
  uint8_t            sd_fat_bits;               
  const char*        sd_label;                  
  /* Console window: console[0] is the newest *visible* line (the firmware ring
   * is deeper -- see console_total -- and console_scroll says how far back this
   * window starts). Unused rows are empty strings. */
  char     console[k_overlay_console_rows][k_overlay_line_cap];
  uint32_t console_count;      
  uint32_t console_scroll;     
  uint32_t console_total;      
  bool     console_autoscroll; 
  /* Tabbed-console bar: one tab per board_console channel. console_active_ch is
   * the channel the console body shows; the names + per-tab line counts caption
   * the bar. Borrowed name pointers valid for the compose call only. */
  uint32_t console_ch_count;
  uint32_t console_active_ch;
  const char* console_ch_name[k_overlay_console_tabs_max];
  uint32_t console_ch_count_lines[k_overlay_console_tabs_max];
  uint32_t pc;            
  uint32_t chunks;        
  uint32_t mmio_reads;    
  uint32_t mmio_writes;   
  uint32_t uart_tx_total; 
  bool     running;       
} board_status_t;

typedef bool (*board_overlay_fill_fn)(void*    context,
                                      uint16_t x,
                                      uint16_t y,
                                      uint16_t width,
                                      uint16_t height,
                                      uint16_t color);

typedef struct {
  void*                 context; 
  board_overlay_fill_fn fill;    
  uint16_t              width;   
  uint16_t              height;  
  bool                  ok;      
} board_overlay_surface_t;

bool board_overlay_draw_sidebar(board_overlay_surface_t* surface,
                                uint16_t                 panel_w,
                                const board_status_t*    st);

uint16_t board_overlay_sidebar_width(void);

uint16_t board_overlay_total_width(uint16_t panel_w);

uint16_t board_overlay_total_height(uint16_t panel_h);

void board_overlay_compose(uint16_t*             out,
                           const uint16_t*       panel,
                           uint16_t              panel_w,
                           uint16_t              panel_h,
                           const board_status_t* st);

board_overlay_btn_t board_overlay_hit_button(uint16_t x, uint16_t y, uint16_t panel_w);

bool board_overlay_battery_pct_at(uint16_t x, uint16_t panel_w, uint8_t* out_pct);

bool board_overlay_hit_console_tab(uint16_t  x,
                                   uint16_t  y,
                                   uint16_t  panel_w,
                                   uint32_t  tab_count,
                                   uint32_t* out_idx);
 
#ifdef __cplusplus
}
#endif