fsl_clock_MKL03Z4.h File Reference

#include "fsl_mcglite_hal.h"
#include "fsl_mcglite_hal_modes.h"
#include "fsl_osc_hal.h"

Data Structures
struct	sim_config_kl03z4_t
	SIM configuration structure for dynamic clock setting. More...

Macros
#define	TPM_EXT_CLK_COUNT   2
	TPM external clock source count. More...

Functions
static void	CLOCK_SYS_SetOutDiv1 (uint8_t outdiv1)
	Sets the clock out divider1 setting(OUTDIV1). More...
static uint8_t	CLOCK_SYS_GetOutDiv1 (void)
	Gets the clock out divider1 setting(OUTDIV1). More...
static void	CLOCK_SYS_SetOutDiv4 (uint8_t outdiv4)
	Sets the clock out divider4 setting(OUTDIV4). More...
static uint8_t	CLOCK_SYS_GetOutDiv4 (void)
	Gets the clock out divider4 setting(OUTDIV4). More...
static void	CLOCK_SYS_SetOutDiv (uint8_t outdiv1, uint8_t outdiv2, uint8_t outdiv3, uint8_t outdiv4)
	Sets the clock out dividers setting. More...
static void	CLOCK_SYS_GetOutDiv (uint8_t *outdiv1, uint8_t *outdiv2, uint8_t *outdiv3, uint8_t *outdiv4)
	Gets the clock out dividers setting. More...
static uint32_t	CLOCK_SYS_GetInternalRefClockFreq (void)
	Get internal reference clock frequency. More...
uint32_t	CLOCK_SYS_GetExternalRefClock32kFreq (void)
	Gets the external reference 32k clock frequency. More...
static void	CLOCK_SYS_SetExternalRefClock32kSrc (clock_er32k_src_t src)
	Set the clock selection of ERCLK32K. More...
static clock_er32k_src_t	CLOCK_SYS_GetExternalRefClock32kSrc (void)
	Get the clock selection of ERCLK32K. More...
uint32_t	CLOCK_SYS_GetOsc0ExternalRefClockFreq (void)
	Gets the OSC0ERCLK frequency. More...
static uint32_t	CLOCK_SYS_GetRtcFreq (uint32_t instance)
	Gets RTC input clock frequency. More...
uint32_t	CLOCK_SYS_GetRtcOutFreq (void)
	Gets RTC_CLKOUT frequency. More...
static clock_rtcout_src_t	CLOCK_SYS_GetRtcOutSrc (void)
	Gets RTC_CLKOUT source. More...
static void	CLOCK_SYS_SetRtcOutSrc (clock_rtcout_src_t src)
	Gets RTC_CLKOUT source. More...
uint32_t	CLOCK_SYS_GetTpmFreq (uint32_t instance)
	Gets TPM clock frequency. More...
static void	CLOCK_SYS_SetTpmSrc (uint32_t instance, clock_tpm_src_t tpmSrc)
	Set the TPM clock source selection. More...
static clock_tpm_src_t	CLOCK_SYS_GetTpmSrc (uint32_t instance)
	Get the TPM clock source selection. More...
static clock_lpuart_src_t	CLOCK_SYS_GetLpuartSrc (uint32_t instance)
	Gets the clock source for LPUART module. More...
static void	CLOCK_SYS_SetLpuartSrc (uint32_t instance, clock_lpuart_src_t lpuartSrc)
	Sets the clock source for LPUART module. More...
uint32_t	CLOCK_SYS_GetLpuartFreq (uint32_t instance)
	Gets the clock frequency for LPUART module. More...
static uint32_t	CLOCK_SYS_GetFtfFreq (uint32_t instance)
	Gets the clock frequency for FTF module. More...
static uint32_t	CLOCK_SYS_GetCmpFreq (uint32_t instance)
	Gets the clock frequency for CMP module. More...
static uint32_t	CLOCK_SYS_GetVrefFreq (uint32_t instance)
	Gets the clock frequency for VREF module. More...
static uint32_t	CLOCK_SYS_GetSpiFreq (uint32_t instance)
	Gets the clock frequency for SPI module. More...
static uint32_t	CLOCK_SYS_GetI2cFreq (uint32_t instance)
	Gets the clock frequency for I2C module. More...
static uint32_t	CLOCK_SYS_GetAdcAltFreq (uint32_t instance)
	Gets ADC alternate clock frequency. More...
uint32_t	CLOCK_SYS_GetUartFreq (uint32_t instance)
	Gets the clock frequency for UART module. More...
static uint32_t	CLOCK_SYS_GetGpioFreq (uint32_t instance)
	Gets the clock frequency for GPIO module. More...
