SIM: System Integration Module Driver

Overview

This document consists of sections titled with Driver Overview, Data Structures, Enumerations, Functions, etc., each with an overview list and detailed documentation. It is recommended to read the Driver Overview first for it includes a comprehensive description of the peripheral, driver and driver changes. Other sections give detailed information for APIs, enums, macros, etc., for your further reference.

Modules
	SIM Peripheral and Driver Overview
	Content including 1) peripheral features and work logic; 2) driver design logic.
	The Driver Change Log
	The current SIM driver version is 2.0.0.

Macros
#define	SIM_RESET_STATUS_MASK
	The macro of REST status bit field mask. More...
#define	SIM_PWR_SR27_CONTROL_MODE_MASK   (SIM_PWR_SR27STDBY_MASK | SIM_PWR_SR27PDN_MASK)
	The definition of the short regulator control mode bit field mask.
#define	SIM_PWR_SR27_CONTROL_MODE_SHIFT   (2U)
	The definition of the short regulator control mode bit field shift. More...
#define	SIM_PWR_SR27_CONTROL_MODE(x)   (((uint16_t)(((uint16_t)(x)) << SIM_PWR_SR27_CONTROL_MODE_SHIFT)) & SIM_PWR_SR27_CONTROL_MODE_MASK)
	The macro that can be used to set the bit field of PWR register's short regulator bit field. More...
#define	SIM_PROT_BIT_FIELD_MASK(moduleName)   (((uint16_t)3U << (uint8_t)(moduleName)))
	The definition of the PORT register bit filed mask. More...
#define	SIM_PORT_SET_MODE_PROTECTION_MODE(moduleName, protectionMode)   ((uint16_t)(((uint16_t)(protectionMode)) << (uint8_t)(moduleName)))
	The macro that can be used to set module's protection mode. More...
#define	SIM_XBAR_FILTER_REG_INDEX(xbarInput)   (((uint16_t)(xbarInput)) >> 1U)
	The definition of the XBAR_FLTx register index. More...
#define	SIM_XBAR_FILTER_BIT_SHIFT(xbarInput)   ((((uint16_t)(xbarInput)) & 1U) * 8U)
	The definition of the XBAR_FLTx register bit field shift. More...
#define	SIM_XBAR_FILTER_BIT_MASK(xbarInput)   (((uint16_t)0xFFU) << SIM_XBAR_FILTER_BIT_SHIFT(xbarInput))
	The definition of the XBAR_FLTx register bit field mask. More...

Enumerations
enum	_sim_reset_status_flags {   kSIM_PowerONResetFlag = SIM_RSTAT_POR_MASK,   kSIM_ExternalResetFlag = SIM_RSTAT_EXTR_MASK,   kSIM_COPLossOfReferenceResetFlag,   kSIM_COPCPUTimeOutResetFlag = SIM_RSTAT_COP_CPU_MASK,   kSIM_SofwareResetFlag = SIM_RSTAT_SWR_MASK,   kSIM_COPWindowTimeOutResetFlag = SIM_RSTAT_COP_WIN_MASK }
	The enumeration of system reset status flags, such as power on reset, software reset, etc. More...
enum	sim_stop_mode_operation_t {   kSIM_STOPInstrutionEnterStopMode = 0U,   kSIM_STOPInstrutionNotEnterStopMode = 1U,   kSIM_STOPInstrutionEnterStopModeWriteProtect = 2U,   kSIM_STOPInstructionNotEnterStopModeWriteProtect = 3U }
	The enumeration of stop mode operation can be used to enable/disable stop mode enter. More...
enum	sim_wait_mode_operation_t {   kSIM_WAITInstrutionEnterWaitMode = 0U,   kSIM_WAITInstrutionNotEnterWaitMode = 1U,   kSIM_WAITInstrutionEnterWaitModeWriteProtect = 2U,   kSIM_WAITInstructionNotEnterWaitModeWriteProtect = 3U }
	The enumeration of wait mode operation can be used to enable/disable wait mode enter. More...
enum	sim_onceclk_operation_mode_t {   kSIM_OnCEClkEnabledWhenCoreTapEnabled = 0U,   kSIM_OnCEClkAlwaysEnabled = 1U }
	The enumeration of OnCE clock operation mode, such as enabled when core TAP is enabled and always enabled. More...
