git.sur5r.net Git - freertos/blob - Demo/Common/drivers/Atmel/at91lib/utility/led.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         ATMEL Microcontroller Software Support \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2008, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 /*\r
  31     Title: LED\r
  32 \r
  33     About: Purpose\r
  34         Small set of functions for simple and portable LED usage.\r
  35 \r
  36     About: Usage\r
  37         1 - Configure one or more LEDs using <LED_Configure> and\r
  38             <LED_ConfigureAll>.\r
  39         2 - Set, clear and toggle LEDs using <LED_Set>, <LED_Clear> and\r
  40             <LED_Toggle>.\r
  41         3 - Get the current status of a LED using <LED_Get>.\r
  42 \r
  43         LEDs are numbered starting from 0; the number of LEDs depend on the\r
  44         board being used. All the functions defined here will compile properly\r
  45         regardless of whether the LED is defined or not; they will simply\r
  46         return 0 when a LED which does not exist is given as an argument.\r
  47         Also, these functions take into account how each LED is connected on to\r
  48         board; thus, <LED_Set> might change the level on the corresponding pin\r
  49         to 0 or 1, but it will always light the LED on; same thing for the other\r
  50         methods.\r
  51 */\r
  52 \r
  53 #ifndef LED_H\r
  54 #define LED_H\r
  55 \r
  56 //------------------------------------------------------------------------------\r
  57 //         Exported functions\r
  58 //------------------------------------------------------------------------------\r
  59 \r
  60 extern unsigned char LED_Configure(unsigned int led);\r
  61 extern unsigned char LED_Set(unsigned int led);\r
  62 extern unsigned char LED_Clear(unsigned int led);\r
  63 extern unsigned char LED_Toggle(unsigned int led);\r
  64 \r
  65 #endif //#ifndef LED_H\r
  66 \r