nxp_mcxw7x_clock.h File Reference

DT binding macros for NXP MCXW7x clock controller. More...

Go to the source code of this file.

Macros
OSC32K Mode
#define	MCXW_CLK_OSC32K_DISABLE   0
	Disable 32K oscillator mode.
#define	MCXW_CLK_OSC32K_ENABLE   1
	Enable 32K oscillator mode.
#define	MCXW_CLK_OSC32K_BYPASS   3
	Bypass 32K oscillator (external clock).
OSC32K XTAL/EXTAL internal load capacitance
Selects the internal capacitance applied from the OSC32K cap bank. Value N maps to 2*N pF (0 pF .. 30 pF).
#define	MCXW_CLK_OSC32K_CAP_0PF   0
	0 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_2PF   1
	2 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_4PF   2
	4 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_6PF   3
	6 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_8PF   4
	8 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_10PF   5
	10 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_12PF   6
	12 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_14PF   7
	14 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_16PF   8
	16 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_18PF   9
	18 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_20PF   10
	20 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_22PF   11
	22 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_24PF   12
	24 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_26PF   13
	26 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_28PF   14
	28 pF internal capacitance.
#define	MCXW_CLK_OSC32K_CAP_30PF   15
	30 pF internal capacitance.
OSC32K coarse amplifier gain adjustment
Selects the 32 kHz crystal oscillator amplifier coarse gain, used to match the external crystal ESR range.
#define	MCXW_CLK_OSC32K_COARSE_RANGE0   0
	Coarse amplifier gain Range0.
#define	MCXW_CLK_OSC32K_COARSE_RANGE1   1
	Coarse amplifier gain Range1.
#define	MCXW_CLK_OSC32K_COARSE_RANGE2   2
	Coarse amplifier gain Range2.
#define	MCXW_CLK_OSC32K_COARSE_RANGE3   3
	Coarse amplifier gain Range3.
FIRC Mode
#define	MCXW_CLK_FIRC_DISABLE   0
	Disable FIRC.
#define	MCXW_CLK_FIRC_ENABLE   1
	Enable FIRC.
#define	MCXW_CLK_FIRC_ENABLE_IN_LP   2
	Enable FIRC in low-power mode.
FIRC Range
#define	MCXW_CLK_FIRC_RANGE_48MHZ   0
	FIRC range: 48 MHz.
#define	MCXW_CLK_FIRC_RANGE_64MHZ   1
	FIRC range: 64 MHz.
#define	MCXW_CLK_FIRC_RANGE_96MHZ   2
	FIRC range: 96 MHz.
#define	MCXW_CLK_FIRC_RANGE_192MHZ   3
	FIRC range: 192 MHz.
System clock source
#define	MCXW_CLK_SYSTEM_CLK_SRC_SOSC   1
	System clock: SOSC (external oscillator).
#define	MCXW_CLK_SYSTEM_CLK_SRC_SIRC   2
	System clock: SIRC (internal slow RC).
#define	MCXW_CLK_SYSTEM_CLK_SRC_FIRC   3
	System clock: FIRC (fast internal RC).
#define	MCXW_CLK_SYSTEM_CLK_SRC_ROSC   4
	System clock: ROSC (ring oscillator).
System clock dividers
Values map to kSCG_SysClkDivByX definitions used by MCXW platform code.
#define	MCXW_CLK_DIV_NONE   0
	No divider change, equal to MCXW_CLK_DIV_BY_1.
#define	MCXW_CLK_DIV_BY_1   0
	Divide by 1.
#define	MCXW_CLK_DIV_BY_2   1
	Divide by 2.
#define	MCXW_CLK_DIV_BY_3   2
	Divide by 3.
#define	MCXW_CLK_DIV_BY_4   3
	Divide by 4.
#define	MCXW_CLK_DIV_BY_5   4
	Divide by 5.
#define	MCXW_CLK_DIV_BY_6   5
	Divide by 6.
#define	MCXW_CLK_DIV_BY_7   6
	Divide by 7.
#define	MCXW_CLK_DIV_BY_8   7
	Divide by 8.
#define	MCXW_CLK_DIV_BY_10   9
	Divide by 10.
#define	MCXW_CLK_DIV_BY_11   10
	Divide by 11.
#define	MCXW_CLK_DIV_BY_12   11
	Divide by 12.
#define	MCXW_CLK_DIV_BY_13   12
	Divide by 13.
#define	MCXW_CLK_DIV_BY_14   13
	Divide by 14.
