Contains API prototypes for the CLKCTRL (Clock Controller) driver. More...

Files
file	driver_clkctrl.c
	Implements APIs for the CLKCTRL (Clock Controller) driver.

Functions
void	CLKCTRL_ModifyMainControlA (uint8_t groupMask, uint8_t groupConfig)
	Modifies specific bit field(s) in the MCLKCTRLA register.
void	CLKCTRL_WriteMainControlB (uint8_t value)
	Overwrites the MCLKCTRLB register value.
void	CLKCTRL_SetMainControlC (uint8_t bitmask)
	Sets specific bits in the MCLKCTRLC register.
uint8_t	CLKCTRL_ReadIntControl (void)
	Reads the MCLKINTCTRL register value.
void	CLKCTRL_WriteIntControl (uint8_t value)
	Overwrites the MCLKINTCTRL register value.
void	CLKCTRL_SetIntControl (uint8_t bitmask)
	Sets specific bits in the MCLKINTCTRL register.
void	CLKCTRL_ClearIntControl (uint8_t bitmask)
	Clears specific bits in the MCLKINTCTRL register.
uint8_t	CLKCTRL_ReadIntFlags (void)
	Reads the MCLKINTFLAGS register value.
void	CLKCTRL_WriteIntFlags (uint8_t value)
	Overwrites the MCLKINTFLAGS register value.
uint8_t	CLKCTRL_ReadCfd0ControlA (void)
	Reads the MCLKCFD0CTRLA register value.
void	CLKCTRL_WriteCfd0ControlA (uint8_t value)
	Overwrites the MCLKCFD0CTRLA register value.
void	CLKCTRL_SetCfd0ControlA (uint8_t bitmask)
	Sets specific bits in the MCLKCFD0CTRLA register.
void	CLKCTRL_ClearCfd0ControlA (uint8_t bitmask)
	Clears specific bits in the MCLKCFD0CTRLA register.
uint8_t	CLKCTRL_ReadCfd1ControlA (void)
	Reads the MCLKCFD1CTRLA register value.
void	CLKCTRL_WriteCfd1ControlA (uint8_t value)
	Overwrites the MCLKCFD1CTRLA register value.
void	CLKCTRL_SetCfd1ControlA (uint8_t bitmask)
	Sets specific bits in the MCLKCFD1CTRLA register.
void	CLKCTRL_ClearCfd1ControlA (uint8_t bitmask)
	Clears specific bits in the MCLKCFD1CTRLA register.
uint16_t	CLKCTRL_ReadCfm0WindowLow (void)
	Reads the MCLKCFM0WINLT register value.
void	CLKCTRL_WriteCfm0WindowLow (uint16_t value)
	Overwrites the MCLKCFM0WINLT register value.
uint16_t	CLKCTRL_ReadCfm0WindowHigh (void)
	Reads the MCLKCFM0WINHT register value.
void	CLKCTRL_WriteCfm0WindowHigh (uint16_t value)
	Overwrites the MCLKCFM0WINHT register value.
uint16_t	CLKCTRL_ReadCfm0RefNum (void)
	Reads the MCLKCFM0REFNUM register value.
void	CLKCTRL_WriteCfm0RefNum (uint16_t value)
	Overwrites the MCLKCFM0REFNUM register value.
uint8_t	CLKCTRL_ReadCfm0ControlA (void)
	Reads the MCLKCFM0CTRLA register value.
void	CLKCTRL_WriteCfm0ControlA (uint8_t value)
	Overwrites the MCLKCFM0CTRLA register value.
void	CLKCTRL_ClearCfm0ControlA (uint8_t bitmask)
	Clears specific bits in the MCLKCFM0CTRLA register.
uint8_t	CLKCTRL_ReadCfm0ControlB (void)
	Reads the MCLKCFM0CTRLB register value.
void	CLKCTRL_WriteCfm0ControlB (uint8_t value)
	Overwrites the MCLKCFM0CTRLB register value.
uint16_t	CLKCTRL_ReadCfm1WindowLow (void)
	Reads the MCLKCFM1WINLT register value.
void	CLKCTRL_WriteCfm1WindowLow (uint16_t value)
	Overwrites the MCLKCFM1WINLT register value.
