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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  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 Pololu A-Star Micro board.
  33  *  \copydetails Group_LEDs_MICRO
  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_MICRO MICRO
  41  *  \brief Board specific LED driver header for the Pololu A-Star Micro board.
  42  *
  43  *  Board specific LED driver header for the Pololu A-Star Micro board https://www.pololu.com/docs/0J61/3.1
  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>Yellow</td><td>General Indicator</td><td>High</td><td>PORTC.7</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>Bootloader, USB-activity</td><td>Low</td><td>PORTD.5</td></tr>
  49  *  </table>
  50  *
  51  *  @{
  52  */
  53
  54 #ifndef __LEDS_MICRO_H__
  55 #define __LEDS_MICRO_H__
  56
  57         /* Includes: */
  58                 #include "../../../../Common/Common.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_LEDS_H)
  67                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  68                 #endif
  69
  70         /* Private Interface - For use in library only: */
  71         #if !defined(__DOXYGEN__)
  72                 /* Macros: */
  73                         #define LEDS_PORTC_LEDS       (LEDS_LED1)
  74                         #define LEDS_PORTD_LEDS       (LEDS_LED2)
  75         #endif
  76
  77         /* Public Interface - May be used in end-application: */
  78                 /* Macros: */
  79                         /** LED mask for the first LED on the board. */
  80                         #define LEDS_LED1        (1 << 7)
  81
  82                         /** LED mask for the second LED on the board. */
  83                         #define LEDS_LED2        (1 << 5)
  84
  85                         /** LED mask for all the LEDs on the board. */
  86                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2)
  87
  88                         /** LED mask for none of the board LEDs. */
  89                         #define LEDS_NO_LEDS     0
  90
  91                 /* Inline Functions: */
  92                 #if !defined(__DOXYGEN__)
  93                         static inline void LEDs_Init(void)
  94                         {
  95                                 DDRD  |=  LEDS_PORTD_LEDS;
  96                                 PORTD &= ~LEDS_PORTD_LEDS;
  97                                 DDRC  |=  LEDS_PORTC_LEDS;
  98                                 PORTC &= ~LEDS_PORTC_LEDS;
  99                         }
 100
 101                         static inline void LEDs_Disable(void)
 102                         {
 103                                 DDRD  &= ~LEDS_PORTD_LEDS;
 104                                 PORTD &= ~LEDS_PORTD_LEDS;
 105                                 DDRC  &= ~LEDS_PORTC_LEDS;
 106                                 PORTC &= ~LEDS_PORTC_LEDS;
 107                         }
 108
 109                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 110                         {
 111                                 PORTD |=  (LEDMask & LEDS_PORTD_LEDS);
 112                                 PORTC |=  (LEDMask & LEDS_PORTC_LEDS);
 113                         }
 114
 115                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 116                         {
 117                                 PORTD &= ~(LEDMask & LEDS_PORTD_LEDS);
 118                                 PORTC &= ~(LEDMask & LEDS_PORTC_LEDS);
 119                         }
 120
 121                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 122                         {
 123                                 PORTD = ((PORTD & ~LEDS_PORTD_LEDS) | (LEDMask & LEDS_PORTD_LEDS));
 124                                 PORTC = ((PORTC & ~LEDS_PORTC_LEDS) | (LEDMask & LEDS_PORTC_LEDS));
 125                         }
 126
 127                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 128                                                            const uint8_t ActiveMask)
 129                         {
 130                                 PORTD = ((PORTD & ~(LEDMask & LEDS_PORTD_LEDS)) | (ActiveMask & LEDS_PORTD_LEDS));
 131                                 PORTC = ((PORTC & ~(LEDMask & LEDS_PORTC_LEDS)) | (ActiveMask & LEDS_PORTC_LEDS));
 132                         }
 133
 134                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 135                         {
 136                                 PORTD ^= (LEDMask & LEDS_PORTD_LEDS);
 137                                 PORTC ^= (LEDMask & LEDS_PORTC_LEDS);
 138                         }
 139
 140                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 141                         static inline uint8_t LEDs_GetLEDs(void)
 142                         {
 143                                 return ((PORTD & LEDS_PORTD_LEDS) | (PORTC & LEDS_PORTC_LEDS));
 144                         }
 145                 #endif
 146
 147         /* Disable C linkage for C++ Compilers: */
 148                 #if defined(__cplusplus)
 149                         }
 150                 #endif
 151
 152 #endif
 153
 154 /** @} */