board_periph_prcr.c

Go to the documentation of this file.

 
#include <stdint.h>
#include <stdio.h>
 
#include "board_periph_block.h"
#include "board_periph_prcr_internal.h"
#include "emu_host_io_internal.h"
#include "ra8_attributes.h"

typedef enum : uint64_t {
  k_prcr_base = 0x4001E3FAUL, 
  k_prcr_span = 0x2UL,        
} prcr_geom_t;

typedef enum : uint16_t {
  k_prcr_key_mask   = 0xFF00U, 
  k_prcr_key_value  = 0xA500U, 
  k_prcr_group_mask = 0x003BU, 
} prcr_mask_t;

typedef enum : uint32_t {
  k_prcr_block_order = 170U, 
} prcr_order_t;

typedef struct {
  uint16_t groups;  
  uint32_t unlocks; 
  uint32_t bad_key; 
} prcr_state_t;
 
static prcr_state_t s_prcr;

RA8_INTERNAL static void internal_prcr_reset(void)
{
  s_prcr = (prcr_state_t){};
}
 
RA8_PRIV bool priv_board_prcr_group_unlocked(uint16_t group_mask)
{
  return (uint16_t)(s_prcr.groups & group_mask) == group_mask;
}

RA8_INTERNAL static uint64_t internal_prcr_read(uc_engine* uc, uint64_t addr, unsigned size)
{
  (void)uc;
  (void)addr;
  (void)size;
  return 0U;
}

RA8_INTERNAL static void
internal_prcr_write(uc_engine* uc, uint64_t addr, unsigned size, uint64_t value)
{
  (void)uc;
  (void)addr;
  (void)size;
  const uint16_t word = (uint16_t)value;
  if ((uint16_t)(word & (uint16_t)k_prcr_key_mask) != (uint16_t)k_prcr_key_value) {
    s_prcr.bad_key++;
    return;
  }
  s_prcr.groups = (uint16_t)(word & (uint16_t)k_prcr_group_mask);
  if (s_prcr.groups != 0U) {
    s_prcr.unlocks++;
  }
}

RA8_INTERNAL static void internal_prcr_report(void)
{
  if (s_prcr.bad_key != 0U) {
    /* Loud: a PRCR write without the 0xA5 key unlocks nothing on silicon. */
    (void)priv_emu_io_errf(
      "  SYSC-PRCR     : unlocks=%u REJECTED=%u (missing 0xA5 key in PRKEY[7:0])\n",
      s_prcr.unlocks,
      s_prcr.bad_key);
    return;
  }
  if (s_prcr.unlocks == 0U) {
    return; /* Untouched: stay quiet. */
  }
  (void)priv_emu_io_errf("  SYSC-PRCR     : unlocks=%u\n", s_prcr.unlocks);
}

static const board_periph_block_t s_k_prcr_block = {
  .base    = (uint64_t)k_prcr_base,
  .span    = (uint64_t)k_prcr_span,
  .order   = (uint32_t)k_prcr_block_order,
  .read    = internal_prcr_read,
  .write   = internal_prcr_write,
  .tick    = nullptr,
  .reset   = internal_prcr_reset,
  .report  = internal_prcr_report,
  .name    = "SYSC-PRCR",
  .observe = true,
};

[[gnu::constructor]] RA8_INTERNAL static void internal_prcr_block_register(void)
{
  board_periph_register_block(&s_k_prcr_block);
}