HAL DSI Overview

Introducing DSI

group DSI_Introduction

  • This introduction is under development.

Module and files

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

Module and files diagram

Component diagram

The following diagram illustrates the software components involved in the DSI 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 DSI Software Component Diagram



package "HAL" {

    [HAL_SERVICE]

    [HAL_DSI]

}



package "Low Layer" {

    [DSI Interrupt Service Routine]

    [CMSIS]

}



package "HW" {

    [STM32_HW]

}



[Appli] --> [HAL_DSI] : HAL DSI API

[HAL_DSI] --> [Appli] : DSI Callback

[HAL_DSI] <-- [DSI Interrupt Service Routine]

[STM32_HW] -up-> [DSI Interrupt Service Routine]: DSI IRQ

@enduml

Configuration table

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

group DSI_Configuration_Table

Configuration inside the DSI driver

Config defines

Description

Default value

Note

USE_HAL_DSI_MODULE

from hal_conf.h

1

When set, HAL DSI module is enabled

USE_HAL_DSI_REGISTER_CALLBACKS

from hal_conf.h

0

When set, enable the register callbacks

USE_HAL_DSI_CLK_ENABLE_MODEL

from hal_conf.h

HAL_CLK_ENABLE_NO

Enable the gating of the peripheral clock

USE_HAL_CHECK_PARAM

from hal_conf.h

0

When set, the vital parameters (pointers or sizes) are checked in runtime

USE_ASSERT_DBG_PARAM

from PreProcessor env

None

When defined, enable the params assert

USE_ASSERT_DBG_STATE

from PreProcessor env

None

When defined, enable the state assert

USE_HAL_DSI_USER_DATA

from hal_conf.h

0

When set, user data is defined in handle

USE_HAL_DSI_GET_LAST_ERRORS

from hal_conf.h

0

When set, user can get the last error code