Contains public interface to various functions related to the clock (CLK) object. More...

#include "sw/modules/types/src/types.h"
#include "sw/drivers/cpu/src/32b/f28x/f2806x/cpu.h"
#include "sw/drivers/pwm/src/32b/f28x/f2806x/pwm.h"

Go to the source code of this file.

Data Structures
struct	_CLK_Obj_
	Defines the clock (CLK) object. More...

Macros
#define	CLK_BASE_ADDR (0x00007010)
	Defines the base address of the clock (CLK) registers. More...

#define	CLK_PCLKCR0_HRPWMENCLK_BITS (1 << 0)
	Defines the location of the HRPWMENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_LINAENCLK_BITS (1 << 1)
	Defines the location of the LINAENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_TBCLKSYNC_BITS (1 << 2)
	Defines the location of the TBCLKSYNC bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_ADCENCLK_BITS (1 << 3)
	Defines the location of the ADCENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_I2CAENCLK_BITS (1 << 4)
	Defines the location of the I2CAENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_SPIAENCLK_BITS (1 << 8)
	Defines the location of the SPIAENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_SPIBENCLK_BITS (1 << 9)
	Defines the location of the SPIBENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_SCIAENCLK_BITS (1 << 10)
	Defines the location of the SCIAENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_SCIBENCLK_BITS (1 << 11)
	Defines the location of the SCIBENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR0_ECANAENCLK_BITS (1 << 14)
	Defines the location of the ECANAENCLK bits in the PCLKCR0 register. More...

#define	CLK_PCLKCR1_EPWM1ENCLK_BITS (1 << 0)
	Defines the location of the EPWM1ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EPWM2ENCLK_BITS (1 << 1)
	Defines the location of the EPWM2ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EPWM3ENCLK_BITS (1 << 2)
	Defines the location of the EPWM3ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EPWM4ENCLK_BITS (1 << 3)
	Defines the location of the EPWM4ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EPWM5ENCLK_BITS (1 << 4)
	Defines the location of the EPWM5ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EPWM6ENCLK_BITS (1 << 5)
	Defines the location of the EPWM6ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EPWM7ENCLK_BITS (1 << 6)
	Defines the location of the EPWM7ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_ECAP1ENCLK_BITS (1 << 8)
	Defines the location of the ECAP1ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EQEP1ENCLK_BITS (1 << 14)
	Defines the location of the EQEP1ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR1_EQEP2ENCLK_BITS (1 << 15)
	Defines the location of the EQEP2ENCLK bits in the PCLKCR1 register. More...

#define	CLK_PCLKCR3_COMP1ENCLK_BITS (1 << 0)
	Defines the location of the COMP1ENCLK bits in the PCLKCR3 register. More...

#define	CLK_PCLKCR3_COMP2ENCLK_BITS (1 << 1)
	Defines the location of the COMP2ENCLK bits in the PCLKCR3 register. More...

#define	CLK_PCLKCR3_COMP3ENCLK_BITS (1 << 2)
	Defines the location of the COMP3ENCLK bits in the PCLKCR3 register. More...

#define	CLK_PCLKCR3_CPUTIMER0ENCLK_BITS (1 << 8)
	Defines the location of the CPUTIMER0ENCLK bits in the PCLKCR3 register. More...

#define	CLK_PCLKCR3_CPUTIMER1ENCLK_BITS (1 << 9)
	Defines the location of the CPUTIMER1ENCLK bits in the PCLKCR3 register. More...

#define	CLK_PCLKCR3_CPUTIMER2ENCLK_BITS (1 << 10)
	Defines the location of the CPUTIMER2ENCLK bits in the PCLKCR3 register. More...

#define	CLK_PCLKCR3_GPIOINENCLK_BITS (1 << 13)
	Defines the location of the GPIOINENCLK bits in the PCLKCR3 register. More...

#define	CLK_PCLKCR3_CLA1ENCLK_BITS (1 << 14)
	Defines the location of the CLA1ENCLK bits in the PCLKCR3 register. More...

#define	CLK_LOSPCP_LSPCLK_BITS (7 << 0)
	Defines the location of the LSPNCLK bits in the LOSPCP register. More...

#define	CLK_XCLK_XCLKOUTDIV_BITS (3 << 0)
	Defines the location of the XCLKOUTDIV bits in the XCLK register. More...

#define	CLK_XCLK_XCLKINSEL_BITS (1 << 6)
	Defines the location of the XCLKINSEL bits in the XCLK register. More...

