Clock Driver

Overview

The MCUXpresso SDK provides APIs for MCUXpresso SDK devices' clock operation.

Files
file	fsl_clock.h

Macros
#define	FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL   0
	Configure whether driver controls clock. More...
#define	MU_CLOCKS
	Clock ip name array for MU. More...
#define	GPIO_CLOCKS
	Clock ip name array for GPIO. More...
#define	FLEXSPI_CLOCKS
	Clock ip name array for FLEXSPI. More...
#define	RGPIO_CLOCKS
	Clock ip name array for RGPIO. More...
#define	FTM_CLOCKS
	Clock ip name array for FTM. More...
#define	GPT_CLOCKS
	Clock ip name array for GPT. More...
#define	FLEXCAN_CLOCKS
	Clock ip name array for FLEXCAN. More...
#define	LPUART_CLOCKS
	Clock ip name array for LPUART. More...
#define	LPADC_CLOCKS
	Clock ip name array for LPADC. More...
#define	INTMUX_CLOCKS
	Clock ip name array for INTMUX. More...
#define	SAI_CLOCKS
	Clock ip name array for SAI. More...
#define	SEMA42_CLOCKS
	Clock ip name array for SAI. More...
#define	TPM_CLOCKS
	Clock ip name array for TPM. More...
#define	LPIT_CLOCKS
	Clock ip name array for LPIT. More...
#define	LPI2C_CLOCKS
	Clock ip name array for LPI2C. More...
#define	LPSPI_CLOCKS
	Clock ip name array for LPSPI. More...
#define	EDMA_CLOCKS
	Clock ip name array for EDMA. More...
#define	ESAI_CLOCKS
	Clock ip name array for LPIT. More...
#define	ISI_CLOCKS
	Clock ip name array for ISI. More...
#define	MIPI_CSI2RX_CLOCKS
	Clock ip name array for MIPI CSI2 RX. More...
#define	MIPI_DSI_HOST_CLOCKS
	Clock ip name array for MIPI DSI host. More...
#define	ENET_CLOCKS
	Clock ip name array for ENET. More...
#define	DPU_CLOCKS
	Clock ip name array for DPU. More...
#define	CI_PI_CLOCKS
	Clock ip name array for CI_PI. More...
#define	CAAM_CLOCKS
	Clock ip name array for CAAM. More...
#define	LDB_CLOCKS
	Clock ip name array for LVDS display bridge(LDB). More...
#define	LPCG_TUPLE(rsrc, base)   ((uint32_t)((((base) >> 12U) << 10U) | rsrc))
	LPCG TUPLE macors to map corresponding ip clock name, SCFW API resource index and LPCG Register base address. More...
#define	LPCG_TUPLE_REG_BASE(tuple)   ((volatile uint32_t *)((((uint32_t)(tuple) >> 10U) & 0xFFFFFU) << 12U))
	Get the LPCG REG base address. More...
#define	LPCG_TUPLE_RSRC(tuple)   ((sc_rsrc_t)((uint32_t)(tuple)&0x3FFU))
	Get the resource index. More...
#define	NV   (0U)
	LPCG Cell not available. More...

Enumerations
enum	clock_ip_src_t {   kCLOCK_IpSrcNone = 0U,   kCLOCK_IpSrcDummy = 1U }
	Clock source for peripherals that support various clock selections. More...
enum	clock_name_t {   kCLOCK_CoreSysClk,   kCLOCK_CONECTIVITY_AhbClk }
	Clock name used to get clock frequency. More...
enum	clock_ip_name_t
	Peripheral clock name difinition used for clock gate, clock source and clock divider setting. More...

Functions
void	CLOCK_Init (sc_ipc_t ipc)
	Initialize Clock module. More...
void	CLOCK_Deinit (void)
	Deinitialize Clock module.
bool	CLOCK_EnableClockExt (clock_ip_name_t name, uint32_t gate)
	Enable the clock for specific IP, with gate setting. More...
static bool	CLOCK_EnableClock (clock_ip_name_t name)
	Enable the clock for specific IP. More...
bool	CLOCK_DisableClock (clock_ip_name_t name)
	Disable the clock for specific IP. More...
uint32_t	CLOCK_SetIpFreq (clock_ip_name_t name, uint32_t freq)
	Set the clock frequency for specific IP module. More...
uint32_t	CLOCK_GetIpFreq (clock_ip_name_t name)
	Get the clock frequency for a specific IP module. More...
