platform.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_PLATFORM_H
#define BSP430_PLATFORM_H

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

void vBSP430platformInitialize_ni (void);

void vBSP430platformInitialize_ni (void);

int iBSP430platformConfigurePeripheralPins_ni (tBSP430periphHandle periph, int periph_config, int enablep);

#ifndef configBSP430_PLATFORM_SPIN_FOR_JUMPER
#define configBSP430_PLATFORM_SPIN_FOR_JUMPER 0
#endif /* configBSP430_PLATFORM_SPIN_FOR_JUMPER */

#if defined(BSP430_DOXYGEN) || (configBSP430_PLATFORM_SPIN_FOR_JUMPER - 0)
void vBSP430platformSpinForJumper_ni (void);
#endif /* configBSP430_PLATFORM_SPIN_FOR_JUMPER */

#ifndef configBSP430_PLATFORM_PERIPHERAL_HELP
#define configBSP430_PLATFORM_PERIPHERAL_HELP 0
#endif /* configBSP430_PLATFORM_PERIPHERAL_HELP */

const char * xBSP430platformPeripheralHelp (tBSP430periphHandle periph, int periph_config);

#ifndef configBSP430_PLATFORM_RF

#define configBSP430_PLATFORM_RF 0
#endif /* configBSP430_PLATFORM_RF */

#ifndef configBSP430_PLATFORM_BUTTON0
#define configBSP430_PLATFORM_BUTTON0 0
#endif /* configBSP430_PLATFORM_BUTTON0 */

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

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

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


/* !BSP430! tool=msp subst=tool instance=exp430f5438,exp430f5529,exp430f5529lp,exp430fr5739,exp430fr5969,exp430fr4133,exp430fg4618,exp430g2 */
/* !BSP430! insert=platform_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [platform_decl] */
#ifndef BSP430_PLATFORM_EXP430F5438
#define BSP430_PLATFORM_EXP430F5438 0
#endif /* BSP430_PLATFORM_EXP430F5438 */

#if (BSP430_PLATFORM_EXP430F5438 - 0)
#include <bsp430/platform/exp430f5438/platform.h>
#endif /* BSP430_PLATFORM_EXP430F5438 */

#ifndef BSP430_PLATFORM_EXP430F5529
#define BSP430_PLATFORM_EXP430F5529 0
#endif /* BSP430_PLATFORM_EXP430F5529 */

#if (BSP430_PLATFORM_EXP430F5529 - 0)
#include <bsp430/platform/exp430f5529/platform.h>
#endif /* BSP430_PLATFORM_EXP430F5529 */

#ifndef BSP430_PLATFORM_EXP430F5529LP
#define BSP430_PLATFORM_EXP430F5529LP 0
#endif /* BSP430_PLATFORM_EXP430F5529LP */

#if (BSP430_PLATFORM_EXP430F5529LP - 0)
#include <bsp430/platform/exp430f5529lp/platform.h>
#endif /* BSP430_PLATFORM_EXP430F5529LP */

#ifndef BSP430_PLATFORM_EXP430FR5739
#define BSP430_PLATFORM_EXP430FR5739 0
#endif /* BSP430_PLATFORM_EXP430FR5739 */

#if (BSP430_PLATFORM_EXP430FR5739 - 0)
#include <bsp430/platform/exp430fr5739/platform.h>
#endif /* BSP430_PLATFORM_EXP430FR5739 */

#ifndef BSP430_PLATFORM_EXP430FR5969
#define BSP430_PLATFORM_EXP430FR5969 0
#endif /* BSP430_PLATFORM_EXP430FR5969 */

#if (BSP430_PLATFORM_EXP430FR5969 - 0)
#include <bsp430/platform/exp430fr5969/platform.h>
#endif /* BSP430_PLATFORM_EXP430FR5969 */

#ifndef BSP430_PLATFORM_EXP430FR4133
#define BSP430_PLATFORM_EXP430FR4133 0
#endif /* BSP430_PLATFORM_EXP430FR4133 */

