Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

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

diff --git a/LUFA/Drivers/USB/HighLevel/USBMode.h b/LUFA/Drivers/USB/HighLevel/USBMode.h
index 471f307..d894bba 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBMode.h
+++ b/LUFA/Drivers/USB/HighLevel/USBMode.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -28,22 +28,79 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief USB mode and capability macros.\r
+ *\r
+ *  This file defines macros indicating the type of USB controller the library is being compiled for, and its\r
+ *  capabilities. These macros may then be referenced in the user application to selectively enable or disable\r
+ *  code sections depending on if they are defined or not.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_USBMode USB Mode Tokens\r
+ *\r
+ *  After the inclusion of the master USB driver header, one or more of the following\r
+ *  tokens may be defined, to allow the user code to conditionally enable or disable\r
+ *  code based on the USB controller family and allowable USB modes. These tokens may\r
+ *  be tested against to eliminate code relating to a USB mode which is not enabled for\r
+ *  the given compilation.\r
+ *\r
+ *  @{\r
+ */\r
+\r

 #ifndef __USBMODE_H__\r
 #define __USBMODE_H__\r
 \r
 #ifndef __USBMODE_H__\r
 #define __USBMODE_H__\r
 \r

-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\r
-               /* Macros: */\r
-                       #if ((defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) ||   \\r
-                             defined(__AVR_AT90USB162__)  || defined(__AVR_AT90USB82__)  ||   \\r
-                                 defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) ||   \\r
-                                 defined(__AVR_ATmega32U6__)) && !defined(USB_DEVICE_ONLY))\r
-                               #define USB_DEVICE_ONLY\r
-                       #endif\r
-                       \r
-                       #if (defined(__AVR_AT90USB162__)  || defined(__AVR_AT90USB82__))\r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+               #endif\r
+               \r
+       /* Public Interface - May be used in end-application: */\r
+       #if defined(__DOXYGEN__)\r
+               /** Indicates that the target AVR microcontroller belongs to the Series 2 USB controller\r
+                *  (i.e. AT90USBXXX2 or ATMEGAXXU2) when defined.\r
+                */\r
+               #define USB_SERIES_2_AVR\r
+\r
+               /** Indicates that the target AVR microcontroller belongs to the Series 4 USB controller\r
+                *  (i.e. ATMEGAXXU4) when defined.\r
+                */\r
+               #define USB_SERIES_4_AVR\r
+\r
+               /** Indicates that the target AVR microcontroller belongs to the Series 6 USB controller\r
+                *  (i.e. AT90USBXXX6) when defined.\r
+                */\r
+               #define USB_SERIES_6_AVR\r
+\r
+               /** Indicates that the target AVR microcontroller belongs to the Series 7 USB controller\r
+                *  (i.e. AT90USBXXX7) when defined.\r
+                */\r
+               #define USB_SERIES_7_AVR\r
+\r
+               /** Indicates that the target AVR microcontroller and compilation settings allow for the\r
+                *  target to be configured in USB Device mode when defined.\r
+                */\r
+               #define USB_CAN_BE_DEVICE\r
+\r
+               /** Indicates that the target AVR microcontroller and compilation settings allow for the\r
+                *  target to be configured in USB Host mode when defined.\r
+                */\r
+               #define USB_CAN_BE_HOST\r
+\r
+               /** Indicates that the target AVR microcontroller and compilation settings allow for the\r
+                *  target to be configured in either USB Device or Host mode when defined.\r
+                */\r
+               #define USB_CAN_BE_BOTH\r
+       #else\r
+               /* Macros: */                   \r
+                       #if (defined(__AVR_AT90USB162__) || defined(__AVR_AT90USB82__)  || \\r
+                            defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega8U2__))\r

                                #define USB_SERIES_2_AVR\r
                                #define USB_SERIES_2_AVR\r

-                       #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))\r
+                       #elif (defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega16U4__))\r

                                #define USB_SERIES_4_AVR\r
                        #elif (defined(__AVR_ATmega32U6__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__))\r
                                #define USB_SERIES_6_AVR\r
                                #define USB_SERIES_4_AVR\r
                        #elif (defined(__AVR_ATmega32U6__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__))\r
                                #define USB_SERIES_6_AVR\r


@@ -51,27 +108,31 @@
                                #define USB_SERIES_7_AVR\r
                        #endif                  \r
 \r
                                #define USB_SERIES_7_AVR\r
                        #endif                  \r
 \r

+                       #if !defined(USB_SERIES_7_AVR)          \r
+                               #if defined(USB_HOST_ONLY)\r
+                                       #error USB_HOST_ONLY is not available for the currently selected USB AVR model.\r
+                               #endif\r
+                               \r
+                               #if !defined(USB_DEVICE_ONLY)\r
+                                       #define USB_DEVICE_ONLY\r
+                               #endif\r
+                       #endif\r
+\r

                        #if (!defined(USB_DEVICE_ONLY) && !defined(USB_HOST_ONLY))\r
                                #define USB_CAN_BE_BOTH\r
                                #define USB_CAN_BE_HOST\r
                                #define USB_CAN_BE_DEVICE\r
                        #elif defined(USB_HOST_ONLY)\r
                                #define USB_CAN_BE_HOST\r
                        #if (!defined(USB_DEVICE_ONLY) && !defined(USB_HOST_ONLY))\r
                                #define USB_CAN_BE_BOTH\r
                                #define USB_CAN_BE_HOST\r
                                #define USB_CAN_BE_DEVICE\r
                        #elif defined(USB_HOST_ONLY)\r
                                #define USB_CAN_BE_HOST\r

-                               #define USB_CurrentMode USB_MODE_HOST\r

                        #elif defined(USB_DEVICE_ONLY)\r
                                #define USB_CAN_BE_DEVICE\r
                        #elif defined(USB_DEVICE_ONLY)\r
                                #define USB_CAN_BE_DEVICE\r

-                               #define USB_CurrentMode USB_MODE_DEVICE\r

                        #endif\r
                        \r
                        #endif\r
                        \r

-                       #if (!(defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__)) && defined(USB_HOST_ONLY))\r
-                               #error USB_HOST_ONLY is not available for the currently selected USB AVR model.\r
-                       #elif (defined(USB_HOST_ONLY) && defined(USB_DEVICE_ONLY))\r
+                       #if (defined(USB_HOST_ONLY) && defined(USB_DEVICE_ONLY))\r

                                #error USB_HOST_ONLY and USB_DEVICE_ONLY are mutually exclusive.\r
                        #endif\r
                                #error USB_HOST_ONLY and USB_DEVICE_ONLY are mutually exclusive.\r
                        #endif\r

-\r
-                       #if defined(USE_STATIC_OPTIONS)\r
-                               #define USB_Options USE_STATIC_OPTIONS\r
-                       #endif\r

        #endif\r
        \r
 #endif\r
        #endif\r
        \r
 #endif\r

+\r
+/** @} */
\ No newline at end of file