emu_run.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include <unicorn/unicorn.h>
 
#include "board_view.h"
#include "emu_elf.h"
#include "emu_memmap.h"
#include "emu_presentation.h"
#include "ra8_attributes.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum : uint32_t {
  k_run_chunk_insns = 500000U, 
  k_low_power_div   = 4U,      
  k_run_max_chunks = 40000U,   
  k_idle_spin_insns = 2U,      
  k_op_branch_self  = 0xE7FEU, 
  k_op_wfi          = 0xBF30U, 
  k_op_cpsie_i      = 0xB662U, 
  k_op_bn_mask      = 0xF800U, 
  k_op_bn_base      = 0xE000U, 
  k_op_bn_imm       = 0x07FFU, 
  k_bn_imm_sext_shl = 21U,     
  k_bn_imm_sext_shr = 20U,     
  k_idle_scan_fwd   = 8U,      
  k_idle_loop_max   = 32U,     
  k_run_wall_s      = 120U,    
  k_run_inner_max   = 4096U,   
  k_env_strtol_base = 10U,     
} emu_budget_t;

typedef enum : int {
  k_emu_exit_ok      = 0, 
  k_emu_exit_fault   = 1, 
  k_emu_exit_bkpt    = 2, 
  k_emu_exit_timeout = 3, 
} emu_exit_t;

typedef enum : uint32_t {
  /* Thumb / conditional-select instruction decode. */
  k_thumb_op5_shift = 11U,   
  k_thumb_op5_mask  = 0x1FU, 
  k_thumb32_op5_min = 0x1DU, 
  k_cs_op_shift     = 12U,   
  k_cs_op_mask      = 0x3U,  
  /* Assorted. */
  k_max_panel_px    = k_emu_presentation_max_panel_px, 
  k_record_dir_mode = 0755U,                           
  k_dump_sym_max    = 8U,                              
  k_sectors_per_mib = 2048U,                           
} emu_misc_t;

typedef enum : uint64_t {
  k_bytes_per_sector = 512ULL,        
  k_size_kib         = 1024ULL,       
  k_sd_u32_max       = 0xFFFFFFFFULL, 
  k_fat32_min_mib    = 512ULL,        
} emu_size_t;

typedef struct {
  uc_engine*                    uc;              
  emu_elf_source_t*             elf;             
  uint32_t                      initial_pc;      
  uint32_t                      vtor_base;       
  bool                          want_trace;      
  bool                          want_view;       
  bool                          want_click;      
  int                           click_x;         
  int                           click_y;         
  const char*                   ppm_path;        
  const char*                   record_dir;      
  uint32_t                      record_secs;     
  uint32_t                      rotate_deg;      
  int                           reboot_count;    
  const char*                   save_sd_path;    
  uint32_t                      stop_sym_addr;   
  uint32_t                      stop_sym_thresh; 
  const char* const*            dump_sym_names;  
  const uint32_t*               dump_sym_addrs;  
  uint32_t                      dump_sym_n;      
  uint16_t                      view_w;          
  uint16_t                      view_h;          
  const char*                   win_title;       
  emu_presentation_workspace_t* presentation;    
  emu_memmap_workspace_t*       memory;          
} emu_run_cfg_t;

typedef struct {
  uint32_t    click_settle_chunks; 
  uint32_t    max_chunks;          
  double      wall_s;              
  bool        wall_guard_on;       
  uint32_t    idle_stop_chunks;    
  uint32_t    usb_stop_settle;     
  uint32_t    usbh_stop_settle;    
  const char* stop_on;             
  uint32_t    prof_idle_insns;     
  uint32_t    prof_idle_need;      
  uint32_t    prof_idle_arm;       
} run_guards_t;

run_guards_t run_read_guards(const emu_run_cfg_t* cfg, const board_view_t* view);

int emu_run_and_report(const emu_run_cfg_t* cfg);
 
#ifdef __cplusplus
}
#endif