More Doxygen updates for multiple architecture support.

[pub/USBasp.git] / LUFA / Drivers / Board / XPLAIN / LEDs.h

diff --git a/LUFA/Drivers/Board/XPLAIN/LEDs.h b/LUFA/Drivers/Board/XPLAIN/LEDs.h
index daca766..75d4a7b 100644 (file)
--- a/LUFA/Drivers/Board/XPLAIN/LEDs.h
+++ b/LUFA/Drivers/Board/XPLAIN/LEDs.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  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
   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
   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
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -29,31 +29,26 @@
 */
 
 /** \file
 */
 
 /** \file

- *  \brief Board specific LED driver header for the XPLAIN.
- *
- *  Board specific LED driver header for the XPLAIN.
+ *  \brief Board specific LED driver header for the Atmel XPLAIN.
+ *  \copydetails Group_LEDs_XPLAIN

  *
  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  */
 
 /** \ingroup Group_LEDs
  *
  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  */
 
 /** \ingroup Group_LEDs

- *  @defgroup Group_LEDs_XPLAIN XPLAIN
+ *  \defgroup Group_LEDs_XPLAIN XPLAIN
+ *  \brief Board specific LED driver header for the Atmel XPLAIN.

  *
  *

- *  Board specific LED driver header for the XPLAIN.
- *
- *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
- *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
+ *  Board specific LED driver header for the Atmel XPLAIN.

  *
  *  @{
  */
  *
  *  @{
  */

- 
+

 #ifndef __LEDS_XPLAIN_H__
 #define __LEDS_XPLAIN_H__
 
        /* Includes: */
 #ifndef __LEDS_XPLAIN_H__
 #define __LEDS_XPLAIN_H__
 
        /* Includes: */

-               #include <avr/io.h>
-

                #include "../../../Common/Common.h"
 
        /* Enable C linkage for C++ Compilers: */
                #include "../../../Common/Common.h"
 
        /* Enable C linkage for C++ Compilers: */


@@ -74,7 +69,7 @@
                        /** LED mask for all the LEDs on the board. */
                        #define LEDS_ALL_LEDS    LEDS_LED1
 
                        /** LED mask for all the LEDs on the board. */
                        #define LEDS_ALL_LEDS    LEDS_LED1
 

-                       /** LED mask for the none of the board LEDs */
+                       /** LED mask for none of the board LEDs. */

                        #define LEDS_NO_LEDS     0
 
                /* Inline Functions: */
                        #define LEDS_NO_LEDS     0
 
                /* Inline Functions: */


@@ -84,7 +79,7 @@
                                DDRB  |= LEDS_ALL_LEDS;
                                PORTB |= LEDS_ALL_LEDS;
                        }
                                DDRB  |= LEDS_ALL_LEDS;
                                PORTB |= LEDS_ALL_LEDS;
                        }

-                       
+

                        static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
                        {
                                PORTB &= ~LEDMask;
                        static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
                        {
                                PORTB &= ~LEDMask;


@@ -99,29 +94,31 @@
                        {
                                PORTB = ((PORTB | LEDS_ALL_LEDS) & ~LEDMask);
                        }
                        {
                                PORTB = ((PORTB | LEDS_ALL_LEDS) & ~LEDMask);
                        }

-                       
-                       static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask)
+
+                       static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
+                                                          const uint8_t ActiveMask)

                        {
                        {

-                               PORTB = ((PORTB | (LEDMask & LEDS_ALL_LEDS)) & (~ActiveMask & LEDS_ALL_LEDS));
+                               PORTB = ((PORTB | LEDMask) & ~ActiveMask);

                        }
                        }

-                       
+

                        static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
                        {
                        static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
                        {

-                               PORTD = (PORTB ^ (LEDMask & LEDS_ALL_LEDS));
+                               PORTB ^= LEDMask;

                        }
                        }

-                       
+

                        static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t LEDs_GetLEDs(void)
                        {
                                return (~PORTB & LEDS_ALL_LEDS);
                        }
                #endif
                        static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t LEDs_GetLEDs(void)
                        {
                                return (~PORTB & LEDS_ALL_LEDS);
                        }
                #endif

-               
+

        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif

-       
+

 #endif
 
 /** @} */
 #endif
 
 /** @} */

+