S32 SDK

Detailed Description

Error Injection Module Hardware Abstraction Level. EIM HAL provides low level APIs for reading and writing register bit-fields belonging to the EIM module.

Macros

#define POS_MSB_EIM_EICHEN   (31U)
 The position of the most significant bit in Error Injection Channel Enable register. More...
 

EIM HAL API

void EIM_HAL_Init (EIM_Type *const base)
 Resets for the registers of EIM descriptor. More...
 
static void EIM_HAL_Enable (EIM_Type *const base)
 Enables EIM module. More...
 
static void EIM_HAL_Disable (EIM_Type *const base)
 Disables the EIM module. More...
 
static void EIM_HAL_EnableChannelCmd (EIM_Type *const base, uint8_t channel, bool enable)
 Enables or disables EIM channel operation. More...
 
static bool EIM_HAL_IsChannelEnabled (const EIM_Type *const base, uint8_t channel)
 Checks whether EIM channel is enabled. More...
 
static void EIM_HAL_SetCheckBitMask (EIM_Type *const base, uint8_t channel, uint8_t checkBitMask)
 Sets check bit mask for EIM channel. More...
 
static uint8_t EIM_HAL_GetCheckBitMask (const EIM_Type *const base, uint8_t channel)
 Gets check bit mask of EIM channel. More...
 
static void EIM_HAL_SetDataMask (EIM_Type *const base, uint8_t channel, uint32_t dataMask)
 Sets data mask for EIM channel. More...
 
static uint32_t EIM_HAL_GetDataMask (const EIM_Type *const base, uint8_t channel)
 Gets data mask of EIM channel. More...
 

Macro Definition Documentation

#define POS_MSB_EIM_EICHEN   (31U)

The position of the most significant bit in Error Injection Channel Enable register.

Definition at line 44 of file eim_hal.h.

Function Documentation

static void EIM_HAL_Disable ( EIM_Type *const  base)
inlinestatic

Disables the EIM module.

This function disables the error injection function of the EIM.

Parameters
[in]baseEIM peripheral base address Implements : EIM_HAL_Disable_Activity

Definition at line 89 of file eim_hal.h.

static void EIM_HAL_Enable ( EIM_Type *const  base)
inlinestatic

Enables EIM module.

This function enables the error injection function of the EIM.

Parameters
[in]baseEIM peripheral base address Implements : EIM_HAL_Enable_Activity

Definition at line 76 of file eim_hal.h.

static void EIM_HAL_EnableChannelCmd ( EIM_Type *const  base,
uint8_t  channel,
bool  enable 
)
inlinestatic

Enables or disables EIM channel operation.

This function enables the EIM channel given as argument.

Parameters
[in]baseEIM peripheral base address
[in]channelEIM channel number
[in]enableEIM channel operation
  • true : enables EIM channel
  • false: disables EIM channel Implements : EIM_HAL_EnableChannelCmd_Activity

Definition at line 106 of file eim_hal.h.

static uint8_t EIM_HAL_GetCheckBitMask ( const EIM_Type *const  base,
uint8_t  channel 
)
inlinestatic

Gets check bit mask of EIM channel.

This function gets check bit mask of EIM channel given as argument.

Parameters
[in]baseEIM peripheral base address
[in]channelEIM channel number
Returns
Checkbit mask Implements : EIM_HAL_GetCheckBitMask_Activity

Definition at line 170 of file eim_hal.h.

static uint32_t EIM_HAL_GetDataMask ( const EIM_Type *const  base,
uint8_t  channel 
)
inlinestatic

Gets data mask of EIM channel.

This function gets data mask of EIM channel given as argument.

Parameters
[in]baseEIM peripheral base address
[in]channelEIM channel number
Returns
Data mask Implements : EIM_HAL_GetDataMask_Activity

Definition at line 208 of file eim_hal.h.

void EIM_HAL_Init ( EIM_Type *const  base)

Resets for the registers of EIM descriptor.

This function disables all channels and clears checkbit and data masks of all the channels.

Parameters
[in]baseEIM peripheral base address

Definition at line 43 of file eim_hal.c.

static bool EIM_HAL_IsChannelEnabled ( const EIM_Type *const  base,
uint8_t  channel 
)
inlinestatic

Checks whether EIM channel is enabled.

This function check whether the EIM channel given as argument is enabled.

Parameters
[in]baseEIM peripheral base address
[in]channelEIM channel number
Returns
EIM channel operation status -true: EIM channel is enabled -false: EIM channel is disabled Implements : EIM_HAL_IsChannelEnabled_Activity

Definition at line 132 of file eim_hal.h.

static void EIM_HAL_SetCheckBitMask ( EIM_Type *const  base,
uint8_t  channel,
uint8_t  checkBitMask 
)
inlinestatic

Sets check bit mask for EIM channel.

This function sets the check bit mask of the EIM channel given as argument.

Parameters
[in]baseEIM peripheral base address
[in]channelEIM channel number
[in]checkBitMaskCheckbit mask Implements : EIM_HAL_SetCheckBitMask_Activity

Definition at line 150 of file eim_hal.h.

static void EIM_HAL_SetDataMask ( EIM_Type *const  base,
uint8_t  channel,
uint32_t  dataMask 
)
inlinestatic

Sets data mask for EIM channel.

This function sets data mask of the EIM channel given as argument.

Parameters
[in]baseEIM peripheral base address
[in]channelEIM channel number
[in]dataMaskData mask Implements : EIM_HAL_SetDataMask_Activity

Definition at line 189 of file eim_hal.h.