HAL SDRAM Use Cases ¶

Use case1 : Initialization and configuration ¶

$@startuml participant App as "User application" participant system as "System" participant "GPIO Driver" as GPIO participant "RCC Driver" as RCC participant "HAL SDRAM Driver" as SDRAM == HAL SDRAM initialization == App->SDRAM : HAL_SDRAM_Init() note right: Initialize the SDRAM handle and associate an instance. note over SDRAM #CCCCFF Global state = INIT Device state = RESET end note group #lightgrey Alt SDRAM->RCC : HAL_RCC_FMC_EnableClock() note right: If USE_FMC_CLK_ENABLE_MODEL > HAL_CLK_ENABLE_NO end SDRAM --> App : hal status : HAL_OK or HAL_INVALID_PARAM note right: Return == SDRAM system initialization == Note over SDRAM : SDRAM System initialization can be called before\nHAL SDRAM initialization group #lightgrey Alt App->RCC : Enable FMC Clock note right: If USE_FMC_CLK_ENABLE_MODEL == HAL_CLK_ENABLE_NO end group #lightblue Hardware resource initialization App->GPIO : SDRAM HW Initialisation note right: Initialize GPIO GPIO --> App end == Configuration == App->SDRAM : HAL_SDRAM_SetConfig note right: common configuration for the FMC SDRAM(all devices) note over SDRAM #CCCCFF Global state = CONFIGURED Device state = RESET end note SDRAM --> App: hal status : HAL_OK or HAL_INVALID_PARAM note right: return App->SDRAM : HAL_SDRAM_SetMemoryConfig note right: Configure the SDRAM memory and enable the corresponding device note over SDRAM #CCCCFF Global state = CONFIGURED Device state = MEMORY_CONFIGURED end note SDRAM --> App: hal status : HAL_OK or HAL_INVALID_PARAM note right: return group #orange Example of initialization sequence with external memories App->SDRAM : HAL_SDRAM_SendCommand() note right of SDRAM command sequence to be sent to ensure the initialization with external memories. (command sequence specification must be specified in the memory's datasheet). end note note over SDRAM #CCCCFF Global state = CONFIGURED Device state = ACTIVE end note SDRAM --> App: hal status : HAL_OK note right: return App->SDRAM : HAL_SDRAM_SetRefreshRate() note over SDRAM #CCCCFF Global state = CONFIGURED Device state = MEMORY_CONFIGURED end note SDRAM --> App: hal status : HAL_OK note right: return App->SDRAM : HAL_SDRAM_CompleteInitSequence() note right of SDRAM Complete the initialization sequence and mark the memory ready to be used by the FMC hardware. end note note over SDRAM #CCCCFF Global state = CONFIGURED Device state = MEMORY_IDLE end note SDRAM --> App: hal status : HAL_OK note right: return end @enduml$

Called functions:

Use case2 : SDRAM deinitialization sequence ¶

Called functions:

HAL_SDRAM_DeInit()

Use case3 : Starting a read/write operation ¶

@startuml

== Prerequisite: Initialisation and configuration ==

== Process ==
"User Application"->"User Application" : User Read/write operations
note right: Read/Write user operations

@enduml

Use case : Starting a write operation using enable and disable write protection APIs ¶

Called functions:

Use case : Starting read/write operations in all SDRAM devices ¶

