STM32CubeWBA: System Clock Manager

Coming soon

Information

This page is not yet finished but will be soon.

1. Introduction

The system clock manager (SCM) is module responsible for managing CPU system clock source and frequency according to Connectivity purposes.
System clock manager module defines different users that can request different configurations. Modules determines which one is best to suit the system and all SCM users needs.

SCM module also steps in low power wake-up phase by applying usable configuration for RF activities.

2. Features

2.1. SCM users principle

The module is based on a client request mechanism. SCM defines users (up to 32) that can request a clock frequency modification.
There is a system user SCM_USER_LL_FW and multiple application users can be define in addition to existing SCM_USER_APP. All users has the same weight/priority.

Among all the requests, the system clock manager determines the one that fulfills all the needs. The best system clock evaluation is realized at each new request.

2.2. Supported configurations

2.2.1. Overview

Supported configurations are fixed. Unlike SCM users, it is not possible to add SCM configurations over existing ones.

Each SCM configuration is used for a particular purpose.
The table below presents all the supported configuration (increasing order of priority) and their use at system side.

Supported SCM configurations

SCM configuration	Purpose
HSE 16MHz	Nominal - no radio activity Requested in radio interrupt (ending radio event notification from link layer)
HSE 32MHz	Radio activity Requested in radio interrupt (starting radio event notification from link layer)
PLL	PLL is used for BLE audio use cases

Information

HSI as system clock source is not supported.

Information

The SCM always select the request with the most prior configuration (as needs with the lower ones are fulfilled).

2.2.2. Corresponding SoC configuration

In order to achieve these configurations, SCM module is responsible to adapt several SoC related parameters:

• Flash & SRAMs latencies.
• Flash & SRAMs wait states.
• Regulator supply output voltage (VOS).
• AHB5 divider.

They are presented per SCM configuration is the table below.

SCM related SoC parameters

SCM configuration	Flash & SRAMs latencies	Flash & SRAMs wait states	VOS	AHB5 divider
HSE 16MHz	Flash latency: 1 SRAM1/2 latencies: 1	Flash WS: 1 SRAM1/2 WS: 1	2	2
HSE 32MHz	Flash latency: 0 SRAM1/2 latencies: 0	Flash WS: 0 SRAM1/2 WS: 0	1	1
PLL	Flash latencies: 3 SRAM1/2 latency: 0	Flash WS: 0 SRAM1/2 WS: 0	1	1

2.3. PLL usage

PLL usage and configuration is defined as follow:

• PLL source is always HSE 32MHz.
• If there is one global PLL configuration for SCM, PLL parameters (PLL mode, PLL multiplier & dividers) can be adapted to user needs with dedicated interfaces.
  See PLL interfaces section for more information.

2.4. Low power management

SCM module is used in low power management for both low power entry and exit.

• For low power mode entry (stop1 or standby), SCM interface scm_setwaitstates(LP) is used for adapting FLASH & SRAMs wait states and latencies.
• For low power mode exit (stop1 and standby), SCM interface scm_setup() is used for applying the system clock confirmation that were before low power entry. Regarding standby mod exit, PLL configuration is re-applied (even if not used at that time) as PLL registers has been reset.

2.5. SCM elected request execution

On one hand, decreasing clock speed is handled immediately.
On the other hand, increasing clock speed requires more time to setup (including oscillators to be enabled, propagation delays, PLL lock, ...). To guarantee system performances and radio activity timings, SCM implemented an interrupt based mechanism.

Indeed, when the system clock source has to be changed, the targeted oscillator (HSE or PLL) is enabled alongside dedicated RCC ready flag. The other part of system clock configuration is done in the RCC interrupts itself once clock is ready. This permits the firmware to keep running with the actual clock source and speed until targeted clock is ready.

There is two RCC interrupts the SCM handles:

• RCC HSE ready flag (raised just after low power mode exit as system clock is HSI 16MHz).
• RCC PLL ready flag (always raised when system clock is on HSE as HSE is PLL source clock).

2.6. SCM concept summary

Here is a summary diagram of SCM module.

File:SCM Overview.png

System Clock Manager concept summary

3. Interfaces

TBD. texte affiché du point d'ancrage

texte

texte

The available functions for AMM are listed below:

scm_init
Description Initialize the Advanced Memory Manager Pool. Syntax AMM_Function_Error_t AMM_Init (const AMM_InitParameters_t * const p_InitParams); Parameters [in] p_InitParams Type: const AMM_InitParameters_t * const Description: Struct of init parameters Return Value AMM_Function_Error_t

scm_setsystemclock
Description DeInitialize the Advance Memory Manager Pool Syntax AMM_Function_Error_t AMM_DeInit (void); Parameters None Return Value AMM_Function_Error_t

scm_setup

Description Allocate a buffer from the Advance Memory Manager Pool. Syntax AMM_Function_Error_t AMM_Alloc (const uint8_t VirtualMemoryId, const uint32_t BufferSize, uint32_t ** pp_AllocBuffer, AMM_VirtualMemoryCallbackFunction_t * const p_CallBackFunction); Parameters [in] VirtualMemoryId Type: const uint8_t Description: Virtual Memory Identifier - AMM_NO_VIRTUAL_ID Can be used. [in] BufferSize Type: const uint32_t Description: Size of the pool with a multiple of 32bits. ie: BufferSize = 4; TotalSize = BufferSize * 32bits = 4 * 32bits = 128 bits [out] pp_AllocBuffer Type: uint32_t ** Description: Pointer onto the allocated buffer [in] p_CallBackFunction Type: AMM_VirtualMemoryCallbackFunction_t * const Description: Pointer onto the Callback to call in case of failure - Can be NULL. Return Value AMM_Function_Error_t

scm_setwaitstates
Description Free the allocated buffer from the Advance Memory Manager Pool Syntax AMM_Function_Error_t AMM_Free (uint32_t * const p_BufferAddr); Parameters [in] p_BufferAddr Type: uint32_t * const Description: Address of the buffer to free Return Value AMM_Function_Error_t

AMM_BackgroundProcess
Description Background routine that aims to call registered callbacks for an allocation retry Syntax void AMM_BackgroundProcess (void); Parameters None Return Value None

AMM_RegisterBasicMemoryManager
Description Register the Basic Memory Manager functions to use Syntax void AMM_RegisterBasicMemoryManager (AMM_BasicMemoryManagerFunctions_t * const p_BasicMemoryManagerFunctions); Parameters [in] p_BasicMemoryManagerFunctions Type: AMM_BasicMemoryManagerFunctions_t * const Description: Address of the basic memory manager functions Return Value None

AMM_ProcessRequest
Description Request to application for a Background process run Syntax void AMM_ProcessRequest (void); Parameters None Return Value None

4. How to

TBD.