uint32_t	CLOCK_GetFreq (clock_name_t name)
	Gets the clock frequency for a specific clock name. More...
uint32_t	CLOCK_GetCoreSysClkFreq (void)
	Get the core clock or system clock frequency. More...
void	CLOCK_ConfigLPCG (clock_ip_name_t name, uint32_t swGate, uint32_t hwGate)
	Config the LPCG cell for specific IP. More...
void	CLOCK_SetLpcgGate (volatile uint32_t *regBase, uint32_t swGate, uint32_t hwGate, uint32_t bitsMask)
	Set LPCG gate for specific LPCG. More...
void	SDK_DelayAtLeastUs (uint32_t delay_us)
	Use DWT to delay at least for some time. More...

Driver version
#define	FSL_CLOCK_DRIVER_VERSION   (MAKE_VERSION(2, 2, 0))
	CLOCK driver version 2.2.0. More...

Macro Definition Documentation

#define FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL   0

When set to 0, peripheral drivers will enable clock in initialize function and disable clock in de-initialize function. When set to 1, peripheral driver will not control the clock, application could control the clock out of the driver.

Note

All drivers share this feature switcher. If it is set to 1, application should handle clock enable and disable for all drivers.

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

#define MU_CLOCKS

Value:

{                                                                                                                 \
        kCLOCK_M4_0_Mu0B, kCLOCK_M4_0_Mu0B, kCLOCK_M4_0_Mu0B, kCLOCK_M4_0_Mu0B, kCLOCK_M4_0_Mu0A0, kCLOCK_M4_0_Mu0A1, \
            kCLOCK_M4_0_Mu0A2, kCLOCK_M4_0_Mu0A3, kCLOCK_M4_0_Mu1A, kCLOCK_LSIO_Mu0A, kCLOCK_LSIO_Mu1A,               \
            kCLOCK_LSIO_Mu2A, kCLOCK_LSIO_Mu3A, kCLOCK_LSIO_Mu4A, kCLOCK_LSIO_Mu5A, kCLOCK_LSIO_Mu6A,                 \
            kCLOCK_LSIO_Mu7A, kCLOCK_LSIO_Mu8A, kCLOCK_LSIO_Mu9A, kCLOCK_LSIO_Mu10A, kCLOCK_LSIO_Mu11A,               \
            kCLOCK_LSIO_Mu12A, kCLOCK_LSIO_Mu13A, kCLOCK_LSIO_Mu5B, kCLOCK_LSIO_Mu6B, kCLOCK_LSIO_Mu7B,               \
            kCLOCK_LSIO_Mu8B, kCLOCK_LSIO_Mu9B, kCLOCK_LSIO_Mu10B, kCLOCK_LSIO_Mu11B, kCLOCK_LSIO_Mu12B,              \
            kCLOCK_LSIO_Mu13B,                                                                                        \
    }

#define GPIO_CLOCKS

Value:

{                                                                                                                 \
        kCLOCK_IpInvalid, kCLOCK_IpInvalid, kCLOCK_IpInvalid, kCLOCK_HSIO_Gpio, kCLOCK_LSIO_Gpio0, kCLOCK_LSIO_Gpio1, \
            kCLOCK_LSIO_Gpio2, kCLOCK_LSIO_Gpio3, kCLOCK_LSIO_Gpio4, kCLOCK_LSIO_Gpio5, kCLOCK_LSIO_Gpio6,            \
            kCLOCK_LSIO_Gpio7, kCLOCK_IpInvalid,                                                                      \
    }

#define FLEXSPI_CLOCKS

Value:

{                                               \
        kCLOCK_LSIO_Flexspi0, kCLOCK_LSIO_Flexspi1, \
    }

#define RGPIO_CLOCKS

Value:

{                      \
        kCLOCK_M4_0_Rgpio, \
    }

#define FTM_CLOCKS

Value:

{                                     \
        kCLOCK_DMA_Ftm0, kCLOCK_DMA_Ftm1, \
    }

#define GPT_CLOCKS

Value:

{                                                                                                  \
        kCLOCK_AUDIO_Gpt0, kCLOCK_AUDIO_Gpt1, kCLOCK_AUDIO_Gpt2, kCLOCK_AUDIO_Gpt3, kCLOCK_AUDIO_Gpt4, \
            kCLOCK_AUDIO_Gpt5, kCLOCK_LSIO_Gpt0, kCLOCK_LSIO_Gpt1, kCLOCK_LSIO_Gpt2, kCLOCK_LSIO_Gpt3, \
            kCLOCK_LSIO_Gpt4,                                                                          \
    }