#define	CLK_CLKCTL_OSCCLKSRCSEL_BITS (1 << 0)
	Defines the location of the OSCCLKSRCSEL bits in the CLKCTL register. More...

#define	CLK_CLKCTL_OSCCLKSRC2SEL_BITS (1 << 1)
	Defines the location of the OSCCLKSRC2SEL bits in the CLKCTL register. More...

#define	CLK_CLKCTL_WDCLKSRCSEL_BITS (1 << 2)
	Defines the location of the WDCLKSRCSEL bits in the CLKCTL register. More...

#define	CLK_CLKCTL_TMR2CLKSRCSEL_BITS (3 << 3)
	Defines the location of the TMR2CLKSRCSEL bits in the CLKCTL register. More...

#define	CLK_CLKCTL_TMR2CLKPRESCALE_BITS (7 << 5)
	Defines the location of the TMR2CLKPRESCALE bits in the CLKCTL register. More...

#define	CLK_CLKCTL_INTOSC1OFF_BITS (1 << 8)
	Defines the location of the INTOSC1OFF bits in the CLKCTL register. More...

#define	CLK_CLKCTL_INTOSC1HALTI_BITS (1 << 9)
	Defines the location of the INTOSC1HALTI bits in the CLKCTL register. More...

#define	CLK_CLKCTL_INTOSC2OFF_BITS (1 << 10)
	Defines the location of the INTOSC2OFF bits in the CLKCTL register. More...

#define	CLK_CLKCTL_INTOSC2HALTI_BITS (1 << 11)
	Defines the location of the INTOSC2HALTI bits in the CLKCTL register. More...

#define	CLK_CLKCTL_WDHALTI_BITS (1 << 12)
	Defines the location of the WDHALTI bits in the CLKCTL register. More...

#define	CLK_CLKCTL_XCLKINOFF_BITS (1 << 13)
	Defines the location of the XCLKINOFF bits in the CLKCTL register. More...

#define	CLK_CLKCTL_XTALOSCOFF_BITS (1 << 14)
	Defines the location of the XTALOSCOFF bits in the CLKCTL register. More...

#define	CLK_CLKCTL_NMIRESETSEL_BITS (1 << 15)
	Defines the location of the NMIRESETSEL bits in the CLKCTL register. More...

Typedefs
typedef struct _CLK_Obj_	CLK_Obj
	Defines the clock (CLK) object. More...

typedef struct _CLK_Obj_ *	CLK_Handle
	Defines the clock (CLK) handle. More...

Enumerations
enum	CLK_ClkOutPreScaler_e { CLK_ClkOutPreScaler_SysClkOut_by_4 =(0 << 0), CLK_ClkOutPreScaler_SysClkOut_by_2 =(1 << 0), CLK_ClkOutPreScaler_SysClkOut_by_1 =(2 << 0), CLK_ClkOutPreScaler_Off }
	Enumeration to define the external clock output frequency. More...

enum	CLK_CompNumber_e { CLK_CompNumber_1 =(1 << 0), CLK_CompNumber_2 =(1 << 1), CLK_CompNumber_3 =(1 << 2) }
	Enumeration to define the comparator numbers. More...

enum	CLK_CpuTimerNumber_e { CLK_CpuTimerNumber_0 =(1 << 8), CLK_CpuTimerNumber_1 =(1 << 9), CLK_CpuTimerNumber_2 =(1 << 10) }
	Enumeration to define the CPU timer numbers. More...

enum	CLK_LowSpdPreScaler_e { CLK_LowSpdPreScaler_SysClkOut_by_1 =(0 << 0), CLK_LowSpdPreScaler_SysClkOut_by_2 =(1 << 0), CLK_LowSpdPreScaler_SysClkOut_by_4 =(2 << 0), CLK_LowSpdPreScaler_SysClkOut_by_6 =(3 << 0), CLK_LowSpdPreScaler_SysClkOut_by_8 =(4 << 0), CLK_LowSpdPreScaler_SysClkOut_by_10 =(5 << 0), CLK_LowSpdPreScaler_SysClkOut_by_12 =(6 << 0), CLK_LowSpdPreScaler_SysClkOut_by_14 =(7 << 0) }
	Enumeration to define the low speed clock prescaler, which sets the clock frequency. More...

enum	CLK_XClkInSrc_e { CLK_XClkInSrc_Gpio38 =(0 << 6), CLK_XClkInSrc_Gpio19 =(1 << 6) }
	Enumeration to define the clock in source. More...

