SAMV71 Xplained Ultra Software Package 1.5

led.h

Go to the documentation of this file.
00001 /* ---------------------------------------------------------------------------- */
00002 /*                  Atmel Microcontroller Software Support                      */
00003 /*                       SAM Software Package License                           */
00004 /* ---------------------------------------------------------------------------- */
00005 /* Copyright (c) 2015, Atmel Corporation                                        */
00006 /*                                                                              */
00007 /* All rights reserved.                                                         */
00008 /*                                                                              */
00009 /* Redistribution and use in source and binary forms, with or without           */
00010 /* modification, are permitted provided that the following condition is met:    */
00011 /*                                                                              */
00012 /* - Redistributions of source code must retain the above copyright notice,     */
00013 /* this list of conditions and the disclaimer below.                            */
00014 /*                                                                              */
00015 /* Atmel's name may not be used to endorse or promote products derived from     */
00016 /* this software without specific prior written permission.                     */
00017 /*                                                                              */
00018 /* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
00019 /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
00020 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
00021 /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
00022 /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
00023 /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
00024 /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
00025 /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
00026 /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
00027 /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
00028 /* ---------------------------------------------------------------------------- */
00029 
00030 /**
00031  * \file
00032  *
00033  *  \section Purpose
00034  *
00035  *  Small set of functions for simple and portable LED usage.
00036  *
00037  *  \section Usage
00038  *
00039  *  -# Configure one or more LEDs using LED_Configure and
00040  *     LED_ConfigureAll.
00041  *  -# Set, clear and toggle LEDs using LED_Set, LED_Clear and
00042  *     LED_Toggle.
00043  *
00044  *  LEDs are numbered starting from 0; the number of LEDs depend on the
00045  *  board being used. All the functions defined here will compile properly
00046  *  regardless of whether the LED is defined or not; they will simply
00047  *  return 0 when a LED which does not exist is given as an argument.
00048  *  Also, these functions take into account how each LED is connected on to
00049  *  board; thus, \ref LED_Set might change the level on the corresponding pin
00050  *  to 0 or 1, but it will always light the LED on; same thing for the other
00051  *  methods.
00052  */
00053 
00054 #ifndef _LED_
00055 #define _LED_
00056 
00057 #include <stdint.h>
00058 
00059 /*----------------------------------------------------------------------------
00060  *        Exported functions
00061  *----------------------------------------------------------------------------*/
00062 
00063 extern uint32_t LED_Configure(uint32_t dwLed);
00064 
00065 extern uint32_t LED_Set(uint32_t dwLed);
00066 
00067 extern uint32_t LED_Clear(uint32_t dwLed);
00068 
00069 extern uint32_t LED_Toggle(uint32_t dwLed);
00070 
00071 #endif /* #ifndef LED_H */
00072 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines