Add script reading bootloader flags

[pub/lufa.git] / LUFA / CodeTemplates / DriverStubs / LEDs.h

diff --git a/LUFA/CodeTemplates/DriverStubs/LEDs.h b/LUFA/CodeTemplates/DriverStubs/LEDs.h
index 04744de..8f6d904 100644 (file)
--- a/LUFA/CodeTemplates/DriverStubs/LEDs.h
+++ b/LUFA/CodeTemplates/DriverStubs/LEDs.h
@@ -1,24 +1,24 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2021.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -28,26 +28,26 @@
   this software.
 */
 
-/*
-   This is a stub driver header file, for implementing custom board
-   layout hardware with compatible LUFA board specific drivers. If
-   the library is configured to use the BOARD_USER board mode, this
-   driver file should be completed and copied into the "/Board/" folder
-   inside the application's folder.
-
-   This stub is for the board-specific component of the LUFA LEDs driver,
-   for the LEDs (up to four) mounted on most USB AVR boards.
+/** \file
+ *  \brief LUFA Custom Board LED Hardware Driver (Template)
+ *
+ *  This is a stub driver header file, for implementing custom board
+ *  layout hardware with compatible LUFA board specific drivers. If
+ *  the library is configured to use the BOARD_USER board mode, this
+ *  driver file should be completed and copied into the "/Board/" folder
+ *  inside the application's folder.
+ *
+ *  This stub is for the board-specific component of the LUFA LEDs driver,
+ *  for the LEDs (up to four) mounted on most development boards.
 */
 
 #ifndef __LEDS_USER_H__
 #define __LEDS_USER_H__
 
        /* Includes: */
-               #include <avr/io.h>
-
                // TODO: Add any required includes here
 
-/* Enable C linkage for C++ Compilers: */
+       /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
                #endif
@@ -74,7 +74,7 @@
                        /** LED mask for all the LEDs on the board. */
                        #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
 
-                       /** LED mask for the none of the board LEDs. */
+                       /** LED mask for none of the board LEDs. */
                        #define LEDS_NO_LEDS     0
 
                /* Inline Functions: */
@@ -83,7 +83,12 @@
                        {
                                // TODO: Add code to initialize LED port pins as outputs here
                        }
-                       
+
+                       static inline void LEDs_Disable(void)
+                       {
+                               // TODO: Clear the LED port pins as high impedance inputs here
+                       }
+
                        static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
                        {
                                // TODO: Add code to turn on LEDs given in the LEDMask mask here, leave others as-is
@@ -98,7 +103,7 @@
                        {
                                // TODO: Add code to turn on only LEDs given in the LEDMask mask here, all others off
                        }
-                       
+
                        static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask)
                        {
                                // TODO: Add code to set the Leds in the given LEDMask to the status given in ActiveMask here
@@ -108,7 +113,7 @@
                        {
                                // TODO: Add code to toggle the Leds in the given LEDMask, ignoring all others
                        }
-                       
+
                        static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t LEDs_GetLEDs(void)
                        {
@@ -120,5 +125,6 @@
                #if defined(__cplusplus)
                        }
                #endif
-               
+
 #endif
+