HAL OPAMP Overview

Introducing OPAMP

group OPAMP_Introduction

  • This introduction is under development.

Module and files

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

Module and files diagram

Component diagram

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



package "HAL" {

    [HAL_SERVICE]

    [HAL_OPAMP]

}



package "Low Layer" {

    [LL_OPAMP]

    [CMSIS]



}



package "HW" {

    [STM32_HW]

}



[Appli] --> [HAL_OPAMP] : HAL OPAMP API

[HAL_OPAMP] --> [LL_OPAMP] : LL OPAMP API

[HAL_OPAMP] -l-> [HAL_SERVICE] : HAL_GetTick

[LL_OPAMP] --> [CMSIS]:OPAMP register def

[STM32_HW] <-u-- [LL_OPAMP] : OPAMP registers R/W

@enduml

Configuration table

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

group OPAMP_Configuration_Table

Configuration inside the OPAMP driver

Config defines

Description

Default value

Note

USE_HAL_OPAMP_MODULE

from hal_conf.h

1

HAL OPAMP module is enabled

USE_HAL_OPAMP_CALIBRATE_PARALLEL

from hal_conf.h

0

enable the parallel calibration

USE_HAL_OPAMP_USER_DATA

from hal_conf.h

0

enable the user data

USE_HAL_OPAMP_CLK_ENABLE_MODEL

from hal_conf.h

HAL_CLK_ENABLE_NO

else clock is enabled inside HAL_OPAMP_Init()

USE_HAL_CHECK_PARAM

from hal_conf.h

0

to use the run-time checks on function parameters

USE_HAL_CHECK_PROCESS_STATE

from hal_conf.h

0

to use the run-time checks on the state during processing

USE_ASSERT_DBG_PARAM

Pre-processor env

None

to use the assert checks on function parameters

USE_ASSERT_DBG_STATE

Pre-processor env

None

to use the assert checks on module state