core.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_CORE_H
#define BSP430_CORE_H

#include <msp430.h>             /* MSP430 MCU-specific information */
#include <stdint.h>             /* Size-annotated integral types (uint8_t) */
#include <stddef.h>             /* NULL and size_t */
#include <stdbool.h>            /* bool */

#define BSP430_VERSION 20141115

#define BSP430_PERIPH_CPPID_NONE 0

/* !BSP430! insert=periph_cppid */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [periph_cppid] */

#define BSP430_PERIPH_CPPID_PORT1 1

#define BSP430_PERIPH_CPPID_PORT2 2

#define BSP430_PERIPH_CPPID_PORT3 3

#define BSP430_PERIPH_CPPID_PORT4 4

#define BSP430_PERIPH_CPPID_PORT5 5

#define BSP430_PERIPH_CPPID_PORT6 6

#define BSP430_PERIPH_CPPID_PORT7 7

#define BSP430_PERIPH_CPPID_PORT8 8

#define BSP430_PERIPH_CPPID_PORT9 9

#define BSP430_PERIPH_CPPID_PORT10 10

#define BSP430_PERIPH_CPPID_PORT11 11

#define BSP430_PERIPH_CPPID_TA0 12

#define BSP430_PERIPH_CPPID_TA1 13

#define BSP430_PERIPH_CPPID_TA2 14

#define BSP430_PERIPH_CPPID_TA3 15

#define BSP430_PERIPH_CPPID_TB0 16

#define BSP430_PERIPH_CPPID_TB1 17

#define BSP430_PERIPH_CPPID_TB2 18

#define BSP430_PERIPH_CPPID_USCI_A0 19

#define BSP430_PERIPH_CPPID_USCI_A1 20

#define BSP430_PERIPH_CPPID_USCI_B0 21

#define BSP430_PERIPH_CPPID_USCI_B1 22

#define BSP430_PERIPH_CPPID_USCI5_A0 23

#define BSP430_PERIPH_CPPID_USCI5_A1 24

#define BSP430_PERIPH_CPPID_USCI5_A2 25

#define BSP430_PERIPH_CPPID_USCI5_A3 26

#define BSP430_PERIPH_CPPID_USCI5_B0 27

#define BSP430_PERIPH_CPPID_USCI5_B1 28

#define BSP430_PERIPH_CPPID_USCI5_B2 29

#define BSP430_PERIPH_CPPID_USCI5_B3 30

#define BSP430_PERIPH_CPPID_EUSCI_A0 31

#define BSP430_PERIPH_CPPID_EUSCI_A1 32

#define BSP430_PERIPH_CPPID_EUSCI_A2 33

#define BSP430_PERIPH_CPPID_EUSCI_B0 34
/* END AUTOMATICALLY GENERATED CODE [periph_cppid] */
/* !BSP430! end=periph_cppid */

#ifndef configBSP430_CORE_INCLUDE_BSP430_CONFIG_FILE
#define configBSP430_CORE_INCLUDE_BSP430_CONFIG_FILE 1
#endif /* configBSP430_CORE_INCLUDE_BSP430_CONFIG_FILE */

#if (configBSP430_CORE_INCLUDE_BSP430_CONFIG_FILE - 0)
#include "bsp430_config.h"
#endif /* configBSP430_CORE_INCLUDE_BSP430_CONFIG_FILE */

#ifndef BSP430_CORE_NDEBUG
#define BSP430_CORE_NDEBUG 0
#endif /* BSP430_CORE_NDEBUG */

#if defined(__MSP430_HAS_MSP430XV2_CPU__)
#define BSP430_CORE_FAMILY_IS_5XX 1
#else /* 5xx == CPUXv2*/
#define BSP430_CORE_FAMILY_IS_5XX 0
#endif /* 5xx == CPUXv2 */

#ifndef configBSP430_CORE_DISABLE_FLL
#define configBSP430_CORE_DISABLE_FLL (defined(__MSP430_HAS_UCS__) || defined(__MSP430_HAS_UCS_RF__))
#endif /* configBSP430_CORE_DISABLE_FLL */

#ifndef configBSP430_CORE_LPM_EXIT_CLEAR_GIE
#define configBSP430_CORE_LPM_EXIT_CLEAR_GIE 0
#endif /* configBSP430_CORE_LPM_EXIT_CLEAR_GIE */

