Add skeleton LUFAConfig.h to the CodeTemplates directory.
authorDean Camera <dean@fourwalledcubicle.com>
Sat, 14 May 2011 02:34:47 +0000 (02:34 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Sat, 14 May 2011 02:34:47 +0000 (02:34 +0000)
LUFA/CodeTemplates/LUFAConfig.h [new file with mode: 0644]
LUFA/ManPages/CompileTimeTokens.txt

diff --git a/LUFA/CodeTemplates/LUFAConfig.h b/LUFA/CodeTemplates/LUFAConfig.h
new file mode 100644 (file)
index 0000000..5d808a3
--- /dev/null
@@ -0,0 +1,122 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2011.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+  Copyright 2011  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, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/*\r
+   This is a header file which can be used to configure LUFA's\r
+   compile time options, as an alternative to the compile time\r
+   constants supplied through a makefile. To use this configuration\r
+   header, copy this into your project's root directory and supply\r
+   the USE_LUFA_CONFIG_HEADER token to the compiler so that it is\r
+   defined in all compiled source files.\r
+   \r
+   For information on what each token does, refer to the LUFA\r
+   manual section "Summary of Compile Tokens".\r
+*/\r
+\r
+#ifndef __LUFA_CONFIG_H__\r
+#define __LUFA_CONFIG_H__\r
+\r
+       #if (ARCH == ARCH_AVR8)\r
+\r
+               /* Non-USB Related Configuration Tokens: */\r
+//             #define DISABLE_TERMINAL_CODES\r
+\r
+               /* USB Class Driver Related Tokens: */\r
+//             #define HID_HOST_BOOT_PROTOCOL_ONLY\r
+//             #define HID_STATETABLE_STACK_DEPTH       {Insert Value Here}\r
+//             #define HID_USAGE_STACK_DEPTH            {Insert Value Here}\r
+//             #define HID_MAX_COLLECTIONS              {Insert Value Here}\r
+//             #define HID_MAX_REPORTITEMS              {Insert Value Here}\r
+//             #define HID_MAX_REPORT_IDS               {Insert Value Here}\r
+//             #define NO_CLASS_DRIVER_AUTOFLUSH\r
+\r
+               /* General USB Driver Related Tokens: */\r
+//             #define ORDERED_EP_CONFIG\r
+//             #define USE_STATIC_OPTIONS               {Insert Value Here}\r
+//             #define USB_DEVICE_ONLY\r
+//             #define USB_HOST_ONLY\r
+//             #define USB_STREAM_TIMEOUT_MS            {Insert Value Here}\r
+//             #define NO_LIMITED_CONTROLLER_CONNECT\r
+//             #define NO_SOF_EVENTS\r
+\r
+               /* USB Device Mode Driver Related Tokens: */\r
+//             #define USE_RAM_DESCRIPTORS\r
+//             #define USE_FLASH_DESCRIPTORS\r
+//             #define USE_EEPROM_DESCRIPTORS\r
+//             #define NO_INTERNAL_SERIAL\r
+//             #define FIXED_CONTROL_ENDPOINT_SIZE      {Insert Value Here}\r
+//             #define DEVICE_STATE_AS_GPIOR            {Insert Value Here}\r
+//             #define FIXED_NUM_CONFIGURATION          {Insert Value Here}\r
+//             #define CONTROL_ONLY_DEVICE\r
+//             #define INTERRUPT_CONTROL_ENDPOINT\r
+//             #define NO_DEVICE_REMOTE_WAKEUP\r
+//             #define NO_DEVICE_SELF_POWER\r
+\r
+               /* USB Host Mode Driver Related Tokens: */\r
+//             #define HOST_STATE_AS_GPIOR              {Insert Value Here}\r
+//             #define USB_HOST_TIMEOUT_MS              {Insert Value Here}\r
+//             #define HOST_DEVICE_SETTLE_DELAY_MS          {Insert Value Here}\r
+\r
+       #elif (ARCH == ARCH_UC3)\r
+\r
+               /* Non-USB Related Configuration Tokens: */\r
+//             #define DISABLE_TERMINAL_CODES\r
+\r
+               /* USB Class Driver Related Tokens: */\r
+//             #define HID_HOST_BOOT_PROTOCOL_ONLY\r
+//             #define HID_STATETABLE_STACK_DEPTH       {Insert Value Here}\r
+//             #define HID_USAGE_STACK_DEPTH            {Insert Value Here}\r
+//             #define HID_MAX_COLLECTIONS              {Insert Value Here}\r
+//             #define HID_MAX_REPORTITEMS              {Insert Value Here}\r
+//             #define HID_MAX_REPORT_IDS               {Insert Value Here}\r
+//             #define NO_CLASS_DRIVER_AUTOFLUSH\r
+\r
+               /* General USB Driver Related Tokens: */\r
+//             #define USE_STATIC_OPTIONS               {Insert Value Here}\r
+//             #define USB_DEVICE_ONLY\r
+//             #define USB_HOST_ONLY\r
+//             #define USB_STREAM_TIMEOUT_MS            {Insert Value Here}\r
+//             #define NO_SOF_EVENTS\r
+\r
+               /* USB Device Mode Driver Related Tokens: */\r
+//             #define NO_INTERNAL_SERIAL\r
+//             #define FIXED_CONTROL_ENDPOINT_SIZE      {Insert Value Here}\r
+//             #define FIXED_NUM_CONFIGURATION          {Insert Value Here}\r
+//             #define CONTROL_ONLY_DEVICE\r
+//             #define NO_DEVICE_REMOTE_WAKEUP\r
+//             #define NO_DEVICE_SELF_POWER\r
+\r
+               /* USB Host Mode Driver Related Tokens: */\r
+//             #define USB_HOST_TIMEOUT_MS              {Insert Value Here}\r
+//             #define HOST_DEVICE_SETTLE_DELAY_MS          {Insert Value Here}\r
+\r
+       #endif  \r
+#endif\r
+\r
index 415fde5..660cdcf 100644 (file)
@@ -10,9 +10,9 @@
  *  compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,
  *  or remove features unused by a given application in order to save flash space.
  *
- *  If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located
- *  in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile
- *  defined tokens for configuring the library.
+ *  \note If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located
+ *        in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile
+ *        defined tokens for configuring the library.
  *
  *  \section Sec_SummaryNonUSBTokens Non USB Related Tokens
  *  This section describes compile tokens which affect non-USB sections of the LUFA library.