#define	MCXW_CLK_DIV_BY_15   14
	Divide by 15.
#define	MCXW_CLK_DIV_BY_16   15
	Divide by 16.
IP mux clock sources
Values used to select the peripheral clock source via ip mux selection.
#define	MCXW_CLK_IP_MUX_SLOW_CLK   1
	Slow clock source.
#define	MCXW_CLK_IP_MUX_FRO_6M   2
	FRO 6 MHz clock (kCLOCK_IpSrcFro6M).
#define	MCXW_CLK_IP_MUX_FRO_192M_DIV   3
	FRO 192 MHz divided clock (frequency depends on range).
#define	MCXW_CLK_IP_MUX_SOSC   4
	SOSC: RF oscillator clock (kCLOCK_IpSrcSoscClk).
#define	MCXW_CLK_IP_MUX_32K   5
	32 kHz clock (kCLOCK_IpSrc32kClk).
#define	MCXW_CLK_IP_MUX_FRO_200M_DIV   6
	FRO 200 MHz (for CAN); only MCXW70 supports this.
#define	MCXW_CLK_IP_MUX_1M   7
	1 MHz derived from FRO6M; only MCXW70 supports this.
#define	MCXW_CLK_IP_MUX_NONE   0xFF
	No IP mux selection / invalid value.
Clock control flags
These flags match the kCLOCK_IpClkControl_xxx values used by the driver.
#define	MCXW_CLK_CTRL_DISABLED   0
	Clock disabled (kCLOCK_IpClkControl_fun0).
#define	MCXW_CLK_CTRL_ENABLED   1U
	Clock enabled (kCLOCK_IpClkControl_fun1).
Low power behavior flags
#define	MCXW_CLK_LP_STALL_ALLOWED   0U
	Clock can prevent low-power entry (will stall).
#define	MCXW_CLK_LP_NO_STALL   2U
	Clock won't prevent low-power entry (no stall).
Combined control modes
#define	MCXW_CLK_MODE_DISABLED   (MCXW_CLK_CTRL_DISABLED)
	Disabled mode.
#define	MCXW_CLK_MODE_ENABLED_LP_STALL   (MCXW_CLK_CTRL_ENABLED | MCXW_CLK_LP_STALL_ALLOWED)
	Enabled; may stall LP.
#define	MCXW_CLK_MODE_ENABLED_LP_NO_STALL   (MCXW_CLK_CTRL_ENABLED | MCXW_CLK_LP_NO_STALL)
	Enabled; won't stall LP.
#define	MCXW_CLOCK(mrcc_offset, clk_mux, clk_div, flag)
	Helper macro to encode a clock configuration into a 32-bit integer used in device tree bindings.

Detailed Description

DT binding macros for NXP MCXW7x clock controller.

These macros are used by device tree clock binding properties to describe clock modes, sources, dividers and control flags for MCXW devices.

Macro Definition Documentation

MCXW_CLK_CTRL_DISABLED

#define MCXW_CLK_CTRL_DISABLED   0

Clock disabled (kCLOCK_IpClkControl_fun0).

MCXW_CLK_CTRL_ENABLED

#define MCXW_CLK_CTRL_ENABLED   1U

Clock enabled (kCLOCK_IpClkControl_fun1).

MCXW_CLK_DIV_BY_1

#define MCXW_CLK_DIV_BY_1   0

Divide by 1.

MCXW_CLK_DIV_BY_10

#define MCXW_CLK_DIV_BY_10   9

Divide by 10.

MCXW_CLK_DIV_BY_11

#define MCXW_CLK_DIV_BY_11   10

Divide by 11.

MCXW_CLK_DIV_BY_12

#define MCXW_CLK_DIV_BY_12   11

Divide by 12.

MCXW_CLK_DIV_BY_13

#define MCXW_CLK_DIV_BY_13   12

Divide by 13.

MCXW_CLK_DIV_BY_14

#define MCXW_CLK_DIV_BY_14   13

Divide by 14.

MCXW_CLK_DIV_BY_15

#define MCXW_CLK_DIV_BY_15   14

Divide by 15.

MCXW_CLK_DIV_BY_16

#define MCXW_CLK_DIV_BY_16   15

Divide by 16.

MCXW_CLK_DIV_BY_2

#define MCXW_CLK_DIV_BY_2   1

Divide by 2.

MCXW_CLK_DIV_BY_3

#define MCXW_CLK_DIV_BY_3   2

Divide by 3.

MCXW_CLK_DIV_BY_4

#define MCXW_CLK_DIV_BY_4   3

