midware_clock_manager.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include <define_error_flags.h>
#include <xc.h>

Go to the source code of this file.

Data Structures
struct	cfmWindow_t
	Struct for configuring the Clock Frequency Measure window. More...

Enumerations
enum	clkFrq_t {   CLK_FRQ_1_MHZ = CLKCTRL_FRQSEL_1M_gc >> CLKCTRL_FRQSEL_gp , CLK_FRQ_2_MHZ = CLKCTRL_FRQSEL_2M_gc >> CLKCTRL_FRQSEL_gp , CLK_FRQ_3_MHZ = CLKCTRL_FRQSEL_3M_gc >> CLKCTRL_FRQSEL_gp , CLK_FRQ_4_MHZ = CLKCTRL_FRQSEL_4M_gc >> CLKCTRL_FRQSEL_gp ,   CLK_FRQ_INVALID , CLK_FRQ_8_MHZ = CLKCTRL_FRQSEL_8M_gc >> CLKCTRL_FRQSEL_gp , CLK_FRQ_12_MHZ = CLKCTRL_FRQSEL_12M_gc >> CLKCTRL_FRQSEL_gp , CLK_FRQ_16_MHZ = CLKCTRL_FRQSEL_16M_gc >> CLKCTRL_FRQSEL_gp ,   CLK_FRQ_20_MHZ = CLKCTRL_FRQSEL_20M_gc >> CLKCTRL_FRQSEL_gp , CLK_FRQ_MAX }
	Type definitions for available High Frequency Oscillator output frequencies used for configuring the main clock. More...
enum	clkFrqDiv_t {   CLK_FRQ_DIV2 = CLKCTRL_PDIV_DIV2_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV4 = CLKCTRL_PDIV_DIV4_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV8 = CLKCTRL_PDIV_DIV8_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV16 = CLKCTRL_PDIV_DIV16_gc >> CLKCTRL_PDIV_gp ,   CLK_FRQ_DIV32 = CLKCTRL_PDIV_DIV32_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV64 = CLKCTRL_PDIV_DIV64_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV_INVALID1 , CLK_FRQ_DIV_INVALID2 ,   CLK_FRQ_DIV6 = CLKCTRL_PDIV_DIV6_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV10 = CLKCTRL_PDIV_DIV10_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV12 = CLKCTRL_PDIV_DIV12_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV24 = CLKCTRL_PDIV_DIV24_gc >> CLKCTRL_PDIV_gp ,   CLK_FRQ_DIV48 = CLKCTRL_PDIV_DIV48_gc >> CLKCTRL_PDIV_gp , CLK_FRQ_DIV_OFF , CLK_FRQ_DIV_MAX }
	Type definitions for available pre-scaler division used for configuring the main clock. More...
enum	cfdSource_t {   CFD_SRC_MAINCLK = CLKCTRL_CFDSRC_MCLK_gc >> CLKCTRL_CFDSRC_gp , CFD_SRC_OSCHF = CLKCTRL_CFDSRC_OSCHF_gc >> CLKCTRL_CFDSRC_gp , CFD_SRC_OSC32K = CLKCTRL_CFDSRC_OSC32K_gc >> CLKCTRL_CFDSRC_gp , CFD_SRC_XOSCHF = CLKCTRL_CFDSRC_XOSCHF_gc >> CLKCTRL_CFDSRC_gp ,   CFD_SRC_XOSC32K = CLKCTRL_CFDSRC_XOSC32K_gc >> CLKCTRL_CFDSRC_gp , CFD_SRC_EVSYS = CLKCTRL_CFDSRC_EVSYS_gc >> CLKCTRL_CFDSRC_gp , CFD_SRC_MAX }
	Type definitions for available Clock Failure Detection (CFD) sources used for configuring the CFDs. More...
enum	cfdReference_t { CFD_REF_OSC32K = CLKCTRL_CFDREF_OSC32K_gc >> CLKCTRL_CFDREF_gp , CFD_REF_ONEDIV32 = CLKCTRL_CFDREF_ONEDIV32_gc >> CLKCTRL_CFDREF_gp , CFD_REF_XOSC32K = CLKCTRL_CFDREF_XOSC32K_gc >> CLKCTRL_CFDREF_gp , CFD_REF_MAX }
	Type definitions for available Clock Failure Detection (CFD) references used for configuring the CFDs. More...
enum	cfmSource_t {   CFM_SRC_MAINCLK = CLKCTRL_CFMSRC_CLK_MAIN_gc >> CLKCTRL_CFMSRC_gp , CFM_SRC_OSCHF = CLKCTRL_CFMSRC_OSCHF_gc >> CLKCTRL_CFMSRC_gp , CFM_SRC_OSC32K = CLKCTRL_CFMSRC_OSC32K_gc >> CLKCTRL_CFMSRC_gp , CFM_SRC_XOSCHF = CLKCTRL_CFMSRC_XOSCHF_gc >> CLKCTRL_CFMSRC_gp ,   CFM_SRC_XOSC32K = CLKCTRL_CFMSRC_XOSC32K_gc >> CLKCTRL_CFMSRC_gp , CFM_SRC_EVSYS = CLKCTRL_CFMSRC_EVSYS_gc >> CLKCTRL_CFMSRC_gp , CFM_SRC_MAX }
	Type definitions for available Clock Frequency Measure (CFM) sources used for configuring the CFMs. More...
enum	cfmReference_t {   CFM_REF_OSCHF = CLKCTRL_CFMREF_OSCHF_gc >> CLKCTRL_CFMREF_gp , CFM_REF_XOSCHF = CLKCTRL_CFMREF_XOSCHF_gc >> CLKCTRL_CFMREF_gp , CFM_REF_XOSC32K = CLKCTRL_CFMREF_XOSC32K_gc >> CLKCTRL_CFMREF_gp , CFM_REF_OSC32K = CLKCTRL_CFMREF_OSC32K_gc >> CLKCTRL_CFMREF_gp ,   CFM_REF_MAX }
	Type definitions for available Clock Frequency Measure (CFM) references used for configuring the CFMs. More...

Functions
errFlag_t	MW_GetClearClockCfd0Error (void)
	Reads and clears the flag indicating a clock failure detected by CFD0.
errFlag_t	MW_GetClearClockCfd1Error (void)
	Reads and clears the flag indicating a clock failure detected by CFD1.
errFlag_t	MW_GetClearClockCfm0Error (void)
	Reads and clears the flag indicating a clock frequency error measured by CFM0.
errFlag_t	MW_GetClearClockCfm1Error (void)
	Reads and clears the flag indicating a clock frequency error measured by CFM1.
void	MW_ClearClockCfmDoneFlags (void)
	Clears the Clock Frequency Measure Done (CFMDn) flags indicating that a clock frequency measurement is done.
errFlag_t	MW_SetMainClockFrequency (clkFrq_t frequency, clkFrqDiv_t divider)
	Initializes main clock with internal High Frequency Oscillator (OSCHF) as clock source.
errFlag_t	MW_StartCfd0 (cfdSource_t src, cfdReference_t ref)
	Starts Clock Failure Detect 0 (CFD0) to monitor the configured clock source with the configured reference.
errFlag_t	MW_StartCfd1 (cfdSource_t src, cfdReference_t ref)
	Starts Clock Failure Detect 1 (CFD1) to monitor the configured clock source with the configured reference.
errFlag_t	MW_StartCfm0 (cfmSource_t src, cfmReference_t ref, cfmWindow_t window, bool useContinuous)
	Starts continuous Clock Frequency Measure 0 (CFM0) to monitor the configured clock source with the configured reference.
errFlag_t	MW_StartCfm1 (cfmSource_t src, cfmReference_t ref, cfmWindow_t window, bool useContinuous)
	Starts continuous Clock Frequency Measure 1 (CFM1) to monitor the configured clock source with the configured reference.
void	MW_EnableClockInterrupts (void)
	Enables all Clock Failure Detect (CFD) and Clock Frequency Measure (CFM) interrupts.