#define FLEXCAN_CLOCKS

Value:

{                                                      \
        kCLOCK_DMA_Can0, kCLOCK_DMA_Can1, kCLOCK_DMA_Can2, \
    }

#define LPUART_CLOCKS

Value:

{                                                                                                       \
        kCLOCK_DMA_Lpuart0, kCLOCK_DMA_Lpuart1, kCLOCK_DMA_Lpuart2, kCLOCK_DMA_Lpuart3, kCLOCK_M4_0_Lpuart, \
            kCLOCK_SCU_Lpuart,                                                                              \
    }

#define LPADC_CLOCKS

Value:

{                       \
        kCLOCK_ADMA_Lpadc0, \
    }

#define INTMUX_CLOCKS

Value:

{                       \
        kCLOCK_M4_0_Intmux, \
    }

#define SAI_CLOCKS

Value:

{                                                                                                  \
        kCLOCK_AUDIO_Sai0, kCLOCK_AUDIO_Sai1, kCLOCK_AUDIO_Sai2, kCLOCK_AUDIO_Sai3, kCLOCK_AUDIO_Sai4, \
            kCLOCK_AUDIO_Sai5,                                                                         \
    }

#define SEMA42_CLOCKS

Value:

{                                          \
        kCLOCK_M4_0_Sema42, kCLOCK_SCU_Sema42, \
    }

#define TPM_CLOCKS

Value:

{                                    \
        kCLOCK_M4_0_Tpm, kCLOCK_SCU_Tpm, \
    }

#define LPIT_CLOCKS

Value:

{                                      \
        kCLOCK_M4_0_Lpit, kCLOCK_SCU_Lpit, \
    }

#define LPI2C_CLOCKS

Value:

{                                                                                                                 \
        kCLOCK_DMA_Lpi2c0, kCLOCK_DMA_Lpi2c1, kCLOCK_DMA_Lpi2c2, kCLOCK_DMA_Lpi2c3, kCLOCK_CiPiLpi2c,                 \
            kCLOCK_M4_0_Lpi2c, kCLOCK_DiMiPiDsiLvds0Lpi2c0, kCLOCK_DiMiPiDsiLvds0Lpi2c1, kCLOCK_DiMiPiDsiLvds1Lpi2c0, \
            kCLOCK_DiMiPiDsiLvds1Lpi2c1, kCLOCK_MipiCsiLpi2c, kCLOCK_SCU_Lpi2c,                                       \
    }

#define LPSPI_CLOCKS

Value:

{                                                                               \
        kCLOCK_DMA_Lpspi0, kCLOCK_DMA_Lpspi1, kCLOCK_DMA_Lpspi2, kCLOCK_DMA_Lpspi3, \
    }

#define EDMA_CLOCKS

Value:

{                    \
        kCLOCK_DMA_Dma0, \
    }

#define ESAI_CLOCKS

Value:

{                                           \
        kCLOCK_AUDIO_Esai0, kCLOCK_AUDIO_Esai1, \
    }

#define ISI_CLOCKS

Value:

{                                                                                                            \
        kCLOCK_IMAGING_Isi0, kCLOCK_IMAGING_Isi1, kCLOCK_IMAGING_Isi2, kCLOCK_IMAGING_Isi3, kCLOCK_IMAGING_Isi4, \
            kCLOCK_IMAGING_Isi5, kCLOCK_IMAGING_Isi6, kCLOCK_IMAGING_Isi7,                                       \
    }

#define MIPI_CSI2RX_CLOCKS

Value:

{                       \
        kCLOCK_MipiCsi2Rx0, \
    }

#define MIPI_DSI_HOST_CLOCKS

Value:

{                                            \
        kCLOCK_MipiDsiHost0, kCLOCK_MipiDsiHost1 \
    }

#define ENET_CLOCKS

Value:

{                                                        \
        kCLOCK_CONNECTIVITY_Enet0, kCLOCK_CONNECTIVITY_Enet1 \
    }

#define DPU_CLOCKS

Value:

{                \
        kCLOCK_Dpu0, \
    }

#define CI_PI_CLOCKS

Value:

{                 \
        kCLOCK_CiPi0, \
    }

