System Configuration (MXC_SYS)

Macros
#define	MXC_CRITICAL(code)

Typedefs
typedef mxc_sys_cfg_t	mxc_sys_cfg_scache_t
typedef mxc_sys_cfg_t	mxc_sys_cfg_usbhs_t

Enumerations
enum	mxc_sys_reset_t
enum	mxc_sys_periph_clock_t
enum	mxc_sys_control_t

Functions
static void	MXC_SYS_Crit_Enter (void)
static void	MXC_SYS_Crit_Exit (void)
static int	MXC_SYS_In_Crit_Section (void)
int	MXC_SYS_IsClockEnabled (mxc_sys_periph_clock_t clock)
int	MXC_SYS_ClockDisable (mxc_sys_periph_clock_t clock)
int	MXC_SYS_ClockEnable (mxc_sys_periph_clock_t clock)
int	MXC_SYS_RTCClockEnable (void)
int	MXC_SYS_RTCClockDisable (void)
int	MXC_SYS_ClockSourceEnable (mxc_sys_system_clock_t clock)
int	MXC_SYS_ClockSourceDisable (mxc_sys_system_clock_t clock)
int	MXC_SYS_Clock_Select (mxc_sys_system_clock_t clock)
void	MXC_SYS_Clock_Div (mxc_sys_system_div_t div)
int	MXC_SYS_Clock_Timeout (uint32_t ready)
int	MXC_SYS_Reset_Periph (mxc_sys_reset_t reset)
uint8_t	MXC_SYS_GetRev (void)
int	MXC_SYS_GetUSN (uint8_t *serialNumber, int len)
int	MXC_SYS_SCACHE_Init (const mxc_sys_cfg_scache_t *sys_cfg)
int	MXC_SYS_SCACHE_Shutdown (void)
int	MXC_SYS_USBHS_Init (const mxc_sys_cfg_usbhs_t *sys_cfg)
int	MXC_SYS_USBHS_Shutdown (void)
int	MXC_SYS_SysTick_Config (uint32_t ticks, int clk_src, mxc_tmr_regs_t *tmr)
int	MXC_SYS_SysTick_Disable (void)
int	MXC_SYS_SysTick_Delay (uint32_t ticks)
uint32_t	MXC_SYS_SysTick_GetFreq (void)
int	MXC_SYS_SysTick_DelayUs (uint32_t us)
int	MXC_SYS_LockDAP_Permanent (void)

Detailed Description

API for system configuration including clock source selection and entering critical sections of code.

Macro Definition Documentation

MXC_CRITICAL

#define MXC_CRITICAL

(

code

)

Value:

    {\
    MXC_SYS_Crit_Enter();\
    code;\
    MXC_SYS_Crit_Exit();\
}

Macro for wrapping a section of code to make it critical (interrupts disabled). Note: this macro does not support nesting.

Ex:

MXC_CRITICAL(
     printf("Hello critical section!\n");
)

This macro places a call to MXC_SYS_Crit_Enter before the code, and a call to MXC_SYS_Crit_Exit after.

Parameters

code	The code section to wrap.

Enumeration Type Documentation

mxc_sys_periph_clock_t

enum mxc_sys_periph_clock_t

System clock disable enumeration. Used in SYS_ClockDisable and SYS_ClockEnable functions.

