ra8_devcfg_store_extra_mram.c

Go to the documentation of this file.

 
#include <stddef.h>
#include <stdint.h>
#include <string.h>
 
#include "ra8_attributes.h"
#include "ra8_check.h"
#include "ra8_devcfg.h"
#include "ra8_err.h"
 
#ifndef RA8_OFF_TARGET
#include "ra8_flash_core.h"
#include "ra8_flash_regs.h"
#endif

static const char* const s_tag = "DEVCFG_XM";

typedef enum : uint32_t {
  k_ra8_devcfg_xm_span = 
  (uint32_t)k_ra8_devcfg_copy1_off + (uint32_t)k_ra8_devcfg_slot_bytes,
} ra8_devcfg_xm_span_t;
 
#ifdef RA8_OFF_TARGET

typedef enum : uint8_t {
  k_ra8_devcfg_xm_blank = 0xFFU, 
} ra8_devcfg_xm_shadow_t;

static uint8_t s_shadow[k_ra8_devcfg_xm_span] = {};

static bool s_shadow_ready = false;

RA8_INTERNAL
static uint8_t* internal_devcfg_xm_shadow(void)
{
  if (!s_shadow_ready) {
    (void)memset(s_shadow, (int)k_ra8_devcfg_xm_blank, sizeof s_shadow);
    s_shadow_ready = true;
  }
  return s_shadow;
}
 
#endif /* RA8_OFF_TARGET */

RA8_INTERNAL
[[nodiscard]] static ra8_err_t internal_devcfg_xm_read(uint32_t offset, uint8_t* dst, uint32_t len)
{
  RA8_CHECK_NULL_PTR(dst, s_tag, "xm read: dst null");
  if ((offset + len) > (uint32_t)k_ra8_devcfg_xm_span) {
    return k_ra8_err_out_of_range;
  }
#ifdef RA8_OFF_TARGET
  (void)memcpy(dst, &internal_devcfg_xm_shadow()[offset], (size_t)len);
#else
  /* HUM Ch 59.1 "Address Map" p 3543 -- the extra-MRAM window is directly
   * memory-mapped for CPU reads; a virgin word returns 0xFFFFFFFF with valid
   * ECC and no BusFault (#315). */
  const volatile uint8_t* src =
    (const volatile uint8_t*)(uintptr_t)((uint32_t)k_ra8_flash_extra_start + offset);
  for (uint32_t i = 0U; i < len; i++) {
    dst[i] = src[i];
  }
#endif
  return k_ra8_ok;
}

RA8_INTERNAL
[[nodiscard]] static ra8_err_t
internal_devcfg_xm_write(uint32_t offset, const uint8_t* src, uint32_t len)
{
  RA8_CHECK_NULL_PTR(src, s_tag, "xm write: src null");
  if ((offset + len) > (uint32_t)k_ra8_devcfg_xm_span) {
    return k_ra8_err_out_of_range;
  }
#ifdef RA8_OFF_TARGET
  (void)memcpy(&internal_devcfg_xm_shadow()[offset], src, (size_t)len);
  return k_ra8_ok;
#else
  /* Bounded by len/page_bytes (<= record_len/page_bytes = 4) chunks; each
   * chunk stays inside one 32-byte program page. */
  uint32_t done = 0U;
  while (done < len) {
    uint32_t chunk = len - done;
    if (chunk > (uint32_t)k_ra8_devcfg_page_bytes) {
      chunk = (uint32_t)k_ra8_devcfg_page_bytes;
    }
    const uint32_t  addr = (uint32_t)k_ra8_flash_extra_start + offset + done;
    const ra8_err_t err  = ra8_flash_extra_mram_write(addr, &src[done], chunk);
    RA8_RETURN_ON_ERROR(err, s_tag, "xm write: page program failed");
    done += chunk;
  }
  return k_ra8_ok;
#endif
}

static const ra8_devcfg_store_t s_default_store = {
  .read  = internal_devcfg_xm_read,
  .write = internal_devcfg_xm_write,
};
 
const ra8_devcfg_store_t* ra8_devcfg_default_store(void)
{
  return &s_default_store;
}