clk.h

Go to the documentation of this file.

/* --COPYRIGHT--,BSD
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --/COPYRIGHT--*/
#ifndef _CLK_H_
#define _CLK_H_



// **************************************************************************
// the includes

#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"





#ifdef __cplusplus
extern "C" {
#endif


// **************************************************************************
// the defines


#define  CLK_BASE_ADDR                   (0x00007010)

#define  CLK_PCLKCR0_HRPWMENCLK_BITS     (1 << 0)

#define  CLK_PCLKCR0_LINAENCLK_BITS      (1 << 1)

#define  CLK_PCLKCR0_TBCLKSYNC_BITS      (1 << 2)

#define  CLK_PCLKCR0_ADCENCLK_BITS       (1 << 3)

#define  CLK_PCLKCR0_I2CAENCLK_BITS      (1 << 4)

#define  CLK_PCLKCR0_SPIAENCLK_BITS      (1 << 8)

#define  CLK_PCLKCR0_SPIBENCLK_BITS      (1 << 9)

#define  CLK_PCLKCR0_SCIAENCLK_BITS      (1 << 10)

#define  CLK_PCLKCR0_SCIBENCLK_BITS      (1 << 11)

#define  CLK_PCLKCR0_ECANAENCLK_BITS     (1 << 14)


#define  CLK_PCLKCR1_EPWM1ENCLK_BITS     (1 << 0)

#define  CLK_PCLKCR1_EPWM2ENCLK_BITS     (1 << 1)

#define  CLK_PCLKCR1_EPWM3ENCLK_BITS     (1 << 2)

#define  CLK_PCLKCR1_EPWM4ENCLK_BITS     (1 << 3)

#define  CLK_PCLKCR1_EPWM5ENCLK_BITS     (1 << 4)

#define  CLK_PCLKCR1_EPWM6ENCLK_BITS     (1 << 5)

#define  CLK_PCLKCR1_EPWM7ENCLK_BITS     (1 << 6)

#define  CLK_PCLKCR1_ECAP1ENCLK_BITS     (1 << 8)

#define  CLK_PCLKCR1_EQEP1ENCLK_BITS     (1 << 14)

#define  CLK_PCLKCR1_EQEP2ENCLK_BITS     (1 << 15)

#define  CLK_PCLKCR3_COMP1ENCLK_BITS     (1 << 0)

#define  CLK_PCLKCR3_COMP2ENCLK_BITS     (1 << 1)

#define  CLK_PCLKCR3_COMP3ENCLK_BITS     (1 << 2)

#define  CLK_PCLKCR3_CPUTIMER0ENCLK_BITS (1 << 8)

#define  CLK_PCLKCR3_CPUTIMER1ENCLK_BITS (1 << 9)

#define  CLK_PCLKCR3_CPUTIMER2ENCLK_BITS (1 << 10)

#define  CLK_PCLKCR3_GPIOINENCLK_BITS    (1 << 13)

#define  CLK_PCLKCR3_CLA1ENCLK_BITS      (1 << 14)


#define  CLK_LOSPCP_LSPCLK_BITS          (7 << 0)


#define  CLK_XCLK_XCLKOUTDIV_BITS        (3 << 0)

#define  CLK_XCLK_XCLKINSEL_BITS         (1 << 6)


#define  CLK_CLKCTL_OSCCLKSRCSEL_BITS    (1 << 0)

#define  CLK_CLKCTL_OSCCLKSRC2SEL_BITS   (1 << 1)

#define  CLK_CLKCTL_WDCLKSRCSEL_BITS     (1 << 2)

#define  CLK_CLKCTL_TMR2CLKSRCSEL_BITS   (3 << 3)

#define  CLK_CLKCTL_TMR2CLKPRESCALE_BITS (7 << 5)

#define  CLK_CLKCTL_INTOSC1OFF_BITS      (1 << 8)

#define  CLK_CLKCTL_INTOSC1HALTI_BITS    (1 << 9)

#define  CLK_CLKCTL_INTOSC2OFF_BITS      (1 << 10)

#define  CLK_CLKCTL_INTOSC2HALTI_BITS    (1 << 11)

#define  CLK_CLKCTL_WDHALTI_BITS         (1 << 12)

#define  CLK_CLKCTL_XCLKINOFF_BITS       (1 << 13)

#define  CLK_CLKCTL_XTALOSCOFF_BITS      (1 << 14)

#define  CLK_CLKCTL_NMIRESETSEL_BITS     (1 << 15)


// **************************************************************************
// the typedefs


typedef enum
{
  CLK_ClkOutPreScaler_SysClkOut_by_4=(0 << 0),  
  CLK_ClkOutPreScaler_SysClkOut_by_2=(1 << 0),  
  CLK_ClkOutPreScaler_SysClkOut_by_1=(2 << 0),  
  CLK_ClkOutPreScaler_Off                       
} CLK_ClkOutPreScaler_e;


typedef enum
{
  CLK_CompNumber_1=(1 << 0),  
  CLK_CompNumber_2=(1 << 1),  
  CLK_CompNumber_3=(1 << 2)   
} CLK_CompNumber_e;


typedef enum
{
  CLK_CpuTimerNumber_0=(1 << 8),  
  CLK_CpuTimerNumber_1=(1 << 9),  
  CLK_CpuTimerNumber_2=(1 << 10)  
} CLK_CpuTimerNumber_e;


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


typedef enum
{
  CLK_XClkInSrc_Gpio38=(0 << 6),
  CLK_XClkInSrc_Gpio19=(1 << 6)
} CLK_XClkInSrc_e;


typedef enum
{
  CLK_OscSrc_Internal=(0 << 0),  
  CLK_OscSrc_External=(1 << 0)   
} CLK_OscSrc_e;


typedef enum
{
  CLK_Osc2Src_Internal=(1 << 1),  
  CLK_Osc2Src_External=(0 << 1)   
} CLK_Osc2Src_e;


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


typedef enum
{
  CLK_Timer2Src_SysClk=(0 << 3),   
  CLK_Timer2Src_ExtOsc=(1 << 3),   
  CLK_Timer2Src_IntOsc1=(2 << 3),  
  CLK_Timer2Src_IntOsc2=(3 << 3)   
} CLK_Timer2Src_e;


typedef enum
{
  CLK_WdClkSrc_IntOsc1=(0 << 2),         
  CLK_WdClkSrc_ExtOscOrIntOsc2=(1 << 2)  
} CLK_WdClkSrc_e;


typedef struct _CLK_Obj_
{
  volatile uint16_t   XCLK;         
  volatile uint16_t   rsvd_1;       
  volatile uint16_t   CLKCTL;       
  volatile uint16_t   rsvd_2[8];    
  volatile uint16_t   LOSPCP;       
  volatile uint16_t   PCLKCR0;      
  volatile uint16_t   PCLKCR1;      
  volatile uint16_t   rsvd_3[2];    
  volatile uint16_t   PCLKCR3;      
} CLK_Obj;


typedef struct _CLK_Obj_ *CLK_Handle;


// **************************************************************************
// the globals


// **************************************************************************
// the function prototypes


extern void CLK_disableAdcClock(CLK_Handle clkHandle);


extern void CLK_disableClaClock(CLK_Handle clkHandle);


extern void CLK_disableClkIn(CLK_Handle clkHandle);


extern void CLK_disableCompClock(CLK_Handle clkHandle,const CLK_CompNumber_e compNumber);


extern void CLK_disableCpuTimerClock(CLK_Handle clkHandle,
                                     const CLK_CpuTimerNumber_e cpuTimerNumber);


extern void CLK_disableCrystalOsc(CLK_Handle clkHandle);


extern void CLK_disableEcanaClock(CLK_Handle clkHandle);


extern void CLK_disableEcap1Clock(CLK_Handle clkHandle);


extern void CLK_disableEqep1Clock(CLK_Handle clkHandle);

extern void CLK_disableEqep2Clock(CLK_Handle clkHandle);


extern void CLK_disableGpioInputClock(CLK_Handle clkHandle);


extern void CLK_disableHrPwmClock(CLK_Handle clkHandle);


extern void CLK_disableI2cClock(CLK_Handle clkHandle);


extern void CLK_disableLinAClock(CLK_Handle clkHandle);


extern void CLK_disableOsc1(CLK_Handle clkHandle);


extern void CLK_disableOsc1HaltMode(CLK_Handle clkHandle);


extern void CLK_disableOsc2(CLK_Handle clkHandle);


extern void CLK_disableOsc2HaltMode(CLK_Handle clkHandle);


extern void CLK_disablePwmClock(CLK_Handle clkHandle,const PWM_Number_e pwmNumber);


extern void CLK_disableSciaClock(CLK_Handle clkHandle);


extern void CLK_disableScibClock(CLK_Handle clkHandle);


extern void CLK_disableSpiaClock(CLK_Handle clkHandle);


extern void CLK_disableSpibClock(CLK_Handle clkHandle);


extern void CLK_disableTbClockSync(CLK_Handle clkHandle);


extern void CLK_disableWatchDogHaltMode(CLK_Handle clkHandle);


extern void CLK_enableAdcClock(CLK_Handle clkHandle);


extern void CLK_enableClaClock(CLK_Handle clkHandle);


extern void CLK_enableClkIn(CLK_Handle clkHandle);


extern void CLK_enableCompClock(CLK_Handle clkHandle,const CLK_CompNumber_e compNumber);


extern void CLK_enableCpuTimerClock(CLK_Handle clkHandle,
                                    const CLK_CpuTimerNumber_e cpuTimerNumber);


extern void CLK_enableCrystalOsc(CLK_Handle clkHandle);


extern void CLK_enableEcanaClock(CLK_Handle clkHandle);


extern void CLK_enableEcap1Clock(CLK_Handle clkHandle);


extern void CLK_enableEqep1Clock(CLK_Handle clkHandle);

extern void CLK_enableEqep2Clock(CLK_Handle clkHandle);


extern void CLK_enableGpioInputClock(CLK_Handle clkHandle);


extern void CLK_enableHrPwmClock(CLK_Handle clkHandle);


extern void CLK_enableI2cClock(CLK_Handle clkHandle);


extern void CLK_enableLinAClock(CLK_Handle clkHandle);


extern void CLK_enableOsc1(CLK_Handle clkHandle);


extern void CLK_enableOsc1HaltMode(CLK_Handle clkHandle);


extern void CLK_enableOsc2(CLK_Handle clkHandle);


extern void CLK_enableOsc2HaltMode(CLK_Handle clkHandle);


extern void CLK_enablePwmClock(CLK_Handle clkHandle,const PWM_Number_e pwmNumber);


extern void CLK_enableSciaClock(CLK_Handle clkHandle);


extern void CLK_enableScibClock(CLK_Handle clkHandle);


extern void CLK_enableSpiaClock(CLK_Handle clkHandle);


extern void CLK_enableSpibClock(CLK_Handle clkHandle);


extern void CLK_enableTbClockSync(CLK_Handle clkHandle);


extern void CLK_enableWatchDogHaltMode(CLK_Handle clkHandle);


extern CLK_Handle CLK_init(void *pMemory,const size_t numBytes);


extern void CLK_setClkOutPreScaler(CLK_Handle clkHandle,
                                   const CLK_ClkOutPreScaler_e preScaler);


extern void CLK_setLowSpdPreScaler(CLK_Handle clkHandle,
                                   const CLK_LowSpdPreScaler_e preScaler);


extern void CLK_setOscSrc(CLK_Handle clkHandle,const CLK_OscSrc_e src);
                      

extern void CLK_setOsc2Src(CLK_Handle clkHandle,const CLK_Osc2Src_e src);


extern void CLK_setXClkInSrc(CLK_Handle clkHandle, const CLK_XClkInSrc_e src);
                      

extern void CLK_setTimer2PreScaler(CLK_Handle clkHandle,
                                   const CLK_Timer2PreScaler_e preScaler);
                      

extern void CLK_setTimer2Src(CLK_Handle clkHandle,const CLK_Timer2Src_e src);
                      

extern void CLK_setWatchDogSrc(CLK_Handle clkHandle,const CLK_WdClkSrc_e src);


#ifdef __cplusplus
}
#endif // extern "C"

#endif  // end of _CLK_H_ definition