#define CAAM_CLOCKS

Value:

{                                                      \
        kCLOCK_CAAM_JR1, kCLOCK_CAAM_JR2, kCLOCK_CAAM_JR3, \
    }

#define LDB_CLOCKS

Value:

{                            \
        kCLOCK_Ldb0, kCLOCK_Ldb1 \
    }

#define LPCG_TUPLE	(		rsrc,
			base
	)		((uint32_t)((((base) >> 12U) << 10U) | rsrc))

The LPCG base should be 4KB aligned, if not it will be truncated.

#define LPCG_TUPLE_REG_BASE

(

tuple

)

((volatile uint32_t *)((((uint32_t)(tuple) >> 10U) & 0xFFFFFU) << 12U))

#define LPCG_TUPLE_RSRC

(

tuple

)

((sc_rsrc_t)((uint32_t)(tuple)&0x3FFU))

#define NV   (0U)

Enumeration Type Documentation

enum clock_ip_src_t

Enumerator
kCLOCK_IpSrcNone	Clock is off.
kCLOCK_IpSrcDummy	Clock option 1.

enum clock_name_t

Enumerator
kCLOCK_CoreSysClk	Core/system clock for M4.
kCLOCK_CONECTIVITY_AhbClk	AHB clock in Connectivity subsystem.

enum clock_ip_name_t

It is defined as the corresponding register address.

Function Documentation

void CLOCK_Init

(

sc_ipc_t

ipc

)

Parameters

ipc	IPC handle for communication with SCU, see sc_ipc_t.

bool CLOCK_EnableClockExt	(	clock_ip_name_t	name,
		uint32_t	gate
	)

Parameters

name	Which clock to enable, see clock_ip_name_t.
gate	0: clock always on, 1: HW auto clock gating.

Returns

true if success, false if failure.

static bool CLOCK_EnableClock ( clock_ip_name_t  name )

inlinestatic

Parameters

name	Which clock to enable, see clock_ip_name_t.

Returns

true for success, false for failure.

bool CLOCK_DisableClock

(

clock_ip_name_t

name

)

Parameters

name	Which clock to disable, see clock_ip_name_t.

Returns

true for success, false for failure.

uint32_t CLOCK_SetIpFreq	(	clock_ip_name_t	name,
		uint32_t	freq
	)

This function sets the IP module clock frequency.

Parameters

name	Which peripheral to check, see clock_ip_name_t.
freq	Target clock frequency value in hertz.

Returns

the Real clock frequency value in hertz, or 0 if failed

uint32_t CLOCK_GetIpFreq

(

clock_ip_name_t

name

)

This function gets the IP module clock frequency.

Parameters

name	Which peripheral to get, see clock_ip_name_t.

Returns

Clock frequency value in hertz, or 0 if failed

uint32_t CLOCK_GetFreq

(

clock_name_t

name

)

This function checks the current clock configurations and then calculates the clock frequency for a specific clock name defined in clock_name_t.

Parameters

clockName

Clock names defined in clock_name_t

Returns

Clock frequency value in hertz

uint32_t CLOCK_GetCoreSysClkFreq

(

void

)

Returns

Clock frequency in Hz.

void CLOCK_ConfigLPCG	(	clock_ip_name_t	name,
		uint32_t	swGate,
		uint32_t	hwGate
	)

Parameters

name	Which clock to enable, see clock_ip_name_t.
swGate	Software clock gating. 0: clock is gated; 1: clock is enabled
swGate	Hardware auto gating. 0: disable the HW clock gate control; 1: HW clock gating is enabled

void CLOCK_SetLpcgGate	(	volatile uint32_t *	regBase,
		uint32_t	swGate,
		uint32_t	hwGate,
		uint32_t	bitsMask
	)

Parameters

regBase	LPCG register base address.
swGate	Software clock gating. 0: clock is gated; 1: clock is enabled
swGate	Hardware auto gating. 0: disable the HW clock gate control; 1: HW clock gating is enabled
bitsMask	The available bits in LPCG register. Each bit indicate the corresponding bit is available or not.

void SDK_DelayAtLeastUs

(

uint32_t

delay_us

)

Please note that, this API will calculate the microsecond period with the maximum supported CPU frequency, so this API will only delay for at least the given microseconds, if precise delay count was needed, please implement a new timer count to achieve this function.

Parameters

delay_us

Delay time in unit of microsecond.