STM32L4xx_HAL_Driver  1.14.0
OPAMP Exported Functions

Modules

 Initialization and de-initialization functions
 Initialization and Configuration functions.
 
 IO operation functions
 IO operation functions.
 
 Peripheral Control functions
 Peripheral Control functions.
 
 Peripheral State functions
 Peripheral State functions.
 

Functions

HAL_StatusTypeDef HAL_OPAMP_RegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackID, pOPAMP_CallbackTypeDef pCallback)
 Register a User OPAMP Callback To be used instead of the weak (surcharged) predefined callback. More...
 
HAL_StatusTypeDef HAL_OPAMP_UnRegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackID)
 Unregister a User OPAMP Callback OPAMP Callback is redirected to the weak (surcharged) predefined callback. More...
 

Detailed Description

Function Documentation

◆ HAL_OPAMP_RegisterCallback()

HAL_StatusTypeDef HAL_OPAMP_RegisterCallback ( OPAMP_HandleTypeDef hopamp,
HAL_OPAMP_CallbackIDTypeDef  CallbackID,
pOPAMP_CallbackTypeDef  pCallback 
)

Register a User OPAMP Callback To be used instead of the weak (surcharged) predefined callback.

Parameters
hopamp: OPAMP handle
CallbackID: ID of the callback to be registered This parameter can be one of the following values:
pCallback: pointer to the Callback function
Return values
status

Definition at line 1037 of file stm32l4xx_hal_opamp.c.

1038 {
1039  HAL_StatusTypeDef status = HAL_OK;
1040 
1041  if(pCallback == NULL)
1042  {
1043  return HAL_ERROR;
1044  }
1045 
1046  /* Process locked */
1047  __HAL_LOCK(hopamp);
1048 
1049  if(hopamp->State == HAL_OPAMP_STATE_READY)
1050  {
1051  switch (CallbackID)
1052  {
1054  hopamp->MspInitCallback = pCallback;
1055  break;
1057  hopamp->MspDeInitCallback = pCallback;
1058  break;
1059  default :
1060  /* update return status */
1061  status = HAL_ERROR;
1062  break;
1063  }
1064  }
1065  else if (hopamp->State == HAL_OPAMP_STATE_RESET)
1066  {
1067  switch (CallbackID)
1068  {
1070  hopamp->MspInitCallback = pCallback;
1071  break;
1073  hopamp->MspDeInitCallback = pCallback;
1074  break;
1075  default :
1076  /* update return status */
1077  status = HAL_ERROR;
1078  break;
1079  }
1080  }
1081  else
1082  {
1083  /* update return status */
1084  status = HAL_ERROR;
1085  }
1086 
1087  /* Release Lock */
1088  __HAL_UNLOCK(hopamp);
1089  return status;
1090 }
__HAL_UNLOCK(hrtc)
__HAL_LOCK(hrtc)
return HAL_OK

◆ HAL_OPAMP_UnRegisterCallback()

HAL_StatusTypeDef HAL_OPAMP_UnRegisterCallback ( OPAMP_HandleTypeDef hopamp,
HAL_OPAMP_CallbackIDTypeDef  CallbackID 
)

Unregister a User OPAMP Callback OPAMP Callback is redirected to the weak (surcharged) predefined callback.

Parameters
hopamp: OPAMP handle
CallbackID: ID of the callback to be unregistered This parameter can be one of the following values:
Return values
status

Definition at line 1104 of file stm32l4xx_hal_opamp.c.

1105 {
1106  HAL_StatusTypeDef status = HAL_OK;
1107 
1108  /* Process locked */
1109  __HAL_LOCK(hopamp);
1110 
1111  if(hopamp->State == HAL_OPAMP_STATE_READY)
1112  {
1113  switch (CallbackID)
1114  {
1116  hopamp->MspInitCallback = HAL_OPAMP_MspInit;
1117  break;
1119  hopamp->MspDeInitCallback = HAL_OPAMP_MspDeInit;
1120  break;
1121  case HAL_OPAMP_ALL_CB_ID :
1122  hopamp->MspInitCallback = HAL_OPAMP_MspInit;
1123  hopamp->MspDeInitCallback = HAL_OPAMP_MspDeInit;
1124  break;
1125  default :
1126  /* update return status */
1127  status = HAL_ERROR;
1128  break;
1129  }
1130  }
1131  else if (hopamp->State == HAL_OPAMP_STATE_RESET)
1132  {
1133  switch (CallbackID)
1134  {
1136  hopamp->MspInitCallback = HAL_OPAMP_MspInit;
1137  break;
1139  hopamp->MspDeInitCallback = HAL_OPAMP_MspDeInit;
1140  break;
1141  default :
1142  /* update return status */
1143  status = HAL_ERROR;
1144  break;
1145  }
1146  }
1147  else
1148  {
1149  /* update return status */
1150  status = HAL_ERROR;
1151  }
1152 
1153  /* Release Lock */
1154  __HAL_UNLOCK(hopamp);
1155  return status;
1156 }
__HAL_UNLOCK(hrtc)
__HAL_LOCK(hrtc)
return HAL_OK
void HAL_OPAMP_MspDeInit(OPAMP_HandleTypeDef *hopamp)
DeInitialize OPAMP MSP.
void HAL_OPAMP_MspInit(OPAMP_HandleTypeDef *hopamp)
Initialize the OPAMP MSP.