enum	sim_dma_operation_mode_t {   kSIM_DMADisable = 0U,   kSIM_DMAEnableAtRunModeOnly = 1U,   kSIM_DMAEnableAtRunModeWaitMode = 2U,   kSIM_DMAEnableAtAllPowerModes = 3U,   kSIM_DMADisableWriteProtect = 4U,   kSIM_DMAEnableAtRunModeOnlyWriteProtect = 5U,   kSIM_DMAEnableAtRunModeWaitModeWriteProtect = 6U,   kSIM_DMAEnableAtAllPowerModesWriteProtect = 7U }
	The enumeration of dma operation mode, this enumeration can be used to disable/enable DMA module in different power modes. More...
enum	sim_small_regulator_1P2V_control_mode_t {   kSIM_SmallRegulator1P2VInNormalMode = 0U,   kSIM_SmallRegulator1P2VInStandbyMode = 1U,   kSIM_SmallRegulator1P2VInNormalModeWriteProtect = 2U,   kSIM_SmallRegulator1P2VInStandbyModeWriteProtect = 3U }
	The enumeration of small regualtor 1P2V control mode, such as normal mode and standby mode. More...
enum	sim_small_regulator_2P7V_control_mode_t {   kSIM_SmallRegulator2P7VInNormalMode = 0U,   kSIM_SmallRegulator2P7VInStandbyMode = 1U,   kSIM_SmallRegulator2P7VInPowerdownMode = 4U,   kSIM_SmallRegulator2P7VInNormalModeWriteProtect = 2U,   kSIM_SmallRegulator2P7VInStandbyModeWriteProtect = 3U,   kSIM_SmallRegulator2P7VInPowerdownModeWriteProtect = 0xCU }
	The enumeration of small regulator 2P7V control mode, such as normal mode, standby mode, powerdown mode, etc. More...
enum	sim_large_regulator_control_mode_t {   kSIM_LargeRegulatorInNormalMode = 0U,   kSIM_LargeRegulatorInStandbyMode = 1U,   kSIM_LargeRegulatorInNormalModeWriteProtect = 2U,   kSIM_LargeRegulatorInStandbyModeWriteProtect = 3U }
	The enumeration of large regulator contorl mode, such as normal mode, standby mode. More...
enum	sim_write_protection_module_t {   kSIM_GPIOInternalPeripheralSelectProtection = 0U,   kSIM_PeripheralClockEnableProtection = 2U,   kSIM_GPIOPortDProtection = 4U,   kSIM_PowerModeControlWriteProtection = 6U }
	The enumeration of modules that support various protection mode. More...
enum	sim_write_protection_mode_t {   kSIM_WriteProtectionOff = 0U,   kSIM_WriteProtectionOn = 1U,   kSIM_WriteProtectionOffAndLocked = 2U,   kSIM_WriteProtectionOnAndLocked = 3U }
	The enumeration of write protection mode, such as write protection off, write protection on, etc. More...
enum	sim_lpi2c_trigger_selection_t {   kSIM_Lpi2cSlaveTrigger = 0U,   kSIM_Lpi2cMasterTrigger = 1U }
	The enumeration of lpi2c trigger selection, including slave trigger and master trigger. More...
enum	sim_device_operate_mode_t {   kSIM_NormalOperateMode = 0U,   kSIM_FastOperateMode = 1U }
	The enumeration of device operate mode, including normal mode and fast mode. More...
enum	sim_master_pit_selection_t {   kSIM_PIT0MasterPIT1Slave = 0U,   kSIM_PIT1MasterPIT0Slave = 1U }
	The enumeration of master pit. More...
enum	sim_xbar_input_t {   kSIM_XBARInput2 = 0U,   kSIM_XBARInput3 = 1U,   kSIM_XBARInput4 = 2U,   kSIM_XBARInput5 = 3U,   kSIM_XBARInput6 = 4U,   kSIM_XBARInput7 = 5U,   kSIM_XBARInput8 = 6U,   kSIM_XBARInput9 = 7U }
	The enumeration of XBAR input. More...
enum	sim_xbar_filter_count_t {   kSIM_XBARFilter3Count = 0U,   kSIM_XBARFilter4Count = 1U,   kSIM_XBARFilter5Count = 2U,   kSIM_XBARFilter6Count = 3U,   kSIM_XBARFilter7Count = 4U,   kSIM_XBARFilter8Count = 5U,   kSIM_XBARFilter9Count = 6U,   kSIM_XBARFilter10Count = 7U }
	The enumeration of XBAR filter count. More...