Enumerator
MXC_SYS_PERIPH_CLOCK_GPIO0	Disable MXC_F_GCR_PERCKCN0_GPIO0D clock
MXC_SYS_PERIPH_CLOCK_GPIO1	Disable MXC_F_GCR_PERCKCN0_GPIO1D clock
MXC_SYS_PERIPH_CLOCK_GPIO2	Disable MXC_F_GCR_PERCKCN0_GPIO2D clock
MXC_SYS_PERIPH_CLOCK_USB	Disable MXC_F_GCR_PERCKCN0_USBD clock
MXC_SYS_PERIPH_CLOCK_TFT	Disable MXC_F_GCR_PERCKCN0_CLCD clock
MXC_SYS_PERIPH_CLOCK_DMA	Disable MXC_F_GCR_PERCKCN0_DMAD clock
MXC_SYS_PERIPH_CLOCK_SPI0	Disable MXC_F_GCR_PERCKCN0_SPI0D clock
MXC_SYS_PERIPH_CLOCK_SPI1	Disable MXC_F_GCR_PERCKCN0_SPI1D clock
MXC_SYS_PERIPH_CLOCK_SPI2	Disable MXC_F_GCR_PERCKCN0_SPI2D clock
MXC_SYS_PERIPH_CLOCK_UART0	Disable MXC_F_GCR_PERCKCN0_UART0D clock
MXC_SYS_PERIPH_CLOCK_UART1	Disable MXC_F_GCR_PERCKCN0_UART1D clock
MXC_SYS_PERIPH_CLOCK_I2C0	Disable MXC_F_GCR_PERCKCN0_I2C0D clock
MXC_SYS_PERIPH_CLOCK_TPU	Disable MXC_F_GCR_PERCKCN0_TPUD clock
MXC_SYS_PERIPH_CLOCK_TIMER0	Disable MXC_F_GCR_PERCKCN0_T0D clock
MXC_SYS_PERIPH_CLOCK_TIMER1	Disable MXC_F_GCR_PERCKCN0_T1D clock
MXC_SYS_PERIPH_CLOCK_TIMER2	Disable MXC_F_GCR_PERCKCN0_T2D clock
MXC_SYS_PERIPH_CLOCK_TIMER3	Disable MXC_F_GCR_PERCKCN0_T3D clock
MXC_SYS_PERIPH_CLOCK_TIMER4	Disable MXC_F_GCR_PERCKCN0_T4D clock
MXC_SYS_PERIPH_CLOCK_TIMER5	Disable MXC_F_GCR_PERCKCN0_T5D clock
MXC_SYS_PERIPH_CLOCK_ADC	Disable MXC_F_GCR_PERCKCN0_ADCD clock
MXC_SYS_PERIPH_CLOCK_I2C1	Disable MXC_F_GCR_PERCKCN0_I2C1D clock
MXC_SYS_PERIPH_CLOCK_PT	Disable MXC_F_GCR_PERCKCN0_PTD clock
MXC_SYS_PERIPH_CLOCK_SPIXIPF	Disable MXC_F_GCR_PERCKCN0_SPIXIPD clock
MXC_SYS_PERIPH_CLOCK_SPIXIPM	Disable MXC_F_GCR_PERCKCN0_SPIMD clock
MXC_SYS_PERIPH_CLOCK_UART2	Disable MXC_F_GCR_PERCKCN1_UART2D clock
MXC_SYS_PERIPH_CLOCK_TRNG	Disable MXC_F_GCR_PERCKCN1_TRNGD clock
MXC_SYS_PERIPH_CLOCK_FLC	Disable MXC_F_GCR_PERCKCN1_FLCD clock
MXC_SYS_PERIPH_CLOCK_HBC	Disable MXC_F_GCR_PERCKCN1_HBCD clock
MXC_SYS_PERIPH_CLOCK_GPIO3	Disable MXC_F_GCR_PERCKCN1_GPIO3D clock
MXC_SYS_PERIPH_CLOCK_SCACHE	Disable MXC_F_GCR_PERCKCN1_SCACHED clock
MXC_SYS_PERIPH_CLOCK_SDMA	Disable MXC_F_GCR_PERCKCN1_SDMAD clock
MXC_SYS_PERIPH_CLOCK_SEMA	Disable MXC_F_GCR_PERCKCN1_SMPHRD clock
MXC_SYS_PERIPH_CLOCK_SDHC	Disable MXC_F_GCR_PERCKCN1_SDHCD clock
MXC_SYS_PERIPH_CLOCK_ICACHE	Disable MXC_F_GCR_PERCKCN1_ICACHED clock
MXC_SYS_PERIPH_CLOCK_ICACHEXIP	Disable MXC_F_GCR_PERCKCN1_ICACHEXIPD clock
MXC_SYS_PERIPH_CLOCK_OWIRE	Disable MXC_F_GCR_PERCKCN1_OWIRED clock
MXC_SYS_PERIPH_CLOCK_SPI3	Disable MXC_F_GCR_PERCKCN1_SPI3D clock
MXC_SYS_PERIPH_CLOCK_I2S	Disable MXC_F_GCR_PERCKCN1_I2SD clock
MXC_SYS_PERIPH_CLOCK_SPIXIPR	Disable MXC_F_GCR_PERCKCN1_SPIXIPDD clock

mxc_sys_reset_t

enum mxc_sys_reset_t

System reset0 enumeration. Used in SYS_PeriphReset0 function.