void	CLOCK_SYS_EnablePortClock (uint32_t instance)
	Enable the clock for PORT module. More...
void	CLOCK_SYS_DisablePortClock (uint32_t instance)
	Disable the clock for PORT module. More...
bool	CLOCK_SYS_GetPortGateCmd (uint32_t instance)
	Get the the clock gate state for PORT module. More...
static void	CLOCK_SYS_EnableFtfClock (uint32_t instance)
	Enable the clock for FTF module. More...
static void	CLOCK_SYS_DisableFtfClock (uint32_t instance)
	Disable the clock for FTF module. More...
static bool	CLOCK_SYS_GetFtfGateCmd (uint32_t instance)
	Get the the clock gate state for FTF module. More...
void	CLOCK_SYS_EnableAdcClock (uint32_t instance)
	Enable the clock for ADC module. More...
void	CLOCK_SYS_DisableAdcClock (uint32_t instance)
	Disable the clock for ADC module. More...
bool	CLOCK_SYS_GetAdcGateCmd (uint32_t instance)
	Get the the clock gate state for ADC module. More...
static void	CLOCK_SYS_EnableCmpClock (uint32_t instance)
	Enable the clock for CMP module. More...
static void	CLOCK_SYS_DisableCmpClock (uint32_t instance)
	Disable the clock for CMP module. More...
static bool	CLOCK_SYS_GetCmpGateCmd (uint32_t instance)
	Get the the clock gate state for CMP module. More...
static void	CLOCK_SYS_EnableVrefClock (uint32_t instance)
	Enable the clock for VREF module. More...
static void	CLOCK_SYS_DisableVrefClock (uint32_t instance)
	Disable the clock for VREF module. More...
static bool	CLOCK_SYS_GetVrefGateCmd (uint32_t instance)
	Get the the clock gate state for VREF module. More...
uint32_t	CLOCK_SYS_GetLptmrFreq (uint32_t instance, clock_lptmr_src_t lptmrSrc)
	Gets LPTMRx pre-scaler/glitch filter clock frequency. More...
static void	CLOCK_SYS_EnableLptmrClock (uint32_t instance)
	Enable the clock for LPTIMER module. More...
static void	CLOCK_SYS_DisableLptmrClock (uint32_t instance)
	Disable the clock for LPTIMER module. More...
static bool	CLOCK_SYS_GetLptmrGateCmd (uint32_t instance)
	Get the the clock gate state for LPTIMER module. More...
static void	CLOCK_SYS_EnableRtcClock (uint32_t instance)
	Enable the clock for RTC module. More...
static void	CLOCK_SYS_DisableRtcClock (uint32_t instance)
	Disable the clock for RTC module. More...
static bool	CLOCK_SYS_GetRtcGateCmd (uint32_t instance)
	Get the the clock gate state for RTC module. More...
void	CLOCK_SYS_EnableSpiClock (uint32_t instance)
	Enable the clock for SPI module. More...
void	CLOCK_SYS_DisableSpiClock (uint32_t instance)
	Disable the clock for SPI module. More...
bool	CLOCK_SYS_GetSpiGateCmd (uint32_t instance)
	Get the the clock gate state for SPI module. More...
void	CLOCK_SYS_EnableI2cClock (uint32_t instance)
	Enable the clock for I2C module. More...
void	CLOCK_SYS_DisableI2cClock (uint32_t instance)
	Disable the clock for I2C module. More...
bool	CLOCK_SYS_GetI2cGateCmd (uint32_t instance)
	Get the the clock gate state for I2C module. More...
static void	CLOCK_SYS_EnableLpuartClock (uint32_t instance)
	Enable the clock for LPUART module. More...
static void	CLOCK_SYS_DisableLpuartClock (uint32_t instance)
	Disable the clock for LPUART module. More...
static bool	CLOCK_SYS_GetLpuartGateCmd (uint32_t instance)
	Get the the clock gate state for LPUART module. More...
uint32_t	CLOCK_SYS_GetTpmExternalFreq (uint32_t instance)
	Get the TPM external clock source frequency. More...
static void	CLOCK_SYS_SetTpmExternalSrc (uint32_t instance, sim_tpm_clk_sel_t src)
	Set the TPM external clock source selection. More...
static sim_tpm_clk_sel_t	CLOCK_SYS_GetTpmExternalSrc (uint32_t instance)
	Set the TPM external clock source selection. More...
void	CLOCK_SYS_EnableTpmClock (uint32_t instance)
	Enable the clock for TPM module. More...
void	CLOCK_SYS_DisableTpmClock (uint32_t instance)
	Disable the clock for TPM module. More...
