ra8_cnecc.h

Go to the documentation of this file.

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

typedef struct {
  bool correct_1bit; 
  bool irq_1bit;     
  bool irq_2bit;     
  bool enable;       
} ra8_cnecc_instance_cfg_t;

typedef struct {
  ra8_cnecc_instance_cfg_t instances[k_ra8_cnecc_instance_count]; 
} ra8_cnecc_config_t;
 
/* =============================================================================
 * Status / event types
 * =============================================================================
 */

typedef struct {
  uint32_t raw_ctl;         
  uint16_t raw_tmc;         
  uint16_t reserved0;       
  uint32_t one_bit_count;   
  uint32_t two_bit_count;   
  uint32_t overflow_count;  
  uint16_t last_addr;       
  bool     err_present;     
  bool     err_1bit;        
  bool     err_2bit;        
  bool     overflow;        
  bool     addr_is_1bit;    
  bool     addr_is_2bit;    
  bool     judgment_active; 
  bool     correct_enabled; 
  bool     irq1_enabled;    
  bool     irq2_enabled;    
  bool     test_mode;       
  bool     reserved1;       
} ra8_cnecc_status_t;

typedef struct {
  uint32_t one_bit_count;  
  uint32_t two_bit_count;  
  uint32_t overflow_count; 
} ra8_cnecc_counters_t;

typedef void (*ra8_cnecc_error_fn_t)(void* ctx, uint8_t instance, bool is_2bit, uint16_t err_addr);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_cnecc_init(const ra8_cnecc_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_cnecc_deinit(void);

[[nodiscard]] ra8_err_t ra8_cnecc_enable_instance(uint8_t instance);

[[nodiscard]] ra8_err_t ra8_cnecc_disable_instance(uint8_t instance);

[[nodiscard]] ra8_err_t ra8_cnecc_enter_standby(void);

[[nodiscard]] ra8_err_t ra8_cnecc_exit_standby(void);
 
/* =============================================================================
 * Per-instance configuration tweaks
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_cnecc_set_irq_enables(uint8_t instance, bool irq_1bit, bool irq_2bit);

[[nodiscard]] ra8_err_t ra8_cnecc_set_correction_permission(uint8_t instance, bool correct_1bit);
 
/* =============================================================================
 * Status / event API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_cnecc_get_status(uint8_t instance, ra8_cnecc_status_t* out);

[[nodiscard]] ra8_err_t ra8_cnecc_get_counters(uint8_t instance, ra8_cnecc_counters_t* out);

[[nodiscard]] ra8_err_t ra8_cnecc_reset_counters(uint8_t instance);

[[nodiscard]] ra8_err_t ra8_cnecc_set_counter_mirror(uint8_t               instance,
                                                     ra8_cnecc_counters_t* mirror);

[[nodiscard]] ra8_err_t ra8_cnecc_clear_status(uint8_t instance);
 
/* =============================================================================
 * Fault injection (HUM 42.3.2 ECC Decoder Testing)
 * =============================================================================
 */

typedef struct {
  uint32_t substitute;   
  bool     one_bit_flip; 
} ra8_cnecc_inject_t;

[[nodiscard]] ra8_err_t ra8_cnecc_inject_fault(uint8_t instance, const ra8_cnecc_inject_t* req);

[[nodiscard]] ra8_err_t ra8_cnecc_test_mode_disable(uint8_t instance);

[[nodiscard]] ra8_err_t ra8_cnecc_test_mode_active(uint8_t instance, bool* out);
 
/* =============================================================================
 * Async fault notification
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_cnecc_attach_handler(ra8_cnecc_error_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t ra8_cnecc_attach_isr(uint8_t priority);

[[nodiscard]] ra8_err_t ra8_cnecc_detach_isr(void);

void ra8_cnecc_isr_handler(void* ctx);

void ra8_cnecc_dispatch(uint8_t instance, bool is_2bit, uint16_t err_addr);

void ra8_cnecc_dispatch_overflow(uint8_t instance);
 
/* =============================================================================
 * Code-flash ECC compute / verify (software fallback)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_cnecc_open(void);

[[nodiscard]] ra8_err_t ra8_cnecc_compute(uint32_t addr, uint32_t len, uint32_t* out_ecc);

[[nodiscard]] ra8_err_t ra8_cnecc_verify(uint32_t addr, uint32_t len, uint32_t expected_ecc);
 
#ifdef __cplusplus
}
#endif