git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained_IAR_Keil/libboard_samv7-ek/include/led.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2011, 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  * \file\r
  32  *\r
  33  *  \section Purpose\r
  34  * \r
  35  *  Small set of functions for simple and portable LED usage.\r
  36  * \r
  37  *  \section Usage\r
  38  * \r
  39  *  -# Configure one or more LEDs using LED_Configure and\r
  40  *     LED_ConfigureAll.\r
  41  *  -# Set, clear and toggle LEDs using LED_Set, LED_Clear and\r
  42  *     LED_Toggle.\r
  43  * \r
  44  *  LEDs are numbered starting from 0; the number of LEDs depend on the\r
  45  *  board being used. All the functions defined here will compile properly\r
  46  *  regardless of whether the LED is defined or not; they will simply\r
  47  *  return 0 when a LED which does not exist is given as an argument.\r
  48  *  Also, these functions take into account how each LED is connected on to\r
  49  *  board; thus, \ref LED_Set might change the level on the corresponding pin\r
  50  *  to 0 or 1, but it will always light the LED on; same thing for the other\r
  51  *  methods.\r
  52  */\r
  53 \r
  54 #ifndef _LED_\r
  55 #define _LED_\r
  56 \r
  57 #include <stdint.h>\r
  58 \r
  59 //------------------------------------------------------------------------------\r
  60 //         Global Functions\r
  61 //------------------------------------------------------------------------------\r
  62 \r
  63 extern uint32_t LED_Configure( uint32_t dwLed ) ;\r
  64 \r
  65 extern uint32_t LED_Set( uint32_t dwLed ) ;\r
  66 \r
  67 extern uint32_t LED_Clear( uint32_t dwLed ) ;\r
  68 \r
  69 extern uint32_t LED_Toggle( uint32_t dwLed ) ;\r
  70 \r
  71 #endif /* #ifndef LED_H */\r
  72 \r