ref.h

Go to the documentation of this file.

//*****************************************************************************
//
// ref.h - Driver for the REF Module.
//
//*****************************************************************************
 
#ifndef __MSP430WARE_REF_H__
#define __MSP430WARE_REF_H__
 
#include "inc/hw_memmap.h"
 
#ifdef __MSP430_HAS_REF__
 
//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif
 
//*****************************************************************************
//
// The following are values that can be passed to the referenceVoltageSelect
// parameter for functions: Ref_setReferenceVoltage().
//
//*****************************************************************************
#define REF_VREF1_5V                                                (REFVSEL_0)
#define REF_VREF2_0V                                                (REFVSEL_1)
#define REF_VREF2_5V                                                (REFVSEL_2)
 
//*****************************************************************************
//
// The following are values that can be passed toThe following are values that
// can be returned by the Ref_isBandgapActive() function and the
// Ref_isRefGenActive() function.
//
//*****************************************************************************
#define REF_ACTIVE                                                         true
#define REF_INACTIVE                                                      false
 
//*****************************************************************************
//
// The following are values that can be passed toThe following are values that
// can be returned by the Ref_getBandgapMode() function.
//
//*****************************************************************************
#define REF_STATICMODE                                                     0x00
#define REF_SAMPLEMODE                                                   BGMODE
 
//*****************************************************************************
//
// The following are values that can be passed toThe following are values that
// can be returned by the Ref_isRefGenBusy() function.
//
//*****************************************************************************
#define REF_NOTBUSY                                                        0x00
#define REF_BUSY                                                     REFGENBUSY
 
//*****************************************************************************
//
// Prototypes for the APIs.
//
//*****************************************************************************
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void Ref_setReferenceVoltage(uint16_t baseAddress,
                                    uint8_t referenceVoltageSelect);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void Ref_disableTempSensor(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void Ref_enableTempSensor(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void Ref_enableReferenceVoltageOutput(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void Ref_disableReferenceVoltageOutput(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void Ref_enableReferenceVoltage(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void Ref_disableReferenceVoltage(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint16_t Ref_getBandgapMode(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool Ref_isBandgapActive(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint16_t Ref_isRefGenBusy(uint16_t baseAddress);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool Ref_isRefGenActive(uint16_t baseAddress);
 
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif
 
#endif
#endif // __MSP430WARE_REF_H__