HAL OPAMP Use Cases ¶

User Application Initialization of the OPAMP Driver ¶

$@startuml title Use case: initialization end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == note over user: start the OPAMP initialization user -> opamp : HAL_OPAMP_Init() note over opamp : associate a OPAMP instance to an handle opamp --> user : HAL_OK or HAL_INVALID_PARAM note right: return hal_opamp_status_t == OPAMP system initialization == user -> system : HAL_RCC_OPAMP_EnableClock() system --> user note over user, system: enable the OPAMP clock\n HAL_RCC_OPAMP_EnableClock() is also called inside HAL_OPAMP_Init() whenever \n (USE_HAL_OPAMP_CLK_ENABLE_MODEL \t != \t HAL_CLK_ENABLE_NO) == Peripherals dependencies initialization == opt when GPIO needed user -> system : HAL_RCC_GPIOx_EnableClock() user -> system : HAL_GPIO_Init(...) end == OPAMP configuration == note over opamp : by default configuration is:\n power_mode = normal \n speed_mode = normal\n STANDALONE \n normal mode (ie calibration disabled)\n non-inverted input connected to GPIO \n inverted input connected to GPIO\n PGA gain = x2 \n OPAMP disabled\n group optionnal user -> opamp : HAL_OPAMP_SetConfig() opamp --> user : HAL_OK or HAL_INVALID_PARAM end == OPAMP processing == user -> opamp : HAL_OPAMP_Start() opamp --> user: HAL_OK == == @enduml$

Functions called:

OPAMP Deinitialization by User Application, Minimal Sequence ¶

@startuml

title
 OPAMP deinitialization,
 minimal sequence

end title

participant "User application" as user
participant "OPAMP driver" as opamp
participant "System driver" as system

==OPAMP deinitialization==
user -> opamp : HAL_OPAMP_Stop()
opamp --> user
user -> opamp : HAL_OPAMP_DeInit()
== ==

@enduml

Functions called:

OPAMP Deinitialization by User Application, Full Sequence ¶

Functions called:

Use Case: OPAMP Reset Configuration ¶

$@startuml title Use case: OPAMP reset configuration end title participant "User application" as user participant "OPAMP driver" as opamp == OPAMP initialization == == OPAMP configuration == alt optional user -> opamp : HAL_OPAMP_SetConfig( hopampx, p_config ) opamp --> user: HAL_OK or HAL_INVALID_PARAM end == OPAMP processing == user -> opamp : HAL_OPAMP_Start( hopampx ) note right: ACTIVE state == Stop OPAMP channel, then reset configuration == user -> opamp : HAL_OPAMP_Stop( hopampx ) note right: IDLE state user -> opamp : HAL_OPAMP_ResetConfig( hopampx ) note right: Reset to the default parameters configuration of the OPAMP:\n power_mode = normal \n speed_mode = normal\n STANDALONE \n normal mode (ie calibration disabled)\n non-inverted input connected to GPIO \n inverted input connected to GPIO\n PGA gain = x2 \n OPAMP disabled\n\n Note: user trimming mode remains unchanged \n\n IDLE state == == @enduml$

Functions called:

Use Case: OPAMP Set Configuration in Standalone Mode, Detailed Sequence ¶

$@startuml title Use case: OPAMP set configuration in STANDALONE mode (external gain setting mode) detailed sequence end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP configuration STANDALONE == group optionnal user -> opamp : HAL_OPAMP_SetConfig() \n \n note right: power_mode = normal , low\n speed_mode = normal , high \n configuration = STANDALONE \n \n default connections:\n non inverting_input VINP = GPIO connected \n inverting_input VINM = GPIO connected \n output pin = connected internally to an ADC input, and by user to GPIO non-inverting input (through filtering component)\n\n factory trimming opamp --> user end opt optionnal user -> opamp : HAL_OPAMP_SetConfigInputConnection(...) note right: VINM can be connected internally to _DAC1_CH1 end == OPAMP processing == user -> opamp : HAL_OPAMP_Start() note right: OPAMP is operationnal in STANDALONE mode opamp --> user opt optionnal user -> system : HAL_RCC_OPAMP_DisableClock() note right: the clock is switched off, \nthe opamp register can no more been accessed,\n OPAMP still running as STANDALONE end == == @enduml$

