clock_18xx_43xx.h

Go to the documentation of this file.

/*
 * @brief LPC18xx/43xx 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_18XX_43XX_H_
#define __CLOCK_18XX_43XX_H_

#ifdef __cplusplus
extern "C" {
#endif

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

#ifndef MAX_CLOCK_FREQ
#if defined(CHIP_LPC43XX)
#define MAX_CLOCK_FREQ (204000000)
#else
#define MAX_CLOCK_FREQ (180000000)
#endif
#endif /* MAX_CLOCK_FREQ */

void Chip_Clock_EnableCrystal(void);

void Chip_Clock_DisableCrystal(void);

uint32_t Chip_Clock_SetupMainPLLHz(CHIP_CGU_CLKIN_T Input, uint32_t MinHz, uint32_t DesiredHz, uint32_t MaxHz);

uint32_t Chip_Clock_SetupMainPLLMult(CHIP_CGU_CLKIN_T Input, uint32_t mult);

uint32_t Chip_Clock_GetMainPLLHz(void);

void Chip_Clock_DisableMainPLL(void);

void Chip_Clock_EnableMainPLL(void);

bool Chip_Clock_MainPLLLocked(void);

void Chip_Clock_SetDivider(CHIP_CGU_IDIV_T Divider, CHIP_CGU_CLKIN_T Input, uint32_t Divisor);

CHIP_CGU_CLKIN_T Chip_Clock_GetDividerSource(CHIP_CGU_IDIV_T Divider);

uint32_t Chip_Clock_GetDividerDivisor(CHIP_CGU_IDIV_T Divider);

uint32_t Chip_Clock_GetClockInputHz(CHIP_CGU_CLKIN_T input);

uint32_t Chip_Clock_GetBaseClocktHz(CHIP_CGU_BASE_CLK_T clock);

void Chip_Clock_SetBaseClock(CHIP_CGU_BASE_CLK_T BaseClock, CHIP_CGU_CLKIN_T Input, bool autoblocken, bool powerdn);

void Chip_Clock_GetBaseClockOpts(CHIP_CGU_BASE_CLK_T BaseClock, CHIP_CGU_CLKIN_T *Input, bool *autoblocken,
         bool *powerdn);

CHIP_CGU_CLKIN_T Chip_Clock_GetBaseClock(CHIP_CGU_BASE_CLK_T BaseClock);

void Chip_Clock_EnableBaseClock(CHIP_CGU_BASE_CLK_T BaseClock);

void Chip_Clock_DisableBaseClock(CHIP_CGU_BASE_CLK_T BaseClock);

bool Chip_Clock_IsBaseClockEnabled(CHIP_CGU_BASE_CLK_T BaseClock);

void Chip_Clock_EnableOpts(CHIP_CCU_CLK_T clk, bool autoen, bool wakeupen, int div);

void Chip_Clock_Enable(CHIP_CCU_CLK_T clk);

void Chip_Clock_Disable(CHIP_CCU_CLK_T clk);

uint32_t Chip_Clock_GetRate(CHIP_CCU_CLK_T clk);

void Chip_Clock_StartPowerDown(void);

void Chip_Clock_ClearPowerDown(void);

typedef struct {
 uint32_t ctrl;  /* Default control word for PLL */
 uint32_t mdiv;  /* Default M-divider value for PLL */
 uint32_t ndiv;  /* Default NP-divider value for PLL */
 uint32_t fract;  /* Default fractional value for audio PLL only */
} CGU_USBAUDIO_PLL_SETUP_T;

void Chip_Clock_SetupPLL(CHIP_CGU_CLKIN_T Input, CHIP_CGU_USB_AUDIO_PLL_T pllnum,
       const CGU_USBAUDIO_PLL_SETUP_T *pPLLSetup);

void Chip_Clock_EnablePLL(CHIP_CGU_USB_AUDIO_PLL_T pllnum);

void Chip_Clock_DisablePLL(CHIP_CGU_USB_AUDIO_PLL_T pllnum);

#define CGU_PLL_LOCKED (1 << 0) /* PLL locked status */
#define CGU_PLL_FR     (1 << 1) /* PLL free running indicator status */

uint32_t Chip_Clock_GetPLLStatus(CHIP_CGU_USB_AUDIO_PLL_T pllnum);

#ifdef __cplusplus
}
#endif

#endif /* __CLOCK_18XX_43XX_H_ */