S32 SDK
Reset Control Module (RCM)

Detailed Description

This module covers the functionality of the Reset Control Module (RCM) peripheral.

RCM HAL provides the API for reading and writing register bit-fields belonging to the RCM module.

Data Structures

struct  rcm_version_info_t
 RCM module version number Implements rcm_version_info_t_Class. More...
 

Enumerations

enum  rcm_source_names_t {
  RCM_WAKEUP, RCM_LOW_VOLT_DETECT, RCM_LOSS_OF_CLK, RCM_LOSS_OF_LOCK,
  RCM_WATCH_DOG, RCM_EXTERNAL_PIN, RCM_POWER_ON, RCM_SJTAG,
  RCM_CORE_LOCKUP, RCM_SOFTWARE, RCM_SMDM_AP, RCM_STOP_MODE_ACK_ERR,
  RCM_TAMPERR, RCM_CORE1, RCM_SRC_NAME_MAX
}
 System Reset Source Name definitions Implements rcm_source_names_t_Class. More...
 
enum  rcm_filter_run_wait_modes_t { RCM_FILTER_DISABLED, RCM_FILTER_BUS_CLK, RCM_FILTER_LPO_CLK, RCM_FILTER_RESERVED }
 Reset pin filter select in Run and Wait modes Implements rcm_filter_run_wait_modes_t_Class. More...
 
enum  rcm_reset_delay_time_t { RCM_10LPO_CYCLES_DELAY, RCM_34LPO_CYCLES_DELAY, RCM_130LPO_CYCLES_DELAY, RCM_514LPO_CYCLES_DELAY }
 Reset delay time Implements rcm_reset_delay_time_t_Class. More...
 

Reset Control Module APIs

void RCM_HAL_GetVersion (const RCM_Type *const baseAddr, rcm_version_info_t *const versionInfo)
 Get the version of the RCM module. More...
 
bool RCM_HAL_GetSrcIndicationFeatureAvailability (const RCM_Type *const baseAddr, const rcm_source_names_t srcName)
 Checks the existence of the status indication feature for a reset source. More...
 
bool RCM_HAL_GetSrcStatusCmd (const RCM_Type *const baseAddr, const rcm_source_names_t srcName)
 Gets the reset source status. More...
 
void RCM_HAL_SetResetIntCmd (RCM_Type *const baseAddr, const rcm_source_names_t resetInterrupt, const bool enable)
 Enables/disables a specified system reset interrupt. More...
 
static void RCM_HAL_SetAllResetIntCmd (RCM_Type *const baseAddr, const bool enable)
 Enables/disables all system reset interrupts. More...
 
bool RCM_HAL_GetStickySrcStatusCmd (const RCM_Type *const baseAddr, const rcm_source_names_t srcName)
 Gets the sticky reset source status. More...
 
void RCM_HAL_ClearStickySrcStatus (RCM_Type *const baseAddr)
 Clear the sticky reset source status. More...
 
static void RCM_HAL_SetFilterStopModeCmd (RCM_Type *const baseAddr, const bool enable)
 Sets the reset pin filter in stop mode. More...
 
static bool RCM_HAL_GetFilterStopModeCmd (const RCM_Type *const baseAddr)
 Gets the reset pin filter in stop mode. More...
 
static void RCM_HAL_SetFilterRunWaitMode (RCM_Type *const baseAddr, const rcm_filter_run_wait_modes_t mode)
 Sets the reset pin filter in run and wait mode. More...
 
static rcm_filter_run_wait_modes_t RCM_HAL_GetFilterRunWaitMode (const RCM_Type *const baseAddr)
 Gets the reset pin filter for stop mode. More...
 
static void RCM_HAL_SetFilterWidth (RCM_Type *const baseAddr, const uint32_t width)
 Sets the reset pin filter width. More...
 
static uint32_t RCM_HAL_GetFilterWidth (const RCM_Type *const baseAddr)
 Gets the reset pin filter for stop mode. More...
 
static void RCM_HAL_SetResetDelayTimeValue (RCM_Type *const baseAddr, const rcm_reset_delay_time_t value)
 Sets reset delay time. More...
 

Enumeration Type Documentation

Reset pin filter select in Run and Wait modes Implements rcm_filter_run_wait_modes_t_Class.

Enumerator
RCM_FILTER_DISABLED 
RCM_FILTER_BUS_CLK 
RCM_FILTER_LPO_CLK 
RCM_FILTER_RESERVED 

Definition at line 67 of file rcm_hal.h.

Reset delay time Implements rcm_reset_delay_time_t_Class.

Enumerator
RCM_10LPO_CYCLES_DELAY 
RCM_34LPO_CYCLES_DELAY 
RCM_130LPO_CYCLES_DELAY 
RCM_514LPO_CYCLES_DELAY 

Definition at line 80 of file rcm_hal.h.

System Reset Source Name definitions Implements rcm_source_names_t_Class.

Enumerator
RCM_WAKEUP 
RCM_LOW_VOLT_DETECT 
RCM_LOSS_OF_CLK 
RCM_LOSS_OF_LOCK 
RCM_WATCH_DOG 
RCM_EXTERNAL_PIN 
RCM_POWER_ON 
RCM_SJTAG 
RCM_CORE_LOCKUP 
RCM_SOFTWARE 
RCM_SMDM_AP 
RCM_STOP_MODE_ACK_ERR 
RCM_TAMPERR 
RCM_CORE1 
RCM_SRC_NAME_MAX 

Definition at line 45 of file rcm_hal.h.

Function Documentation

void RCM_HAL_ClearStickySrcStatus ( RCM_Type *const  baseAddr)

Clear the sticky reset source status.

This function clears all the sticky system reset flags.