#if (BSP430_PLATFORM_EXP430FR4133 - 0)
#include <bsp430/platform/exp430fr4133/platform.h>
#endif /* BSP430_PLATFORM_EXP430FR4133 */

#ifndef BSP430_PLATFORM_EXP430FG4618
#define BSP430_PLATFORM_EXP430FG4618 0
#endif /* BSP430_PLATFORM_EXP430FG4618 */

#if (BSP430_PLATFORM_EXP430FG4618 - 0)
#include <bsp430/platform/exp430fg4618/platform.h>
#endif /* BSP430_PLATFORM_EXP430FG4618 */

#ifndef BSP430_PLATFORM_EXP430G2
#define BSP430_PLATFORM_EXP430G2 0
#endif /* BSP430_PLATFORM_EXP430G2 */

#if (BSP430_PLATFORM_EXP430G2 - 0)
#include <bsp430/platform/exp430g2/platform.h>
#endif /* BSP430_PLATFORM_EXP430G2 */

/* END AUTOMATICALLY GENERATED CODE [platform_decl] */
/* !BSP430! end=platform_decl */
/* !BSP430! tool=ez430 subst=tool instance=rf2500t */
/* !BSP430! insert=platform_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [platform_decl] */
#ifndef BSP430_PLATFORM_RF2500T
#define BSP430_PLATFORM_RF2500T 0
#endif /* BSP430_PLATFORM_RF2500T */

#if (BSP430_PLATFORM_RF2500T - 0)
#include <bsp430/platform/rf2500t/platform.h>
#endif /* BSP430_PLATFORM_RF2500T */

/* END AUTOMATICALLY GENERATED CODE [platform_decl] */
/* !BSP430! end=platform_decl */
/* !BSP430! url=http://www.ti.com/tool/em430f5137rf900 subst=url instance=em430 */
/* !BSP430! insert=platform_decl_url */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [platform_decl_url] */
#ifndef BSP430_PLATFORM_EM430
#define BSP430_PLATFORM_EM430 0
#endif /* BSP430_PLATFORM_EM430 */

#if (BSP430_PLATFORM_EM430 - 0)
#include <bsp430/platform/em430/platform.h>
#endif /* BSP430_PLATFORM_EM430 */

/* END AUTOMATICALLY GENERATED CODE [platform_decl_url] */
/* !BSP430! end=platform_decl_url */
/* !BSP430! url=http://en.wikipedia.org/wiki/HTTP_404 subst=url instance=surf */
/* !BSP430! insert=platform_decl_url */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [platform_decl_url] */
#ifndef BSP430_PLATFORM_SURF
#define BSP430_PLATFORM_SURF 0
#endif /* BSP430_PLATFORM_SURF */

#if (BSP430_PLATFORM_SURF - 0)
#include <bsp430/platform/surf/platform.h>
#endif /* BSP430_PLATFORM_SURF */

/* END AUTOMATICALLY GENERATED CODE [platform_decl_url] */
/* !BSP430! end=platform_decl_url */
/* !BSP430! url=http://www.ti.com/tool/cc1125dk subst=url instance=trxeb */
/* !BSP430! insert=platform_decl_url */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [platform_decl_url] */
#ifndef BSP430_PLATFORM_TRXEB
#define BSP430_PLATFORM_TRXEB 0
#endif /* BSP430_PLATFORM_TRXEB */

#if (BSP430_PLATFORM_TRXEB - 0)
#include <bsp430/platform/trxeb/platform.h>
#endif /* BSP430_PLATFORM_TRXEB */

/* END AUTOMATICALLY GENERATED CODE [platform_decl_url] */
/* !BSP430! end=platform_decl_url */
/* !BSP430! url=http://www.ti.com/tool/msp-fet430u48c subst=url instance=wolverine */
/* !BSP430! insert=platform_decl_url */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [platform_decl_url] */
#ifndef BSP430_PLATFORM_WOLVERINE
#define BSP430_PLATFORM_WOLVERINE 0
#endif /* BSP430_PLATFORM_WOLVERINE */

