bc2.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_BC2_H
#define BSP430_PERIPH_BC2_H

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

#define BSP430_MODULE_BC2 defined(__MSP430_HAS_BC2__)

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

#ifndef configBSP430_BC2_TRIM_TO_MCLK
#define configBSP430_BC2_TRIM_TO_MCLK 0
#endif /* configBSP430_BC2_TRIM_TO_MCLK */

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

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

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

int iBSP430bc2TrimToMCLK_ni (unsigned long mclk_Hz);
#endif /* configBSP430_BC2_TRIM_TO_MCLK */

/* Simplify conditionally-defined macros to avoid reference to
 * non-existent values.  The chip supports an external crystal for
 * LFXT1 iff LFXT1S_0 is defined */
#if defined(XT2OF)
#define BSP430_BC2_XT2OF_ XT2OF
#else /* XT2OF */
#define BSP430_BC2_XT2OF_ 0
#endif /* XT2OF */
#if defined(LFXT1OF)
#define BSP430_BC2_LFXT1OF_ LFXT1OF
#else /* LFXT1OF */
#define BSP430_BC2_LFXT1OF_ 0
#endif /* LFXT1OF */

#define BSP430_BC2_LFXT1_IS_FAULTED_NI() (BCSCTL3 & BSP430_BC2_LFXT1OF_)

#define BSP430_BC2_XT2_IS_FAULTED_NI() (BC2CTL3 & BSP430_BC2_XT2OF_)

#if defined(BSP430_DOXYGEN) || ! defined(BSP430_CLOCK_LFXT1_IS_FAULTED_NI)
#define BSP430_CLOCK_LFXT1_IS_FAULTED_NI() ((BCSCTL3 & (LFXT1S0 | LFXT1S1)) || BSP430_BC2_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() ((BCSCTL1 & XT2OFF) || BSP430_BC2_XT2_IS_FAULTED_NI())
#endif /* BSP430_CLOCK_XT2_IS_FAULTED_NI */

#if defined(BSP430_DOXYGEN) || ! defined(BSP430_CLOCK_CLEAR_FAULTS_NI)
#define BSP430_CLOCK_CLEAR_FAULTS_NI() do {                             \
    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 */

#define BSP430_CLOCK_NOMINAL_VLOCLK_HZ 12000U

#define BSP430_CLOCK_PUC_MCLK_HZ 1100000UL

#endif /* BSP430_MODULE_BC2 */

#endif /* BSP430_PERIPH_BC2_H */