Enumerator
MXC_SYS_RESET_DMA	Reset DMA
MXC_SYS_RESET_WDT	Reset WDT
MXC_SYS_RESET_GPIO0	Reset GPIO0
MXC_SYS_RESET_GPIO1	Reset GPIO1
MXC_SYS_RESET_GPIO2	Reset GPIO2
MXC_SYS_RESET_TIMER0	Reset TIMER0
MXC_SYS_RESET_TIMER1	Reset TIMER1
MXC_SYS_RESET_TIMER2	Reset TIMER2
MXC_SYS_RESET_TIMER3	Reset TIMER3
MXC_SYS_RESET_TIMER4	Reset TIMER4
MXC_SYS_RESET_TIMER5	Reset TIMER5
MXC_SYS_RESET_UART0	Reset UART0
MXC_SYS_RESET_UART1	Reset UART1
MXC_SYS_RESET_SPI0	Reset SPI0
MXC_SYS_RESET_SPI1	Reset SPI1
MXC_SYS_RESET_SPI2	Reset SPI2
MXC_SYS_RESET_I2C0	Reset I2C0
MXC_SYS_RESET_RTC	Reset RTC
MXC_SYS_RESET_TPU	Reset TPU
MXC_SYS_RESET_HBC	Reset HBC
MXC_SYS_RESET_USB	Reset USB
MXC_SYS_RESET_TFT	Reset TRNG
MXC_SYS_RESET_ADC	Reset ADC
MXC_SYS_RESET_UART2	Reset UART2
MXC_SYS_RESET_SRST	Soft reset
MXC_SYS_RESET_PRST	Peripheral reset
MXC_SYS_RESET_SYSTEM	System reset
MXC_SYS_RESET_I2C1	Reset I2C1
MXC_SYS_RESET_PT	Reset PT
MXC_SYS_RESET_SPIXIP	Reset SPIXIP
MXC_SYS_RESET_XSPIM	Reset XSPIM
MXC_SYS_RESET_GPIO3	Reset GPIO3
MXC_SYS_RESET_SDHC	Reset SDHC
MXC_SYS_RESET_OWIRE	Reset OWIRE
MXC_SYS_RESET_WDT1	Reset WDT1
MXC_SYS_RESET_SPI3	Reset SPI3
MXC_SYS_RESET_I2S	Reset I2S
MXC_SYS_RESET_XIPR	Reset SPIXMEM
MXC_SYS_RESET_SEMA	Reset SMPHR

Function Documentation

MXC_SYS_Clock_Div()

void MXC_SYS_Clock_Div

(

mxc_sys_system_div_t

div

)

Select the system clock divider.

Parameters

clock

Enumeration for desired system clock divider.

MXC_SYS_Clock_Select()

int MXC_SYS_Clock_Select

(

mxc_sys_system_clock_t

clock

)

Select the system clock.

Parameters

clock

Enumeration for desired clock.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_Clock_Timeout()

int MXC_SYS_Clock_Timeout

(

uint32_t

ready

)

Wait for a clock to enable with timeout.

Parameters

ready

The clock to wait for

Returns

E_NO_ERROR if ready, E_TIME_OUT if timeout

MXC_SYS_ClockDisable()

int MXC_SYS_ClockDisable

(

mxc_sys_periph_clock_t

clock

)

Disables the selected peripheral clock.

Parameters

clock

Enumeration for desired clock.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_ClockEnable()

int MXC_SYS_ClockEnable

(

mxc_sys_periph_clock_t

clock

)

Enables the selected peripheral clock.

Parameters

clock

Enumeration for desired clock.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_ClockSourceDisable()

int MXC_SYS_ClockSourceDisable

(

mxc_sys_system_clock_t

clock

)

Disable System Clock Source.

Parameters

clock

The clock to disable

Returns

E_NO_ERROR if everything is successful

MXC_SYS_ClockSourceEnable()

int MXC_SYS_ClockSourceEnable

(

mxc_sys_system_clock_t

clock

)

Enable System Clock Source without switching to it.

Parameters

clock

The clock to enable

Returns

E_NO_ERROR if everything is successful

MXC_SYS_Crit_Enter()

static void MXC_SYS_Crit_Enter ( void  )

inlinestatic

Enter a critical section of code that cannot be interrupted. Call MXC_SYS_Crit_Exit to exit the critical section.

Ex:

MXC_SYS_Crit_Enter();
printf("Hello critical section!\n");
MXC_SYS_Crit_Exit();

The MXC_CRITICAL macro is also provided as a convencience macro for wrapping a code section in this way.

Returns

None

MXC_SYS_Crit_Exit()

static void MXC_SYS_Crit_Exit ( void  )

inlinestatic

Exit a critical section of code from MXC_SYS_Crit_Enter.

Returns

None

MXC_SYS_GetRev()

uint8_t MXC_SYS_GetRev

