The incomplete StandaloneProgrammer project now uses Host and Device Mass storage...

[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 ba221c5..e47c9c1 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBMode.h
+++ b/LUFA/Drivers/USB/HighLevel/USBMode.h
@@ -28,11 +28,58 @@
   this software.\r
 */\r
 \r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_USBMode USB Configuration 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
-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\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
@@ -71,3 +118,5 @@
        #endif\r
        \r
 #endif\r
+\r
+/** @} */
\ No newline at end of file