HAL RAMCFG Overview

Introducing RAMCFG

group RAMCFG_Introduction

The RAMCFG hardware abstraction layer provides a set of APIs to interface with the RAMCFG peripheral controlling the internal SRAMs configuration on STM32 microcontrollers.

The RAMCFG module provides firmware functions to manage the following functionalities :

  • ECC management functions.

  • SRAM write protection management functions.

  • SRAM erase management functions.

  • SRAM information getter functions.

This abstraction layer guarantees portability and ease of use across different STM32 series.

Module and files

The following diagram illustrates the RAMCFG module and its associated files.

Module and files diagram

Component diagram

The following diagram illustrates the software components involved in the RAMCFG module. It shows the interactions between the user application, HAL drivers, low-level drivers, and the hardware components.

@startuml
<style>
componentDiagram {
   arrow {
      FontSize 8
   }
}
</style>
title RAMCFG Software Component Diagram
package "HAL" {
    [HAL_RAMCFG]
    [HAL_SERVICE] 
}
package "Low Layer" {
    [LL_RAMCFG]
    [DFP]
    [RAMCFG Interrupt Service Routine]
}
package "HW" {
    [STM32_HW]
}
[Application] --> [HAL_RAMCFG] : HAL RAMCFG API
[Application] <-- [HAL_RAMCFG] : RAMCFG callback
[HAL_RAMCFG] --> [LL_RAMCFG] : LL RAMCFG API
[HAL_RAMCFG] -l-> [HAL_SERVICE] : HAL_GetTick
[HAL_RAMCFG] <-- [RAMCFG Interrupt Service Routine]
[LL_RAMCFG] --> [DFP]:RAMCFG register def
[STM32_HW] -u---> [RAMCFG Interrupt Service Routine]: RAMCFG IRQHandler
[STM32_HW] <-u--- [LL_RAMCFG] : RAMCFG registers R/W
@enduml

Configuration table

The following table lists the configuration defines for the HAL RAMCFG module, specifying their locations, default values, and descriptions:

group RAMCFG_Configuration_Table

Configuration inside the RAMCFG driver

Config defines

Description

Default value

Note

PRODUCT

from IDE

NA

Ex:STM32C562XX.

USE_ASSERT_DBG_PARAM

from IDE

None

Enable the parameters asserts.

USE_HAL_CHECK_PARAM

from hal_conf.h

0

Enable the parameters runtime checks.

USE_HAL_RAMCFG_MODULE

from hal_conf.h

1

Enable the HAL RAMCFG module.