dl_vref.h File Reference

Detailed Description

Voltage Reference (VREF) Driver Library.

---

#include <stdbool.h>
#include <stdint.h>
#include <ti/devices/msp/msp.h>
#include <ti/driverlib/dl_common.h>

Include dependency graph for dl_vref.h:

Go to the source code of this file.

Data Structures
struct	DL_VREF_ClockConfig
	Configuration struct for DL_VREF_setClockConfig. More...
struct	DL_VREF_Config
	Configuration struct for DL_VREF_Config. More...

Macros
#define	DL_VREF_CTL1_READY_NOTRDY   (VREF_CTL1_READY_NOTRDY)
	VREF bit in CTL1 indicating the module is ready is not set.
#define	DL_VREF_CTL1_READY_RDY   (VREF_CTL1_READY_RDY)
	VREF bit in CTL1 indicating the module is ready is set.
#define	DL_VREF_SH_MIN   (VREF_CTL2_SHCYCLE_MINIMUM)
	Minimum value for VREF sample and hold, if enabled.
#define	DL_VREF_SH_MAX   (VREF_CTL2_SHCYCLE_MAXIMUM)
	Maximum value for VREF sample and hold, if enabled.
#define	DL_VREF_HOLD_MIN   (VREF_CTL2_HCYCLE_MINIMUM)
	Minimum value for VREF hold, if enabled.
#define	DL_VREF_HOLD_MAX   (VREF_CTL2_HCYCLE_MAXIMUM)
	Maximum value for VREF hold, if enabled.

Enumerations
enum	DL_VREF_CLOCK {   DL_VREF_CLOCK_LFCLK = VREF_CLKSEL_LFCLK_SEL_MASK,   DL_VREF_CLOCK_MFCLK = VREF_CLKSEL_MFCLK_SEL_MASK,   DL_VREF_CLOCK_BUSCLK = VREF_CLKSEL_BUSCLK_SEL_MASK }
enum	DL_VREF_CLOCK_DIVIDE {   DL_VREF_CLOCK_DIVIDE_1 = 0,   DL_VREF_CLOCK_DIVIDE_2 = 1,   DL_VREF_CLOCK_DIVIDE_4 = 3,   DL_VREF_CLOCK_DIVIDE_6 = 5,   DL_VREF_CLOCK_DIVIDE_8 = 7 }
enum	DL_VREF_ENABLE {   DL_VREF_ENABLE_DISABLE = VREF_CTL0_ENABLE_DISABLE,   DL_VREF_ENABLE_ENABLE = VREF_CTL0_ENABLE_ENABLE }
enum	DL_VREF_BUFCONFIG {   DL_VREF_BUFCONFIG_OUTPUT_2_5V = VREF_CTL0_BUFCONFIG_OUTPUT2P5V,   DL_VREF_BUFCONFIG_OUTPUT_1_4V = VREF_CTL0_BUFCONFIG_OUTPUT1P4V }
enum	DL_VREF_SHMODE {   DL_VREF_SHMODE_DISABLE = VREF_CTL0_SHMODE_DISABLE,   DL_VREF_SHMODE_ENABLE = VREF_CTL0_SHMODE_ENABLE }

Functions
__STATIC_INLINE void	DL_VREF_enablePower (VREF_Regs *vref)
	Enables the Peripheral Write Enable (PWREN) register for the VREF. More...
__STATIC_INLINE void	DL_VREF_disablePower (VREF_Regs *vref)
	Disables the Peripheral Write Enable (PWREN) register for the VREF. More...
__STATIC_INLINE bool	DL_VREF_isPowerEnabled (VREF_Regs *vref)
	Returns if the Peripheral Write Enable (PWREN) register for the VREF is enabled. More...
__STATIC_INLINE void	DL_VREF_enableInternalRef (VREF_Regs *vref)
	Enables Internal VREF. More...
__STATIC_INLINE void	DL_VREF_disableInternalRef (VREF_Regs *vref)
	Disables Internal VREF, allows for External VREF. More...
__STATIC_INLINE bool	DL_VREF_isEnabled (const VREF_Regs *vref)
	Checks if the internal VREF is enabled. More...
__STATIC_INLINE void	DL_VREF_enableInternalRefCOMP (VREF_Regs *vref)
	Enable VREF buffer as internal reference input for comparator. More...
__STATIC_INLINE bool	DL_VREF_isInternalRefCOMPEnabled (const VREF_Regs *vref)
	Checks if VREF buffer for comparator is enabled. More...
__STATIC_INLINE void	DL_VREF_disableInternalRefCOMP (VREF_Regs *vref)
	Disable VREF buffer as internal reference input for comparator. More...
void	DL_VREF_setClockConfig (VREF_Regs *vref, const DL_VREF_ClockConfig *config)
	Set the clock select and clock divide fields in VREF. More...
void	DL_VREF_getClockConfig (const VREF_Regs *vref, DL_VREF_ClockConfig *config)
	Copy the clock select and clock divide fields in VREF to config. More...
__STATIC_INLINE void	DL_VREF_reset (VREF_Regs *vref)
	Resets the VREF module. More...
__STATIC_INLINE bool	DL_VREF_isReset (const VREF_Regs *vref)
	Returns if VREF peripheral was reset. More...
__STATIC_INLINE uint32_t	DL_VREF_getStatus (const VREF_Regs *vref)
	Returns VREF register status. More...
void	DL_VREF_configReference (VREF_Regs *vref, const DL_VREF_Config *config)
	Configure VREF enable, control registers. More...