#if (BSP430_PLATFORM_WOLVERINE - 0)
#include <bsp430/platform/wolverine/platform.h>
#endif /* BSP430_PLATFORM_WOLVERINE */

/* END AUTOMATICALLY GENERATED CODE [platform_decl_url] */
/* !BSP430! end=platform_decl_url */

#ifndef BSP430_PLATFORM_CUSTOM
#define BSP430_PLATFORM_CUSTOM 0
#endif /* BSP430_PLATFORM_CUSTOM */

#if (BSP430_PLATFORM_CUSTOM - 0)
#include <bsp430/platform/custom/platform.h>
#endif /* BSP430_PLATFORM_CUSTOM */

/* If configBSP430_TIMER_CCACLK was requested, then mark the feature as
 * available or not based on whether the platform provided a serial
 * peripheral for the console's use. */
#if (configBSP430_TIMER_CCACLK - 0)
#if BSP430_PERIPH_CPPID_NONE != BSP430_TIMER_CCACLK_PERIPH_CPPID
#define BSP430_TIMER_CCACLK 1
#else /* BSP430_TIMER_CCACLK_PERIPH_CPPID */
#define BSP430_TIMER_CCACLK 0
#endif /* BSP430_TIMER_CCACLK_PERIPH_CPPID */
#endif /* configBSP430_TIMER_CCACLK */

/* If configBSP430_UCS_TRIM_DCOCLKDIV was requested and the platform
 * supports BSP430_TIMER_CCACLK, then mark the feature as
 * available. */
#if (configBSP430_UCS_TRIM_DCOCLKDIV - 0)
#if (BSP430_TIMER_CCACLK - 0)
#define BSP430_UCS_TRIM_DCOCLKDIV 1
#else /* BSP430_TIMER_CCACLK */
#define BSP430_UCS_TRIM_DCOCLKDIV 0
#endif /* BSP430_TIMER_CCACLK */
#endif /* configBSP430_UCS_TRIM_DCOCLKDIV */

/* If configBSP430_BC2_TRIM_TO_MCLK was requested and the platform
 * supports BSP430_TIMER_CCACLK, then mark the feature as
 * available. */
#if (configBSP430_BC2_TRIM_TO_MCLK - 0)
#if (BSP430_TIMER_CCACLK - 0)
#define BSP430_BC2_TRIM_TO_MCLK 1
#else /* BSP430_TIMER_CCACLK */
#define BSP430_BC2_TRIM_TO_MCLK 0
#endif /* BSP430_TIMER_CCACLK */
#endif /* configBSP430_BC2_TRIM_TO_MCLK */

/* If configBSP430_CONSOLE was requested, then mark the feature as
 * available or not based on whether the platform provided a serial
 * peripheral for the console's use. */
#if (configBSP430_CONSOLE - 0)
#if BSP430_PERIPH_CPPID_NONE != BSP430_CONSOLE_SERIAL_PERIPH_CPPID
#define BSP430_CONSOLE 1
#else /* BSP430_CONSOLE_SERIAL_PERIPH_CPPID */
#define BSP430_CONSOLE 0
#endif /* BSP430_CONSOLE_SERIAL_PERIPH_CPPID */
#endif /* configBSP430_CONSOLE */

/* If configBSP430_UPTIME was requested, then mark the feature as
 * available or not based on whether the platform provided a timer for
 * its use. */
#if (configBSP430_UPTIME - 0) && !defined(BSP430_UPTIME)
#if BSP430_PERIPH_CPPID_NONE != BSP430_UPTIME_TIMER_PERIPH_CPPID
#define BSP430_UPTIME 1
#else /* BSP430_UPTIME_TIMER_PERIPH_CPPID */
#define BSP430_UPTIME 0
#endif /* BSP430_UPTIME_TIMER_PERIPH_CPPID */
#endif /* configBSP430_UPTIME */