Divide by 4.

MCXW_CLK_DIV_BY_5

#define MCXW_CLK_DIV_BY_5   4

Divide by 5.

MCXW_CLK_DIV_BY_6

#define MCXW_CLK_DIV_BY_6   5

Divide by 6.

MCXW_CLK_DIV_BY_7

#define MCXW_CLK_DIV_BY_7   6

Divide by 7.

MCXW_CLK_DIV_BY_8

#define MCXW_CLK_DIV_BY_8   7

Divide by 8.

MCXW_CLK_DIV_NONE

#define MCXW_CLK_DIV_NONE   0

No divider change, equal to MCXW_CLK_DIV_BY_1.

MCXW_CLK_FIRC_DISABLE

#define MCXW_CLK_FIRC_DISABLE   0

Disable FIRC.

MCXW_CLK_FIRC_ENABLE

#define MCXW_CLK_FIRC_ENABLE   1

Enable FIRC.

MCXW_CLK_FIRC_ENABLE_IN_LP

#define MCXW_CLK_FIRC_ENABLE_IN_LP   2

Enable FIRC in low-power mode.

MCXW_CLK_FIRC_RANGE_192MHZ

#define MCXW_CLK_FIRC_RANGE_192MHZ   3

FIRC range: 192 MHz.

MCXW_CLK_FIRC_RANGE_48MHZ

#define MCXW_CLK_FIRC_RANGE_48MHZ   0

FIRC range: 48 MHz.

MCXW_CLK_FIRC_RANGE_64MHZ

#define MCXW_CLK_FIRC_RANGE_64MHZ   1

FIRC range: 64 MHz.

MCXW_CLK_FIRC_RANGE_96MHZ

#define MCXW_CLK_FIRC_RANGE_96MHZ   2

FIRC range: 96 MHz.

MCXW_CLK_IP_MUX_1M

#define MCXW_CLK_IP_MUX_1M   7

1 MHz derived from FRO6M; only MCXW70 supports this.

MCXW_CLK_IP_MUX_32K

#define MCXW_CLK_IP_MUX_32K   5

32 kHz clock (kCLOCK_IpSrc32kClk).

MCXW_CLK_IP_MUX_FRO_192M_DIV

#define MCXW_CLK_IP_MUX_FRO_192M_DIV   3

FRO 192 MHz divided clock (frequency depends on range).

MCXW_CLK_IP_MUX_FRO_200M_DIV

#define MCXW_CLK_IP_MUX_FRO_200M_DIV   6

FRO 200 MHz (for CAN); only MCXW70 supports this.

MCXW_CLK_IP_MUX_FRO_6M

#define MCXW_CLK_IP_MUX_FRO_6M   2

FRO 6 MHz clock (kCLOCK_IpSrcFro6M).

Note

ERR052742: the FRO6M clock (kCLOCK_IpSrcFro6M) may be unstable on some parts: it can output a lower-than-expected frequency after reset or low- power wakeup. Avoid using FRO6M where stability is required; prefer higher-frequency FRO sources when possible.

MCXW_CLK_IP_MUX_NONE

#define MCXW_CLK_IP_MUX_NONE   0xFF

No IP mux selection / invalid value.

MCXW_CLK_IP_MUX_SLOW_CLK

#define MCXW_CLK_IP_MUX_SLOW_CLK   1

Slow clock source.

MCXW_CLK_IP_MUX_SOSC

#define MCXW_CLK_IP_MUX_SOSC   4

SOSC: RF oscillator clock (kCLOCK_IpSrcSoscClk).

MCXW_CLK_LP_NO_STALL

#define MCXW_CLK_LP_NO_STALL   2U

Clock won't prevent low-power entry (no stall).

MCXW_CLK_LP_STALL_ALLOWED

#define MCXW_CLK_LP_STALL_ALLOWED   0U

Clock can prevent low-power entry (will stall).

MCXW_CLK_MODE_DISABLED

#define MCXW_CLK_MODE_DISABLED   (MCXW_CLK_CTRL_DISABLED)

Disabled mode.

MCXW_CLK_MODE_ENABLED_LP_NO_STALL

#define MCXW_CLK_MODE_ENABLED_LP_NO_STALL   (MCXW_CLK_CTRL_ENABLED | MCXW_CLK_LP_NO_STALL)

Enabled; won't stall LP.

MCXW_CLK_MODE_ENABLED_LP_STALL

