HAL HSP use cases ¶

Prerequisite ¶

This diagram illustrates the prerequisite steps for initializing the system

@startuml
==Prerequisite==

participant App as "User application"
participant "HAL GENERIC" as GENERIC
participant "System Driver" as RCC

App -> GENERIC : HAL_Init
GENERIC --> App
App -> RCC : Configure system clock
RCC --> App
@enduml

Full Initialization sequence ¶

$@startuml Title HSP initialization participant "User Application" as app participant "HAL HSP" as hal_hsp participant "HW HSP" as hw_hsp participant "HAL CORTEX\n(NVIC)" as hal_cortex participant "HAL RCC" as hal_rcc == HAL Initialization == app -> hal_cortex : HAL_Init app <-- hal_cortex app -> hal_rcc : Configure system clock app <-- hal_rcc == HSP HAL Initialization == hnote over hal_hsp : global_state = RESET app -> hal_hsp : HAL_HSP_Init() note over hal_hsp, hw_hsp When invoking HAL_HSP_Init(), the HSP bus clock might not be enabled. As a result, certain read/write operations to the HSP registers cannot be performed within this API. end note alt#grey #lightgrey If USE_HAL_HSP_CLK_ENABLE_MODEL > HAL_CLK_ENABLE_NO hal_hsp -> hal_rcc : HAL_RCC_HSP[x]_EnableClock() hal_hsp <-- hal_rcc end hnote over hal_hsp : global_state = INIT == HSP System Initialization == opt#grey #lightgrey If Interrupt needed app -> hal_cortex : Enable HSPx_IRQn app <-- hal_cortex end alt#grey #lightgrey If USE_HAL_HSP_CLK_ENABLE_MODEL == HAL_CLK_ENABLE_NO app -> hal_rcc : HAL_RCC_HSP[x]_EnableClock() app <-- hal_rcc end == HSP Configuration == note over app, hal_hsp: Use HAL HSP Driver APIs to configure some HSP interfaces. == HSP Boot == app -> hal_hsp: HAL_HSP_LoadFirmware() app <-- hal_hsp hnote over hal_hsp : global_state = READY_TO_BOOT opt#grey #lightgrey Load Plugins app -> hal_hsp : HAL_HSP_LoadPlugin() app <-- hal_hsp end app -> hal_hsp: HAL_HSP_Boot() app <-- hal_hsp: HAL_OK hnote over hal_hsp : global_state = RUNNING @enduml$

Called functions:

Full Deinitialization sequence ¶

$@startuml Title HSP Deinitialization participant "User Application" as app participant "HAL HSP" as hal_hsp participant "HW HSP" as hw_hsp participant "HAL CORTEX\n(NVIC)" as hal_cortex participant "HAL RCC" as hal_rcc == HSP DeInitialisation == app -> hal_hsp : HAL_HSP_DeInit() hal_hsp -> hw_hsp: Disable all ITs hal_hsp <-- hw_hsp hal_hsp -> hw_hsp: Clear all Flags hal_hsp <-- hw_hsp hal_hsp -> hw_hsp: HSP Reset Request note over hw_hsp #Orange: Flush SPE & HSPDMA transactions hal_hsp <-- hw_hsp hal_hsp -> hw_hsp: Clean the HAL handle hal_hsp <-- hw_hsp hnote over hal_hsp : global_state = RESET app <-- hal_hsp == HSP System DeInitialization == opt#grey #lightgrey If HSP Interrupt enabled app -> hal_cortex : Disable HSP NVIC app <-- hal_cortex end app -> hal_rcc : HAL_RCC_HSP[x]_Reset() hal_rcc --> app app -> hal_rcc : HAL_RCC_HSP[x]_DisableClock() hal_rcc --> app @enduml$

Called functions:

HAL_HSP_DeInit()

Warning

Add plantuml process diagrams