X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/fef185a409e2fee980d5fd391813a1cb7809582a..05fcf7e2a79bebb978d4aeaef26b12f70c6826f8:/LUFA/Drivers/USB/HighLevel/USBMode.h

diff --git a/LUFA/Drivers/USB/HighLevel/USBMode.h b/LUFA/Drivers/USB/HighLevel/USBMode.h
index 18a2666c6..cf6c78d9e 100644
--- a/LUFA/Drivers/USB/HighLevel/USBMode.h
+++ b/LUFA/Drivers/USB/HighLevel/USBMode.h
@@ -28,11 +28,58 @@
   this software.
 */
 
+/** \ingroup Group_USB
+ *  @defgroup Group_USBMode USB Mode Tokens
+ *
+ *  After the inclusion of the master USB driver header, one or more of the following
+ *  tokens may be defined, to allow the user code to conditionally enable or disable
+ *  code based on the USB controller family and allowable USB modes. These tokens may
+ *  be tested against to eliminate code relating to a USB mode which is not enabled for
+ *  the given compilation.
+ *
+ *  @{
+ */
+
 #ifndef __USBMODE_H__
 #define __USBMODE_H__
 
-	/* Private Interface - For use in library only: */
-	#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
+		 *  (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
+		 *  (i.e. ATMEGAXXU4) when defined.
+		 */
+		#define USB_SERIES_4_AVR
+
+		/** Indicates that the target AVR microcontroller belongs to the Series 6 USB controller
+		 *  (i.e. AT90USBXXX6) when defined.
+		 */
+		#define USB_SERIES_6_AVR
+
+		/** Indicates that the target AVR microcontroller belongs to the Series 7 USB controller
+		 *  (i.e. AT90USBXXX7) when defined.
+		 */
+		#define USB_SERIES_7_AVR
+
+		/** Indicates that the target AVR microcontroller and compilation settings allow for the
+		 *  target to be configured in USB Device mode when defined.
+		 */
+		#define USB_CAN_BE_DEVICE
+
+		/** Indicates that the target AVR microcontroller and compilation settings allow for the
+		 *  target to be configured in USB Host mode when defined.
+		 */
+		#define USB_CAN_BE_HOST
+
+		/** Indicates that the target AVR microcontroller and compilation settings allow for the
+		 *  target to be configured in either USB Device or Host mode when defined.
+		 */
+		#define USB_CAN_BE_BOTH
+	#else
 		/* Macros: */			
 			#if (defined(__AVR_AT90USB162__) || defined(__AVR_AT90USB82__)  || \
 			     defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega8U2__))
@@ -50,7 +97,9 @@
 					#error USB_HOST_ONLY is not available for the currently selected USB AVR model.
 				#endif
 				
-				#define USB_DEVICE_ONLY
+				#if !defined(USB_DEVICE_ONLY)
+					#define USB_DEVICE_ONLY
+				#endif
 			#endif
 
 			#if (!defined(USB_DEVICE_ONLY) && !defined(USB_HOST_ONLY))
@@ -69,3 +118,5 @@
 	#endif
 	
 #endif
+
+/** @} */
\ No newline at end of file