Driver version
#define	FSL_SIM_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))
	SIM driver version. More...

Low Power Mode Control Related Interfaces
static void	SIM_SetWaitModeOperation (SIM_Type *base, sim_wait_mode_operation_t eOperation)
	Sets the operation of wait mode, enable/disable the entry of wait mode. More...
static void	SIM_SetStopModeOperation (SIM_Type *base, sim_stop_mode_operation_t eOperation)
	Sets the operation of stop mode, enable/disable the entry of stop mode. More...
static void	SIM_EnterLPMode (SIM_Type *base)
	Enters into LPMode when the advanced power mode is enabled(register FOPT[1] bit is set). More...
static void	SIM_ExitLPMode (SIM_Type *base)
	Exits from LPMode when the advanced power mode is enabled(register FOPT[1] bit is set). More...
static void	SIM_EnterVLPMode (SIM_Type *base)
	Enters into VLPMode when the advanced power mode is enabled(register FOPT[1] bit is set). More...
static void	SIM_ExitVLPMode (SIM_Type *base)
	Exits from VLPMode when the advanced power mode is enabled(register FOPT[1] bit is set). More...
static bool	SIM_IsInLPMode (SIM_Type *base)
	Indicates whether the chip is in LPMode when the advanced power mode is enabled(register FOPT[1] bit is set). More...
static bool	SIM_IsInVLPMode (SIM_Type *base)
	Indicates whether the chip is in VLPMode when the advanced power mode is enabled(register FOPT[1] bit is set). More...

Reset Related Interfaces
static void	SIM_TriggerSoftwareReset (SIM_Type *base)
	Triggers the software reset for device. More...
static uint16_t	SIM_GetResetStatusFlags (SIM_Type *base)
	Gets the cause of the most recent reset. More...
static void	SIM_TriggerPeripheralSoftwareReset (SIM_Type *base, sim_swReset_peri_index_t ePeriIndex)
	Triggers the software reset of specific peripheral. More...
static void	SIM_EnableResetPadCellInputFilter (SIM_Type *base, bool bEnable)
	Enables/Disables the input filter on external reset padcell. More...

Peripheral Signal Muxing Control Interfaces
static void	SIM_SetInternalPeriInput (SIM_Type *base, sim_internal_peri_index_t eIndex, sim_internal_peri_input_t eInput)
	Sets internal peripheral inputs, some peripheral inputs have the ability to be connected to either XBAR outputs or GPIO. More...
static void	SIM_SetXbarInputAdcTmrSelection (SIM_Type *base, sim_xbar_input_adc_tmr_index_t eIndex, sim_xbar_input_adc_tmr_selection_t eSelection)
	Selects the Xbar input from ADC and TMR A/B. More...
static void	SIM_XBARInputFilter (SIM_Type *base, sim_xbar_input_t eXbarInput, uint8_t u8SamplePeriod, sim_xbar_filter_count_t eCount)
	Sets XBAR input filter period and count. More...

Voltage Regulators Control Interfaces
static void	SIM_SetSmallRegulator1P2VControlMode (SIM_Type *base, sim_small_regulator_1P2V_control_mode_t eControlMode)
	Sets the control mode of small regulator 1.2V supply, the available control modes are normal mode, standby mode, etc. More...
static void	SIM_SetSmallRegulator2P7VControlMode (SIM_Type *base, sim_small_regulator_2P7V_control_mode_t eControlMode)
	Sets the control mode of small regulator 2.7 supply, the available control modes are normal mode, standby mode, etc. More...
static void	SIM_SetLargeRegulatorControlMode (SIM_Type *base, sim_large_regulator_control_mode_t eControlMode)
	Sets the control mode of large regulator, the available control mode are normal mode, standby mode, etc. More...

Write Protection Interfaces
static void	SIM_SetRegisterProtectionMode (SIM_Type *base, sim_write_protection_module_t eModule, sim_write_protection_mode_t eMode)
	Sets the write protection mode of the selected register. More...

JTAG ID Interfaces
static uint32_t	SIM_GetJTAGID (SIM_Type *base)
	Gets JTAG ID, the JTAG ID is 32bits width. More...

