ra8_reset.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_reset_regs.h"
 
/* =============================================================================
 * Reset cause enumeration
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_reset_cause_unknown            = 0U,  
  k_ra8_reset_cause_power_on           = 1U,  
  k_ra8_reset_cause_lvd0               = 2U,  
  k_ra8_reset_cause_lvd1               = 3U,  
  k_ra8_reset_cause_lvd2               = 4U,  
  k_ra8_reset_cause_lvd4               = 5U,  
  k_ra8_reset_cause_lvd5               = 6U,  
  k_ra8_reset_cause_deep_sw_standby    = 7U,  
  k_ra8_reset_cause_core_voltage       = 8U,  
  k_ra8_reset_cause_overcurrent        = 9U,  
  k_ra8_reset_cause_temperature        = 10U, 
  k_ra8_reset_cause_iwdt               = 11U, 
  k_ra8_reset_cause_wdt0               = 12U, 
  k_ra8_reset_cause_software           = 13U, 
  k_ra8_reset_cause_lockup0            = 14U, 
  k_ra8_reset_cause_local_memory0      = 15U, 
  k_ra8_reset_cause_bus_peripheral_mpu = 16U, 
  k_ra8_reset_cause_common_memory      = 17U, 
  k_ra8_reset_cause_wdt1               = 18U, 
  k_ra8_reset_cause_lockup1            = 19U, 
  k_ra8_reset_cause_local_memory1      = 20U, 
  k_ra8_reset_cause_network            = 21U, 
  k_ra8_reset_cause_warm_start         = 22U, 
} ra8_reset_cause_t;

typedef struct {
  uint8_t  rstsr0; 
  uint32_t rstsr1; 
  uint8_t  rstsr2; 
  uint8_t  rstsr3; 
} ra8_reset_raw_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_reset_init(void);

void ra8_reset_test_only_reset_state(void);
 
/* =============================================================================
 * Cause introspection
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_reset_get_cause(ra8_reset_cause_t* out);

[[nodiscard]] ra8_err_t ra8_reset_get_raw(ra8_reset_raw_t* out);

[[nodiscard]] ra8_err_t ra8_reset_clear_cause(uint32_t mask);
 
/* =============================================================================
 * Security attribution
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_reset_get_attribution(uint32_t* out);
 
/* =============================================================================
 * Software reset
 * =============================================================================
 */

void ra8_reset_software_reset(void);
 
/* =============================================================================
 * Reset-source masking (SYRSTMSK0/1/2)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_reset_source_iwdt  = 0U,  
  k_ra8_reset_source_wdt0  = 1U,  
  k_ra8_reset_source_sw    = 2U,  
  k_ra8_reset_source_clu0  = 3U,  
  k_ra8_reset_source_lm0   = 4U,  
  k_ra8_reset_source_cm    = 5U,  
  k_ra8_reset_source_bus   = 6U,  
  k_ra8_reset_source_wdt1  = 7U,  
  k_ra8_reset_source_clu1  = 8U,  
  k_ra8_reset_source_lm1   = 9U,  
  k_ra8_reset_source_pvd1  = 10U, 
  k_ra8_reset_source_pvd2  = 11U, 
  k_ra8_reset_source_count = 12U, 
} ra8_reset_source_t;

[[nodiscard]] ra8_err_t ra8_reset_set_source_mask(ra8_reset_source_t source, bool disable);

[[nodiscard]] ra8_err_t ra8_reset_get_source_mask(ra8_reset_source_t source, bool* disabled);
 
#ifdef __cplusplus
}
#endif