(

void

)

Get the revision of the chip.

Returns

the chip revision

MXC_SYS_GetUSN()

int MXC_SYS_GetUSN	(	uint8_t *	serialNumber,
		int	len
	)

Get the USN of the chip.

Parameters

serialNumber	buffer to store the USN
len	length of the USN buffer

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_In_Crit_Section()

static int MXC_SYS_In_Crit_Section ( void  )

inlinestatic

Polls whether code is currently executing from a critical section.

Returns

1 if code is currently in a critical section (interrupts are disabled). 0 if code is not in a critical section.

MXC_SYS_IsClockEnabled()

int MXC_SYS_IsClockEnabled

(

mxc_sys_periph_clock_t

clock

)

Determines if the selected peripheral clock is enabled.

Parameters

clock

Enumeration for desired clock.

Returns

0 is the clock is disabled, non 0 if the clock is enabled.

MXC_SYS_LockDAP_Permanent()

int MXC_SYS_LockDAP_Permanent

(

void

)

This function PERMANENTLY locks the Debug Access Port.

Warning

After executing this function you will never be able to reprogram the target micro.

MXC_SYS_Reset_Periph()

int MXC_SYS_Reset_Periph

(

mxc_sys_reset_t

reset

)

Reset the peripherals and/or CPU in the rstr0 register.

Parameters

reset

Enumeration for what to reset. Can reset multiple items at once.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_RTCClockDisable()

int MXC_SYS_RTCClockDisable

(

void

)

Disables the external 32k oscillator.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_RTCClockEnable()

int MXC_SYS_RTCClockEnable

(

void

)

Enables the external 32k oscillator.

Parameters

rtc	rtc system configuration settings. NULL if undesired.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_SCACHE_Init()

int MXC_SYS_SCACHE_Init

(

const mxc_sys_cfg_scache_t *

sys_cfg

)

System level initialization for SCHACE module.

Parameters

sys_cfg

System configuration object

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_SCACHE_Shutdown()

int MXC_SYS_SCACHE_Shutdown

(

void

)

System level Shutdown for SCACHE module.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_SysTick_Config()

int MXC_SYS_SysTick_Config	(	uint32_t	ticks,
		int	clk_src,
		mxc_tmr_regs_t *	tmr
	)

System Tick Configuration Helper.

        The function enables selection of the external clock source for
        the System Tick Timer. It initializes the System Timer and its
        interrupt, and starts the System Tick Timer. Counter is in free
        running mode to generate periodic interrupts.

Parameters

ticks	Number of ticks between two interrupts.
clk_src	Selects between default SystemClock or External Clock. 0 Use external clock source 1 SystemClock
tmr	Optional tmr pointer for timeout. NULL if undesired.

Returns

E_NO_ERROR Function succeeded.

E_INVALID Invalid reload value requested.

MXC_SYS_SysTick_Delay()

int MXC_SYS_SysTick_Delay

(

uint32_t

ticks

)

Delay a requested number of SysTick Timer Ticks.

Parameters

ticks

Number of System Ticks to delay.

Note

This delay function is based on the clock used for the SysTick timer if the SysTick timer is enabled. If the SysTick timer is not enabled, the current SysTick registers are saved and the timer will use the SystemClock as the source for the delay. The delay is measured in clock ticks and is not based on the SysTick interval.

Returns

E_NO_ERROR if everything is successful

MXC_SYS_SysTick_DelayUs()

int MXC_SYS_SysTick_DelayUs

(

uint32_t

us

)

Delay a requested number of microseconds.

Parameters

us	Number of microseconds to delay.

Note

Calls SYS_SysTick_Delay().

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_SysTick_Disable()

int MXC_SYS_SysTick_Disable

(

void

)

Disable System Tick timer.

Returns

E_NO_ERROR if everything is successful.

MXC_SYS_SysTick_GetFreq()

uint32_t MXC_SYS_SysTick_GetFreq

(

void

)

Get the frequency of the SysTick Timer.

Returns

frequency in Hz

MXC_SYS_USBHS_Init()

int MXC_SYS_USBHS_Init

(

const mxc_sys_cfg_usbhs_t *

sys_cfg

)

System-level initialization for the USBHS module.

Parameters

sys_cfg

System configuration object

Returns

E_NO_ERROR upon success, or appropriate failure code

MXC_SYS_USBHS_Shutdown()

int MXC_SYS_USBHS_Shutdown

(

void

)

System-level shutdown for the USBHS module.

Returns

E_NO_ERROR upon success, or appropriate failure code