Minor documentation adjustments to the demos, projects and bootloaders to ensure...
[pub/USBasp.git] / LUFA / CodeTemplates / LUFAConfig.h
index 9feb341..35e8f65 100644 (file)
@@ -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
   this software.
 */
 
   this software.
 */
 
-/*
-   This is a header file which can be used to configure LUFA's
-   compile time options, as an alternative to the compile time
-   constants supplied through a makefile. To use this configuration
-   header, copy this into your project's root directory and supply
-   the \c USE_LUFA_CONFIG_HEADER token to the compiler so that it is
-   defined in all compiled source files.
-   
-   For information on what each token does, refer to the LUFA
-   manual section "Summary of Compile Tokens".
-*/
+/** \file
+ *  \brief LUFA Library Configuration Header File (Template)
+ *
+ *  This is a header file which can be used to configure LUFA's
+ *  compile time options, as an alternative to the compile time
+ *  constants supplied through a makefile. To use this configuration
+ *  header, copy this into your project's root directory and supply
+ *  the \c USE_LUFA_CONFIG_HEADER token to the compiler so that it is
+ *  defined in all compiled source files.
+ *
+ *  For information on what each token does, refer to the LUFA
+ *  manual section "Summary of Compile Tokens".
+ */
 
 #ifndef __LUFA_CONFIG_H__
 #define __LUFA_CONFIG_H__
 
 #ifndef __LUFA_CONFIG_H__
 #define __LUFA_CONFIG_H__
@@ -73,7 +75,7 @@
 //             #define NO_INTERNAL_SERIAL
 //             #define FIXED_CONTROL_ENDPOINT_SIZE      {Insert Value Here}
 //             #define DEVICE_STATE_AS_GPIOR            {Insert Value Here}
 //             #define NO_INTERNAL_SERIAL
 //             #define FIXED_CONTROL_ENDPOINT_SIZE      {Insert Value Here}
 //             #define DEVICE_STATE_AS_GPIOR            {Insert Value Here}
-//             #define FIXED_NUM_CONFIGURATION          {Insert Value Here}
+//             #define FIXED_NUM_CONFIGURATIONS         {Insert Value Here}
 //             #define CONTROL_ONLY_DEVICE
 //             #define INTERRUPT_CONTROL_ENDPOINT
 //             #define NO_DEVICE_REMOTE_WAKEUP
 //             #define CONTROL_ONLY_DEVICE
 //             #define INTERRUPT_CONTROL_ENDPOINT
 //             #define NO_DEVICE_REMOTE_WAKEUP
 //             #define HOST_STATE_AS_GPIOR              {Insert Value Here}
 //             #define USB_HOST_TIMEOUT_MS              {Insert Value Here}
 //             #define HOST_DEVICE_SETTLE_DELAY_MS          {Insert Value Here}
 //             #define HOST_STATE_AS_GPIOR              {Insert Value Here}
 //             #define USB_HOST_TIMEOUT_MS              {Insert Value Here}
 //             #define HOST_DEVICE_SETTLE_DELAY_MS          {Insert Value Here}
+//      #define NO_AUTO_VBUS_MANAGEMENT
+//      #define INVERTED_VBUS_ENABLE_LINE
+
+       #elif (ARCH == ARCH_XMEGA)
+
+               /* Non-USB Related Configuration Tokens: */
+//             #define DISABLE_TERMINAL_CODES
+
+               /* USB Class Driver Related Tokens: */
+//             #define HID_HOST_BOOT_PROTOCOL_ONLY
+//             #define HID_STATETABLE_STACK_DEPTH       {Insert Value Here}
+//             #define HID_USAGE_STACK_DEPTH            {Insert Value Here}
+//             #define HID_MAX_COLLECTIONS              {Insert Value Here}
+//             #define HID_MAX_REPORTITEMS              {Insert Value Here}
+//             #define HID_MAX_REPORT_IDS               {Insert Value Here}
+//             #define NO_CLASS_DRIVER_AUTOFLUSH
+
+               /* General USB Driver Related Tokens: */
+//             #define USE_STATIC_OPTIONS               {Insert Value Here}
+//             #define USB_STREAM_TIMEOUT_MS            {Insert Value Here}
+//             #define NO_LIMITED_CONTROLLER_CONNECT
+//             #define NO_SOF_EVENTS
+
+               /* USB Device Mode Driver Related Tokens: */
+//             #define USE_RAM_DESCRIPTORS
+//             #define USE_FLASH_DESCRIPTORS
+//             #define USE_EEPROM_DESCRIPTORS
+//             #define NO_INTERNAL_SERIAL
+//             #define FIXED_CONTROL_ENDPOINT_SIZE      {Insert Value Here}
+//             #define DEVICE_STATE_AS_GPIOR            {Insert Value Here}
+//             #define FIXED_NUM_CONFIGURATIONS         {Insert Value Here}
+//             #define CONTROL_ONLY_DEVICE
+//             #define NO_DEVICE_REMOTE_WAKEUP
+//             #define NO_DEVICE_SELF_POWER
 
        #elif (ARCH == ARCH_UC3)
 
 
        #elif (ARCH == ARCH_UC3)
 
                /* USB Device Mode Driver Related Tokens: */
 //             #define NO_INTERNAL_SERIAL
 //             #define FIXED_CONTROL_ENDPOINT_SIZE      {Insert Value Here}
                /* USB Device Mode Driver Related Tokens: */
 //             #define NO_INTERNAL_SERIAL
 //             #define FIXED_CONTROL_ENDPOINT_SIZE      {Insert Value Here}
-//             #define FIXED_NUM_CONFIGURATION          {Insert Value Here}
+//             #define FIXED_NUM_CONFIGURATIONS         {Insert Value Here}
 //             #define CONTROL_ONLY_DEVICE
 //             #define INTERRUPT_CONTROL_ENDPOINT
 //             #define NO_DEVICE_REMOTE_WAKEUP
 //             #define CONTROL_ONLY_DEVICE
 //             #define INTERRUPT_CONTROL_ENDPOINT
 //             #define NO_DEVICE_REMOTE_WAKEUP
                /* USB Host Mode Driver Related Tokens: */
 //             #define USB_HOST_TIMEOUT_MS              {Insert Value Here}
 //             #define HOST_DEVICE_SETTLE_DELAY_MS          {Insert Value Here}
                /* USB Host Mode Driver Related Tokens: */
 //             #define USB_HOST_TIMEOUT_MS              {Insert Value Here}
 //             #define HOST_DEVICE_SETTLE_DELAY_MS          {Insert Value Here}
+//      #define NO_AUTO_VBUS_MANAGEMENT
+//      #define INVERTED_VBUS_ENABLE_LINE
 
 
-       #endif  
+       #endif
 #endif
 
 #endif