bool	CLOCK_SYS_GetTpmGateCmd (uint32_t instance)
	Get the the clock gate state for TPM module. More...
static void	CLOCK_SYS_SetTpmExternalFreq (uint32_t srcInstance, uint32_t freq)
	Set the TPM external clock frequency(TPM_CLKx). More...

Variables
uint32_t	g_tpmClkFreq [TPM_EXT_CLK_COUNT]
	TPM external clock frequency(TPM_CLK). More...

Function Documentation

static void CLOCK_SYS_SetOutDiv1 ( uint8_t  outdiv1 )

inlinestatic

This function sets divide value OUTDIV1.

Parameters

outdiv1

Outdivider1 setting

static uint8_t CLOCK_SYS_GetOutDiv1 ( void  )

inlinestatic

This function gets divide value OUTDIV1.

Returns

Outdivider1 setting

static void CLOCK_SYS_SetOutDiv4 ( uint8_t  outdiv4 )

inlinestatic

This function sets divide value OUTDIV4.

Parameters

outdiv4

Outdivider4 setting

static uint8_t CLOCK_SYS_GetOutDiv4 ( void  )

inlinestatic

This function gets divide value OUTDIV4.

Returns

Outdivider4 setting

static void CLOCK_SYS_SetOutDiv ( uint8_t  outdiv1, uint8_t  outdiv2, uint8_t  outdiv3, uint8_t  outdiv4  )

inlinestatic

This function sets the setting for all clock out dividers at the same time.

Parameters

outdiv1	Outdivider1 setting
outdiv2	Outdivider2 setting
outdiv3	Outdivider3 setting
outdiv4	Outdivider4 setting

static void CLOCK_SYS_GetOutDiv ( uint8_t *  outdiv1, uint8_t *  outdiv2, uint8_t *  outdiv3, uint8_t *  outdiv4  )

inlinestatic

This function gets the setting for all clock out dividers at the same time.

Parameters

outdiv1	Outdivider1 setting
outdiv2	Outdivider2 setting
outdiv3	Outdivider3 setting
outdiv4	Outdivider4 setting

static uint32_t CLOCK_SYS_GetInternalRefClockFreq ( void  )

inlinestatic

This function gets the internal reference clock frequency.

Returns

Current clock frequency.

static void CLOCK_SYS_SetExternalRefClock32kSrc ( clock_er32k_src_t  src )

inlinestatic

This function sets the clock selection of ERCLK32K.

Parameters

src	clock source.

static clock_er32k_src_t CLOCK_SYS_GetExternalRefClock32kSrc ( void  )

inlinestatic

This function gets the clock selection of ERCLK32K.

Returns

Current selection.

static clock_rtcout_src_t CLOCK_SYS_GetRtcOutSrc ( void  )

inlinestatic

This function gets the source of RTC_CLKOUT. It is determined by RTCCLKOUTSEL.

Returns

Current source.

static void CLOCK_SYS_SetRtcOutSrc ( clock_rtcout_src_t  src )

inlinestatic

This function sets the source of RTC_CLKOUT.

Parameters

src	RTC_CLKOUT source to set.

static void CLOCK_SYS_SetTpmSrc ( uint32_t  instance, clock_tpm_src_t  tpmSrc  )

inlinestatic

This function sets the TPM clock source selection.

Parameters

instance	IP instance.
tpmSrc	The value to set.

static clock_tpm_src_t CLOCK_SYS_GetTpmSrc ( uint32_t  instance )

inlinestatic

This function gets the TPM clock source selection.

Parameters

instance

IP instance.

Returns

Current selection.

static clock_lpuart_src_t CLOCK_SYS_GetLpuartSrc ( uint32_t  instance )

inlinestatic

This function gets the clock source for LPUART module.

Parameters

instance

module device instance

Returns

Clock source.

static void CLOCK_SYS_SetLpuartSrc ( uint32_t  instance, clock_lpuart_src_t  lpuartSrc  )

inlinestatic

This function sets the clock source for LPUART module.

Parameters

instance	module device instance
lpuartSrc	Clock source.

static uint32_t CLOCK_SYS_GetFtfFreq ( uint32_t  instance )

inlinestatic

(Flash Memory)

This function gets the clock frequency for FTF module. (Flash Memory)

Parameters

instance

module device instance

Returns

freq clock frequency for this module

static uint32_t CLOCK_SYS_GetCmpFreq ( uint32_t  instance )

inlinestatic

This function gets the clock frequency for CMP module.

Parameters

instance

module device instance

Returns

freq clock frequency for this module

static uint32_t CLOCK_SYS_GetVrefFreq ( uint32_t  instance )

inlinestatic

This function gets the clock frequency for VREF module.

Parameters

