clock_8xx.h

Go to the documentation of this file.

/*
 * @brief LPC8xx clock driver
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licenser disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __CLOCK_8XX_H_
#define __CLOCK_8XX_H_

#ifdef __cplusplus
extern "C" {
#endif

/* Internal oscillator frequency */
#define SYSCTL_IRC_FREQ     (12000000)

typedef enum CHIP_SYSCTL_PLLCLKSRC {
 SYSCTL_PLLCLKSRC_IRC = 0,  
 SYSCTL_PLLCLKSRC_SYSOSC,  
 SYSCTL_PLLCLKSRC_RESERVED,
 SYSCTL_PLLCLKSRC_EXT_CLKIN, 
} CHIP_SYSCTL_PLLCLKSRC_T;

typedef enum CHIP_WDTLFO_OSC {
 WDTLFO_OSC_ILLEGAL,
 WDTLFO_OSC_0_60, 
 WDTLFO_OSC_1_05, 
 WDTLFO_OSC_1_40, 
 WDTLFO_OSC_1_75, 
 WDTLFO_OSC_2_10, 
 WDTLFO_OSC_2_40, 
 WDTLFO_OSC_2_70, 
 WDTLFO_OSC_3_00, 
 WDTLFO_OSC_3_25, 
 WDTLFO_OSC_3_50, 
 WDTLFO_OSC_3_75, 
 WDTLFO_OSC_4_00, 
 WDTLFO_OSC_4_20, 
 WDTLFO_OSC_4_40, 
 WDTLFO_OSC_4_60  
} CHIP_WDTLFO_OSC_T;

typedef enum CHIP_SYSCTL_MAINCLKSRC{
 SYSCTL_MAINCLKSRC_IRC = 0,  
 SYSCTL_MAINCLKSRC_PLLIN,  
 SYSCTL_MAINCLKSRC_WDTOSC,  
 SYSCTL_MAINCLKSRC_PLLOUT,  
} CHIP_SYSCTL_MAINCLKSRC_T;

typedef enum CHIP_SYSCTL_CLOCK{
 SYSCTL_CLOCK_SYS = 0, 
 SYSCTL_CLOCK_ROM,  
 SYSCTL_CLOCK_RAM,  
 SYSCTL_CLOCK_FLASHREG, 
 SYSCTL_CLOCK_FLASH,  
 SYSCTL_CLOCK_I2C,  
 SYSCTL_CLOCK_GPIO,  
 SYSCTL_CLOCK_SWM,  
 SYSCTL_CLOCK_SCT,  
 SYSCTL_CLOCK_WKT,  
 SYSCTL_CLOCK_MRT,  
 SYSCTL_CLOCK_SPI0,  
 SYSCTL_CLOCK_SPI1,  
 SYSCTL_CLOCK_CRC,  
 SYSCTL_CLOCK_UART0,  
 SYSCTL_CLOCK_UART1,  
 SYSCTL_CLOCK_UART2,  
 SYSCTL_CLOCK_WWDT,  
 SYSCTL_CLOCK_IOCON,  
 SYSCTL_CLOCK_ACOMP  
} CHIP_SYSCTL_CLOCK_T;

typedef enum CHIP_SYSCTL_CLKOUTSRC{
 SYSCTL_CLKOUTSRC_IRC = 0,  
 SYSCTL_CLKOUTSRC_SYSOSC,  
 SYSCTL_CLKOUTSRC_WDTOSC,  
 SYSCTL_CLKOUTSRC_MAINSYSCLK, 
} CHIP_SYSCTL_CLKOUTSRC_T;

STATIC INLINE void Chip_Clock_SetupSystemPLL(uint8_t msel, uint8_t psel)
{
 LPC_SYSCTL->SYSPLLCTRL = (msel & 0x1F) | ((psel & 0x3) << 5);
}

STATIC INLINE bool Chip_Clock_IsSystemPLLLocked(void)
{
 return (bool) ((LPC_SYSCTL->SYSPLLSTAT & 1) != 0);
}

STATIC INLINE void Chip_Clock_SetWDTOSC(CHIP_WDTLFO_OSC_T wdtclk, uint8_t div)
{
 LPC_SYSCTL->WDTOSCCTRL  = (((uint32_t) wdtclk) << 5) | ((div >> 1) - 1);
}

STATIC INLINE CHIP_SYSCTL_MAINCLKSRC_T Chip_Clock_GetMainClockSource(void)
{
 return (CHIP_SYSCTL_MAINCLKSRC_T) (LPC_SYSCTL->MAINCLKSEL);
}

STATIC INLINE void Chip_Clock_SetSysClockDiv(uint32_t div)
{
 LPC_SYSCTL->SYSAHBCLKDIV  = div;
}

STATIC INLINE void Chip_Clock_EnablePeriphClock(CHIP_SYSCTL_CLOCK_T clk)
{
 LPC_SYSCTL->SYSAHBCLKCTRL |= (1 << clk);
}

STATIC INLINE void Chip_Clock_DisablePeriphClock(CHIP_SYSCTL_CLOCK_T clk)
{
 LPC_SYSCTL->SYSAHBCLKCTRL &= ~(1 << clk);
}

STATIC INLINE void Chip_Clock_SetUARTClockDiv(uint32_t div)
{
 LPC_SYSCTL->UARTCLKDIV = div;
}

STATIC INLINE uint32_t Chip_Clock_GetUARTClockDiv(void)
{
 return LPC_SYSCTL->UARTCLKDIV;
}

STATIC INLINE uint32_t Chip_Clock_GetMainOscRate(void)
{
 return CRYSTAL_MAIN_FREQ_IN;
}

STATIC INLINE uint32_t Chip_Clock_GetIntOscRate(void)
{
 return SYSCTL_IRC_FREQ;
}

STATIC INLINE uint32_t Chip_Clock_GetExtClockInRate(void)
{
 return EXTCLKIN_FREQ_IN;
}

void Chip_Clock_SetSystemPllSource(CHIP_SYSCTL_PLLCLKSRC_T src);

void Chip_Clock_SetPLLBypass(bool bypass, bool highfr);

void Chip_Clock_SetMainClockSource(CHIP_SYSCTL_MAINCLKSRC_T src);

void Chip_Clock_SetCLKOUTSource(CHIP_SYSCTL_CLKOUTSRC_T src, uint32_t div);

uint32_t Chip_Clock_GetWDTOSCRate(void);

uint32_t Chip_Clock_GetSystemPllInClockRate(void);

uint32_t Chip_Clock_GetSystemPllOutClockRate(void);

uint32_t Chip_Clock_GetMainClockRate(void);

uint32_t Chip_Clock_GetSystemClockRate(void);

#ifdef __cplusplus
}
#endif

#endif /* __CLOCK_8XX_H_ */