cs.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_CS_H
#define BSP430_PERIPH_CS_H

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

#define BSP430_CS_IS_FR58XX (BSP430_PERIPH_CS_IS_CSA - 0)

#define BSP430_CS_IS_FR57XX (defined(__MSP430_HAS_CS__) && (! ((BSP430_PERIPH_CS_IS_CSA - 0) || (BSP430_PERIPH_CS_IS_CS4 - 0))))

#define BSP430_MODULE_CS ((BSP430_CS_IS_FR57XX - 0) || (BSP430_CS_IS_FR58XX - 0))

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

/* Simplify conditionally-defined macros to avoid reference to
 * non-existent values and inconsistencies between CS and CS_A. */
#if (BSP430_CS_IS_FR58XX - 0)
#define BSP430_CS_XT2DRIVE_ HFXTDRIVE
#define BSP430_CS_XT2OFF_ HFXTOFF
#define BSP430_CS_XT1DRIVE_ LFXTDRIVE
#define BSP430_CS_XTS_ 0
#define BSP430_CS_XT1BYPASS_ LFXTBYPASS
#define BSP430_CS_XT1OFF_ LFXTOFF
#define BSP430_CS_XT2OFFG_ HFXTOFFG
#define BSP430_CS_XT1OFFG_ LFXTOFFG
#else /* CS or CS_A */
#define BSP430_CS_XT2DRIVE_ XT2DRIVE
#define BSP430_CS_XT2OFF_ XT2OFF
#define BSP430_CS_XT1DRIVE_ XT1DRIVE
#define BSP430_CS_XTS_ XTS
#define BSP430_CS_XT1BYPASS_ XT1BYPASS
#define BSP430_CS_XT1OFF_ XT1OFF
#if defined(XT2OFFG)
#define BSP430_CS_XT2OFFG_ XT2OFFG
#else /* XT2OFFG */
#define BSP430_CS_XT2OFFG_ 0
#endif /* XT2OFFG */
#define BSP430_CS_XT1OFFG_ XT1OFFG
#endif /* CS or CS_A */

#if defined(BSP430_DOXYGEN) || (BSP430_CS_IS_FR58XX - 0)
/* CS_A has a significantly different set of capabilities */

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

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

#define BSP430_CS_NOMINAL_LFMODCLK_HZ (BSP430_CS_NOMINAL_MODCLK_HZ / 128)
#endif /* BSP430_CS_IS_FR58XX */

#define BSP430_CS_LFXT1_IS_FAULTED_NI() (CSCTL5 & BSP430_CS_XT1OFFG_)

#define BSP430_CS_XT2_IS_FAULTED_NI() (CSCTL5 & BSP430_CS_XT2OFFG_)

#if defined(BSP430_DOXYGEN) || ! defined(BSP430_CLOCK_LFXT1_IS_FAULTED_NI)
#define BSP430_CLOCK_LFXT1_IS_FAULTED_NI() ((CSCTL4 & BSP430_CS_XT1OFF_) || BSP430_CS_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() ((CSCTL4 & BSP430_CS_XT2OFF_) || BSP430_CS_XT2_IS_FAULTED_NI())
#endif /* BSP430_CLOCK_XT2_IS_FAULTED_NI */

#define BSP430_CS_CLEAR_FAULTS_NI() do {                        \
    CSCTL5 &= ~(BSP430_CS_XT2OFFG_ | BSP430_CS_XT1OFFG_);       \
  } while (0)

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

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

#define BSP430_CLOCK_NOMINAL_VLOCLK_HZ 10000U

#define BSP430_CLOCK_PUC_MCLK_HZ 1048576UL

#endif /* BSP430_MODULE_CS */

#endif /* BSP430_PERIPH_CS_H */