#if (configBSP430_CORE_LPM_EXIT_CLEAR_GIE - 0)
#define BSP430_CORE_LPM_EXIT_CLEAR_GIE_ GIE
#else /* configBSP430_CORE_LPM_EXIT_CLEAR_GIE */
#define BSP430_CORE_LPM_EXIT_CLEAR_GIE_ 0
#endif /* configBSP430_CORE_LPM_EXIT_CLEAR_GIE */

#ifndef BSP430_CORE_LPM_EXIT_MASK
#if (configBSP430_CORE_DISABLE_FLL - 0)
#define BSP430_CORE_LPM_EXIT_MASK (BSP430_CORE_LPM_EXIT_CLEAR_GIE_ | (LPM4_bits & ~SCG0))
#else /* configBSP430_CORE_DISABLE_FLL */
#define BSP430_CORE_LPM_EXIT_MASK (BSP430_CORE_LPM_EXIT_CLEAR_GIE_ | LPM4_bits)
#endif /* configBSP430_CORE_DISABLE_FLL */
#endif /* BSP430_CORE_LPM_EXIT_MASK */

#define BSP430_CORE_LPM_SR_MASK (SCG1 | SCG0 | OSCOFF | CPUOFF | GIE)

#define BSP430_CORE_LPM_LPMXp5 0x0100

#define BSP430_CORE_TOOLCHAIN_GCC (1 < __GNUC__)

#define BSP430_CORE_TOOLCHAIN_GCC_MSPGCC (1 < __MSPGCC__)

#define BSP430_CORE_TOOLCHAIN_GCC_MSP430_ELF (BSP430_CORE_TOOLCHAIN_GCC && ! BSP430_CORE_TOOLCHAIN_GCC_MSPGCC)

#if (BSP430_CORE_TOOLCHAIN_GCC_MSP430_ELF - 0)
#define __read_status_register() _get_SR_register()
#define __bis_status_register(v_) _bis_SR_register(v_)
#define __bic_status_register(v_) _bic_SR_register(v_)
#define __bic_status_register_on_exit(v_) __bic_SR_register_on_exit(v_)
#define __bis_status_register_on_exit(v_) __bis_SR_register_on_exit(v_)
#define __disable_interrupts() _disable_interrupts()
#define __enable_interrupts() _enable_interrupts()
#endif /* RHGCC */

#define BSP430_CORE_TOOLCHAIN_LIBC_MSP430_LIBC BSP430_CORE_TOOLCHAIN_GCC_MSPGCC

#define BSP430_CORE_TOOLCHAIN_LIBC_NEWLIB BSP430_CORE_TOOLCHAIN_GCC_MSP430_ELF

#ifdef __TI_COMPILER_VERSION__
/* TI's compiler isn't GCC even if somebody added --gcc to the command
 * line, which causes __GNUC__ to be defined (apparently as 3). */
#undef BSP430_CORE_TOOLCHAIN_GCC
#define BSP430_CORE_TOOLCHAIN_TI 1
#endif /* __TI_COMPILER_VERSION__ */

#if (BSP430_CORE_TOOLCHAIN_TI - 0)
#define __read_stack_register() _get_SP_register()
#define __read_status_register() _get_SR_register()
#define __bis_status_register(v_) _bis_SR_register(v_)
#define __bic_status_register(v_) _bic_SR_register(v_)
#define __bic_status_register_on_exit(v_) _bic_SR_register_on_exit(v_)
#define __nop() _nop()
#endif /* BSP430_CORE_TOOLCHAIN_TI */

#if defined(BSP430_DOXYGEN) || (BSP430_CORE_TOOLCHAIN_GCC - 0)
#define BSP430_CORE_INLINE __inline__
#elif BSP430_CORE_TOOLCHAIN_TI - 0
#define BSP430_CORE_INLINE __inline
#else /* TOOLCHAIN */
#define BSP430_CORE_INLINE inline
#endif /* TOOLCHAIN */

#if defined(BSP430_DOXYGEN) || (BSP430_CORE_TOOLCHAIN_GCC - 0)
/* GCC wants both directives */
#define BSP430_CORE_INLINE_FORCED BSP430_CORE_INLINE __attribute__((__always_inline__))
#else /* TOOLCHAIN */
#define BSP430_CORE_INLINE_FORCED BSP430_CORE_INLINE
#endif /* TOOLCHAIN */

