stm32l4xx_hal_opamp.h File Reference

Header file of OPAMP HAL module. More...

#include "stm32l4xx_hal_def.h"
#include "stm32l4xx_hal_opamp_ex.h"

Go to the source code of this file.

Data Structures
struct	OPAMP_InitTypeDef
	OPAMP Init structure definition. More...
struct	__OPAMP_HandleTypeDef
	OPAMP Handle Structure definition. More...
Defines
#define	OPAMP_STANDALONE_MODE   ((uint32_t)0x00000000)
#define	OPAMP_PGA_MODE   OPAMP_CSR_OPAMODE_1
#define	OPAMP_FOLLOWER_MODE   OPAMP_CSR_OPAMODE
#define	OPAMP_NONINVERTINGINPUT_IO0   ((uint32_t)0x00000000)
#define	OPAMP_NONINVERTINGINPUT_DAC_CH   OPAMP_CSR_VPSEL
#define	OPAMP_INVERTINGINPUT_IO0   ((uint32_t)0x00000000)
#define	OPAMP_INVERTINGINPUT_IO1   OPAMP_CSR_VMSEL_0
#define	OPAMP_INVERTINGINPUT_CONNECT_NO   OPAMP_CSR_VMSEL_1
#define	OPAMP_PGA_GAIN_2   ((uint32_t)0x00000000)
#define	OPAMP_PGA_GAIN_4   OPAMP_CSR_PGGAIN_0
#define	OPAMP_PGA_GAIN_8   OPAMP_CSR_PGGAIN_1
#define	OPAMP_PGA_GAIN_16   (OPAMP_CSR_PGGAIN_0 | OPAMP_CSR_PGGAIN_1)
#define	OPAMP_POWERMODE_NORMAL   ((uint32_t)0x00000000)
#define	OPAMP_POWERMODE_LOWPOWER   OPAMP_CSR_OPALPM
#define	OPAMP_POWERSUPPLY_LOW   ((uint32_t)0x00000000)
#define	OPAMP_POWERSUPPLY_HIGH   OPAMP1_CSR_OPARANGE
#define	OPAMP_TRIMMING_FACTORY   ((uint32_t)0x00000000)
#define	OPAMP_TRIMMING_USER   OPAMP_CSR_USERTRIM
#define	OPAMP_FACTORYTRIMMING_DUMMY   ((uint32_t)0xFFFFFFFF)
#define	OPAMP_FACTORYTRIMMING_N   ((uint32_t)0x00000000)
#define	OPAMP_FACTORYTRIMMING_P   ((uint32_t)0x00000001)
#define	OPAMP_INPUT_NONINVERTING   ((uint32_t) 8)
#define	OPAMP_TRIMMING_DELAY   ((uint32_t) 1)
#define	__HAL_OPAMP_RESET_HANDLE_STATE(__HANDLE__)
	Reset OPAMP handle state.
#define	IS_OPAMP_FUNCTIONAL_NORMALMODE(INPUT)
#define	IS_OPAMP_INVERTING_INPUT_STANDALONE(INPUT)
#define	IS_OPAMP_NONINVERTING_INPUT(INPUT)
#define	IS_OPAMP_INVERTING_INPUT_PGA(INPUT)
#define	IS_OPAMP_PGA_GAIN(GAIN)
#define	IS_OPAMP_POWERMODE(TRIMMING)
#define	IS_OPAMP_POWER_SUPPLY_RANGE(RANGE)
#define	IS_OPAMP_TRIMMING(TRIMMING)
#define	IS_OPAMP_TRIMMINGVALUE(TRIMMINGVALUE)   ((TRIMMINGVALUE) <= 0x1F)
#define	IS_OPAMP_FACTORYTRIMMING(TRIMMING)
Typedefs
typedef struct __OPAMP_HandleTypeDef	OPAMP_HandleTypeDef
	OPAMP Handle Structure definition.
typedef uint32_t	HAL_OPAMP_TrimmingValueTypeDef
	HAl_OPAMP_TrimmingValueTypeDef definition.
typedef void(*	pOPAMP_CallbackTypeDef )(OPAMP_HandleTypeDef *hopamp)
	HAL OPAMP Callback pointer definition.
Enumerations
enum	HAL_OPAMP_StateTypeDef {   HAL_OPAMP_STATE_RESET = 0x00000000, HAL_OPAMP_STATE_READY = 0x00000001, HAL_OPAMP_STATE_CALIBBUSY = 0x00000002, HAL_OPAMP_STATE_BUSY = 0x00000004,   HAL_OPAMP_STATE_BUSYLOCKED = 0x00000005 }
	HAL State structures definition. More...
enum	HAL_OPAMP_CallbackIDTypeDef { HAL_OPAMP_MSP_INIT_CB_ID = 0x01U, HAL_OPAMP_MSP_DEINIT_CB_ID = 0x02U, HAL_OPAMP_ALL_CB_ID = 0x03U }
	HAL OPAMP Callback ID enumeration definition. More...
Functions
HAL_StatusTypeDef	HAL_OPAMP_Init (OPAMP_HandleTypeDef *hopamp)
	Initializes the OPAMP according to the specified parameters in the OPAMP_InitTypeDef and initialize the associated handle.
HAL_StatusTypeDef	HAL_OPAMP_DeInit (OPAMP_HandleTypeDef *hopamp)
	DeInitialize the OPAMP peripheral.
__weak void	HAL_OPAMP_MspInit (OPAMP_HandleTypeDef *hopamp)
	Initialize the OPAMP MSP.
__weak void	HAL_OPAMP_MspDeInit (OPAMP_HandleTypeDef *hopamp)
	DeInitialize OPAMP MSP.
HAL_StatusTypeDef	HAL_OPAMP_Start (OPAMP_HandleTypeDef *hopamp)
	Start the OPAMP.
HAL_StatusTypeDef	HAL_OPAMP_Stop (OPAMP_HandleTypeDef *hopamp)
	Stop the OPAMP.
HAL_StatusTypeDef	HAL_OPAMP_SelfCalibrate (OPAMP_HandleTypeDef *hopamp)
	Run the self calibration of one OPAMP.
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.
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.
HAL_StatusTypeDef	HAL_OPAMP_Lock (OPAMP_HandleTypeDef *hopamp)
	Lock the selected OPAMP configuration.
HAL_OPAMP_TrimmingValueTypeDef	HAL_OPAMP_GetTrimOffset (OPAMP_HandleTypeDef *hopamp, uint32_t trimmingoffset)
	Return the OPAMP factory trimming value.
HAL_OPAMP_StateTypeDef	HAL_OPAMP_GetState (OPAMP_HandleTypeDef *hopamp)
	Return the OPAMP handle state.

---

Detailed Description

Header file of OPAMP HAL module.

Author:

MCD Application Team

Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32l4xx_hal_opamp.h.