midware_clock_manager.h

Go to the documentation of this file.

#ifndef MIDWARE_CLOCK_MANAGER_H
#define MIDWARE_CLOCK_MANAGER_H
 
// Standard Library Includes
#include <stdbool.h>
#include <stdint.h>
 
// Framework Includes
#include <define_error_flags.h>
 
// Device-specific Includes
#include <xc.h>

typedef enum
{
    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 
} clkFrq_t;

typedef enum
{
    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 
} clkFrqDiv_t;

typedef enum
{
    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 
} cfdSource_t;

typedef enum
{
    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 
} cfdReference_t;

typedef enum
{
    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 
} cfmSource_t;

typedef enum
{
    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, 
} cfmReference_t;

typedef struct
{
    uint16_t refCount;   
    uint16_t windowHigh; 
    uint16_t windowLow;  
} cfmWindow_t;

errFlag_t MW_GetClearClockCfd0Error(void);

errFlag_t MW_GetClearClockCfd1Error(void);

errFlag_t MW_GetClearClockCfm0Error(void);

errFlag_t MW_GetClearClockCfm1Error(void);

void MW_ClearClockCfmDoneFlags(void);

errFlag_t MW_SetMainClockFrequency(clkFrq_t frequency, clkFrqDiv_t divider);

errFlag_t MW_StartCfd0(cfdSource_t src, cfdReference_t ref);

errFlag_t MW_StartCfd1(cfdSource_t src, cfdReference_t ref);

errFlag_t MW_StartCfm0(cfmSource_t src, cfmReference_t ref, cfmWindow_t window, bool useContinuous);

errFlag_t MW_StartCfm1(cfmSource_t src, cfmReference_t ref, cfmWindow_t window, bool useContinuous);

void MW_EnableClockInterrupts(void);
 
#endif // MIDWARE_CLOCK_MANAGER_H