LUFA/Drivers/Board/AVR8/MULTIO/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 disclaims 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  *  \brief Board specific LED driver header for the Bitwizard Multio.
  33  *  \copydetails Group_LEDs_MULTIO
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  36  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  37  */
  38
  39 /** \ingroup Group_LEDs
  40  *  \defgroup Group_LEDs_MULTIO MULTIO
  41  *  \brief Board specific LED driver header for the Bitwizard Multio.
  42  *
  43  *  Board specific LED driver header for the Bitwizard Multio (http://www.bitwizard.nl/wiki/index.php/USB-multio).
  44  *
  45  *  <table>
  46  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  47  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.0</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTC.2</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.7</td></tr>
  50  *  </table>
  51  *
  52  *  @{
  53  */
  54
  55 #ifndef __LEDS_MULTIO_H__
  56 #define __LEDS_MULTIO_H__
  57
  58         /* Includes: */
  59                 #include "../../../../Common/Common.h"
  60
  61         /* Enable C linkage for C++ Compilers: */
  62                 #if defined(__cplusplus)
  63                         extern "C" {
  64                 #endif
  65
  66         /* Preprocessor Checks: */
  67                 #if !defined(__INCLUDE_FROM_LEDS_H)
  68                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  69                 #endif
  70
  71         /* Private Interface - For use in library only: */
  72         #if !defined(__DOXYGEN__)
  73                 /* Macros: */
  74                         #define LEDS_PORTD_LEDS       (LEDS_LED1 | LEDS_LED3)
  75                         #define LEDS_PORTC_LEDS       LEDS_LED2
  76         #endif
  77
  78         /* Public Interface - May be used in end-application: */
  79                 /* Macros: */
  80                         /** LED mask for the first LED on the board. */
  81                         #define LEDS_LED1        (1 << 0)
  82
  83                         /** LED mask for the second LED on the board. */
  84                         #define LEDS_LED2        (1 << 2)
  85
  86                         /** LED mask for the second LED on the board. */
  87                         #define LEDS_LED3        (1 << 7)
  88
  89                         /** LED mask for all the LEDs on the board. */
  90                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3)
  91
  92                         /** LED mask for none of the board LEDs. */
  93                         #define LEDS_NO_LEDS     0
  94
  95                 /* Inline Functions: */
  96                 #if !defined(__DOXYGEN__)
  97                         static inline void LEDs_Init(void)
  98                         {
  99                                 DDRD  |=  LEDS_PORTD_LEDS;
 100                                 DDRC  |=  LEDS_PORTC_LEDS;
 101
 102                                 PORTD &= ~LEDS_PORTD_LEDS;
 103                                 PORTC &= ~LEDS_PORTC_LEDS;
 104                         }
 105
 106                         static inline void LEDs_Disable(void)
 107                         {
 108                                 DDRD  &= ~LEDS_PORTD_LEDS;
 109                                 DDRC  &= ~LEDS_PORTC_LEDS;
 110
 111                                 PORTD &= ~LEDS_PORTD_LEDS;
 112                                 PORTC &= ~LEDS_PORTC_LEDS;
 113                         }
 114
 115                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 116                         {
 117                                 PORTD |= (LEDMask & LEDS_PORTD_LEDS);
 118                                 PORTC |= (LEDMask & LEDS_PORTC_LEDS);
 119                         }
 120
 121                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 122                         {
 123                                 PORTD &= ~(LEDMask & LEDS_PORTD_LEDS);
 124                                 PORTC &= ~(LEDMask & LEDS_PORTC_LEDS);
 125                         }
 126
 127                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 128                         {
 129                                 PORTD = (PORTD & ~LEDS_PORTD_LEDS) | (LEDMask & LEDS_PORTD_LEDS);
 130                                 PORTC = (PORTC & ~LEDS_PORTC_LEDS) | (LEDMask & LEDS_PORTC_LEDS);
 131                         }
 132
 133                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 134                                                            const uint8_t ActiveMask)
 135                         {
 136                                 PORTD = (PORTD & ~(LEDMask & LEDS_PORTD_LEDS)) | (ActiveMask & LEDS_PORTD_LEDS);
 137                                 PORTC = (PORTC & ~(LEDMask & LEDS_PORTC_LEDS)) | (ActiveMask & LEDS_PORTC_LEDS);
 138                         }
 139
 140                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 141                         {
 142                                 PIND  = (LEDMask & LEDS_PORTD_LEDS);
 143                                 PINC  = (LEDMask & LEDS_PORTC_LEDS);
 144                         }
 145
 146                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 147                         static inline uint8_t LEDs_GetLEDs(void)
 148                         {
 149                                 return ((PORTD & LEDS_PORTD_LEDS) | (PORTC & LEDS_PORTC_LEDS));
 150                         }
 151                 #endif
 152
 153         /* Disable C linkage for C++ Compilers: */
 154                 #if defined(__cplusplus)
 155                         }
 156                 #endif
 157
 158 #endif
 159
 160 /** @} */
 161