Short Addressing Control Related Interfaces
static void	SIM_SetIOShortAddressValue (SIM_Type *base, uint32_t u32IOShortAddressValue)
	Sets the I/O short address location value which specifies the memory referenced through the I/O short address mode. More...

Software Control Interfaces
static uint16_t	SIM_GetSoftwareControlData (SIM_Type *base, sim_software_contrl_register_index_t eIndex)
	Gets the software control data by the software control register index. More...
static void	SIM_SetSoftwareControlData (SIM_Type *base, sim_software_contrl_register_index_t eIndex, uint16_t u16Value)
	Sets the software control data by the software contorl register index, the data is for general-purpose use by software. More...

Internal Peripheral Extend Control Interfaces
static void	SIM_SetOnCEClockOperationMode (SIM_Type *base, sim_onceclk_operation_mode_t eOperationMode)
	Sets the operation mode of the OnCE clock, the available operation modes are always enabled and enabled when the core TAP is enabled. More...
static void	SIM_SetDMAOperationMode (SIM_Type *base, sim_dma_operation_mode_t eOperationMode)
	Sets the operation mode of DMA, such as disabled, enabled in run mode only, etc. More...
static void	SIM_SetLPI2C0TriggerSelection (SIM_Type *base, sim_lpi2c_trigger_selection_t eTriggerSelection)
	Sets the trigger selection of lpi2c0, the available selections are master trigger and slave trigger. More...
static sim_device_operate_mode_t	SIM_GetDeviceOperateMode (SIM_Type *base)
	Gets device currently operate mode, the possible result is normal operate mode or fast operate mode. More...
static void	SIM_EnableADCScanControlReorder (SIM_Type *base, bool bEnable)
	Enables/Disables the ADC scan control register reorder feature. More...
static void	SIM_SetMasterPIT (SIM_Type *base, sim_master_pit_selection_t eMasterPit)
	Sets master programmable interval timer. More...

Macro Definition Documentation

#define FSL_SIM_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))

#define SIM_RESET_STATUS_MASK

Value:

(SIM_RSTAT_COP_WIN_MASK | SIM_RSTAT_SWR_MASK | SIM_RSTAT_COP_CPU_MASK | SIM_RSTAT_COP_LOR_MASK | \
     SIM_RSTAT_EXTR_MASK | SIM_RSTAT_POR_MASK)

#define SIM_PWR_SR27_CONTROL_MODE_SHIFT   (2U)

#define SIM_PWR_SR27_CONTROL_MODE

(

x

)

(((uint16_t)(((uint16_t)(x)) << SIM_PWR_SR27_CONTROL_MODE_SHIFT)) & SIM_PWR_SR27_CONTROL_MODE_MASK)

#define SIM_PROT_BIT_FIELD_MASK

(

moduleName

)

(((uint16_t)3U << (uint8_t)(moduleName)))

#define SIM_PORT_SET_MODE_PROTECTION_MODE	(		moduleName,
			protectionMode
	)		((uint16_t)(((uint16_t)(protectionMode)) << (uint8_t)(moduleName)))

#define SIM_XBAR_FILTER_REG_INDEX

(

xbarInput

)

(((uint16_t)(xbarInput)) >> 1U)

#define SIM_XBAR_FILTER_BIT_SHIFT

(

xbarInput

)

((((uint16_t)(xbarInput)) & 1U) * 8U)

#define SIM_XBAR_FILTER_BIT_MASK

(

xbarInput

)

(((uint16_t)0xFFU) << SIM_XBAR_FILTER_BIT_SHIFT(xbarInput))

Enumeration Type Documentation

enum _sim_reset_status_flags

Enumerator
kSIM_PowerONResetFlag	The Power on reset caused the most recent reset.
kSIM_ExternalResetFlag	The external reset caused the most recent reset, that means the external reset pin was asserted or remained asserted after the power-on reset de-asserted.
kSIM_COPLossOfReferenceResetFlag	The computer operating properly module signaled a loss of reference clock reset caused the most recent reset.
kSIM_COPCPUTimeOutResetFlag	The computer operating properly module signaled a CPU time-out reset caused the most recent reset.
kSIM_SofwareResetFlag	The previous system reset occurred as a result of a software reset.
kSIM_COPWindowTimeOutResetFlag	The previous system reset occurred as a result of a cop_window reset.

enum sim_stop_mode_operation_t

