led.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_UTILITY_LED_H
#define BSP430_UTILITY_LED_H

#ifndef configBSP430_LED
#define configBSP430_LED 1
#endif /* configBSP430_LED */

#if defined(BSP430_DOXYGEN) || defined(configBSP430_LED)
#ifndef BSP430_LED
#if (configBSP430_LED - 0)
#define BSP430_LED 1
#else /* configBSP430_LED */
#define BSP430_LED 0
#endif /* configBSP430_LED */
#endif /* BSP430_LED */
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN) || (configBSP430_LED - 0)
void vBSP430ledInitialize_ni (void);
#else /* BSP430_LED */
#define vBSP430ledInitialize_ni() do {} while (0)
#endif /* BSP430_LED */

#if defined(BSP430_DOXYGEN) || (configBSP430_LED - 0)
void vBSP430ledSet (int led_idx,
                    int value);
#else /* BSP430_LED */
#define vBSP430ledSet(led_idx, value) do { (void)(led_idx); (void)(value); } while (0)
#endif /* BSP430_LED */

#if defined(BSP430_DOXYGEN) || (configBSP430_LED - 0)
int vBSP430ledGet (int led_idx);
#else /* BSP430_LED */
#define vBSP430ledGet(led_idx) 0
#endif /* BSP430_LED */

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

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

#ifndef configBSP430_LED_USE_COMMON
#define configBSP430_LED_USE_COMMON 1
#endif /* configBSP430_LED_USE_COMMON */

typedef struct sBSP430halLED {
  volatile unsigned char * const outp;
  unsigned char const bit;
  unsigned char const flags;
} sBSP430halLED;

#if (configBSP430_LED_USE_COMMON - 0)

extern const sBSP430halLED xBSP430halLED_[];

#endif /* configBSP430_LED_USE_COMMON */

extern const unsigned char nBSP430led;

#endif /* BSP430_UTILITY_LED_H */