git.sur5r.net Git - freertos/blob - Demo/AVR32_UC3/BOARDS/EVK1101/led.h

   1 /*This file is prepared for Doxygen automatic documentation generation.*/\r
   2 /*! \file *********************************************************************\r
   3  *\r
   4  * \brief AT32UC3B EVK1101 board LEDs support package.\r
   5  *\r
   6  * This file contains definitions and services related to the LED features of\r
   7  * the EVK1101 board.\r
   8  *\r
   9  * - Compiler:           IAR EWAVR32 and GNU GCC for AVR32\r
  10  * - Supported devices:  All AVR32 AT32UC3B devices can be used.\r
  11  * - AppNote:\r
  12  *\r
  13  * \author               Atmel Corporation: http://www.atmel.com \n\r
  14  *                       Support and FAQ: http://support.atmel.no/\r
  15  *\r
  16  ******************************************************************************/\r
  17 \r
  18 /* Copyright (c) 2007, Atmel Corporation All rights reserved.\r
  19  *\r
  20  * Redistribution and use in source and binary forms, with or without\r
  21  * modification, are permitted provided that the following conditions are met:\r
  22  *\r
  23  * 1. Redistributions of source code must retain the above copyright notice,\r
  24  * this list of conditions and the following disclaimer.\r
  25  *\r
  26  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  27  * this list of conditions and the following disclaimer in the documentation\r
  28  * and/or other materials provided with the distribution.\r
  29  *\r
  30  * 3. The name of ATMEL may not be used to endorse or promote products derived\r
  31  * from this software without specific prior written permission.\r
  32  *\r
  33  * THIS SOFTWARE IS PROVIDED BY ATMEL ``AS IS'' AND ANY EXPRESS OR IMPLIED\r
  34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  35  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY AND\r
  36  * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,\r
  37  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
  38  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
  39  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
  40  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
  41  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
  42  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  43  */\r
  44 \r
  45 \r
  46 #ifndef _LED_H_\r
  47 #define _LED_H_\r
  48 \r
  49 #include "compiler.h"\r
  50 \r
  51 \r
  52 /*! \name Identifiers of LEDs to Use with LED Functions\r
  53  */\r
  54 //! @{\r
  55 #define LED0  0x01\r
  56 #define LED1  0x02\r
  57 #define LED2  0x04\r
  58 #define LED3  0x08\r
  59 //! @}\r
  60 \r
  61 \r
  62 /*! \brief Gets the last state of all LEDs set through the LED API.\r
  63  *\r
  64  * \return State of all LEDs (1 bit per LED).\r
  65  *\r
  66  * \note The GPIO pin configuration of all LEDs is left unchanged.\r
  67  */\r
  68 extern U32 LED_Read_Display(void);\r
  69 \r
  70 /*! \brief Sets the state of all LEDs.\r
  71  *\r
  72  * \param leds New state of all LEDs (1 bit per LED).\r
  73  *\r
  74  * \note The pins of all LEDs are set to GPIO output mode.\r
  75  */\r
  76 extern void LED_Display(U32 leds);\r
  77 \r
  78 /*! \brief Gets the last state of the specified LEDs set through the LED API.\r
  79  *\r
  80  * \param mask LEDs of which to get the state (1 bit per LED).\r
  81  *\r
  82  * \return State of the specified LEDs (1 bit per LED).\r
  83  *\r
  84  * \note The GPIO pin configuration of all LEDs is left unchanged.\r
  85  */\r
  86 extern U32 LED_Read_Display_Mask(U32 mask);\r
  87 \r
  88 /*! \brief Sets the state of the specified LEDs.\r
  89  *\r
  90  * \param mask LEDs of which to set the state (1 bit per LED).\r
  91  *\r
  92  * \param leds New state of the specified LEDs (1 bit per LED).\r
  93  *\r
  94  * \note The pins of the specified LEDs are set to GPIO output mode.\r
  95  */\r
  96 extern void LED_Display_Mask(U32 mask, U32 leds);\r
  97 \r
  98 /*! \brief Tests the last state of the specified LEDs set through the LED API.\r
  99  *\r
 100  * \param leds LEDs of which to test the state (1 bit per LED).\r
 101  *\r
 102  * \return \c TRUE if at least one of the specified LEDs has a state on, else\r
 103  *         \c FALSE.\r
 104  *\r
 105  * \note The GPIO pin configuration of all LEDs is left unchanged.\r
 106  */\r
 107 extern Bool LED_Test(U32 leds);\r
 108 \r
 109 /*! \brief Turns off the specified LEDs.\r
 110  *\r
 111  * \param leds LEDs to turn off (1 bit per LED).\r
 112  *\r
 113  * \note The pins of the specified LEDs are set to GPIO output mode.\r
 114  */\r
 115 extern void LED_Off(U32 leds);\r
 116 \r
 117 /*! \brief Turns on the specified LEDs.\r
 118  *\r
 119  * \param leds LEDs to turn on (1 bit per LED).\r
 120  *\r
 121  * \note The pins of the specified LEDs are set to GPIO output mode.\r
 122  */\r
 123 extern void LED_On(U32 leds);\r
 124 \r
 125 /*! \brief Toggles the specified LEDs.\r
 126  *\r
 127  * \param leds LEDs to toggle (1 bit per LED).\r
 128  *\r
 129  * \note The pins of the specified LEDs are set to GPIO output mode.\r
 130  */\r
 131 extern void LED_Toggle(U32 leds);\r
 132 \r
 133 /*! \brief Gets as a bit-field the last state of the specified LEDs set through\r
 134  *         the LED API.\r
 135  *\r
 136  * \param field LEDs of which to get the state (1 bit per LED).\r
 137  *\r
 138  * \return State of the specified LEDs (1 bit per LED, beginning with the first\r
 139  *         specified LED).\r
 140  *\r
 141  * \note The GPIO pin configuration of all LEDs is left unchanged.\r
 142  */\r
 143 extern U32 LED_Read_Display_Field(U32 field);\r
 144 \r
 145 /*! \brief Sets as a bit-field the state of the specified LEDs.\r
 146  *\r
 147  * \param field LEDs of which to set the state (1 bit per LED).\r
 148  * \param leds New state of the specified LEDs (1 bit per LED, beginning with\r
 149  *             the first specified LED).\r
 150  *\r
 151  * \note The pins of the specified LEDs are set to GPIO output mode.\r
 152  */\r
 153 extern void LED_Display_Field(U32 field, U32 leds);\r
 154 \r
 155 /*! \brief Gets the intensity of the specified LED.\r
 156  *\r
 157  * \param led LED of which to get the intensity (1 bit per LED; only the least\r
 158  *            significant set bit is used).\r
 159  *\r
 160  * \return Intensity of the specified LED (0x00 to 0xFF).\r
 161  *\r
 162  * \warning The PWM channel of the specified LED is supposed to be used only by\r
 163  *          this module.\r
 164  *\r
 165  * \note The GPIO pin configuration of all LEDs is left unchanged.\r
 166  */\r
 167 extern U8 LED_Get_Intensity(U32 led);\r
 168 \r
 169 /*! \brief Sets the intensity of the specified LEDs.\r
 170  *\r
 171  * \param leds LEDs of which to set the intensity (1 bit per LED).\r
 172  * \param intensity New intensity of the specified LEDs (0x00 to 0xFF).\r
 173  *\r
 174  * \warning The PWM channels of the specified LEDs are supposed to be used only\r
 175  *          by this module.\r
 176  *\r
 177  * \note The pins of the specified LEDs are set to PWM output mode.\r
 178  */\r
 179 extern void LED_Set_Intensity(U32 leds, U8 intensity);\r
 180 \r
 181 \r
 182 #endif  // _LED_H_\r