#define MCXW_CLK_MODE_ENABLED_LP_STALL   (MCXW_CLK_CTRL_ENABLED | MCXW_CLK_LP_STALL_ALLOWED)

Enabled; may stall LP.

MCXW_CLK_OSC32K_BYPASS

#define MCXW_CLK_OSC32K_BYPASS   3

Bypass 32K oscillator (external clock).

MCXW_CLK_OSC32K_CAP_0PF

#define MCXW_CLK_OSC32K_CAP_0PF   0

0 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_10PF

#define MCXW_CLK_OSC32K_CAP_10PF   5

10 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_12PF

#define MCXW_CLK_OSC32K_CAP_12PF   6

12 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_14PF

#define MCXW_CLK_OSC32K_CAP_14PF   7

14 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_16PF

#define MCXW_CLK_OSC32K_CAP_16PF   8

16 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_18PF

#define MCXW_CLK_OSC32K_CAP_18PF   9

18 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_20PF

#define MCXW_CLK_OSC32K_CAP_20PF   10

20 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_22PF

#define MCXW_CLK_OSC32K_CAP_22PF   11

22 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_24PF

#define MCXW_CLK_OSC32K_CAP_24PF   12

24 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_26PF

#define MCXW_CLK_OSC32K_CAP_26PF   13

26 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_28PF

#define MCXW_CLK_OSC32K_CAP_28PF   14

28 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_2PF

#define MCXW_CLK_OSC32K_CAP_2PF   1

2 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_30PF

#define MCXW_CLK_OSC32K_CAP_30PF   15

30 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_4PF

#define MCXW_CLK_OSC32K_CAP_4PF   2

4 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_6PF

#define MCXW_CLK_OSC32K_CAP_6PF   3

6 pF internal capacitance.

MCXW_CLK_OSC32K_CAP_8PF

#define MCXW_CLK_OSC32K_CAP_8PF   4

8 pF internal capacitance.

MCXW_CLK_OSC32K_COARSE_RANGE0

#define MCXW_CLK_OSC32K_COARSE_RANGE0   0

Coarse amplifier gain Range0.

MCXW_CLK_OSC32K_COARSE_RANGE1

#define MCXW_CLK_OSC32K_COARSE_RANGE1   1

Coarse amplifier gain Range1.

MCXW_CLK_OSC32K_COARSE_RANGE2

#define MCXW_CLK_OSC32K_COARSE_RANGE2   2

Coarse amplifier gain Range2.

MCXW_CLK_OSC32K_COARSE_RANGE3

#define MCXW_CLK_OSC32K_COARSE_RANGE3   3

Coarse amplifier gain Range3.

MCXW_CLK_OSC32K_DISABLE

#define MCXW_CLK_OSC32K_DISABLE   0

Disable 32K oscillator mode.

MCXW_CLK_OSC32K_ENABLE

#define MCXW_CLK_OSC32K_ENABLE   1

Enable 32K oscillator mode.

MCXW_CLK_SYSTEM_CLK_SRC_FIRC

#define MCXW_CLK_SYSTEM_CLK_SRC_FIRC   3

System clock: FIRC (fast internal RC).

MCXW_CLK_SYSTEM_CLK_SRC_ROSC

#define MCXW_CLK_SYSTEM_CLK_SRC_ROSC   4

System clock: ROSC (ring oscillator).

MCXW_CLK_SYSTEM_CLK_SRC_SIRC

#define MCXW_CLK_SYSTEM_CLK_SRC_SIRC   2

System clock: SIRC (internal slow RC).

MCXW_CLK_SYSTEM_CLK_SRC_SOSC

#define MCXW_CLK_SYSTEM_CLK_SRC_SOSC   1

System clock: SOSC (external oscillator).

MCXW_CLOCK

#define MCXW_CLOCK	(		mrcc_offset,
			clk_mux,
			clk_div,
			flag )

Value:

((((mrcc_offset) & 0xFFFF) << 16) | (((clk_mux) & 0xFF) << 8) | (((clk_div) & 0xF) << 4) | \
 (((flag) & 0xF)))

Helper macro to encode a clock configuration into a 32-bit integer used in device tree bindings.

Bit layout (from MSB to LSB):

• [31:16] mrcc_offset (16 bits)
• [15:8] clk_mux (8 bits)
• [7:4] clk_div (4 bits)
• [3:0] flag (4 bits)

Parameters

mrcc_offset	MRCC register offset (16-bit)
clk_mux	Clock multiplexer selection (8-bit)
clk_div	Clock divider value (4-bit)
flag	Control/behavior flags (4-bit)