/* If configBSP430_PLATFORM_BUTTON0 was requested, then mark the
 * feature as available or not based on whether the platform provided
 * a peripheral handle for the button's use.
 *
 * NOTE: This file is responsible only for processing button 0.
 * Additional buttons must be handled in the platform-specific
 * header. */
#if (configBSP430_PLATFORM_BUTTON0 - 0)
#ifdef BSP430_PLATFORM_BUTTON0_PORT_PERIPH_HANDLE
#define BSP430_PLATFORM_BUTTON0 1
#else /* BSP430_PLATFORM_BUTTON0_PORT_PERIPH_HANDLE */
#define BSP430_PLATFORM_BUTTON0 0
#endif /* BSP430_PLATFORM_BUTTON0_PORT_PERIPH_HANDLE */
#endif /* configBSP430_PLATFORM_BUTTON0 */

/* If configBSP430_PLATFORM_M25P was requested, then mark the feature
 * as available or not based on whether the platform provided a
 * peripheral handle to use to access the device. */
#if (configBSP430_PLATFORM_M25P - 0)
#ifdef BSP430_PLATFORM_M25P_SPI_PERIPH_HANDLE
#define BSP430_PLATFORM_M25P 1
#else /* BSP430_PLATFORM_M25P_SPI_PERIPH_HANDLE */
#define BSP430_PLATFORM_M25P 0
#endif /* BSP430_PLATFORM_M25P_SPI_PERIPH_HANDLE */
#endif /* configBSP430_PLATFORM_M25P */

/* Set other M25P defaults */
#if (BSP430_PLATFORM_M25P - 0)
#endif /* BSP430_PLATFORM_M25P */

/* If configBSP430_PLATFORM_BOOSTERPACK_SHARP96 was requested, then
 * mark the feature as available or not based on whether the platform
 * provided a peripheral handle to use to access the device.  Default
 * the screen size to the boosterpack, but accept existing
 * overrides. */
#if (configBSP430_PLATFORM_BOOSTERPACK_SHARP96 - 0)
#ifdef BSP430_PLATFORM_SHARPLCD_SPI_PERIPH_HANDLE
#define BSP430_PLATFORM_BOOSTERPACK_SHARP96 1
#define BSP430_PLATFORM_SHARPLCD 1
#ifndef BSP430_PLATFORM_SHARPLCD_ROWS
#define BSP430_PLATFORM_SHARPLCD_ROWS 96
#endif /* BSP430_PLATFORM_SHARPLCD_ROWS */
#ifndef BSP430_PLATFORM_SHARPLCD_COLUMNS
#define BSP430_PLATFORM_SHARPLCD_COLUMNS 96
#endif /* BSP430_PLATFORM_SHARPLCD_COLUMNS */
#else /* BSP430_PLATFORM_SHARPLCD_SPI_PERIPH_HANDLE */
#define BSP430_PLATFORM_SHARPLCD 0
#endif /* BSP430_PLATFORM_SHARPLCD_SPI_PERIPH_HANDLE */
#endif /* configBSP430_PLATFORM_BOOSTERPACK_SHARP96 */

#if (BSP430_PLATFORM_SHARPLCD - 0)
#ifndef BSP430_UTILITY_U8GLIB
/* Enable U8GLIB if requested */
#define BSP430_UTILITY_U8GLIB (configBSP430_UTILITY_U8GLIB - 0)
#endif /* BSP430_UTILITY_U8GLIB */
#endif /* BSP430_PLATFORM_SHARPLCD */

#if defined(BSP430_DOXYGEN) || defined(configBSP430_PLATFORM_SPIN_FOR_JUMPER)
#ifndef BSP430_PLATFORM_SPIN_FOR_JUMPER
#define BSP430_PLATFORM_SPIN_FOR_JUMPER 0 /* False unless platform explicitly enabled it */
#endif /* BSP430_PLATFORM_SPIN_FOR_JUMPER */
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN) || defined(configBSP430_PLATFORM_PERIPHERAL_HELP)
#ifndef BSP430_PLATFORM_PERIPHERAL_HELP
#define BSP430_PLATFORM_PERIPHERAL_HELP 1 /* True unless platform explicitly disabled it */
#endif /* BSP430_PLATFORM_PERIPHERAL_HELP */
#endif /* BSP430_DOXYGEN */

