ucs.h

Go to the documentation of this file.

/* Copyright 2012-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the software 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.
 */

#ifndef BSP430_PERIPH_UCS_H
#define BSP430_PERIPH_UCS_H

#include <bsp430/clock.h>
#include <bsp430/periph.h>

#define BSP430_MODULE_UCS (defined(__MSP430_HAS_UCS__)          \
                           || defined(__MSP430_HAS_UCS_RF__))

#if defined(BSP430_DOXYGEN) || (BSP430_MODULE_UCS - 0)

#ifndef configBSP430_UCS_TRIM_DCOCLKDIV
#define configBSP430_UCS_TRIM_DCOCLKDIV 1
#endif /* configBSP430_UCS_TRIM_DCOCLKDIV */

#if (configBSP430_UCS_TRIM_DCOCLKDIV - 0) && ! (configBSP430_TIMER_CCACLK - 0)
#warning configBSP430_UCS_TRIM_DCOCLKDIV requested without configBSP430_TIMER_CCACLK
#endif /* configBSP430_UCS_TRIM_DCOCLKDIV */

#if defined(BSP430_DOXYGEN)
#define BSP430_UCS_TRIM_DCOCLKDIV include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN) || (configBSP430_UCS_TRIM_DCOCLKDIV - 0)

int iBSP430ucsTrimDCOCLKDIV_ni ();
#endif /* configBSP430_UCS_TRIM_DCOCLKDIV */

#ifndef BSP430_UCS_FLL_SELREF
#define BSP430_UCS_FLL_SELREF SELREF__XT1CLK
#endif /* BSP430_UCS_FLL_SELREF */

/* Simplify conditionally-defined macros to avoid reference to
 * non-existent values. */
#if defined(XT2OFFG)
#define BSP430_UCS_XT2OFF_ XT2OFF
#define BSP430_UCS_XT2OFFG_ XT2OFFG
#else /* XT2OFFG */
#define BSP430_UCS_XT2OFF_ 0
#define BSP430_UCS_XT2OFFG_ 0
#endif /* XT2OFFG */
#if defined(XT1HFOFFG)
#define BSP430_UCS_XT1HFOFFG_ XT1HFOFFG
#else /* XT1HFOFFG */
#define BSP430_UCS_XT1HFOFFG_ 0
#endif /* XT1HFOFFG */

#define BSP430_UCS_DCO_IS_FAULTED_NI() (UCSCTL7 & DCOFFG)

#define BSP430_UCS_LFXT1_IS_FAULTED_NI() (UCSCTL7 & XT1LFOFFG)

#define BSP430_UCS_XT2_IS_FAULTED_NI() (UCSCTL7 & BSP430_UCS_XT2OFFG_)

#if defined(BSP430_DOXYGEN) || ! defined(BSP430_CLOCK_LFXT1_IS_FAULTED_NI)
#define BSP430_CLOCK_LFXT1_IS_FAULTED_NI() ((UCSCTL6 & XT1OFF) || BSP430_UCS_LFXT1_IS_FAULTED_NI())
#endif /* BSP430_CLOCK_LFXT1_IS_FAULTED_NI */

#if defined(BSP430_DOXYGEN) || ! defined(BSP430_CLOCK_XT2_IS_FAULTED_NI)
#define BSP430_CLOCK_XT2_IS_FAULTED_NI() ((UCSCTL6 & BSP430_UCS_XT2OFF_) || BSP430_UCS_XT2_IS_FAULTED_NI())
#endif /* BSP430_CLOCK_XT2_IS_FAULTED_NI */

#define BSP430_UCS_CLEAR_FAULTS_NI() do {                               \
    UCSCTL7 &= ~(BSP430_UCS_XT2OFFG_ | BSP430_UCS_XT1HFOFFG_ | XT1LFOFFG | DCOFFG); \
  } while (0)

#if defined(BSP430_DOXYGEN) || ! defined(BSP430_CLOCK_CLEAR_FAULTS_NI)
#define BSP430_CLOCK_CLEAR_FAULTS_NI() do {                             \
    BSP430_UCS_CLEAR_FAULTS_NI();                                       \
    BSP430_CLOCK_OSC_CLEAR_FAULT_NI();                                  \
  } while (0)
#endif /*  BSP430_CLOCK_CLEAR_FAULTS_NI */

#ifndef BSP430_CLOCK_LFXT1_XCAP

#define BSP430_CLOCK_LFXT1_XCAP XCAP_1
#endif /* BSP430_CLOCK_LFXT1_XCAP */

#if defined(BSP430_DOXYGEN) || defined(BSP430_PERIPH_XT2)

#undef BSP430_CLOCK_XT2_IS_FAULTED_NI

#define BSP430_CLOCK_XT2_IS_FAULTED_NI() (UCSCTL7 & XT2OFFG)

#endif /* BSP430_PERIPH_XT2 */

#define BSP430_CLOCK_NOMINAL_VLOCLK_HZ 10000U

#define BSP430_CLOCK_PUC_MCLK_HZ 1048576UL

#define BSP430_UCS_NOMINAL_REFOCLK_HZ 32768U

#ifndef BSP430_UCS_NOMINAL_MODCLK_HZ
#define BSP430_UCS_NOMINAL_MODCLK_HZ 5000000UL
#endif /* BSP430_UCS_NOMINAL_MODCLK_HZ */

/* Provide definition for clock system */
#define BSP430_NOMINAL_MODCLK_HZ BSP430_UCS_NOMINAL_MODCLK_HZ

#endif /* BSP430_MODULE_UCS */

#endif /* BSP430_PERIPH_UCS_H */