uint16_t	CLKCTRL_ReadCfm1WindowHigh (void)
	Reads the MCLKCFM1WINHT register value.
void	CLKCTRL_WriteCfm1WindowHigh (uint16_t value)
	Overwrites the MCLKCFM1WINHT register value.
uint16_t	CLKCTRL_ReadCfm1RefNum (void)
	Reads the MCLKCFM1REFNUM register value.
void	CLKCTRL_WriteCfm1RefNum (uint16_t value)
	Overwrites the MCLKCFM1REFNUM register value.
uint8_t	CLKCTRL_ReadCfm1ControlA (void)
	Reads the MCLKCFM1CTRLA register value.
void	CLKCTRL_WriteCfm1ControlA (uint8_t value)
	Overwrites the MCLKCFM1CTRLA register value.
void	CLKCTRL_ClearCfm1ControlA (uint8_t bitmask)
	Clears specific bits in the MCLKCFM1CTRLA register.
uint8_t	CLKCTRL_ReadCfm1ControlB (void)
	Reads the MCLKCFM1CTRLB register value.
void	CLKCTRL_WriteCfm1ControlB (uint8_t value)
	Overwrites the MCLKCFM1CTRLB register value.
void	CLKCTRL_ModifyOscHfControlA (uint8_t groupMask, uint8_t groupConfig)
	Modifies specific bit field(s) in the OSCHFCTRLA register.

Detailed Description

Contains API prototypes for the CLKCTRL (Clock Controller) driver.

Version: 1.0.0-alpha.1

These APIs provide direct register access and have no functional knowledge of the register interface. No input or output validation is performed in the drivers. It is the responsibility of the calling function to use them correctly according to the register interface specification.

Copyright: © 2025 Microchip Technology Inc. and its subsidiaries.

Subject to your compliance with these terms, you may use Microchip software and any derivatives exclusively with Microchip products. It is your responsibility to comply with third party license terms applicable to your use of third party software (including open source software) that may accompany Microchip software.

THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.

UML Class Diagrams

Function Documentation

◆ CLKCTRL_ClearCfd0ControlA()

void CLKCTRL_ClearCfd0ControlA ( uint8_t bitmask )

Clears specific bits in the MCLKCFD0CTRLA register.

Parameters

bitmask Specifies which bits to clear.

Definition at line 103 of file driver_clkctrl.c.

◆ CLKCTRL_ClearCfd1ControlA()

void CLKCTRL_ClearCfd1ControlA ( uint8_t bitmask )

Clears specific bits in the MCLKCFD1CTRLA register.

Parameters

bitmask Specifies which bits to clear.

Definition at line 127 of file driver_clkctrl.c.

◆ CLKCTRL_ClearCfm0ControlA()

void CLKCTRL_ClearCfm0ControlA ( uint8_t bitmask )

Clears specific bits in the MCLKCFM0CTRLA register.

Parameters

bitmask Specifies which bits to clear.

Definition at line 174 of file driver_clkctrl.c.

◆ CLKCTRL_ClearCfm1ControlA()

void CLKCTRL_ClearCfm1ControlA ( uint8_t bitmask )

Clears specific bits in the MCLKCFM1CTRLA register.

Parameters

bitmask Specifies which bits to clear.

Definition at line 231 of file driver_clkctrl.c.

◆ CLKCTRL_ClearIntControl()

void CLKCTRL_ClearIntControl ( uint8_t bitmask )

Clears specific bits in the MCLKINTCTRL register.

Parameters

bitmask Specifies which bits to clear.

Definition at line 69 of file driver_clkctrl.c.

◆ CLKCTRL_ModifyMainControlA()

void CLKCTRL_ModifyMainControlA	(	uint8_t	groupMask,
		uint8_t	groupConfig )

Modifies specific bit field(s) in the MCLKCTRLA register.

Parameters

groupMask	Specifies which bit field values to modify (clear and write).
groupConfig	Specifies the bit pattern to write to the specified bit fields.

Definition at line 30 of file driver_clkctrl.c.

◆ CLKCTRL_ModifyOscHfControlA()

void CLKCTRL_ModifyOscHfControlA	(	uint8_t	groupMask,
		uint8_t	groupConfig )

Modifies specific bit field(s) in the OSCHFCTRLA register.

Parameters