Enumerator
kSIM_STOPInstrutionEnterStopMode	Stop mode is entered when the DSC core executes a STOP instruction.
kSIM_STOPInstrutionNotEnterStopMode	The DSC core STOP instruction does not cause entry into stop mode.
kSIM_STOPInstrutionEnterStopModeWriteProtect	Stop mode is entered when the DSC core executes a STOP instruction, and the realted register bit field is write protected until the next reset.
kSIM_STOPInstructionNotEnterStopModeWriteProtect	The DSC core STOP instruction does not cause entry into stop mode, and the related register bit field is write protected until the next reset.

enum sim_wait_mode_operation_t

Enumerator
kSIM_WAITInstrutionEnterWaitMode	Wait mode is entered when the DSC core executes a WAIT instruction.
kSIM_WAITInstrutionNotEnterWaitMode	The DSC core WAIT instruction does not cause entry into wait mode.
kSIM_WAITInstrutionEnterWaitModeWriteProtect	Wait mode is entered when the DSC core executes a WAIT instruction, and the realted register bit field is write protected until the next reset.
kSIM_WAITInstructionNotEnterWaitModeWriteProtect	The DSC core WAIT instruction does not cause entry into wait mode, and the related register bit field is write protected until the next reset.

enum sim_onceclk_operation_mode_t

Enumerator
kSIM_OnCEClkEnabledWhenCoreTapEnabled	The OnCE clock to the DSC core is enabled when the core TAP is enabled.
kSIM_OnCEClkAlwaysEnabled	The OnCE clock to the DSC core is always enabled.

enum sim_dma_operation_mode_t

Enumerator
kSIM_DMADisable	DMA module is disabled.
kSIM_DMAEnableAtRunModeOnly	DMA module is enabled in run mode only.
kSIM_DMAEnableAtRunModeWaitMode	DMA module is enabled in run and wait modes only.
kSIM_DMAEnableAtAllPowerModes	DMA module is enabled in all power modes.
kSIM_DMADisableWriteProtect	DMA module is disabled and the related register bit field is write protected until the next reset.
kSIM_DMAEnableAtRunModeOnlyWriteProtect	DMA module is enabled in run mode only and the related bit field is write protected until the next reset.
kSIM_DMAEnableAtRunModeWaitModeWriteProtect	DMA module is enabled in run and wait modes only and the related register bit field is write protected until the next reset.
kSIM_DMAEnableAtAllPowerModesWriteProtect	DMA module is enabled in all low power modes and the related register bit field is write protected until the next reset.

enum sim_small_regulator_1P2V_control_mode_t

Enumerator
kSIM_SmallRegulator1P2VInNormalMode	Small regulator 1.2V supply placed in normal mode.
kSIM_SmallRegulator1P2VInStandbyMode	Small regulator 1.2V supply placed in standby mode.
kSIM_SmallRegulator1P2VInNormalModeWriteProtect	Small regulator 1.2V supply placed in nomal mode, and the related register bit field is write protected until the next reset.
kSIM_SmallRegulator1P2VInStandbyModeWriteProtect	Small regulator 1.2V supply placed in standby mode, and the related register bit field is write protected until the next reset.

enum sim_small_regulator_2P7V_control_mode_t

Enumerator
kSIM_SmallRegulator2P7VInNormalMode	Small regulator 2.7V supply placed in normal mode.
kSIM_SmallRegulator2P7VInStandbyMode	Small regulator 2.7V supply placed in standby mode.
kSIM_SmallRegulator2P7VInPowerdownMode	Small regulator 2.7V supply placed in powerdown mode.
kSIM_SmallRegulator2P7VInNormalModeWriteProtect	Small regulator 2.7V supply placed in normal mode and the related bit field is write protected until chip reset.
kSIM_SmallRegulator2P7VInStandbyModeWriteProtect	Small regulator 2.7V supply placed in standby mode and the related bit field is write protected until chip reset.
kSIM_SmallRegulator2P7VInPowerdownModeWriteProtect	Small regulator placed in powerdown mode and the related bit field is write protected until chip reset.

enum sim_large_regulator_control_mode_t

Enumerator
kSIM_LargeRegulatorInNormalMode	Large regulator placed in normal mode.
kSIM_LargeRegulatorInStandbyMode	Large regulator placed in standby mode.
kSIM_LargeRegulatorInNormalModeWriteProtect	Large regulator placed in normal mode, and the related register bit field is write protected until chip reset.
kSIM_LargeRegulatorInStandbyModeWriteProtect	Large regulator placed in standby mode, and the related register bit field is write protected until chip reset.

