Quick Start Guide for the System Clock Management service (UC3B0/UC3B1)

This is the quick start guide for the System Clock Management service, with step-by-step instructions on how to configure and use the service for specific use cases.

System Clock Management use cases

• Basic usage of the System Clock Management service
• Advanced use case - Peripheral Bus Clock Management (UC3B0/UC3B1)

Basic usage of the System Clock Management service

This section will present a basic use case for the System Clock Management service. This use case will configure the main system clock to 48MHz, using an internal PLL module to multiply the frequency of a crystal attached to the microcontroller. The peripheral bus clocks are scaled down from the speed of the main system clock.

Prerequisites

• None

Initialization code

Add to the application initialization code:

sysclk_init();

Workflow

1. Configure the system clocks according to the settings in conf_clock.h:

   sysclk_init(); 

Example code

Add or uncomment the following in your conf_clock.h header file, commenting out all other definitions of the same symbol(s):

#define CONFIG_SYSCLK_SOURCE        SYSCLK_SRC_PLL0

// Fpll0 = (Fclk * PLL_mul) / PLL_div
#define CONFIG_PLL0_SOURCE          PLL_SRC_OSC0
#define CONFIG_PLL0_MUL             (48000000UL / BOARD_OSC0_HZ)
#define CONFIG_PLL0_DIV             1

// Fbus = Fsys / (2 ^ BUS_div)
#define CONFIG_SYSCLK_CPU_DIV       0
#define CONFIG_SYSCLK_PBA_DIV       1
#define CONFIG_SYSCLK_PBB_DIV       1

Workflow

1. Configure the main system clock to use the output of the PLL0 module as its source:

   #define CONFIG_SYSCLK_SOURCE      SYSCLK_SRC_PLL0 

2. Configure the PLL0 module to use external crystal oscillator OSC0 as its source:

   #define CONFIG_PLL0_SOURCE        SYSCLK_SRC_OSC0 

3. Configure the PLL0 module to multiply the external oscillator OSC0 frequency up to 48MHz:

   #define CONFIG_PLL0_MUL             (48000000UL / BOARD_OSC0_HZ)
   #define CONFIG_PLL0_DIV             1 

   Note

   For user boards, BOARD_OSC0_HZ should be defined in the board conf_board.h configuration file as the frequency of the crystal attached to OSC0.

4. Configure the main clock to run at the full 48MHz, scale the peripheral busses to run at one half (2 to the power of 1) of the system clock speed:

   #define CONFIG_SYSCLK_CPU_DIV       0
   #define CONFIG_SYSCLK_PBA_DIV       1
   #define CONFIG_SYSCLK_PBB_DIV       1

   Note

   Some dividers are powers of two, while others are integer division factors. Refer to the formulas in the conf_clock.h template commented above each division define.