#if defined(BSP430_DOXYGEN) || (BSP430_CORE_TOOLCHAIN_GCC - 0)
#define BSP430_CORE_PACKED_STRUCT(nm_) struct __attribute__((__packed__)) nm_
#endif /* TOOLCHAIN */

#if (BSP430_CORE_TOOLCHAIN_TI - 0)
#define BSP430_CORE_DECLARE_INTERRUPT(iv_) _BSP430_CORE_TOOLCHAIN_TI_PRAGMA(vector=##iv_) __interrupt void
/* Helper function required to make the _Pragma argument a single
 * string literal */
#define _BSP430_CORE_TOOLCHAIN_TI_PRAGMA(x_) _Pragma(#x_)
#else  /* TOOLCHAIN */
#define BSP430_CORE_DECLARE_INTERRUPT(iv_) void __attribute__((__interrupt__(iv_)))
#endif /* TOOLCHAIN */

#define BSP430_CORE_LPM_ENTER(lpm_bits_) __bis_status_register(BSP430_CORE_LPM_SR_MASK & (lpm_bits_))

#define BSP430_CORE_LPM_ENTER_NI(lpm_bits_) BSP430_CORE_LPM_ENTER(GIE | (lpm_bits_))

#define BSP430_CORE_LPM_EXIT_FROM_ISR(lpm_bits_) __bic_status_register_on_exit(BSP430_CORE_LPM_SR_MASK & (lpm_bits_))

#ifndef configBSP430_CORE_SUPPORT_WATCHDOG
#define configBSP430_CORE_SUPPORT_WATCHDOG 0
#endif /* configBSP430_CORE_SUPPORT_WATCHDOG */

#if (configBSP430_CORE_SUPPORT_WATCHDOG - 0)
#ifndef BSP430_CORE_WATCHDOG_CLEAR
#if 20120406 < __MSPGCC__
#define BSP430_CORE_WATCHDOG_CLEAR() __watchdog_clear()
#endif /* MSPGCC */
#endif /* BSP430_CORE_WATCHDOG_CLEAR */
#else /* configBSP430_CORE_SUPPORT_WATCHDOG */
#undef BSP430_CORE_WATCHDOG_CLEAR
#define BSP430_CORE_WATCHDOG_CLEAR() do { } while (0)
#endif /* configBSP430_CORE_SUPPORT_WATCHDOG */

#ifndef BSP430_CORE_WATCHDOG_MAX_DELAY_CYCLES
#define BSP430_CORE_WATCHDOG_MAX_DELAY_CYCLES 10000U
#endif /* BSP430_CORE_WATCHDOG_MAX_DELAY_CYCLES */

#if (configBSP430_CORE_SUPPORT_WATCHDOG - 0)
#define BSP430_CORE_DELAY_CYCLES(duration_mclk_) do {                   \
    if ((duration_mclk_) > BSP430_CORE_WATCHDOG_MAX_DELAY_CYCLES) {     \
      unsigned int _watchdog_iterations = (duration_mclk_) / BSP430_CORE_WATCHDOG_MAX_DELAY_CYCLES; \
      while (0 < _watchdog_iterations--) {                              \
        __delay_cycles(BSP430_CORE_WATCHDOG_MAX_DELAY_CYCLES);          \
        BSP430_CORE_WATCHDOG_CLEAR();                                   \
      }                                                                 \
    }                                                                   \
    __delay_cycles((duration_mclk_) % BSP430_CORE_WATCHDOG_MAX_DELAY_CYCLES); \
  } while (0)
#else /* configBSP430_CORE_SUPPORT_WATCHDOG */
#define BSP430_CORE_DELAY_CYCLES(duration_mclk_) __delay_cycles(duration_mclk_)
#endif /* configBSP430_CORE_SUPPORT_WATCHDOG */

#ifndef BSP430_CORE_INTERRUPT_STATE_T
#if defined(BSP430_DOXYGEN) || (BSP430_CORE_TOOLCHAIN_GCC_MSPGCC - 0)
#define BSP430_CORE_INTERRUPT_STATE_T __istate_t
#else /* TOOLCHAIN */
#define BSP430_CORE_INTERRUPT_STATE_T unsigned int
#endif /* TOOLCHAIN */
#endif /* BSP430_CORE_INTERRUPT_STATE_T */

#ifndef BSP430_CORE_SAVE_INTERRUPT_STATE
#define BSP430_CORE_SAVE_INTERRUPT_STATE(state_) do {   \
    (state_) = __get_interrupt_state();                 \
  } while (0)