Functions called:

Use Case: OPAMP Set Configuration in Follower Mode, Detailed Sequence ¶

$@startuml title Use case: OPAMP set configuration in FOLLOWER mode detailed sequence end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP configuration FOLLOWER == group compulsory user -> opamp : HAL_OPAMP_SetConfig() \n \n note right: power_mode = normal , low\n speed_mode = normal , high \n configuration = FOLLOWER \n \n default connections:\n non inverting_input VINP = GPIO connected \n inverting_input VINM = inverting input not externally connected \n output pin = connected internally to an ADC input\n\n factory trimming opamp --> user end opt optionnal user -> opamp : HAL_OPAMP_SetConfigInputConnection(...) note right: VINM can be connected internally to _DAC1_CH1 end == OPAMP processing == user -> opamp : HAL_OPAMP_Start() note right: OPAMP is operationnal in FOLLOWER mode opamp --> user opt optionnal user -> system : HAL_RCC_OPAMP_DisableClock() note right: the clock is switched off, \nthe opamp register can no more been accessed,\n OPAMP still running as FOLLOWER end == == @enduml$

Functions called:

Use Case: OPAMP Set Configuration in Programmable Gain Amplifier Mode, Detailed Sequence ¶

$@startuml title Use case: OPAMP set configuration in PROGRAMMABLE GAIN AMPLIFIER mode, internal gain setting (x2, x4, x8, x16), detailed sequence end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP configuration GAIN AMPLIFIER == group compulsory user -> opamp : HAL_OPAMP_SetConfig() \n \n note right: power_mode = normal , low\n speed_mode = normal , high \n configuration = GAIN AMPLIFIER \n \n default connections:\n non inverting_input VINP = GPIO connected \n inverting_input VINM = not use, is not externally connected \n output pin = connected internally to an ADC input\n\n factory trimming opamp --> user : HAL_OK or HAL_INVALID_PARAM user -> opamp : HAL_OPAMP_SetGain( gain ) note right:\n PGA gain set to x2, x4, x8 or x16 \n opamp --> user : HAL_OK end opt optionnal user -> opamp : HAL_OPAMP_SetConfigInputConnection(...) note right: VINP can be connected internally to _DAC1_CH1 opamp --> user : HAL_OK or HAL_INVALID_PARAM end == OPAMP processing == user -> opamp : HAL_OPAMP_Start() note right: OPAMP is operationnal in GAIN AMPLIFIER mode opamp --> user opt optionnal user -> system : HAL_RCC_OPAMP_DisableClock() note right: the clock is switched off, \nthe opamp register can no more been accessed,\n OPAMP still running as GAIN AMPLIFIER end == == @enduml$

Functions called:

Use Case: OPAMP Set Configuration in Programmable Gain Amplifier with External Filtering Mode, Detailed Sequence ¶

$@startuml title Use case: OPAMP set configuration in PROGRAMMABLE GAIN AMPLIFIER internal gain setting (x2, x4, x8, x16), with external filtering, detailed sequence end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP configuration GAIN AMPLIFIER EXTERNAL FILTERING == group compulsory user -> opamp : HAL_OPAMP_SetConfig() \n \n note right: power_mode = normal , low\n speed_mode = normal , high \n configuration = GAIN AMPLIFIER \n \n default connections:\n non inverting_input VINP = GPIO connected \n inverting_input VINM = not use, is not externally connected \n output pin = connected internally to an ADC input\n\n factory trimming opamp --> user : HAL_OK or HAL_INVALID_PARAM user -> opamp : HAL_OPAMP_SetConfigInputConnection( ... ) note right: non_inverting_input VINM = GPIO connected or _DAC1_CH1 \n inverting_input VINM = GPIO connected opamp --> user : HAL_OK user -> opamp : HAL_OPAMP_SetGain( gain ) note right:\n PGA gain set to x2, x4, x8 or x16 \n opamp --> user : HAL_OK user --> opamp : user add an external capacitor note right:\n For example, a capacitor can be connected between VOUT and VINM for filtering purpose,\n the gain depends on the cut-off frequency. opamp --> user : HAL_OK end == OPAMP processing == user -> opamp : HAL_OPAMP_Start() note right: OPAMP is operationnal in GAIN AMPLIFIER mode opamp --> user opt optionnal user -> system : HAL_RCC_OPAMP_DisableClock() note right: the clock is switched off, \nthe opamp register can no more been accessed,\n OPAMP still running as GAIN AMPLIFIER EXTERNAL FILTERING end == == @enduml$