instance

module device instance

Returns

freq clock frequency for this module

static uint32_t CLOCK_SYS_GetSpiFreq ( uint32_t  instance )

inlinestatic

This function gets the clock frequency for SPI module.

Parameters

instance

module device instance

Returns

freq clock frequency for this module

static uint32_t CLOCK_SYS_GetI2cFreq ( uint32_t  instance )

inlinestatic

This function gets the clock frequency for I2C module.

Parameters

instance

module device instance

Returns

freq clock frequency for this module

static uint32_t CLOCK_SYS_GetAdcAltFreq ( uint32_t  instance )

inlinestatic

This function gets the ADC alternate clock frequency.

Parameters

instance

module device instance

Returns

freq Current frequency.

static uint32_t CLOCK_SYS_GetGpioFreq ( uint32_t  instance )

inlinestatic

This function gets the clock frequency for GPIO module.

Parameters

instance

module device instance

Returns

freq clock frequency for this module

static void CLOCK_SYS_EnableFtfClock ( uint32_t  instance )

inlinestatic

This function enables the clock for FTF module.

Parameters

instance

module device instance

static void CLOCK_SYS_DisableFtfClock ( uint32_t  instance )

inlinestatic

This function disables the clock for FTF module.

Parameters

instance

module device instance

static bool CLOCK_SYS_GetFtfGateCmd ( uint32_t  instance )

inlinestatic

This function will get the clock gate state for FTF module.

Parameters

instance

module device instance

Returns

state true - ungated(Enabled), false - gated (Disabled)

static void CLOCK_SYS_EnableCmpClock ( uint32_t  instance )

inlinestatic

This function enables the clock for CMP module.

Parameters

instance

module device instance

static void CLOCK_SYS_DisableCmpClock ( uint32_t  instance )

inlinestatic

This function disables the clock for CMP module.

Parameters

instance

module device instance

static bool CLOCK_SYS_GetCmpGateCmd ( uint32_t  instance )

inlinestatic

This function will get the clock gate state for CMP module.

Parameters

instance

module device instance

Returns

state true - ungated(Enabled), false - gated (Disabled)

static void CLOCK_SYS_EnableVrefClock ( uint32_t  instance )

inlinestatic

This function enables the clock for VREF module.

Parameters

instance

module device instance

static void CLOCK_SYS_DisableVrefClock ( uint32_t  instance )

inlinestatic

This function disables the clock for VREF module.

Parameters

instance

module device instance

static bool CLOCK_SYS_GetVrefGateCmd ( uint32_t  instance )

inlinestatic

This function will get the clock gate state for VREF module.

Parameters

instance

module device instance

Returns

state true - ungated(Enabled), false - gated (Disabled)

static void CLOCK_SYS_EnableLptmrClock ( uint32_t  instance )

inlinestatic

This function enables the clock for LPTIMER module.

Parameters

instance

module device instance

static void CLOCK_SYS_DisableLptmrClock ( uint32_t  instance )

inlinestatic

This function disables the clock for LPTIMER module.

Parameters

instance

module device instance

static bool CLOCK_SYS_GetLptmrGateCmd ( uint32_t  instance )

inlinestatic

This function will get the clock gate state for LPTIMER module.

Parameters

instance

module device instance

Returns

state true - ungated(Enabled), false - gated (Disabled)

static void CLOCK_SYS_EnableRtcClock ( uint32_t  instance )

inlinestatic

This function enables the clock for RTC module.

Parameters

instance

module device instance

static void CLOCK_SYS_DisableRtcClock ( uint32_t  instance )

inlinestatic

This function disables the clock for RTC module.

Parameters

instance

module device instance

static bool CLOCK_SYS_GetRtcGateCmd ( uint32_t  instance )

inlinestatic

This function will get the clock gate state for RTC module.

Parameters

instance

module device instance

Returns

state true - ungated(Enabled), false - gated (Disabled)

static void CLOCK_SYS_SetTpmExternalSrc ( uint32_t  instance, sim_tpm_clk_sel_t  src  )

inlinestatic

This function sets the TPM external clock source selection.

Parameters

instance	IP instance.
src	TPM external clock source.

static sim_tpm_clk_sel_t CLOCK_SYS_GetTpmExternalSrc ( uint32_t  instance )

inlinestatic

This function sets the TPM external clock source selection.

Parameters

instance

IP instance.

Returns

setting Current TPM external clock source.

static void CLOCK_SYS_SetTpmExternalFreq ( uint32_t  srcInstance, uint32_t  freq  )

inlinestatic

This function sets the TPM external clock frequency (TPM_CLKx).

Parameters

srcInstance	External source instance.
freq	Frequcney value.