#ifndef BSP430_PLATFORM_BOOT_DISABLE_WATCHDOG
#define BSP430_PLATFORM_BOOT_DISABLE_WATCHDOG (! (configBSP430_CORE_SUPPORT_WATCHDOG - 0))
#endif /* BSP430_PLATFORM_BOOT_DISABLE_WATCHDOG */

#ifndef BSP430_PLATFORM_BOOT_CONFIGURE_LEDS
#if defined(BSP430_PLATFORM_BOOT_CONFIGURE_LED)
#warning BSP430_PLATFORM_BOOT_CONFIGURE_LEDS is not spelled BSP430_PLATFORM_BOOT_CONFIGURE_LED
#endif /* BSP430_PLATFORM_BOOT_CONFIGURE_LED */
#define BSP430_PLATFORM_BOOT_CONFIGURE_LEDS 1
#endif /* BSP430_PLATFORM_BOOT_CONFIGURE_LEDS */

#ifndef BSP430_PLATFORM_BOOT_CONFIGURE_CLOCKS
#define BSP430_PLATFORM_BOOT_CONFIGURE_CLOCKS 1
#endif /* BSP430_PLATFORM_BOOT_CONFIGURE_CLOCKS */

#ifndef BSP430_PLATFORM_BOOT_CONFIGURE_LFXT1
#define BSP430_PLATFORM_BOOT_CONFIGURE_LFXT1 0
#endif /* BSP430_PLATFORM_BOOT_CONFIGURE_LFXT1 */

#ifndef BSP430_PLATFORM_BOOT_CONFIGURE_XT2
#define BSP430_PLATFORM_BOOT_CONFIGURE_XT2 0
#endif /* BSP430_PLATFORM_BOOT_CONFIGURE_XT2 */

#ifndef BSP430_PLATFORM_BOOT_LFXT1_DELAY_SEC
#define BSP430_PLATFORM_BOOT_LFXT1_DELAY_SEC 1
#endif /* BSP430_PLATFORM_BOOT_LFXT1_DELAY_SEC */

#ifndef BSP430_PLATFORM_BOOT_ACLK_SOURCE
#define BSP430_PLATFORM_BOOT_ACLK_SOURCE eBSP430clockSRC_XT1CLK_FALLBACK
#endif /* BSP430_PLATFORM_BOOT_ACLK_SOURCE */

#ifndef BSP430_PLATFORM_BOOT_ACLK_DIVIDING_SHIFT
#define BSP430_PLATFORM_BOOT_ACLK_DIVIDING_SHIFT 0
#endif /* BSP430_PLATFORM_BOOT_ACLK_DIVIDING_SHIFT */

#ifndef BSP430_PLATFORM_BOOT_SMCLK_SOURCE
#define BSP430_PLATFORM_BOOT_SMCLK_SOURCE eBSP430clockSRC_SMCLK_PU_DEFAULT
#endif /* BSP430_PLATFORM_BOOT_SMCLK_SOURCE */

#ifndef BSP430_PLATFORM_BOOT_SMCLK_DIVIDING_SHIFT
#define BSP430_PLATFORM_BOOT_SMCLK_DIVIDING_SHIFT 0
#endif /* BSP430_PLATFORM_BOOT_SMCLK_DIVIDING_SHIFT */

#if (BSP430_RFEM - 0)
/* If using the RFEM feature, incorporate the header that maps RFEM
 * constants to specific EMK functions. */
#include <bsp430/rf/emk_platform.h>
#endif /* BSP430_RFEM */

#endif /* BSP430_PLATFORM_H */