Functions called:

User Application Calibration in Parallel for Multi OPAMP in Normal-Power Mode ¶

$@startuml title Use case: calibration in parallel for multi opamp in normal-power mode end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization opamp -> opamp: note right: IDLE state end == OPAMP calibration == user -> opamp : HAL_OPAMP_SetLinkNextHandle( hopampX, hopampY )\n \n note right: circular chained list = [ hopampX, hopampY ] user -> opamp : HAL_OPAMP_SetLinkNextHandle( hopampY, hopampZ )\n \n note right: circular chained list = [ hopampX, hopampY, hopampZ ] user -> opamp : HAL_OPAMP_CalibrateParallel( hopampX , normal-power) note right: CALIB state opamp --> user : HAL_OK or HAL_INVALID_PARAM note right: when HAL_OK is returned, those parameters are set for each opamp of list_of_hopamp : \n . normal-power trimming for PMOS (high voltage) differential pairs , \n . normal-power trimming for NMOS (low voltage) differential pairs. == OPAMP configuration set in normal-power mode == user -> opamp : HAL_OPAMP_SetConfig() \n \n note right: power_mode = normal \nspeed_mode = normal , high \nconfiguration = FOLLOWER, STANDALONE, GAIN AMPLIFIER \n \n default connections\n user trimming opamp --> user : HAL_OK or HAL_INVALID_PARAM note right: IDLE state == OPAMP processing with user trimming in normal-power mode == user -> opamp : HAL_OPAMP_Start() note right: ACTIVE state == == @enduml$

Functions called:

HAL_OPAMP_SetLinkNextHandle()
HAL_OPAMP_CalibrateParallel()
HAL_OPAMP_SetConfig()
HAL_OPAMP_Start()

User Application Calibration for a Single OPAMP in Normal-Power Mode ¶

$@startuml title Use case: calibration for a single opamp in normal-power mode, the configuration mode is unchanged. end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization opamp -> opamp: note right: IDLE state end == OPAMP configuration set in normal-power mode == user -> opamp : HAL_OPAMP_SetConfig( hopampx ) \n \n note right: power_mode = normal \nspeed_mode = normal , high \nconfiguration = FOLLOWER, STANDALONE, GAIN AMPLIFIER \n \n default connections\n user trimming opamp --> user : HAL_OK or HAL_INVALID_PARAM note right: IDLE state == OPAMP processing with user trimming in normal-power mode == user -> opamp : HAL_OPAMP_Start( hopampx ) note right: ACTIVE state user -> opamp : HAL_OPAMP_Stop( hopampx ) note right: IDLE state == OPAMP calibration == user -> opamp : HAL_OPAMP_Calibrate( hopampx, normal-power ) note right: CALIB state opamp --> user : HAL_OK or HAL_INVALID_PARAM note right: when HAL_OK is returned, those parameters are set for hopampx : \n . normal-power trimming for PMOS (high voltage) differential pairs , \n . normal-power trimming for NMOS (low voltage) differential pairs.\n . the configuration mode is unchanged\n\n\n IDLE state == == @enduml$

Functions called:

User Application Calibration for a Single OPAMP in Low-Power Mode ¶

$@startuml title Use case: calibration for a single opamp in low-power mode, the configuration mode is unchanged. end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization opamp -> opamp: note right: IDLE state end == OPAMP configuration set in low-power mode == user -> opamp : HAL_OPAMP_SetConfig( hopampx ) \n \n note right: power_mode = low \nspeed_mode = normal , high \nconfiguration = FOLLOWER, STANDALONE, GAIN AMPLIFIER \n \n default connections\n user trimming opamp --> user : HAL_OK or HAL_INVALID_PARAM note right: IDLE state == OPAMP processing with user trimming in low-power mode == user -> opamp : HAL_OPAMP_Start( hopampx ) note right: ACTIVE state user -> opamp : HAL_OPAMP_Stop( hopampx ) note right: IDLE state == OPAMP calibration processing == user -> opamp : HAL_OPAMP_Calibrate( hopampx, low-power ) note right: CALIB state opamp --> user : HAL_OK or HAL_INVALID_PARAM note right: when HAL_OK is returned, those parameters are set for hopampx : \n . low-power trimming for PMOS (high voltage) differential pairs , \n . low-power trimming for NMOS (low voltage) differential pairs.\n . the configuration mode is unchanged\n\n IDLE state == == @enduml$

