ra8_sram.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_sram_regs.h"
 
/* =============================================================================
 * Configuration types
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_sram_ecc_disabled = 0U, 
  k_ra8_sram_ecc_no_check = 1U, 
  k_ra8_sram_ecc_with_chk = 2U, 
} ra8_sram_ecc_mode_t;

typedef enum : uint8_t {
  k_ra8_sram_on_error_interrupt = 0U, 
  k_ra8_sram_on_error_reset     = 1U, 
} ra8_sram_on_error_t;

typedef enum : uint8_t {
  k_ra8_sram_region_off   = 0U, 
  k_ra8_sram_region_128kb = 1U, 
  k_ra8_sram_region_256kb = 2U, 
  k_ra8_sram_region_384kb = 3U, 
  k_ra8_sram_region_512kb = 4U, 
} ra8_sram_eccrgn_size_t;

typedef struct {
  ra8_sram_ecc_mode_t    ecc_mode;          
  ra8_sram_on_error_t    on_error;          
  bool                   enable_1bit_latch; 
  ra8_sram_eccrgn_size_t eccrgn;            
  bool                   zero_init;         
} ra8_sram_bank_cfg_t;

typedef struct {
  bool     bank_ns[k_ra8_sram_bank_count];         
  bool     wtsc_ns;                                
  bool     ecc_region_ns;                          
  uint32_t boundary_offset[k_ra8_sram_bank_count]; 
} ra8_sram_security_cfg_t;

typedef struct {
  ra8_sram_bank_cfg_t     banks[k_ra8_sram_bank_count]; 
  ra8_sram_security_cfg_t security;                     
  bool                    apply_security;               
} ra8_sram_config_t;
 
/* =============================================================================
 * Status / event types
 * =============================================================================
 */

typedef struct {
  uint16_t  raw_esr;                          
  uint8_t   one_bit_mask;                     
  uint8_t   two_bit_mask;                     
  uintptr_t addr_1bit[k_ra8_sram_bank_count]; 
  uintptr_t addr_2bit[k_ra8_sram_bank_count]; 
} ra8_sram_status_t;

typedef struct {
  uint8_t   bank;      
  uintptr_t data_base; 
  uint32_t  data_size; 
  uintptr_t ecc_base;  
  uint32_t  ecc_size;  
} ra8_sram_bank_info_t;

typedef void (*ra8_sram_error_fn_t)(void* ctx, uint8_t bank, bool is_2bit, uintptr_t err_addr);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sram_init(const ra8_sram_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_sram_deinit(void);

[[nodiscard]] ra8_err_t ra8_sram_enter_stop(uint8_t bank);

[[nodiscard]] ra8_err_t ra8_sram_exit_stop(uint8_t bank);
 
/* =============================================================================
 * ECC mode set / status / clear
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sram_set_mode(uint8_t bank, const ra8_sram_bank_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_sram_set_eccrgn(uint8_t bank, ra8_sram_eccrgn_size_t region);

[[nodiscard]] ra8_err_t ra8_sram_set_wait_state_for_clock(uint32_t iclk_hz, uint32_t iclk_max_hz);

[[nodiscard]] ra8_err_t ra8_sram_get_status(ra8_sram_status_t* out);

[[nodiscard]] ra8_err_t ra8_sram_clear_status(uint16_t esr_mask);

[[nodiscard]] ra8_err_t ra8_sram_clear_address(uint8_t bank, uint8_t slot);
 
/* =============================================================================
 * Zero-init / self-test / introspection
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sram_zero_init_bank(uint8_t bank);

[[nodiscard]] ra8_err_t
ra8_sram_self_test(uint8_t bank, uint32_t probe_offset, bool inject_two_bit, bool* out_caught);

[[nodiscard]] ra8_err_t ra8_sram_get_bank_info(uint8_t bank, ra8_sram_bank_info_t* out);
 
/* =============================================================================
 * TrustZone security attribution
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sram_set_security(uint32_t sa_mask);

[[nodiscard]] ra8_err_t ra8_sram_set_ecc_security(bool non_secure);

[[nodiscard]] ra8_err_t ra8_sram_set_boundary(uint8_t bank, uint32_t offset);
 
/* =============================================================================
 * Interrupt / fault path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sram_attach_handler(ra8_sram_error_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t
ra8_sram_attach_bank_handler(uint8_t bank, ra8_sram_error_fn_t fn, void* ctx);

void ra8_sram_dispatch(uint8_t bank, bool is_2bit, uintptr_t err_addr);

uint16_t ra8_sram_dispatch_from_esr(ra8_sram_status_t* out_status);
 
#ifdef __cplusplus
}
#endif