groupMask	Specifies which bit field values to modify (clear and write).
groupConfig	Specifies the bit pattern to write to the specified bit fields.

Definition at line 248 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfd0ControlA()

uint8_t CLKCTRL_ReadCfd0ControlA ( void )

Reads the MCLKCFD0CTRLA register value.

Returns: The read value.

Definition at line 86 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfd1ControlA()

uint8_t CLKCTRL_ReadCfd1ControlA ( void )

Reads the MCLKCFD1CTRLA register value.

Returns: The read value.

Definition at line 110 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm0ControlA()

uint8_t CLKCTRL_ReadCfm0ControlA ( void )

Reads the MCLKCFM0CTRLA register value.

Returns: The read value.

Definition at line 164 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm0ControlB()

uint8_t CLKCTRL_ReadCfm0ControlB ( void )

Reads the MCLKCFM0CTRLB register value.

Returns: The read value.

Definition at line 181 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm0RefNum()

uint16_t CLKCTRL_ReadCfm0RefNum ( void )

Reads the MCLKCFM0REFNUM register value.

Returns: The read value.

Definition at line 154 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm0WindowHigh()

uint16_t CLKCTRL_ReadCfm0WindowHigh ( void )

Reads the MCLKCFM0WINHT register value.

Returns: The read value.

Definition at line 144 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm0WindowLow()

uint16_t CLKCTRL_ReadCfm0WindowLow ( void )

Reads the MCLKCFM0WINLT register value.

Returns: The read value.

Definition at line 134 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm1ControlA()

uint8_t CLKCTRL_ReadCfm1ControlA ( void )

Reads the MCLKCFM1CTRLA register value.

Returns: The read value.

Definition at line 221 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm1ControlB()

uint8_t CLKCTRL_ReadCfm1ControlB ( void )

Reads the MCLKCFM1CTRLB register value.

Returns: The read value.

Definition at line 238 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm1RefNum()

uint16_t CLKCTRL_ReadCfm1RefNum ( void )

Reads the MCLKCFM1REFNUM register value.

Returns: The read value.

Definition at line 211 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm1WindowHigh()

uint16_t CLKCTRL_ReadCfm1WindowHigh ( void )

Reads the MCLKCFM1WINHT register value.

Returns: The read value.

Definition at line 201 of file driver_clkctrl.c.

◆ CLKCTRL_ReadCfm1WindowLow()

uint16_t CLKCTRL_ReadCfm1WindowLow ( void )

Reads the MCLKCFM1WINLT register value.

Returns: The read value.

Definition at line 191 of file driver_clkctrl.c.

◆ CLKCTRL_ReadIntControl()

uint8_t CLKCTRL_ReadIntControl ( void )

Reads the MCLKINTCTRL register value.

Returns: The read value.

Definition at line 52 of file driver_clkctrl.c.

◆ CLKCTRL_ReadIntFlags()

uint8_t CLKCTRL_ReadIntFlags ( void )

Reads the MCLKINTFLAGS register value.

Returns: The read value.

Definition at line 76 of file driver_clkctrl.c.

◆ CLKCTRL_SetCfd0ControlA()

void CLKCTRL_SetCfd0ControlA ( uint8_t bitmask )

Sets specific bits in the MCLKCFD0CTRLA register.

Parameters

bitmask Specifies which bits to set.

Definition at line 96 of file driver_clkctrl.c.

◆ CLKCTRL_SetCfd1ControlA()

void CLKCTRL_SetCfd1ControlA ( uint8_t bitmask )

Sets specific bits in the MCLKCFD1CTRLA register.

Parameters

bitmask Specifies which bits to set.

Definition at line 120 of file driver_clkctrl.c.

◆ CLKCTRL_SetIntControl()

void CLKCTRL_SetIntControl ( uint8_t bitmask )

Sets specific bits in the MCLKINTCTRL register.

Parameters

bitmask Specifies which bits to set.

Definition at line 62 of file driver_clkctrl.c.

◆ CLKCTRL_SetMainControlC()

void CLKCTRL_SetMainControlC ( uint8_t bitmask )

Sets specific bits in the MCLKCTRLC register.

Parameters

bitmask Specifies which bits to set.

Definition at line 45 of file driver_clkctrl.c.