ucs.h

Go to the documentation of this file.

//*****************************************************************************
//
// ucs.h - Driver for the UCS Module.
//
//*****************************************************************************
 
#ifndef __MSP430WARE_UCS_H__
#define __MSP430WARE_UCS_H__
 
#include "inc/hw_memmap.h"
 
#if defined(__MSP430_HAS_UCS__) || defined(__MSP430_HAS_UCS_RF__)
 
//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif
 
//*****************************************************************************
//
// Internal very low power VLOCLK, low frequency oscillator with 10 kHz typical
// frequency
//
//*****************************************************************************
#define UCS_VLOCLK_FREQUENCY                                              10000
 
//*****************************************************************************
//
// Internal, trimmed, low-frequency oscillator with 32768 Hz typical frequency
//
//*****************************************************************************
#define UCS_REFOCLK_FREQUENCY                                             32768
 
//*****************************************************************************
//
// The following are values that can be passed to the clockSourceDivider
// parameter for functions: UCS_initClockSignal().
//
//*****************************************************************************
#define UCS_CLOCK_DIVIDER_1                                             DIVM__1
#define UCS_CLOCK_DIVIDER_2                                             DIVM__2
#define UCS_CLOCK_DIVIDER_4                                             DIVM__4
#define UCS_CLOCK_DIVIDER_8                                             DIVM__8
#define UCS_CLOCK_DIVIDER_12                                           DIVM__32
#define UCS_CLOCK_DIVIDER_16                                           DIVM__16
#define UCS_CLOCK_DIVIDER_32                                           DIVM__32
 
//*****************************************************************************
//
// The following are values that can be passed to the selectedClockSignal
// parameter for functions: UCS_initClockSignal().
//
//*****************************************************************************
#define UCS_ACLK                                                           0x01
#define UCS_MCLK                                                           0x02
#define UCS_SMCLK                                                          0x04
#define UCS_FLLREF                                                         0x08
 
//*****************************************************************************
//
// The following are values that can be passed to the clockSource parameter for
// functions: UCS_initClockSignal().
//
//*****************************************************************************
#define UCS_XT1CLK_SELECT                                          SELM__XT1CLK
#define UCS_VLOCLK_SELECT                                          SELM__VLOCLK
#define UCS_REFOCLK_SELECT                                        SELM__REFOCLK
#define UCS_DCOCLK_SELECT                                          SELM__DCOCLK
#define UCS_DCOCLKDIV_SELECT                                    SELM__DCOCLKDIV
#define UCS_XT2CLK_SELECT                                          SELM__XT2CLK
 
//*****************************************************************************
//
// The following are values that can be passed to the xcap parameter for
// functions: UCS_turnOnLFXT1(), and UCS_turnOnLFXT1WithTimeout().
//
//*****************************************************************************
#define UCS_XCAP_0                                                       XCAP_0
#define UCS_XCAP_1                                                       XCAP_1
#define UCS_XCAP_2                                                       XCAP_2
#define UCS_XCAP_3                                                       XCAP_3
 
//*****************************************************************************
//
// The following are values that can be passed to the xt1drive parameter for
// functions: UCS_turnOnLFXT1(), UCS_turnOnHFXT1(),
// UCS_turnOnLFXT1WithTimeout(), and UCS_turnOnHFXT1WithTimeout().
//
//*****************************************************************************
#define UCS_XT1_DRIVE_0                                              XT1DRIVE_0
#define UCS_XT1_DRIVE_1                                              XT1DRIVE_1
#define UCS_XT1_DRIVE_2                                              XT1DRIVE_2
#define UCS_XT1_DRIVE_3                                              XT1DRIVE_3
 
//*****************************************************************************
//
// The following are values that can be passed to the highOrLowFrequency
// parameter for functions: UCS_bypassXT1(), and UCS_bypassXT1WithTimeout().
//
//*****************************************************************************
#define UCS_XT1_HIGH_FREQUENCY                                              XTS
#define UCS_XT1_LOW_FREQUENCY                                              0x00
 
//*****************************************************************************
//
// The following are values that can be passed to the xt2drive parameter for
// functions: UCS_turnOnXT2(), and UCS_turnOnXT2WithTimeout().
//
//*****************************************************************************
#define UCS_XT2_DRIVE_4MHZ_8MHZ                                      XT2DRIVE_0
#define UCS_XT2_DRIVE_8MHZ_16MHZ                                     XT2DRIVE_1
#define UCS_XT2_DRIVE_16MHZ_24MHZ                                    XT2DRIVE_2
#define UCS_XT2_DRIVE_24MHZ_32MHZ                                    XT2DRIVE_3
 
//*****************************************************************************
//
// The following are values that can be passed to the selectClock parameter for
// functions: UCS_enableClockRequest(), and UCS_disableClockRequest().
//
//*****************************************************************************
#define UCS_ACLK                                                           0x01
#define UCS_SMCLK                                                          0x04
#define UCS_MCLK                                                           0x02
#define UCS_MODOSC                                                  MODOSCREQEN
 
//*****************************************************************************
//
// The following are values that can be passed to the mask parameter for
// functions: UCS_getFaultFlagStatus(), and UCS_clearFaultFlag() as well as
// returned by the UCS_clearAllOscFlagsWithTimeout() function.
//
//*****************************************************************************
#define UCS_XT2OFFG                                                     XT2OFFG
#define UCS_XT1HFOFFG                                                 XT1HFOFFG
#define UCS_XT1LFOFFG                                                 XT1LFOFFG
#define UCS_DCOFFG                                                       DCOFFG
 
//*****************************************************************************
//
// Prototypes for the APIs.
//
//*****************************************************************************
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_setExternalClockSource(uint32_t XT1CLK_frequency,
                                       uint32_t XT2CLK_frequency);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_initClockSignal(uint8_t selectedClockSignal,
                                uint16_t clockSource,
                                uint16_t clockSourceDivider);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_turnOnLFXT1(uint16_t xt1drive,
                            uint8_t xcap);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_turnOnHFXT1(uint16_t xt1drive);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_bypassXT1(uint8_t highOrLowFrequency);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool UCS_turnOnLFXT1WithTimeout(uint16_t xt1drive,
                                       uint8_t xcap,
                                       uint16_t timeout);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool UCS_turnOnHFXT1WithTimeout(uint16_t xt1drive,
                                       uint16_t timeout);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool UCS_bypassXT1WithTimeout(uint8_t highOrLowFrequency,
                                     uint16_t timeout);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_turnOffXT1(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_turnOnXT2(uint16_t xt2drive);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_bypassXT2(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool UCS_turnOnXT2WithTimeout(uint16_t xt2drive,
                                     uint16_t timeout);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern bool UCS_bypassXT2WithTimeout(uint16_t timeout);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_turnOffXT2(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_initFLLSettle(uint16_t fsystem,
                              uint16_t ratio);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_initFLL(uint16_t fsystem,
                        uint16_t ratio);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_enableClockRequest(uint8_t selectClock);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_disableClockRequest(uint8_t selectClock);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint8_t UCS_getFaultFlagStatus(uint8_t mask);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_clearFaultFlag(uint8_t mask);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_turnOffSMCLK(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void UCS_turnOnSMCLK(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint32_t UCS_getACLK(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint32_t UCS_getSMCLK(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint32_t UCS_getMCLK(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint16_t UCS_clearAllOscFlagsWithTimeout(uint16_t timeout);
 
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif
 
#endif
#endif // __MSP430WARE_UCS_H__