$@startuml title <size:18><color:Red> All SDRAM devices must be configured before starting any SDRAM device process \n\n participant App as "User application" participant "HAL SDRAM Driver" as SDRAM participant system as system participant "GPIO Driver" as GPIO participant "RCC Driver" as RCC == Prerequisite == == HAL SDRAM initialization == == SDRAM system initialization == == Configuration == group #lightblue SDRAM common configuration (for all devices) App->SDRAM : HAL_SDRAM_SetConfig(&hsdram, &common_config) note right of SDRAM Common configuration for all SDRAM devices, and the external memories should have the same timing requirements. end note note over SDRAM #CCCCFF Global state = CONFIGURED Device state = RESET end note SDRAM --> App: hal status : HAL_OK or HAL_INVALID_PARAM note right: return end group #lightblue SDRAM device 1 configuration (HAL_SDRAM_DEVICE1) App->SDRAM : HAL_SDRAM_SetConfigMemory(&hsdram, HAL_SDRAM_DEVICE1, &device1_config) note right: memory configuration and enable for the device 1 note over SDRAM #CCCCFF Global state = CONFIGURED Device state[HAL_SDRAM_DEVICE1] = MEMORY_CONFIGURED end note SDRAM --> App: hal status : HAL_OK or HAL_INVALID_PARAM note right: return group #orange Example of initialization sequence with external memory 1 App->SDRAM : HAL_SDRAM_SendCommand(&hsdram, HAL_SDRAM_DEVICE1, command_sequence1, timeout_ms) note right of SDRAM command sequence to be sent to ensure the initialization with the external memory 1. (command sequence specification must be specified in the memory's datasheet). end note note over SDRAM #CCCCFF Global state = CONFIGURED Device state = ACTIVE end note SDRAM --> App: hal status : HAL_OK note right: return App->SDRAM : HAL_SDRAM_SetRefreshRate() note over SDRAM #CCCCFF Global state = CONFIGURED Device state = MEMORY_CONFIGURED end note SDRAM --> App: hal status : HAL_OK note right: return App->SDRAM : HAL_SDRAM_CompleteInitSequence(&hsdram, HAL_SDRAM_DEVICE1) note right of SDRAM Complete the initialization sequence and mark the device1 ready to be used by the FMC hardware. end note note over SDRAM #CCCCFF Global state = CONFIGURED Device state = MEMORY_IDLE end note SDRAM --> App: hal status : HAL_OK note right: return end end group #lightblue SDRAM device 2 configuration (HAL_SDRAM_DEVICE2) App->SDRAM : HAL_SDRAM_SetConfigMemory(hsdram, HAL_SDRAM_DEVICE2, &device2_config) note right: memory configuration for device 2 note over SDRAM #CCCCFF Global state = CONFIGURED Device state[HAL_SDRAM_DEVICE2] = MEMORY_CONFIGURED end note SDRAM --> App: hal status : HAL_OK or HAL_INVALID_PARAM note right: return group #orange Example of initialization sequence with external memory 2 App->SDRAM : HAL_SDRAM_SendCommand(&hsdram, HAL_SDRAM_DEVICE2, command_sequence2, timeout_ms) note right of SDRAM command sequence to be sent to ensure the initialization with the external memory 2. (command sequence specification must be specified in the memory's datasheet). end note note over SDRAM #CCCCFF Global state = CONFIGURED Device state = ACTIVE end note SDRAM --> App: hal status : HAL_OK note right: return App->SDRAM : HAL_SDRAM_SetRefreshRate() note over SDRAM #CCCCFF Global state = CONFIGURED Device state = MEMORY_CONFIGURED end note SDRAM --> App: hal status : HAL_OK note right: return App->SDRAM : HAL_SDRAM_CompleteInitSequence(&hsdram, HAL_SDRAM_DEVICE2) note right of SDRAM Complete the initialization sequence and mark the device2 ready to be used by the FMC hardware. end note note over SDRAM #CCCCFF Global state = CONFIGURED Device state = MEMORY_IDLE end note SDRAM --> App: hal status : HAL_OK note right: return end end == Process == App->App : User Read/write operations note right: Read/Write user operations for configured SDRAM devices @enduml$

Called functions:

Use case : Starting a command process operation with unitary processes ¶

$@startuml participant App as "User application" participant "HAL SDRAM" as SDRAM == Prerequisite: Initialisation and configuration == ==Process : Send command Polling== group #lightblue Unitary processes during send command process note over App : when the Global state = CONFIGURED and the Device state = IDLE(send command process completed),\nUser can start any unitary process . App -> SDRAM : HAL_SDRAM_SetRefreshRate() SDRAM --> App: hal status : HAL_OK App -> SDRAM : HAL_SDRAM_GetRefreshRate() SDRAM --> App: hal status : HAL_OK App -> SDRAM : HAL_SDRAM_GetDeviceMode() SDRAM --> App: hal status : HAL_OK end App -> SDRAM : HAL_SDRAM_SendCommand(...,uint32_t timeout_ms) note over SDRAM #CCCCFF Global state = CONFIGURED Device state = ACTIVE end note HW-->SDRAM: command is sent App <-- SDRAM : HAL_OK @enduml$

Called functions:

