Add script reading bootloader flags
[pub/lufa.git] / LUFA / CodeTemplates / DriverStubs / LEDs.h
index e698c9d..8f6d904 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2021.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  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
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   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
   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 development 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__
@@ -45,7 +47,7 @@
        /* Includes: */
                // TODO: Add any required includes here
 
-/* Enable C linkage for C++ Compilers: */
+       /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
                #endif
                                // 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