#endif /* BSP430_CORE_SAVE_INTERRUPT_STATE */

#ifndef BSP430_CORE_SAVED_INTERRUPT_STATE
#define BSP430_CORE_SAVED_INTERRUPT_STATE(var_)             \
  BSP430_CORE_INTERRUPT_STATE_T var_ = __get_interrupt_state()
#endif /* BSP430_CORE_SAVED_INTERRUPT_STATE */

#ifndef BSP430_CORE_RESTORE_INTERRUPT_STATE
#define BSP430_CORE_RESTORE_INTERRUPT_STATE(state_) do {        \
    __set_interrupt_state(state_);                              \
  } while (0)
#endif /* BSP430_CORE_RESTORE_INTERRUPT_STATE */

#ifndef BSP430_CORE_ENABLE_INTERRUPT
#if (BSP430_CORE_FAMILY_IS_5XX - 0)
#define BSP430_CORE_ENABLE_INTERRUPT() do {     \
    __enable_interrupt();                       \
    __nop();                                    \
  } while (0)
#else /* BSP430_CORE_FAMILY_IS_5XX */
#define BSP430_CORE_ENABLE_INTERRUPT() __enable_interrupt()
#endif /* BSP430_CORE_FAMILY_IS_5XX */
#endif /* BSP430_CORE_ENABLE_INTERRUPT */

#ifndef BSP430_CORE_DISABLE_INTERRUPT
#if (BSP430_CORE_TOOLCHAIN_GCC_MSP430_ELF - 0)
#define BSP430_CORE_DISABLE_INTERRUPT() do { _disable_interrupts(); _no_operation(); } while (0)
#else /* BSP430_CORE_TOOLCHAIN */
#define BSP430_CORE_DISABLE_INTERRUPT() __disable_interrupt()
#endif /* BSP430_CORE_TOOLCHAIN */
#endif /* BSP430_CORE_DISABLE_INTERRUPT */

#define BSP430_CORE_US_TO_TICKS(us_, hz_) (((us_) * (unsigned long)(hz_)) / 1000000UL)

#define BSP430_CORE_TICKS_TO_US(ticks_, hz_) ((1000000UL * (ticks_)) / (hz_))

#define BSP430_CORE_MS_TO_TICKS(ms_, hz_) (((ms_) * (unsigned long)(hz_)) / 1000UL)

#define BSP430_CORE_TICKS_TO_MS(ticks_, hz_) ((1000UL * (ticks_)) / (hz_))

#if (BSP430_CORE_TOOLCHAIN_GCC_MSPGCC - 0)
#include <byteswap.h>
#define BSP430_CORE_SWAP_16(w_) bswap_16(w_)
#elif (BSP430_CORE_TOOLCHAIN_GCC_MSP430_ELF - 0)
#define BSP430_CORE_SWAP_16(w_) _swap_bytes(w_)
#else
#define BSP430_CORE_SWAP_16(w_) ((  ((w_) & 0xFF00) >> 8)       \
                                 | (((w_) & 0x00FF) << 8) )
#endif

#if (BSP430_CORE_TOOLCHAIN_GCC_MSPGCC - 0)
#include <byteswap.h>
#define BSP430_CORE_SWAP_32(lw_) bswap_32(lw_)
#else
#define BSP430_CORE_SWAP_32(lw_) ((  ((lw_) & 0xFF000000) >> 24)     \
                                  | (((lw_) & 0x00FF0000) >> 8)      \
                                  | (((lw_) & 0x0000FF00) << 8)      \
                                  | (((lw_) & 0x000000FF) << 24) )
#endif

/* See <bsp430/rtos/freertos.h> */
#if (configBSP430_RTOS_FREERTOS - 0)
/* FreeRTOS defines application behavior in a shared header.  Read it
 * in here so everybody agrees on its contents. */

#include "FreeRTOS.h"

#define BSP430_RTOS_YIELD_FROM_ISR() portYIELD_FROM_ISR(1)

#endif /* configBSP430_RTOS_FREERTOS */

#ifndef BSP430_RTOS_YIELD_FROM_ISR
#define BSP430_RTOS_YIELD_FROM_ISR() do { } while (0)
#endif /* BSP430_RTOS_YIELD_FROM_ISR */

#endif /* BSP430_CORE_H */