enum sim_write_protection_module_t

Enumerator
kSIM_GPIOInternalPeripheralSelectProtection	Used to control the protection mode GPSn and IPSn registers in the SIM, all XBAR, EVTG, GPIOn_PER, GPIOn_PPMODE, GPIOn_DRIVE.
kSIM_PeripheralClockEnableProtection	Used to control the protection mode of PCEn, SDn, PSWRn, and PCR register.
kSIM_GPIOPortDProtection	Used to control the protection mode of GPIO_D_PER, GPIO_D_PPMODE, and GPIO_D_DRIVE register.
kSIM_PowerModeControlWriteProtection	Used to control the protection mode of the PWRMODE register.

enum sim_write_protection_mode_t

Enumerator
kSIM_WriteProtectionOff	Write protection off.
kSIM_WriteProtectionOn	Write protection on.
kSIM_WriteProtectionOffAndLocked	Write protection off and locked until chip reset.
kSIM_WriteProtectionOnAndLocked	Write protection on and locked until chip reset.

enum sim_lpi2c_trigger_selection_t

Enumerator
kSIM_Lpi2cSlaveTrigger	Selects slave trigger.
kSIM_Lpi2cMasterTrigger	Selects master trigger.

enum sim_device_operate_mode_t

Enumerator
kSIM_NormalOperateMode	Device in normal operating mode, core:bus:flash frequency as 2:2:1.
kSIM_FastOperateMode	Device in fast operate mode, core:bus:flash frequency as 4:4:1.

enum sim_master_pit_selection_t

Enumerator
kSIM_PIT0MasterPIT1Slave	PIT0 is master PIT and PIT1 is slave PIT.
kSIM_PIT1MasterPIT0Slave	PIT0 is master PIT and PIT1 is slave PIT.

enum sim_xbar_input_t

Enumerator
kSIM_XBARInput2	XBAR Input 2.
kSIM_XBARInput3	XBAR Input 3.
kSIM_XBARInput4	XBAR Input 4.
kSIM_XBARInput5	XBAR Input 5.
kSIM_XBARInput6	XBAR Input 6.
kSIM_XBARInput7	XBAR Input 7.
kSIM_XBARInput8	XBAR Input 8.
kSIM_XBARInput9	XBAR Input 9.

enum sim_xbar_filter_count_t

Enumerator
kSIM_XBARFilter3Count	3 consecutive sample must agree.
kSIM_XBARFilter4Count	4 consecutive sample must agree.
kSIM_XBARFilter5Count	5 consecutive sample must agree.
kSIM_XBARFilter6Count	6 consecutive sample must agree.
kSIM_XBARFilter7Count	7 consecutive sample must agree.
kSIM_XBARFilter8Count	8 consecutive sample must agree.
kSIM_XBARFilter9Count	9 consecutive sample must agree.
kSIM_XBARFilter10Count	10 consecutive sample must agree.

Function Documentation

static void SIM_SetWaitModeOperation ( SIM_Type *  base, sim_wait_mode_operation_t  eOperation  )

inlinestatic

Parameters

base	SIM peripheral base address.
eOperation	Used to enable/disable the wait mode, please refer to sim_wait_mode_operation_t.

static void SIM_SetStopModeOperation ( SIM_Type *  base, sim_stop_mode_operation_t  eOperation  )

inlinestatic

Parameters

base	SIM peripheral base address.
eOperation	Used to enable/disable the stop mode, please refer to sim_stop_mode_operation_t.

static void SIM_EnterLPMode ( SIM_Type *  base )

inlinestatic

Note

Please make sure the power mode register is not set as write protected before invoking this function.

This function is useful only when the FTFE module's FOPT[0] bit is set(advanced power mode is enabled).

Parameters

base	SIM peripheral base address.

static void SIM_ExitLPMode ( SIM_Type *  base )

inlinestatic

Note

Please make sure the power mode register is not set as write protected before invoking this function.

This function is useful only when the FTFE module's FOPT[0] bit is set(advanced power mode is enabled).

Parameters

base	SIM peripheral base address.

static void SIM_EnterVLPMode ( SIM_Type *  base )

inlinestatic