Parameters
[in]baseAddrRegister base address of RCM

Definition at line 331 of file rcm_hal.c.

static rcm_filter_run_wait_modes_t RCM_HAL_GetFilterRunWaitMode ( const RCM_Type *const  baseAddr)
inlinestatic

Gets the reset pin filter for stop mode.

This function gets the reset pin filter enable setting for stop mode.

Parameters
[in]baseAddrRegister base address of RCM
Returns
mode for reset filter in run/wait mode Implements RCM_HAL_GetFilterRunWaitMode_Activity

Definition at line 249 of file rcm_hal.h.

static bool RCM_HAL_GetFilterStopModeCmd ( const RCM_Type *const  baseAddr)
inlinestatic

Gets the reset pin filter in stop mode.

This function gets the reset pin filter enable setting in stop mode.

Parameters
[in]baseAddrRegister base address of RCM
Returns
enable true/false to enable or disable the filter in stop mode Implements RCM_HAL_GetFilterStopModeCmd_Activity

Definition at line 216 of file rcm_hal.h.

static uint32_t RCM_HAL_GetFilterWidth ( const RCM_Type *const  baseAddr)
inlinestatic

Gets the reset pin filter for stop mode.

This function gets the reset pin filter width.

Parameters
[in]baseAddrRegister base address of RCM
Returns
width reset filter width Implements RCM_HAL_GetFilterWidth_Activity

Definition at line 299 of file rcm_hal.h.

bool RCM_HAL_GetSrcIndicationFeatureAvailability ( const RCM_Type *const  baseAddr,
const rcm_source_names_t  srcName 
)

Checks the existence of the status indication feature for a reset source.

This function checks the existence of the status indication feature for a specified source.

Parameters
[in]baseAddrRegister base address of RCM
[in]srcNamereset source name
Returns
status true or false for specified reset source

Definition at line 75 of file rcm_hal.c.

bool RCM_HAL_GetSrcStatusCmd ( const RCM_Type *const  baseAddr,
const rcm_source_names_t  srcName 
)

Gets the reset source status.

This function gets the current reset source status for a specified source.

Parameters
[in]baseAddrRegister base address of RCM
[in]srcNamereset source name
Returns
status true or false for specified reset source

Definition at line 143 of file rcm_hal.c.

bool RCM_HAL_GetStickySrcStatusCmd ( const RCM_Type *const  baseAddr,
const rcm_source_names_t  srcName 
)

Gets the sticky reset source status.

This function gets the current reset source status that have not been cleared by software for a specified source.

Parameters
[in]baseAddrRegister base address of RCM
[in]srcNamereset source name
Returns
status true or false for specified reset source

Definition at line 269 of file rcm_hal.c.

void RCM_HAL_GetVersion ( const RCM_Type *const  baseAddr,
rcm_version_info_t *const  versionInfo 
)

Get the version of the RCM module.

Parameters
[in]baseAddrbase address of the RCM module
[out]versionInfoDevice Version Number

Definition at line 49 of file rcm_hal.c.

static void RCM_HAL_SetAllResetIntCmd ( RCM_Type *const  baseAddr,
const bool  enable 
)
inlinestatic

Enables/disables all system reset interrupts.

This function enables/disables all system reset interrupts.

Parameters
[in]baseAddrRegister base address of RCM
[in]enableenable or disable the filter in stop mode Implements RCM_HAL_SetAllResetIntCmd_Activity

Definition at line 161 of file rcm_hal.h.

static void RCM_HAL_SetFilterRunWaitMode ( RCM_Type *const  baseAddr,
const rcm_filter_run_wait_modes_t  mode 
)
inlinestatic

Sets the reset pin filter in run and wait mode.

This function sets the reset pin filter enable setting in run/wait mode.

Parameters
[in]baseAddrRegister base address of RCM
[in]modeto be set for reset filter in run/wait mode Implements RCM_HAL_SetFilterRunWaitMode_Activity

Definition at line 232 of file rcm_hal.h.

static void RCM_HAL_SetFilterStopModeCmd ( RCM_Type *const  baseAddr,
const bool  enable 
)
inlinestatic

Sets the reset pin filter in stop mode.

This function sets the reset pin filter enable setting in stop mode.

Parameters
[in]baseAddrRegister base address of RCM
[in]enableenable or disable the filter in stop mode Implements RCM_HAL_SetFilterStopModeCmd_Activity

Definition at line 199 of file rcm_hal.h.

static void RCM_HAL_SetFilterWidth ( RCM_Type *const  baseAddr,
const uint32_t  width 
)
inlinestatic

Sets the reset pin filter width.

This function sets the reset pin filter width.

Parameters
[in]baseAddrRegister base address of RCM
[in]widthto be set for reset filter width Implements RCM_HAL_SetFilterWidth_Activity

Definition at line 282 of file rcm_hal.h.

static void RCM_HAL_SetResetDelayTimeValue ( RCM_Type *const  baseAddr,
const rcm_reset_delay_time_t  value 
)
inlinestatic

Sets reset delay time.

This function configures the maximum reset delay time from when the interrupt is asserted.

Parameters
[in]baseAddrRegister base address of RCM
[in]valueReset delay time Implements RCM_HAL_SetResetDelayTimeValue_Activity

Definition at line 315 of file rcm_hal.h.

void RCM_HAL_SetResetIntCmd ( RCM_Type *const  baseAddr,
const rcm_source_names_t  resetInterrupt,
const bool  enable 
)

Enables/disables a specified system reset interrupt.

This function will enable/disable the specified system reset interrupt.

Parameters
[in]baseAddrRegister base address of RCM
[in]resetInterruptReset source name
[in]enabletrue or false for the specified reset interrupt

Definition at line 203 of file rcm_hal.c.