LUFA/Drivers/Board/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  This file is the master dispatch header file for the board-specific LED driver, for boards containing user
  34  *  controllable LEDs.
  35  *
  36  *  User code should include this file, which will in turn include the correct LED driver header file for the
  37  *  currently selected board.
  38  *
  39  *  If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project
  40  *  directory.
  41  */
  42
  43 /** \ingroup Group_BoardDrivers
  44  *  @defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
  45  *
  46  *  \section Sec_Dependencies Module Source Dependencies
  47  *  The following files must be built with any user project that uses this module:
  48  *    - None
  49  *
  50  *  \section Module Description
  51  *  Functions, macros, variables, enums and types related to the control of board LEDs.
  52  *
  53  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  54  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  55  *
  56  *  @{
  57  */
  58
  59 #ifndef __LEDS_H__
  60 #define __LEDS_H__
  61
  62         /* Macros: */
  63         #if !defined(__DOXYGEN__)
  64                 #define INCLUDE_FROM_LEDS_H
  65                 #define INCLUDE_FROM_BOARD_DRIVER
  66         #endif
  67
  68         /* Includes: */
  69         #include "../../Common/Common.h"
  70
  71         #if !defined(BOARD)
  72                 #error BOARD must be set in makefile to a value specified in BoardTypes.h.
  73         #elif (BOARD == BOARD_USBKEY)
  74                 #include "USBKEY/LEDs.h"
  75         #elif (BOARD == BOARD_STK525)
  76                 #include "STK525/LEDs.h"
  77         #elif (BOARD == BOARD_STK526)
  78                 #include "STK526/LEDs.h"
  79         #elif (BOARD == BOARD_RZUSBSTICK)
  80                 #include "RZUSBSTICK/LEDs.h"
  81         #elif (BOARD == BOARD_ATAVRUSBRF01)
  82                 #include "ATAVRUSBRF01/LEDs.h"
  83         #elif (BOARD == BOARD_USER)
  84                 #include "Board/LEDs.h"
  85         #endif
  86
  87         /* Pseudo-Functions for Doxygen: */
  88         #if defined(__DOXYGEN__)
  89                 /** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
  90                  *  I/O pins as outputs, and sets the LEDs to default to off.
  91                  */
  92                 static inline void LEDs_Init(void);
  93
  94                 /** Turns on the LEDs specified in the given LED mask.
  95                  *
  96                  *  \param LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
  97                  */
  98                 static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask);
  99
 100                 /** Turns off the LEDs specified in the given LED mask.
 101                  *
 102                  *  \param LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
 103                  */
 104                 static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask);
 105
 106                 /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
 107                  *  mask.
 108                  *
 109                  *  \param LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
 110                  */
 111                 static inline void LEDs_SetAllLEDs(const uint8_t LEDMask);
 112
 113                 /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs
 114                  *  specified in both the LED and active masks.
 115                  *
 116                  *  \param LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
 117                  *  \param ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off
 118                  */
 119                 static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask);
 120
 121                 /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
 122                  *  corresponding LED is on.
 123                  *
 124                  *  \return Mask of the board LEDs which are currently turned on
 125                  */
 126                 static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 127         #endif
 128
 129 #endif
 130
 131 /** @} */