enum	CLK_OscSrc_e { CLK_OscSrc_Internal =(0 << 0), CLK_OscSrc_External =(1 << 0) }
	Enumeration to define the clock oscillator source. More...

enum	CLK_Osc2Src_e { CLK_Osc2Src_Internal =(1 << 1), CLK_Osc2Src_External =(0 << 1) }
	Enumeration to define the clock oscillator 2 source. More...

enum	CLK_Timer2PreScaler_e { CLK_Timer2PreScaler_by_1 =(0 << 5), CLK_Timer2PreScaler_by_2 =(1 << 5), CLK_Timer2PreScaler_by_4 =(2 << 5), CLK_Timer2PreScaler_by_8 =(3 << 5), CLK_Timer2PreScaler_by_16 =(4 << 5) }
	Enumeration to define the timer 2 prescaler, which sets the timer 2 frequency. More...

enum	CLK_Timer2Src_e { CLK_Timer2Src_SysClk =(0 << 3), CLK_Timer2Src_ExtOsc =(1 << 3), CLK_Timer2Src_IntOsc1 =(2 << 3), CLK_Timer2Src_IntOsc2 =(3 << 3) }
	Enumeration to define the timer 2 source. More...

enum	CLK_WdClkSrc_e { CLK_WdClkSrc_IntOsc1 =(0 << 2), CLK_WdClkSrc_ExtOscOrIntOsc2 =(1 << 2) }
	Enumeration to define the watchdog clock source. More...

Functions
void	CLK_disableAdcClock (CLK_Handle clkHandle)
	Disables the ADC clock. More...

void	CLK_disableClaClock (CLK_Handle clkHandle)
	Disables the CLA clock. More...

void	CLK_disableClkIn (CLK_Handle clkHandle)
	Disables the XCLKIN oscillator input. More...

void	CLK_disableCompClock (CLK_Handle clkHandle, const CLK_CompNumber_e compNumber)
	Disables the comparator clock. More...

void	CLK_disableCpuTimerClock (CLK_Handle clkHandle, const CLK_CpuTimerNumber_e cpuTimerNumber)
	Disables the CPU timer clock. More...

void	CLK_disableCrystalOsc (CLK_Handle clkHandle)
	Disables the crystal oscillator. More...

void	CLK_disableEcanaClock (CLK_Handle clkHandle)
	Disables the ECANA clock. More...

void	CLK_disableEcap1Clock (CLK_Handle clkHandle)
	Disables the ECAP1 clock. More...

void	CLK_disableEqep1Clock (CLK_Handle clkHandle)
	Disables the EQEP1 clock. More...

void	CLK_disableEqep2Clock (CLK_Handle clkHandle)
	Disables the EQEP2 clock. More...

void	CLK_disableGpioInputClock (CLK_Handle clkHandle)
	Disables the GPIO input clock. More...

void	CLK_disableHrPwmClock (CLK_Handle clkHandle)
	Disables the HRPWM clock. More...

void	CLK_disableI2cClock (CLK_Handle clkHandle)
	Disables the I2C clock. More...

void	CLK_disableLinAClock (CLK_Handle clkHandle)
	Disables the LIN-A clock. More...

void	CLK_disableOsc1 (CLK_Handle clkHandle)
	Disables internal oscillator 1. More...

void	CLK_disableOsc1HaltMode (CLK_Handle clkHandle)
	Disables internal oscillator 1 halt mode ignore. More...

void	CLK_disableOsc2 (CLK_Handle clkHandle)
	Disables internal oscillator 2. More...

void	CLK_disableOsc2HaltMode (CLK_Handle clkHandle)
	Disables internal oscillator 2 halt mode ignore. More...

void	CLK_disablePwmClock (CLK_Handle clkHandle, const PWM_Number_e pwmNumber)
	Disables the pwm clock. More...

void	CLK_disableSciaClock (CLK_Handle clkHandle)
	Disables the SCI-A clock. More...

void	CLK_disableScibClock (CLK_Handle clkHandle)
	Disables the SCI-B clock. More...

void	CLK_disableSpiaClock (CLK_Handle clkHandle)
	Disables the SPI-A clock. More...

void	CLK_disableSpibClock (CLK_Handle clkHandle)
	Disables the SPI-B clock. More...

void	CLK_disableTbClockSync (CLK_Handle clkHandle)
	Disables the ePWM module time base clock sync signal. More...

void	CLK_disableWatchDogHaltMode (CLK_Handle clkHandle)
	Disables the watchdog halt mode ignore. More...

void	CLK_enableAdcClock (CLK_Handle clkHandle)
	Enables the ADC clock. More...

void	CLK_enableClaClock (CLK_Handle clkHandle)
	Enables the CLA clock. More...

void	CLK_enableClkIn (CLK_Handle clkHandle)
	Enables the XCLKIN oscillator input. More...

void	CLK_enableCompClock (CLK_Handle clkHandle, const CLK_CompNumber_e compNumber)
	Enables the comparator clock. More...

void	CLK_enableCpuTimerClock (CLK_Handle clkHandle, const CLK_CpuTimerNumber_e cpuTimerNumber)
	Enables the CPU timer clock. More...

void	CLK_enableCrystalOsc (CLK_Handle clkHandle)
	Enables the crystal oscillator. More...

void	CLK_enableEcanaClock (CLK_Handle clkHandle)
	Enables the ECANA clock. More...

void	CLK_enableEcap1Clock (CLK_Handle clkHandle)
	Enables the ECAP1 clock. More...

void	CLK_enableEqep1Clock (CLK_Handle clkHandle)
	Enables the EQEP1 clock. More...

void	CLK_enableEqep2Clock (CLK_Handle clkHandle)
	Enables the EQEP2 clock. More...

void	CLK_enableGpioInputClock (CLK_Handle clkHandle)
	Enables the GPIO input clock. More...

void	CLK_enableHrPwmClock (CLK_Handle clkHandle)
	Enables the HRPWM clock. More...

void	CLK_enableI2cClock (CLK_Handle clkHandle)
	Enables the I2C clock. More...

void	CLK_enableLinAClock (CLK_Handle clkHandle)
	Enables the LIN-A clock. More...

void	CLK_enableOsc1 (CLK_Handle clkHandle)
	Enables internal oscillator 1. More...

void	CLK_enableOsc1HaltMode (CLK_Handle clkHandle)
	Enables internal oscillator 1 halt mode ignore. More...

void	CLK_enableOsc2 (CLK_Handle clkHandle)
	Enables internal oscillator 2. More...

void	CLK_enableOsc2HaltMode (CLK_Handle clkHandle)
	Enables internal oscillator 2 halt mode ignore. More...

void	CLK_enablePwmClock (CLK_Handle clkHandle, const PWM_Number_e pwmNumber)
	Enables the pwm clock. More...

void	CLK_enableSciaClock (CLK_Handle clkHandle)
	Enables the SCI-A clock. More...

void	CLK_enableScibClock (CLK_Handle clkHandle)
	Enables the SCI-B clock. More...

void	CLK_enableSpiaClock (CLK_Handle clkHandle)
	Enables the SPI-A clock. More...

void	CLK_enableSpibClock (CLK_Handle clkHandle)
	Enables the SPI-B clock. More...

void	CLK_enableTbClockSync (CLK_Handle clkHandle)
	Enables the ePWM module time base clock sync signal. More...

void	CLK_enableWatchDogHaltMode (CLK_Handle clkHandle)
	Enables the watchdog halt mode ignore. More...

CLK_Handle	CLK_init (void *pMemory, const size_t numBytes)
	Initializes the clock (CLK) object handle. More...

void	CLK_setClkOutPreScaler (CLK_Handle clkHandle, const CLK_ClkOutPreScaler_e preScaler)
	Sets the external clock out prescaler. More...

void	CLK_setLowSpdPreScaler (CLK_Handle clkHandle, const CLK_LowSpdPreScaler_e preScaler)
	Sets the low speed peripheral clock prescaler. More...

void	CLK_setOscSrc (CLK_Handle clkHandle, const CLK_OscSrc_e src)
	Sets the oscillator clock source. More...

void	CLK_setOsc2Src (CLK_Handle clkHandle, const CLK_Osc2Src_e src)
	Sets the oscillator 2 clock source. More...

void	CLK_setXClkInSrc (CLK_Handle clkHandle, const CLK_XClkInSrc_e src)
	Sets the XCLKIN Clock Source. More...

void	CLK_setTimer2PreScaler (CLK_Handle clkHandle, const CLK_Timer2PreScaler_e preScaler)
	Sets the timer 2 clock prescaler. More...

void	CLK_setTimer2Src (CLK_Handle clkHandle, const CLK_Timer2Src_e src)
	Sets the timer 2 clock source. More...

void	CLK_setWatchDogSrc (CLK_Handle clkHandle, const CLK_WdClkSrc_e src)
	Sets the watchdog clock source. More...

Detailed Description

Contains public interface to various functions related to the clock (CLK) object.

Definition in file clk.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description