Note

Please make sure the power mode register is not set as write protected before invoking this function. If both set to enter LPMode and VLPMode, the VLPMode has higher priority.

This function is useful only when the FTFE module's FOPT[0] bit is set(advanced power mode is enabled).

Parameters

base	SIM peripheral base address.

static void SIM_ExitVLPMode ( SIM_Type *  base )

inlinestatic

Note

Please make sure the power mode register is not set as write protected before invoking this function.

This function is useful only when the FTFE module's FOPT[0] bit is set(advanced power mode is enabled).

Parameters

base	SIM peripheral base address.

static bool SIM_IsInLPMode ( SIM_Type *  base )

inlinestatic

Note

This function is useful only when the FTFE module's FOPT[0] bit is set(advanced power mode is enabled).

Parameters

base	SIM peripheral base address.

Return values

true	The chip is in LPMode.
false	The chip is not in LPMode.

static bool SIM_IsInVLPMode ( SIM_Type *  base )

inlinestatic

Note

This function is useful only when the FTFE module's FOPT[0] bit is set(advanced power mode is enabled).

Parameters

base	SIM peripheral base address.

Return values

true	The chip is in VLPMode.
false	The chip is not in VLPMode.

static void SIM_TriggerSoftwareReset ( SIM_Type *  base )

inlinestatic

Parameters

base	SIM base address.

static uint16_t SIM_GetResetStatusFlags ( SIM_Type *  base )

inlinestatic

Note

At any given time, the only one reset source is indicated. When multiple reset source assert simultaneously, the reset source with the highest precedence is indicated. The precedence from highest to lowest is POR, external reset, COP loss of reference reset, COP CPU time-out reset, software reset, COP window time-out reset. The POR is always set during a power-on reset. However, POR is cleared and the external reset is set if the external reset pin is asserted or remains asserted after the power-on reset has de-asserted.

Parameters

base	SIM peripheral base address.

Returns

The current reset status flags, should be the OR'ed value of _sim_reset_status_flags.

static void SIM_TriggerPeripheralSoftwareReset ( SIM_Type *  base, sim_swReset_peri_index_t  ePeriIndex  )

inlinestatic

Parameters

base	SIM peripheral base address.
ePeriIndex	The index of the peripheral to be reset.

static void SIM_EnableResetPadCellInputFilter ( SIM_Type *  base, bool  bEnable  )

inlinestatic

If the input filter is enabled, the filter will remove transient signals on the input at the expense of an increased input delay.

Note

If the input filter is enabled, the filter will affect all input functions supported by that padcell, including GPIO.

Parameters

base	SIM peripheral base address.
bEnable	Used to control the behaviour of input filter. true Enable the input filter on external input padcell. false Disable the input filter on external input padcell.

static void SIM_SetInternalPeriInput ( SIM_Type *  base, sim_internal_peri_index_t  eIndex, sim_internal_peri_input_t  eInput  )

inlinestatic

Parameters

base	SIM base address.
eIndex	The internal peripherals that supply multi-inputs.
eInput	The specific input that connected to the selected internal peripheral.

static void SIM_SetXbarInputAdcTmrSelection ( SIM_Type *  base, sim_xbar_input_adc_tmr_index_t  eIndex, sim_xbar_input_adc_tmr_selection_t  eSelection  )

inlinestatic

Parameters

base	SIM base address.
eIndex	SIM ADC and TMR select register field index.
eSelection	Xbar input ADC and TMR selection.

static void SIM_XBARInputFilter ( SIM_Type *  base, sim_xbar_input_t  eXbarInput, uint8_t  u8SamplePeriod, sim_xbar_filter_count_t  eCount  )

inlinestatic

Parameters

base	SIM peripheral base address.
eXbarInput	XBAR input index.
u8SamplePeriod	XBAR input filter sample period, in unit of 1 IP bus clock. u8SamplePeriod must be range in 0~31, where 0 means filter disabled.
eCount	Count for filter, which means eCount consecutive samples must agree to be accepted as transition.

static void SIM_SetSmallRegulator1P2VControlMode ( SIM_Type *  base, sim_small_regulator_1P2V_control_mode_t  eControlMode  )

inlinestatic

Note

This function is useful only when the flash module's FOPT[0] bit is 0.

Parameters

base	SIM peripheral base address.
eControlMode	The control mode to be set, please refer to sim_small_regulator_1P2V_control_mode_t.