Use case : Starting an auto refresh command process operation with interruption process ¶

$@startuml participant App as "User application" participant "HAL SDRAM" as SDRAM participant "NVIC" as NVIC == Prerequisite: Initialisation and configuration == ==Process : Send command with enabling refresh error interruption== App -> SDRAM : HAL_SDRAM_EnableIT(HAL_SDRAM_IT_REFRESH_ERROR) note over SDRAM : the refresh error interruption is enabled App -> SDRAM : HAL_SDRAM_SendCommand(...,uint32_t timeout_ms) note over SDRAM : Command issued is HAL_SDRAM_CMD_AUTOREFRESH. note over SDRAM #CCCCFF Global state = CONFIGURED Device state = ACTIVE end note alt successful case HW-->SDRAM: command is sent App <-- SDRAM : HAL_OK else refresh error case HW --> NVIC: Refresh error interrupt NVIC --> SDRAM: HAL_SDRAM_IRQHandler note over SDRAM : Clear Flag RE SDRAM --> App: HAL_SDRAM_RefreshErrorCallback note over App : Refresh error callback detected. App --> SDRAM SDRAM --> NVIC note over App : When issuing another HAL_SDRAM_CMD_AUTOREFRESH command and the previous one was not served,\na refresh error occured. end @enduml$

Called functions:

Use case : Starting a send command process operation issued for both devices ¶

$@startuml participant App as "User application" participant "HAL SDRAM" as SDRAM == Prerequisite: Initialisation and configuration == == Process : Send command Polling for both devices == note over App: Send the command to both devices simultanously with the\n same command configuration and same timeout\n for targeting both devices. App -> SDRAM : HAL_SDRAM_SendCommand(&hsdram, HAL_SDRAM_CMD_DEVICE1, &p_command_config, timeout_ms); note over SDRAM #CCCCFF Global state = CONFIGURED Device state[HAL_SDRAM_CMD_DEVICE1] = ACTIVE end note HW-->SDRAM: command is sent to device 1 App <-- SDRAM : HAL_OK note over SDRAM #CCCCFF Global state = CONFIGURED Device state[HAL_SDRAM_CMD_DEVICE1] = IDLE end note note over App : Command sent to the device 1,\n and ready to send the command to the second device. App -> SDRAM : HAL_SDRAM_SendCommand(&hsdram, HAL_SDRAM_CMD_DEVICE2, &p_command_config, timeout_ms); note over SDRAM #CCCCFF Global state = CONFIGURED Device state[HAL_SDRAM_CMD_DEVICE2] = ACTIVE end note HW-->SDRAM: command is sent to device 2 App <-- SDRAM : HAL_OK note over SDRAM #CCCCFF Global state = CONFIGURED Device state[HAL_SDRAM_CMD_DEVICE2] = IDLE end note note over App : Device state = IDLE,\nUser can start any process or execute any configuration. @enduml$

Called functions:

HAL_SDRAM_SendCommand()

Use case : Region remap and base address handling ¶

$@startuml == Initialization == "User Application"->"HAL SDRAM Driver" : HAL_SDRAM_Init() note right: Initialize the SDRAM handle and associate an instance.\n FMC clock is enabled in HAL_SDRAM_Init when USE_FMC_CLK_ENABLE_MODEL is set to HAL_CLK_ENABLE_PERIPH_ONLY "HAL SDRAM Driver" --> "User Application" : hal status : HAL_OK or HAL_INVALID_PARAM note right: Return "User Application"->"System" : SDRAM HW Initialization note right: Initialize GPIO "System" --> "User Application" "System" --> "User Application" group #LightBlue Optional: FMC region remap (after initialization) "User Application"->"HAL SDRAM Driver" : HAL_SDRAM_SetRegionRemap(&hsdram, remap_apply) "HAL SDRAM Driver" --> "User Application" : HAL_OK "User Application"->"HAL SDRAM Driver" : remap_readback = HAL_SDRAM_GetRegionRemap(&hsdram) end == Configuration == == Process == group #LightBlue Optional: Use base resolver under active remap "User Application"->"HAL SDRAM Driver" : base = HAL_SDRAM_GetDeviceBaseAddress(&hsdram, device) end "User Application"->"User Application" : User Read/Write operations @enduml$

Called functions: