emu_memmap.h

Go to the documentation of this file.

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

typedef struct {
  const char* name; 
  uint64_t    base; 
  uint64_t    size; 
} mem_region_t;

typedef enum : uint32_t {
  k_dtcm_base = 0x20000000U,
  k_dtcm_end = 0x20010000U,
  k_sram_base = 0x22000000U,
  k_sram_end = 0x22100000U,
  k_sdram_base = 0x68000000U,
  k_sdram_end = 0x6C000000U,
  k_ns_sdram_base = 0x78000000U,
  k_page_size = 0x1000U,
} ram_region_t;

typedef enum : size_t {
  k_emu_memmap_backing_count = 3U, 
  k_emu_memmap_binding_count = 2U, 
} emu_memmap_limit_t;

typedef enum : uint8_t {
  k_emu_memmap_ok = 0U, 
  k_emu_memmap_invalid, 
  k_emu_memmap_backing, 
  k_emu_memmap_unicorn, 
} emu_memmap_status_t;

typedef struct {
  emu_memmap_status_t status;                
  uint64_t            logical_backing_bytes; 
  int                 os_error;              
} emu_memmap_result_t;

typedef struct {
  uint8_t* host; 
  uint64_t size; 
} emu_memmap_backing_t;

typedef struct {
  uc_engine* uc;     
  bool       active; 
} emu_memmap_binding_t;

typedef struct emu_memmap_workspace {
  emu_memmap_backing_t backings[k_emu_memmap_backing_count];
  emu_memmap_binding_t bindings[k_emu_memmap_binding_count];
  bool open;
} emu_memmap_workspace_t;

[[nodiscard]] emu_memmap_result_t emu_memmap_requirements(void);

[[nodiscard]] emu_memmap_result_t emu_memmap_open(emu_memmap_workspace_t* workspace);

[[nodiscard]] emu_memmap_result_t emu_memmap_attach(emu_memmap_workspace_t* workspace,
                                                    uc_engine*              uc);

bool emu_memmap_detach(emu_memmap_workspace_t* workspace, uc_engine* uc);

bool emu_memmap_close(emu_memmap_workspace_t* workspace);

const mem_region_t* emu_memmap_regions(uint32_t* count);

uint64_t emu_memmap_mram_base(void);
 
#ifdef __cplusplus
}
#endif