static void SIM_SetSmallRegulator2P7VControlMode ( SIM_Type *  base, sim_small_regulator_2P7V_control_mode_t  eControlMode  )

inlinestatic

Note

This function is useful only when the flash module's FOPT[0] bit is 0.

Parameters

base	SIM peripheral base address.
eControlMode	THe control mode to be set, please refer to sim_small_regulator_2P7V_control_mode_t.

static void SIM_SetLargeRegulatorControlMode ( SIM_Type *  base, sim_large_regulator_control_mode_t  eControlMode  )

inlinestatic

Note

This function is useful only when the flash module's FOPT[0] bit is 0.

Parameters

base	SIM peripheral base address.
eControlMode	The control mode to be set, please refer to sim_large_regulator_control_mode_t.

static void SIM_SetRegisterProtectionMode ( SIM_Type *  base, sim_write_protection_module_t  eModule, sim_write_protection_mode_t  eMode  )

inlinestatic

Parameters

base	SIM peripheral base address.
eModule	The module to be set, please refer to sim_write_protection_module_t.
eMode	The specific write protection mode to be set, please refer to sim_write_protection_mode_t.

static uint32_t SIM_GetJTAGID ( SIM_Type *  base )

inlinestatic

Parameters

base	SIM base address.

Returns

The 32bits width JTAG ID.

static void SIM_SetIOShortAddressValue ( SIM_Type *  base, uint32_t  u32IOShortAddressValue  )

inlinestatic

The I/O short address mode allows the instrution to specify the lower 6 bits of the address. And the upper 18 bits of the address can be controlled by invoking this function.

Note

The pipeline delay between setting the related register set and using short I/O addrssing with the new value is five cycles.

Parameters

base	SIM base address.
u32IOShortAddressValue	The value of I/O short address location, this address value should be 24 bits width.

static uint16_t SIM_GetSoftwareControlData ( SIM_Type *  base, sim_software_contrl_register_index_t  eIndex  )

inlinestatic

Parameters

base	SIM base address.
eIndex	SIM software control register index.

Returns

Software control registers value.

static void SIM_SetSoftwareControlData ( SIM_Type *  base, sim_software_contrl_register_index_t  eIndex, uint16_t  u16Value  )

inlinestatic

Parameters

base	SIM base address.
eIndex	SIM software control register index.
u16Value	Software control registers value.

static void SIM_SetOnCEClockOperationMode ( SIM_Type *  base, sim_onceclk_operation_mode_t  eOperationMode  )

inlinestatic

Parameters

base	SIM peripheral base address.
eOperationMode	The operation mode of OnCE clock, please refer to sim_onceclk_operation_mode_t.

static void SIM_SetDMAOperationMode ( SIM_Type *  base, sim_dma_operation_mode_t  eOperationMode  )

inlinestatic

Parameters

base	SIM peripheral base address.
eOperationMode	The operation mode to be set, please refer to sim_dma_operation_mode_t.

static void SIM_SetLPI2C0TriggerSelection ( SIM_Type *  base, sim_lpi2c_trigger_selection_t  eTriggerSelection  )

inlinestatic

This function can be used to selection the LPI2C0 output trigger. If selected as master trigger, the LPI2C0 master will generate an output trigger that can be connected to other peripherals on the device. If selected as slave trigger, the LPI2C0 slave will generate an output trigger that can be connected to other peripherals on the device.

Parameters

base	SIM peripheral base address.
eTriggerSelection	The trigger selection to set, please refer to sim_lpi2c_trigger_selection_t.

static sim_device_operate_mode_t SIM_GetDeviceOperateMode ( SIM_Type *  base )

inlinestatic

Parameters

base	SIM peripheral base address.

Returns

Current device's operate mode.

static void SIM_EnableADCScanControlReorder ( SIM_Type *  base, bool  bEnable  )

inlinestatic

Parameters

base	SIM peripheral base address.
bEnable	Used to control the ADC scan control register reorder feature. true Enable the re-ordering of ADC scan control bits. false ADC scan control register works in normal order.

static void SIM_SetMasterPIT ( SIM_Type *  base, sim_master_pit_selection_t  eMasterPit  )

inlinestatic

Parameters

base	SIM peripheral base address.
eMasterPit	The master PIT to be selected, please refer to sim_master_pit_selection_t.