osd-contiki/core/dev/leds.h
2011-02-09 15:29:41 +01:00

99 lines
2.8 KiB
C

/*
* Copyright (c) 2005, Swedish Institute of Computer Science
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name of the Institute 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 INSTITUTE 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 INSTITUTE 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.
*
* This file is part of the Contiki operating system.
*
* @(#)$Id: leds.h,v 1.1 2006/06/17 22:41:16 adamdunkels Exp $
*/
/**
* \addtogroup dev
* @{
*/
/**
* \defgroup leds LEDs API
*
* The LEDs API defines a set of functions for accessing LEDs for
* Contiki plaforms with LEDs.
*
* A platform with LED support must implement this API.
* @{
*/
#ifndef __LEDS_H__
#define __LEDS_H__
void leds_init(void);
/**
* Blink all LEDs.
*/
void leds_blink(void);
#define LEDS_GREEN 1
#define LEDS_YELLOW 2
#define LEDS_RED 4
#define LEDS_BLUE LEDS_YELLOW /* Tmote Sky is colorblind? */
#define leds_blue leds_yellow
#ifdef LEDS_CONF_ALL
#define LEDS_ALL LEDS_CONF_ALL
#else /* LEDS_CONF_ALL */
#define LEDS_ALL 7
#endif /* LEDS_CONF_ALL */
/**
* Returns the current status of all leds (respects invert)
*/
unsigned char leds_get(void);
void leds_on(unsigned char leds);
void leds_off(unsigned char leds);
void leds_toggle(unsigned char leds);
void leds_invert(unsigned char leds);
void leds_green(int onoroff);
void leds_red(int onoroff);
void leds_yellow(int onoroff);
#define LEDS_ON 1
#define LEDS_OFF 0
/**
* Leds implementation
*/
void leds_arch_init(void);
unsigned char leds_arch_get(void);
void leds_arch_set(unsigned char leds);
#endif /* __LEDS_H__ */