Functions called:

User Application Retrieve Factory Offset Trimming in Normal-Power Mode ¶

$@startuml title Use case: retrieve FACTORY offset trimming in normal-power mode end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP retrieve factory offset trimming == user -> opamp : HAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode FACTORY user -> opamp : \n\nHAL_OPAMP_GetConfigTrimming( hopampx, *p_config, normal-power ) note right opamp: to be call before HAL_OPAMP_CalibrateXXX() \nand before HAL_OPAMP_SetConfigTrimming() note right opamp: when HAL_OK is returned, p_config is filled with those retrieved parameters: \n - normal-power factory offset trimming for PMOS (high voltage) differential pairs , \n - normal-power factory offset trimming for NMOS (low voltage) differential pairs. user -> opamp : \n\nHAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode FACTORY == == @enduml$

Functions called:

User Application Retrieve Factory Offset Trimming in Low-Power Mode ¶

$@startuml title Use case: retrieve FACTORY offset trimming in low-power mode end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP retrieve factory offset trimming == user -> opamp : HAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode FACTORY user -> opamp : \n\n HAL_OPAMP_GetConfigTrimming( hopampx, *p_config , low-power) note right opamp: to be call before HAL_OPAMP_CalibrateXXX() \nand before HAL_OPAMP_SetConfigTrimming() note right opamp: when HAL_OK is returned, p_config is filled with those retrieved parameters: \n - low-power factory offset trimming for PMOS (high voltage) differential pairs , \n - low-power factory offset trimming for NMOS (low voltage) differential pairs. user -> opamp : \n\nHAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode FACTORY == == @enduml$

Functions called:

User Application Retrieve User Offset Trimming in Normal-Power Mode ¶

$@startuml title Use case: retrieve USER offset trimming in normal-power mode end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP retrieve user offset trimming == user -> opamp : HAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode FACTORY user -> opamp : \n\nneed to be called at first to compute and set the user offset trimming\n HAL_OPAMP_Calibrate( hopampx, normal-power ) user -> opamp : \n\nHAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode USER user -> opamp : \n\nthen retrieve the user offset trimming\n HAL_OPAMP_GetConfigTrimming( hopampx, *p_config, normal-power ) note right opamp: when HAL_OK is returned, p_config is filled with those retrieved parameters: \n - normal-power user offset trimming for PMOS (high voltage) differential pairs , \n - normal-power user offset trimming for NMOS (low voltage) differential pairs. user -> opamp : HAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode USER == == @enduml$

Functions called:

User Application Retrieve User Offset Trimming in Low-Power Mode ¶

$@startuml title Use case: retrieve USER offset trimming in low-power mode end title ' Fix order of each column participant "User application" as user participant "OPAMP driver" as opamp participant "System driver" as system == OPAMP initialization == group initialization end == OPAMP retrieve user offset trimming == user -> opamp : HAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode FACTORY user -> opamp : \n\nneed to be called at first to compute and set the user offset trimming \n HAL_OPAMP_Calibrate( hopampx, low-power ) user -> opamp : \n\nHAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode USER user -> opamp : \n then retrieve the user offset trimming \n HAL_OPAMP_GetConfigTrimming( hopampx,*p_config, low-power) note right opamp: when HAL_OK is returned, p_config is filled with those retrieved parameters: \n - low-power user offset trimming for PMOS (high voltage) differential pairs , \n - low-power user offset trimming for NMOS (low voltage) differential pairs. user -> opamp : HAL_OPAMP_GetTrimmingMode( hopampx ); opamp -> user : trimming mode USER == == @enduml$

Functions called: