Fix broken code sample section spacing in the Doxygen documentation due to a missing...

[pub/USBasp.git] / LUFA / Drivers / USB / Core / USBMode.h

diff --git a/LUFA/Drivers/USB/Core/USBMode.h b/LUFA/Drivers/USB/Core/USBMode.h
index 4acfda2..7ae30bb 100644 (file)
--- a/LUFA/Drivers/USB/Core/USBMode.h
+++ b/LUFA/Drivers/USB/Core/USBMode.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -55,6 +55,11 @@
 #ifndef __USBMODE_H__
 #define __USBMODE_H__
 
 #ifndef __USBMODE_H__
 #define __USBMODE_H__
 

+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+

        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.


@@ -62,30 +67,90 @@
 
        /* Public Interface - May be used in end-application: */
        #if defined(__DOXYGEN__)
 
        /* Public Interface - May be used in end-application: */
        #if defined(__DOXYGEN__)

-               /** Indicates that the target AVR microcontroller belongs to the Series 2 USB controller
+               /** Indicates that the target AVR microcontroller belongs to the Series 2 AVR8 USB controller

                 *  (i.e. AT90USBxxx2 or ATMEGAxxU2) when defined.
                 */
                #define USB_SERIES_2_AVR
 
                 *  (i.e. AT90USBxxx2 or ATMEGAxxU2) when defined.
                 */
                #define USB_SERIES_2_AVR
 

-               /** Indicates that the target AVR microcontroller belongs to the Series 4 USB controller
+               /** Indicates that the target AVR microcontroller belongs to the Series 4 AVR8 USB controller

                 *  (i.e. ATMEGAxxU4) when defined.
                 */
                #define USB_SERIES_4_AVR
 
                 *  (i.e. ATMEGAxxU4) when defined.
                 */
                #define USB_SERIES_4_AVR
 

-               /** Indicates that the target AVR microcontroller belongs to the Series 6 USB controller
+               /** Indicates that the target AVR microcontroller belongs to the Series 6 AVR8 USB controller

                 *  (i.e. AT90USBxxx6) when defined.
                 */
                #define USB_SERIES_6_AVR
 
                 *  (i.e. AT90USBxxx6) when defined.
                 */
                #define USB_SERIES_6_AVR
 

-               /** Indicates that the target AVR microcontroller belongs to the Series 7 USB controller
+               /** Indicates that the target AVR microcontroller belongs to the Series 7 AVR8 USB controller

                 *  (i.e. AT90USBxxx7) when defined.
                 */
                #define USB_SERIES_7_AVR
 
                 *  (i.e. AT90USBxxx7) when defined.
                 */
                #define USB_SERIES_7_AVR
 

-               /** Indicates that the target AVR microcontroller belongs to the UC3B Series USB controller
-                *  (i.e. AT32UC3B*) when defined.
+               /** Indicates that the target AVR microcontroller belongs to the AVR32 UC3A0 Series USB controller
+                *  (i.e. AT32UC3A0*) when defined.
+                */
+               #define USB_SERIES_UC3A0_AVR
+
+               /** Indicates that the target AVR microcontroller belongs to the AVR32 UC3A1 Series USB controller
+                *  (i.e. AT32UC3A1*) when defined.
+                */
+               #define USB_SERIES_UC3A1_AVR
+
+               /** Indicates that the target AVR microcontroller belongs to the AVR32 UC3A3 Series USB controller
+                *  (i.e. AT32UC3A3*) when defined.
+                */
+               #define USB_SERIES_UC3A3_AVR
+
+               /** Indicates that the target AVR microcontroller belongs to the AVR32 UC3A4 Series USB controller
+                *  (i.e. AT32UC3A4*) when defined.
+                */
+               #define USB_SERIES_UC3A4_AVR
+               
+               /** Indicates that the target AVR microcontroller belongs to the AVR32 UC3B0 Series USB controller
+                *  (i.e. AT32UC3B0*) when defined.
+                */
+               #define USB_SERIES_UC3B0_AVR
+
+               /** Indicates that the target AVR microcontroller belongs to the AVR32 UC3B1 Series USB controller
+                *  (i.e. AT32UC3B1*) when defined.
+                */
+               #define USB_SERIES_UC3B1_AVR
+
+               /** Indicates that the target AVR microcontroller belongs to the XMEGA A1U Series USB controller
+                *  (i.e. ATXMEGA*A1U) when defined.
+                */
+               #define USB_SERIES_A1U_XMEGA
+
+               /** Indicates that the target AVR microcontroller belongs to the XMEGA A3U Series USB controller
+                *  (i.e. ATXMEGA*A3U) when defined.
+                */
+               #define USB_SERIES_A3U_XMEGA
+
+               /** Indicates that the target AVR microcontroller belongs to the XMEGA A4U Series USB controller
+                *  (i.e. ATXMEGA*A4U) when defined.
+                */
+               #define USB_SERIES_A4U_XMEGA
+
+               /** Indicates that the target AVR microcontroller belongs to the XMEGA B1 Series USB controller
+                *  (i.e. ATXMEGA*B1) when defined.
+                */
+               #define USB_SERIES_B1_XMEGA
+
+               /** Indicates that the target AVR microcontroller belongs to the XMEGA B3 Series USB controller
+                *  (i.e. ATXMEGA*B3) when defined.
+                */
+               #define USB_SERIES_B3_XMEGA
+
+               /** Indicates that the target AVR microcontroller belongs to the XMEGA C3 Series USB controller
+                *  (i.e. ATXMEGA*C3) when defined.
+                */
+               #define USB_SERIES_C3_XMEGA
+
+               /** Indicates that the target AVR microcontroller belongs to the XMEGA C4 Series USB controller
+                *  (i.e. ATXMEGA*C4) when defined.

                 */
                 */

-               #define USB_SERIES_UC3B_AVR
+               #define USB_SERIES_C4_XMEGA

 
                /** Indicates that the target microcontroller and compilation settings allow for the
                 *  target to be configured in USB Device mode when defined.
 
                /** Indicates that the target microcontroller and compilation settings allow for the
                 *  target to be configured in USB Device mode when defined.


@@ -117,15 +182,68 @@
                                #define USB_SERIES_7_AVR
                                #define USB_CAN_BE_DEVICE
                                #define USB_CAN_BE_HOST
                                #define USB_SERIES_7_AVR
                                #define USB_CAN_BE_DEVICE
                                #define USB_CAN_BE_HOST

-                       #elif (defined(__AVR32_UC3B0512__) || defined(__AVR32_UC3B1512__) || \
-                              defined(__AVR32_UC3B0256__) || defined(__AVR32_UC3B1256__) || \
-                              defined(__AVR32_UC3B0128__) || defined(__AVR32_UC3B1128__) || \
-                              defined(__AVR32_UC3B064__) || defined(__AVR32_UC3B164__))
-                               #define USB_SERIES_UC3B_AVR
+                       #elif (defined(__AVR32_UC3A0512__) || defined(__AVR32_UC3A0256__) || \
+                              defined(__AVR32_UC3A0128__) || defined(__AVR32_UC3A064__))
+                               #define USB_SERIES_UC3A0_AVR32
+                               #define USB_CAN_BE_DEVICE
+                               #define USB_CAN_BE_HOST
+                       #elif (defined(__AVR32_UC3A1512__) || defined(__AVR32_UC3A1256__) || \
+                              defined(__AVR32_UC3A1128__) || defined(__AVR32_UC3A164__))
+                               #define USB_SERIES_UC3A1_AVR32
+                               #define USB_CAN_BE_DEVICE
+                               #define USB_CAN_BE_HOST
+                       #elif (defined(__AVR32_UC3A3256__) || defined(__AVR32_UC3A3256S__) || \
+                              defined(__AVR32_UC3A3128__) || defined(__AVR32_UC3A3128S__) || \
+                              defined(__AVR32_UC3A364__)  || defined(__AVR32_UC3A364S__))
+                               #define USB_SERIES_UC3A3_AVR32
+                               #define USB_CAN_BE_DEVICE
+                               #define USB_CAN_BE_HOST
+                       #elif (defined(__AVR32_UC3A4256__) || defined(__AVR32_UC3A4256S__) || \
+                              defined(__AVR32_UC3A4128__) || defined(__AVR32_UC3A4128S__) || \
+                              defined(__AVR32_UC3A464__)  || defined(__AVR32_UC3A464S__))
+                               #define USB_SERIES_UC3A4_AVR32
+                               #define USB_CAN_BE_DEVICE
+                               #define USB_CAN_BE_HOST
+                       #elif (defined(__AVR32_UC3B0512__) || defined(__AVR32_UC3B0256__) || \
+                              defined(__AVR32_UC3B0128__) || defined(__AVR32_UC3B064__))
+                               #define USB_SERIES_UC3B0_AVR32

                                #define USB_CAN_BE_DEVICE
                                #define USB_CAN_BE_HOST
                                #define USB_CAN_BE_DEVICE
                                #define USB_CAN_BE_HOST

+                       #elif (defined(__AVR32_UC3B1512__) || defined(__AVR32_UC3B1256__) || \
+                              defined(__AVR32_UC3B1128__) || defined(__AVR32_UC3B164__))
+                               #define USB_SERIES_UC3B1_AVR32
+                               #define USB_CAN_BE_DEVICE
+                               #define USB_CAN_BE_HOST
+                       #elif (defined(__AVR_ATxmega128A1U__) || defined(__AVR_ATxmega64A1U__))
+                               #define USB_SERIES_A1U_XMEGA
+                               #define USB_CAN_BE_DEVICE
+                       #elif (defined(__AVR_ATxmega64A3U__) || defined(__AVR_ATxmega128A3U__) || \
+                              defined(__AVR_ATxmega192A3U__) || defined(__AVR_ATxmega256A3U__))
+                               #define USB_SERIES_A3U_XMEGA
+                               #define USB_CAN_BE_DEVICE
+                       #elif (defined(__AVR_ATxmega256A3BU__))
+                               #define USB_SERIES_A3BU_XMEGA
+                               #define USB_CAN_BE_DEVICE
+                       #elif (defined(__AVR_ATxmega16A4U__) || defined(__AVR_ATxmega32A4U__) || \
+                              defined(__AVR_ATxmega64A4U__) || defined(__AVR_ATxmega128A4U__))
+                               #define USB_SERIES_A4U_XMEGA
+                               #define USB_CAN_BE_DEVICE
+                       #elif (defined(__AVR_ATxmega128B1__) || defined(__AVR_ATxmega64B1__))
+                               #define USB_SERIES_B1_XMEGA
+                               #define USB_CAN_BE_DEVICE
+                       #elif (defined(__AVR_ATxmega128B3__) || defined(__AVR_ATxmega64B3__))
+                               #define USB_SERIES_B3_XMEGA
+                               #define USB_CAN_BE_DEVICE
+                       #elif (defined(__AVR_ATxmega128C3__) || defined(__AVR_ATxmega64C3__) || \
+                              defined(__AVR_ATxmega192C3__) || defined(__AVR_ATxmega256C3__) || \
+                                  defined(__AVR_ATxmega384C3__))
+                               #define USB_SERIES_C3_XMEGA
+                               #define USB_CAN_BE_DEVICE
+                       #elif (defined(__AVR_ATxmega16C4__) || defined(__AVR_ATxmega32C4__))
+                               #define USB_SERIES_C4_XMEGA
+                               #define USB_CAN_BE_DEVICE

                        #endif
                        #endif

-                       
+

                        #if (defined(USB_CAN_BE_DEVICE) && defined(USB_CAN_BE_HOST))
                                #define USB_CAN_BE_BOTH
                        #endif
                        #if (defined(USB_CAN_BE_DEVICE) && defined(USB_CAN_BE_HOST))
                                #define USB_CAN_BE_BOTH
                        #endif


@@ -147,16 +265,22 @@
                                        #undef USB_CAN_BE_BOTH
                                #endif
                        #endif
                                        #undef USB_CAN_BE_BOTH
                                #endif
                        #endif

-                       
+

                        #if (defined(USB_HOST_ONLY) && defined(USB_DEVICE_ONLY))
                                #error USB_HOST_ONLY and USB_DEVICE_ONLY are mutually exclusive.
                        #endif
 
                        #if (!defined(USB_CAN_BE_DEVICE) && !defined(USB_CAN_BE_HOST))
                        #if (defined(USB_HOST_ONLY) && defined(USB_DEVICE_ONLY))
                                #error USB_HOST_ONLY and USB_DEVICE_ONLY are mutually exclusive.
                        #endif
 
                        #if (!defined(USB_CAN_BE_DEVICE) && !defined(USB_CAN_BE_HOST))

-                               #error The currently selected architecture is not supported under the USB component of the library.
+                               #error The currently selected device or architecture is not supported under the USB component of the library.

                        #endif
        #endif
 
                        #endif
        #endif
 

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

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

+