diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-07-07 11:55:23 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-07-07 11:55:23 -0400 |
| commit | 8655d4f4948b2deef7844503c8d690f23ac1a062 (patch) | |
| tree | b2c6effc9d6cd5b5b43933a1e53b8bf17e9e82cf /lib/lufa/LUFA/DoxygenPages | |
| parent | 1896c76a2928c96f9ab7947bec2ef8dd37623cff (diff) | |
| parent | 60b30c036397cb5627fa374bb930794b225daa29 (diff) | |
| download | qmk_firmware-8655d4f4948b2deef7844503c8d690f23ac1a062.tar.gz qmk_firmware-8655d4f4948b2deef7844503c8d690f23ac1a062.zip | |
Merge commit '60b30c036397cb5627fa374bb930794b225daa29' as 'lib/lufa'
Diffstat (limited to 'lib/lufa/LUFA/DoxygenPages')
29 files changed, 4945 insertions, 0 deletions
diff --git a/lib/lufa/LUFA/DoxygenPages/BuildSystem.txt b/lib/lufa/LUFA/DoxygenPages/BuildSystem.txt new file mode 100644 index 000000000..ef57fcf0c --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/BuildSystem.txt | |||
| @@ -0,0 +1,281 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_BuildSystem The LUFA Build System | ||
| 8 | * | ||
| 9 | * \section Sec_BuildSystem_Overview Overview of the LUFA Build System | ||
| 10 | * The LUFA build system was originally an attempt at making a set of | ||
| 11 | * re-usable, modular build make files which could be referenced in a LUFA | ||
| 12 | * powered project, to minimize the amount of code required in an | ||
| 13 | * application makefile. | ||
| 14 | * | ||
| 15 | * As it turned out to be fairly generic in nature, it was split out into its | ||
| 16 | * own separate project, called DMBS (<i>Dean's Makefile Build System</i>) | ||
| 17 | * which is released into the public domain. LUFA-specific portions of the | ||
| 18 | * LUFA build system extend DMBS, and provide a universal build system for all | ||
| 19 | * LUFA projects. | ||
| 20 | * | ||
| 21 | * The latest DMBS project information and documentation can be found at: | ||
| 22 | * https://github.com/abcminiuser/dmbs | ||
| 23 | * | ||
| 24 | * DMBS is written in GNU Make, and each module is independent of one-another. | ||
| 25 | * | ||
| 26 | * LUFA now uses DMBS for its build system, with some LUFA specific extension | ||
| 27 | * modules. | ||
| 28 | * | ||
| 29 | * If you have problems building using LUFA, see \subpage Page_BuildTroubleshooting for resolution steps. | ||
| 30 | * | ||
| 31 | * \li \subpage Page_BuildModule_LUFA_SOURCES - The LUFA SOURCES extension module for DMBS | ||
| 32 | * \li \subpage Page_BuildModule_LUFA_GCC - The LUFA GCC extension module for DMBS | ||
| 33 | */ | ||
| 34 | |||
| 35 | /** \page Page_BuildModule_LUFA_SOURCES LUFA SOURCES extension module for DMBS | ||
| 36 | * | ||
| 37 | * The LUFA SOURCES extension more for DMBS provides LUFA specific variables | ||
| 38 | * listing the various LUFA source files required to be build by a project for | ||
| 39 | * a given LUFA module. This module gives a way to reference LUFA source files | ||
| 40 | * symbolically, so that changes to the library structure do not break the | ||
| 41 | * library makefile. | ||
| 42 | * | ||
| 43 | * To use this module in your application makefile, add the following code: | ||
| 44 | * \code | ||
| 45 | * include $(LUFA_PATH)/Build/LUFA/lufa-sources.mk | ||
| 46 | * \endcode | ||
| 47 | * | ||
| 48 | * \section SSec_BuildModule_LUFA_SOURCES_Requirements Requirements | ||
| 49 | * None. | ||
| 50 | * | ||
| 51 | * \section SSec_BuildModule_LUFA_SOURCES_Targets Targets | ||
| 52 | * | ||
| 53 | * <table> | ||
| 54 | * <tr> | ||
| 55 | * <td><i>None</i></td> | ||
| 56 | * </tr> | ||
| 57 | * </table> | ||
| 58 | * | ||
| 59 | * \section SSec_BuildModule_LUFA_SOURCES_MandatoryParams Mandatory Parameters | ||
| 60 | * | ||
| 61 | * <table> | ||
| 62 | * <tr> | ||
| 63 | * <td><tt>LUFA_PATH</tt></td> | ||
| 64 | * <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td> | ||
| 65 | * </tr> | ||
| 66 | * <tr> | ||
| 67 | * <td><tt>ARCH</tt></td> | ||
| 68 | * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td> | ||
| 69 | * </tr> | ||
| 70 | * </table> | ||
| 71 | * | ||
| 72 | * \section SSec_BuildModule_LUFA_SOURCES_OptionalParams Optional Parameters | ||
| 73 | * | ||
| 74 | * <table> | ||
| 75 | * <tr> | ||
| 76 | * <td><i>None</i></td> | ||
| 77 | * </tr> | ||
| 78 | * </table> | ||
| 79 | * | ||
| 80 | * \section SSec_BuildModule_LUFA_SOURCES_ProvidedVariables Module Provided Variables | ||
| 81 | * | ||
| 82 | * <table> | ||
| 83 | * <tr> | ||
| 84 | * <td><tt>LUFA_SRC_USB</tt></td> | ||
| 85 | * <td>List of LUFA USB driver source files.</td> | ||
| 86 | * </tr> | ||
| 87 | * <tr> | ||
| 88 | * <td><tt>LUFA_SRC_USBCLASS</tt></td> | ||
| 89 | * <td>List of LUFA USB Class driver source files.</td> | ||
| 90 | * </tr> | ||
| 91 | * <tr> | ||
| 92 | * <td><tt>LUFA_SRC_TEMPERATURE</tt></td> | ||
| 93 | * <td>List of LUFA temperature sensor driver source files.</td> | ||
| 94 | * </tr> | ||
| 95 | * <tr> | ||
| 96 | * <td><tt>LUFA_SRC_SERIAL</tt></td> | ||
| 97 | * <td>List of LUFA Serial U(S)ART driver source files.</td> | ||
| 98 | * </tr> | ||
| 99 | * <tr> | ||
| 100 | * <td><tt>LUFA_SRC_TWI</tt></td> | ||
| 101 | * <td>List of LUFA TWI driver source files.</td> | ||
| 102 | * </tr> | ||
| 103 | * <tr> | ||
| 104 | * <td><tt>LUFA_SRC_PLATFORM</tt></td> | ||
| 105 | * <td>List of LUFA architecture specific platform management source files.</td> | ||
| 106 | * </tr> | ||
| 107 | * </table> | ||
| 108 | * | ||
| 109 | * \section SSec_BuildModule_LUFA_SOURCES_ProvidedMacros Module Provided Macros | ||
| 110 | * | ||
| 111 | * <table> | ||
| 112 | * <tr> | ||
| 113 | * <td><i>None</i></td> | ||
| 114 | * </tr> | ||
| 115 | * </table> | ||
| 116 | */ | ||
| 117 | |||
| 118 | /** \page Page_BuildModule_LUFA_GCC LUFA GCC extension module for DMBS | ||
| 119 | * | ||
| 120 | * The LUFA GCC extension module for the standard DMBS GCC module extends the | ||
| 121 | * latter to support the compilation of LUFA powered projects. It should be | ||
| 122 | * imported into your LUFA powered project makefiles to ensure that the correct | ||
| 123 | * build settings are used for the project's configuration. | ||
| 124 | * | ||
| 125 | * To use this module in your application makefile, add the following code: | ||
| 126 | * \code | ||
| 127 | * include $(LUFA_PATH)/Build/LUFA/lufa-gcc.mk | ||
| 128 | * \endcode | ||
| 129 | * | ||
| 130 | * \section SSec_BuildModule_LUFA_GCC_Requirements Requirements | ||
| 131 | * This module should be included in your makefile *after* the DMBS GCC module. | ||
| 132 | * | ||
| 133 | * \section SSec_BuildModule_LUFA_GCC_Targets Targets | ||
| 134 | * | ||
| 135 | * <table> | ||
| 136 | * <tr> | ||
| 137 | * <td><i>None</i></td> | ||
| 138 | * </tr> | ||
| 139 | * </table> | ||
| 140 | * | ||
| 141 | * \section SSec_BuildModule_LUFA_GCC_MandatoryParams Mandatory Parameters | ||
| 142 | * | ||
| 143 | * <table> | ||
| 144 | * <tr> | ||
| 145 | * <td><tt>LUFA_PATH</tt></td> | ||
| 146 | * <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td> | ||
| 147 | * </tr> | ||
| 148 | * </table> | ||
| 149 | * | ||
| 150 | * \section SSec_BuildModule_LUFA_GCC_OptionalParams Optional Parameters | ||
| 151 | * | ||
| 152 | * <table> | ||
| 153 | * <tr> | ||
| 154 | * <td><tt>BOARD</tt></td> | ||
| 155 | * <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td> | ||
| 156 | * </tr> | ||
| 157 | * </table> | ||
| 158 | * | ||
| 159 | * \section SSec_BuildModule_LUFA_GCC_ProvidedVariables Module Provided Variables | ||
| 160 | * | ||
| 161 | * <table> | ||
| 162 | * <tr> | ||
| 163 | * <td><i>None</i></td> | ||
| 164 | * </tr> | ||
| 165 | * </table> | ||
| 166 | * | ||
| 167 | * \section SSec_BuildModule_LUFA_GCC_ProvidedMacros Module Provided Macros | ||
| 168 | * | ||
| 169 | * <table> | ||
| 170 | * <tr> | ||
| 171 | * <td><i>None</i></td> | ||
| 172 | * </tr> | ||
| 173 | * </table> | ||
| 174 | */ | ||
| 175 | |||
| 176 | /** \page Page_BuildTroubleshooting Troubleshooting Information | ||
| 177 | * | ||
| 178 | * LUFA uses a lot of advanced features of the AVR-GCC compiler, linker, and | ||
| 179 | * surrounding binaries. This can sometimes lead to problems compiling | ||
| 180 | * applications if one of these features is buggy in the version of the tools | ||
| 181 | * used in a build environment. Missing utilities and incorrectly set makefile | ||
| 182 | * configuration options can also result in different errors being produced | ||
| 183 | * when compilation or other operations are attempted. The table below lists a | ||
| 184 | * set of commonly encountered errors and their resolutions. | ||
| 185 | * | ||
| 186 | * <table> | ||
| 187 | * <tr> | ||
| 188 | * <th>Problem</th> | ||
| 189 | * <th>Resolution</th> | ||
| 190 | * </tr> | ||
| 191 | * <tr> | ||
| 192 | * <td>Error "<b><tt>relocation truncated to fit: R_AVR_13_PCREL against symbol <i>{X}</i></tt></b>" shown when compiling.</td> | ||
| 193 | * <td>Try compiling with the setting <tt>LINKER_RELAXATIONS=N</tt> in your LUFA Build System 2.0 makefile, or remove the line <tt>-Wl,--relax</tt> | ||
| 194 | * from other makefiles. Alternatively, make sure you have the latest version of the Atmel Toolchain installed for your system.</td> | ||
| 195 | * </tr> | ||
| 196 | * <tr> | ||
| 197 | * <td>Error "<b><tt>error: ld terminated with signal 11 [Segmentation fault]</tt></b>" shown when compiling.</td> | ||
| 198 | * <td>Try compiling with the setting <tt>DEBUG_LEVEL=2</tt> in your LUFA Build System 2.0 makefile, or make sure you are using <tt>binutils</tt> version 2.22 or later.</td> | ||
| 199 | * </tr> | ||
| 200 | * <tr> | ||
| 201 | * <td>Error "<b><tt>EMERGENCY ABORT: INFINITE RECURSION DETECTED</tt></b>" shown when compiling.</td> | ||
| 202 | * <td>Make sure you are using an up to date version of GNU Make when compiling. This error is a safety system added to the mid-level makefiles, to prevent an issue with | ||
| 203 | * GNU make or other variants of Make causing an infinitely recursive build.</td> | ||
| 204 | * </tr> | ||
| 205 | * <tr> | ||
| 206 | * <td>Error "<b><tt>Unsupported architecture "<i>{X}</i>"</tt></b>" shown when compiling.</td> | ||
| 207 | * <td>Ensure your makefile's <tt>ARCH</tt> setting is set to one of the architecture names (case-sensitive) supported by the version of LUFA you are compiling against.</td> | ||
| 208 | * </tr> | ||
| 209 | * <tr> | ||
| 210 | * <td>Error "<b><tt>Makefile <i>{X}</i> value not set</tt></b>" shown when compiling.</td> | ||
| 211 | * <td>The specified Makefile value was not configured in your project's makefile or on the command line, and the nominated setting is required by one or more LUFA | ||
| 212 | * build system modules. Define the value in your project makefile and try again.</td> | ||
| 213 | * </tr> | ||
| 214 | * <tr> | ||
| 215 | * <td>Error "<b><tt>Makefile <i>{X}</i> option cannot be blank</tt></b>" shown when compiling.</td> | ||
| 216 | * <td>The specified Makefile value was configured in your project's makefile or on the command line, but was set to an empty value. For the nominated configuration | ||
| 217 | * option, an empty value is not allowed. Define the nominated setting to a correct non-blank value and try again.</td> | ||
| 218 | * </tr> | ||
| 219 | * <tr> | ||
| 220 | * <td>Error "<b><tt>Makefile <i>{X}</i> option must be Y or N</tt></b>" shown when compiling.</td> | ||
| 221 | * <td>The specified Makefile value was configured in your project's makefile or on the command line, but was set to a value other than a Y (for "Yes") or "N" (for "No"). | ||
| 222 | * This configuration option is required to be one of the aforementioned boolean values, and other values are invalid. Set this option to either Y or N and try again.</td> | ||
| 223 | * </tr> | ||
| 224 | * <tr> | ||
| 225 | * <td>Error "<b><tt>Unknown input source file formats: <i>{X}</i></tt></b>" shown when compiling.</td> | ||
| 226 | * <td>The nominated source files, specified in your project's makefile in the <tt>SRC</tt> configuration option, has an extension that the LUFA build system does not | ||
| 227 | * recognise. The file extensions are case sensitive, and must be one of the supported formats (<tt>*.c</tt>, <tt>*.cpp</tt> or <tt>*.S</tt>).</td> | ||
| 228 | * </tr> | ||
| 229 | * <tr> | ||
| 230 | * <td>Error "<b><tt>Cannot build with OBJDIR parameter set - one or more object file name is not unique</tt></b>" shown when compiling.</td> | ||
| 231 | * <td>When a project is built with a non-empty <tt>OBJDIR</tt> object directory name set, all input source files must have unique names, excluding extension and path. | ||
| 232 | * This means that input files that are named identically and differ only by their path or extension are invalid when this mode is used.</td> | ||
| 233 | * </tr> | ||
| 234 | * <tr> | ||
| 235 | * <td>Error "<b><tt>Source file does not exist: <i>{X}</i></tt></b>" shown when compiling.</td> | ||
| 236 | * <td>The nominated input source file, specified in the user project's <tt>SRC</tt> parameter, could not be found. Ensure the source file exists and the absolute or | ||
| 237 | * relative path given in the user project makefile is correct and try again.</td> | ||
| 238 | * </tr> | ||
| 239 | * <tr> | ||
| 240 | * <td>Error "<b><tt>Doxygen configuration file <i>{X}</i> does not exist</tt></b>" shown when upgrading a Doxygen configuration file.</td> | ||
| 241 | * <td>The nominated Doxygen configuration file, specified in the user project's <tt>DOXYGEN_CONF</tt> parameter, could not be found. Ensure the configuration file exists | ||
| 242 | * and the absolute or relative path given in the user project makefile is correct and try again, or run the appropriate makefile target to generate a new configuration | ||
| 243 | * file.</td> | ||
| 244 | * </tr> | ||
| 245 | * <tr> | ||
| 246 | * <td>Error "<b><tt>avr-gcc: error: unrecognized option '<i>{X}</i>'</tt></b>" shown when compiling.</td> | ||
| 247 | * <td>An unrecognised option was supplied to the compiler, usually in the <tt>C_FLAGS</tt>, <tt>CPP_FLAGS</tt>, <tt>ASM_FLAGS</tt> or <tt>CC_FLAGS</tt> configuration | ||
| 248 | * options. The nominated compiler switch may be invalid, or unsupported by the version of AVR-GCC on the host system. Remove the unrecognised flag if invalid, or | ||
| 249 | * upgrade to the latest AVR-GCC. If the option is a valid linker option, use the prefix "-Wl," to ensure it is passed to the linker correctly.</td> | ||
| 250 | * </tr> | ||
| 251 | * <tr> | ||
| 252 | * <td>Error "<b><tt>makefile:{X}: {Y}.mk: No such file or directory</tt></b>" shown when make is invoked.</td> | ||
| 253 | * <td>The path to the nominated makefile module was incorrect. This usually indicates that the makefile <tt>LUFA_PATH</tt> option is not set to a valid relative or | ||
| 254 | * absolute path to the LUFA library core.</td> | ||
| 255 | * </tr> | ||
| 256 | * <tr> | ||
| 257 | * <td>Error "<b><tt>fatal error: LUFAConfig.h: No such file or directory</tt></b>" shown when compiling.</td> | ||
| 258 | * <td>The <tt>USE_LUFA_CONFIG_HEADER</tt> compile time option was set in the user project makefile, but the user supplied <tt>LUFAConfig.h</tt> header could not be | ||
| 259 | * found. Ensure that the directory that contains this configuration file is correctly passed to the compiler via the -I switch in the makefile <tt>CC_FLAGS</tt> | ||
| 260 | * parameter.</td> | ||
| 261 | * </tr> | ||
| 262 | * <tr> | ||
| 263 | * <td>Error "<b><tt>ld.exe: section .apitable_trampolines loaded at <i>{X}</i> overlaps section .text</tt></b>" shown when compiling a bootloader.</td> | ||
| 264 | * <td>The bootloader is compiling too large for the given <tt>FLASH_SIZE_KB</tt> and <tt>BOOT_SECTION_SIZE_KB</tt> parameters set in the bootloader makefile. This | ||
| 265 | * usually indicates that these values are incorrect for the specified device the bootloader is targeting. If these values are correct, a newer version of the | ||
| 266 | * compiler may need to be used to ensure that the bootloader is built within the section size constraints of the target device.</td> | ||
| 267 | * </tr> | ||
| 268 | * <tr> | ||
| 269 | * <td>Error "<b><tt>unknown MCU '<i>{X}</i>' specified</tt></b>" shown when compiling.</td> | ||
| 270 | * <td>The specified microcontroller device model name set in the user application's makefile as the <tt>MCU</tt> parameter is incorrect, or unsupported by the | ||
| 271 | * version of the compiler being used. Make sure the model name is correct, or upgrade to the latest Atmel Toolchain to obtain newer device support.</td> | ||
| 272 | * </tr> | ||
| 273 | * <tr> | ||
| 274 | * <td>Error "<b><tt>undefined reference to `<i>{X}</i>'</tt></b>" shown when compiling.</td> | ||
| 275 | * <td>This is usually caused by a missing source file in the user application's <tt>SRC</tt> configuration parameter. If the indicated symbol is one from the LUFA | ||
| 276 | * library, you may be missing a LUFA source makefile module (see \ref Page_BuildModule_LUFA_SOURCES).</td> | ||
| 277 | * </tr> | ||
| 278 | * </table> | ||
| 279 | * | ||
| 280 | * For troubleshooting other errors you encounter, please see \ref Sec_ProjectHelp. | ||
| 281 | */ | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt b/lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt new file mode 100644 index 000000000..cbbae4b8e --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_BuildLibrary Building as a Linkable Library | ||
| 8 | * | ||
| 9 | * The LUFA library can be built as a proper linkable library (with the extension .a) under AVR-GCC, so that | ||
| 10 | * the library does not need to be recompiled with each revision of a user project. Instructions for creating | ||
| 11 | * a library from a given source tree can be found in the AVR-GCC user manual included in the WinAVR install | ||
| 12 | * /Docs/ directory. | ||
| 13 | * | ||
| 14 | * However, building the library is <b>not recommended</b>, as the static (compile-time) options will be | ||
| 15 | * unable to be changed without a recompilation of the LUFA code. Therefore, if the library is to be built | ||
| 16 | * from the LUFA source, it should be made to be application-specific and compiled with the static options | ||
| 17 | * that are required for each project (which should be recorded along with the library). | ||
| 18 | * | ||
| 19 | * Normal library use has the library components compiled in at the same point as the application code, as | ||
| 20 | * demonstrated in the library demos and applications. This is the preferred method, as the library is recompiled | ||
| 21 | * each time to ensure that all static options for a particular application are applied. | ||
| 22 | */ | ||
| 23 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/ChangeLog.txt b/lib/lufa/LUFA/DoxygenPages/ChangeLog.txt new file mode 100644 index 000000000..aedfd3ce5 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/ChangeLog.txt | |||
| @@ -0,0 +1,1653 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_ChangeLog Project Changelog | ||
| 8 | * | ||
| 9 | * \section Sec_ChangeLog170418 Version 170418 | ||
| 10 | * <b>New:</b> | ||
| 11 | * - Core: | ||
| 12 | * - Added support for the Pololu A-Star Micro board (thanks to Joh Schneider) | ||
| 13 | * - Added new \c LUFA_VERSION_RELEASE_TYPE macro to the library version header, to determine release type (thanks to NicoHood) | ||
| 14 | * | ||
| 15 | * <b>Fixed:</b> | ||
| 16 | * - Core: | ||
| 17 | * - The CALLBACK_USB_GetDescriptor() callback function into the user application erroneously had a uint8_t type for the wIndex | ||
| 18 | * parameter, instead of uint16_t (thanks to Matlo) | ||
| 19 | * - Fixed broken USE_RAM_DESCRIPTORS compile time option when the FIXED_NUM_CONFIGURATIONS compile time option is not enabled | ||
| 20 | * in a user application (thanks to Matlo) | ||
| 21 | * - Fixed missing \c va_end() calls in the HID bootloader CLI app which could cause portability issues | ||
| 22 | * - Fixed void pointer arithmetic in the \c Serial_SendData() functions for AVR8 and XMEGA architectures | ||
| 23 | * - Fixed void pointer arithmetic in the low level and class driver RNDIS demo protocol decoders | ||
| 24 | * - Fixed low level RNDIS demo incorrectly setting the RNDIS state when a null packet filter was requested | ||
| 25 | * - Fixed missing entries in several project's Atmel Studio integration files, such as driver INF files | ||
| 26 | * - Fixed invalid endpoint indexes causing memory corruption in device Clear/Set Feature standard requests (thanks to Peter Popovec) | ||
| 27 | * - Fixed incorrect serialization in USB_SetHIDReportItemInfo() function (thanks to e-chip) | ||
| 28 | * | ||
| 29 | * <b>Changed:</b> | ||
| 30 | * - Added signed alternative libUSB driver for the AVRISP-MKII clone project, to support Atmel Studio 7 (thanks to Atmel) | ||
| 31 | * - Removed no longer required LIBUSB_DRIVER_COMPAT and RESET_TOGGLES_LIBUSB_COMPAT configuration options from the AVRISP-MKII | ||
| 32 | * clone project, as the new libUSB driver works for AVRDUDE and Atmel Studio 7 under Windows | ||
| 33 | * - Replaced the LUFA build system with its (compatible) successor, DMBS (Dean's Makefile Build System) | ||
| 34 | * - Removed obsolete library TAR export and associated documentation | ||
| 35 | * - Fixed incorrect HID_DESCRIPTOR_KEYBOARD() macro definition (thanks to Eric Tang) | ||
| 36 | * | ||
| 37 | * \section Sec_ChangeLog151115 Version 151115 | ||
| 38 | * <b>New:</b> | ||
| 39 | * - Added support for the Atmel Xplained-MINI series of development kits | ||
| 40 | * - Added new PROGMEM variant send functions to the CDC class device driver (thanks to Stefan Hellermann) | ||
| 41 | * - Added new PROGMEM variant send functions to the CDC class host driver | ||
| 42 | * - Added additional Arduino Uno board definitions for the main processor reset (thanks to NicoHood) | ||
| 43 | * - Added modified DocBook transforms to generate Atmel Studio 6/7 internal help documentation (thanks to Morten Engelhardt Olsen) | ||
| 44 | * | ||
| 45 | * <b>Changed:</b> | ||
| 46 | * - Core: | ||
| 47 | * - The TWI peripheral driver's TWI_WritePacket() and TWI_ReadPacket() functions now takes a 16-bit Length rather than an 8-bit | ||
| 48 | * length, for longer transfers | ||
| 49 | * - Library Applications: | ||
| 50 | * - The CDC, DFU, Mass Storage and Printer class bootloaders will no longer run the user application if the application reset | ||
| 51 | * vector is blank (thanks to Alex Kazik) | ||
| 52 | * - The CDC, DFU and Printer class bootloaders are now compatible with the original Atmel XPLAIN and Arduino Leonardo boards | ||
| 53 | * - The CDC, DFU, Mass Storage and Printer class bootloaders are not compatible with devices with the BOOTRST fuse set and will | ||
| 54 | * exit automatically unless an external reset was the last reset cause (thanks to Alex Kazik) | ||
| 55 | * - Added missing force-inline attribute to the endianness utility functions (thanks to Stefan Hellermann) | ||
| 56 | * - Updated the DFU build system module to use updated EEPROM programming command arguments for dfu-programmer 0.6.2 or newer | ||
| 57 | * | ||
| 58 | * <b>Fixed:</b> | ||
| 59 | * - Fixed broken XMEGA serial stream driver due to missing USART base pointer parameter (thanks to William Patterson) | ||
| 60 | * - Fixed incorrect signature reported in the CDC/DFU bootloaders for the AT90USB82 (thanks to NicoHood) | ||
| 61 | * - Fixed broken RNDIS demos on Linux machines whose DHCP hosts require a Lease Time option (thanks to Stefan Hellermann) | ||
| 62 | * - Fixed broken LEDs_Disable() implementation for the Arduino Uno board (thanks to NicoHood) | ||
| 63 | * - Fixed missing bounds checks and off-by-one in the DFU bootloader signature bytes (thanks to Reuti) | ||
| 64 | * | ||
| 65 | * \section Sec_ChangeLog140928 Version 140928 | ||
| 66 | * <b>New:</b> | ||
| 67 | * - Core: | ||
| 68 | * - Updated the BUILD build system module to add a new COMPILER_PATH optional variable | ||
| 69 | * - Added Serial_IsSendReady() and Serial_IsSendComplete() functions to the Serial hardware peripheral driver | ||
| 70 | * - Added support for the Arduino Yun board (ATMEGA32U4 co-processor) | ||
| 71 | * - Added support for the Arduino Micro board (thanks to Zoltán Szőke) | ||
| 72 | * - Library Applications: | ||
| 73 | * - Added new Dual MIDI class driver device demo | ||
| 74 | * | ||
| 75 | * <b>Changed:</b> | ||
| 76 | * - Core: | ||
| 77 | * - The RNDIS device class driver now takes a user-supplied buffer and buffer length for the internal RNDIS | ||
| 78 | * message management (thanks to Peter Mc Shane) | ||
| 79 | * | ||
| 80 | * <b>Fixed:</b> | ||
| 81 | * - Core: | ||
| 82 | * - Fixed device class driver pipe configuration routines returning success with a partially constructed instance | ||
| 83 | * when a pipe configuration failed (thanks to Helge Suess) | ||
| 84 | * - Fixed incorrect XMEGA DFLL reference frequency (thanks to Martin Aakerberg) | ||
| 85 | * - Fixed possible infinite loop in the control endpoint stream write function (thanks to Clayton Knight) | ||
| 86 | * - Fixed missing HID report ID prefix on HID class driver GetReport request responses (thanks to Bert van Hall) | ||
| 87 | * - Fixed incorrect XMEGA USB controller clock division factory for non-Full Speed operation (thanks to Bert van Hall) | ||
| 88 | * - Fixed the LUFA build system to prevent incorrect code from being generated in newer toolchains when building for larger | ||
| 89 | * FLASH memory devices (thanks to demultiplexer) | ||
| 90 | * - Fixed missing parenthesis in the MIDI_EVENT() macro which could cause incorrect results (thanks to hexwab) | ||
| 91 | * - Fixed mixed capitalization of TWI in the XMEGA TWI driver causing compilation failures (thanks to Jacob Schloss) | ||
| 92 | * - Fixed broken AVR8 USART-SPI peripheral driver (thanks to Phil Zakielarz) | ||
| 93 | * - Library Applications: | ||
| 94 | * - Fixed spurious 0xFE USART byte sent in the USBtoSerial project when the baud rate is changed (thanks to Carl Kjeldsen) | ||
| 95 | * - Fixed blocking USART reads causing low throughput on slow baud rates in the USBtoSerial project (thanks to Nevada Smith) | ||
| 96 | * - Fixed USART reception overrun corrupting the internal buffers in the USBtoSerial project (thanks to Nevada Smith) | ||
| 97 | * - Fixed broken LowLevel Audio Out demo sampling frequency configuration (thanks to Torsten Duwe) | ||
| 98 | * | ||
| 99 | * \section Sec_ChangeLog140302 Version 140302 | ||
| 100 | * <b>New:</b> | ||
| 101 | * - Library Applications: | ||
| 102 | * - Added new Bulk Vendor low level device demo | ||
| 103 | * - Added new libUSB host Python and NodeJS application examples for the Class driver GenericHID demo (thanks to Laszlo Monda) | ||
| 104 | * - Added new AVR8 USB option to keep 3.3V regulator enabled (thanks to Michael Hanselmann) | ||
| 105 | * - Added new USB_STRING_DESCRIPTOR() and USB_STRING_DESCRIPTOR_ARRAY() convenience macros (thanks to Laszlo Monda) | ||
| 106 | * | ||
| 107 | * <b>Changed:</b> | ||
| 108 | * - Library Applications: | ||
| 109 | * - Refactored out USB interface IDs in the demo applications into enums (thanks to Laszlo Monda) | ||
| 110 | * - AVRISP-MKII Clone Project PDI/TPI frequency increased from 250KHz to 2MHz as it is now stable | ||
| 111 | * - Increased TPI/PDI handshake delay to 100us from 1us to support targets with high amounts of capacitance on their | ||
| 112 | * /RESET lines (thanks to Paul Duke) | ||
| 113 | * - Changed the VERSION_BCD() macro to accept the major/minor/revision values as separate parameters | ||
| 114 | * | ||
| 115 | * <b>Fixed:</b> | ||
| 116 | * - Core: | ||
| 117 | * - Fixed MIDI device class driver MIDI_Device_ReceiveEventPacket() for the XMEGA architecture | ||
| 118 | * - Library Applications: | ||
| 119 | * - Fixed incorrect signature bytes returned in the DFU bootloader | ||
| 120 | * | ||
| 121 | * \section Sec_ChangeLog130901 Version 130901 | ||
| 122 | * <b>New:</b> | ||
| 123 | * - Core: | ||
| 124 | * - Added additional MIDI command definitions to the MIDI class driver (thanks to Daniel Dreibrodt) | ||
| 125 | * - Added new CONCAT() and CONCAT_EXPANDED() convenience macros | ||
| 126 | * - Added new Printer Device Class driver | ||
| 127 | * - Added support for the XMEGA C3 Xplained board | ||
| 128 | * - Added support for the U2S board (thanks to megal0maniac) | ||
| 129 | * - Added TWI Master driver for the XMEGA architecture (thanks to Michael Janssen) | ||
| 130 | * - Library Applications: | ||
| 131 | * - Added new Printer class bootloader | ||
| 132 | * - Added new Mass Storage class bootloader | ||
| 133 | * - Added XMEGA support for class driver device demos (where applicable) | ||
| 134 | * - Added Python host application example for the Generic HID class driver device demo | ||
| 135 | * - Added Python alternative host application for the HID class bootloader | ||
| 136 | * | ||
| 137 | * <b>Changed:</b> | ||
| 138 | * - Core: | ||
| 139 | * - Updated the BUILD build system module to produce binary BIN files in addition to Intel HEX files | ||
| 140 | * - Updated the Android Accessory Class to accept version 2 protocol devices (with version 1 functionality) | ||
| 141 | * - All board drivers now implement dummy functions and constants when BOARD is set to NONE | ||
| 142 | * - Added missing LEDs to the XMEGA A3BU Xplained board LED driver (thanks to Michael Janssen) | ||
| 143 | * - Changed board Dataflash drivers to automatically configure the appropriate SPI interface for the selected board | ||
| 144 | * - Library Applications: | ||
| 145 | * - Re-added Set Control Line State request handling to the CDC class bootloader to prevent issues with the .NET serial | ||
| 146 | * class (thanks to Erik Lins) | ||
| 147 | * - TemperatureDataLogger project dummy RTC mode now tracks real time (thanks to David Lazarus) | ||
| 148 | * | ||
| 149 | * <b>Fixed:</b> | ||
| 150 | * - Core: | ||
| 151 | * - Fixed Low Speed USB devices broken when using the library HID Class driver (thanks to Michael) | ||
| 152 | * - Fixed possible register corruption in USB Host mode on AVR8 devices when ORDERED_EP_CONFIG is used (thanks to Martin Aakerberg) | ||
| 153 | * - Fixed Pipe_GetBoundEndpointAddress() returning invalid endpoint directions on AVR8 architecture devices (thanks to decerri) | ||
| 154 | * under some circumstances | ||
| 155 | * - Fixed incorrect USB device state set when a suspended LUFA device is woken while addressed but not configured (thanks to Balaji Krishnan) | ||
| 156 | * - Fixed broken USART SPI driver for the AVR8 architecture due to incorrect initialization | ||
| 157 | * - Fixed re-enumeration issue of XMEGA architecture targets (thanks to Jaroslav Jedlinsky) | ||
| 158 | * - Fixed error receiving PIMA events via the Still Image Host class driver | ||
| 159 | * - Library Applications: | ||
| 160 | * - Added handler for SCSI_CMD_START_STOP_UNIT in demos using the Mass Storage class, to prevent ejection errors on *nix systems due to an | ||
| 161 | * unknown SCSI command | ||
| 162 | * - Fixed incorrect HID report descriptor generated for 16-bit axis ranges by the HID_DESCRIPTOR_MOUSE() and HID_DESCRIPTOR_JOYSTICK() | ||
| 163 | * macros (thanks to Armory) | ||
| 164 | * - Fixed incorrect HID report descriptor generated for button multiples of 8 by the HID_DESCRIPTOR_MOUSE() and HID_DESCRIPTOR_JOYSTICK() | ||
| 165 | * macros | ||
| 166 | * - Fixed race condition in the DFU class bootloader causing failed device reprogramming in some circumstances (thanks to Luis Mendes) | ||
| 167 | * - Fixed incorrect time/date configuration data order in the TempDataLogger host application (thanks to David Lazarus) | ||
| 168 | * | ||
| 169 | * \section Sec_ChangeLog130303 Version 130303 | ||
| 170 | * <b>New:</b> | ||
| 171 | * - Core: | ||
| 172 | * - Added support for the Arduino Leonardo board | ||
| 173 | * - Added support for the Atmel UC3-A3 Xplained board | ||
| 174 | * - Added support for the Xevelabs USB2AX revision 3.1 board | ||
| 175 | * - Added support for the Dimex Stange-ISP board (thanks to Gerhard Wesser) | ||
| 176 | * - Added new \c doxygen_upgrade and \c doxygen_create targets to the DOXYGEN build system module | ||
| 177 | * - Added new Board Hardware Information board driver | ||
| 178 | * - Library Applications: | ||
| 179 | * - Added a different device serial number when the AVRISP-MKII Clone project is in libUSB compatibility mode, so that | ||
| 180 | * both the libUSB and Jungo drivers can be installed at the same time without having to use a filter driver | ||
| 181 | * | ||
| 182 | * <b>Changed:</b> | ||
| 183 | * - Core: | ||
| 184 | * - Added workaround for broken VBUS detection on AVR8 devices when a bootloader starts the application | ||
| 185 | * via a software jump without first turning off the OTG pad (thanks to Simon Inns) | ||
| 186 | * - Library Applications: | ||
| 187 | * - Increased throughput in the USBtoSerial project now that data transmission is non-blocking (thanks to Joseph Lacerte) | ||
| 188 | * - Updated bootloader makefiles to remove dependency on the \c bc command line calculator tool | ||
| 189 | * - Updated AVRISP-MKII Clone Programmer project so that the SCK clock period is saved in EEPROM (thanks to Gerhard Wesser) | ||
| 190 | * - Changed all *_SendByte() function prototypes to accept a void pointer for the input buffer (thanks to Simon Kuppers) | ||
| 191 | * | ||
| 192 | * <b>Fixed:</b> | ||
| 193 | * - Core: | ||
| 194 | * - Fixed incorrectly issuing STALL response to unsupported control request SETUP packets, rather than in the data/status stage | ||
| 195 | * - Fixed inverted LEDs_GetLEDs() function implementation for the Benito, Minimus and Arduino UNO boards | ||
| 196 | * - Fixed missing Windows 32-bit compatibility sections in the LUFA INF driver files (thanks to Christan Beharrell) | ||
| 197 | * - Fixed logic hole breaking USB operations on a USB controller with only one supported USB mode and no USB_DEVICE_ONLY or USB_HOST_ONLY | ||
| 198 | * configuration token set | ||
| 199 | * - Fixed possible rounding in the VERSION_BCD() macros for some 0.01 step increments (thanks to Oliver Zander) | ||
| 200 | * - Fixed incorrect Dataflash functionality in the USBKEY board if the driver is modified for a single Dataflash chip (thanks to Jonathan Oakley) | ||
| 201 | * - Fixed incorrect definitions of \c HID_KEYBOARD_LED_KANA, \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN and \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400 | ||
| 202 | * and added a missing definition for \c HID_KEYBOARD_SC_APPLICATION (thanks to David Monro) | ||
| 203 | * - Fixed maximum allowed keyboard key code usage of \c 0x65 rather than \c 0xFF for the \c HID_DESCRIPTOR_KEYBOARD() macro (thanks to David Monro) | ||
| 204 | * - Fixed hardware race condition that could cause failed device enumerations for AVR8 and UC3 architectures (thanks to Mike Beyhs) | ||
| 205 | * - Fixed incorrect Minimus board LED definitions (thanks to Joonas Lahtinen) | ||
| 206 | * - Fixed incorrect ordering of the linker options in the build system causing link failures in some cases | ||
| 207 | * - Fixed bug in the TWI peripheral driver for the AVR8 devices causing incorrect failure codes to be returned in some cases (thanks to Peter K) | ||
| 208 | * - Fixed swapped LED3 and LED4 masks for the Olimex-32U4 development board LED driver | ||
| 209 | * - Fixed potential NULL pointer dereference in the HID Host mode Class Driver (thanks to Pavel Kuzmin) | ||
| 210 | * - Library Applications: | ||
| 211 | * - Fixed broken RESET_TOGGLES_LIBUSB_COMPAT compile time option in the AVRISP-MKII project | ||
| 212 | * - Fixed incompatibility in the CDC class bootloader on some systems (thanks to Sylvain Munaut) | ||
| 213 | * - Fixed lengthy timeouts in the USBtoSerial project if no application on the host is consuming data (thanks to Nicolas Saugnier) | ||
| 214 | * - Fixed lengthy automatic data flushing in the CDC and MIDI device class drivers | ||
| 215 | * - Fixed incorrect LED masks for received data display in the Device GenericHID demos (thanks to Denys Berkovskyy) | ||
| 216 | * - Fixed incorrect output in the HIDReportViewer project when no device is connected (thanks to Pavel Kuzmin) | ||
| 217 | * | ||
| 218 | * \section Sec_ChangeLog120730 Version 120730 | ||
| 219 | * <b>New:</b> | ||
| 220 | * - Core: | ||
| 221 | * - Added new, revamped modular build system with new makefile templates | ||
| 222 | * - Added support for the BitWizard Multio and Big-Multio boards | ||
| 223 | * - Added support for the DorkbotPDX Duce board | ||
| 224 | * - Added support for the Olimex AVR-USB-32U4 board | ||
| 225 | * - Added support for the Olimex AVR-USB-T32U4 board | ||
| 226 | * - Added support for the Olimex AVR-ISP-MK2 board | ||
| 227 | * - Added new Endpoint_ConfigureEndpointTable() function | ||
| 228 | * - Added new Pipe_ConfigurePipeTable() function | ||
| 229 | * - Added build test to verify correct compilation of all board drivers using all driver APIs | ||
| 230 | * - Added build test to verify correct compilation of all bootloaders using all supported devices | ||
| 231 | * - Added build test to verify that there are no detectable errors in the codebase via static analysis | ||
| 232 | * - Added new JTAG_ENABLE() macro for the AVR8 architecture | ||
| 233 | * - Library Applications: | ||
| 234 | * - Modified the CDC Host demos to set a default CDC Line Encoding on enumerated devices | ||
| 235 | * - Added Dataflash operational checks and aborts to all projects using the Dataflash to ensure it is working correctly before use | ||
| 236 | * - Added new SerialToLCD user project contributed by Simon Foster | ||
| 237 | * - Added new RESET_TOGGLES_LIBUSB_COMPAT compile time option to the AVRISP-MKII clone programmer project (thanks to Robert Spitzenpfeil) | ||
| 238 | * | ||
| 239 | * <b>Changed:</b> | ||
| 240 | * - Core: | ||
| 241 | * - Android Accessory Host property strings changed from a struct of pointer to an array to prevent unaligned access on greater than 8-bit architectures | ||
| 242 | * - Audio Device Class driver changed to also require the index of the Audio Control interface within the device, for SET/GET/CUR/MIN/MAX/RES property adjustments | ||
| 243 | * - Removed variable axis support from the HID_DESCRIPTOR_JOYSTICK() macro due to OS incompatibilities, replaced with fixed 3-axis joystick report structure | ||
| 244 | * - Removed the old pseudo-scheduler from the library as it was unused and deprecated since the 090810 release | ||
| 245 | * - Endpoint indexes are now specified as full endpoint addresses within the device in device mode, rather than a logical index | ||
| 246 | * - The Endpoint_ConfigureEndpoint() function no longer takes an endpoint direction as a parameter, as this is now deduced from the specified full endpoint | ||
| 247 | * address and type | ||
| 248 | * - The Endpoint_ConfigureEndpoint() function no longer takes a number of banks as a special mask; the number of banks is now specified as an integer parameter | ||
| 249 | * - Endpoints are now configured via instances of a new struct USB_Endpoint_Table_t in all device mode class drivers, rather than a list of endpoint parameters | ||
| 250 | * - Pipe indexes are now specified as full pipe addresses within the host in host mode, rather than a logical index | ||
| 251 | * - The Pipe_ConfigurePipe() function no longer takes an pipe token as a parameter, as this is now deduced from the specified full pipe address and type | ||
| 252 | * - The Pipe_ConfigurePipe() function no longer takes a number of banks as a special mask; the number of banks is now specified as an integer parameter | ||
| 253 | * - Pipes are now configured via instances of a new struct USB_Pipe_Table_t in all host mode class drivers, rather than a list of pipe parameters | ||
| 254 | * - Added support for various assert and debugging macros for the UC3 devices | ||
| 255 | * - Changed MIDI event structure MIDI_EventPacket_t to use a single field for the combined virtual cable index and command ID, to prevent bitfield packing issues | ||
| 256 | * on some architectures (thanks to Darren Gibbs) | ||
| 257 | * - Changed board LED driver implementations of LEDs_ToggleLEDs() for the AVR8 architecture to use the fast PIN register toggle alternative function for speed | ||
| 258 | * - Library Applications: | ||
| 259 | * - Raised the guard bits in the AVRISP-MKII clone project when in PDI and TPI to 32, to prevent communication errors on low quality connections to a target | ||
| 260 | * - Added additional bootloader API data to expose the bootloader start address and class to the DFU and CDC class bootloaders | ||
| 261 | * - Reverted AVRISP-MKII clone project watchdog based command timeout patch in favour of a hardware timer, to allow for use in devices with WDTRST fuse programmed | ||
| 262 | * - The library bootloaders will now correctly start the user application after a watchdog-based application start, even if the /HWB line is held low externally | ||
| 263 | * during the reset phase | ||
| 264 | * - Increased endpoint polling interval for all demos and projects to 5ms, as 1ms was causing some enumeration issues on some machines (thanks to Riku Salminen) | ||
| 265 | * | ||
| 266 | * <b>Fixed:</b> | ||
| 267 | * - Core: | ||
| 268 | * - Fixed possible enumeration error if the user application selects a pipe other than the default Control pipe between the Powered and Default states of | ||
| 269 | * the host state machine | ||
| 270 | * - Fixed incorrect call to the user callback CALLBACK_Audio_Device_GetSetInterfaceProperty() in the Audio Class device driver (thanks to Tiit Ratsep) | ||
| 271 | * - Fixed compile error for the UC3 architecture when INTERRUPT_CONTROL_ENDPOINT is specified (thanks to Andrus Aaslaid) | ||
| 272 | * - Fixed compile error if LEDs_Disable() is called and BOARD=NONE is set (thanks to Sam Lin) | ||
| 273 | * - Fixed inverted LED logic in the OLIMEX162 board LED driver | ||
| 274 | * - Fixed incorrect response to GET STATUS requests in device mode if NO_DEVICE_SELF_POWER or NO_DEVICE_REMOTE_WAKEUP tokens are defined (thanks to Georg Glock) | ||
| 275 | * - Fixed inverted LED logic in the USB2AX board LED driver | ||
| 276 | * - Fixed possible deadlock in the CDC device driver if the USB connection is dropped while the CDC_REQ_SetLineEncoding control request is being processed by | ||
| 277 | * the stack (thanks to Jonathan Hudgins) | ||
| 278 | * - Fixed broken MIDI host driver MIDI_Host_ReceiveEventPacket() function due to not unfreezing the MIDI data IN pipe before use (thanks to Michael Brown) | ||
| 279 | * - Fixed swapped Little Endian/Big Endian endpoint and pipe write code for the UC3 devices (thanks to Andrew Chu) | ||
| 280 | * - Fixed the JTAG_DISABLE() macro clearing all other bits in MCUSR when called | ||
| 281 | * - Fixed incorrect Micropendous board LED driver LEDs_SetAllLEDs() and LEDs_ChangeLEDs() function implementations (thanks to MitchJS) | ||
| 282 | * - Fixed endianess issues in the RNDIS host class driver for UC3 devices (thanks to Andrew Chu) | ||
| 283 | * - Library Applications: | ||
| 284 | * - Fixed error in the AVRISP-MKII programmer when ISP mode is used at 64KHz (thanks to Ben R. Porter) | ||
| 285 | * - Fixed AVRISP-MKII programmer project failing to compile for the U4 chips when VTARGET_ADC_CHANNEL is defined to an invalid channel and NO_VTARGET_DETECT is | ||
| 286 | * defined (thanks to Steven Morehouse) | ||
| 287 | * - Fixed AVRISP-MKII programmer project reset line polarity inverted when the generated EEP file is loaded into the USB AVR's EEPROM and avr-dude is used | ||
| 288 | * - Fixed CDC and DFU bootloaders failing to compile when the bootloader section size is 8KB or more (thanks to Georg Glock) | ||
| 289 | * - Fixed CDC and DFU bootloaders API function offsets incorrect on some devices (thanks to Rod DeMay) | ||
| 290 | * - Fixed incorrect DFU version number reported to the host in the DFU bootloader descriptors (thanks to Georg Glock) | ||
| 291 | * - Fixed incorrect version hundredths value encoding in VERSION_BCD() macro (thanks to Georg Glock) | ||
| 292 | * - Fixed invalid configuration descriptor in the low level KeyboardMouse device demo (thanks to Jun Wako) | ||
| 293 | * - Fixed CDC and DFU bootloaders API page erase and write function failures (thanks to Martin Lambert) | ||
| 294 | * | ||
| 295 | * \section Sec_ChangeLog120219 Version 120219 | ||
| 296 | * <b>New:</b> | ||
| 297 | * - Core: | ||
| 298 | * - Added support for the XMEGA A3BU Xplained board | ||
| 299 | * - Added support for the new B series XMEGA devices | ||
| 300 | * - Added support for version 2 of the Teensy boards (thanks to Christoph Redecker) | ||
| 301 | * - Added support for the USB2AX boards, hardware revision 1-3 | ||
| 302 | * - Added new Android Accessory Host class driver | ||
| 303 | * - Added new USB_Host_GetDescriptor(), USB_Host_GetDeviceConfiguration() and USB_Host_GetInterfaceAltSetting() functions | ||
| 304 | * - Added new CALLBACK_Audio_Device_GetSetInterfaceProperty() callback to the Audio Device Class driver | ||
| 305 | * - Added new LEDs_Disable(), Buttons_Disable() and Joystick_Disable() functions to the board hardware drivers | ||
| 306 | * - Added support for the Micropendous family of boards (Arduino-like revisions 1 and 2, DIP, 32U2, A, 1, 2, 3 and 4) | ||
| 307 | * - Added INVERTED_VBUS_ENABLE_LINE and NO_AUTO_VBUS_MANAGEMENT compile time options (thanks to Opendous Inc.) | ||
| 308 | * - Added support for the Atmel XMEGA B1 Xplained board | ||
| 309 | * - Added Serial USART peripheral driver for the XMEGA architecture | ||
| 310 | * - Added Master Mode SPI USART peripheral driver for the XMEGA and AVR8 architectures | ||
| 311 | * - Added build test to verify correct compilation of as many modules as possible under as many architectures as possible under the C and C++ languages | ||
| 312 | * - Added build test to verify correct compilation of the USB driver when forced into single USB mode under as many architectures as possible | ||
| 313 | * - Library Applications: | ||
| 314 | * - Added User Application APIs to the CDC and DFU class bootloaders | ||
| 315 | * - Added INVERTED_ISP_MISO compile time option to the AVRISP-MKII clone project (thanks to Chuck Rohs) | ||
| 316 | * - Added new Android Accessory Host demo (thanks to Opendous Inc.) | ||
| 317 | * | ||
| 318 | * <b>Changed:</b> | ||
| 319 | * - Core: | ||
| 320 | * - When automatic PLL management mode is enabled on the U4 series AVR8 chips, the PLL is now configured for 48MHz and not | ||
| 321 | * a divided 96MHz, to lower power consumption and to keep the system within the datasheet specs for 3.3V operation (thanks to Scott Vitale) | ||
| 322 | * - Added Class, ClassDevice, ClassHost and ClassCommon to the internal class driver source filenames to prevent ambiguities | ||
| 323 | * - Altered the Mass Storage Host class driver so that SCSI data STALLs from the attached device can be recovered from automatically without | ||
| 324 | * having to reset the Mass Storage interface | ||
| 325 | * - USB_CONFIG_ATTR_BUSPOWERED constant renamed to USB_CONFIG_ATTR_RESERVED, as this was misnamed (thanks to NXP Semiconductors) | ||
| 326 | * - Reordered board name definition indexes so that a misspelled BOARD compile option will default to BOARD_USER rather than BOARD_USBKEY | ||
| 327 | * - Altered the HID class driver to only try to construct at maximum one packet per USB frame, to reduce CPU usage | ||
| 328 | * - All USB Class Driver configuration struct values are now non-const, to allow for run-time modifications if required before configuring an instance | ||
| 329 | * - Library Applications: | ||
| 330 | * - Altered the Mass Storage Host LowLevel demo so that SCSI data STALLs from the attached device can be recovered from automatically without | ||
| 331 | * having to reset the Mass Storage interface | ||
| 332 | * - Updated the AVRISP-MKII Clone programmer project to be compatible with the latest version of AVR Studio (version 5.1) | ||
| 333 | * - Changed the AVRISP-MKII Clone programmer project to report a fixed 3.3V VTARGET voltage on USB AVRs lacking an ADC instead of 5V to prevent | ||
| 334 | * warnings in AVR Studio 5.1 when programming XMEGA devices | ||
| 335 | * - Allow serial strings to be generated on the older AVR8 devices which do not explicitly state they contain unique values in the datasheet, | ||
| 336 | * as this appears to be implemented in hardware | ||
| 337 | * | ||
| 338 | * <b>Fixed:</b> | ||
| 339 | * - Core: | ||
| 340 | * - Fixed ring buffer size limited to 255 elements, instead of the intended 65535 elements. | ||
| 341 | * - Fixed CDC class drivers not saving and sending all 16-bits of the control line states (thanks to Matthew Swabey) | ||
| 342 | * - Fixed race conditions in the CDC, HID and Mass Storage class drivers when processing some control requests | ||
| 343 | * - Fixed misspelled HID_KEYBOARD_MODIFIER_* macros in the HID class driver (thanks to Laszlo Monda) | ||
| 344 | * - Fixed broken AVR32 endpoint/pipe communications when ORDERED_EP_CONFIG compile time option is not enabled (thanks to Matthias Jahr) | ||
| 345 | * - Fixed broken compilation for the AVR32 devices if the NO_SOF_EVENTS compile time option was not enabled (thanks to Matthias Jahr) | ||
| 346 | * - Fixed compiler warning on GCC with \c -wundef compile flag is used (thanks to Georg Glock) | ||
| 347 | * - Fixed incorrect implementation of LEDs_ToggleLEDs() for the Adafruit-U4 board (thanks to Caroline Saliman) | ||
| 348 | * - Fixed broken compilation of LUFA under C++ compilers when the Serial peripheral module header file is included in a C++ source file | ||
| 349 | * - Fixed missing semicolon in the UC3 architecture host pipe functions | ||
| 350 | * - Fixed failed compilation for the XMEGA architecture if USB_DEVICE_ONLY us not specified | ||
| 351 | * - Fixed UC3 architecture ignoring the pipe size when Pipe_ConfigurePipe() is called | ||
| 352 | * - Library Applications: | ||
| 353 | * - Added reliability patches to the AVRISP-MKII Clone project's PDI/TPI protocols (thanks to Justin Mattair) | ||
| 354 | * - Fixed AVRISP-MKII Clone compile warning on AVR8 U4 targets even when NO_VTARGET_DETECT is enabled | ||
| 355 | * - Fixed AVRISP-MKII Clone failing to start application firmware once a TPI programming session is exited | ||
| 356 | * - Fixed DFU class bootloader not resetting the LED pins as high impedance inputs when a software jump to the user applications is requested | ||
| 357 | * - Fixed AVRISP-MKII Clone timing out on long programming commands such as programming the EEPROM on an ATMEGA8 (thanks to Martin Kelling) | ||
| 358 | * - Fixed invalid PID value used in the TempDataLogger project host application (thanks to Anupam Pathak) | ||
| 359 | * | ||
| 360 | * \section Sec_ChangeLog111009 Version 111009 | ||
| 361 | * <b>New:</b> | ||
| 362 | * - Core: | ||
| 363 | * - Added USE_LUFA_CONFIG_HEADER compile time option to include a LUFAConfig.h header in the user director for LUFA configuration | ||
| 364 | * tokens as an alternative to tokens defined in the project makefile | ||
| 365 | * - Added new USB_Host_SetInterfaceAltSetting() convenience function for the selection of an interface's alternative setting | ||
| 366 | * - Added Audio class control request definitions | ||
| 367 | * - Added new CALLBACK_Audio_Device_GetSetEndpointProperty() callback to the Audio Device Class driver to allow for endpoint control manipulations | ||
| 368 | * such as data sample rates | ||
| 369 | * - Added support for the Audio class GET STATUS request in the Audio Device Class driver so that it is correctly ACKed when sent by the host | ||
| 370 | * - Added new EVENT_Audio_Device_StreamStartStop() event to the Audio Device Class driver to detect stream start/stop events | ||
| 371 | * - Added board driver support for the Busware TUL board | ||
| 372 | * - Added board hardware driver support for the EVK1100 board | ||
| 373 | * - Added board hardware driver support for the EVK1104 board | ||
| 374 | * - Added new Host mode Audio Class driver | ||
| 375 | * - Added new SPI_GetCurrentMode() function to the SPI peripheral driver | ||
| 376 | * - Added RingBuffer_GetFreeCount() function to the Ring Buffer driver | ||
| 377 | * - Added new HID_Host_SetIdlePeriod() function to the HID Host Class driver | ||
| 378 | * - Added new USB_Host_ConfigurationNumber global variable to indicate the selected configuration in an attached device | ||
| 379 | * - Added new USB_Host_GetDeviceStatus() function to the host standard request function set | ||
| 380 | * - Added AVR USB XMEGA architecture port (currently incomplete/experimental) | ||
| 381 | * - Added new STRINGIFY() and STRINGIFY_EXPANDED() convenience macros | ||
| 382 | * - Added new JTAG_DISABLE() macro for the AVR8 architecture | ||
| 383 | * - Added Device Qualifier standard descriptor structure definitions USB_StdDescriptor_DeviceQualifier_t and USB_Descriptor_DeviceQualifier_t | ||
| 384 | * - Library Applications: | ||
| 385 | * - Added RNDIS device mode to the Webserver project | ||
| 386 | * - Added new incomplete AndroidAccessoryHost Host LowLevel demo | ||
| 387 | * - Added new HIDReportViewer project | ||
| 388 | * - Added new MediaControl project | ||
| 389 | * - Added new AudioInputHost Host ClassDriver demo | ||
| 390 | * - Added new AudioOutputHost Host ClassDriver demo | ||
| 391 | * - Added new AudioInputHost Host LowLevel demo | ||
| 392 | * - Added new AudioOutputHost Host LowLevel demo | ||
| 393 | * - Added new "checksource" target to all library project makefiles | ||
| 394 | * - Added new VTARGET_USE_INTERNAL_REF configuration option to the AVRISP-MKII clone project (thanks to Volker Bosch) | ||
| 395 | * | ||
| 396 | * <b>Changed:</b> | ||
| 397 | * - Core: | ||
| 398 | * - Altered the definition of the USB_Audio_Descriptor_Format_t descriptor so that the user is now responsible for supplying | ||
| 399 | * the supported audio sampling rates, to allow for multiple audio interfaces with different numbers of supported rates and/or | ||
| 400 | * continuous sample rates | ||
| 401 | * - Pipe_BoundEndpointNumber() has been renamed to Pipe_GetBoundEndpointAddress(), and now returns the correct endpoint direction | ||
| 402 | * as part of the endpoint address | ||
| 403 | * - Renamed global state variables that are specific to a certain USB mode to clearly indicate which mode the variable relates to, | ||
| 404 | * by changing the USB_* prefix to USB_Device_* or USB_Host_* | ||
| 405 | * - Removed the HOST_STATE_WaitForDeviceRemoval and HOST_STATE_Suspended host state machine states, as these are no longer required | ||
| 406 | * - Altered the USB_Host_SetDeviceConfiguration() function to update the global Host state machine state and the new | ||
| 407 | * USB_Host_ConfigurationNumber global as required | ||
| 408 | * - Added endian correcting code to the library USB class drivers for multiple architecture support | ||
| 409 | * - Removed the ENDPOINT_DESCRIPTOR_DIR_* macros, replaced by ENDPOINT_DIR_* instead | ||
| 410 | * - Renamed the JTAG_DEBUG_ASSERT() macro to JTAG_ASSERT() | ||
| 411 | * - Added variable number of axis to HID_DESCRIPTOR_JOYSTICK() for multi-axis joysticks above just X and Y | ||
| 412 | * - Renamed USB_Host_ClearPipeStall() to USB_Host_ClearEndpointStall() as the function works on an endpoint address within the attached device, | ||
| 413 | * and not a Pipe within the host | ||
| 414 | * - The MS_Host_ResetMSInterface() now performs a full Mass Storage reset sequence to prevent data corruption in the event of a device | ||
| 415 | * lock up or timeout (thanks to David Lyons) | ||
| 416 | * - Added endian-correction to the CDC driver's Line Encoding control request handlers. | ||
| 417 | * - Library Applications: | ||
| 418 | * - Modified the Low Level and Class Driver AudioInput and AudioOutput demos to support multiple audio sample rates | ||
| 419 | * - Updated all host mode demos and projects to use the EVENT_USB_Host_DeviceEnumerationComplete() event callback for device configuration | ||
| 420 | * instead of manual host state machine manipulations in the main application task | ||
| 421 | * - Changed the reports in the GenericHID device demos to control the board LEDs, to reduce user confusion over the callback routines | ||
| 422 | * - Added reliability patches to the AVRISP-MKII Clone project's ISP and PDI/TPI protocols (thanks to Justin Mattair) | ||
| 423 | * | ||
| 424 | * <b>Fixed:</b> | ||
| 425 | * - Core: | ||
| 426 | * - Large number of documentation and code comment corrections (thanks to Andrey from Microsin.ru) | ||
| 427 | * - Fixed possibility of the AVR's SPI interface being pulled out of master mode if the /SS pin is a input and pulled low (thanks | ||
| 428 | * to Andrey from Microsin.ru) | ||
| 429 | * - Fixed compile error when FIXED_CONTROL_ENDPOINT_SIZE compile time option was disabled, and a USE_*_DESCRIPTORS compile time | ||
| 430 | * option was not enabled on the AVR8s | ||
| 431 | * - Fixed lack of C++ compatibility in some internal header files causing compile errors when using LUFA in C++ projects | ||
| 432 | * - Fixed error in the pipe unordered allocation algorithm for the AVR8 devices breaking compatibility with some devices | ||
| 433 | * - Fixed USB_USBTask not being called internally in stream transfers between packets when Partial Stream Transfers are used | ||
| 434 | * - Fixed swapped TWI_ADDRESS_READ and TWI_ADDRESS_WRITE values | ||
| 435 | * - Fixed TWI_ReadPacket() not releasing the TWI bus on read completion | ||
| 436 | * - Fixed optimization error in the HID Parser item value USB_SetHIDReportItemInfo() and USB_GetHIDReportItemInfo() routines if the report item was | ||
| 437 | * \c NULL (which should be allowable according to the API) | ||
| 438 | * - Fixed HID Parser CALLBACK_HIDParser_FilterHIDReportItem() callback function not being passed a cacheable report item pointer | ||
| 439 | * - Fixed HID Parser's largest report size bit count not including the size of the last parsed report item | ||
| 440 | * - Fixed HID host driver's largest HID report size count corrupt when the number of report bits exceeds 255 | ||
| 441 | * - Library Applications: | ||
| 442 | * - Fixed incorrect signature in the CDC and DFU class bootloaders for the ATMEGA8U2 | ||
| 443 | * - Fixed KeyboardHost and KeyboardHostWithParser demos displaying incorrect values when numerical keys were pressed | ||
| 444 | * - Fixed compile errors in the incomplete BluetoothHost demo application (thanks to Timo Lindfors) | ||
| 445 | * - Fixed incorrect Dataflash buffer use in the DataflashManager_WriteBlocks_RAM() function of several demos/projects (thanks to Jeremy Willden) | ||
| 446 | * - Fixed incorrect logging interval (always 500ms longer than requested) in the TempDataLogger project | ||
| 447 | * - Fixed incorrect buffer size check in the USBtoSerial project (thanks to Yuri A Nikiforov) | ||
| 448 | * - Fixed port state table corruption in the TCP layer of the RNDIS Ethernet device demos | ||
| 449 | * | ||
| 450 | * \section Sec_ChangeLog110528 Version 110528 | ||
| 451 | * <b>New:</b> | ||
| 452 | * - Core: | ||
| 453 | * - Added new ORDERED_EP_CONFIG compile time option to restrict endpoint/pipe configuration to ascending order | ||
| 454 | * in exchange for a smaller compiled program binary size | ||
| 455 | * - Added a new general RingBuff.h miscellaneous ring buffer library driver header | ||
| 456 | * - Added new GCC_FORCE_POINTER_ACCESS() macro to correct GCC's mishandling of struct pointer accesses | ||
| 457 | * - Added new GCC_MEMORY_BARRIER() macro to prevent instruction reordering across boundaries | ||
| 458 | * - Added basic driver example use code to the library documentation | ||
| 459 | * - Added new Endpoint_Null_Stream() and Pipe_Null_Stream() functions | ||
| 460 | * - Added new ADC_GET_CHANNEL_MASK() convenience macro | ||
| 461 | * - Added new HID report item macros (with HID_RI_ prefix) to allow for easy creation and editing of HID report descriptors | ||
| 462 | * - Added new HID_DESCRIPTOR_MOUSE(), HID_DESCRIPTOR_KEYBOARD(), HID_DESCRIPTOR_JOYSTICK() and HID_DESCRIPTOR_VENDOR() macros | ||
| 463 | * for easy automatic creation of basic USB HID device reports | ||
| 464 | * - Added new MAX() and MIN() convenience macros | ||
| 465 | * - Added new Serial_SendData() function to the Serial driver | ||
| 466 | * - Added board driver support for the Sparkfun ATMEGA8U2 breakout board | ||
| 467 | * - Added TWI baud rate prescaler and bit length parameters to the TWI_Init() function (thanks to Thomas Herlinghaus) | ||
| 468 | * - Internal restructuring for eventual multiple architecture ports | ||
| 469 | * - Added AVR32 UC3 architecture port (currently incomplete/experimental) | ||
| 470 | * - Added new architecture independent functions to enable, disable, save and restore the Global Interrupt Enable flags | ||
| 471 | * - Added new RNDIS Device Class Driver packet send and receive functions | ||
| 472 | * - Library Applications: | ||
| 473 | * - Added ability to write protect Mass Storage disk write operations from the host OS | ||
| 474 | * - Added new MIDIToneGenerator project | ||
| 475 | * - Added new KeyboardMouseMultiReport Device ClassDriver demo | ||
| 476 | * - Added new VirtualSerialMassStorage Device ClassDriver demo | ||
| 477 | * - Added HID class bootloader, compatible with a modified version of the command line Teensy loader from PJRC.com | ||
| 478 | * - Added LED flashing to the CDC and DFU class bootloaders to indicate when they are running | ||
| 479 | * | ||
| 480 | * <b>Changed:</b> | ||
| 481 | * - Core: | ||
| 482 | * - Unordered Endpoint/Pipe configuration is now allowed once again by default via the previous reconfig workaround | ||
| 483 | * - Refactored Host mode Class Driver *_Host_ConfigurePipes() routines to be more space efficient when compiled | ||
| 484 | * - Added new *_ENUMERROR_PipeConfigurationFailed error codes for the *_Host_ConfigurePipes() routines | ||
| 485 | * - The USARTStream global is now public and documented in the SerialStream module, allowing for the serial USART | ||
| 486 | * stream to be accessed via its handle rather than via the implicit stdout and stdin streams | ||
| 487 | * - The FAST_STREAM_TRANSFERS compile time option has been removed due to lack of use and low cost/benefit ratio | ||
| 488 | * - Altered all endpoint/pipe stream transfers so that the new BytesProcessed parameter now points to a location | ||
| 489 | * where the number of bytes in the transfer that have been completed can be stored (or NULL if entire transaction | ||
| 490 | * should be performed in one chunk) | ||
| 491 | * - The NO_STREAM_CALLBACKS compile time option has now been removed due to the new partial stream transfer feature | ||
| 492 | * - Changed over all project and demo HID report descriptors to use the new HID report item macros | ||
| 493 | * - Moved the HIDParser.c source file to the LUFA/Drivers/USB/Class/Common/ directory from the LUFA/Drivers/USB/Class/Host/ | ||
| 494 | * - Added support to the HID parser for extended USAGE items that contain the usage page as well as the usage index | ||
| 495 | * - Removed the SerialStream driver, rolled functionality into the regular Serial peripheral driver via the new | ||
| 496 | * Serial_CreateStream() and Serial_CreateBlockingStream() functions | ||
| 497 | * - Renamed the low level Serial byte send/receive functions, to be consistent with the CDC class driver byte functions | ||
| 498 | * - Altered the behaviour of the serial byte reception function so that is is non-blocking, and now returns a negative | ||
| 499 | * value if no character is received (to remain consistent with the CDC class driver byte reception routines) | ||
| 500 | * - Renamed the PRNT_Host_SendString(), CDC_Host_SendString() and CDC_Device_SendString() functions to *_SendData(), and | ||
| 501 | * added new versions of the *_SendString() routines that expect a null terminated string instead | ||
| 502 | * - Renamed all driver termination *_ShutDown() functions to the more logical name *_Disable() | ||
| 503 | * - Reduced latency for executing the Start-Of-Frame events (if enabled in the user application) | ||
| 504 | * - Removed Pipe_ClearErrorFlags(), pipe error flags are now automatically cleared when Pipe_ClearError() is called | ||
| 505 | * - Endpoint_ResetFIFO() renamed to Endpoint_ResetEndpoint(), to be consistent with the Pipe_ResetPipe() function name | ||
| 506 | * - Implemented on-demand PLL clock generation for the U4, U6 and U7 series USB AVRs when automatic PLL mode is specified | ||
| 507 | * - F_CLOCK changed to F_USB to be more descriptive, and applicable on future architecture ports | ||
| 508 | * - Renamed all low level Endpoint_Read_*, Endpoint_Write_* and Endpoint_Discard_* functions to use the number of bits instead of | ||
| 509 | * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures | ||
| 510 | * - Renamed all low level Pipe_Read_*, Pipe_Write_* and Pipe_Discard_* functions to use the number of bits instead of | ||
| 511 | * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures | ||
| 512 | * - Separated out board drivers by architecture in the library internals for better organisation | ||
| 513 | * - Library Applications: | ||
| 514 | * - Changed the XPLAINBridge software UART to use the regular timer CTC mode instead of the alternative CTC mode | ||
| 515 | * via the Input Capture register, to reduce user confusion | ||
| 516 | * - Combined page and word ISP programming mode code in the AVRISP-MKII clone project to reduce compiled size and | ||
| 517 | * increase maintainability of the code | ||
| 518 | * - Changed over library projects to use the new general ring buffer library driver module | ||
| 519 | * - Added new high level TWI packet read/write commands, altered behaviour of the TWI_StartTransmission() function | ||
| 520 | * - Changed TempDataLogger project's DS1307 driver to simplify the function interface and prevent a possible race condition | ||
| 521 | * - Changed AVRISP-MKII project to use the Watchdog interrupt for command timeouts, to reduce CPU usage and free timer 0 | ||
| 522 | * for other uses | ||
| 523 | * - Updated the software USART code in the XPLAIN Bridge application so that the incoming bits are sampled at their mid-point | ||
| 524 | * instead of starting point, to give maximum reliability (thanks to Anton Staaf) | ||
| 525 | * | ||
| 526 | * <b>Fixed:</b> | ||
| 527 | * - Core: | ||
| 528 | * - Fixed broken USBFOO board drivers due to missing BOARD_USBFOO define | ||
| 529 | * - Fixed HID host class driver incorrectly binding to HID devices that do not have an OUT endpoint | ||
| 530 | * - Fixed incorrect definition of the HID_KEYBOARD_SC_D constant in the HID class driver (thanks to Opendous Inc.) | ||
| 531 | * - Fixed incorrect definition of the HID_KEYBOARD_SC_RIGHT_ARROW constant in the HID class driver (thanks to Joby Taffey) | ||
| 532 | * - Fixed incorrect endpoint initialisation order in the several device demos (thanks to Rick Drolet) | ||
| 533 | * - Fixed inverted Minimus board LEDs | ||
| 534 | * - Fixed incorrect byte ordering in the Audio_Device_WriteSample24 function (thanks to WZab) | ||
| 535 | * - Fixed several functions in the Host mode Still Image Class driver returning an error code from the incorrect | ||
| 536 | * error code enum (thanks to Daniel Seibert) | ||
| 537 | * - Fixed ReportID not being removed from the feature/out report data array in the HID class driver when Report IDs are used | ||
| 538 | * - Fixed incorrect BUTTONS_BUTTON1 definition for the Minimus board | ||
| 539 | * - Fixed Still Image Host class driver exiting the descriptor search routine prematurely if the data pipes (but not event pipe) | ||
| 540 | * is found | ||
| 541 | * - Fixed missing call to Pipe_SetInfiniteINRequests() in the Pipe_ConfigurePipe() routine | ||
| 542 | * - Fixed Remote Wakeup broken on the AVRs due to the mechanism only operating when the SUSPI bit is set (thanks to Holger Steinhaus) | ||
| 543 | * - Fixed possible invalid program execution when in host mode if corrupt descriptor lengths are supplied by the attached device | ||
| 544 | * - Library Applications: | ||
| 545 | * - Fixed Benito project discarding incoming data from the USB virtual serial port when the USART is busy | ||
| 546 | * - Fixed broken DFU bootloader, added XPLAIN support for bootloader start when XCK jumpered to ground | ||
| 547 | * - Fixed broken HID_REQ_GetReport request handler in the Low Level GenericHID demo | ||
| 548 | * - Fixed possible lost data in the XPLAINBridge, USBtoSerial and Benito projects when the host exceeds the packet | ||
| 549 | * timeout period on received packets as set by USB_STREAM_TIMEOUT_MS (thanks to Justin Rajewski) | ||
| 550 | * - Fixed possible programming problem in the AVRISP-MKII clone project when programming specific patterns into a target | ||
| 551 | * memory space that is only byte (not page) addressable | ||
| 552 | * - Fixed errors in the incomplete Test and Measurement device demo preventing proper operation (thanks to Pavel Plotnikov) | ||
| 553 | * - Fixed programming errors in the AVRISP-MKII project when the programming packet is a round multiple of the endpoint bank | ||
| 554 | * size under avrdude (thanks to Steffan Woltjer) | ||
| 555 | * | ||
| 556 | * | ||
| 557 | * \section Sec_ChangeLog101122 Version 101122 | ||
| 558 | * <b>New:</b> | ||
| 559 | * - Core: | ||
| 560 | * - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously | ||
| 561 | * not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger) | ||
| 562 | * - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c | ||
| 563 | * - Added new USB_Device_GetFrameNumber() and USB_Host_GetFrameNumber() functions to retrieve the current USB frame number | ||
| 564 | * - Added new USB_Host_EnableSOFEvents(), USB_Host_DisableSOFEvents() and EVENT_USB_Host_StartOfFrame() for the user application | ||
| 565 | * handling of USB Start of Frame events while in USB Host mode | ||
| 566 | * - Added new PRNT_Host_BytesReceived(), PRNT_Host_ReceiveByte(), PRNT_Host_SendByte() and PRNT_Host_Flush() functions to the | ||
| 567 | * Print Host Class driver | ||
| 568 | * - Added class specific descriptor alternative struct type defines with standard USB-IF element naming | ||
| 569 | * - Added new project makefile template to the library and moved board driver stub files into in a new "CodeTemplates" directory | ||
| 570 | * - Added board hardware driver support for the Adafruit U4 breakout board | ||
| 571 | * - Added board hardware driver support for the Arduino Uno development board | ||
| 572 | * - Added board hardware driver support for the Blackcat USB JTAG board (thanks to the PSGroove team) | ||
| 573 | * - Added board hardware driver support for the Busware BUI development board | ||
| 574 | * - Added board hardware driver support for the Busware CUL V3 868MHZ radio board (thanks to Dirk Tostmann) | ||
| 575 | * - Added board hardware driver support for the Kernel Concepts USBFOO development board | ||
| 576 | * - Added board hardware driver support for the Linnix UDIP development board | ||
| 577 | * - Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett) | ||
| 578 | * - Added board hardware driver support for the Maximus board (thanks to the PSGroove team) | ||
| 579 | * - Added board hardware driver support for the Microsin AVR-USB162 breakout board | ||
| 580 | * - Added board hardware driver support for the Minimus board (thanks to the PSGroove team) | ||
| 581 | * - Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management | ||
| 582 | * tasks for each driver is called | ||
| 583 | * - Added standard keyboard HID report scan-code defines (thanks to Laszlo Monda) | ||
| 584 | * - Added new Pipe_GetBusyBanks(), Endpoint_GetBusyBanks() and Endpoint_AbortPendingIN() functions | ||
| 585 | * - Library Applications: | ||
| 586 | * - Added default test tone generation mode to the Device mode AudioInput demos | ||
| 587 | * - Added new NO_BLOCK_SUPPORT, NO_EEPROM_BYTE_SUPPORT, NO_FLASH_BYTE_SUPPORT and NO_LOCK_BYTE_WRITE_SUPPORT compile time options to the | ||
| 588 | * CDC class bootloader | ||
| 589 | * - Added new XCK_RESCUE_CLOCK_ENABLE compile time option to the AVRISP-MKII clone programmer project (thanks to Tom Light) | ||
| 590 | * | ||
| 591 | * <b>Changed:</b> | ||
| 592 | * - Core: | ||
| 593 | * - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions | ||
| 594 | * depending of if the given bank size is a compile time constant, as the compiler does a better job of optimizing | ||
| 595 | * with basic code | ||
| 596 | * - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove | ||
| 597 | * the need for extra casting inside the callback (thanks to Jonathan Kollasch) | ||
| 598 | * - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode | ||
| 599 | * - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode | ||
| 600 | * - Renamed and moved class driver common constant definitions to make the naming scheme more uniform | ||
| 601 | * - Moved the USB mode specifier constants into a new enum, so that they are semantically related to one another | ||
| 602 | * - Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed it to return the maximum number of supported banks for | ||
| 603 | * the given endpoint | ||
| 604 | * - Better algorithm to extract and convert the internal device serial number into a string descriptor (if present) | ||
| 605 | * - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be separately included | ||
| 606 | * - The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called | ||
| 607 | * - Renamed the EVENT_USB_Device_UnhandledControlRequest() event to EVENT_USB_Device_ControlRequest() as it is now fired before the library | ||
| 608 | * request handlers, not afterwards | ||
| 609 | * - Library Applications: | ||
| 610 | * - Changed over all device demos to use a clearer algorithm for the configuring of the application's endpoints | ||
| 611 | * - Added missing DataflashManager_CheckDataflashOperation() function to the MassStorageKeyboard demo, removed redundant | ||
| 612 | * SCSI_Codes.h file as these values are part of the MassStorage Class Driver | ||
| 613 | * - Added compile time error to the AVRISP-MKII project when built for the U4 chips, as the default VTARGET detection ADC channel | ||
| 614 | * does not exist on these chips (thanks to Marco) | ||
| 615 | * - Changed all Device mode LowLevel demos and Device Class drivers so that the control request is acknowledged and any data | ||
| 616 | * transferred as quickly as possible without any processing in between sections, so that long callbacks or event handlers will | ||
| 617 | * not break communications with the host by exceeding the maximum control request stage timeout period | ||
| 618 | * - Changed over all demos, drivers and internal functions to use the current frame number over the Start of Frame flag where possible | ||
| 619 | * to free up the Start of Frame flag for interrupt use in the user application | ||
| 620 | * - All project makefiles now correctly clean intermediate build files from assembly and C++ sources (thanks to Daniel Czigany) | ||
| 621 | * - Changed default value for the reset polarity parameter in the AVRISP-MKII project so that it defaults to active low drive | ||
| 622 | * - Changed configuration descriptor parser for all host mode projects and class drivers to ensure better compatibility with devices | ||
| 623 | * - All LowLevel demos changed to use the constants and types defined in the USB class drivers | ||
| 624 | * - Changed AudioInput and AudioOutput demos to reload the next sample via an interrupt rather than polling the sample timer | ||
| 625 | * - Rescue clock of the AVRISP-MKII moved to the AVR's OCR1A pin, so that the clock can be generated at all times | ||
| 626 | * - Changed ClassDriver MIDI demos to process all incoming events in a loop until the bank becomes empty rather than one at a time | ||
| 627 | * - Changed LowLevel MIDI demos to only clear the incoming event bank once it has become empty to support packed event packets | ||
| 628 | * | ||
| 629 | * <b>Fixed:</b> | ||
| 630 | * - Core: | ||
| 631 | * - Fixed USB_GetHIDReportItemInfo() function modifying the given report item's data when the report item does not exist | ||
| 632 | * within the supplied report of a multiple report HID device | ||
| 633 | * - Fixed critical pipe/endpoint memory allocation issue where the bank memory address space could be silently overlapped | ||
| 634 | * in the USB controller if the endpoints or pipes were allocated in anything other than ascending order (thanks to Martin Degelsegger) | ||
| 635 | * - Added LEDs_ToggleLEDs() function to several board LED drivers which were missing it (thanks to Andrei Krainev) | ||
| 636 | * - Fixed SET FEATURE and CLEAR FEATURE control requests directed at an unconfigured endpoint causing request timeouts | ||
| 637 | * - Fixed USB_Host_ClearPipeStall() incorrectly determining the endpoint direction from the currently selected pipe | ||
| 638 | * - Fixed JTAG_DEBUG_POINT() and JTAG_DEBUG_BREAK() macros not compiling under pure C99 standards mode | ||
| 639 | * - Fixed endpoint selection within the CALLBACK_HID_Device_CreateHIDReport() callback function causing broken GET REPORT requests | ||
| 640 | * - Fixed incorrect command name for EEPROM memory programming in the makefile dfu-ee target | ||
| 641 | * - Fixed incorrect LEDs_ChangeLEDs() function in the Benito board LED driver | ||
| 642 | * - Fixed incorrect USB_DeviceState value when unconfiguring the device without an address set | ||
| 643 | * - Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init() is called | ||
| 644 | * - Fixed random enumeration failure while in device mode due to interrupts causing the Set Address request to exceed maximum timings | ||
| 645 | * - Fixed MIDI_Host_Flush() not aborting early when the specified MIDI host interface was not configured | ||
| 646 | * - Fixed MIDI class driver send routines silently discarding packets if the endpoint or pipe is busy (thanks to Robin Green) | ||
| 647 | * - Library Applications: | ||
| 648 | * - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to | ||
| 649 | * missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger) | ||
| 650 | * - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control | ||
| 651 | * request handler | ||
| 652 | * - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value | ||
| 653 | * - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2 | ||
| 654 | * - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev) | ||
| 655 | * - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used | ||
| 656 | * - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules | ||
| 657 | * - Fixed USBtoSerial and XPLAINBridge demos discarding data from the PC if the send buffer becomes full | ||
| 658 | * - Fixed broken input in the MagStripe reader project due to an incorrect HID report descriptor | ||
| 659 | * - Fixed incorrect PollingIntervalMS values in the demo/project/bootloader endpoint descriptors (thanks to MCS Electronics) | ||
| 660 | * - Fixed AVRISP-MKII clone project not starting the target's program automatically after exiting TPI programming mode | ||
| 661 | * | ||
| 662 | * | ||
| 663 | * \section Sec_ChangeLog100807 Version 100807 | ||
| 664 | * <b>New:</b> | ||
| 665 | * - Added new ADC_DisableChannel() function (thanks to Mich Davis) | ||
| 666 | * - Added new VTARGET_REF_VOLTS and VTARGET_SCALE_FACTOR compile time defines to the AVRISP-MKII programmer project to set | ||
| 667 | * the VTARGET reference voltage and scale factor | ||
| 668 | * - Added new pgm_read_ptr() macro to Common.h for reading of pointers out of flash memory space | ||
| 669 | * - Added new SWAPENDIAN_16() and SWAPENDIAN_32() macros to Common.h for statically initialized variables at compile time | ||
| 670 | * - Added new Drivers/USB/LowLevel/Device.c file to house Device mode specific functions that are more complicated than simple macros | ||
| 671 | * - Added new AVRStudio 4 project files for all library demos, projects and bootloaders | ||
| 672 | * - Added ability to set the serial baud rate via the user's terminal in the XPLAINBridge project | ||
| 673 | * - Added new LUFA module variables for the different source modules in the core library makefile to simplify project makefiles | ||
| 674 | * - Added start of a new Test and Measurement class demo (thanks to Peter Lawrence) | ||
| 675 | * - Added new SPI_ORDER_* data order masks to the SPI peripheral driver | ||
| 676 | * - Added support to the AVRISP-MKII project for ISP speeds slower than 125KHz via a new software SPI driver | ||
| 677 | * - Added support for the new button/LED on the latest model USBTINY-MKII | ||
| 678 | * | ||
| 679 | * <b>Changed:</b> | ||
| 680 | * - The RingBuff library code has been replaced in the XPLAINBridge, Benito and USBtoSerial projects with an ultra lightweight | ||
| 681 | * ring buffer to help improve the reliability of the projects | ||
| 682 | * - The EEPROM stream read/write functions now use eeprom_update_byte() instead of eeprom_write_byte(), so that only | ||
| 683 | * changed bytes are written to EEPROM to preserve its lifespan | ||
| 684 | * - Changed over the AVRISP-MKII and TemperatureDataLogger projects to use eeprom_update_byte() when writing non-volatile | ||
| 685 | * parameters to EEPROM to preserve its lifespan | ||
| 686 | * - Removed unused line encoding data and control requests from the CDC Bootloader code, to save space | ||
| 687 | * - Renamed SERIAL_STREAM_ASSERT() macro to STDOUT_ASSERT() | ||
| 688 | * - The USB_Device_IsRemoteWakeupSent() and USB_Device_IsUSBSuspended() macros have been deleted, as they are now obsolete | ||
| 689 | * - Rewrote the implementation of the SwapEndian_16() and SwapEndian_32() functions so that they compile down in most instances to | ||
| 690 | * minimal loads and stores rather than complicated shifts | ||
| 691 | * - The software UART in the XPLAINBridge has been largely altered to try to improve upon its performance and reliability | ||
| 692 | * - The USBtoSerial and Benito projects now flushes received data via a flush timer, so that several bytes can be transmitted at once | ||
| 693 | * - Removed the automated checking of event names in the demo, project and bootloader makefiles due to inconsistencies between the | ||
| 694 | * behaviour of the command line tools used to perform the check on each platform | ||
| 695 | * - Internal USB driver source files renamed and moved to ease future possible architecture ports | ||
| 696 | * - All internal pseudo-function macros have been converted to true inline functions for type-safety and readability | ||
| 697 | * - Changed LED indicator masks for the AVRISP-MKII project, so that there are defined roles for each LED | ||
| 698 | * - Altered the CDC Device and Host Class drivers' receive byte routines, so that no data is indicated by the function returning a | ||
| 699 | * negative value (thanks to Andreas Paulin) | ||
| 700 | * - Added auto flushing of OUT data to the CDC Host Class driver's USBTask function to automatically flush the send pipe buffer | ||
| 701 | * | ||
| 702 | * <b>Fixed:</b> | ||
| 703 | * - Fixed AVRISP project sending a LOAD EXTENDED ADDRESS command to 128KB AVRs after programming or reading from | ||
| 704 | * the last page of FLASH (thanks to Gerard Sexton) | ||
| 705 | * - Fixed AVRISP project not sending a full erase-and-write EEPROM command to XMEGA targets when writing to the EEPROM | ||
| 706 | * instead of the split write-only command (thanks to Tim Margush) | ||
| 707 | * - Fixed RNDISEthernet demos crashing when calculating checksums for Ethernet/TCP packets of more than ~500 bytes due to | ||
| 708 | * an overflow in the checksum calculation loop (thanks to Kevin Malec) | ||
| 709 | * - Fixed XPLAINBridge project not correctly reading the XMEGA's supply voltage when reporting back to the host | ||
| 710 | * - Fixed incorrect signature for the ATMEGA32U2 in the DFU bootloader (thanks to Axel Rohde) | ||
| 711 | * - Fixed internal device serial not being accessible on the ATMEGAXXU2 AVRs (thanks to Axel Rohde) | ||
| 712 | * - Fixed void pointer arithmetic in ConfigDescriptor.h breaking C++ compatibility (thanks to Michael Hennebry) | ||
| 713 | * - Fixed broken PDI EEPROM Section Erase functionality in the AVRISP-MKII project | ||
| 714 | * - Fixed USB_Device_SendRemoteWakeup() not working when the USB clock was frozen during USB bus suspend (thanks to Brian Dickman) | ||
| 715 | * - Fixed occasional lockup of the AVRISP project due to the timeout extension code incorrectly extending the timeout in | ||
| 716 | * PDI and TPI programming modes infinitely | ||
| 717 | * - Fixed HID device class driver still using PrevReportINBuffer for GetReport control requests even when it has been | ||
| 718 | * set to NULL by the user application (thanks to Axel Rohde) | ||
| 719 | * - Fixed MIDI_Device_SendEventPacket() not correctly waiting for the endpoint to become ready (thanks to Robin Green) | ||
| 720 | * - Fixed Benito and USBtoSerial projects not turning off the USART before reconfiguring it, which could cause incorrect | ||
| 721 | * operation to occur (thanks to Bob Paddock) | ||
| 722 | * - Fixed Serial peripheral driver not turning off the USART before reconfiguring it, which would cause incorrect operation | ||
| 723 | * to occur (thanks to Bob Paddock) | ||
| 724 | * - Fixed software application start command broken in the DFU class bootloader when dfu-programmer is used due to application | ||
| 725 | * start address corruption | ||
| 726 | * | ||
| 727 | * | ||
| 728 | * \section Sec_ChangeLog100513 Version 100513 | ||
| 729 | * <b>New:</b> | ||
| 730 | * - Added incomplete MIDIToneGenerator project | ||
| 731 | * - Added new Relay Controller Board project (thanks to OBinou) | ||
| 732 | * - Added board hardware driver support for the Teensy, USBTINY MKII, Benito and JM-DB-U2 lines of third party USB AVR boards | ||
| 733 | * - Added new ATTR_NO_INIT variable attribute for global variables that should not be automatically cleared on startup | ||
| 734 | * - Added new ENDPOINT_*_BusSuspended error code to the Endpoint function, so that the stream functions early-abort if the bus | ||
| 735 | * is suspended before or during a transfer | ||
| 736 | * - Added new EVENT_CDC_Device_BreakSent() event and CDC_Host_SendBreak() function to the Device and Host CDC Class drivers | ||
| 737 | * - Added ReportType parameter to the HID device class driver CALLBACK_HID_Device_ProcessHIDReport() function so that FEATURE | ||
| 738 | * reports from the host to the device can be correctly processed | ||
| 739 | * - Added ReportType parameter to the HID host class driver HID_Host_SendReportByID() function so that FEATURE reports can be | ||
| 740 | * issued to the attached device | ||
| 741 | * | ||
| 742 | * <b>Changed:</b> | ||
| 743 | * - AVRISP programmer project now has a more robust timeout system | ||
| 744 | * - Added a timeout value to the TWI_StartTransmission() function, within which the addressed device must respond | ||
| 745 | * - Webserver project now uses the board LEDs to indicate the current IP configuration state | ||
| 746 | * - Added ENABLE_TELNET_SERVER compile time option to the Webserver project to disable the TELNET server if desired | ||
| 747 | * - Increased throughput of the USBtoSerial demo on systems that send multiple bytes per packet (thanks to Opendous Inc.) | ||
| 748 | * - Double bank CDC endpoints in the XPLAIN Bridge project, re-enable JTAG once the mode selection pin has been sampled. | ||
| 749 | * - Standardized the naming scheme given to configuration descriptor sub-elements in the Device mode demos, bootloaders | ||
| 750 | * and projects | ||
| 751 | * - All Class Driver Host mode demos now correctly set the board LEDs to READY once the enumeration process has completed | ||
| 752 | * - Added LIBUSB_FILTERDRV_COMPAT compile time option to the AVRISP programmer project to make the code compatible with Windows | ||
| 753 | * builds of avrdude at the expense of AVRStudio compatibility | ||
| 754 | * - Removed two-step endpoint/pipe bank clear and switch sequence for smaller, faster endpoint/pipe code | ||
| 755 | * - The USB_Init() function no longer calls sei() - the user is now responsible for enabling interrupts when they are ready | ||
| 756 | * for them to be enabled (thanks to Andrei Krainev) | ||
| 757 | * - The Audio_Device_IsSampleReceived() and Audio_Device_IsReadyForNextSample() functions are now inline, to reduce overhead | ||
| 758 | * - Removed the cast to uint16_t on the set baud rate in the USBtoSerial project, so that the higher >1M baud rates can be | ||
| 759 | * selected (thanks to Steffan Woltjer) | ||
| 760 | * - Removed software PDI and TPI emulation from the AVRISP-MKII clone project as it was very buggy and slow - PDI and TPI must | ||
| 761 | * now be implemented via separate programming headers | ||
| 762 | * - The CDC class bootloader now uses a watchdog reset rather than a soft-reset when exited to ensure that all hardware is | ||
| 763 | * properly reset to their defaults | ||
| 764 | * - Device mode class driver callbacks are now fired before the control request status stage is sent to prevent the host from | ||
| 765 | * timing out if another request is immediately fired and the device has a lengthy callback routine | ||
| 766 | * - The TeensyHID bootloader has been removed, per request from Paul at PJRC | ||
| 767 | * - The LIBUSB_FILTERDRV_COMPAT compile time option in the XPLAINBridge and AVRISP-MKII projects has been renamed | ||
| 768 | * LIBUSB_DRIVER_COMPAT, as it applies to all software on all platforms using the libUSB driver | ||
| 769 | * | ||
| 770 | * <b>Fixed:</b> | ||
| 771 | * - Fixed possible device lockup when INTERRUPT_CONTROL_ENDPOINT is enabled and the control endpoint is not properly | ||
| 772 | * selected when the ISR completes | ||
| 773 | * - Fixed AVRISP-MKII clone project not correctly issuing LOAD EXTENDED ADDRESS commands when the extended address | ||
| 774 | * boundary is crossed during programming or read back (thanks to Gerard Sexton) | ||
| 775 | * - Fixed warnings when building the AVRISP-MKII clone project with the ENABLE_XPROG_PROTOCOL compile time option disabled | ||
| 776 | * - Fixed software PDI/TPI programming mode in the AVRISP project not correctly toggling just the clock pin | ||
| 777 | * - Fixed TWI_StartTransmission() corrupting the contents of the GPIOR0 register | ||
| 778 | * - Fixed TWI driver not aborting when faced with no response after attempting to address a device on the bus | ||
| 779 | * - Fixed ADC routines not correctly returning the last result when multiple channels were read | ||
| 780 | * - Fixed ADC routines failing to read the extended channels (Channels 8 to 13, Internal Temperature Sensor) on the | ||
| 781 | * U4 series USB AVR parts | ||
| 782 | * - Fixed LowLevel MassStorage demo broken on the U2 series USB AVRs due to unsupported double-banked endpoint modes used | ||
| 783 | * - Fixed compilation error in the AudioInput demos when MICROPHONE_BIASED_TO_HALF_RAIL is defined (thanks to C. Scott Ananian) | ||
| 784 | * - Fixed incorrect definition of HID_ALIGN_DATA() causing incorrect HID report item data alignment | ||
| 785 | * - Fixed Still Image Host class driver not resetting the transaction ID when a new session is opened, fixed driver not sending | ||
| 786 | * a valid session ID to the device | ||
| 787 | * - Removed invalid dfu and flip related targets from the bootloaders - bootloaders can only be replaced with an external programmer | ||
| 788 | * - Fixed Set/Clear Feature requests directed to a non-configured endpoint not returning a stall to the host | ||
| 789 | * - Fixed HID Device Class Driver not allocating a temporary buffer when the host requests a report via the control endpoint and the | ||
| 790 | * user has set the PrevReportINBuffer driver configuration element to NULL (thanks to Lars Noschinski) | ||
| 791 | * - Fixed device state not being reset to DEVICE_STATE_Default if the host sets a 0x00 device address | ||
| 792 | * - Fixed device not stalling configuration requests before the device's address has been set | ||
| 793 | * - Fixed possibility of internal signature retrieval being corrupted if an interrupt occurs during a signature byte | ||
| 794 | * read (thanks to Andrei Krainev) | ||
| 795 | * - Fixed device state not being reset back to the default state if the host sets the address to 0 | ||
| 796 | * - Fixed Set Configuration requests not being stalled until the host has set the device's address | ||
| 797 | * - Fixed Host mode HID class driver not sending the correct report type when HID_Host_SendReportByID() was called and the | ||
| 798 | * HID_HOST_BOOT_PROTOCOL_ONLY compile time option is set | ||
| 799 | * - Fixed INTERRUPT_CONTROL_ENDPOINT compile time option preventing other interrupts from occurring while the control endpoint | ||
| 800 | * request is being processed, causing possible lockups if a USB interrupt occurs during a transfer | ||
| 801 | * - Remove incorrect Abstract Call Management class specific descriptor from the CDC demos, bootloaders and projects | ||
| 802 | * | ||
| 803 | * | ||
| 804 | * \section Sec_ChangeLog100219 Version 100219 | ||
| 805 | * | ||
| 806 | * <b>New:</b> | ||
| 807 | * - Added TPI programming support for 6-pin ATTINY devices to the AVRISP programmer project (thanks to Tom Light) | ||
| 808 | * - Added command timeout counter to the AVRISP project so that the device no longer freezes when incorrectly connected | ||
| 809 | * to a target | ||
| 810 | * - Added new TemperatureDataLogger application, a USB data logger which writes to the device's dataflash and appears to | ||
| 811 | * the host as a standard Mass Storage device when inserted | ||
| 812 | * - Added MIDI event packing support to the MIDI Device and Host mode Class drivers, allowing for multiple MIDI events to | ||
| 813 | * sent or received in packed form in a single USB packet | ||
| 814 | * - Added new MIDI send buffer flush routines to the MIDI Device and Host mode Class drivers, to flush packed events | ||
| 815 | * - Added master mode hardware TWI driver for easy TWI peripheral control | ||
| 816 | * - Added ADC MUX masks for the standard ADC input channels on all AVR models with an ADC, altered demos to use these masks | ||
| 817 | * as on some models, the channel number is not identical to its single-ended ADC MUX mask | ||
| 818 | * - New Webserver project, a RNDIS host USB webserver using the open source uIP TCP/IP network stack and FatFS library | ||
| 819 | * - New BOARD value option BOARD_NONE (equivalent to not specifying BOARD) which will remove all board hardware drivers which | ||
| 820 | * do not adversely affect the code operation (currently only the LEDs driver) | ||
| 821 | * - Added keyboard modifier masks (HID_KEYBOARD_MODIFER_*) and LED report masks (KEYBOARD_LED_*) to the HID class driver and | ||
| 822 | * Keyboard demos | ||
| 823 | * - Added .5MHz recovery clock to the AVRISP programmer project when in ISP programming mode to correct mis-set fuses | ||
| 824 | * | ||
| 825 | * <b>Changed:</b> | ||
| 826 | * - Slowed down software USART carried PDI programming in the AVRISP project to prevent transmission errors | ||
| 827 | * - Renamed the AVRISP project folder to AVRISP-MKII to reduce confusion | ||
| 828 | * - Renamed the RESET_LINE_* makefile tokens in the AVRISP MKII Project to AUX_LINE_*, as they are not always used for target | ||
| 829 | * reset | ||
| 830 | * - Changed over the MassStorageKeyboard Class driver device demo to use Start of Frame events rather than a timer to keep track | ||
| 831 | * of elapsed milliseconds | ||
| 832 | * - Inlined currently unused (but standardized) maintenance functions in the Device and Host Class drivers to save space | ||
| 833 | * - The XPLAINBridge project now selects between a USB to Serial bridge and a PDI programmer on startup, reading the JTAG port's | ||
| 834 | * TDI pin to determine which mode to use | ||
| 835 | * - Removed the stream example code from the Low Level VirtualSerial demos, as they were buggy and only served to add clutter | ||
| 836 | * | ||
| 837 | * <b>Fixed:</b> | ||
| 838 | * - Fixed AVRISP project not able to enter programming mode when ISP protocol is used | ||
| 839 | * - Fixed AVRISP PDI race condition where the guard time between direction changes could be interpreted as a start bit | ||
| 840 | * - Fixed ADC_IsReadingComplete() returning an inverted result | ||
| 841 | * - Fixed blocking CDC streams not aborting when the host is disconnected | ||
| 842 | * - Fixed XPLAIN board Dataflash driver broken due to incorrect preprocessor commands | ||
| 843 | * - Fixed inverted XPLAIN LED driver output (LED turned on when it was supposed to be turned off, and vice-versa) | ||
| 844 | * - Fixed Class Driver struct interface numbers in the KeyboardMouse and VirtualSerialMouse demos (thanks to Renaud Cerrato) | ||
| 845 | * - Fixed invalid USB controller PLL prescaler values for the ATMEGAxxU2 controllers | ||
| 846 | * - Fixed lack of support for the ATMEGA32U2 in the DFU and CDC class bootloaders | ||
| 847 | * - Fixed Benito project not resetting the target AVR automatically when programming has completed | ||
| 848 | * - Fixed DFU bootloader programming not discarding the correct number of filler bytes from the host when non-aligned programming | ||
| 849 | * ranges are specified (thanks to Thomas Bleeker) | ||
| 850 | * - Fixed CDC and RNDIS host demos and class drivers - bidirectional endpoints should use two separate pipes, not one half-duplex pipe | ||
| 851 | * - Fixed Pipe_IsEndpointBound() not taking the endpoint's direction into account | ||
| 852 | * - Fixed EEPROM and FLASH ISP programming in the AVRISP project | ||
| 853 | * - Fixed incorrect values of USB_CONFIG_ATTR_SELFPOWERED and USB_CONFIG_ATTR_REMOTEWAKEUP tokens (thanks to Claus Christensen) | ||
| 854 | * - Fixed SerialStream driver blocking while waiting for characters to be received instead of returning EOF | ||
| 855 | * - Fixed SerialStream driver not setting stdin to the created serial stream (thanks to Mike Alexander) | ||
| 856 | * - Fixed USB_GetHIDReportSize() returning the number of bits in the specified report instead of bytes | ||
| 857 | * - Fixed AVRISP project not extending the command delay after each successful page/word/byte program | ||
| 858 | * - Fixed accuracy of the SERIAL_UBBRVAL() and SERIAL_2X_UBBRVAL() macros for higher baud rates (thanks to Renaud Cerrato) | ||
| 859 | * | ||
| 860 | * | ||
| 861 | * \section Sec_ChangeLog091223 Version 091223 | ||
| 862 | * | ||
| 863 | * <b>New:</b> | ||
| 864 | * - Added activity LED indicators to the AVRISP project to indicate when the device is busy processing a command | ||
| 865 | * - The USB target family and allowable USB mode tokens are now public and documented (USB_CAN_BE_*, USB_SERIES_*_AVR) | ||
| 866 | * - Added new XPLAIN USB to Serial Bridge project (thanks to John Steggall for initial proof-of-concept, David Prentice | ||
| 867 | * and Peter Danneger for revised software USART code) | ||
| 868 | * - Added new RNDIS Ethernet Host LowLevel demo | ||
| 869 | * - Added new RNDIS Ethernet Host Class Driver | ||
| 870 | * - Added new RNDIS Ethernet Host ClassDriver demo | ||
| 871 | * - Added CDC_Host_Flush() function to the CDC Host Class driver to flush sent data to the attached device | ||
| 872 | * - Added PDI programming support for XMEGA devices to the AVRISP programmer project (thanks to Justin Mattair) | ||
| 873 | * - Added support for the XPLAIN board Dataflash, with new XPLAIN_REV1 board target for the different Dataflash used | ||
| 874 | * on the first revision boards compared to the one mounted on later revisions | ||
| 875 | * - Added new HID_ALIGN_DATA() macro to return the pre-retrieved value of a HID report item, left-aligned to a given datatype | ||
| 876 | * - Added new PreviousValue to the HID Report Parser report item structure, for easy monitoring of previous report item values | ||
| 877 | * - Added new EVK527 board target | ||
| 878 | * - Added new USB_Host_GetDeviceStringDescriptor() convenience function | ||
| 879 | * - Added new LEDNotification project to the library, to give a visual LED notification on new events from the host | ||
| 880 | * - Added new NO_DEVICE_REMOTE_WAKEUP and NO_DEVICE_SELF_POWER compile time options | ||
| 881 | * | ||
| 882 | * <b>Changed:</b> | ||
| 883 | * - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of key codes | ||
| 884 | * as this relied on non-standard OS driver behaviour to repeat key groups | ||
| 885 | * - The SCSI_Request_Sense_Response_t and SCSI_Inquiry_Response_t type defines are now part of the Mass Storage Class | ||
| 886 | * driver common defines, rather than being defined in the Host mode Class driver section only | ||
| 887 | * - The USB_MODE_HOST token is now defined even when host mode is not available | ||
| 888 | * - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to | ||
| 889 | * indicate the report type to generate | ||
| 890 | * - All Class Drivers now return false or the "DeviceDisconnected" error code of their respective error enums when a function | ||
| 891 | * is called when no host/device is connected where possible | ||
| 892 | * - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to HOST_SENDCONTROL_DeviceDisconnected to be in line | ||
| 893 | * with the rest of the library error codes | ||
| 894 | * - Make MIDI device demos also turn off the on board LEDs if MIDI Note On messages are sent with a velocity of zero, | ||
| 895 | * which some devices use instead of Note Off messages (thanks to Robin Green) | ||
| 896 | * - The CDC demos are now named "VirtualSerial" instead to indicate the demos' function rather than its implemented USB class, | ||
| 897 | * to reduce confusion and to be in line with the rest of the LUFA demos | ||
| 898 | * - The SImage_Host_SendBlockHeader() and SImage_Host_ReceiveBlockHeader() Still Image Host Class driver functions are now public | ||
| 899 | * | ||
| 900 | * <b>Fixed:</b> | ||
| 901 | * - Added missing CDC_Host_CreateBlockingStream() function code to the CDC Host Class driver | ||
| 902 | * - Fixed incorrect values for REPORT_ITEM_TYPE_* enum values causing corrupt data in the HID Host Parser | ||
| 903 | * - Fixed misnamed SI_Host_USBTask() and SI_Host_ConfigurePipes() functions | ||
| 904 | * - Fixed broken USB_GetNextDescriptor() function causing the descriptor to jump ahead double the expected amount | ||
| 905 | * - Fixed Pipe_IsEndpointBound() not masking the given Endpoint Address against PIPE_EPNUM_MASK | ||
| 906 | * - Fixed host state machine not enabling Auto VBUS mode when HOST_DEVICE_SETTLE_DELAY_MS is set to zero | ||
| 907 | * - Fixed misnamed Pipe_SetPipeToken() macro for setting a pipe's direction | ||
| 908 | * - Fixed CDCHost failing on devices with bidirectional endpoints | ||
| 909 | * - Fixed USB driver failing to define the PLL prescaler mask for the ATMEGA8U2 and ATMEGA16U2 | ||
| 910 | * - Fixed HID Parser not distributing the Usage Min and Usage Max values across an array of report items | ||
| 911 | * - Fixed Mass Storage Host Class driver and Low Level demo not clearing the error condition if an attached device returns a | ||
| 912 | * STALL to a GET MAX LUN request (thanks to Martin Luxen) | ||
| 913 | * - Fixed TeensyHID bootloader not properly shutting down the USB interface to trigger a disconnection on the host before resetting | ||
| 914 | * - Fixed MassStorageHost Class driver demo not having USB_STREAM_TIMEOUT_MS compile time option set properly to prevent slow | ||
| 915 | * devices from timing out the data pipes | ||
| 916 | * - Fixed the definition of the Endpoint_BytesInEndpoint() macro for the U4 series AVR parts | ||
| 917 | * - Fixed MIDI host Class driver MIDI_Host_SendEventPacket() routine not properly checking for Pipe ready before writing | ||
| 918 | * - Fixed use of deprecated struct initializers, removed library unused parameter warnings when compiled with -Wextra enabled | ||
| 919 | * - Fixed Still Image Host Class driver truncating the PIMA response code (thanks to Daniel Seibert) | ||
| 920 | * - Fixed USB_CurrentMode not being reset to USB_MODE_NONE when the USB interface is shut down and both Host and Device modes can be | ||
| 921 | * used (thanks to Daniel Levy) | ||
| 922 | * - Fixed TeensyHID bootloader not enumerating to the host correctly (thanks to Clint Fisher) | ||
| 923 | * - Fixed AVRISP project timeouts not checking for the correct timeout period (thanks to Carl Ott) | ||
| 924 | * - Fixed STK525 Dataflash driver using incorrect bit-shifting for Dataflash addresses (thanks to Tim Mitchell) | ||
| 925 | * | ||
| 926 | * | ||
| 927 | * \section Sec_ChangeLog091122 Version 091122 | ||
| 928 | * | ||
| 929 | * <b>New:</b> | ||
| 930 | * - Added new Dual Role Keyboard/Mouse demo | ||
| 931 | * - Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the HID Host Class driver when | ||
| 932 | * Report protocol is not needed | ||
| 933 | * - Added new MIDI LowLevel and ClassDriver Host demo, add new MIDI Host Class driver | ||
| 934 | * - Added new CDC/Mouse ClassDriver device demo | ||
| 935 | * - Added new Joystick Host ClassDriver and LowLevel demos | ||
| 936 | * - Added new Printer Host mode Class driver | ||
| 937 | * - Added new Printer Host mode ClassDriver demo | ||
| 938 | * - Added optional support for double banked endpoints and pipes in the Device and Host mode Class drivers | ||
| 939 | * - Added new stream creation function to the CDC Class drivers, to easily make standard I/O streams from CDC Class driver instances | ||
| 940 | * | ||
| 941 | * <b>Changed:</b> | ||
| 942 | * - Removed mostly useless "TestApp" demo, as it was mainly useful only for checking for syntax errors in the library | ||
| 943 | * - MIDI device demos now receive MIDI events from the host and display note ON messages via the board LEDs | ||
| 944 | * - Cleanups to the Device mode Mass Storage demo application SCSI routines | ||
| 945 | * - Changed Audio Class driver sample read/write functions to be inline, to reduce the number of cycles needed to transfer | ||
| 946 | * samples to and from the device (allowing more time for sample processing and output) | ||
| 947 | * - Audio class Device mode demos now work at both 16MHz and 8MHz, rather than just at 8MHz | ||
| 948 | * - The previous USBtoSerial demo has been moved into the projects directory, as it was just a modified CDC demo | ||
| 949 | * - The Endpoint/Pipe functions now use the const qualifier on the input buffer | ||
| 950 | * - Changed the CALLBACK_HIDParser_FilterHIDReportItem() callback to pass a HID_ReportItem_t rather than just the current | ||
| 951 | * item's attributes, to expose more information on the item (including it's type, collection path, etc.) | ||
| 952 | * - Changed MouseHostWithParser demos to check that the report items have a Mouse usage collection as a parent at some point, | ||
| 953 | * to prevent Joysticks from enumerating with the demo | ||
| 954 | * - Corrected the name of the misnamed USB_GetDeviceConfigDescriptor() function to USB_Host_GetDeviceConfigDescriptor(). | ||
| 955 | * - Keyboard LowLevel/ClassDriver demos now support multiple simultaneous key presses (up to 6) per report | ||
| 956 | * | ||
| 957 | * <b>Fixed:</b> | ||
| 958 | * - Fixed PrinterHost demo returning invalid Device ID data when the attached device does not have a | ||
| 959 | * device ID (thanks to Andrei Krainev) | ||
| 960 | * - Changed LUFA_VERSION_INTEGER define to use BCD values, to make comparisons easier | ||
| 961 | * - Fixed issue in the HID Host class driver's HID_Host_SendReportByID() routine using the incorrect mode (control/pipe) | ||
| 962 | * to send report to the attached device | ||
| 963 | * - Fixed ClassDriver AudioOutput device demo not selecting an audio output mode | ||
| 964 | * - Fixed incorrect SampleFrequencyType value in the AudioInput and AudioOutput ClassDriver demos' descriptors | ||
| 965 | * - Fixed incorrect event name rule in demo/project/bootloader makefiles | ||
| 966 | * - Fixed HID device class driver not reselecting the correct endpoint once the user callback routines have been called | ||
| 967 | * - Corrected HID descriptor in the Joystick Device demos - buttons should be placed outside the pointer collection | ||
| 968 | * - Fixed HID report parser collection paths invalid due to misplaced semicolon in the free path item search loop | ||
| 969 | * - Fixed HID host Class driver report send/receive report broken when issued through the control pipe | ||
| 970 | * - Fixed HOST_STATE_AS_GPIOR compile time option being ignored when in host mode (thanks to David Lyons) | ||
| 971 | * - Fixed LowLevel Keyboard demo not saving the issues report only after it has been sent to the host | ||
| 972 | * - Fixed Endpoint_Write_Control_Stream_* functions not sending a terminating IN when given data Length is zero | ||
| 973 | * | ||
| 974 | * | ||
| 975 | * \section Sec_ChangeLog090924 Version 090924 | ||
| 976 | * | ||
| 977 | * <b>New:</b> | ||
| 978 | * - Added new host mode class drivers and matching demos to the library for rapid application development | ||
| 979 | * - Added flag to the HID report parser to indicate if a device has multiple reports | ||
| 980 | * - Added new EVENT_USB_Device_StartOfFrame() event, controlled by the new USB_Device_EnableSOFEvents() and | ||
| 981 | * USB_Device_DisableSOFEvents() macros to give bus-synchronized millisecond interrupts when in USB device mode | ||
| 982 | * - Added new Endpoint_SetEndpointDirection() macro for bidirectional endpoints | ||
| 983 | * - Added new AVRISP project, a LUFA powered clone of the Atmel AVRISP-MKII programmer | ||
| 984 | * - Added ShutDown() functions for all hardware peripheral drivers, so that peripherals can be turned off after use | ||
| 985 | * - Added new CDC_Device_Flush() command to the device mode CDC Class driver to flush Device->Host data | ||
| 986 | * - Added extra masks to the SPI driver, changed SPI_Init() so that the clock polarity and sample modes can be set | ||
| 987 | * - Added new callback to the HID report parser, so that the user application can filter only the items it is interested | ||
| 988 | * in to be stored into the HIDReportInfo structure to save RAM | ||
| 989 | * - Added support for the officially recommended external peripheral layout for the BUMBLEB board (thanks to Dave Fletcher) | ||
| 990 | * - Added new Pipe_IsFrozen() macro to determine if the currently selected pipe is frozen | ||
| 991 | * - Added new USB_GetHIDReportSize() function to the HID report parser to retrieve the size of a given report by its ID | ||
| 992 | * - Added new combined Mass Storage and Keyboard demo (thanks to Matthias Hullin) | ||
| 993 | * | ||
| 994 | * <b>Changed:</b> | ||
| 995 | * - SetIdle requests to the HID device driver with a 0 idle period (send changes only) now only affect the requested | ||
| 996 | * HID interface within the device, not all HID interfaces | ||
| 997 | * - Added explicit attribute masks to the device mode demos' descriptors | ||
| 998 | * - Added return values to the CDC and MIDI class driver transmit functions | ||
| 999 | * - Optimized Endpoint_Read_Word_* and Pipe_Read_Word_* macros to reduce compiled size | ||
| 1000 | * - Added non-null function parameter pointer restrictions to USB Class drivers to improve user code reliability | ||
| 1001 | * - Added new "Common" section to the class drivers, to hold all mode-independent definitions for clarity | ||
| 1002 | * - Moved SCSI command/sense constants into the Mass Storage Class driver, instead of the user-code | ||
| 1003 | * - Altered the SCSI commands in the LowLevel Mass Storage Host to save on FLASH space by reducing function calls | ||
| 1004 | * - Changed the parameters and behaviour of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks | ||
| 1005 | * and data validations internally, to simplify user code | ||
| 1006 | * - Changed HIDParser to only zero out important values in the Parsed HID Report Item Information structure to save cycles | ||
| 1007 | * - The HID report parser now always processed FEATURE items - HID_ENABLE_FEATURE_PROCESSING token now has no effect | ||
| 1008 | * - The HID report parser now always ignores constant-data items, HID_INCLUDE_CONSTANT_DATA_ITEMS token now has no effect | ||
| 1009 | * - The Benito Programmer project now has its own unique VID/PID pair allocated from the Atmel donated LUFA VID/PID pool | ||
| 1010 | * - Add in new invalid event hook check targets to project makefiles to produce compilation errors when invalid event names | ||
| 1011 | * are used in a project | ||
| 1012 | * - The HID Report Parser now gives information on the total length of each report within a HID interface | ||
| 1013 | * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate USB_Descriptor_* and | ||
| 1014 | * USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so both may be used | ||
| 1015 | * | ||
| 1016 | * <b>Fixed:</b> | ||
| 1017 | * - Fixed possible lockup in the CDC device class driver, when the host sends data that is a multiple of the | ||
| 1018 | * endpoint's bank | ||
| 1019 | * - Fixed swapped parameters in the HID state memory copy call while processing a HID PUSH item in the HID report parser | ||
| 1020 | * - Fixed memory corruption HID report parser when too many COLLECTION or PUSH items were processed | ||
| 1021 | * - Fixed HID report parser not resetting the FEATURE item count when a REPORT ID item is encountered | ||
| 1022 | * - Fixed USBtoSerial demos not reading in UDR1 when the USART receives data but the USB interface is not enumerated, | ||
| 1023 | * causing continuous USART receive interrupts | ||
| 1024 | * - Fixed misspelled event name in the Class driver USBtoSerial demo, preventing correct operation | ||
| 1025 | * - Fixed invalid data being returned when a GetStatus request is issued in Device mode with an unhandled data recipient | ||
| 1026 | * - Added hardware USART receive interrupt and software buffering to the Benito project to ensure received data is not | ||
| 1027 | * missed or corrupted | ||
| 1028 | * - Fixed Device mode HID Class driver always sending IN packets, even when nothing to report | ||
| 1029 | * - Fixed Device mode HID Class driver not explicitly initializing the ReportSize parameter to zero before calling callback | ||
| 1030 | * routine, so that ignored callbacks don't cause incorrect data to be sent | ||
| 1031 | * - Fixed StillImageHost not correctly freezing and unfreezing data pipes while waiting for a response block header | ||
| 1032 | * - Fixed error in the PrinterHost demo preventing the full page data from being sent to the attached device (thanks to John Andrews) | ||
| 1033 | * - Fixed CDC based demos and projects' INF driver files under 64 bit versions of Windows (thanks to Ronny Hanson, Thomas Bleeker) | ||
| 1034 | * - Re-add in missing flip, flip-ee, dfu and dfu-ee targets to project makefiles (thanks to Opendous Inc.) | ||
| 1035 | * - Fix allowable F_CPU values comment in project makefiles to more accurately reflect the allowable values on the USB AVRs | ||
| 1036 | * - Fixed DFU and CDC class bootloaders on the series 2 USB AVRs, corrected invalid signatures, added support for the new | ||
| 1037 | * ATMEGAxx2 series 2 variant AVRs to the DFU bootloader | ||
| 1038 | * - Fixed Low Level USBtoSerial demo not storing received characters (thanks to Michael Cooper) | ||
| 1039 | * - Fixed MIDI Device Class driver not sending/receiving MIDI packets of the correct size (thanks to Thomas Bleeker) | ||
| 1040 | * | ||
| 1041 | * | ||
| 1042 | * \section Sec_ChangeLog090810 Version 090810 | ||
| 1043 | * | ||
| 1044 | * <b>New:</b> | ||
| 1045 | * - Added new device class drivers and matching demos to the library for rapid application development | ||
| 1046 | * - Added new PrinterHost demo (thanks to John Andrews) | ||
| 1047 | * - Added USB Missile Launcher project, submitted by Dave Fletcher | ||
| 1048 | * - Added new Benito Arduino Programmer project | ||
| 1049 | * - Added incomplete device and host mode demos for later enhancement | ||
| 1050 | * - Updated MassStorage device block write routines to use ping-pong Dataflash buffering to increase throughput by around 30% | ||
| 1051 | * - Error status LEDs shown when device endpoint configuration fails to complete in all demos and projects | ||
| 1052 | * - Added new USB_Host_SetDeviceConfiguration() convenience function for easy configuration selection of devices while in USB | ||
| 1053 | * host mode | ||
| 1054 | * - Added new USB_Host_ClearPipeStall() convenience function to clear a stall condition on an attached device's endpoint | ||
| 1055 | * - Added new USB_Host_GetDeviceDescriptor() convenience function to retrieve the attached device's Device descriptor | ||
| 1056 | * - Added new Endpoint_ClearStatusStage() convenience function to assist with the status stages of control transfers | ||
| 1057 | * - Added new USE_INTERNAL_SERIAL define for using the unique serial numbers in some AVR models as the USB device's serial number, | ||
| 1058 | * added NO_INTERNAL_SERIAL compile time option to turn off new serial number reading code | ||
| 1059 | * - Added new DATAFLASH_CHIP_MASK() macro to the Dataflash driver, which returns the Dataflash select mask for the given chip index | ||
| 1060 | * - Added new HOST_STATE_WaitForDeviceRemoval host state machine state for non-blocking disabling of device communications until the | ||
| 1061 | * device has been removed (for use when an error occurs or communications with the device have completed) | ||
| 1062 | * - Added new FAST_STREAM_TRANSFERS compile time option for faster stream transfers via multiple bytes copied per stream loop | ||
| 1063 | * - Added stdio stream demo code to the CDC device demos, to show how to create standard streams out of the virtual serial ports | ||
| 1064 | * - Added new EEPROM and FLASH buffer versions of the Endpoint and Pipe stream functions | ||
| 1065 | * - Added new USE_FLASH_DESCRIPTORS and FIXED_NUM_CONFIGURATIONS compile time options | ||
| 1066 | * - Added support for the new ATMEGA32U2, ATMEGA16U2 and ATMEGA8U2 AVR models | ||
| 1067 | * - Added new USB_DeviceState variable to keep track of the current Device mode USB state | ||
| 1068 | * - Added new LEDs_ToggleLEDs() function to the LEDs driver | ||
| 1069 | * - Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions | ||
| 1070 | * - Added new DEVICE_STATE_AS_GPIOR and HOST_STATE_AS_GPIOR compile time options | ||
| 1071 | * - Added 404 Not Found errors to the webserver in the RNDIS demos to indicate invalid URLs | ||
| 1072 | * | ||
| 1073 | * <b>Changed:</b> | ||
| 1074 | * - Deprecated pseudo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused) | ||
| 1075 | * - The device-mode CALLBACK_USB_GetDescriptor() function now has an extra parameter so that the memory space in which the requested | ||
| 1076 | * descriptor is located can be specified. This means that descriptors can now be located in multiple memory spaces within a device. | ||
| 1077 | * - Removed vague USB_IsConnected global - test USB_DeviceState or USB_HostState explicitly to gain previous functionality | ||
| 1078 | * - Removed USB_IsSuspended global - test USB_DeviceState against DEVICE_STATE_Suspended instead | ||
| 1079 | * - Extended USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch | ||
| 1080 | * - Dataflash_WaitWhileBusy() now always ensures that the dataflash is ready for the next command immediately after returning, | ||
| 1081 | * no need to call Dataflash_ToggleSelectedChipCS() afterwards | ||
| 1082 | * - Low level API MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready | ||
| 1083 | * - Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow errors | ||
| 1084 | * - Pipe stream functions now automatically set the correct pipe token, so that bidirectional pipes can be used | ||
| 1085 | * - Pipe_ConfigurePipe() now automatically defaults IN pipes to accepting infinite IN requests, this can still be changed by calling | ||
| 1086 | * the existing Pipe_SetFiniteINRequests() function | ||
| 1087 | * - Changed F_USB entries in project makefiles to alias to F_CPU by default, as this is the most common case | ||
| 1088 | * - Host mode demos now use sane terminal escape codes, so that text is always readable and events/program output is visually distinguished | ||
| 1089 | * from one another using foreground colours | ||
| 1090 | * - Internal per-device preprocessing conditions changed to per-device series rather than per-controller group for finer-grain | ||
| 1091 | * internal control | ||
| 1092 | * - Interrupts are no longer disabled during the processing of Control Requests on the default endpoint while in device mode | ||
| 1093 | * - AudioOutput demos now always output to board LEDs, regardless of output mode (removed AUDIO_OUT_LEDS project option) | ||
| 1094 | * - Removed SINGLE_DEVICE_CONFIGURATION compile time option in favor of the new FIXED_NUM_CONFIGURATIONS option so that the exact number | ||
| 1095 | * of device configurations can be defined statically | ||
| 1096 | * - Removed VBUS events, as they are already exposed to the user application via the regular device connection and disconnection events | ||
| 1097 | * - Renamed and altered existing events to properly separate out Host and Device mode events | ||
| 1098 | * - All demos switched over from GNU99 standards mode to C99 standards mode, to reduce the dependencies on GCC-only language extensions | ||
| 1099 | * | ||
| 1100 | * <b>Fixed:</b> | ||
| 1101 | * - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix | ||
| 1102 | * bootloaders on some of the USB AVR devices where avr-libc erroneously defines RAMPZ | ||
| 1103 | * - Fixes to MassStorageHost for better device compatibility (increase command timeout, change MassStore_WaitForDataReceived() | ||
| 1104 | * to only unfreeze and check one data pipe at a time) to prevent incorrect device enumerations and freezes while transferring data | ||
| 1105 | * - Make Pipe_ConfigurePipe() mask the given endpoint number against PIPE_EPNUM_MASK to ensure the endpoint IN direction bit is | ||
| 1106 | * cleared to prevent endpoint type corruption | ||
| 1107 | * - Fixed issue opening CDC-ACM ports on hosts when the CDC device tries to send data before the host has set the line encoding | ||
| 1108 | * - Fixed USB_OPT_MANUAL_PLL option being ignored during device disconnects on some models (thanks to Brian Dickman) | ||
| 1109 | * - Fixed documentation mentioning Pipe_GetCurrentToken() function when correct function name is Pipe_GetPipeToken() | ||
| 1110 | * - Fixed ADC driver for the ATMEGA32U4 and ATMEGA16U4 (thanks to Opendous Inc.) | ||
| 1111 | * - Fixed CDCHost demo unfreezing the pipes at the point of configuration, rather than use | ||
| 1112 | * - Fixed MassStorage demo not clearing the reset flag when a Mass Storage Reset is issued while not processing a command | ||
| 1113 | * - Fixed USB_Host_SendControlRequest() not re-suspending the USB bus when initial device ready-wait fails | ||
| 1114 | * - Fixed USB Pad regulator not being disabled on some AVR models when the USB_OPT_REG_DISABLED option is used | ||
| 1115 | * - Fixed Host mode to Device mode UID change not causing a USB Disconnect event when a device was connected | ||
| 1116 | * - Fixed Mouse/Keyboard demos not performing the correct arithmetic on the Idle period at the right times (thanks to Brian Dickman) | ||
| 1117 | * - Fixed GenericHID failing HID class tests due to incorrect Logical Minimum and Logical Maximum values (thanks to Soren Greiner) | ||
| 1118 | * - Fixed incorrect PIPE_EPNUM_MASK mask causing pipe failures on devices with endpoint addresses of 8 and above (thanks to John Andrews) | ||
| 1119 | * - Fixed report data alignment issues in the MouseHostWithParser demo when X and Y movement data size is not a multiple of 8 bits | ||
| 1120 | * - Fixed HID Report Descriptor Parser not correctly resetting internal states when a REPORT ID element is encountered | ||
| 1121 | * - Fixed incorrect BUTTONS_BUTTON1 for the STK526 target | ||
| 1122 | * - Fixed RNDIS demos freezing when more than one connection was attempted simultaneously, causing memory corruption | ||
| 1123 | * - Fixed USBtoSerial demo receiving noise from the USART due to pull-up not being enabled | ||
| 1124 | * | ||
| 1125 | * | ||
| 1126 | * \section Sec_ChangeLog090605 Version 090605 | ||
| 1127 | * | ||
| 1128 | * - Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest structure for control request data | ||
| 1129 | * - Fixed documentation showing incorrect USB mode support on the supported AVRs list | ||
| 1130 | * - Fixed RNDISEthernet not working under Linux due to Linux requiring an "optional" RNDIS request which was unhandled | ||
| 1131 | * - Fixed Mouse and Keyboard device demos not acting in accordance with the HID specification for idle periods (thanks to Brian Dickman) | ||
| 1132 | * - Removed support for endpoint/pipe non-control interrupts; these did not act in the way users expected, and had many subtle issues | ||
| 1133 | * - Fixed Device Mode not handling Set Feature and Clear Feature Chapter 9 requests that are addressed to the device (thanks to Brian Dickman) | ||
| 1134 | * - Moved control endpoint interrupt handling into the library itself, enable via the new INTERRUPT_CONTROL_ENDPOINT token | ||
| 1135 | * - Fixed CDCHost not clearing configured pipes and resetting configured pipes mask when a partially enumerated invalid CDC | ||
| 1136 | * interface is skipped | ||
| 1137 | * - Clarified the size of library tokens which accept integer values in the Compile Time Tokens page, values now use the smallest datatype | ||
| 1138 | * inside the library that is able to hold their defined value to save space | ||
| 1139 | * - Removed DESCRIPTOR_ADDRESS() macro as it was largely superfluous and only served to obfuscate code | ||
| 1140 | * - Rewritten event system to remove all macros, to make user code clearer | ||
| 1141 | * - Fixed incorrect ENDPOINT_EPNUM_MASK mask preventing endpoints above EP3 from being selected (thanks to Jonathan Oakley) | ||
| 1142 | * - Removed STREAM_CALLBACK() macro - callbacks now use regular function definitions to clarify user code | ||
| 1143 | * - Removed DESCRIPTOR_COMPARATOR() macro - comparators should now use regular function definitions to clarify user code | ||
| 1144 | * - USB_IsConnected is now cleared before the USB_Disconnect() event is fired in response to VBUS being removed | ||
| 1145 | * - Fixed incorrect PID value being used in the USBtoSerial project (thanks to Phill) | ||
| 1146 | * - Deleted StdDescriptors.c, renamed USB_GetDescriptor() to CALLBACK_USB_GetDescriptor, moved ConfigDescriptor.c/.h from the | ||
| 1147 | * LUFA/Drivers/USB/Class/ directory to LUFA/Drivers/USB/HighLevel/ in preparation for the new USB class APIs | ||
| 1148 | * - Moved out each demos' functionality library files (e.g. Ring Buffer library) to /Lib directories for a better directory structure | ||
| 1149 | * - Removed Tx interrupt from the USBtoSerial demo; now sends characters via polling to ensure more time for the Rx interrupt | ||
| 1150 | * - Fixed possible enumeration errors from spin-loops which may fail to exit if the USB connection is severed before the exit condition | ||
| 1151 | * becomes true | ||
| 1152 | * | ||
| 1153 | * | ||
| 1154 | * \section Sec_ChangeLog090510 Version 090510 | ||
| 1155 | * | ||
| 1156 | * - Added new GenericHIDHost demo | ||
| 1157 | * - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use | ||
| 1158 | * - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR | ||
| 1159 | * - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile | ||
| 1160 | * time options | ||
| 1161 | * - All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected | ||
| 1162 | * - Added new PIMA_DATA_SIZE() define to the Still Image Host demo | ||
| 1163 | * - Add call to MassStore_WaitForDataReceived() in MassStore_GetReturnedStatus() to ensure that the CSW has been received in the | ||
| 1164 | * extended MSC timeout period before continuing, to prevent long processing delays from causing the MassStore_GetReturnedStatus() | ||
| 1165 | * to early-abort (thanks to Dmitry Maksimov) | ||
| 1166 | * - Move StdRequestType.h, StreamCallbacks.h, USBMode.h from the LowLevel USB driver directory to the HighLevel USB driver directory, | ||
| 1167 | * where they are more suited | ||
| 1168 | * - Removed all binary constants and replaced with decimal or hexadecimal constants so that unpatched GCC compilers can still build the | ||
| 1169 | * code without having to be itself patched and recompiled first | ||
| 1170 | * - Added preprocessor checks and documentation to the bootloaders giving information about missing SIGNATURE_x defines due to | ||
| 1171 | * outdated avr-libc versions. | ||
| 1172 | * - Added support to the CDCHost demo for devices with multiple CDC interfaces which are not the correct ACM type preceding the desired | ||
| 1173 | * ACM CDC interface | ||
| 1174 | * - Fixed GenericHID demo not starting USB and HID management tasks when not using interrupt driven modes (thanks to Carl Kjeldsen) | ||
| 1175 | * - Fixed RNDISEthenet demo checking the incorrect message field for packet size constraints (thanks to Jonathan Oakley) | ||
| 1176 | * - Fixed WriteNextReport code in the GenericHIDHost demo using incorrect parameter types and not selecting the correct endpoint | ||
| 1177 | * - Adjusted sample CTC timer calculations in the AudioOutput and AudioInput demos to match the CTC calculations in the AVR datasheet, | ||
| 1178 | * and to fix instances where rounding caused the endpoint to underflow (thanks to Robin Theunis) | ||
| 1179 | * - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0), so that other control type | ||
| 1180 | * pipes can be used with the function | ||
| 1181 | * - The USB Host management task now saves and restores the currently selected pipe before and after the task completes | ||
| 1182 | * - Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev) | ||
| 1183 | * - Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favor of new Endpoint_ClearIN(), Endpoint_ClearOUT(), | ||
| 1184 | * Pipe_ClearIN() and Pipe_ClearOUT() macros (done to allow for the detection of packets of zero length) | ||
| 1185 | * - Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API | ||
| 1186 | * - Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been | ||
| 1187 | * renamed to Endpoint_ClearSETUP(), the Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent() and the | ||
| 1188 | * Pipe_ClearSetupSent() macro is no longer applicable and should be removed - changes made to compliment the new endpoint and pipe | ||
| 1189 | * bank management API | ||
| 1190 | * - Updated all demos, bootloaders and projects to use the new endpoint and pipe management APIs (thanks to Roman Thiel from Curetis AG) | ||
| 1191 | * - Updated library Doxygen documentation, added groups, changed documentation macro functions to real functions for clarity | ||
| 1192 | * - Removed old endpoint and pipe aliased read/write/discard routines which did not have an explicit endian specifier for clarity | ||
| 1193 | * - Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway | ||
| 1194 | * - Renamed the main Drivers/AT90USBXXX directory to Drivers/Peripheral, renamed the Serial_Stream driver to SerialStream | ||
| 1195 | * - Fixed CDC and USBtoSerial demos freezing where buffers were full while still transmitting or receiving (thanks to Peter Hand) | ||
| 1196 | * - Removed "Host_" section of the function names in ConfigDescriptor.h, as most of the routines can now be used in device mode on the | ||
| 1197 | * device descriptor | ||
| 1198 | * - Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name | ||
| 1199 | * - Fixed incorrect HID interface class and subclass values in the Mouse and KeyboardMouse demos (thanks to Brian Dickman) | ||
| 1200 | * - Capitalized the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and | ||
| 1201 | * DSearch_Comp_Return_ErrorCodes_t enums | ||
| 1202 | * - Removed "ERROR" from the enum names in the endpoint and pipe stream error code enums | ||
| 1203 | * - Renamed the USB_PowerOnErrorCodes_t enum to USB_InitErrorCodes_t, renamed the POWERON_ERROR_NoUSBModeSpecified enum value to | ||
| 1204 | * USB_INITERROR_NoUSBModeSpecified | ||
| 1205 | * - Renamed USB_PowerOnFail event to USB_InitFailure | ||
| 1206 | * - Renamed OTG.h header functions to be more consistent with the rest of the library API | ||
| 1207 | * - Changed over all deprecated GCC structure tag initializers to the standardized C99 format (thanks to Mike Alexander) | ||
| 1208 | * - USB_HostRequest renamed to USB_ControlRequest, entire control request header is now read into USB_ControlRequest in Device mode | ||
| 1209 | * rather than having the library pass only partially read header data to the application | ||
| 1210 | * - The USB_UnhandledControlPacket event has had its parameters removed, in favor of accessing the new USB_ControlRequest structure | ||
| 1211 | * - The Endpoint control stream functions now correctly send a ZLP to the host when less data than requested is sent | ||
| 1212 | * - Fixed USB_RemoteWakeupEnabled flag never being set (the REMOTE WAKEUP Set Feature request was not being handled) | ||
| 1213 | * - Renamed the FEATURELESS_CONTROL_ONLY_DEVICE compile-time token to CONTROL_ONLY_DEVICE | ||
| 1214 | * - Endpoint configuration is now refined to give better output when all configurations have static inputs - removed the now useless | ||
| 1215 | * STATIC_ENDPOINT_CONFIGURATION compile time token | ||
| 1216 | * - Fixed SPI driver init function not clearing SPI2X bit when not needed | ||
| 1217 | * - Fixed PREVENT ALLOW MEDIUM REMOVAL command issuing in the MassStorageHost demo using incorrect parameters (thanks to Mike Alex) | ||
| 1218 | * - Fixed MassStorageHost demo broken due to an incorrect if statement test in MassStore_GetReturnedStatus() | ||
| 1219 | * - Fixed reversed signature byte ordering in the CDC bootloader (thanks to Johannes Raschke) | ||
| 1220 | * - Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with faulty devices which do not respect the given | ||
| 1221 | * wLength value when reading in the device descriptor | ||
| 1222 | * - Fixed missing semicolon in the ATAVRUSBRF01 LED board driver code (thanks to Morten Lund) | ||
| 1223 | * - Changed LED board driver code to define dummy LED masks for the first four board LEDs, so that user code can be compiled for boards | ||
| 1224 | * with less than four LEDs without code modifications (thanks to Morten Lund) | ||
| 1225 | * - Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button | ||
| 1226 | * - Serial driver now correctly calculates the baud register value when in double speed mode | ||
| 1227 | * - Init function of the Serial driver is now static inline to product smaller code for the common-case of static init values | ||
| 1228 | * | ||
| 1229 | * | ||
| 1230 | * \section Sec_ChangeLog090401 Version 090401 | ||
| 1231 | * | ||
| 1232 | * - Fixed MagStripe project configuration descriptor containing an unused (blank) endpoint descriptor | ||
| 1233 | * - Incorporated makefile changes by Denver Gingerich to retain compatibility with stock (non-WinAVR) AVR-GCC installations | ||
| 1234 | * - Fixed makefile EEPROM programming targets programming FLASH data in addition to EEPROM data | ||
| 1235 | * - LUFA devices now enumerate correctly with LUFA hosts | ||
| 1236 | * - Fixed Configuration Descriptor search routine freezing when a comparator returned a failure | ||
| 1237 | * - Removed HID report item serial dump in the MouseHostWithParser and KeyboardHostWithParser - useful only for debugging, and | ||
| 1238 | * slowed down the enumeration of HID devices too much | ||
| 1239 | * - Increased the number of bits per track which can be read in the MagStripe project to 8192 when compiled for the AT90USBXXX6/7 | ||
| 1240 | * - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request | ||
| 1241 | * - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission | ||
| 1242 | * next time the device is attached to a host. | ||
| 1243 | * - Added new F_USB compile time constant to the library and makefiles, to give the raw input clock (used to feed the PLL before any | ||
| 1244 | * clock prescaling is performed) frequency, so that the PLL prescale mask can be determined | ||
| 1245 | * - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with | ||
| 1246 | * badly designed hosts or devices which greatly exceed the USB specification limits | ||
| 1247 | * - Mass Storage Host demo now uses a USB_STREAM_TIMEOUT_MS of two seconds to maintain compatibility with poorly designed devices | ||
| 1248 | * - Function attribute ATTR_ALWAYSINLINE renamed to ATTR_ALWAYS_INLINE to match other function attribute macro naming conventions | ||
| 1249 | * - Added ATTR_ALWAYS_INLINE attribute to several key inlined library components, to ensure they are inlined in all circumstances | ||
| 1250 | * - Removed SetSystemClockPrescaler() macro, the clock_prescale_set() avr-libc macro has been corrected in recent avr-libc versions | ||
| 1251 | * - Fixed incorrect/missing control status stage transfers on demos, bootloaders and applications (thanks to Nate Lawson) | ||
| 1252 | * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded | ||
| 1253 | * to also remove parts of the Get Status chapter 9 request to further reduce code usage | ||
| 1254 | * - Makefile updated to include output giving the currently selected BOARD parameter value | ||
| 1255 | * - Board Dataflash driver now allows for dataflash ICs which use different shifts for setting the current page/byte address (thanks | ||
| 1256 | * to Kenneth Clubb) | ||
| 1257 | * - Added DataflashManager_WriteBlocks_RAM() and DataflashManager_ReadBlocks_RAM() functions to the MassStorage demo, to allow for easy | ||
| 1258 | * interfacing with a FAT library for dataflash file level access | ||
| 1259 | * - Corrected CDC class bootloader to fix a few bugs, changed address counter to store x2 addresses for convenience | ||
| 1260 | * - Fixed typos in the SPI driver SPI_SPEED_FCPU_DIV_64 and SPI_SPEED_FCPU_DIV_128 masks (thanks to Markus Zocholl) | ||
| 1261 | * - Keyboard and Mouse device demos (normal, data interrupt and fully interrupt driven) combined into unified keyboard and mouse demos | ||
| 1262 | * - Keyboard and Mouse host demos (normal and data interrupt driven) combined into unified keyboard and mouse demos | ||
| 1263 | * - Removed AVRISP_Programmer project due to code quality concerns | ||
| 1264 | * - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incoming data | ||
| 1265 | * - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg) | ||
| 1266 | * - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg) | ||
| 1267 | * - Fixed incorrect ADC driver init register manipulation (thanks to Tobias) | ||
| 1268 | * - Added new GenericHID device demo application | ||
| 1269 | * - Fixed Still Image Host SImage_SendData() function not clearing the pipe bank after sending data | ||
| 1270 | * | ||
| 1271 | * | ||
| 1272 | * \section Sec_ChangeLog090209 Version 090209 | ||
| 1273 | * | ||
| 1274 | * - PWM timer mode in AudioOut demo changed to Fast PWM for speed | ||
| 1275 | * - Updated Magstripe project to work with the latest hardware revision | ||
| 1276 | * - Fixed library not responding to the BCERRI flag correctly in host mode, leading to device lockups | ||
| 1277 | * - Fixed library handling Get Descriptor requests when not addressed as standard requests to the device or interface (thanks to | ||
| 1278 | * Nate Lawson) | ||
| 1279 | * - Fixed serious data corruption issue in MassStorage demo dataflash write routine | ||
| 1280 | * - Added new NO_CLEARSET_FEATURE_REQUEST compile time token | ||
| 1281 | * - USB task now restores previous global interrupt state after execution, rather than forcing global interrupts to be enabled | ||
| 1282 | * - Fixed USB_DeviceEnumerationComplete event firing after each configuration change, rather than once after the initial configuration | ||
| 1283 | * - Added ENDPOINT_DOUBLEBANK_SUPPORTED() macros to Endpoint.h, altered ENDPOINT_MAX_SIZE() to allow user to specify endpoint | ||
| 1284 | * - ENDPOINT_MAX_ENDPOINTS changed to ENDPOINT_TOTAL_ENDPOINTS, PIPE_MAX_PIPES changed to PIPE_TOTAL_PIPES | ||
| 1285 | * - Endpoint and Pipe non-control stream functions now ensure endpoint or pipe is ready before reading or writing | ||
| 1286 | * - Changed Teensy bootloader to use a watchdog reset when exiting rather than a software jump | ||
| 1287 | * - Fixed integer promotion error in MassStorage and MassStorageHost demos, corrupting read/write transfers | ||
| 1288 | * - SPI_SendByte is now SPI_TransferByte, added new SPI_SendByte and SPI_ReceiveByte functions for fast one-way transfer | ||
| 1289 | * - MassStorage demo changed to use new fast one-way SPI transfers to increase throughput | ||
| 1290 | * - MassStorage handling of Mass Storage Reset class request improved | ||
| 1291 | * - Altered MassStorage demo dataflash block read code for speed | ||
| 1292 | * - Added USB_IsSuspended global flag | ||
| 1293 | * - Simplified internal Dual Mode (OTG) USB library code to reduce code size | ||
| 1294 | * - Extended stream timeout period to 100ms from 50ms | ||
| 1295 | * - Mass Storage Host demo commands now all return an error code from the Pipe_Stream_RW_ErrorCodes_t enum | ||
| 1296 | * - Added SubErrorCode parameter to the USB_DeviceEnumerationFailed event | ||
| 1297 | * - VBUS drop interrupt now disabled during the manual-to-auto VBUS delivery handoff | ||
| 1298 | * - Simplified low level backend so that device/host mode initialization uses the same code paths | ||
| 1299 | * - Added workaround for faulty Mass Storage devices which do not implement the required GET_MAX_LUN request | ||
| 1300 | * - Removed buggy Telnet application from the RNDIS demo | ||
| 1301 | * - Moved Mass Storage class requests in the Mass Storage Host demo to wrapper functions in MassStoreCommands.c | ||
| 1302 | * - Fixed incorrect SCSI command size value in the Request Sense command in MassStoreCommands.c | ||
| 1303 | * - Added SetProtocol request to HID class non-parser Mouse and Keyboard demos to force devices to use the correct Boot Protocol | ||
| 1304 | * - Added new "dfu" and "flip" programming targets to project makefiles | ||
| 1305 | * - HID_PARSE_Sucessful enum member typo corrected to HID_PARSE_Successful | ||
| 1306 | * - Changed COLLECTION item structures in the HID descriptor parser to include the collection's Usage Page value | ||
| 1307 | * - Serial driver now sets Tx line as output, enables pull-up on Rx line | ||
| 1308 | * - Fixed smaller USB AVRs raising multiple connection and disconnection events when NO_LIMITED_CONTROLLER_CONNECT is disabled | ||
| 1309 | * - Added HOST_DEVICE_SETTLE_DELAY_MS to give the host delay after a device is connected before it is enumerated | ||
| 1310 | * - Fixed KeyboardHostWithParser demo linking against the wrong global variables | ||
| 1311 | * - Completed doxygen documentation of remaining library bootloaders, demos and projects | ||
| 1312 | * - Fixed incorrect bootloader start address in the TeensyHID bootloader | ||
| 1313 | * - Added HWB button whole-disk ASCII dump functionality to MassStoreHost demo | ||
| 1314 | * - Replaced printf_P(PSTR("%c"), {Variable}) calls with putchar(<Variable>) for speed and size savings | ||
| 1315 | * - Serial driver now accepts baud rates over 16-bits in size, added double speed flag option | ||
| 1316 | * - Fixed incorrect callback abort return value in Pipe.c | ||
| 1317 | * - Added new flip-ee and dfu-ee makefile targets (courtesy of Opendous Inc.) | ||
| 1318 | * - Removed reboot-on-disconnect code from the TeensyHID bootloader, caused problems on some systems | ||
| 1319 | * - Fixed AudioOutput and AudioInput demos looping on the endpoint data, rather than processing a sample at a time and returning | ||
| 1320 | * each time the task runs to allow for other tasks to execute | ||
| 1321 | * - Added support for the Atmel ATAVRUSBRF01 board | ||
| 1322 | * - Added AVRISP Programmer Project, courtesy of Opendous Inc. | ||
| 1323 | * - Fixed CDC Host demo not searching through both CDC interfaces for endpoints | ||
| 1324 | * - Fixed incorrect Product String descriptor length in the DFU class bootloader | ||
| 1325 | * | ||
| 1326 | * | ||
| 1327 | * \section Sec_ChangeLog081224 Version 081224 | ||
| 1328 | * | ||
| 1329 | * - MyUSB name changed to LUFA, the Lightweight USB Framework for AVRs | ||
| 1330 | * - Fixed Mass Storage Host demo's MassStore_SendCommand() delay in the incorrect place | ||
| 1331 | * - Fixed USBtoSerial demo not calling ReconfigureUSART() after a change in the line encoding | ||
| 1332 | * - Fixed infinite loop in host mode Host-to-Device control transfers with data stages | ||
| 1333 | * - HID report parser now supports devices with multiple reports in one interface via Report IDs | ||
| 1334 | * - Fixed RZUSBSTICK board LED driver header incorrect macro definition order causing compile errors | ||
| 1335 | * - Calling USB_Init() when the USB interface is already configured now forces a complete interface reset | ||
| 1336 | * and re-enumeration - fixes MyUSB DFU bootloader not switching to app code correctly when soft reset used | ||
| 1337 | * - Fixed "No newline at end of file" warning when stream callbacks are enabled | ||
| 1338 | * - DFU bootloader now uses fixed signature bytes per device, rather than reading them out dynamically for size | ||
| 1339 | * - Added new FIXED_CONTROL_ENDPOINT_SIZE and USE_SINGLE_DEVICE_CONFIGURATION switches to statically define certain values to | ||
| 1340 | * reduce compiled binary size | ||
| 1341 | * - Added new NO_LIMITED_CONTROLLER_CONNECT switch to prevent the library from trying to determine bus connection | ||
| 1342 | * state from the suspension and wake up events on the smaller USB AVRs | ||
| 1343 | * - Added summary of all library compile time tokens to the documentation | ||
| 1344 | * - Added overview of the LUFA scheduler to the documentation | ||
| 1345 | * - Removed MANUAL_PLL_CONTROL compile time token, replaced with a mask for the USB_Init() Options parameter | ||
| 1346 | * - CDC bootloader now uses the correct non-far or far versions of the pgm_* functions depending on if RAMPZ is defined | ||
| 1347 | * - Doxygen documentation now contains documentation on all the projects, bootloaders and most demos included with the library | ||
| 1348 | * - CDC bootloader now runs user application when USB disconnected rather than waiting for a hard reset | ||
| 1349 | * - MouseHostWithParser and KeyboardHostWithParser now support multiple-report devices | ||
| 1350 | * - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver | ||
| 1351 | * - Fixed the DFU bootloader, no longer freezes up when certain files are programmed into an AVR, made reading/writing faster | ||
| 1352 | * - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal | ||
| 1353 | * right-handed system | ||
| 1354 | * - Added stub code to the CDC and USBtoSerial demos showing how to read and set the RS-232 handshake lines - not currently used in | ||
| 1355 | * the demos, but the example code and supporting defines are now in place | ||
| 1356 | * - Interrupts are now disabled when processing a control request in device mode, to avoid exceeding the strict control request | ||
| 1357 | * timing requirements. | ||
| 1358 | * - All demos now use a central StatusUpdate() function rather than direct calls to the board LED functions, so that the demos can | ||
| 1359 | * easily be altered to show different LED combinations (or do something else entirely) as the demo's status changes | ||
| 1360 | * - Removed LED commands from the CDC bootloader, unused by most AVR910 programming software | ||
| 1361 | * - Fixed RNDIS demo ICMP ping requests echoing back incorrect data | ||
| 1362 | * - Added DHCP server code to RNDIS demo, allowing for hands-free auto configuration on any PC | ||
| 1363 | * - Fixed DFU bootloader PID value for the ATMEGA16U4 AVR | ||
| 1364 | * - Endpoint and Pipe configuration functions now return an error code indicating success or failure | ||
| 1365 | * - USB Reset in device mode now resets and disables all device endpoints | ||
| 1366 | * - Added intermediate states to the host mode state machine, reducing the USB task blocking time to no more than 1ms explicitly per | ||
| 1367 | * invocation when in host mode | ||
| 1368 | * - Added support for the ATMEGA32U6 microcontroller | ||
| 1369 | * - Added STATIC_ENDPOINT_CONFIGURATION compile time option, enabled in the bootloaders to minimize space usage | ||
| 1370 | * - Removed redundant code from the USB device GetStatus() chapter 9 processing routine | ||
| 1371 | * - Added new TeensyHID bootloader, compatible with the Teensy HID protocol (http://www.pjrc.com/teensy/) | ||
| 1372 | * - Versions are now numbered by release dates, rather than arbitrary major/minor revision numbers | ||
| 1373 | * - USB_RemoteWakeupEnabled is now correctly set and cleared by SetFeature and ClearFeature requests from the host | ||
| 1374 | * - Changed prototype of GetDescriptor, so that it now returns the descriptor size (or zero if the descriptor doesn't exist) | ||
| 1375 | * rather than passing the size back to the caller through a parameter and returning a boolean | ||
| 1376 | * | ||
| 1377 | * | ||
| 1378 | * \section Sec_ChangeLog153 Version 1.5.3 (081002) | ||
| 1379 | * | ||
| 1380 | * - Fixed CDC bootloader using pgmspace macros for some descriptors inappropriately | ||
| 1381 | * - Updated all Mouse and Keyboard device demos to include boot protocol support (now works in BIOS) | ||
| 1382 | * - Renamed bootloader directories to remove spaces, which were causing build problems on several OSes | ||
| 1383 | * - Removed serial number strings from all but the MassStore demo where it is required - users were not | ||
| 1384 | * modifying the code to either omit the descriptor or use a unique serial per device causing problems | ||
| 1385 | * when multiple units of the same device were plugged in at the same time | ||
| 1386 | * - AudioOutput and AudioInput demos now correctly silence endpoints when not enabled by the host | ||
| 1387 | * - Added KeyboardMouse demo (Keyboard and Mouse functionality combined into a single demo) | ||
| 1388 | * - Added DriverStubs directory to house board level driver templates, to make MyUSB compatible custom board | ||
| 1389 | * driver creation easier | ||
| 1390 | * - Extended MassStorage demo to support multiple LUNs, 2 by default | ||
| 1391 | * - Fixed incorrect device address mask, preventing the device from enumerating with addresses larger than 63 | ||
| 1392 | * - Fixed incorrect data direction mask in the GetStatus standard request, preventing it from being handled | ||
| 1393 | * - Fixed incorrect GetStatus standard request for endpoints, now returns the endpoint STALL status correctly | ||
| 1394 | * - Added in new USB_RemoteWakeupEnabled and USB_CurrentlySelfPowered flags rather than using fixed values | ||
| 1395 | * - Added DualCDC demo to demonstrate the use of Interface Association Descriptors | ||
| 1396 | * - Added pipe NAK detection and clearing API | ||
| 1397 | * - Added pipe status change (NAK, STALL, etc.) interrupt API | ||
| 1398 | * - Fixed MassStorageHost demo so that it no longer freezes randomly when issuing several commands in a row | ||
| 1399 | * - Host demos configuration descriptor routines now return a unique error code when the returned data does | ||
| 1400 | * not have a valid configuration descriptor header | ||
| 1401 | * - Added Endpoint_WaitUntilReady() and Pipe_WaitUntilReady() functions | ||
| 1402 | * - Stream functions now have software timeouts, timeout period can be set by the USB_STREAM_TIMEOUT_MS token | ||
| 1403 | * - All demos now pass the USB.org automated Chapter 9 device compliance tests | ||
| 1404 | * - All HID demos now pass the USB.org automated HID compliance tests | ||
| 1405 | * - Polling interval of the interrupt endpoint in the CDC based demos changed to 0xFF to fix problems on Linux systems | ||
| 1406 | * - Changed stream functions to accept a new callback function, with NO_STREAM_CALLBACKS used to disable all callbacks | ||
| 1407 | * - Mass Storage demo Dataflash management routines changed to use the endpoint stream functions | ||
| 1408 | * - Added AVRStudio project files for each demo in addition to the existing Programmer's Notepad master project file | ||
| 1409 | * - Re-added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes | ||
| 1410 | * are reflected in the hardware (change was previously lost) | ||
| 1411 | * | ||
| 1412 | * | ||
| 1413 | * \section Sec_ChangeLog152 Version 1.5.2 (080731) | ||
| 1414 | * | ||
| 1415 | * - Fixed SwapEndian_32() function in Common.h so that it now works correctly (wrong parameter types) | ||
| 1416 | * - Updated RNDIS demo - notification endpoint is no longer blocking so that it works with faulty Linux RNDIS | ||
| 1417 | * implementations (where the notification endpoint is ignored in favor of polling the control endpoint) | ||
| 1418 | * - Fixed incorrect Vendor Description string return size in RNDIS demo for the OID_GEN_VENDOR_DESCRIPTION OID token | ||
| 1419 | * - Added very basic TCP/IP stack and HTTP/TELNET servers to RNDIS demo | ||
| 1420 | * - Fixed DFU bootloader exit causing programming software to complain about failed writes | ||
| 1421 | * - Fixed DFU bootloader EEPROM programming mode wiping first flash page | ||
| 1422 | * - Fixed Clear/Set Feature device standard request processing code (fixing MassStorage demo in the process) | ||
| 1423 | * - Added support for the ATMEGA16U4 AVR microcontroller | ||
| 1424 | * - Library license changed from LGPLv3 to MIT license | ||
| 1425 | * | ||
| 1426 | * | ||
| 1427 | * \section Sec_ChangeLog151 Version 1.5.1 (080707) | ||
| 1428 | * | ||
| 1429 | * - Changed host demos to enable the host function task on the firing of the USB_DeviceEnumerationComplete event | ||
| 1430 | * rather than the USB_DeviceAttached event | ||
| 1431 | * - HID Usage Stack now forcefully cleared after an IN/OUT/FEATURE item has been completely processed to remove | ||
| 1432 | * any referenced but not created usages | ||
| 1433 | * - Changed USB_INT_DisableAllInterrupts() and USB_INT_ClearAllInterrupts(), USB_Host_GetNextDescriptorOfType(), | ||
| 1434 | * USB_Host_GetNextDescriptorOfTypeBefore(), USB_Host_GetNextDescriptorOfTypeAfter() to normal functions (from inline) | ||
| 1435 | * - Fixed USBtoSerial demo not sending data, only receiving | ||
| 1436 | * - Fixed main makefile to make all by default, fixed MagStripe directory case to prevent case-sensitive path problems | ||
| 1437 | * - ConfigDescriptor functions made normal, instead of static inline | ||
| 1438 | * - Pipe/Endpoint *_Ignore_* functions changed to *_Discard_*, old names still present as aliases | ||
| 1439 | * - Fixed ENDPOINT_MAX_SIZE define to be correct on limited USB controller AVRs | ||
| 1440 | * - Changed endpoint and pipe size translation routines to use previous IF/ELSE IF cascade code, new algorithmic | ||
| 1441 | * approach was buggy and caused problems | ||
| 1442 | * - Bootloaders now compile with -fno-inline-small-functions option to reduce code size | ||
| 1443 | * - Audio demos now use correct endpoint sizes for full and limited controller USB AVRs, double banking in all cases | ||
| 1444 | * to be in line with the specification (isochronous endpoints MUST be double banked) | ||
| 1445 | * - Added Interface Association descriptor to StdDescriptors.h, based on the relevant USB2.0 ECN | ||
| 1446 | * - Fixed MIDI demo, corrected Audio Streaming descriptor to follow the MIDI-specific AS structure | ||
| 1447 | * - Fixed HID class demo descriptors so that the HID interface's protocol is 0x00 (required for non-boot protocol HID | ||
| 1448 | * devices) to prevent problems on hosts expecting the boot protocol functions to be supported | ||
| 1449 | * - Added read/write control stream functions to Endpoint.h | ||
| 1450 | * - Fixed AudioOut demo not setting port pins to inputs on USB disconnect properly | ||
| 1451 | * - Added RNDISEthernet demo application | ||
| 1452 | * | ||
| 1453 | * | ||
| 1454 | * \section Sec_ChangeLog150 Version 1.5.0 (080610) | ||
| 1455 | * | ||
| 1456 | * - Fixed MIDI demo, now correctly waits for the endpoint to be ready between multiple note messages | ||
| 1457 | * - Added CDC Host demo application | ||
| 1458 | * - Added KeyboardFullInt demo application | ||
| 1459 | * - Endpoint and Pipe creation routines now mask endpoint/pipe size with the size mask, to remove transaction | ||
| 1460 | * size bits not required for the routines (improves compatibility with devices) | ||
| 1461 | * - Fixed AudioInput demo - now correctly sends sampled audio to the host PC | ||
| 1462 | * - Fixed AudioOutput demo once more -- apparently Windows requires endpoint packets to be >=192 bytes | ||
| 1463 | * - Shrunk round-robin scheduler code slightly via the use of struct pointers rather than array indexes | ||
| 1464 | * - Fixed off-by-one error when determining if the Usage Stack is full inside the HID Report parser | ||
| 1465 | * - Renamed Magstripe.h to MagstripeHW.h and moved driver out of the library and into the MagStripe demo folder | ||
| 1466 | * - Added preprocessor checks to enable C linkage on the library components when used with a C++ compiler | ||
| 1467 | * - Added Still Image Host demo application | ||
| 1468 | * - The USB device task now restores the previously selected endpoint, allowing control requests to be transparently | ||
| 1469 | * handled via interrupts while other endpoints are serviced through polling | ||
| 1470 | * - Fixed device signature being sent in reverse order in the CDC bootloader | ||
| 1471 | * - Host demos now have a separate ConfigDescriptor.c/.h file for configuration descriptor processing | ||
| 1472 | * - HostWithParser demos now have a separate HIDReport.c/.h file for HID report processing and dumping | ||
| 1473 | * - Removed non-mandatory commands from MassStorage demo to save space, fixed SENSE ResponseCode value | ||
| 1474 | * - CDC demos now send empty packets after sending a full one to prevent buffering issues on the host | ||
| 1475 | * - Updated demo descriptors to use VID/PID values donated by Atmel | ||
| 1476 | * - Added DoxyGen documentation to the source files | ||
| 1477 | * - Fixed Serial_IsCharReceived() definition, was previously reversed | ||
| 1478 | * - Removed separate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead | ||
| 1479 | * - Removed unused Device Qualifier descriptor structure | ||
| 1480 | * - Renamed the USB_CreateEndpoints event to the more appropriate USB_ConfigurationChanged | ||
| 1481 | * - Fixed MassStorageHost demo reading in the block data in reverse | ||
| 1482 | * - Removed outdated typedefs in StdRequestType.h, superseded by the macro masks | ||
| 1483 | * - Corrected OTG.h is now included when the AVR supports both Host and Device modes, for creating OTG products | ||
| 1484 | * - USB_DeviceEnumerationComplete event is now also fired when in device mode and the host has finished its enumeration | ||
| 1485 | * - Interrupt driven demos now properly restore previously selected endpoint when ISR is complete | ||
| 1486 | * - The value of USB_HOST_TIMEOUT_MS can now be overridden in the user project makefile to a custom fixed timeout value | ||
| 1487 | * - Renamed USB_Host_SOFGeneration_* macros to more friendly USB_Host_SuspendBus(), USB_Host_ResumeBus() | ||
| 1488 | * and USB_Host_IsBusSuspended() | ||
| 1489 | * - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistent, Pipe_SetInterruptFreq() is now | ||
| 1490 | * Pipe_SetInterruptPeriod() to use the correct terminology | ||
| 1491 | * - UnicodeString member of USB_Descriptor_String_t struct changed to an ordinary int array type, so that the GCC | ||
| 1492 | * Unicode strings (prefixed with an L before the opening quotation mark) can be used instead of explicit arrays | ||
| 1493 | * of ASCII characters | ||
| 1494 | * - Fixed Endpoint/Pipes being configured incorrectly if the maximum endpoint/pipe size for the selected USB AVR | ||
| 1495 | * model was given as the bank size | ||
| 1496 | * - HID device demos now use a true raw array for the HID report descriptor rather than a struct wrapped array | ||
| 1497 | * - Added VERSION_BCD() macro, fixed reported HID and USB version numbers in demo descriptors | ||
| 1498 | * - Cleaned up GetDescriptor device chapter 9 handler function | ||
| 1499 | * - Added GET_REPORT class specific request to HID demos to make them complaint to the HID class | ||
| 1500 | * - Cleaned up setting of USB_IsInitialized and USB_IsConnected values to only when needed | ||
| 1501 | * - Removed Atomic.c and ISRMacro.h; the library was already only compatible with recent avr-lib-c for other reasons | ||
| 1502 | * - All demos and library functions now use USB standardized names for the USB data (bRequest, wLength, etc.) | ||
| 1503 | * - Added USE_NONSTANDARD_DESCRIPTOR_NAMES token to switch back to the non-standard descriptor element names | ||
| 1504 | * | ||
| 1505 | * | ||
| 1506 | * \section Sec_ChangeLog141 Version 1.4.1 (090519) | ||
| 1507 | * | ||
| 1508 | * - Enhanced KeyboardWithParser demo, now prints out pressed alphanumeric characters like the standard demo | ||
| 1509 | * - Fixed MassStorage demo, read/writes using non mode-10 commands now work correctly | ||
| 1510 | * - Corrected version number in Version.h | ||
| 1511 | * | ||
| 1512 | * | ||
| 1513 | * \section Sec_ChangeLog140 Version 1.4.0 (090505) | ||
| 1514 | * | ||
| 1515 | * - Added HID Report Parser API to the library | ||
| 1516 | * - Added Mouse and Keyboard host demo applications, using the new HID report parser engine | ||
| 1517 | * - Added MouseFullInt demo, which demonstrates a fully interrupt (including control requests) mouse device | ||
| 1518 | * - Fixed incorrect length value in the audio control descriptor of the AudioOutput and AudioInput demos | ||
| 1519 | * - Added MIDI device demo application to the library | ||
| 1520 | * - Fixed problem preventing USB devices from being resumed from a suspended state | ||
| 1521 | * - Added new CDC class bootloader to the library, based on the AVR109 bootloader protocol | ||
| 1522 | * - Added header to each demo application indicating the mode, class, subclass, standards used and supported speed | ||
| 1523 | * - Functions expecting endpoint/pipe numbers are no longer automatically masked against ENDPOINT_EPNUM_MASK or | ||
| 1524 | * PIPE_PIPENUM_MASK - this should be manually added to code which requires it | ||
| 1525 | * - Fixed DFU class bootloader - corrected frequency of flash page writes, greatly reducing programming time | ||
| 1526 | * - Renamed AVR_HOST_GetDeviceConfigDescriptor() to USB_Host_GetDeviceConfigDescriptor() and AVR_HOST_GetNextDescriptor() | ||
| 1527 | * to USB_Host_GetNextDescriptor() | ||
| 1528 | * - Added new USB_Host_GetNextDescriptorOfTypeBefore() and USB_Host_GetNextDescriptorOfTypeAfter() routines | ||
| 1529 | * - Moved configuration descriptor routines to MyUSB/Drivers/USB/Class/, new accompanying ConfigDescriptors.c file | ||
| 1530 | * - Added new configuration descriptor comparator API for more powerful descriptor parsing, updated host demos to use the | ||
| 1531 | * new comparator API | ||
| 1532 | * - Fixed MassStorageHost demo capacity printout, and changed data read/write mode from little-endian to the correct | ||
| 1533 | * big-endian for SCSI devices | ||
| 1534 | * - Fixed macro/function naming consistency; USB_HOST is now USB_Host, USB_DEV is now USB_Device | ||
| 1535 | * - Added better error reporting to host demos | ||
| 1536 | * - Added 10 microsecond delay after addressing devices in host mode, to prevent control stalls | ||
| 1537 | * | ||
| 1538 | * | ||
| 1539 | * \section Sec_ChangeLog132 Version 1.3.2 (080401) | ||
| 1540 | * | ||
| 1541 | * - Added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes | ||
| 1542 | * are reflected in the hardware | ||
| 1543 | * - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the | ||
| 1544 | * GetLineCoding request had an incorrect RequestType mask preventing it from being processed | ||
| 1545 | * - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full | ||
| 1546 | * - Device control endpoint size is now determined from the device's descriptors rather than being fixed | ||
| 1547 | * - Separated out SPI code into new SPI driver in AT90USBXXX driver directory | ||
| 1548 | * - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID | ||
| 1549 | * - Added support for the RZUSBSTICK board | ||
| 1550 | * - Bicolour driver removed in favor of generic LEDs driver | ||
| 1551 | * - Added support for the ATMEGA32U4 AVR | ||
| 1552 | * - Added MANUAL_PLL_CONTROL compile time option to prevent the USB library from manipulating the PLL | ||
| 1553 | * | ||
| 1554 | * | ||
| 1555 | * \section Sec_ChangeLog131 Version 1.3.1 (080319) | ||
| 1556 | * | ||
| 1557 | * - Fixed USB to Serial demo - class value in the descriptors was incorrect | ||
| 1558 | * - Control endpoint size changed from 64 bytes to 8 bytes to save on USB FIFO RAM and to allow low | ||
| 1559 | * speed mode devices to enumerate properly | ||
| 1560 | * - USB to Serial demo data endpoints changed to dual-banked 16 byte to allow the demo to work | ||
| 1561 | * on USB AVRs with limited USB FIFO RAM | ||
| 1562 | * - Changed demo endpoint numbers to use endpoints 3 and 4 for double banking, to allow limited | ||
| 1563 | * USB device controller AVRs (AT90USB162, AT90USB82) to function correctly | ||
| 1564 | * - Updated Audio Out demo to use timer 1 for AVRs lacking a timer 3 for the PWM output | ||
| 1565 | * - Fixed incorrect USB_DEV_OPT_HIGHSPEED entry in the Mass Storage device demo makefile | ||
| 1566 | * - Optimized Mass Storage demo for a little extra transfer speed | ||
| 1567 | * - Added LED indicators to the Keyboard demo for Caps Lock, Num Lock and Scroll Lock | ||
| 1568 | * - Added Endpoint_Read_Stream, Endpoint_Write_Stream, Pipe_Read_Stream and Pipe_Write_Stream functions | ||
| 1569 | * (including Big and Little Endian variants) | ||
| 1570 | * - Made Dataflash functions inline for speed, removed now empty Dataflash.c driver file | ||
| 1571 | * - Added new SetSystemClockPrescaler() macro (thanks to Joerg Wunsch) | ||
| 1572 | * - Fixed Endpoint_ClearStall() to function correctly on full USB controller AVRs (AT90USBXXX6/7) | ||
| 1573 | * - Endpoint_Setup_In_Clear() and Endpoint_Setup_Out_Clear() no longer set FIFOCON, in line with the | ||
| 1574 | * directives in the datasheet | ||
| 1575 | * - Fixed PLL prescaler defines for all AVR models and frequencies | ||
| 1576 | * - Fixed ENDPOINT_INT_IN and ENDPOINT_INT_OUT definitions | ||
| 1577 | * - Added interrupt driven keyboard and mouse device demos | ||
| 1578 | * - Combined USB_Device_ClearFeature and USB_Device_SetFeature requests into a single routine for code | ||
| 1579 | * size savings | ||
| 1580 | * - Added missing Pipe_GetCurrentPipe() macro to Pipe.h | ||
| 1581 | * | ||
| 1582 | * | ||
| 1583 | * \section Sec_ChangeLog130 Version 1.3.0 (080307) | ||
| 1584 | * | ||
| 1585 | * - Unnecessary control endpoint config removed from device mode | ||
| 1586 | * - Fixed device standard request interpreter accidentally processing some class-specific requests | ||
| 1587 | * - Added USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS compile time options to instruct the library | ||
| 1588 | * to use descriptors stored in RAM or EEPROM rather than flash memory | ||
| 1589 | * - All demos now disable watchdog on startup, in case it has been enabled by fuses or the bootloader | ||
| 1590 | * - USB_DEV_OPT_LOWSPEED option now works correctly | ||
| 1591 | * - Added ability to set the USB options statically for a binary size reduction via the USE_STATIC_OPTIONS | ||
| 1592 | * compile time define | ||
| 1593 | * - USB_Init no longer takes a Mode parameter if compiled for a USB device with no host mode option, or | ||
| 1594 | * if forced to a particular mode via the USB_HOST_ONLY or USB_DEVICE_ONLY compile time options | ||
| 1595 | * - USB_Init no longer takes an Options parameter if options statically configured by USE_STATIC_OPTIONS | ||
| 1596 | * - Endpoint_Ignore_* and Pipe_Ignore_* made smaller by making the dummy variable non-volatile so that the | ||
| 1597 | * compiler can throw away the result more efficiently | ||
| 1598 | * - Added in an optional GroupID value to each scheduler entry, so that groups of tasks can once again be | ||
| 1599 | * controlled by the new Scheduler_SetGroupTaskMode() routine | ||
| 1600 | * - Added support for AT90USB162 and AT90USB82 AVR models | ||
| 1601 | * - Added support for the STK525 and STK526 boards | ||
| 1602 | * - Added support for custom board drivers to be supplied by selecting the board type as BOARD_USER, and | ||
| 1603 | * placing board drivers in {Application Directory}/Board/ | ||
| 1604 | * - PLL is now stopped and USB clock is frozen when detached from host in device mode, to save power | ||
| 1605 | * - Joystick defines are now in sync with the schematics - orientation will be rotated for the USBKEY | ||
| 1606 | * - Fixed USB_DEV_IsUSBSuspended() - now checks the correct register | ||
| 1607 | * - Fixed data transfers to devices when in host mode | ||
| 1608 | * - Renamed USB_DEV_OPT_HIGHSPEED to USB_DEV_OPT_FULLSPEED and USB_HOST_IsDeviceHighSpeed() to | ||
| 1609 | * USB_HOST_IsDeviceFullSpeed() to be in line with the official USB speed names (to avoid confusion with | ||
| 1610 | * the real high speed mode, which is unavailable on the USB AVRs) | ||
| 1611 | * | ||
| 1612 | * | ||
| 1613 | * \section Sec_ChangeLog120 Version 1.2.0 (080204) | ||
| 1614 | * | ||
| 1615 | * - Added USB_DeviceEnumerationComplete event for host mode | ||
| 1616 | * - Added new Scheduler_Init routine to prepare the scheduler, so that tasks can be started and | ||
| 1617 | * stopped before the scheduler has been started (via Scheduler_Start) | ||
| 1618 | * - Connection events in both Device and Host mode are now interrupt-driven, allowing the USB management | ||
| 1619 | * task to be stopped when the USB is not connected to a host or device | ||
| 1620 | * - All demos updated to stop the USB task when not in use via the appropriate USB events | ||
| 1621 | * - Mass Storage Host demo application updated to function correctly with all USB flash disks | ||
| 1622 | * - Mass Storage Host demo application now prints out the capacity and number of LUNs in the attached | ||
| 1623 | * device, and prints the first block as hexadecimal numbers rather than ASCII characters | ||
| 1624 | * - Endpoint and Pipe clearing routines now clear the Endpoint/Pipe interrupt and status flags | ||
| 1625 | * - Shifted error handling code in the host enum state machine to a single block, to reduce code complexity | ||
| 1626 | * - Added in DESCRIPTOR_TYPE, DESCRIPTOR_SIZE and DESCRIPTOR_CAST macros to make config descriptor processing | ||
| 1627 | * clearer in USB hosts and DESCRIPTOR_ADDRESS for convenience in USB devices | ||
| 1628 | * - Added in alloca macro to common.h, in case the user is using an old version of avr-lib-c missing the macro | ||
| 1629 | * | ||
| 1630 | * | ||
| 1631 | * \section Sec_ChangeLog110 Version 1.1.0 (080125) | ||
| 1632 | * | ||
| 1633 | * - Fixed DCONNI interrupt being enabled accidentally after a USB reset | ||
| 1634 | * - Fixed DDISCI interrupt not being disabled when a device is not connected | ||
| 1635 | * - Added workaround for powerless pull-up devices causing false disconnect interrupts | ||
| 1636 | * - Added USB_DeviceEnumerationFailed event for Host mode | ||
| 1637 | * - AVR_HOST_GetDeviceConfigDescriptor routine no longer modifies ConfigSizePtr if a valid buffer | ||
| 1638 | * pointer is passed | ||
| 1639 | * - Added ALLOCABLE_BYTES to DynAlloc, and added code to make the size of key storage variables | ||
| 1640 | * dependent on size of memory parameters passed in via the user project's makefile | ||
| 1641 | * - Fixed incorrect device reset routine being called in USBTask | ||
| 1642 | * - Devices which do not connect within the standard 300mS are now supported | ||
| 1643 | * - Removed incorrect ATTR_PURE from Scheduler_SetTaskMode(), which was preventing tasks from being | ||
| 1644 | * started/stopped, as well as USB_InitTaskPointer(), which was breaking dual device/host USB projects | ||
| 1645 | * - Changed scheduler to use the task name rather than IDs for setting the task mode, eliminating the | ||
| 1646 | * need to have a task ID list | ||
| 1647 | * - ID transition interrupt now raises the appropriate device/host disconnect event if device attached | ||
| 1648 | * - Fixed double VBUS change (and VBUS -) event when detaching in device mode | ||
| 1649 | * - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile | ||
| 1650 | * - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and | ||
| 1651 | * Endpoint_IsConfigured() after calling the config functions to determine success | ||
| 1652 | */ | ||
| 1653 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/CompileTimeTokens.txt b/lib/lufa/LUFA/DoxygenPages/CompileTimeTokens.txt new file mode 100644 index 000000000..92adf0dcc --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/CompileTimeTokens.txt | |||
| @@ -0,0 +1,223 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_TokenSummary Summary of Compile Tokens | ||
| 8 | * | ||
| 9 | * The following lists all the possible tokens which can be defined in a project makefile, and passed to the | ||
| 10 | * compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour, | ||
| 11 | * or remove features unused by a given application in order to save flash space. | ||
| 12 | * | ||
| 13 | * \note If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located | ||
| 14 | * in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile | ||
| 15 | * defined tokens for configuring the library. | ||
| 16 | * | ||
| 17 | * \section Sec_TokenSummary_NonUSBTokens Non USB Related Tokens | ||
| 18 | * This section describes compile tokens which affect non-USB sections of the LUFA library. | ||
| 19 | * | ||
| 20 | * \li <b>DISABLE_TERMINAL_CODES</b> - (\ref Group_Terminal) - <i>All Architectures</i> \n | ||
| 21 | * If an application contains ANSI terminal control codes listed in TerminalCodes.h, it might be desired to remove them | ||
| 22 | * at compile time for use with a terminal which is non-ANSI control code aware, without modifying the source code. If | ||
| 23 | * this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from | ||
| 24 | * the source code at compile time. | ||
| 25 | * | ||
| 26 | * | ||
| 27 | * \section Sec_TokenSummary_USBClassTokens USB Class Driver Related Tokens | ||
| 28 | * This section describes compile tokens which affect USB class-specific drivers in the LUFA library. | ||
| 29 | * | ||
| 30 | * \li <b>HID_HOST_BOOT_PROTOCOL_ONLY</b> - (\ref Group_USBClassHIDHost) - <i>All Architectures</i> \n | ||
| 31 | * By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID | ||
| 32 | * communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic | ||
| 33 | * Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol | ||
| 34 | * mode can be removed to save space in the compiled application by defining this token. When defined, it is still necessary | ||
| 35 | * to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol(). | ||
| 36 | * | ||
| 37 | * \li <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n | ||
| 38 | * HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This | ||
| 39 | * allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous | ||
| 40 | * state table in a compact manner. This token may be defined to a non-zero 8-bit value to give the maximum depth of the state | ||
| 41 | * table stack. If not defined, this defaults to the value indicated in the HID.h file documentation. | ||
| 42 | * | ||
| 43 | * \li <b>HID_USAGE_STACK_DEPTH</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n | ||
| 44 | * HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession | ||
| 45 | * when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with | ||
| 46 | * different usages in a compact manner. This token may be defined to a non-zero 8-bit value to set the maximum depth of the | ||
| 47 | * usage stack, indicating the maximum number of USAGE items which can be stored temporarily until the next INPUT, OUTPUT | ||
| 48 | * and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation. | ||
| 49 | * | ||
| 50 | * \li <b>HID_MAX_COLLECTIONS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n | ||
| 51 | * HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information | ||
| 52 | * is stored separately in the processed usage structure (and referred to by the data elements in the structure) to save space. | ||
| 53 | * This token may be defined to a non-zero 8-bit value to set the maximum number of COLLECTION items which can be processed by the | ||
| 54 | * parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file | ||
| 55 | * documentation. | ||
| 56 | * | ||
| 57 | * \li <b>HID_MAX_REPORTITEMS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n | ||
| 58 | * All HID reports contain one or more INPUT, OUTPUT and/or FEATURE items describing the data which can be sent to and from the HID | ||
| 59 | * device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which | ||
| 60 | * the report data should be interpreted by the host. This token may be defined to a non-zero 8-bit value to set the maximum number of | ||
| 61 | * data elements which can be stored in the processed HID report structure, including INPUT, OUTPUT and (if enabled) FEATURE items. | ||
| 62 | * If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed separately in the | ||
| 63 | * processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation. | ||
| 64 | * | ||
| 65 | * \li <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - (\ref Group_HIDParser) - <i>All Architectures</i> \n | ||
| 66 | * HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination | ||
| 67 | * keyboard and mouse might use report IDs to separate the keyboard reports from the mouse reports. In order to determine the size of each | ||
| 68 | * report, and thus know how many bytes must be read or written, the size of each report (IN, OUT and FEATURE) must be calculated and | ||
| 69 | * stored. This token may be defined to a non-zero 8-bit value to set the maximum number of report IDs in a device which can be processed | ||
| 70 | * and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in | ||
| 71 | * the HID.h file documentation. | ||
| 72 | * | ||
| 73 | * \li <b>NO_CLASS_DRIVER_AUTOFLUSH</b> - (\ref Group_USBClassDrivers) - <i>All Architectures</i> \n | ||
| 74 | * Many of the device and host mode class drivers automatically flush any data waiting to be written to an interface, when the corresponding | ||
| 75 | * USB management task is executed. This is usually desirable to ensure that any queued data is sent as soon as possible once and new data is | ||
| 76 | * constructed in the main program loop. However, if flushing is to be controlled manually by the user application via the *_Flush() commands, | ||
| 77 | * the compile time token may be defined in the application's makefile to disable automatic flushing during calls to the class driver USB | ||
| 78 | * management tasks. | ||
| 79 | * | ||
| 80 | * | ||
| 81 | * \section Sec_TokenSummary_USBTokens General USB Driver Related Tokens | ||
| 82 | * This section describes compile tokens which affect USB driver stack as a whole in the LUFA library. | ||
| 83 | * | ||
| 84 | * \li <b>ORDERED_EP_CONFIG</b> - (\ref Group_EndpointManagement , \ref Group_PipeManagement) - <i>AVR8, UC3</i> \n | ||
| 85 | * The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they <i>must</i> be configured in an ascending order to | ||
| 86 | * prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialization. This compile | ||
| 87 | * time token may be used to restrict the initialization order to ascending indexes only in exchange for a smaller compiled binary size. Use | ||
| 88 | * caution when applied to applications using the library USB Class drivers; the user application must ensure that all endpoints and pipes are | ||
| 89 | * allocated sequentially. | ||
| 90 | * | ||
| 91 | * \li <b>USE_STATIC_OPTIONS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n | ||
| 92 | * By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad | ||
| 93 | * voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options | ||
| 94 | * mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing | ||
| 95 | * the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an | ||
| 96 | * Options parameter. | ||
| 97 | * | ||
| 98 | * \li <b>USB_DEVICE_ONLY</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n | ||
| 99 | * For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the | ||
| 100 | * mode the library should be initialized to. If only device mode is required, the code for USB host mode can be removed from the binary to | ||
| 101 | * save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevant on smaller USB AVRs which | ||
| 102 | * do not support host mode. | ||
| 103 | * | ||
| 104 | * \li <b>USB_HOST_ONLY</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n | ||
| 105 | * Same as USB_DEVICE_ONLY, except the library is fixed to USB host mode rather than USB device mode. Not available on some USB AVR models. | ||
| 106 | * | ||
| 107 | * \li <b>USB_STREAM_TIMEOUT_MS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n | ||
| 108 | * When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host | ||
| 109 | * must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero 16-bit value to set the timeout | ||
| 110 | * period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead. | ||
| 111 | * | ||
| 112 | * \li <b>NO_LIMITED_CONTROLLER_CONNECT</b> - (\ref Group_Events) - <i>AVR8 Only</i> \n | ||
| 113 | * On the smaller USB AVRs, the USB controller lacks VBUS events to determine the physical connection state of the USB bus to a host. In lieu of | ||
| 114 | * VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be | ||
| 115 | * slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is | ||
| 116 | * required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the \ref USB_DeviceState global | ||
| 117 | * can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the user application. | ||
| 118 | * When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events. | ||
| 119 | * | ||
| 120 | * \li <b>NO_SOF_EVENTS</b> - (\ref Group_Events) - <i>All Architectures</i> \n | ||
| 121 | * By default, there exists a LUFA application event for the start of each USB frame while the USB bus is not suspended in either host or device mode. | ||
| 122 | * This event can be selectively enabled or disabled by calling the appropriate device or host mode function. When this compile time token is defined, | ||
| 123 | * the ability to receive USB Start of Frame events via the \ref EVENT_USB_Device_StartOfFrame() or \ref EVENT_USB_Host_StartOfFrame() events is removed, | ||
| 124 | * reducing the compiled program's binary size. | ||
| 125 | * | ||
| 126 | * | ||
| 127 | * \section Sec_TokenSummary_USBDeviceTokens USB Device Mode Driver Related Tokens | ||
| 128 | * This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode. | ||
| 129 | * | ||
| 130 | * \li <b>USE_RAM_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n | ||
| 131 | * Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one | ||
| 132 | * of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime. | ||
| 133 | * | ||
| 134 | * \li <b>USE_FLASH_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n | ||
| 135 | * Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM. | ||
| 136 | * | ||
| 137 | * \li <b>USE_EEPROM_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n | ||
| 138 | * Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM. | ||
| 139 | * | ||
| 140 | * \li <b>NO_INTERNAL_SERIAL</b> - (\ref Group_StdDescriptors) - <i>All Architectures</i> \n | ||
| 141 | * Some AVR models contain a unique serial number which can be used as the device serial number, while in device mode. This allows | ||
| 142 | * the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing allocated | ||
| 143 | * resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the code that | ||
| 144 | * performs this task can be disabled by defining this option and passing it to the compiler via the -D switch. | ||
| 145 | * | ||
| 146 | * \li <b>FIXED_CONTROL_ENDPOINT_SIZE</b>=<i>x</i> - (\ref Group_EndpointManagement) - <i>All Architectures</i> \n | ||
| 147 | * By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor. | ||
| 148 | * Normally this reduces the amount of configuration required for the library, allows the value to change dynamically (if | ||
| 149 | * descriptors are stored in EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this token can be | ||
| 150 | * defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled | ||
| 151 | * binary. | ||
| 152 | * | ||
| 153 | * \li <b>DEVICE_STATE_AS_GPIOR</b> - (\ref Group_Device) - <i>AVR8 Only</i> \n | ||
| 154 | * One of the most frequently used global variables in the stack is the USB_DeviceState global, which indicates the current state of | ||
| 155 | * the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token | ||
| 156 | * may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR | ||
| 157 | * reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except | ||
| 158 | * implicitly via the library APIs. | ||
| 159 | * | ||
| 160 | * \li <b>FIXED_NUM_CONFIGURATIONS</b>=<i>x</i> - (\ref Group_Device) - <i>All Architectures</i> \n | ||
| 161 | * By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces | ||
| 162 | * the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in | ||
| 163 | * EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project | ||
| 164 | * makefile to reduce the compiled size of the binary at the expense of flexibility. | ||
| 165 | * | ||
| 166 | * \li <b>CONTROL_ONLY_DEVICE</b> - (\ref Group_Device) - <i>All Architectures</i> \n | ||
| 167 | * In some limited USB device applications, there are no device endpoints other than the control endpoint; i.e. all device communication | ||
| 168 | * is through control endpoint requests. Defining this token will remove several features related to the selection and control of device | ||
| 169 | * endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided. | ||
| 170 | * | ||
| 171 | * \li <b>MAX_ENDPOINT_INDEX</b> - (\ref Group_Device) - <i>XMEGA Only</i> \n | ||
| 172 | * Defining this value to the highest index (not address - this excludes the direction flag) endpoint within the device will restrict the | ||
| 173 | * number of FIFOs created internally for the endpoint buffers, reducing the total RAM usage. | ||
| 174 | * | ||
| 175 | * \li <b>INTERRUPT_CONTROL_ENDPOINT</b> - (\ref Group_USBManagement) - <i>All Architectures</i> \n | ||
| 176 | * Some applications prefer to not call the USB_USBTask() management task regularly while in device mode, as it can complicate code significantly. | ||
| 177 | * Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control | ||
| 178 | * endpoint entirely via USB controller interrupts asynchronously to the user application. When defined, USB_USBTask() does not need to be called | ||
| 179 | * when in USB device mode. | ||
| 180 | * | ||
| 181 | * \li <b>NO_DEVICE_REMOTE_WAKEUP</b> - (\ref Group_Device) - <i>All Architectures</i> \n | ||
| 182 | * Many devices do not require the use of the Remote Wakeup features of USB, used to wake up the USB host when suspended. On these devices, | ||
| 183 | * the code required to manage device Remote Wakeup can be disabled by defining this token and passing it to the library via the -D switch. | ||
| 184 | * | ||
| 185 | * \li <b>NO_DEVICE_SELF_POWER</b> - (\ref Group_Device) - <i>All Architectures</i> \n | ||
| 186 | * USB devices may be bus powered, self powered, or a combination of both. When a device can be both bus powered and self powered, the host may | ||
| 187 | * query the device to determine the current power source, via \ref USB_Device_CurrentlySelfPowered. For solely bus powered devices, this global | ||
| 188 | * and the code required to manage it may be disabled by passing this token to the library via the -D switch. | ||
| 189 | * | ||
| 190 | * | ||
| 191 | * \section Sec_TokenSummary_USBHostTokens USB Host Mode Driver Related Tokens | ||
| 192 | * | ||
| 193 | * This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode. | ||
| 194 | * | ||
| 195 | * \li <b>HOST_STATE_AS_GPIOR</b> - (\ref Group_Host) - <i>AVR8 Only</i> \n | ||
| 196 | * One of the most frequently used global variables in the stack is the USB_HostState global, which indicates the current state of | ||
| 197 | * the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token | ||
| 198 | * may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR | ||
| 199 | * reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except | ||
| 200 | * implicitly via the library APIs. | ||
| 201 | * | ||
| 202 | * \li <b>USB_HOST_TIMEOUT_MS</b>=<i>x</i> - (\ref Group_Host) - <i>All Architectures</i> \n | ||
| 203 | * When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached | ||
| 204 | * device fails to respond within the timeout period. This token may be defined to a non-zero 16-bit value to set the timeout period for | ||
| 205 | * control transfers, specified in milliseconds. If not defined, the default value specified in Host.h is used instead. | ||
| 206 | * | ||
| 207 | * \li <b>HOST_DEVICE_SETTLE_DELAY_MS</b>=<i>x</i> - (\ref Group_Host) - <i>All Architectures</i> \n | ||
| 208 | * Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or | ||
| 209 | * they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled | ||
| 210 | * back to a known idle state before communications occur with the device. This token may be defined to a 16-bit value to set the device | ||
| 211 | * settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead. | ||
| 212 | * | ||
| 213 | * \li <b>INVERTED_VBUS_ENABLE_LINE</b> - (\ref Group_Host) - <i>All Architectures</i> \n | ||
| 214 | * If enabled, this will indicate that the USB target VBUS line polarity is inverted; i.e. it should be pulled low to enable VBUS to the | ||
| 215 | * target, and pulled high to stop the target VBUS generation. | ||
| 216 | * \n | ||
| 217 | * \attention On AVR8 architecture devices, this compile time option requires \c NO_AUTO_VBUS_MANAGEMENT to be set. | ||
| 218 | * | ||
| 219 | * \li <b>NO_AUTO_VBUS_MANAGEMENT</b> - (\ref Group_Host) - <i>All Architectures</i> \n | ||
| 220 | * Disables the automatic management of VBUS to the target, i.e. automatic shut down in the even of an overcurrent situation. When enabled, VBUS | ||
| 221 | * is enabled while the USB controller is initialized in USB Host mode. | ||
| 222 | */ | ||
| 223 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/CompilingApps.txt b/lib/lufa/LUFA/DoxygenPages/CompilingApps.txt new file mode 100644 index 000000000..08f81d2ba --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/CompilingApps.txt | |||
| @@ -0,0 +1,46 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_CompilingApps Compiling the Demos, Bootloaders and Projects | ||
| 8 | * | ||
| 9 | * The following details how to compile the included LUFA demos, applications and bootloaders using AVR-GCC. | ||
| 10 | * | ||
| 11 | * \section Sec_CompilingApps_Prerequisites Prerequisites | ||
| 12 | * Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+) | ||
| 13 | * and the AVR-GCC (4.2+) compiler. A standard "coreutils" package for your system is also required for command line | ||
| 14 | * compilation of LUFA based applications. | ||
| 15 | * | ||
| 16 | * \subsection SSec_CompilingApps_PreqWindows Windows Prerequisites | ||
| 17 | * On Windows, you will need a copy of the latest Atmel Toolchain (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx</a>), | ||
| 18 | * either downloaded and installed as a standalone package, or installed as part of Atmel Studio. You will need to ensure | ||
| 19 | * that the "bin" directory of the toolchain is available in your system's <b>PATH</b> environment variable. | ||
| 20 | * | ||
| 21 | * In addition, you will need to install a ported version of the ZSH or BASH *nix shells, and a standard set of *nix | ||
| 22 | * utilities such as <i>cut</i>, <i>find</i> and <i>sed</i>. These can be found in the "basic" system package of the | ||
| 23 | * of the MinGW installer (<a>http://www.mingw.org</a>). Once installed, add the "msys\1.0\bin" of the MinGW installation | ||
| 24 | * folder is added to your system's <b>PATH</b> environment variable. | ||
| 25 | * | ||
| 26 | * \subsection SSec_CompilingApps_PreqLinux Linux Prerequisites | ||
| 27 | * On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the | ||
| 28 | * Atmel website (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORLINUX.aspx</a>), or use the latest avr-libc and avr-gcc packages | ||
| 29 | * for your chosen distribution's package manager. For full device support, the Atmel standalone Toolchain package is recommended. | ||
| 30 | * | ||
| 31 | * \section Sec_CompilingApps_Compiling Compiling a LUFA Application | ||
| 32 | * Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for | ||
| 33 | * each individual demo, bootloader and project folder, as well as scripts in the Demos/, Bootloaders/, Projects/ | ||
| 34 | * and the LUFA root directory. Compilation of projects can be started from any of the above directories, with a build | ||
| 35 | * started from an upper directory in the directory structure executing build of all child directories under it. This | ||
| 36 | * means that while a build inside a particular demo directory will build only that particular demo, a build started from | ||
| 37 | * the /Demos/ directory will build all LUFA demo projects sequentially. | ||
| 38 | * | ||
| 39 | * To build a project from the source via the command line, the command <b>"make all"</b> should be executed from the command | ||
| 40 | * line in the directory of interest. To remove compiled files (including the binary output, all intermediately files and all | ||
| 41 | * diagnostic output files), execute <b>"make clean"</b>. Once a "make all" has been run and no errors were encountered, the | ||
| 42 | * resulting binary will be located in the generated ".HEX" file. If your project makes use of pre-initialized EEPROM | ||
| 43 | * variables, the generated ".EEP" file will contain the project's EEPROM data. | ||
| 44 | * | ||
| 45 | * \see \ref Page_BuildSystem for information on the LUFA build system. | ||
| 46 | */ | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/ConfiguringApps.txt b/lib/lufa/LUFA/DoxygenPages/ConfiguringApps.txt new file mode 100644 index 000000000..15b660e92 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/ConfiguringApps.txt | |||
| @@ -0,0 +1,157 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_ConfiguringApps Configuring the Demos, Bootloaders and Projects | ||
| 8 | * | ||
| 9 | * If the target microcontroller model, architecture, clock speed, board or other settings are different from the current | ||
| 10 | * settings, they must be changed and the project recompiled from the source code before being programmed into the microcontroller. | ||
| 11 | * Most project configuration options are located in the <tt>makefile</tt> build script inside each LUFA application's folder, | ||
| 12 | * however some demo or application-specific configuration settings are located in one or more of the source files of the project. | ||
| 13 | * See each project's individual documentation for application-specific configuration values. | ||
| 14 | * | ||
| 15 | * Each project "makefile" contains all the script and configuration data required to compile each project. When opened with | ||
| 16 | * any regular basic text editor such as Notepad or WordPad (ensure that the save format is a pure ASCII text format) the | ||
| 17 | * build configuration settings may be altered. | ||
| 18 | * | ||
| 19 | * \see \ref Page_BuildSystem for information on the LUFA build system. | ||
| 20 | * | ||
| 21 | * \section Sec_ConfiguringApps_AppMakefileParams The Default Application Makefile Template | ||
| 22 | * | ||
| 23 | * Below is a copy of the default LUFA application makefile, which can be used as a template for each application. | ||
| 24 | * | ||
| 25 | * \verbinclude makefile_template | ||
| 26 | * | ||
| 27 | * Inside each makefile, a number of configuration variables are listed with the syntax "<VARIABLE NAME> = <VALUE>". For | ||
| 28 | * each application, the important standard variables which should be altered are: | ||
| 29 | * | ||
| 30 | * - <b>MCU</b>, the target processor model | ||
| 31 | * - <b>ARCH</b>, the target microcontroller architecture | ||
| 32 | * - <b>BOARD</b>, the target board hardware | ||
| 33 | * - <b>F_CPU</b>, the target CPU master clock frequency, after any prescaling | ||
| 34 | * - <b>F_USB</b>, the target raw input clock to the USB module of the processor | ||
| 35 | * - <b>OPTIMIZATION</b>, the level of optimization to compile with | ||
| 36 | * - <b>TARGET</b>, the name of the target output binary and other files | ||
| 37 | * - <b>SRC</b>, the list of source files to compile/assemble/link | ||
| 38 | * - <b>LUFA_PATH</b>, the path to the LUFA library core source code | ||
| 39 | * - <b>CC_FLAGS</b>, the common command line flags to pass to the C/C++ compiler, assembler and linker | ||
| 40 | * - <b>LD_FLAGS</b>, the command line flags to pass to the linker | ||
| 41 | * | ||
| 42 | * These values should be changed to reflect the build hardware. | ||
| 43 | * | ||
| 44 | * \subsection SSec_ConfiguringApps_MCU The MCU Parameter | ||
| 45 | * This parameter indicates the target microcontroller model for the compiled application. This should be set to the model of the target | ||
| 46 | * microcontroller (such as the AT90USB1287, or the ATMEGA32U4), in all lower-case (e.g. "at90usb1287"). Note that not all demos support all the | ||
| 47 | * microcontroller models and architectures, as they may make use of peripherals or modes only present in some devices. | ||
| 48 | * | ||
| 49 | * For supported processor models, see \ref Page_DeviceSupport. | ||
| 50 | * | ||
| 51 | * \subsection SSec_ConfiguringApps_ARCH The ARCH Parameter | ||
| 52 | * This parameter indicates the target microcontroller architecture the library is to be compiled for. Different microcontroller | ||
| 53 | * architectures require different source files to be compiled into the final binary, and so this option must be set to the correct | ||
| 54 | * architecture for the selected platform. | ||
| 55 | * | ||
| 56 | * For supported processor architectures, see \ref Page_DeviceSupport. | ||
| 57 | * | ||
| 58 | * \subsection SSec_ConfiguringApps_BOARD The BOARD Parameter | ||
| 59 | * This parameter indicates the target board hardware for the compiled application. Some LUFA library drivers are board-specific, | ||
| 60 | * such as the LED driver, and the library needs to know the layout of the target board. If you are using one of the board models listed | ||
| 61 | * on the main library page, change this parameter to the board name in all UPPER-case. | ||
| 62 | * | ||
| 63 | * If you are not using any board-specific drivers in the LUFA library, or you are using a custom board layout, change this to read | ||
| 64 | * "USER" (no quotes) instead of a standard board name. If the USER board type is selected and the application makes use of one or more | ||
| 65 | * board-specific hardware drivers inside the LUFA library, then the appropriate stub drives files should be copied from the \c /CodeTemplates/DriverStubs/ | ||
| 66 | * directory into a /Board/ folder inside the application directory, and the stub driver completed with the appropriate code to drive the | ||
| 67 | * custom board's hardware. | ||
| 68 | * | ||
| 69 | * For boards with built in hardware driver support within the LUFA library, see \ref Page_DeviceSupport. | ||
| 70 | * | ||
| 71 | * \subsection SSec_ConfiguringApps_F_CPU The F_CPU Parameter | ||
| 72 | * This parameter indicates the target microcontroller's main CPU clock frequency, in Hz. This is used by many libraries (and applications) for | ||
| 73 | * timing related purposes, and should reflect the actual CPU speed after any prescaling or adjustments are performed. | ||
| 74 | * | ||
| 75 | * \subsection SSec_ConfiguringApps_F_USB The F_USB Parameter | ||
| 76 | * This parameter indicates the raw input clock frequency to the USB module within the microcontroller in Hz. This may be very different on some platforms | ||
| 77 | * to the main CPU clock or other peripheral/bus clocks. | ||
| 78 | * | ||
| 79 | * \note On AVR8 platforms, this must be equal to \c 8000000 or \c 16000000. | ||
| 80 | * | ||
| 81 | * \note On XMEGA platforms, this must be equal to a multiple of 6000000 from \c 6000000 to \c 48000000. | ||
| 82 | * | ||
| 83 | * \note On UC3 platforms, this must be equal to a multiple of 12000000 from \c 12000000 to \c 48000000. | ||
| 84 | * | ||
| 85 | * \subsection SSec_ConfiguringApps_OPTIMIZATION The OPTIMIZATION Parameter | ||
| 86 | * This parameter indicates the level of optimization to use when compiling the application. This will allow you to compile with an optimization level | ||
| 87 | * supported by GCC, from <tt>0</tt> (no optimization) to <tt>3</tt> (fastest runtime optimization) or <tt>s</tt> (smallest size). | ||
| 88 | * | ||
| 89 | * \subsection SSec_ConfiguringApps_TARGET The TARGET Parameter | ||
| 90 | * This parameter indicates the application target name, which is used as the base filename for the build binary and debugging files. This will be the | ||
| 91 | * name of the output files once linked together into the final application, ready to load into the target. | ||
| 92 | * | ||
| 93 | * \subsection SSec_ConfiguringApps_SRC The SRC Parameter | ||
| 94 | * This parameter indicates the source files used to compile the application, as a list of C (<tt>*.c</tt>), C++ (<tt>*.cpp</tt>) and Assembly (<tt>*.S</tt>) files. Note that | ||
| 95 | * all assembly files must end in a <b>capital</b> .S extension, as lowercase .s files are reserved for GCC intermediate files. | ||
| 96 | * | ||
| 97 | * \subsection SSec_ConfiguringApps_LUFA_PATH The LUFA_PATH Parameter | ||
| 98 | * As each LUFA program requires the LUFA library source code to compile correctly, the application must know where the LUFA library is located. This | ||
| 99 | * value specifies the path to the LUFA library core. This path may be relative or absolute, however note than even under Windows based systems the | ||
| 100 | * forward-slash (/) path separator must be used. | ||
| 101 | * | ||
| 102 | * \subsection SSec_ConfiguringApps_CC_FLAGS The CC_FLAGS Parameter | ||
| 103 | * This parameter lists the compiler flags passed to the C/C++ compiler, the assembler and the linker. These are used as-is directly to GCC and thus | ||
| 104 | * must match GCC's command line options as given in the GCC manual. This variable may be used to define tokens directly on the command line, enable or | ||
| 105 | * disable warnings, adjust the target-specific tuning parameters or other options. | ||
| 106 | * | ||
| 107 | * \subsection SSec_ConfiguringApps_LD_FLAGS The LD_FLAGS Parameter | ||
| 108 | * This parameter lists the linker flags passed exclusively to the linker. These are used as-is directly to GCC and thus must match GCC's command line | ||
| 109 | * linker options as given in the GCC manual. This variable may be used to create or relocate custom data sections, or enable linker specific behaviors. | ||
| 110 | * | ||
| 111 | * | ||
| 112 | * \section Sec_ExampleAppConfig Example Application Makefile Configurations | ||
| 113 | * Below is an example makefile for an AVR8 based AT90USB1287 running at 8MHz, to compile a program called "MyApplication": | ||
| 114 | * \verbatim | ||
| 115 | MCU = at90usb1287 | ||
| 116 | ARCH = AVR8 | ||
| 117 | BOARD = NONE | ||
| 118 | F_CPU = 8000000 | ||
| 119 | F_USB = $(F_CPU) | ||
| 120 | OPTIMIZATION = s | ||
| 121 | TARGET = MyApplication | ||
| 122 | SRC = MyApplication.c Descriptors.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS) | ||
| 123 | LUFA_PATH = ../../../../LUFA | ||
| 124 | CC_FLAGS = -DUSE_LUFA_CONFIG_HEADER -IConfig/ | ||
| 125 | LD_FLAGS = | ||
| 126 | \endverbatim | ||
| 127 | * | ||
| 128 | * Below is an example makefile for an XMEGA based ATXMEGA128A1U running at 32MHz, to compile a program called "MyApplication": | ||
| 129 | * \verbatim | ||
| 130 | MCU = atxmega128a1u | ||
| 131 | ARCH = XMEGA | ||
| 132 | BOARD = NONE | ||
| 133 | F_CPU = 32000000 | ||
| 134 | F_USB = 48000000 | ||
| 135 | OPTIMIZATION = s | ||
| 136 | TARGET = MyApplication | ||
| 137 | SRC = MyApplication.c Descriptors.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS) | ||
| 138 | LUFA_PATH = ../../../../LUFA | ||
| 139 | CC_FLAGS = -DUSE_LUFA_CONFIG_HEADER -IConfig/ | ||
| 140 | LD_FLAGS = | ||
| 141 | \endverbatim | ||
| 142 | * | ||
| 143 | * Below is an example makefile for a UC3 based AT32UC3A0512 running at 50MHz, to compile a program called "MyApplication": | ||
| 144 | * \verbatim | ||
| 145 | MCU = uc3a0512 | ||
| 146 | ARCH = UC3 | ||
| 147 | BOARD = NONE | ||
| 148 | F_CPU = 50000000 | ||
| 149 | F_USB = 48000000 | ||
| 150 | OPTIMIZATION = s | ||
| 151 | TARGET = MyApplication | ||
| 152 | SRC = MyApplication.c Descriptors.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS) | ||
| 153 | LUFA_PATH = ../../../../LUFA | ||
| 154 | CC_FLAGS = -DUSE_LUFA_CONFIG_HEADER -IConfig/ | ||
| 155 | LD_FLAGS = | ||
| 156 | \endverbatim | ||
| 157 | */ | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/DevelopingWithLUFA.txt b/lib/lufa/LUFA/DoxygenPages/DevelopingWithLUFA.txt new file mode 100644 index 000000000..31b58fa2a --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/DevelopingWithLUFA.txt | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** | ||
| 8 | * \page Page_DevelopingWithLUFA Developing With LUFA | ||
| 9 | * | ||
| 10 | * This section of the manual contains information on LUFA development, such as Getting Started information, | ||
| 11 | * information on compile-time tuning of the library and other developer-related sections. | ||
| 12 | * | ||
| 13 | * <b>Subsections:</b> | ||
| 14 | * \li \subpage Page_BuildSystem - The LUFA Buildsystem | ||
| 15 | * \li \subpage Page_TokenSummary - Summary of Compile Time Tokens | ||
| 16 | * \li \subpage Page_Migration - Migrating from an Older LUFA Version | ||
| 17 | * \li \subpage Page_VIDPID - Allocated USB VID and PID Values | ||
| 18 | * \li \subpage Page_OSDrivers - Operating System Driver Information | ||
| 19 | * \li \subpage Page_BuildLibrary - Building as a Linkable Library | ||
| 20 | * \li \subpage Page_WritingBoardDrivers - How to Write Custom Board Drivers | ||
| 21 | * \li \subpage Page_SoftwareBootloaderStart - How to jump to the bootloader in software | ||
| 22 | */ | ||
| 23 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/DeviceSupport.txt b/lib/lufa/LUFA/DoxygenPages/DeviceSupport.txt new file mode 100644 index 000000000..cff2cda4b --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/DeviceSupport.txt | |||
| @@ -0,0 +1,424 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** | ||
| 8 | * \page Page_DeviceSupport Device and Hardware Support | ||
| 9 | * | ||
| 10 | * <b>Atmel Microcontrollers:</b> | ||
| 11 | * \li \subpage Page_AVR8Support - Atmel AVR8 Support | ||
| 12 | * \li \subpage Page_UC3Support - Atmel AVR32 UC3 Support | ||
| 13 | * \li \subpage Page_XMEGASupport - Atmel XMEGA Support | ||
| 14 | */ | ||
| 15 | |||
| 16 | /** | ||
| 17 | * \page Page_AVR8Support Atmel 8-Bit AVR (AVR8) Support | ||
| 18 | * | ||
| 19 | * \section Sec_AVR8Support_Devices Supported Microcontroller Models | ||
| 20 | * | ||
| 21 | * Currently supported AVR8 models: | ||
| 22 | * | ||
| 23 | * <table> | ||
| 24 | * <tr> | ||
| 25 | * <th width="150px">Part</th> | ||
| 26 | * <th width="150px">USB Device Mode</th> | ||
| 27 | * <th width="150px">USB Host Mode</th> | ||
| 28 | * </tr> | ||
| 29 | * <tr> | ||
| 30 | * <td>AT90USB82</td> | ||
| 31 | * <td bgcolor="#00EE00">Yes</td> | ||
| 32 | * <td bgcolor="#EE0000">No</td> | ||
| 33 | * </tr> | ||
| 34 | * <tr> | ||
| 35 | * <td>ATMEGA8U2</td> | ||
| 36 | * <td bgcolor="#00EE00">Yes</td> | ||
| 37 | * <td bgcolor="#EE0000">No</td> | ||
| 38 | * </tr> | ||
| 39 | * <tr> | ||
| 40 | * <td>AT90USB162</td> | ||
| 41 | * <td bgcolor="#00EE00">Yes</td> | ||
| 42 | * <td bgcolor="#EE0000">No</td> | ||
| 43 | * </tr> | ||
| 44 | * <tr> | ||
| 45 | * <td>ATMEGA16U2</td> | ||
| 46 | * <td bgcolor="#00EE00">Yes</td> | ||
| 47 | * <td bgcolor="#EE0000">No</td> | ||
| 48 | * </tr> | ||
| 49 | * <tr> | ||
| 50 | * <td>ATMEGA16U4</td> | ||
| 51 | * <td bgcolor="#00EE00">Yes</td> | ||
| 52 | * <td bgcolor="#EE0000">No</td> | ||
| 53 | * </tr> | ||
| 54 | * <tr> | ||
| 55 | * <td>ATMEGA32U2</td> | ||
| 56 | * <td bgcolor="#00EE00">Yes</td> | ||
| 57 | * <td bgcolor="#EE0000">No</td> | ||
| 58 | * </tr> | ||
| 59 | * <tr> | ||
| 60 | * <td>ATMEGA32U4</td> | ||
| 61 | * <td bgcolor="#00EE00">Yes</td> | ||
| 62 | * <td bgcolor="#EE0000">No</td> | ||
| 63 | * </tr> | ||
| 64 | * <tr> | ||
| 65 | * <td>AT90USB646</td> | ||
| 66 | * <td bgcolor="#00EE00">Yes</td> | ||
| 67 | * <td bgcolor="#EE0000">No</td> | ||
| 68 | * </tr> | ||
| 69 | * <tr> | ||
| 70 | * <td>AT90USB647</td> | ||
| 71 | * <td bgcolor="#00EE00">Yes</td> | ||
| 72 | * <td bgcolor="#00EE00">Yes</td> | ||
| 73 | * </tr> | ||
| 74 | * <tr> | ||
| 75 | * <td>AT90USB1286</td> | ||
| 76 | * <td bgcolor="#00EE00">Yes</td> | ||
| 77 | * <td bgcolor="#EE0000">No</td> | ||
| 78 | * </tr> | ||
| 79 | * <tr> | ||
| 80 | * <td>AT90USB1287</td> | ||
| 81 | * <td bgcolor="#00EE00">Yes</td> | ||
| 82 | * <td bgcolor="#00EE00">Yes</td> | ||
| 83 | * </tr> | ||
| 84 | * </table> | ||
| 85 | * | ||
| 86 | * \section Sec_AVR8Support_Boards Supported Atmel Boards | ||
| 87 | * Currently supported Atmel AVR8 boards (see \ref Group_BoardTypes): | ||
| 88 | * - AT90USBKEY | ||
| 89 | * - ATAVRUSBRF01 | ||
| 90 | * - EVK527 | ||
| 91 | * - RZUSBSTICK | ||
| 92 | * - STK525 | ||
| 93 | * - STK526 | ||
| 94 | * - XPLAIN (Original green board, <i>not</i> the newer blue XPLAINED family boards) | ||
| 95 | * - Xplained-MINI | ||
| 96 | * | ||
| 97 | * \section Sec_AVR8Support_ThirdParty Supported Third Party Boards | ||
| 98 | * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): | ||
| 99 | * - Adafruit U4 Breakout Board | ||
| 100 | * - Arduino Leonardo | ||
| 101 | * - Arduino Micro | ||
| 102 | * - Arduino Uno | ||
| 103 | * - Arduino Yun | ||
| 104 | * - Bitwizard Multio and Big-Multio | ||
| 105 | * - Busware BUI | ||
| 106 | * - Busware CUL V3 | ||
| 107 | * - Busware TUL | ||
| 108 | * - DorkbotPDX Duce | ||
| 109 | * - Fletchtronics Bumble-B (using manufacturer recommended peripheral layout) | ||
| 110 | * - Kernel Concepts USBFOO | ||
| 111 | * - Linnix UDIP | ||
| 112 | * - MattairTech JM-DB-U2 | ||
| 113 | * - Maximus USB | ||
| 114 | * - Micropendous Boards (Micropendous-32U2, Micropendous-1, Micropendous-2) | ||
| 115 | * - Microsin AVR-USB162 | ||
| 116 | * - Minimus USB | ||
| 117 | * - Olimex AVR-USB-162, AVR-USB-32U4 and AVR-USB-T32U4 Boards | ||
| 118 | * - Olimex AVR-ISP-MK2 | ||
| 119 | * - Paranoid Studio's US2AX (V1, V2 and V3 hardware revisions) | ||
| 120 | * - PJRC Teensy (1.x and 2.x versions) | ||
| 121 | * - Pololu A-Star Micro | ||
| 122 | * - Rikus' U2S | ||
| 123 | * - Sparkfun U2 Breakout Board | ||
| 124 | * - Stange ISP Programmer Board | ||
| 125 | * - TCNISO Blackcat USB JTAG | ||
| 126 | * - Tempusdictum Benito | ||
| 127 | * - Tom's USBTINY-MKII (all revisions and versions) | ||
| 128 | * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) | ||
| 129 | */ | ||
| 130 | |||
| 131 | /** | ||
| 132 | * \page Page_UC3Support Atmel 32-Bit UC3 AVR (UC3) | ||
| 133 | * | ||
| 134 | * \warning The AVR32 UC3 device support is currently <b>experimental</b>, and is included for preview purposes only. | ||
| 135 | * | ||
| 136 | * \section Sec_UC3Support_Devices Supported Microcontroller Models | ||
| 137 | * | ||
| 138 | * Currently supported UC3 models: | ||
| 139 | * | ||
| 140 | * <table> | ||
| 141 | * <tr> | ||
| 142 | * <th width="150px">Part</th> | ||
| 143 | * <th width="150px">USB Device Mode</th> | ||
| 144 | * <th width="150px">USB Host Mode</th> | ||
| 145 | * </tr> | ||
| 146 | * <tr> | ||
| 147 | * <td>AT32UC3A364</td> | ||
| 148 | * <td bgcolor="#00EE00">Yes</td> | ||
| 149 | * <td bgcolor="#00EE00">Yes</td> | ||
| 150 | * </tr> | ||
| 151 | * <tr> | ||
| 152 | * <td>AT32UC3A364S</td> | ||
| 153 | * <td bgcolor="#00EE00">Yes</td> | ||
| 154 | * <td bgcolor="#00EE00">Yes</td> | ||
| 155 | * </tr> | ||
| 156 | * <tr> | ||
| 157 | * <td>AT32UC3A464</td> | ||
| 158 | * <td bgcolor="#00EE00">Yes</td> | ||
| 159 | * <td bgcolor="#00EE00">Yes</td> | ||
| 160 | * </tr> | ||
| 161 | * <tr> | ||
| 162 | * <td>AT32UC3A464S</td> | ||
| 163 | * <td bgcolor="#00EE00">Yes</td> | ||
| 164 | * <td bgcolor="#00EE00">Yes</td> | ||
| 165 | * </tr> | ||
| 166 | * <tr> | ||
| 167 | * <td>AT32UC3B064</td> | ||
| 168 | * <td bgcolor="#00EE00">Yes</td> | ||
| 169 | * <td bgcolor="#00EE00">Yes</td> | ||
| 170 | * </tr> | ||
| 171 | * <tr> | ||
| 172 | * <td>AT32UC3B164</td> | ||
| 173 | * <td bgcolor="#00EE00">Yes</td> | ||
| 174 | * <td bgcolor="#00EE00">Yes</td> | ||
| 175 | * </tr> | ||
| 176 | * <tr> | ||
| 177 | * <td>AT32UC3A0128</td> | ||
| 178 | * <td bgcolor="#00EE00">Yes</td> | ||
| 179 | * <td bgcolor="#00EE00">Yes</td> | ||
| 180 | * </tr> | ||
| 181 | * <tr> | ||
| 182 | * <td>AT32UC3A1128</td> | ||
| 183 | * <td bgcolor="#00EE00">Yes</td> | ||
| 184 | * <td bgcolor="#00EE00">Yes</td> | ||
| 185 | * </tr> | ||
| 186 | * <tr> | ||
| 187 | * <td>AT32UC3A3128</td> | ||
| 188 | * <td bgcolor="#00EE00">Yes</td> | ||
| 189 | * <td bgcolor="#00EE00">Yes</td> | ||
| 190 | * </tr> | ||
| 191 | * <tr> | ||
| 192 | * <td>AT32UC3A3128S</td> | ||
| 193 | * <td bgcolor="#00EE00">Yes</td> | ||
| 194 | * <td bgcolor="#00EE00">Yes</td> | ||
| 195 | * </tr> | ||
| 196 | * <tr> | ||
| 197 | * <td>AT32UC3A4128</td> | ||
| 198 | * <td bgcolor="#00EE00">Yes</td> | ||
| 199 | * <td bgcolor="#00EE00">Yes</td> | ||
| 200 | * </tr> | ||
| 201 | * <tr> | ||
| 202 | * <td>AT32UC3A4128S</td> | ||
| 203 | * <td bgcolor="#00EE00">Yes</td> | ||
| 204 | * <td bgcolor="#00EE00">Yes</td> | ||
| 205 | * </tr> | ||
| 206 | * <tr> | ||
| 207 | * <td>AT32UC3B0128</td> | ||
| 208 | * <td bgcolor="#00EE00">Yes</td> | ||
| 209 | * <td bgcolor="#00EE00">Yes</td> | ||
| 210 | * </tr> | ||
| 211 | * <tr> | ||
| 212 | * <td>AT32UC3B1128</td> | ||
| 213 | * <td bgcolor="#00EE00">Yes</td> | ||
| 214 | * <td bgcolor="#00EE00">Yes</td> | ||
| 215 | * </tr> | ||
| 216 | * <tr> | ||
| 217 | * <td>AT32UC3A0256</td> | ||
| 218 | * <td bgcolor="#00EE00">Yes</td> | ||
| 219 | * <td bgcolor="#00EE00">Yes</td> | ||
| 220 | * </tr> | ||
| 221 | * <tr> | ||
| 222 | * <td>AT32UC3A1256</td> | ||
| 223 | * <td bgcolor="#00EE00">Yes</td> | ||
| 224 | * <td bgcolor="#00EE00">Yes</td> | ||
| 225 | * </tr> | ||
| 226 | * <tr> | ||
| 227 | * <td>AT32UC3A3256</td> | ||
| 228 | * <td bgcolor="#00EE00">Yes</td> | ||
| 229 | * <td bgcolor="#00EE00">Yes</td> | ||
| 230 | * </tr> | ||
| 231 | * <tr> | ||
| 232 | * <td>AT32UC3A3256S</td> | ||
| 233 | * <td bgcolor="#00EE00">Yes</td> | ||
| 234 | * <td bgcolor="#00EE00">Yes</td> | ||
| 235 | * </tr> | ||
| 236 | * <tr> | ||
| 237 | * <td>AT32UC3A4256</td> | ||
| 238 | * <td bgcolor="#00EE00">Yes</td> | ||
| 239 | * <td bgcolor="#00EE00">Yes</td> | ||
| 240 | * </tr> | ||
| 241 | * <tr> | ||
| 242 | * <td>AT32UC3A4256S</td> | ||
| 243 | * <td bgcolor="#00EE00">Yes</td> | ||
| 244 | * <td bgcolor="#00EE00">Yes</td> | ||
| 245 | * </tr> | ||
| 246 | * <tr> | ||
| 247 | * <td>AT32UC3B0256</td> | ||
| 248 | * <td bgcolor="#00EE00">Yes</td> | ||
| 249 | * <td bgcolor="#00EE00">Yes</td> | ||
| 250 | * </tr> | ||
| 251 | * <tr> | ||
| 252 | * <td>AT32UC3B1256</td> | ||
| 253 | * <td bgcolor="#00EE00">Yes</td> | ||
| 254 | * <td bgcolor="#00EE00">Yes</td> | ||
| 255 | * </tr> | ||
| 256 | * <tr> | ||
| 257 | * <td>AT32UC3A0512</td> | ||
| 258 | * <td bgcolor="#00EE00">Yes</td> | ||
| 259 | * <td bgcolor="#00EE00">Yes</td> | ||
| 260 | * </tr> | ||
| 261 | * <tr> | ||
| 262 | * <td>AT32UC3A1512</td> | ||
| 263 | * <td bgcolor="#00EE00">Yes</td> | ||
| 264 | * <td bgcolor="#00EE00">Yes</td> | ||
| 265 | * </tr> | ||
| 266 | * <tr> | ||
| 267 | * <td>AT32UC3B0512</td> | ||
| 268 | * <td bgcolor="#00EE00">Yes</td> | ||
| 269 | * <td bgcolor="#00EE00">Yes</td> | ||
| 270 | * </tr> | ||
| 271 | * <tr> | ||
| 272 | * <td>AT32UC3B1512</td> | ||
| 273 | * <td bgcolor="#00EE00">Yes</td> | ||
| 274 | * <td bgcolor="#00EE00">Yes</td> | ||
| 275 | * </tr> | ||
| 276 | * </table> | ||
| 277 | * | ||
| 278 | * \section Sec_UC3Support_Boards Supported Atmel Boards | ||
| 279 | * | ||
| 280 | * Currently supported Atmel UC3 boards (see \ref Group_BoardTypes): | ||
| 281 | * - EVK1100 | ||
| 282 | * - EVK1101 | ||
| 283 | * - EVK1104 | ||
| 284 | * - UC3-A3 Xplained | ||
| 285 | * | ||
| 286 | * \section Sec_UC3Support_ThirdParty Supported Third Party Boards | ||
| 287 | * | ||
| 288 | * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): | ||
| 289 | * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) | ||
| 290 | */ | ||
| 291 | |||
| 292 | /** | ||
| 293 | * \page Page_XMEGASupport Atmel USB XMEGA AVR (XMEGA) | ||
| 294 | * | ||
| 295 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 296 | * | ||
| 297 | * \section Sec_XMEGASupport_Devices Supported Microcontroller Models | ||
| 298 | * | ||
| 299 | * Currently supported XMEGA models: | ||
| 300 | * | ||
| 301 | * <table> | ||
| 302 | * <tr> | ||
| 303 | * <th width="150px">Part</th> | ||
| 304 | * <th width="150px">USB Device Mode</th> | ||
| 305 | * <th width="150px">USB Host Mode</th> | ||
| 306 | * </tr> | ||
| 307 | * <tr> | ||
| 308 | * <td>ATXMEGA16A4U</td> | ||
| 309 | * <td bgcolor="#00EE00">Yes</td> | ||
| 310 | * <td bgcolor="#EE0000">No</td> | ||
| 311 | * </tr> | ||
| 312 | * <tr> | ||
| 313 | * <td>ATXMEGA32A4U</td> | ||
| 314 | * <td bgcolor="#00EE00">Yes</td> | ||
| 315 | * <td bgcolor="#EE0000">No</td> | ||
| 316 | * </tr> | ||
| 317 | * <tr> | ||
| 318 | * <td>ATXMEGA64A4U</td> | ||
| 319 | * <td bgcolor="#00EE00">Yes</td> | ||
| 320 | * <td bgcolor="#EE0000">No</td> | ||
| 321 | * </tr> | ||
| 322 | * <tr> | ||
| 323 | * <td>ATXMEGA128A4U</td> | ||
| 324 | * <td bgcolor="#00EE00">Yes</td> | ||
| 325 | * <td bgcolor="#EE0000">No</td> | ||
| 326 | * </tr> | ||
| 327 | * <tr> | ||
| 328 | * <td>ATXMEGA64A3U</td> | ||
| 329 | * <td bgcolor="#00EE00">Yes</td> | ||
| 330 | * <td bgcolor="#EE0000">No</td> | ||
| 331 | * </tr> | ||
| 332 | * <tr> | ||
| 333 | * <td>ATXMEGA128A3U</td> | ||
| 334 | * <td bgcolor="#00EE00">Yes</td> | ||
| 335 | * <td bgcolor="#EE0000">No</td> | ||
| 336 | * </tr> | ||
| 337 | * <tr> | ||
| 338 | * <td>ATXMEGA192A3U</td> | ||
| 339 | * <td bgcolor="#00EE00">Yes</td> | ||
| 340 | * <td bgcolor="#EE0000">No</td> | ||
| 341 | * </tr> | ||
| 342 | * <tr> | ||
| 343 | * <td>ATXMEGA256A3U</td> | ||
| 344 | * <td bgcolor="#00EE00">Yes</td> | ||
| 345 | * <td bgcolor="#EE0000">No</td> | ||
| 346 | * </tr> | ||
| 347 | * <tr> | ||
| 348 | * <td>ATXMEGA256A3BU</td> | ||
| 349 | * <td bgcolor="#00EE00">Yes</td> | ||
| 350 | * <td bgcolor="#EE0000">No</td> | ||
| 351 | * </tr> | ||
| 352 | * <tr> | ||
| 353 | * <td>ATXMEGA128A1U</td> | ||
| 354 | * <td bgcolor="#00EE00">Yes</td> | ||
| 355 | * <td bgcolor="#EE0000">No</td> | ||
| 356 | * </tr> | ||
| 357 | * <tr> | ||
| 358 | * <td>ATXMEGA64B3</td> | ||
| 359 | * <td bgcolor="#00EE00">Yes</td> | ||
| 360 | * <td bgcolor="#EE0000">No</td> | ||
| 361 | * </tr> | ||
| 362 | * <tr> | ||
| 363 | * <td>ATXMEGA128B3</td> | ||
| 364 | * <td bgcolor="#00EE00">Yes</td> | ||
| 365 | * <td bgcolor="#EE0000">No</td> | ||
| 366 | * </tr> | ||
| 367 | * <tr> | ||
| 368 | * <td>ATXMEGA64B1</td> | ||
| 369 | * <td bgcolor="#00EE00">Yes</td> | ||
| 370 | * <td bgcolor="#EE0000">No</td> | ||
| 371 | * </tr> | ||
| 372 | * <tr> | ||
| 373 | * <td>ATXMEGA128B1</td> | ||
| 374 | * <td bgcolor="#00EE00">Yes</td> | ||
| 375 | * <td bgcolor="#EE0000">No</td> | ||
| 376 | * </tr> | ||
| 377 | * <tr> | ||
| 378 | * <td>ATXMEGA64C3</td> | ||
| 379 | * <td bgcolor="#00EE00">Yes</td> | ||
| 380 | * <td bgcolor="#EE0000">No</td> | ||
| 381 | * </tr> | ||
| 382 | * <tr> | ||
| 383 | * <td>ATXMEGA128C3</td> | ||
| 384 | * <td bgcolor="#00EE00">Yes</td> | ||
| 385 | * <td bgcolor="#EE0000">No</td> | ||
| 386 | * </tr> | ||
| 387 | * <tr> | ||
| 388 | * <td>ATXMEGA192C3</td> | ||
| 389 | * <td bgcolor="#00EE00">Yes</td> | ||
| 390 | * <td bgcolor="#EE0000">No</td> | ||
| 391 | * </tr> | ||
| 392 | * <tr> | ||
| 393 | * <td>ATXMEGA256C3</td> | ||
| 394 | * <td bgcolor="#00EE00">Yes</td> | ||
| 395 | * <td bgcolor="#EE0000">No</td> | ||
| 396 | * </tr> | ||
| 397 | * <tr> | ||
| 398 | * <td>ATXMEGA384C3</td> | ||
| 399 | * <td bgcolor="#00EE00">Yes</td> | ||
| 400 | * <td bgcolor="#EE0000">No</td> | ||
| 401 | * </tr> | ||
| 402 | * <tr> | ||
| 403 | * <td>ATXMEGA16C4</td> | ||
| 404 | * <td bgcolor="#00EE00">Yes</td> | ||
| 405 | * <td bgcolor="#EE0000">No</td> | ||
| 406 | * </tr> | ||
| 407 | * <tr> | ||
| 408 | * <td>ATXMEGA32C4</td> | ||
| 409 | * <td bgcolor="#00EE00">Yes</td> | ||
| 410 | * <td bgcolor="#EE0000">No</td> | ||
| 411 | * </tr> | ||
| 412 | * </table> | ||
| 413 | * | ||
| 414 | * \section Sec_XMEGASupport_Boards Supported Atmel Boards | ||
| 415 | * Currently supported Atmel XMEGA boards (see \ref Group_BoardTypes): | ||
| 416 | * - XMEGA A3BU Xplained | ||
| 417 | * - XMEGA B1 Xplained | ||
| 418 | * - XMEGA C3 Xplained | ||
| 419 | * | ||
| 420 | * \section Sec_XMEGASupport_ThirdParty Supported Third Party Boards | ||
| 421 | * Currently supported third-party boards (see \ref Group_BoardTypes for makefile \c BOARD constant names): | ||
| 422 | * - Custom User Boards (with Board Drivers if desired, see \ref Page_WritingBoardDrivers) | ||
| 423 | */ | ||
| 424 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/DirectorySummaries.txt b/lib/lufa/LUFA/DoxygenPages/DirectorySummaries.txt new file mode 100644 index 000000000..87b863c28 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/DirectorySummaries.txt | |||
| @@ -0,0 +1,80 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \dir Platform | ||
| 8 | * \brief Platform specific drivers. | ||
| 9 | * | ||
| 10 | * This folder contains platform specific drivers and defines for various supported architectures. These may or may | ||
| 11 | * not be used in a LUFA application, and are provided for convenience purposes. | ||
| 12 | * | ||
| 13 | * \dir Drivers | ||
| 14 | * \brief Library hardware and software drivers. | ||
| 15 | * | ||
| 16 | * This folder contains all the library hardware and software drivers for each supported board, architecture and | ||
| 17 | * microcontroller model. | ||
| 18 | * | ||
| 19 | * \dir Drivers/Misc | ||
| 20 | * \brief Miscellaneous driver files. | ||
| 21 | * | ||
| 22 | * This folder contains drivers for aspects other than the USB interface, board hardware or microcontroller peripherals. | ||
| 23 | * | ||
| 24 | * \dir Drivers/Peripheral | ||
| 25 | * \brief Microcontroller peripheral driver files. | ||
| 26 | * | ||
| 27 | * This folder contains drivers for various low level microcontroller peripherals, usually located on the microcontroller | ||
| 28 | * die within the same physical chip. | ||
| 29 | * | ||
| 30 | * \dir Drivers/USB | ||
| 31 | * \brief USB controller peripheral driver files. | ||
| 32 | * | ||
| 33 | * This folder contains the complete LUFA USB stack and controller files, including the core driver and stack, as well | ||
| 34 | * as the USB class driver implementations. | ||
| 35 | * | ||
| 36 | * \dir Drivers/USB/Core | ||
| 37 | * \brief Core USB driver files. | ||
| 38 | * | ||
| 39 | * This folder contains the core USB stack and controller driver files, to correctly implement USB functionality on the | ||
| 40 | * target architecture and microcontroller model. This | ||
| 41 | * | ||
| 42 | * \dir Drivers/USB/Class | ||
| 43 | * \brief USB Class helper driver files. | ||
| 44 | * | ||
| 45 | * This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library, | ||
| 46 | * but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive | ||
| 47 | * development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications. | ||
| 48 | * | ||
| 49 | * \dir Drivers/USB/Class/Device | ||
| 50 | * \brief USB Device Class helper driver files. | ||
| 51 | * | ||
| 52 | * Device mode drivers for the standard USB classes. | ||
| 53 | * | ||
| 54 | * \dir Drivers/USB/Class/Host | ||
| 55 | * \brief USB Host Class helper driver files. | ||
| 56 | * | ||
| 57 | * Host mode drivers for the standard USB classes. | ||
| 58 | * | ||
| 59 | * \dir Drivers/Board | ||
| 60 | * \brief Board hardware driver files. | ||
| 61 | * | ||
| 62 | * This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from | ||
| 63 | * the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of | ||
| 64 | * hardware placed on supported boards. | ||
| 65 | * | ||
| 66 | * \dir CodeTemplates | ||
| 67 | * \brief Code templates for use in LUFA powered applications. | ||
| 68 | * | ||
| 69 | * This contains code templates for board drivers, sample LUFA project makefiles and other similar templates that can be copied into | ||
| 70 | * a LUFA powered application and modified to speed up development. | ||
| 71 | * | ||
| 72 | * \dir CodeTemplates/DriverStubs | ||
| 73 | * \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate. | ||
| 74 | * | ||
| 75 | * This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those | ||
| 76 | * directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files | ||
| 77 | * copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board, | ||
| 78 | * the corresponding LUFA board APIs will work correctly with the non-standard board hardware. | ||
| 79 | */ | ||
| 80 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/Donating.txt b/lib/lufa/LUFA/DoxygenPages/Donating.txt new file mode 100644 index 000000000..68228ac94 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/Donating.txt | |||
| @@ -0,0 +1,25 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** | ||
| 8 | * \page Page_Donating Donating to Support This Project | ||
| 9 | * | ||
| 10 | * \image html Images/Author.jpg "Dean Camera, LUFA Developer" | ||
| 11 | * | ||
| 12 | * I am a software developer working on LUFA in my spare time. The development and support of this library requires | ||
| 13 | * much effort from myself, as I am the sole developer, maintainer and supporter. Please consider donating a small | ||
| 14 | * amount to support this and my future Open Source projects - All donations are <i>greatly</i> appreciated. | ||
| 15 | * | ||
| 16 | * Note that commercial entities can remove the attribution portion of the LUFA license by a one-time fee - see | ||
| 17 | * \ref Page_LicenseInfo for more details (<b>Note: Please do NOT pay this in advance through the donation link below - | ||
| 18 | * contact author for payment details.</b>). | ||
| 19 | * | ||
| 20 | * \htmlonly | ||
| 21 | * \image html "http://www.pledgie.com/campaigns/6927.png" | ||
| 22 | * \endhtmlonly | ||
| 23 | * <a href="http://www.lufa-lib.org/donate">Donate to this project via PayPal</a> - Thanks in Advance! | ||
| 24 | */ | ||
| 25 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/FutureChanges.txt b/lib/lufa/LUFA/DoxygenPages/FutureChanges.txt new file mode 100644 index 000000000..af1186374 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/FutureChanges.txt | |||
| @@ -0,0 +1,47 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_FutureChanges Future Changes | ||
| 8 | * | ||
| 9 | * Below is a list of future changes which are proposed for the LUFA library, but not yet started/complete. | ||
| 10 | * This gives an unordered list of future changes which may be available in future releases of the library. | ||
| 11 | * If you have an item to add to this list, please contact the library author via email, the LUFA mailing list, | ||
| 12 | * or post your suggestion as an enhancement request to the project bug tracker. | ||
| 13 | * | ||
| 14 | * <b>Targeted for Future Releases:</b> | ||
| 15 | * - Code Features | ||
| 16 | * -# Add hub support when in Host mode for multiple devices | ||
| 17 | * -# Investigate virtual hubs when in device mode instead of composite devices | ||
| 18 | * -# Re-add interrupt Pipe/Endpoint support | ||
| 19 | * -# Update stream APIs to use DMA transfers on supported architectures | ||
| 20 | * -# Pull out third party libraries into a separate folder and reference them as required | ||
| 21 | * -# Add a LUFA_YIELD macro for integration into a third-party RTOS | ||
| 22 | * -# Abstract out Mass Storage byte send/receive to prevent low level API use in projects | ||
| 23 | * -# Fix HID report parser usage support for array types | ||
| 24 | * -# Make HOST_DEVICE_SETTLE_DELAY_MS a global variable that can be changed | ||
| 25 | * -# Add MANDATORY_EVENT_FUNCTIONS compile time option | ||
| 26 | * -# Add watchdog support to the library and apps/bootloaders | ||
| 27 | * -# Limit the maximum size of control transfers | ||
| 28 | * - Testing/Verification | ||
| 29 | * -# Re-run USBIF test suite on all classes to formally verify operation | ||
| 30 | * -# Implement automated functional testing of all demos | ||
| 31 | * - Documentation/Support | ||
| 32 | * -# Add detailed overviews of how each demo works | ||
| 33 | * -# Add board overviews | ||
| 34 | * -# Write LUFA tutorials | ||
| 35 | * - Demos/Projects | ||
| 36 | * -# Add class driver support for Test and Measurement class | ||
| 37 | * -# Add class driver support for EEM class | ||
| 38 | * -# Add class driver support for ECM class | ||
| 39 | * -# Add class driver generic HID report host demo | ||
| 40 | * -# Implement flow control for USB to Serial project | ||
| 41 | * - Ports | ||
| 42 | * -# Port all demos to multiple architectures | ||
| 43 | * -# Finish USB XMEGA port | ||
| 44 | * -# Add AVR32 UC3C, UC3D and UC3L support | ||
| 45 | * -# Other (commercial) C compilers | ||
| 46 | */ | ||
| 47 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/GettingStarted.txt b/lib/lufa/LUFA/DoxygenPages/GettingStarted.txt new file mode 100644 index 000000000..9ceec1e04 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/GettingStarted.txt | |||
| @@ -0,0 +1,37 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_GettingStarted Getting Started | ||
| 8 | * | ||
| 9 | * Getting started with LUFA is easy; read the content below to get on your way to your first LUFA powered application. | ||
| 10 | * | ||
| 11 | * \section Sec_DemosOverview The LUFA Demo Applications | ||
| 12 | * | ||
| 13 | * Out of the box, LUFA contains a large number of pre-made class demos for you to test, experiment with and | ||
| 14 | * ultimately build upon for your own projects. All the demos (where possible) come pre-configured to build and | ||
| 15 | * run correctly on the AT90USB1287 AVR microcontroller, mounted on the Atmel USBKEY board and running at an 8MHz | ||
| 16 | * master clock. This is due to two reasons; one, it is the hardware the author possesses, and two, it is the most | ||
| 17 | * popular Atmel USB demonstration board to date. To learn how to reconfigure, recompile and program the included | ||
| 18 | * LUFA applications using different settings, see the subsections below. | ||
| 19 | * | ||
| 20 | * \section Sec_ClassOrLowLevel Class Driver and Low Level Demos | ||
| 21 | * | ||
| 22 | * Most of the included demos in the /Demos/ folder come in both ClassDriver and LowLevel varieties. If you are new | ||
| 23 | * to LUFA, it is highly recommended that you look at the ClassDriver versions first, which use the pre-made USB | ||
| 24 | * Class Drivers (\ref Group_USBClassDrivers) to simplify the use of the standard USB classes in user applications. | ||
| 25 | * These demos give a basic but easy to use interface to the USB class used in the demo application, such as HID or | ||
| 26 | * CDC. | ||
| 27 | * | ||
| 28 | * Those needing absolute control over the class implementation can look at the LowLevel demos, which implement the | ||
| 29 | * required USB class directly in the demo application using the lowest level LUFA APIs. | ||
| 30 | * | ||
| 31 | * | ||
| 32 | * <b>Subsections:</b> | ||
| 33 | * \li \subpage Page_ConfiguringApps - How to Configure the Included Demos, Projects and Bootloaders | ||
| 34 | * \li \subpage Page_CompilingApps - How to Compile the Included Demos, Projects and Bootloaders | ||
| 35 | * \li \subpage Page_ProgrammingApps - How to Program an AVR with the Included Demos, Projects and Bootloaders | ||
| 36 | */ | ||
| 37 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/Groups.txt b/lib/lufa/LUFA/DoxygenPages/Groups.txt new file mode 100644 index 000000000..2dfa4209d --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/Groups.txt | |||
| @@ -0,0 +1,38 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \defgroup Group_BoardDrivers Board Drivers | ||
| 8 | * | ||
| 9 | * \brief Functions, macros, variables, enums and types related to the control of physical board hardware. | ||
| 10 | */ | ||
| 11 | |||
| 12 | /** \defgroup Group_PeripheralDrivers On-chip Peripheral Drivers | ||
| 13 | * | ||
| 14 | * \brief Functions, macros, variables, enums and types related to the control of AVR subsystems. | ||
| 15 | */ | ||
| 16 | |||
| 17 | /** \defgroup Group_MiscDrivers Miscellaneous Drivers | ||
| 18 | * | ||
| 19 | * \brief Miscellaneous driver Functions, macros, variables, enums and types. | ||
| 20 | */ | ||
| 21 | |||
| 22 | /** \defgroup Group_PlatformDrivers_AVR8 AVR8 | ||
| 23 | * \ingroup Group_PlatformDrivers | ||
| 24 | * | ||
| 25 | * \brief Drivers relating to the AVR8 architecture platform, such as clock setup and interrupt management. | ||
| 26 | */ | ||
| 27 | |||
| 28 | /** \defgroup Group_PlatformDrivers_XMEGA XMEGA | ||
| 29 | * \ingroup Group_PlatformDrivers | ||
| 30 | * | ||
| 31 | * \brief Drivers relating to the XMEGA architecture platform, such as clock setup and interrupt management. | ||
| 32 | */ | ||
| 33 | |||
| 34 | /** \defgroup Group_PlatformDrivers_UC3 UC3 | ||
| 35 | * \ingroup Group_PlatformDrivers | ||
| 36 | * | ||
| 37 | * \brief Drivers relating to the UC3 architecture platform, such as clock setup and interrupt management. | ||
| 38 | */ | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/Images/Author.jpg b/lib/lufa/LUFA/DoxygenPages/Images/Author.jpg new file mode 100644 index 000000000..e8f5541a0 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/Images/Author.jpg | |||
| Binary files differ | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/Images/LUFA.png b/lib/lufa/LUFA/DoxygenPages/Images/LUFA.png new file mode 100644 index 000000000..54fa1a664 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/Images/LUFA.png | |||
| Binary files differ | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/Images/LUFA_thumb.png b/lib/lufa/LUFA/DoxygenPages/Images/LUFA_thumb.png new file mode 100644 index 000000000..efa538677 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/Images/LUFA_thumb.png | |||
| Binary files differ | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/KnownIssues.txt b/lib/lufa/LUFA/DoxygenPages/KnownIssues.txt new file mode 100644 index 000000000..183036c48 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/KnownIssues.txt | |||
| @@ -0,0 +1,234 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_KnownIssues Known Issues | ||
| 8 | * The following are known issues present in each official LUFA release. This list should contain all known | ||
| 9 | * issues in the library. Most of these issues should be corrected in the future release - see | ||
| 10 | * \ref Page_FutureChanges for a list of planned changes in future releases. | ||
| 11 | * | ||
| 12 | * \section Sec_KnownIssues170418 Version 170418 | ||
| 13 | * - AVR8 Architecture | ||
| 14 | * - No known issues. | ||
| 15 | * - UC3 Architecture | ||
| 16 | * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n | ||
| 17 | * | ||
| 18 | * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, | ||
| 19 | * although the architecture is supported in the LUFA core library. | ||
| 20 | * - DMA transfers to and from the USB controller are not yet implemented for this release. | ||
| 21 | * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their | ||
| 22 | * altered USB controller design. | ||
| 23 | * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file | ||
| 24 | * streams are not available on the UC3 architecture, due to a lack of suitable library support. | ||
| 25 | * - XMEGA Architecture | ||
| 26 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 27 | * | ||
| 28 | * - Endpoints of more than 64 bytes are not currently supported in this release. | ||
| 29 | * - Isochronous endpoints are not currently supported in this release. As a result, the audio class | ||
| 30 | * cannot be used on XMEGA devices. | ||
| 31 | * - Multiple-bank endpoints are not currently supported in this release. | ||
| 32 | * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata | ||
| 33 | * relating to the USB controller. | ||
| 34 | * - Architecture Independent | ||
| 35 | * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used | ||
| 36 | * and a lengthy USB operation is initiated. | ||
| 37 | * - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8/10). | ||
| 38 | * - Build System | ||
| 39 | * - No known issues. | ||
| 40 | * - Atmel Studio Integration | ||
| 41 | * - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts". | ||
| 42 | * - When switching boards after changing the device selection, a second conflicting \c BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the "Toolchain" tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition. | ||
| 43 | * | ||
| 44 | * \section Sec_KnownIssues151115 Version 151115 | ||
| 45 | * - AVR8 Architecture | ||
| 46 | * - No known issues. | ||
| 47 | * - UC3 Architecture | ||
| 48 | * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n | ||
| 49 | * | ||
| 50 | * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, | ||
| 51 | * although the architecture is supported in the LUFA core library. | ||
| 52 | * - DMA transfers to and from the USB controller are not yet implemented for this release. | ||
| 53 | * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their | ||
| 54 | * altered USB controller design. | ||
| 55 | * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file | ||
| 56 | * streams are not available on the UC3 architecture, due to a lack of suitable library support. | ||
| 57 | * - XMEGA Architecture | ||
| 58 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 59 | * | ||
| 60 | * - Endpoints of more than 64 bytes are not currently supported in this release. | ||
| 61 | * - Isochronous endpoints are not currently supported in this release. As a result, the audio class | ||
| 62 | * cannot be used on XMEGA devices. | ||
| 63 | * - Multiple-bank endpoints are not currently supported in this release. | ||
| 64 | * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata | ||
| 65 | * relating to the USB controller. | ||
| 66 | * - Architecture Independent | ||
| 67 | * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used | ||
| 68 | * and a lengthy USB operation is initiated. | ||
| 69 | * - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8). | ||
| 70 | * - Build System | ||
| 71 | * - No known issues. | ||
| 72 | * - Atmel Studio Integration | ||
| 73 | * - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts". | ||
| 74 | * - When switching boards after changing the device selection, a second conflicting \c BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the "Toolchain" tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition. | ||
| 75 | * | ||
| 76 | * \section Sec_KnownIssues140928 Version 140928 | ||
| 77 | * - AVR8 Architecture | ||
| 78 | * - No known issues. | ||
| 79 | * - UC3 Architecture | ||
| 80 | * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n | ||
| 81 | * | ||
| 82 | * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, | ||
| 83 | * although the architecture is supported in the LUFA core library. | ||
| 84 | * - DMA transfers to and from the USB controller are not yet implemented for this release. | ||
| 85 | * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their | ||
| 86 | * altered USB controller design. | ||
| 87 | * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file | ||
| 88 | * streams are not available on the UC3 architecture, due to a lack of suitable library support. | ||
| 89 | * - XMEGA Architecture | ||
| 90 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 91 | * | ||
| 92 | * - Endpoints of more than 64 bytes are not currently supported in this release. | ||
| 93 | * - Isochronous endpoints are not currently supported in this release. As a result, the audio class | ||
| 94 | * cannot be used on XMEGA devices. | ||
| 95 | * - Multiple-bank endpoints are not currently supported in this release. | ||
| 96 | * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata | ||
| 97 | * relating to the USB controller. | ||
| 98 | * - Architecture Independent | ||
| 99 | * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used | ||
| 100 | * and a lengthy USB operation is initiated. | ||
| 101 | * - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8). | ||
| 102 | * - Build System | ||
| 103 | * - No known issues. | ||
| 104 | * - Atmel Studio Integration | ||
| 105 | * - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts". | ||
| 106 | * - When switching boards after changing the device selection, a second conflicting \c BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the "Toolchain" tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition. | ||
| 107 | * | ||
| 108 | * \section Sec_KnownIssues140302 Version 140302 | ||
| 109 | * - AVR8 Architecture | ||
| 110 | * - No known issues. | ||
| 111 | * - UC3 Architecture | ||
| 112 | * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n | ||
| 113 | * | ||
| 114 | * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, | ||
| 115 | * although the architecture is supported in the LUFA core library. | ||
| 116 | * - DMA transfers to and from the USB controller are not yet implemented for this release. | ||
| 117 | * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their | ||
| 118 | * altered USB controller design. | ||
| 119 | * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file | ||
| 120 | * streams are not available on the UC3 architecture, due to a lack of suitable library support. | ||
| 121 | * - XMEGA Architecture | ||
| 122 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 123 | * | ||
| 124 | * - Endpoints of more than 64 bytes are not currently supported in this release. | ||
| 125 | * - Isochronous endpoints are not currently supported in this release. As a result, the audio class | ||
| 126 | * cannot be used on XMEGA devices. | ||
| 127 | * - Multiple-bank endpoints are not currently supported in this release. | ||
| 128 | * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata | ||
| 129 | * relating to the USB controller. | ||
| 130 | * - Architecture Independent | ||
| 131 | * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used | ||
| 132 | * and a lengthy USB operation is initiated. | ||
| 133 | * - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8). | ||
| 134 | * - Build System | ||
| 135 | * - No known issues. | ||
| 136 | * - Atmel Studio Integration | ||
| 137 | * - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts". | ||
| 138 | * - When switching boards after changing the device selection, a second conflicting BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the Toolchain tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition. | ||
| 139 | * | ||
| 140 | * \section Sec_KnownIssues130901 Version 130901 | ||
| 141 | * - AVR8 Architecture | ||
| 142 | * - No known issues. | ||
| 143 | * - UC3 Architecture | ||
| 144 | * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n | ||
| 145 | * | ||
| 146 | * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, | ||
| 147 | * although the architecture is supported in the LUFA core library. | ||
| 148 | * - DMA transfers to and from the USB controller are not yet implemented for this release. | ||
| 149 | * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their | ||
| 150 | * altered USB controller design. | ||
| 151 | * - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file | ||
| 152 | * streams are not available on the UC3 architecture, due to a lack of suitable library support. | ||
| 153 | * - XMEGA Architecture | ||
| 154 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 155 | * | ||
| 156 | * - Endpoints of more than 64 bytes are not currently supported in this release. | ||
| 157 | * - Isochronous endpoints are not currently supported in this release. As a result, the audio class | ||
| 158 | * cannot be used on XMEGA devices. | ||
| 159 | * - Multiple-bank endpoints are not currently supported in this release. | ||
| 160 | * - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata | ||
| 161 | * relating to the USB controller. | ||
| 162 | * - Architecture Independent | ||
| 163 | * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used | ||
| 164 | * and a lengthy USB operation is initiated. | ||
| 165 | * - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8). | ||
| 166 | * - Build System | ||
| 167 | * - No known issues. | ||
| 168 | * - Atmel Studio Integration | ||
| 169 | * - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts". | ||
| 170 | * - When switching boards after changing the device selection, a second conflicting BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the Toolchain tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition. | ||
| 171 | * | ||
| 172 | * \section Sec_KnownIssues130303 Version 130303 | ||
| 173 | * - AVR8 Architecture | ||
| 174 | * - No known issues. | ||
| 175 | * - UC3 Architecture | ||
| 176 | * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n | ||
| 177 | * | ||
| 178 | * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, | ||
| 179 | * although the architecture is supported in the LUFA core library. | ||
| 180 | * - DMA transfers to and from the USB controller are not yet implemented for this release. | ||
| 181 | * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their | ||
| 182 | * altered USB controller design. | ||
| 183 | * - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file | ||
| 184 | * streams are not available on the UC3 architecture, due to a lack of suitable library support. | ||
| 185 | * - XMEGA Architecture | ||
| 186 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 187 | * | ||
| 188 | * - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release, | ||
| 189 | * although the architecture is supported in the LUFA core library. | ||
| 190 | * - Endpoints of more than 64 bytes are not currently supported in this release. | ||
| 191 | * - Isochronous endpoints are not currently supported in this release. As a result, the audio class | ||
| 192 | * cannot be used on XMEGA devices. | ||
| 193 | * - Multiple-bank endpoints are not currently supported in this release. | ||
| 194 | * - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata | ||
| 195 | * relating to the USB controller. | ||
| 196 | * - Architecture Independent | ||
| 197 | * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used | ||
| 198 | * and a lengthy USB operation is initiated. | ||
| 199 | * - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8). | ||
| 200 | * - Build System | ||
| 201 | * - No known issues. | ||
| 202 | * | ||
| 203 | * \section Sec_KnownIssues120730 Version 120730 | ||
| 204 | * - AVR8 Architecture | ||
| 205 | * - No known issues. | ||
| 206 | * - UC3 Architecture | ||
| 207 | * \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n | ||
| 208 | * | ||
| 209 | * - No demos, bootloaders or projects have been ported for the UC3 devices in the current release, | ||
| 210 | * although the architecture is supported in the LUFA core library. | ||
| 211 | * - DMA transfers to and from the USB controller are not yet implemented for this release. | ||
| 212 | * - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their | ||
| 213 | * altered USB controller design. | ||
| 214 | * - The various \c CreateStream() functions for creating standard \c <stdio.h> compatible virtual file | ||
| 215 | * streams are not available on the UC3 architecture, due to a lack of suitable library support. | ||
| 216 | * - XMEGA Architecture | ||
| 217 | * \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. | ||
| 218 | * | ||
| 219 | * - No demos, bootloaders or projects have been ported for the XMEGA devices in the current release, | ||
| 220 | * although the architecture is supported in the LUFA core library. | ||
| 221 | * - Endpoints of more than 64 bytes are not currently supported in this release. | ||
| 222 | * - Isochronous endpoints are not currently supported in this release. As a result, the audio class | ||
| 223 | * cannot be used on XMEGA devices. | ||
| 224 | * - Multiple-bank endpoints are not currently supported in this release. | ||
| 225 | * - Early revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata | ||
| 226 | * relating to the USB controller. | ||
| 227 | * - Architecture Independent | ||
| 228 | * - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used | ||
| 229 | * and a lengthy USB operation is initiated. | ||
| 230 | * - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8). | ||
| 231 | * - Build System | ||
| 232 | * - No known issues. | ||
| 233 | */ | ||
| 234 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/LUFAPoweredProjects.txt b/lib/lufa/LUFA/DoxygenPages/LUFAPoweredProjects.txt new file mode 100644 index 000000000..fa94add49 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/LUFAPoweredProjects.txt | |||
| @@ -0,0 +1,226 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_LUFAPoweredProjects User Projects Powered by LUFA | ||
| 8 | * | ||
| 9 | * LUFA is currently in use all around the world, in many applications both commercial and non-commercial. Below is a | ||
| 10 | * list of known public LUFA powered projects, which all use the LUFA library in some way. Feel free to visit each project's | ||
| 11 | * home page for more information on each project. | ||
| 12 | * | ||
| 13 | * If you have a project that you would like to add to this list, please contact me via the details on the main page of this | ||
| 14 | * documentation. | ||
| 15 | * | ||
| 16 | * \section Sec_BoardsUsingLUFA AVR-USB Development Boards Using LUFA | ||
| 17 | * | ||
| 18 | * The following is a list of known AVR USB development boards, which recommend using LUFA for the USB stack. Some of these | ||
| 19 | * are open design, and all are available for purchase as completed development boards suitable for project development. | ||
| 20 | * | ||
| 21 | * \li AVR-USB-162, a USBKEY-like development board for the AT90USB162: http://olimex.com/dev/avr-usb-162.html | ||
| 22 | * \li Benito #7, a no-frills USB board: http://www.dorkbotpdx.org/wiki/benito | ||
| 23 | * \li Duce, the successor to the Benito #7: http://dorkbotpdx.org/wiki/duce | ||
| 24 | * \li JM-DB-U2, an ATMEGA32U2 development board: http://u2.mattair.net/index.html | ||
| 25 | * \li Micropendous, an open design/source set of AVR USB development boards: http://micropendous.org/ | ||
| 26 | * \li Microsin AVR-USB162 breakout board, a DIY AT90USB162 development board: http://microsin.ru/content/view/685/44/ | ||
| 27 | * \li Minimus USB, a board specially designed for PSGroove: http://www.minimususb.com/ | ||
| 28 | * \li Nanduino, a do-it-yourself AT90USB162 board: http://www.makestuff.eu/wordpress/?page_id=569 | ||
| 29 | * \li Sparkfun ATMEGA8U2 breakout board: http://www.sparkfun.com/products/10277 | ||
| 30 | * \li Teensy and Teensy++, two other AVR USB development boards: http://www.pjrc.com/teensy/index.html | ||
| 31 | * \li U2DIL/U4DIL, a set of DIP layout USB AVR boards: http://www.reworld.eu/re/en/products/u2dil/ | ||
| 32 | * \li USB2AX, a tiny USB to serial converter board: http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX | ||
| 33 | * \li USBFOO 2, AT90USB162 based development board: http://shop.kernelconcepts.de/product_info.php?products_id=102 | ||
| 34 | * | ||
| 35 | * \section Sec_LUFAProjects Projects Using LUFA (Hobbyist) | ||
| 36 | * | ||
| 37 | * The following are known hobbyist projects using LUFA. Most are open source, and show off interesting ways that the LUFA library | ||
| 38 | * can be incorporated into many different applications. | ||
| 39 | * | ||
| 40 | * \li Accelerometer Game Joystick: http://www.crictor.co.il/he/episodes/joystick/ | ||
| 41 | * \li Adjacent Reality Motion Tracker: http://www.adjacentreality.org/ | ||
| 42 | * \li AD9833 based USB Function Generator: http://tuomasnylund.fi/drupal6/content/ad9833-based-usb-function-generator | ||
| 43 | * \li AERY development platform for the AVR32 devices: http://www.aery32.com/ | ||
| 44 | * \li AM Radio transmitter: http://amcinnes.info/2012/uc_am_xmit/ | ||
| 45 | * \li Arcade Controller: http://fletchtronics.net/arcade-controller-made-petunia | ||
| 46 | * \li Arcade Joystick: http://jamie.lentin.co.uk/embedded/arcade-joystick/ | ||
| 47 | * \li AttoBasic AVR BASIC interpreter: http://cappels.org/dproj/AttoBasic_Home/AttoBasic_Home.html | ||
| 48 | * \li AVR USB Modem, a 3G Wireless Modem host: http://code.google.com/p/avrusbmodem/ | ||
| 49 | * \li Bicycle POV: http://www.code.google.com/p/bicycleledpov/ | ||
| 50 | * \li Bluetooth Explorerbot: http://code.google.com/p/bluetooth-explorerbot/ | ||
| 51 | * \li Bus Ninja, an AVR clone of the popular BusPirate project: http://blog.hodgepig.org/busninja/ | ||
| 52 | * \li CAMTRIG, a remote Camera Trigger device: http://code.astraw.com/projects/motmot/camtrig | ||
| 53 | * \li ChameleonMini, a smart card emulator: https://github.com/skuep/ChameleonMini | ||
| 54 | * \li CD Driver Emulator Dongle for ISO Files: http://cdemu.blogspot.com/ | ||
| 55 | * \li ChipWhisperer, a signal capture device: https://www.assembla.com/spaces/chipwhisperer/wiki/ChipWhisperer_Rev2_Capture_Hardware | ||
| 56 | * \li ClockTamer, a configurable clock generator: http://code.google.com/p/clock-tamer/ | ||
| 57 | * \li Collection of alternative Arduino Uno firmwares: http://hunt.net.nz/users/darran/ | ||
| 58 | * \li Computer controlled LED matrix (Russian): http://we.easyelectronics.ru/AVR/nebolshoy-primer-s-lufa-hidapi.html | ||
| 59 | * \li CULFW, a 868MHz RF packet encoder/decoder: http://www.koeniglich.de/culfw/culfw.html | ||
| 60 | * \li Dashkey, a custom PC keyboard controller: http://geekhack.org/showwiki.php?title=Island:19096 | ||
| 61 | * \li DIY PS3 controller emulator: https://code.google.com/p/diyps3controller/ | ||
| 62 | * \li EMuSer, a USB-RS422 adapter for E-Mu samplers: http://www.emxp.net/EMuSer.htm | ||
| 63 | * \li EQ Track, a telescope mount controller: http://sourceforge.net/projects/eqtrack/ | ||
| 64 | * \li Estick JTAG, an ARM JTAG debugger: http://code.google.com/p/estick-jtag/ | ||
| 65 | * \li "Fingerlicking Wingdinger" (WARNING: Bad language if no Javascript), a MIDI controller: http://noisybox.net/electronics/wingdinger/ | ||
| 66 | * \li Flyatar, a real-time fly tracking system: https://github.com/peterpolidoro/Flyatar | ||
| 67 | * \li FootJoy, a 22 button, 6-axis josystick with keyboard and mouse modes: https://bitbucket.org/sirbrialliance/foot-joy/ | ||
| 68 | * \li Gamecube controller to USB adapter: https://www.facebook.com/media/set/?set=a.10150202447076304.310536.688776303&l=df53851c50 | ||
| 69 | * \li Garmin GPS USB to NMEA standard serial sentence translator: http://github.com/nall/garmin-transmogrifier/tree/master | ||
| 70 | * \li Geiger Counter with USB interface: http://www.hforsten.com/i-made-a-geiger-counter.html | ||
| 71 | * \li Generic HID Device Creator: http://generichid.sourceforge.net/ | ||
| 72 | * \li Generic HID Open Source Framework: http://www.waitingforfriday.com/index.php/USB_Generic_HID_Open_Source_Framework_for_Atmel_AVR_and_Windows | ||
| 73 | * \li Ghetto Drum, a MIDI drum controller: http://noisybox.net/art/gdrum/ | ||
| 74 | * \li GPS enabled lap timer for vehicles: http://www.assembla.com/code/ironlung/subversion/nodes/trunk/LapTimer | ||
| 75 | * \li GSynth, an 8-bit sound synthesizer: https://github.com/gcielniak/GSynth | ||
| 76 | * \li Gumbi, a Python library and USB GPIO controller: https://code.google.com/p/gumbi/ | ||
| 77 | * \li Hardware Volume Control: https://github.com/davidk/hw-volume-control | ||
| 78 | * \li Hiduino, a USB-MIDI replacement firmware for the Arduino Uno: http://code.google.com/p/hiduino/ | ||
| 79 | * \li HoodLoader2, an Arduino Uno enhanced USB AVR coprocessor firmware: https://github.com/NicoHood/HoodLoader2 | ||
| 80 | * \li IBM capacitive keybord replacement controller: http://downloads.cornall.co/ibm-capsense-usb-web/ibm-capsense-usb.html | ||
| 81 | * \li Ikea RGB LED USB modification: http://slashhome.se/p/projects/id/ikea_dioder_usb/#project | ||
| 82 | * \li IR electricity meter monitor: http://sourceforge.net/projects/irmetermon/ | ||
| 83 | * \li IR Remote to Keyboard decoder: http://netzhansa.blogspot.com/2010/04/our-living-room-hi-fi-setup-needs-mp3.html | ||
| 84 | * \li Jukebox panic button: http://thinkl33t.co.uk/the-panic-button | ||
| 85 | * \li Kinesis replacement firmware: https://github.com/chrisandreae/kinesis-firmware | ||
| 86 | * \li LED Panel controller: http://projects.peterpolidoro.net/caltech/panelscontroller/panelscontroller.htm | ||
| 87 | * \li Linux Secure Storage Dongle: http://github.com/TomMD/teensy | ||
| 88 | * \li LUFA powered DDR dance mat (French): http://logicien-parfait.fr/dokuwiki/doku.php?id=projet:ddr_repair | ||
| 89 | * \li Macintosh SIMM ROM Programmer: https://code.google.com/p/mac-rom-simm-programmer/ | ||
| 90 | * \li MakeTV Episode Dispenser: http://www.youtube.com/watch?v=BkWUi18hl3g | ||
| 91 | * \li Mec64,a Commodore 64 keyboard: http://deskthority.net/workshop-f7/mec64-keyboard-t4522.html | ||
| 92 | * \li MidiMonster, a USB-to-MIDI gateway board: http://www.dorkbotpdx.org/wiki/midimonster | ||
| 93 | * \li MIDI Theremin: http://baldwisdom.com/usb-midi-controller-theremin-style-on-arduino-uno/ | ||
| 94 | * \li MIDI interface hack of a toy Guitar: http://blog.x37v.info/2011/06/26/toy-guitar-hacked-midi-conroller | ||
| 95 | * \li MiniBloq, a graphical Ardunio programming environment : http://minibloq.org/ | ||
| 96 | * \li MiXley, a port of the Teacup 3D printer firmware for the USB AVRs: http://codaset.com/michielh/mixley | ||
| 97 | * \li Mobo 4.3, a USB controlled all band (160-10m) HF SDR transceiver: http://sites.google.com/site/lofturj/mobo4_3 | ||
| 98 | * \li Moco, a native Arduino Uno MIDI replacement firmware: http://web.mac.com/kuwatay/morecat_lab./MocoLUFA.html | ||
| 99 | * \li Monash ECSE Smart Packet Radio Testbed: http://www.ecse.monash.edu.au/twiki/bin/view/WSRNLab/SmartPacketRadio | ||
| 100 | * \li Motherboard BIOS flasher: http://www.coreboot.org/InSystemFlasher | ||
| 101 | * \li Multi-button Joystick (French): http://logicien-parfait.fr/dokuwiki/doku.php?id=projet:joystick | ||
| 102 | * \li Music Playing Alarm Clock (Tutorial): http://www.instructables.com/id/Music-Playing-Alarm-Clock/ | ||
| 103 | * \li Nehebkau, Laptop Controlled Keyboard and Mouse: http://www.frank-zhao.com/cache/nehebkau.php | ||
| 104 | * \li NeroJTAG, a JTAG dongle: https://github.com/makestuff/neroJtag | ||
| 105 | * \li NES Controller USB modification: https://github.com/nfd/nes_adapter | ||
| 106 | * \li Nikon wireless camera remote control (Norwegian): http://hekta.org/~hpe1119/ | ||
| 107 | * \li Nintendo Four-Score, USB NES 4-player controller adapter: http://www.waitingforfriday.com/index.php/Nintendo_Four_Score_USB | ||
| 108 | * \li Numpad keyboard: http://tuomasnylund.fi/drupal6/content/usb-cherry-mx-numpad | ||
| 109 | * \li Opendous-JTAG, an open source ARM JTAG debugger: http://code.google.com/p/opendous-jtag/ | ||
| 110 | * \li Openkubus, an open source hardware-based authentication dongle: http://code.google.com/p/openkubus/ | ||
| 111 | * \li Orbee, a USB connected RGB Orb for notifications: http://www.franksworkshop.com.au/Electronics/Orbee/Orbee.htm | ||
| 112 | * \li Password keyring: http://owlsan.blogspot.no/2014/06/keyring-project-version-10.html | ||
| 113 | * \li Picade alternative firmware, a retro Arcade controller/cabinet: https://github.com/rktrlng/picade_lufa | ||
| 114 | * \li PPM signal generator over USB: https://github.com/G33KatWork/USBPPM | ||
| 115 | * \li Programmable keyboard controller: http://41j.com/blog/2011/10/a-programmable-keyboard-controller/ | ||
| 116 | * \li Programmable XBOX controller: http://richard-burke.dyndns.org/wordpress/pan-galactic-gargantuan-gargle-brain-aka-xbox-360-usb-controller/ | ||
| 117 | * \li Project Surface, a touch interface controller for Windows 8: https://code.google.com/p/project-surface/ | ||
| 118 | * \li PSGroove, a Playstation 3 Homebrew dongle: http://github.com/psgroove | ||
| 119 | * \li PS/2 to USB adapter: https://github.com/makestuff/p2ukbd | ||
| 120 | * \li RaspiFace, an Arduino platform bridge for the Raspberry Pi: http://www.raspiface.com/ | ||
| 121 | * \li Reflow oven controller: http://danstrother.com/2011/01/15/reflow-oven-controller/ | ||
| 122 | * \li RFPirate, a RF experimentation platform: https://github.com/ebuller/RF-Pirate | ||
| 123 | * \li RF Power Meter, based on the AD8307 log amp: https://sites.google.com/site/lofturj/ad8307-power-meter | ||
| 124 | * \li RF Transceiver using the MRF49XA: http://alternet.us.com/?page_id=1494 | ||
| 125 | * \li SD Card reader: http://elasticsheep.com/2010/04/teensy2-usb-mass-storage-with-an-sd-card/ | ||
| 126 | * \li SDR1, a Software Defined Radio firmware: https://code.google.com/p/sdr-mk1/ | ||
| 127 | * \li SEGA Megadrive/Genesis Development Cartridge: http://www.makestuff.eu/wordpress/?page_id=398 | ||
| 128 | * \li Serial Line bus analyser: http://www.pjrc.com/teensy/projects/SerialAnalyzer.html | ||
| 129 | * \li Simple USB LED Controller (SULC): https://github.com/scottbez1/sulc | ||
| 130 | * \li SNES custom FLASH ROM: http://electrifiedfoolingmachine.co/?page_id=633 | ||
| 131 | * \li Smartcard Detective: https://code.google.com/p/smartcarddetective/ | ||
| 132 | * \li SmartportVHD Apple II Mass Storage adapter: http://pcedric3.free.fr/SmartportVHD/ | ||
| 133 | * \li Single LED Matrix Display: http://guysoft.wordpress.com/2009/10/08/bumble-b/ | ||
| 134 | * \li Simple USB LED Controller: https://github.com/scottbez1/sulc | ||
| 135 | * \li Stripe Snoop, a Magnetic Card reader: http://www.ossguy.com/ss_usb/ | ||
| 136 | * \li Stylophone, with USB MIDI connectivity: http://www.waitingforfriday.com/index.php/Stylophone_Studio_5 | ||
| 137 | * \li Teensy SD Card .WAV file player: http://elasticsheep.com/2010/04/teensy2-usb-wav-player-part-1/ | ||
| 138 | * \li Touch It (Fabulously), presumably art: http://touch.it.fa.bulo.us/ly/ | ||
| 139 | * \li Touchscreen Input Device: http://capnstech.blogspot.com/2010/07/touchscreen-update.html | ||
| 140 | * \li UDFS, a BBC Micro USB disk filing system: https://github.com/makestuff/udfs | ||
| 141 | * \li Universal USB AVR Module: http://usbavr.bplaced.net/ | ||
| 142 | * \li USB2AX, a USB to Dynamixel network adapter: http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX | ||
| 143 | * \li USBPass, a USB password keeper: http://sroz.net/projects/usbpass/ | ||
| 144 | * \li USB Business Card: http://www.limpkin.fr/index.php?post/2012/09/15/My-new-business-card | ||
| 145 | * \li USB Function Generator: http://tuomasnylund.fi/drupal6/content/ad9833-based-usb-function-generator | ||
| 146 | * \li USB Infrared Receiver/Transmitter: http://vaton4.web2001.cz/ | ||
| 147 | * \li USB Interface for Playstation Portable Devices: http://forums.ps2dev.org/viewtopic.php?t=11001 | ||
| 148 | * \li USB MIDI to DMX controller: http://github.com/hanshuebner/miDiMX | ||
| 149 | * \li USB Mood Light: https://github.com/hsbp/usb_moodlight | ||
| 150 | * \li USB powered Geiger Counter: http://uhrheber.wordpress.com/2011/04/28/a-usb-powered-geiger-counter-for-the-z2-and-other-computers/ | ||
| 151 | * \li Userial, a USB to Serial converter with SPI, I2C and other protocols: http://www.tty1.net/userial/ | ||
| 152 | * \li Wii Classic Controller to USB converter: https://github.com/crazyiop/wii-classic-2-usb | ||
| 153 | * \li Wireless MIDI Guitar system: http://www.ise.pw.edu.pl/~wzab/wireless_guitar_system/ | ||
| 154 | * \li XBOX 360 Startup Sound Changer: http://www.homebrew-connection.org/change-your-xbox-360-startup-sounds-yourself/ | ||
| 155 | * \li Xnormidi, a C MIDI library: http://x37v.info/projects/xnormidi | ||
| 156 | * \li XUM1541, a Commodore 64 floppy drive to USB adapter: http://www.root.org/~nate/c64/xum1541/ | ||
| 157 | * \li Zeus, a touch screen computer for music manipulation: http://www.benbengler.com/developments_zeus.html | ||
| 158 | * | ||
| 159 | * \section Sec_LUFACommercialProjects Projects Using LUFA (Commercial) | ||
| 160 | * | ||
| 161 | * The following is a list of known commercial products using LUFA. Some of these are open source, although many are "black-box" | ||
| 162 | * solutions with no source code given. Those companies which have purchased a Commercial License to LUFA (see \ref Page_LicenseInfo) | ||
| 163 | * are not listed here unless specifically requested. | ||
| 164 | * | ||
| 165 | * \li Alphasphere, a MIDI input sphere device for music creation: http://www.alphasphere.com/ | ||
| 166 | * \li Arduino Uno and Leonardo, official Arduino boards: http://www.arduino.cc | ||
| 167 | * \li ARPS Locator: http://la3t.hamradio.no/lab//?id=tracker_en | ||
| 168 | * \li AsTeRICS assistive technologies project, HID actuator: http://www.asterics.eu | ||
| 169 | * \li BitFury, a Bitcoin ASIC miner: https://github.com/aauer1/LUFA-BitFury/tree/master/Projects/BitfuryBTC | ||
| 170 | * \li Ceberus, a MadCatz Xbox 360 arcade stick modifier: http://www.phreakmods.com/products/cerberus | ||
| 171 | * \li CFFA3000, a CompactFlash interface for the Apple II: http://www.dreher.net/CFforAppleII | ||
| 172 | * \li ChameleonMini, a RFID monitoring tool: https://github.com/emsec/ChameleonMini/wiki | ||
| 173 | * \li Digital Survey Instruments Magnetometer and Pointer: http://www.digitalsurveyinstruments.com/ | ||
| 174 | * \li FinchRobot, a robot designed for educational use: http://www.finchrobot.com/ | ||
| 175 | * \li Flysight, a GPS logger for wingsuit pilots: http://flysight.ca/ | ||
| 176 | * \li Goldilocks, an Arduino compatible clone: http://feilipu.me/2014/03/08/goldilocks-1284p-arduino-uno-clone/ | ||
| 177 | * \li HummingBird Kit, a robotics learning platform: http://www.hummingbirdkit.com/ | ||
| 178 | * \li LP1, an AVRISP-MKII Clone AVR Programmer: http://embeddedglow.com/items/LP1/LP1.php | ||
| 179 | * \li Penguino, an Arduino Board With On-Board LUFA Powered Debugger/Programmer: http://wiki.icy.com.au/PenguinoAVR | ||
| 180 | * \li PhatIO, a filesystem based I/O interface: http://www.phatio.com/ | ||
| 181 | * \li PIR-1, an IR control interface for consumer electronics: http://www.promixis.com/pir-1.php | ||
| 182 | * \li PIR-4, a USB Connected 4 port IR transmitter: http://promixis.com/pir-4.php | ||
| 183 | * \li PortPilot, a USB device charger with power meter: http://portpilot.net/ | ||
| 184 | * \li KeyGlove, an alternative input system: http://www.keyglove.net/ | ||
| 185 | * \li Many of Busware's Products: http://www.busware.de/ | ||
| 186 | * \li MIDIFighter, a USB-MIDI controller: http://www.midifighter.com/ | ||
| 187 | * \li MIDI USB Arduino Shield: http://openpipe.cc/products/midi-usb-shield/ | ||
| 188 | * \li Norduino, a wireless Arduino: http://norduino.robomotic.com/norduino-is-now-usb-hid/ | ||
| 189 | * \li Olimex AVR-ISP-MK2, an AVRISP-MKII Clone AVR Programmer: https://www.olimex.com/dev/avr-isp-mk2.html | ||
| 190 | * \li Retrode, a USB Games Console Cartridge Reader: http://www.retrode.org | ||
| 191 | * \li RFI21.1EU UHF RFID reader: http://www.metra.cz/rfid/uhf-rfid-ctecky/rfi21-1eu-uhf-rfid-ctecka.htm | ||
| 192 | * \li SmartCardDetective, a Smart Card analysis tool: http://www.smartcarddetective.com/ | ||
| 193 | * \li TimelapsePlus, a digital camera time lapse tool: https://github.com/timelapseplus/TimelapsePlus-Firmware | ||
| 194 | * \li USBTINY-MKII, an AVRISP-MKII Clone AVR Programmer: http://tom-itx.no-ip.biz:81/~webpage/boards/USBTiny_Mkii/USBTiny_Mkii_index.php | ||
| 195 | * \li UDS18B20 USB Temperature sensor: http://toughlog.org/uds18b20/ | ||
| 196 | * \li VMeter, a USB MIDI touch strip controller: http://www.vmeter.net/ | ||
| 197 | * \li XMEGA Development Board, using LUFA as an On-Board Programmer: http://xmega.mattair.net/ | ||
| 198 | * \li Zeptoprog, a multifunction AVR programmer: http://www.mattairtech.com/index.php/featured/zeptoprog.html | ||
| 199 | * | ||
| 200 | * \section Sec_LUFAPublications Publications Mentioning LUFA | ||
| 201 | * The following are published magazines which have either mentioned or featured the LUFA library. | ||
| 202 | * | ||
| 203 | * \li Elektor Magazine, "My First AVR-USB" by Antoine Authier (feature), January 2010 Issue | ||
| 204 | * \li Elektor Magazine, "USB is Cool/Sucks" by Jerry Jacobs and Chris Vossen (minor mention), January 2010 Issue | ||
| 205 | * \li Elektor Magazine, "20 x Open Source" by Jens Nickel, March 2010 Issue | ||
| 206 | * \li Circuit Cellar Magazine, "Advanced USB Design Debugging" by Collin O'Flynn, August 2010 Issue | ||
| 207 | * \li "Some Assembly Required: Assembly Language Programming with the AVR Microcontroller" by Timothy S. Margush | ||
| 208 | * \li Elektor Magazine, "Taming the Beast (2)" by Clemens Valens/Raymond Vermeulen, January 2014 Issue | ||
| 209 | * | ||
| 210 | * \section Sec_LUFANotableMentions Other Notable Mentions of LUFA | ||
| 211 | * The following are non-print but notable mentions of the LUFA library. | ||
| 212 | * | ||
| 213 | * \li Adafruit "Ask an Engineer", 7th November 2010 | ||
| 214 | * \li Arduino 2010 Keynote speech | ||
| 215 | * \li The Amp Hour podcast blog #11 | ||
| 216 | * \li Blackhat 2011 conference, "Exploiting USB Devices with Arduino" | ||
| 217 | * | ||
| 218 | * \section Sec_PortsAndForks Non-Official LUFA Ports and Forks | ||
| 219 | * The following are unofficial forks of the LUFA codebase, which implement different features such as support for | ||
| 220 | * additional architectures. | ||
| 221 | * | ||
| 222 | * \li NXP's official LPCOpen "LPCUSBLib" LUFA fork, for LPC devices: http://www.lpcware.com/ | ||
| 223 | * \li Kevin Mehall's LUFA port to the NXP LPC13xx: https://github.com/kevinmehall/LUFA-LPC13xx | ||
| 224 | * \li Mark Ding's port for the Silicon Labs SiM3U1xx: https://www.github.com/MarkDing/USB_CDC | ||
| 225 | * \li Mark Ding's port for the Silicon Labs EFM32 Giant Gecko: https://github.com/MarkDing/lufa-efm32 | ||
| 226 | */ | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/LibraryResources.txt b/lib/lufa/LUFA/DoxygenPages/LibraryResources.txt new file mode 100644 index 000000000..f69d4344c --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/LibraryResources.txt | |||
| @@ -0,0 +1,33 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** | ||
| 8 | * \page Page_Resources Library Resources | ||
| 9 | * | ||
| 10 | * \section Sec_UnofficialResources Unofficial Resources | ||
| 11 | * Unofficial Russian LUFA documentation translation: http://microsin.ru/Download.cnt/doc/LUFA/ \n | ||
| 12 | * Tutorial for LUFA USB Control Transfers: http://www.avrbeginners.net/new/tutorials/usb-control-transfers-with-lufa/ | ||
| 13 | * | ||
| 14 | * \section Sec_ProjectPages LUFA Related Webpages | ||
| 15 | * Project Homepage: http://www.lufa-lib.org \n | ||
| 16 | * Commercial Licenses: http://www.lufa-lib.org/license \n | ||
| 17 | * Author's Website: http://www.fourwalledcubicle.com \n | ||
| 18 | * Development Blog: http://www.fourwalledcubicle.com/blog \n | ||
| 19 | * | ||
| 20 | * \section Sec_ProjectHelp Assistance With LUFA | ||
| 21 | * Support Mailing List: http://www.lufa-lib.org/support \n | ||
| 22 | * Author's Email: dean [at] fourwalledcubicle [dot] com \n | ||
| 23 | * | ||
| 24 | * \section Sec_InDevelopment Latest In-Development Source Code | ||
| 25 | * Issue Tracker: http://www.lufa-lib.org/tracker \n | ||
| 26 | * Public GIT Repository: http://www.lufa-lib.org/git \n | ||
| 27 | * Latest Repository Source Archive: http://www.lufa-lib.org/latest-archive \n | ||
| 28 | * Commit RSS Feed: http://www.lufa-lib.org/rss \n | ||
| 29 | * | ||
| 30 | * \section Sec_USBResources USB Resources | ||
| 31 | * USB-IF Website: http://www.usb.org \n | ||
| 32 | */ | ||
| 33 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/LicenseInfo.txt b/lib/lufa/LUFA/DoxygenPages/LicenseInfo.txt new file mode 100644 index 000000000..86ed124bb --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/LicenseInfo.txt | |||
| @@ -0,0 +1,43 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** | ||
| 8 | * \page Page_LicenseInfo Source Code License | ||
| 9 | * | ||
| 10 | * The LUFA library is currently released under the MIT license, included below. | ||
| 11 | * | ||
| 12 | * \section Sec_LicenseForHumans License Summary for Human Beings | ||
| 13 | * Everyone is free to use LUFA without payment - even in commercial applications | ||
| 14 | * where the product source code is not publicly disclosed. However, use of the | ||
| 15 | * library must be in accordance with the library license conditions. | ||
| 16 | * | ||
| 17 | * If you wish to use LUFA without payment, you <b>must</b> include a copy of the | ||
| 18 | * full license text below with your product or project - on your website, and in | ||
| 19 | * an accompanying manual or other materials for the product. As long as the entire | ||
| 20 | * license text is made available and obvious to the users of your product, you | ||
| 21 | * are free to incorporate the LUFA library into your product without special | ||
| 22 | * additional licensing. | ||
| 23 | * | ||
| 24 | * \section Sec_CommercialLicenses Commercial Licensing | ||
| 25 | * In some instances the small requirement for public disclosure of LUFA within a | ||
| 26 | * product is unwanted; in these instances a commercial license is offered up as an | ||
| 27 | * alternative to the standard LUFA license. | ||
| 28 | * | ||
| 29 | * Commercial entities can opt out of the public disclosure clause in this license | ||
| 30 | * for a one-time US$1500 payment. This provides a non-exclusive modified MIT | ||
| 31 | * licensed which allows for the free use of the LUFA library, bootloaders and | ||
| 32 | * (where the sole copyright is attributed to Dean Camera) demos without public | ||
| 33 | * disclosure within an organization, in addition to three free hours of consultation | ||
| 34 | * with the library author, and priority support. | ||
| 35 | * | ||
| 36 | * Please visit the Commercial License link on \ref Page_Resources for more information on | ||
| 37 | * ordering a commercial license for your company. | ||
| 38 | * | ||
| 39 | * \section Sec_LicenseText LUFA License Text | ||
| 40 | * | ||
| 41 | * \verbinclude License.txt | ||
| 42 | */ | ||
| 43 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/MainPage.txt b/lib/lufa/LUFA/DoxygenPages/MainPage.txt new file mode 100644 index 000000000..e737c39b5 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/MainPage.txt | |||
| @@ -0,0 +1,52 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** | ||
| 8 | * \mainpage | ||
| 9 | * | ||
| 10 | * \image html Images/LUFA.png | ||
| 11 | * <div align="center"><small><i>Logo design by <a href="http://www.studiomonsoon.com">Studio Monsoon Photography</a></i></small></div> | ||
| 12 | * \n | ||
| 13 | * <div align="center"><a href="http://www.lufa-lib.org">http://www.lufa-lib.org</a></div> | ||
| 14 | * \n | ||
| 15 | * | ||
| 16 | * <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b> | ||
| 17 | * | ||
| 18 | * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_LicenseInfo). | ||
| 19 | * It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, | ||
| 20 | * feature rich framework for the development of USB peripherals and hosts. | ||
| 21 | * | ||
| 22 | * LUFA focuses on the microcontroller side of USB development only; it includes no PC host USB driver development facilities - other projects | ||
| 23 | * such as the Windows Driver Development Kit, Windows USB Device Mode Framework and libusb may be of interest for developing custom OS drivers. | ||
| 24 | * While custom USB devices can be made with LUFA using such tools, the included demos all use the inbuilt OS drivers for each USB class for | ||
| 25 | * simplicity. | ||
| 26 | * | ||
| 27 | * The library is currently in a stable release, suitable for download and incorporation into user projects for | ||
| 28 | * both host and device modes. For information about the project progression, see the blog link at \ref Page_Resources. | ||
| 29 | * | ||
| 30 | * LUFA is written specifically for the free AVR-GCC compiler, and uses several GCC-only extensions to make the | ||
| 31 | * library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, | ||
| 32 | * from the the WinAVR website (see \ref Page_Resources). | ||
| 33 | * | ||
| 34 | * The only required AVR peripherals for LUFA is the USB controller itself and interrupts - LUFA does not require the use of the | ||
| 35 | * microcontroller's timers or other hardware, leaving more hardware to the application developer. | ||
| 36 | * | ||
| 37 | * Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders of different classes | ||
| 38 | * and open source LUFA powered projects. | ||
| 39 | * | ||
| 40 | * <b>Subsections:</b> | ||
| 41 | * \li \subpage Page_LicenseInfo - Project source license and commercial use information | ||
| 42 | * \li \subpage Page_Donating - Donating to support this project | ||
| 43 | * \li \subpage Page_DeviceSupport - Current Device and Hardware Support | ||
| 44 | * \li \subpage Page_ChangeLog - Project Changelog | ||
| 45 | * \li \subpage Page_KnownIssues - Known Issues | ||
| 46 | * \li \subpage Page_FutureChanges - Planned Changes to the Library | ||
| 47 | * \li \subpage Page_GettingStarted - Getting started with LUFA | ||
| 48 | * \li \subpage Page_DevelopingWithLUFA - Developing with LUFA | ||
| 49 | * \li \subpage Page_LUFAPoweredProjects - Other Projects Using LUFA | ||
| 50 | * \li \subpage Page_Resources - LUFA and USB Related Resources | ||
| 51 | */ | ||
| 52 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/MigrationInformation.txt b/lib/lufa/LUFA/DoxygenPages/MigrationInformation.txt new file mode 100644 index 000000000..7efb312ea --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/MigrationInformation.txt | |||
| @@ -0,0 +1,717 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_Migration Migrating from Older Versions | ||
| 8 | * | ||
| 9 | * Below is migration information for updating existing projects based on previous versions of the LUFA library | ||
| 10 | * to the next version released. It does not indicate all new additions to the library in each version change, only | ||
| 11 | * areas relevant to making older projects compatible with the API changes of each new release. | ||
| 12 | * | ||
| 13 | * \section Sec_Migration170418 Version 170418 | ||
| 14 | * <b>Device Mode</b> | ||
| 15 | * - The \c CALLBACK_USB_GetDescriptor() callback function into the user application's \c wIndex parameter is now \c uint16_t, not \c uint8_t. | ||
| 16 | * | ||
| 17 | * \section Sec_Migration151115 Migrating from 140928 to 151115 | ||
| 18 | * <b>Non-USB Library Components</b> | ||
| 19 | * - The ATPROGRAM LUFA build system module now defaults to the Atmel ICE debugger tool, instead of the Atmel JTAG ICE3. | ||
| 20 | * - The \c Serial_CreateStream() and \c Serial_CreateBlockingStream() functions now require a USART base pointer for XMEGA devices as the first parameter. | ||
| 21 | * | ||
| 22 | * \section Sec_Migration140928 Migrating from 140302 to 140928 | ||
| 23 | * <b>Device Mode</b> | ||
| 24 | * - The device mode RNDIS class driver now requires a user-supplied buffer and buffer length to operate, rather | ||
| 25 | * than allocating this buffer internally. | ||
| 26 | * | ||
| 27 | * \section Sec_Migration140302 Migrating from 130901 to 140302 | ||
| 28 | * <b>USB Core</b> | ||
| 29 | * - The \c VERSION_BCD() macro has changed from accepting one floating point parameter to taking three distinct major/minor/revision integer parameters, as | ||
| 30 | * some edge cases caused incorrect parsing of the input float into the final integer BCD encoded value. | ||
| 31 | * | ||
| 32 | * <b>Non-USB Library Components</b> | ||
| 33 | * - The \c ATTR_NEVER_INLINE macro, erroneously introduced in a previous release has been removed, as it duplicates the existing \c ATTR_NO_INLINE macro. | ||
| 34 | * | ||
| 35 | * <b>Build System</b> | ||
| 36 | * - The default configuration file for Doxygen is now "doxyfile" rather than "Doxygen.conf", to conform to the Doxygen project's own default file name. | ||
| 37 | * Set \c DOXYGEN_CONF to override the new default file name. | ||
| 38 | * | ||
| 39 | * \section Sec_Migration130901 Migrating from 130303 to 130901 | ||
| 40 | * <b>Non-USB Library Components</b> | ||
| 41 | * - The Board Dataflash \c Dataflash_Init() function now automatically configures the appropriate communication interface. | ||
| 42 | * | ||
| 43 | * \section Sec_Migration130303 Migrating from 120730 to 130303 | ||
| 44 | * <b>Device Mode</b> | ||
| 45 | * - The \ref HID_KEYBOARD_LED_KANA macro was previously misspelled as \c HID_KEYBOARD_LED_KATANA, and had an incorrect value. User applications requiring this | ||
| 46 | * constant should use the new name, and remove any workarounds for the previously incorrect macro definition. | ||
| 47 | * - The \c HID_KEYBOARD_SC_EQUAL_SIGN macro has been renamed to \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN, and the previous definition of | ||
| 48 | * \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN has been renamed \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400 to conform to the definitions in the HID specification. | ||
| 49 | * | ||
| 50 | * <b>Host Mode</b> | ||
| 51 | * - The \ref HID_KEYBOARD_LED_KANA macro was previously misspelled as \c HID_KEYBOARD_LED_KATANA, and had an incorrect value. User applications requiring this | ||
| 52 | * constant should use the new name, and remove any workarounds for the previously incorrect macro definition. | ||
| 53 | * - The \c HID_KEYBOARD_SC_EQUAL_SIGN macro has been renamed to \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN, and the previous definition of | ||
| 54 | * \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN has been renamed \ref HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400 to conform to the definitions in the HID specification. | ||
| 55 | * | ||
| 56 | * \section Sec_Migration120730 Migrating from 120219 to 120730 | ||
| 57 | * <b>Device Mode</b> | ||
| 58 | * - The device mode Audio Class driver now requires an additional configuration parameter, the Audio Control interface index. Existing applications should | ||
| 59 | * be adjusted to specify the additional configuration parameter. | ||
| 60 | * - The HID_DESCRIPTOR_JOYSTICK() macro no longer takes a variable number of axis as a parameter, due to OS incompatibilities; this macro now uses a fixed | ||
| 61 | * 3 axis of data. User applications should update their calls to this macro and their report structures to suit a fixed 3-axis joystick report. If a user | ||
| 62 | * application requires more than 3 axis' of data, a custom report descriptor will need to be constructed by hand. | ||
| 63 | * - The \ref Endpoint_ConfigureEndpoint() function no longer takes in masks for the banks and direction; the number of banks is now an integer argument, and | ||
| 64 | * the direction is obtained from the full endpoint address within the device. Applications calling Endpoint_ConfigureEndpoint() should update their API | ||
| 65 | * call to use a full endpoint address (including ENDPOINT_DIR_IN or ENDPOINT_DIR_OUT direction in the MSB of the endpoint address) and an integer number | ||
| 66 | * of banks. | ||
| 67 | * - All endpoint functions now operate on full endpoint addresses within the device, rather than a directionless endpoint index. Applications should update | ||
| 68 | * their API calls to use full endpoint addresses when required within the device. | ||
| 69 | * - All device mode class drivers have been updated to use a new unified endpoint description structure for all endpoints; existing applications will need | ||
| 70 | * to update their class driver struct instantiation to match the new scheme (see \ref USB_Endpoint_Table_t). | ||
| 71 | * - The \c ENDPOINT_BANKS_SUPPORTED() and \c ENDPOINT_MAX_ENDPOINT_SIZE() macros have been removed, as these do not function correctly with the new addressing | ||
| 72 | * scheme for the endpoint APIs. Please refer to the target device's datasheet for the maximum bank size of each endpoint. | ||
| 73 | * - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains separate \c CableIndex and \c Command entries; these have been combined | ||
| 74 | * into a single \c Event element which can be constructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure | ||
| 75 | * element name. | ||
| 76 | * | ||
| 77 | * <b>Host Mode</b> | ||
| 78 | * - The Android Accessory Host class driver property strings are now a array of \c char* rather than a struct of named pointers. Existing applications | ||
| 79 | * should use C99 Designated Initializers with the property string indexes located in \ref AOA_Strings_t instead. | ||
| 80 | * - The \ref Pipe_ConfigurePipe() function no longer takes in masks for the banks and token; the number of banks is now an integer argument, and the token | ||
| 81 | * is now inferred from the full pipe address within the device, and the pipe type. Applications calling Pipe_ConfigurePipe() should update their API | ||
| 82 | * call to use a full pipe address (including PIPE_DIR_IN or PIPE_DIR_OUT direction in the MSB of the pipe address) and an integer number of banks. | ||
| 83 | * - All pipe functions now operate on full pipe addresses within the device, rather than a directionless pipe index. Applications should update their API | ||
| 84 | * calls to use full pipe addresses when required within the device. | ||
| 85 | * - All host mode class drivers have been updated to use a new unified pipe description structure for all pipes; existing applications will need to update | ||
| 86 | * their class driver struct instantiation to match the new scheme (see \ref USB_Pipe_Table_t). | ||
| 87 | * - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined | ||
| 88 | * into a single \c Event element which can be constructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure | ||
| 89 | * element name. | ||
| 90 | * - The library "LUFA/Drivers/USB/Core/ConfigDescriptor.c" source file has been renamed "LUFA/Drivers/USB/Core/ConfigDescriptors.c" as this was clashing with | ||
| 91 | * files in some low level host mode demo applications, preventing parallel project builds. If you are referencing the project source files directly instead | ||
| 92 | * of using the makefile module names, you will need to adjust your project makefile. | ||
| 93 | * | ||
| 94 | * \section Sec_Migration120219 Migrating from 111009 to 120219 | ||
| 95 | * <b>USB Core</b> | ||
| 96 | * - The HID_KEYBOARD_MODIFER_* macros in the HID class driver have been corrected to HID_KEYBOARD_MODIFIER_* (note the spelling of "modifier"). | ||
| 97 | * Existing applications should switch over to the correctly spelled macro names. | ||
| 98 | * - The names of the USB Device and USB Host class driver files have changed; a new "ClassDevice" and "ClassHost" postfix has been added to the | ||
| 99 | * respective class driver files. Projects referencing the class driver source files by filename rather than the LUFA_SRC_USBCLASS makefile | ||
| 100 | * variable should append these postfixes to the source file names. Projects including the USB class driver dispatch headers directly should either | ||
| 101 | * switch to including the main USB driver header instead, or use the updated header filenames. | ||
| 102 | * - The USB_CONFIG_ATTR_BUSPOWERED constant has been renamed to USB_CONFIG_ATTR_RESERVED, as this was misnamed. All devices must set this bit in | ||
| 103 | * the Configuration descriptor's attributes field. As all devices are assumed to be bus-powered unless stated otherwise with the | ||
| 104 | * USB_CONFIG_ATTR_SELFPOWERED flag a replacement constant for bus powered devices is not provided. | ||
| 105 | * | ||
| 106 | * <b>Device Mode</b> | ||
| 107 | * - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetInterfaceProperty(). | ||
| 108 | * Existing applications must implement this new callback, however if no audio entities are defined in the audio device's descriptors, | ||
| 109 | * this function may be hard-coded to always return false for previous behaviour to be retained. | ||
| 110 | * | ||
| 111 | * \section Sec_Migration111009 Migrating from 110528 to 111009 | ||
| 112 | * <b>Non-USB Library Components</b> | ||
| 113 | * - The \c JTAG_DEBUG_ASSERT() macro has been renamed \ref JTAG_ASSERT() to be consistent with \ref STDOUT_ASSERT(). | ||
| 114 | * | ||
| 115 | * <b>USB Core</b> | ||
| 116 | * - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of | ||
| 117 | * reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimize the compiled program | ||
| 118 | * size, the new \c ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering | ||
| 119 | * in exchange for a smaller compiled binary size. | ||
| 120 | * - The previous \c F_CLOCK symbol, required in the project makefile, has been renamed to \c F_USB. This is due to the previous name | ||
| 121 | * being far too generic for use in future architecture ports, where multiple clock domains are used. | ||
| 122 | * | ||
| 123 | * <b>Device Mode</b> | ||
| 124 | * - The Endpoint stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter. | ||
| 125 | * This should be set to \c NULL to retain previous behaviour of the functions, or point to a location where the number of bytes | ||
| 126 | * processed in the current transaction can be stored. If the \c BytesProcessed parameter is non \c NULL, each time the endpoint | ||
| 127 | * bank becomes full and the packet is sent, the routine will exit with the new \ref ENDPOINT_RWSTREAM_IncompleteTransfer | ||
| 128 | * error code to allow the user application to determine when to send the next chunk of data. | ||
| 129 | * - The \ref CDC_Device_SendString() function now expects a null terminated string instead of an explicit length. Existing code | ||
| 130 | * should use the new \ref CDC_Device_SendData() function, or remove the length parameter from the function call. | ||
| 131 | * - The \c Endpoint_ResetFIFO() function has been renamed to \ref Endpoint_ResetEndpoint(), to make the API function names more | ||
| 132 | * consistent. Existing applications using the old function name should simply replace it with a call to the new function name. | ||
| 133 | * - The \c Endpoint_*_Byte() functions have been renamed Endpoint_*_8() to ensure they are correct across all architectures. Existing | ||
| 134 | * code using these functions should replace the previous function names with the new function names. | ||
| 135 | * - The \c Endpoint_*_Word() functions have been renamed Endpoint_*_16() to ensure they are correct across all architectures. Existing | ||
| 136 | * code using these functions should replace the previous function names with the new function names. | ||
| 137 | * - The \c Endpoint_*_DWord() functions have been renamed Endpoint_*_32() to ensure they are correct across all architectures. Existing | ||
| 138 | * code using these functions should replace the previous function names with the new function names. | ||
| 139 | * - The Device mode RNDIS class driver no longer stores the incoming and outgoing packets in the class driver instance; the user is | ||
| 140 | * now expected to manually define a storage location for the packet data. Packets must now be sent and received manually via a call | ||
| 141 | * to \ref RNDIS_Device_ReadPacket() and/or \ref RNDIS_Device_SendPacket(). | ||
| 142 | * - The definition of the Audio class \ref USB_Audio_Descriptor_Format_t has been altered, to remove the fixed singular | ||
| 143 | * audio sample rate in the descriptor definition, and to rename the \c SampleFrequencyType to the more appropriate | ||
| 144 | * \c TotalDiscreteSampleRates. Existing applications will need to add an array of \ref USB_Audio_SampleFreq_t elements | ||
| 145 | * immediately following any \ref USB_Audio_Descriptor_Format_t descriptors, and insert the appropriate sampling rates | ||
| 146 | * supported by the device, as well as rename the descriptor elements to match the updated element names. | ||
| 147 | * - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetEndpointProperty(). | ||
| 148 | * Existing applications must implement this new callback, however if multiple sample rates or pitch control is not used, | ||
| 149 | * this function may be hard-coded to always return false for previous behaviour to be retained. | ||
| 150 | * - The \c USB_ConfigurationNumber, \c USB_RemoteWakeupEnabled and \c USB_CurrentlySelfPowered globals have been renamed to | ||
| 151 | * \ref USB_Device_ConfigurationNumber, \ref USB_Device_RemoteWakeupEnabled and \ref USB_Device_CurrentlySelfPowered to clearly indicate | ||
| 152 | * the USB mode they relate to. Existing applications using these variables should rename all references to the previous names. | ||
| 153 | * - The \c ENDPOINT_DESCRIPTOR_DIR_IN and \c ENDPOINT_DESCRIPTOR_DIR_OUT macros have now been replaced by \ref ENDPOINT_DIR_IN and | ||
| 154 | * \ref ENDPOINT_DIR_OUT to improve code clarity. | ||
| 155 | * - The \ref HID_DESCRIPTOR_JOYSTICK() macro now takes an additional (first) parameter indicating the number of axis in the joystick. | ||
| 156 | * | ||
| 157 | * <b>Host Mode</b> | ||
| 158 | * - The Pipe stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter. | ||
| 159 | * This should be set to \c NULL to retain previous behaviour of the functions, or point to a location where the number of bytes | ||
| 160 | * processed in the current transaction can be stored. If the BytesProcessed parameter is non \c NULL, each time the pipe | ||
| 161 | * bank becomes full and the packet is sent, the routine will exit with the new \ref PIPE_RWSTREAM_IncompleteTransfer | ||
| 162 | * error code to allow the user application to determine when to send the next chunk of data. | ||
| 163 | * - The \ref PRNT_Host_SendString() and \ref CDC_Host_SendString() functions now expect a null terminated string instead of an explicit | ||
| 164 | * length. Existing code should use the new \ref PRNT_Host_SendData() and \ref CDC_Host_SendData() functions, or remove the | ||
| 165 | * length parameter from the function call. | ||
| 166 | * - The \c Pipe_ClearErrorFlags() function has been removed, as the pipe error flags are now automatically cleared when the | ||
| 167 | * \ref Pipe_ClearError() function is called. | ||
| 168 | * - The \c Pipe_*_Byte() functions have been renamed Pipe_*_8() to ensure they are correct across all architectures. Existing code using | ||
| 169 | * these functions should replace the previous function names with the new function names. | ||
| 170 | * - The \c Pipe_*_Word() functions have been renamed Pipe_*_16() to ensure they are correct across all architectures. Existing code using | ||
| 171 | * these functions should replace the previous function names with the new function names. | ||
| 172 | * - The \c Pipe_*_DWord() functions have been renamed Pipe_*_32() to ensure they are correct across all architectures. Existing code using | ||
| 173 | * these functions should replace the previous function names with the new function names. | ||
| 174 | * - The \c USB_Host_ClearPipeStall() function has been renamed to USB_Host_ClearEndpointStall(), as it operates on a full endpoint address | ||
| 175 | * within the attached device and not a pipe within the host. Existing code using the old function name should update the function calls and | ||
| 176 | * check for correct usage. | ||
| 177 | * | ||
| 178 | * \section Sec_Migration101122 Migrating from 100807 to 101122 | ||
| 179 | * <b>USB Core</b> | ||
| 180 | * - A new USB driver source file, \c Drivers/USB/HighLevel/EndpointStream.c now exists. This source file should be added | ||
| 181 | * to all project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source | ||
| 182 | * variables. | ||
| 183 | * - A new USB driver source file, \c Drivers/USB/HighLevel/PipeStream.c now exists. This source file should be added to all | ||
| 184 | * project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables. | ||
| 185 | * - The \c EVENT_USB_InitFailure() event has been removed, as the \ref USB_Init() function will no longer fail; if not USB mode is | ||
| 186 | * specified, the controller will default to UID selection mode. | ||
| 187 | * - The USB mode specifier constants have been moved into a new enum and renamed. Existing projects should use the equivalent | ||
| 188 | * value in the new \ref USB_Modes_t enum. | ||
| 189 | * - All class driver headers are now included as part of the standard \c LUFA/Drivers/USB/USB.h master dispatch header, and should | ||
| 190 | * no longer be included separately. Class driver module source files must still be added as a separate module in the project's | ||
| 191 | * makefile if used. | ||
| 192 | * | ||
| 193 | * <b>Device Mode</b> | ||
| 194 | * - Endpoints MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application | ||
| 195 | * allocated endpoints in ascending order - or if your application uses the USB device mode class drivers, ensure that each instance's | ||
| 196 | * endpoint indexes are not overlapped with other interface's endpoints. | ||
| 197 | * - The signature for the \ref CALLBACK_USB_GetDescriptor() callback has changed, the \c void** \c const \c DescriptorAddress parameter is | ||
| 198 | * now \c const \c void** \c const \c DescriptorAddress. Existing applications should update their callback signatures to match this, and | ||
| 199 | * eliminate any casting of descriptor pointers to a non \c const pointer. | ||
| 200 | * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation | ||
| 201 | * for each class driver for the new class specific descriptor type names. | ||
| 202 | * - The \c ENDPOINT_DOUBLEBANK_SUPPORTED() macro is has been renamed \c ENDPOINT_BANKS_SUPPORTED() and now returns the total number of | ||
| 203 | * banks supported by the given endpoint. Existing code should switch to the new naming scheme, and test that the return value of the | ||
| 204 | * macro is equal to or greater than 2 to regain the previous functionality. | ||
| 205 | * - The \c EVENT_USB_Device_UnhandledControlRequest() event is now named \ref EVENT_USB_Device_ControlRequest() and fires before (not after) | ||
| 206 | * the internal library event handlers. Existing code should rename the event handlers in the user application to match the new event | ||
| 207 | * name, and should ensure that the new execution order does not affect the application's operation. | ||
| 208 | * | ||
| 209 | * <b>Host Mode</b> | ||
| 210 | * - Pipes MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application | ||
| 211 | * allocated pipes in ascending order - or if your application uses the USB host mode class drivers, ensure that each instance's | ||
| 212 | * pipe indexes are not overlapped with other interface's pipes. | ||
| 213 | * - The \c PRNT_Host_SendData() function has been renamed to \ref PRNT_Host_SendString(). Existing applications should simply | ||
| 214 | * replace all references to the obsolete function name with the new function name. | ||
| 215 | * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation | ||
| 216 | * for each class driver for the new class specific descriptor type names. | ||
| 217 | * - The Still Image Host class' function prefix has been changed from \c SImage_ to \c SI_, to remain consistent with the rest of the | ||
| 218 | * driver's enums, type defines and constants. | ||
| 219 | * | ||
| 220 | * \section Sec_Migration100807 Migrating from 100513 to 100807 | ||
| 221 | * | ||
| 222 | * <b>Non-USB Library Components</b> | ||
| 223 | * - The Dataflash board driver stub file has changed, as dataflash functions previously located in the internal | ||
| 224 | * Dataflash driver of the library have now been moved to the individual board files. Existing drivers can | ||
| 225 | * copy-paste the new functions from the board Dataflash stub driver. | ||
| 226 | * | ||
| 227 | * <b>USB Core</b> | ||
| 228 | * - A new USB driver source file, \c Drivers/USB/LowLevel/Device.c now exists. This source file should be added to all project | ||
| 229 | * makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables. | ||
| 230 | * - The \c Drivers/USB/LowLevel/DevChapter9.c source file has moved to \c Drivers/USB/HighLevel/DeviceStandardReq.c - this should | ||
| 231 | * be updated in all project makefiles, or the makefile should be updated to use the new module source variables. | ||
| 232 | * - The \c Drivers/USB/LowLevel/HostChapter9.h source file has moved to \c Drivers/USB/HighLevel/HostStandardReq.c - this should | ||
| 233 | * be updated in all project makefiles, or the makefile should be updated to use the new module source variables. | ||
| 234 | * - The \c Drivers/USB/LowLevel/LowLevel.c source file has moved to \c Drivers/LowLevel/USBController.c - this should be updated | ||
| 235 | * in all project makefiles, or the makefile should be updated to use the new module source variables. | ||
| 236 | * | ||
| 237 | * <b>Device Mode</b> | ||
| 238 | * - The \c USB_Device_IsRemoteWakeupSent() macro has been removed, as the remote wakeup request is now fully handled by the | ||
| 239 | * enhanced \ref USB_Device_SendRemoteWakeup() function. Existing code may now discard any checks to \c USB_Device_IsRemoteWakeupSent(). | ||
| 240 | * - The \c USB_Device_IsUSBSuspended() macro has been removed, as it is obsolete. Existing code should compare \ref USB_DeviceState | ||
| 241 | * to see if it the device is in the \ref DEVICE_STATE_Suspended state instead. | ||
| 242 | * - The \ref CDC_Device_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was | ||
| 243 | * received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact | ||
| 244 | * number of queued bytes received is not needed. | ||
| 245 | * | ||
| 246 | * <b>Host Mode</b> | ||
| 247 | * - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was | ||
| 248 | * received. This allows for more efficient coding, as a call to \ref CDC_Host_BytesReceived() is no longer needed if the exact | ||
| 249 | * number of queued bytes received is not needed. | ||
| 250 | * - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual | ||
| 251 | * flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask(). | ||
| 252 | * | ||
| 253 | * \section Sec_Migration100513 Migrating from 100219 to 100513 | ||
| 254 | * | ||
| 255 | * <b>Non-USB Library Components</b> | ||
| 256 | * - The \ref TWI_StartTransmission() function now takes in a timeout period, expressed in milliseconds, within which the addressed | ||
| 257 | * device must respond or the function will abort. | ||
| 258 | * | ||
| 259 | * <b>Device Mode</b> | ||
| 260 | * - The \ref USB_Init() function no longer calls \c sei() to enable global interrupts, as the user application may need | ||
| 261 | * to perform other initialization before it is ready to handle global interrupts. The user application is now responsible | ||
| 262 | * for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process | ||
| 263 | * functions correctly. | ||
| 264 | * - The \c USBInterrupt.c USB driver source file has been relocated from \c LUFA/Drivers/USB/HighLevel/ to \c LUFA/Drivers/USB/LowLevel. | ||
| 265 | * Projects must update their makefile SRC values accordingly. | ||
| 266 | * - The HID Device Class driver's function signature for the \ref CALLBACK_HID_Device_ProcessHIDReport() function has been changed, to | ||
| 267 | * allow for a new \c ReportType parameter. This new parameter must be added in all user applications using the Device mode HID Class | ||
| 268 | * Driver, but may be ignored unless Host-to-Device FEATURE HID reports are used. | ||
| 269 | * | ||
| 270 | * <b>Host Mode</b> | ||
| 271 | * - The \ref USB_Init() function no longer calls \c sei() to enable global interrupts, as the user application may need | ||
| 272 | * to perform other initialization before it is ready to handle global interrupts. The user application is now responsible | ||
| 273 | * for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process | ||
| 274 | * functions correctly. | ||
| 275 | * - The \c USBInterrupt.c USB driver source file has been relocated from \c LUFA/Drivers/USB/HighLevel/ to \c LUFA/Drivers/USB/LowLevel. | ||
| 276 | * Projects must update their makefile \c SRC values accordingly. | ||
| 277 | * - The HID Host Class driver's function signature for the \ref HID_Host_SendReportByID() function has been changed, to allow for a new | ||
| 278 | * ReportType parameter. Existing calls to this function should substitute \c REPORT_ITEM_TYPE_Out as this parameter's value. | ||
| 279 | * | ||
| 280 | * \section Sec_Migration100219 Migrating from 091223 to 100219 | ||
| 281 | * | ||
| 282 | * <b>Non-USB Library Components</b> | ||
| 283 | * - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models, | ||
| 284 | * the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used | ||
| 285 | * when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function | ||
| 286 | * is an exception, and should always be called with a channel number rather than a channel mask. | ||
| 287 | * | ||
| 288 | * <b>Host Mode</b> | ||
| 289 | * - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be | ||
| 290 | * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send | ||
| 291 | * pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually | ||
| 292 | * flush the queued event(s) to the device by calling \ref MIDI_Host_Flush(). | ||
| 293 | * - The \ref Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address | ||
| 294 | * is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint | ||
| 295 | * address against the \ref PIPE_EPNUM_MASK token before calling \ref Pipe_IsEndpointBound(). | ||
| 296 | * | ||
| 297 | * <b>Device Mode</b> | ||
| 298 | * - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be | ||
| 299 | * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send | ||
| 300 | * endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually | ||
| 301 | * flush the queued event(s) to the host by calling \ref MIDI_Device_Flush(). | ||
| 302 | * | ||
| 303 | * \section Sec_Migration091223 Migrating from 091122 to 091223 | ||
| 304 | * | ||
| 305 | * <b>Host Mode</b> | ||
| 306 | * - The Still Image Host Class driver \ref SI_Host_USBTask() and \ref SI_Host_ConfigurePipes() functions were misnamed, and are | ||
| 307 | * now named \c SImage_Host_USBTask() and \c SImage_Host_ConfigurePipes() respectively. | ||
| 308 | * - The \c HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to \ref HOST_SENDCONTROL_DeviceDisconnected to be in | ||
| 309 | * line with the rest of the library error codes. | ||
| 310 | * - The HID Parser item usages no longer contain separate minimum and maximum values, as this was a violation of the HID | ||
| 311 | * specification. Instead, the values are distributed evenly across each item as its usage value, to ensure that all items | ||
| 312 | * can be distinguished from one-another. | ||
| 313 | * | ||
| 314 | * <b>Device Mode</b> | ||
| 315 | * - The \ref CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new \c ReportType parameter to | ||
| 316 | * indicate the report type to generate. Existing applications may simply add and ignore this additional parameter. | ||
| 317 | * | ||
| 318 | * \section Sec_Migration091122 Migrating from 090924 to 091122 | ||
| 319 | * | ||
| 320 | * <b>Host Mode</b> | ||
| 321 | * - The \c HID_PARSE_UsageStackOverflow HID parser error constant is now named \ref HID_PARSE_UsageListOverflow | ||
| 322 | * - The \ref CALLBACK_HIDParser_FilterHIDReportItem() HID Parser callback now passes a complete \ref HID_ReportItem_t to the | ||
| 323 | * user application, instead of just its attributes. | ||
| 324 | * - The \c USB_GetDeviceConfigDescriptor() function was incorrectly named and is now called \ref USB_Host_GetDeviceConfigDescriptor(). | ||
| 325 | * | ||
| 326 | * \section Sec_Migration090924 Migrating from 090810 to 090924 | ||
| 327 | * | ||
| 328 | * <b>Non-USB Library Components</b> | ||
| 329 | * - The \c ADC_Off() function has been renamed to \c ADC_ShutDown() to be consistent with the rest of the library. | ||
| 330 | * - The \ref SPI_Init() routine's parameters have changed, so that the clock polarity and data sampling modes can be set. See | ||
| 331 | * the \ref SPI_Init() function documentation for more details | ||
| 332 | * - The \ref Dataflash_Init() routine no longer initializes the SPI bus - the SPI bus should be initialized manually via a | ||
| 333 | * call to \ref SPI_Init() before using the Dataflash driver | ||
| 334 | * | ||
| 335 | * <b>Host Mode</b> | ||
| 336 | * - The \c USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to | ||
| 337 | * preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single | ||
| 338 | * call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user | ||
| 339 | * application perform these intermediary steps. | ||
| 340 | * - The HID report parser now requires a mandatory callback in the user code, to filter only the items the application | ||
| 341 | * is interested in into the processed HID report item structure to save RAM. See \ref CALLBACK_HIDParser_FilterHIDReportItem(). | ||
| 342 | * - The HID report parser now always parses FEATURE and always ignores constant-data items - the \c HID_ENABLE_FEATURE_PROCESSING | ||
| 343 | * and \c HID_INCLUDE_CONSTANT_DATA_ITEMS compile time tokens now have no effect. | ||
| 344 | * - The \c USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate \c USB_Descriptor_* | ||
| 345 | * and \c USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in | ||
| 346 | * the one project. For existing projects using the standardized names, change all code to use the \c USB_StdDescriptor_* variants. | ||
| 347 | * | ||
| 348 | * <b>Device Mode</b> | ||
| 349 | * - The \c USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate \c USB_Descriptor_* | ||
| 350 | * and \c USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in | ||
| 351 | * the one project. For existing projects using the standardized names, change all code to use the \c USB_StdDescriptor_* variants. | ||
| 352 | * | ||
| 353 | * \section Sec_Migration090810 Migrating from 090605 to 090810 | ||
| 354 | * | ||
| 355 | * <b>All</b> | ||
| 356 | * - The "Simple Scheduler" has been <i>deprecated</i>, as it was little more than an abstracted loop and caused much confusion. | ||
| 357 | * User applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future | ||
| 358 | * release. | ||
| 359 | * - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never | ||
| 360 | * used in user applications. | ||
| 361 | * | ||
| 362 | * <b>Non-USB Library Components</b> | ||
| 363 | * - The \c ATTR_NOINLINE function attribute macro has been renamed to \ref ATTR_NO_INLINE to be in line with the rest of the function attribute | ||
| 364 | * macro names. | ||
| 365 | * | ||
| 366 | * <b>Library Demos</b> | ||
| 367 | * - Most demos now have a corresponding Class Driver implementation, which uses the new internal library class drivers for the standard | ||
| 368 | * USB classes. This allows for more rapid device and host development, and so should be used in preference to the low level APIs where | ||
| 369 | * possible so that fixes to the class drivers propagate to all applications which use them automatically with each new LUFA release. | ||
| 370 | * | ||
| 371 | * <b>Host Mode</b> | ||
| 372 | * - The \c HIDParser.c module has moved from \c LUFA/Drivers/USB/Class/ to \c LUFA/Drivers/USB/Class/Host/. | ||
| 373 | * - The \c USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first | ||
| 374 | * parameter, to add support for multi-configuration devices. Existing code should use a configuration index of 1 to indicate the | ||
| 375 | * first configuration descriptor within the device. | ||
| 376 | * - The non-standard "Ready" host state has been removed. Existing \ref HOST_STATE_Configured code should be moved to the end of | ||
| 377 | * the existing \ref HOST_STATE_Addressed state, and the existing HOST_STATE_Ready state code should be moved to the \ref HOST_STATE_Configured | ||
| 378 | * state. | ||
| 379 | * - The \c USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_HostState explicitly to ensure the host is | ||
| 380 | * in the desired state instead. | ||
| 381 | * - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode | ||
| 382 | * events. See the \ref Group_Events page for details on the new event names and firing conditions. | ||
| 383 | * | ||
| 384 | * <b>Device Mode</b> | ||
| 385 | * - The \ref CALLBACK_USB_GetDescriptor() function now takes an extra parameter to specify the descriptor's memory space so that | ||
| 386 | * descriptors in mixed memory spaces can be used. The previous functionality can be returned by defining the \c USE_FLASH_DESCRIPTORS | ||
| 387 | * token in the project makefile to fix all descriptors into FLASH space and remove the extra function parameter. | ||
| 388 | * - The \c USB_IsSuspended global has been removed - test \ref USB_DeviceState against \ref DEVICE_STATE_Suspended instead. | ||
| 389 | * - The \c USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_DeviceState explicitly to ensure the device | ||
| 390 | * is in the desired state instead. | ||
| 391 | * - The VBUS events have been removed, as they are already exposed to the user via the \c USB_Connect and \c USB_Disconnect events. | ||
| 392 | * - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode | ||
| 393 | * events. See the \ref Group_Events page for details on the new event names and firing conditions. | ||
| 394 | * | ||
| 395 | * \section Sec_Migration090605 Migrating from 090510 to 090605 | ||
| 396 | * | ||
| 397 | * <b>Device Mode</b> | ||
| 398 | * - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing | ||
| 399 | * projects using interrupts on non-control endpoints should switch to polling. For control interrupts, the library can | ||
| 400 | * manage the control endpoint via interrupts automatically by compiling with the \c INTERRUPT_CONTROL_ENDPOINT token defined. | ||
| 401 | * - The \c DESCRIPTOR_ADDRESS() macro has been removed. User applications should use normal casts to obtain a descriptor's memory | ||
| 402 | * address. | ||
| 403 | * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See | ||
| 404 | * \ref Group_Events for new API details. | ||
| 405 | * - The \c STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular | ||
| 406 | * function signatures of a function accepting no arguments and returning a \c uint8_t value. | ||
| 407 | * - The \c Event_DeviceError() event no longer exists, as its sole caller (unlinked \c USB_GetDescriptor() function) now produces a | ||
| 408 | * compilation error rather than a runtime error. The \c StdDescriptors.c file no longer exists as a result, and should be removed | ||
| 409 | * from project makefiles. | ||
| 410 | * - The \c USB_GetDescriptor() function has been renamed to \ref CALLBACK_USB_GetDescriptor() to be in line with the new \c CALLBACK_ | ||
| 411 | * function prefixes for functions which <i>must</i> be implemented in the user application. | ||
| 412 | * | ||
| 413 | * <b>Host Mode</b> | ||
| 414 | * - Support for non-control data pipe interrupts has been dropped due to many issues in the implementation. All existing | ||
| 415 | * projects using interrupts on non-control pipes should switch to polling. | ||
| 416 | * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See | ||
| 417 | * \ref Group_Events for new API details. | ||
| 418 | * - The \c STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular | ||
| 419 | * function signatures of a function accepting no arguments and returning a \c uint8_t value. | ||
| 420 | * - The \c DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with | ||
| 421 | * regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a \c uint8_t value. | ||
| 422 | * | ||
| 423 | * \section Sec_Migration090510 Migrating from 090401 to 090510 | ||
| 424 | * | ||
| 425 | * <b>All</b> | ||
| 426 | * - The \c ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all | ||
| 427 | * \c BUTTLOADTAG() elements, or download and extract \c ButtLoadTag.h header from the ButtLoad project. | ||
| 428 | * - The \c Drivers/AT90USBXXX/ directory has been renamed to \c Drivers/Peripheral/. | ||
| 429 | * - The \c Serial_Stream driver has been renamed to \c SerialStream to remain consistent with the rest of the library naming scheme. | ||
| 430 | * - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API. | ||
| 431 | * | ||
| 432 | * <b>Dual Role Mode</b> | ||
| 433 | * - The \c USB_PowerOnFail event has been renamed to \c USB_InitFailure. | ||
| 434 | * - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more | ||
| 435 | * details. | ||
| 436 | * | ||
| 437 | * <b>Device Mode</b> | ||
| 438 | * - The \c Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the \ref Endpoint_ClearIN(), \ref Endpoint_ClearOUT() | ||
| 439 | * macros. See \c Endpoint.h documentation for more details on the new endpoint management macros. | ||
| 440 | * - The \c Endpoint_ReadWriteAllowed() macro has been renamed to \ref Endpoint_IsReadWriteAllowed() to be more consistent with the rest of | ||
| 441 | * the API naming scheme. | ||
| 442 | * - The \c Endpoint_IsSetupINReady() and \c Endpoint_IsSetupOUTReceived() macros have been renamed to \ref Endpoint_IsINReady() and | ||
| 443 | * \ref Endpoint_IsOUTReceived() respectively. | ||
| 444 | * - The \c Endpoint_IsSetupReceived() macro has been renamed to \ref Endpoint_IsSETUPReceived(). | ||
| 445 | * - The \c Endpoint_ClearSetupReceived() macro has been renamed to \ref Endpoint_ClearSETUP(). | ||
| 446 | * - All endpoint read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Endpoint_Read_Word()) have | ||
| 447 | * been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions. | ||
| 448 | * - The \c USB_UnhandledControlPacket event no longer has any parameters. User code should no longer attempt to read in the remainder of | ||
| 449 | * the Control Request header as all Control Request header data is now preloaded by the library and made available in the | ||
| 450 | * USB_ControlRequest structure. | ||
| 451 | * - The \c FEATURELESS_CONTROL_ONLY_DEVICE token has been renamed to \c CONTROL_ONLY_DEVICE. | ||
| 452 | * - The \c STATIC_ENDPOINT_CONFIGURATION is no longer applicable as the library will apply this optimization when appropriate automatically. | ||
| 453 | * - The values of the \ref Endpoint_Stream_RW_ErrorCodes_t and \ref Endpoint_ControlStream_RW_ErrorCodes_t enums have had the \c ERROR_ portion | ||
| 454 | * of their names removed. | ||
| 455 | * | ||
| 456 | * <b>Host Mode</b> | ||
| 457 | * - The \ref USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on | ||
| 458 | * other control type pipes. Care should be taken to ensure that the Control pipe is always selected before the function is called | ||
| 459 | * in existing projects where the Control pipe is to be operated on. | ||
| 460 | * - The USB Host management task now saves and restores the currently selected pipe before and after the task runs. Projects no longer | ||
| 461 | * need to manage this manually when calling the USB management task. | ||
| 462 | * - The \c Pipe_ClearCurrentBank() macro has been removed, and is now replaced with the Pipe_ClearIN(), Pipe_ClearOUT() macros. See | ||
| 463 | * Pipe.h documentation for more details on the new pipe management macros. | ||
| 464 | * - The \c Pipe_ReadWriteAllowed() macro has been renamed to \ref Pipe_IsReadWriteAllowed() to be more consistent with the rest of the API | ||
| 465 | * naming scheme. | ||
| 466 | * - The \c Pipe_IsSetupINReceived() and \c Pipe_IsOutReady() macros have been renamed to \ref Pipe_IsINReceived() and \ref Pipe_IsOUTReady() | ||
| 467 | * respectively. | ||
| 468 | * - The new \ref Pipe_ClearSETUP() macro should be used to send SETUP transactions, rather than the previous \c Pipe_ClearSetupOUT() macro. | ||
| 469 | * - The \c Pipe_IsSetupSent() macro has been renamed to \ref Pipe_IsSETUPSent(). | ||
| 470 | * - The \c Pipe_ClearSetupSent() macro is no longer applicable and should be removed. | ||
| 471 | * - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Pipe_Read_Word()) have | ||
| 472 | * been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions. | ||
| 473 | * - The \c Host_IsResetBusDone() macro has been renamed to \c Host_IsBusResetComplete(). | ||
| 474 | * - The \c Pipe_Ignore_Word() and \c Pipe_Ignore_DWord() functions have been renamed to \c Pipe_Discard_Word() and \c Pipe_Discard_DWord() | ||
| 475 | * to remain consistent with the rest of the pipe API. | ||
| 476 | * - It is no longer needed to manually include the headers from \c LUFA/Drivers/USB/Class, as they are now included along with the rest | ||
| 477 | * of the USB headers when \c LUFA/Drivers/USB/USB.h is included. | ||
| 478 | * - Functions in the \c ConfigDescriptor.h header file no longer have \c Host_ as part of their names. | ||
| 479 | * - The \c ProcessHIDReport() has been renamed to \ref USB_ProcessHIDReport(), \c GetReportItemInfo() has been renamed to \ref USB_GetHIDReportItemInfo() | ||
| 480 | * and \c SetReportItemInfo() has been renamed to \ref USB_GetHIDReportItemInfo(). | ||
| 481 | * - The values of the \ref DSearch_Return_ErrorCodes_t and \ref DSearch_Comp_Return_ErrorCodes_t enums have had their respective \c Descriptor_Search | ||
| 482 | * and \c Descriptor_Search_Comp prefixes changed to all caps. | ||
| 483 | * - The \c USB_HostRequest global has been renamed to \ref USB_ControlRequest, and is used in Device mode also. The \c USB_Host_Request_Header_t | ||
| 484 | * structure type has been renamed to \ref USB_Request_Header_t. | ||
| 485 | * - The values of the \ref Pipe_Stream_RW_ErrorCodes_t enum have had the \c ERROR_ portion of their names removed. | ||
| 486 | * | ||
| 487 | * \section Sec_Migration090401 Migrating from 090209 to 090401 | ||
| 488 | * | ||
| 489 | * <b>All</b> | ||
| 490 | * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant \c F_USB, | ||
| 491 | * defined in the project makefile and passed to the compiler via the -D switch. | ||
| 492 | * - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the | ||
| 493 | * EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called. | ||
| 494 | * - As the avr-libc macro has been corrected in recent avr-libc distributions, the \c SetSystemClockPrescaler() macro has been removed. | ||
| 495 | * Include \c <avr/power.h> and call \c clock_prescale_set(clock_div_1); instead on recent avr-libc distributions. | ||
| 496 | * | ||
| 497 | * <b>Library Demos</b> | ||
| 498 | * - The USBtoSerial demo now discards all data when not connected to a host, rather than buffering it for later transmission. | ||
| 499 | * | ||
| 500 | * <b>Non-USB Library Components</b> | ||
| 501 | * - The \c ATTR_ALWAYSINLINE function attribute macro has been renamed to \ref ATTR_ALWAYS_INLINE. | ||
| 502 | * - Custom board Dataflash drivers now require the implementation of \ref Dataflash_SelectChipFromPage() and \ref Dataflash_SendAddressBytes(). | ||
| 503 | * | ||
| 504 | * <b>Device Mode</b> | ||
| 505 | * - The \c NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to \c FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded | ||
| 506 | * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the | ||
| 507 | * \c NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the \c FEATURELESS_CONTROL_ONLY_DEVICE token with no further | ||
| 508 | * modifications required. | ||
| 509 | * | ||
| 510 | * \section Sec_Migration090209 Migrating from 081217 to 090209 | ||
| 511 | * | ||
| 512 | * <b>Device Mode</b> | ||
| 513 | * - The \c ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of \c ENDPOINT_TOTAL_ENDPOINTS. | ||
| 514 | * - The \c USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user | ||
| 515 | * makefile if desired to restore the previous 50ms timeout. | ||
| 516 | * | ||
| 517 | * <b>Host Mode</b> | ||
| 518 | * - The \c PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of \c PIPE_TOTAL_ENDPOINTS. | ||
| 519 | * - The \c USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user | ||
| 520 | * makefile if desired to restore the previous 50ms timeout. | ||
| 521 | * - The \c USB_DeviceEnumerationFailed event now contains a second \c SubErrorCode parameter, giving the error code of the function | ||
| 522 | * which failed. | ||
| 523 | * - The \c HID_PARSE_Sucessful enum member constant name has been corrected to \ref HID_PARSE_Successful. | ||
| 524 | * | ||
| 525 | * <b>Non-USB Library Components</b> | ||
| 526 | * - The previous \c SPI_SendByte() functionality is now located in \ref SPI_TransferByte(). \ref SPI_SendByte() now discards the return byte | ||
| 527 | * for speed, to compliment the new \ref SPI_ReceiveByte() function. If bidirectional SPI transfers are required, calls to \ref SPI_SendByte() | ||
| 528 | * should be changed to \ref SPI_TransferByte(). | ||
| 529 | * - The serial driver now sets the Tx line as an output explicitly, and enables the pull-up of the Rx line. | ||
| 530 | * - The \ref Serial_Init() and \c SerialStream_Init() functions now take a second \c DoubleSpeed parameter, which indicates if the USART | ||
| 531 | * should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at the given AVR | ||
| 532 | * clock speed. | ||
| 533 | * | ||
| 534 | * \section Sec_Migration171208 Migrating from V1.5.3 to 081217 | ||
| 535 | * | ||
| 536 | * <b>All</b> | ||
| 537 | * - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names, | ||
| 538 | * have been changed to LUFA. | ||
| 539 | * | ||
| 540 | * <b>Library Demos</b> | ||
| 541 | * - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding | ||
| 542 | * parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version. | ||
| 543 | * - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and | ||
| 544 | * KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects | ||
| 545 | * built on either "WithParser" demo should update to the latest code. | ||
| 546 | * - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not | ||
| 547 | * recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes, | ||
| 548 | * as it is neither a full nor a standards compliant implementation. | ||
| 549 | * | ||
| 550 | * <b>Non-USB Library Components</b> | ||
| 551 | * - The Serial_IsCharReceived() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h. | ||
| 552 | * | ||
| 553 | * <b>Device Mode</b> | ||
| 554 | * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask | ||
| 555 | * to be used in the Options parameter of the USB_Init() function. | ||
| 556 | * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is | ||
| 557 | * currently initialized. | ||
| 558 | * - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library | ||
| 559 | * or user request processing code to exceed the strict USB timing requirements on control transfers. | ||
| 560 | * - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured | ||
| 561 | * after a Reset event, it should be altered to explicitly re-initialize all user endpoints. | ||
| 562 | * - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now | ||
| 563 | * returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified | ||
| 564 | * descriptor does not exist. | ||
| 565 | * - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the | ||
| 566 | * GetDescriptor function. | ||
| 567 | * | ||
| 568 | * <b>Host Mode</b> | ||
| 569 | * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask | ||
| 570 | * to be used in the Options parameter of the USB_Init() function. | ||
| 571 | * - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and | ||
| 572 | * SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the | ||
| 573 | * current report. If sending a report to a multi-report device, the first byte of the report is automatically | ||
| 574 | * set to the report ID of the given report item. | ||
| 575 | * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is | ||
| 576 | * currently initialized. | ||
| 577 | * | ||
| 578 | * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3 | ||
| 579 | * | ||
| 580 | * <b>Library Demos</b> | ||
| 581 | * - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number | ||
| 582 | * string is required in Mass Storage devices, or devices which are to retain settings when moved between | ||
| 583 | * ports on a machine. As people were not changing the serial number value, this was causing conflicts and so | ||
| 584 | * the serial number descriptor has been removed from all but the Mass Storage demo, which requires it. | ||
| 585 | * - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated | ||
| 586 | * them. Projects built upon either demo should upgrade to the latest code. | ||
| 587 | * - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented. | ||
| 588 | * - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built | ||
| 589 | * on the MassStoreDemo code should update to the latest version. | ||
| 590 | * - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused | ||
| 591 | * problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade | ||
| 592 | * to the latest code. | ||
| 593 | * - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects | ||
| 594 | * built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code. | ||
| 595 | * - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should | ||
| 596 | * upgrade to the latest code. | ||
| 597 | * - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was | ||
| 598 | * previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update | ||
| 599 | * to the latest code. | ||
| 600 | * | ||
| 601 | * <b>Device Mode</b> | ||
| 602 | * - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream. | ||
| 603 | * If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The | ||
| 604 | * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired | ||
| 605 | * timeout duration in ms. | ||
| 606 | * - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled | ||
| 607 | * and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and | ||
| 608 | * USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details. | ||
| 609 | * - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated | ||
| 610 | * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing | ||
| 611 | * the token NO_STREAM_CALLBACKS to the compiler using the -D switch. | ||
| 612 | * | ||
| 613 | * <b>Host Mode</b> | ||
| 614 | * - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream. | ||
| 615 | * If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The | ||
| 616 | * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired | ||
| 617 | * timeout duration in ms. | ||
| 618 | * - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures. | ||
| 619 | * - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated | ||
| 620 | * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing | ||
| 621 | * the token NO_STREAM_CALLBACKS to the compiler using the -D switch. | ||
| 622 | * | ||
| 623 | * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2 | ||
| 624 | * | ||
| 625 | * <b>Library Demos</b> | ||
| 626 | * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations | ||
| 627 | * of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade | ||
| 628 | * to the latest code. | ||
| 629 | * - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where | ||
| 630 | * possible any existing devices upgrade to the latest bootloader code. | ||
| 631 | * | ||
| 632 | * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1 | ||
| 633 | * | ||
| 634 | * <b>Library Demos</b> | ||
| 635 | * - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the | ||
| 636 | * global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo | ||
| 637 | * should upgrade to the latest code. | ||
| 638 | * - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID | ||
| 639 | * demos should upgrade to the latest code. | ||
| 640 | * - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors. | ||
| 641 | * Projects built upon the HID demos should upgrade to the latest code. | ||
| 642 | * - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo | ||
| 643 | * should upgrade to the latest code. | ||
| 644 | * - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power. | ||
| 645 | * Projects built upon the AudioOut demo should upgrade to the latest code. | ||
| 646 | * | ||
| 647 | * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0 | ||
| 648 | * | ||
| 649 | * <b>Library Demos</b> | ||
| 650 | * - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To | ||
| 651 | * avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing | ||
| 652 | * projects should at least manually correct the BCD version numbers, or preferably update the descriptors to | ||
| 653 | * encode the version number in BCD format using the new macro. | ||
| 654 | * - The mandatory GetReport class-specific request was accidentally omitted from previous versions of the demos | ||
| 655 | * based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the | ||
| 656 | * HID demos should also be updated accordingly. | ||
| 657 | * - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission. | ||
| 658 | * Failure to do this on projects which always or frequently send full packets will cause buffering issues on | ||
| 659 | * the host OS. All CDC user projects are advised to update their transmission routines in the same manner as | ||
| 660 | * the library CDC demos. | ||
| 661 | * - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected | ||
| 662 | * Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven | ||
| 663 | * demos should also update to properly save and restore the selected Endpoint/Pipe. | ||
| 664 | * | ||
| 665 | * <b>Non-USB Library Components</b> | ||
| 666 | * - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only | ||
| 667 | * compatible with avr-libc library versions newer than the time before the functionality of the deleted | ||
| 668 | * headers was available. | ||
| 669 | * | ||
| 670 | * <b>Device Mode</b> | ||
| 671 | * - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and | ||
| 672 | * functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API. | ||
| 673 | * The previously split Type and Index parameters are now passed as the original wValue parameter to the | ||
| 674 | * function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the | ||
| 675 | * previous Index parameter. | ||
| 676 | * - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the | ||
| 677 | * official USB specification. Existing code will need to be altered to use the new parameter names. | ||
| 678 | * - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more | ||
| 679 | * appropriate. It fires in an identical manner to the previously named event, thus the only change to be made | ||
| 680 | * is the event name itself in the user project. | ||
| 681 | * - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a | ||
| 682 | * pseudo-descriptor modeled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type | ||
| 683 | * descriptor as indicated in the USB specification, thus all device code must be updated accordingly. | ||
| 684 | * - The names of several Endpoint macros have been changed to be more consistent with the rest of the library, | ||
| 685 | * with no implementation changes. This means that existing code can be altered to use the new macro names | ||
| 686 | * with no other considerations required. See Endpoint.h for the new macro names. | ||
| 687 | * - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t | ||
| 688 | * structure named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this | ||
| 689 | * demo should correct the structure value to maintain compatibility across multiple OS platforms. | ||
| 690 | * - By default, the descriptor structures use the official USB specification names for the elements. Previous | ||
| 691 | * versions of the library used non-standard (but more verbose) names, which are still usable in the current | ||
| 692 | * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file | ||
| 693 | * documentation for more details. | ||
| 694 | * | ||
| 695 | * <b>Host Mode</b> | ||
| 696 | * - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its | ||
| 697 | * members renamed to the official USB specification names for requests. Existing code will need to be updated | ||
| 698 | * to use the new names. | ||
| 699 | * - The names of several Pipe macros have been changed to be more consistent with the rest of the library, | ||
| 700 | * with no implementation changes. This means that existing code can be altered to use the new macro names | ||
| 701 | * with no other considerations required. See Pipe.h for the new macro names. | ||
| 702 | * - By default, the descriptor structures use the official USB specification names for the elements. Previous | ||
| 703 | * versions of the library used non-standard (but more verbose) names, which are still usable in the current | ||
| 704 | * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file | ||
| 705 | * documentation for more details. | ||
| 706 | * - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h | ||
| 707 | * module documentation for the new macro names. | ||
| 708 | * | ||
| 709 | * <b>Dual Role Mode</b> | ||
| 710 | * - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing | ||
| 711 | * projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG | ||
| 712 | * header inside the library. | ||
| 713 | * - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has | ||
| 714 | * finished enumerating the device. Projects relying on the event only firing in Host mode should be updated | ||
| 715 | * so that the event action only occurs when the USB_Mode global is set to USB_MODE_HOST. | ||
| 716 | */ | ||
| 717 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/OSDrivers.txt b/lib/lufa/LUFA/DoxygenPages/OSDrivers.txt new file mode 100644 index 000000000..4823c5b08 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/OSDrivers.txt | |||
| @@ -0,0 +1,111 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_OSDrivers Operating System Drivers | ||
| 8 | * | ||
| 9 | * Most of the USB classes supported by LUFA are also supported natively in | ||
| 10 | * most operating systems, without extra drivers being required. However, in | ||
| 11 | * some cases, a driver file is required in order for the device to enumerate | ||
| 12 | * and function correctly. | ||
| 13 | * | ||
| 14 | * \section Sec_OSClassSupport Operating System USB Class Support | ||
| 15 | * The table below lists the supported LUFA USB classes, and their associated | ||
| 16 | * <i>native</i> support on modern operating systems. | ||
| 17 | * | ||
| 18 | * <table> | ||
| 19 | * <tr> | ||
| 20 | * <th width="200px">USB Class</th> | ||
| 21 | * <th width="150px">Android</th> | ||
| 22 | * <th width="150px">Windows</th> | ||
| 23 | * <th width="150px">Linux</th> | ||
| 24 | * <th width="150px">OS X</th> | ||
| 25 | * </tr> | ||
| 26 | * <tr> | ||
| 27 | * <td>Android Open Accessory</td> | ||
| 28 | * <td>2.3.4+</td> | ||
| 29 | * <td>N/A</td> | ||
| 30 | * <td>N/A</td> | ||
| 31 | * <td>N/A</td> | ||
| 32 | * </tr> | ||
| 33 | * <tr> | ||
| 34 | * <td>Audio 1.0</td> | ||
| 35 | * <td>N/A</td> | ||
| 36 | * <td>XP+</td> | ||
| 37 | * <td>2.6.?+</td> | ||
| 38 | * <td>10.?+</td> | ||
| 39 | * </tr> | ||
| 40 | * <tr> | ||
| 41 | * <td>CDC-ACM</td> | ||
| 42 | * <td>N/A</td> | ||
| 43 | * <td>XP+</td> | ||
| 44 | * <td>2.6.?+</td> | ||
| 45 | * <td>10.?+</td> | ||
| 46 | * </tr> | ||
| 47 | * <tr> | ||
| 48 | * <td>HID</td> | ||
| 49 | * <td>3.?+</td> | ||
| 50 | * <td>XP+</td> | ||
| 51 | * <td>2.6.?+</td> | ||
| 52 | * <td>10.?+</td> | ||
| 53 | * </tr> | ||
| 54 | * <tr> | ||
| 55 | * <td>MIDI</td> | ||
| 56 | * <td>N/A</td> | ||
| 57 | * <td>XP+</td> | ||
| 58 | * <td>2.6.?+</td> | ||
| 59 | * <td>10.?+</td> | ||
| 60 | * </tr> | ||
| 61 | * <tr> | ||
| 62 | * <td>Mass Storage</td> | ||
| 63 | * <td>N/A</td> | ||
| 64 | * <td>XP+</td> | ||
| 65 | * <td>2.6.?+</td> | ||
| 66 | * <td>10.?+</td> | ||
| 67 | * </tr> | ||
| 68 | * <tr> | ||
| 69 | * <td>Printer</td> | ||
| 70 | * <td>N/A</td> | ||
| 71 | * <td>XP+</td> | ||
| 72 | * <td>2.6.?+</td> | ||
| 73 | * <td>10.?+</td> | ||
| 74 | * </tr> | ||
| 75 | * <tr> | ||
| 76 | * <td>RNDIS</td> | ||
| 77 | * <td>N/A</td> | ||
| 78 | * <td>XP+</td> | ||
| 79 | * <td>2.6.?+</td> | ||
| 80 | * <td>N/A</td> | ||
| 81 | * </tr> | ||
| 82 | * <tr> | ||
| 83 | * <td>Still Image</td> | ||
| 84 | * <td>N/A</td> | ||
| 85 | * <td>XP+</td> | ||
| 86 | * <td>2.6.?+</td> | ||
| 87 | * <td>10.?+</td> | ||
| 88 | * </tr> | ||
| 89 | * </table> | ||
| 90 | * | ||
| 91 | * \section Sec_WinINFTemplates Windows INF Drivers | ||
| 92 | * Windows uses INF driver files to associate a USB device of a specific class, | ||
| 93 | * VID/PID ID pair, Windows Compatibility ID or other characteristic to a kernel | ||
| 94 | * driver. In most cases these files are build into the operating system, and | ||
| 95 | * no special user action or driver files are required for a device using a | ||
| 96 | * standard USB class to enumerate. However, for some classes, a specific INF | ||
| 97 | * driver must be created and given to the operating system for the device to | ||
| 98 | * enumerate. | ||
| 99 | * | ||
| 100 | * Those USB classes requiring a custom INF driver file in Windows are listed | ||
| 101 | * below, along with a basic INF template for each class. | ||
| 102 | * | ||
| 103 | * \subsection SSec_WinINF_CDC Windows CDC INF Template | ||
| 104 | * This template is required for all CDC-ACM devices on Windows XP or newer. | ||
| 105 | * \verbinclude "WindowsINF/LUFA CDC-ACM.inf" | ||
| 106 | * | ||
| 107 | * \subsection SSec_WinINF_RNDIS Windows RNDIS INF Template | ||
| 108 | * This template is required for all RNDIS devices on Windows XP or newer. | ||
| 109 | * \verbinclude "WindowsINF/LUFA RNDIS.inf" | ||
| 110 | */ | ||
| 111 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/ProgrammingApps.txt b/lib/lufa/LUFA/DoxygenPages/ProgrammingApps.txt new file mode 100644 index 000000000..653b4ad04 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/ProgrammingApps.txt | |||
| @@ -0,0 +1,27 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_ProgrammingApps Programming an Application into a USB AVR | ||
| 8 | * | ||
| 9 | * Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your | ||
| 10 | * application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the | ||
| 11 | * reprogramming of an AVR device must be performed using a special piece of programming hardware, through one of the | ||
| 12 | * supported AVR programming protocols - ISP, HVSP, HVPP, JTAG, dW or PDI. This can be done through a custom programmer, | ||
| 13 | * a third party programmer, or an official Atmel AVR tool - for more information, see the <a>atmel.com</a> website. | ||
| 14 | * | ||
| 15 | * Alternatively, you can use the bootloader. From the Atmel factory, each USB AVR comes preloaded with the Atmel | ||
| 16 | * DFU (Device Firmware Update) class bootloader, a small piece of AVR firmware which allows the remainder of the | ||
| 17 | * AVR to be programmed through a non-standard interface such as the serial USART port, SPI, or (in this case) USB. | ||
| 18 | * Bootloaders have the advantage of not requiring any special hardware for programming, and cannot usually be erased | ||
| 19 | * or broken without an external programming device. They have disadvantages however; they cannot change the fuses of | ||
| 20 | * the AVR (special configuration settings that control the operation of the chip itself) and a small portion of the | ||
| 21 | * AVR's FLASH program memory must be reserved to contain the bootloader firmware, and thus cannot be used by the | ||
| 22 | * loaded application. | ||
| 23 | * | ||
| 24 | * If you wish to use the DFU bootloader to program in your application, refer to your DFU programmer's documentation. | ||
| 25 | * Atmel provides a free utility called FLIP which is USB AVR compatible, and an open source (Linux compatible) | ||
| 26 | * alternative exists called "dfu-programmer". | ||
| 27 | */ | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/SoftwareBootloaderJump.txt b/lib/lufa/LUFA/DoxygenPages/SoftwareBootloaderJump.txt new file mode 100644 index 000000000..f8c2523d7 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/SoftwareBootloaderJump.txt | |||
| @@ -0,0 +1,71 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** | ||
| 8 | * \page Page_SoftwareBootloaderStart Entering the Bootloader via Software | ||
| 9 | * | ||
| 10 | * A common requirement of many applications is the ability to jump to the programmed bootloader of a chip | ||
| 11 | * on demand, via the code's firmware (i.e. not as a result of any physical user interaction with the | ||
| 12 | * hardware). This might be required because the device does not have any physical user input, or simply | ||
| 13 | * just to streamline the device upgrade process on the host PC. | ||
| 14 | * | ||
| 15 | * The following C code snippets may be used to enter the bootloader upon request by the user application. | ||
| 16 | * By using the watchdog to physically reset the controller, it is ensured that all system hardware is | ||
| 17 | * completely reset to their defaults before the bootloader is run. This is important; since bootloaders | ||
| 18 | * are written to occupy a very limited space, they usually make assumptions about the register states based | ||
| 19 | * on the default values after a hard-reset of the chip. | ||
| 20 | * | ||
| 21 | * \section Sec_SoftareBootAVR8 AVR8 Architecture | ||
| 22 | * The following software bootloader jump code is written for the AVR8 architecture. | ||
| 23 | * | ||
| 24 | * \code | ||
| 25 | * #include <avr/wdt.h> | ||
| 26 | * #include <avr/io.h> | ||
| 27 | * #include <util/delay.h> | ||
| 28 | * | ||
| 29 | * #include <LUFA/Common/Common.h> | ||
| 30 | * #include <LUFA/Drivers/USB/USB.h> | ||
| 31 | * | ||
| 32 | * uint32_t Boot_Key ATTR_NO_INIT; | ||
| 33 | * | ||
| 34 | * #define MAGIC_BOOT_KEY 0xBADCAFE5 | ||
| 35 | * #define BOOTLOADER_START_ADDRESS ((FLASH_SIZE_BYTES - BOOTLOADER_SEC_SIZE_BYTES) >> 1) | ||
| 36 | * | ||
| 37 | * void Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3); | ||
| 38 | * void Bootloader_Jump_Check(void) | ||
| 39 | * { | ||
| 40 | * // If the reset source was the bootloader and the key is correct, clear it and jump to the bootloader | ||
| 41 | * if ((MCUSR & (1 << WDRF)) && (Boot_Key == MAGIC_BOOT_KEY)) | ||
| 42 | * { | ||
| 43 | * Boot_Key = 0; | ||
| 44 | * ((void (*)(void))BOOTLOADER_START_ADDRESS)(); | ||
| 45 | * } | ||
| 46 | * } | ||
| 47 | * | ||
| 48 | * void Jump_To_Bootloader(void) | ||
| 49 | * { | ||
| 50 | * // If USB is used, detach from the bus and reset it | ||
| 51 | * USB_Disable(); | ||
| 52 | * | ||
| 53 | * // Disable all interrupts | ||
| 54 | * cli(); | ||
| 55 | * | ||
| 56 | * // Wait two seconds for the USB detachment to register on the host | ||
| 57 | * Delay_MS(2000); | ||
| 58 | * | ||
| 59 | * // Set the bootloader key to the magic value and force a reset | ||
| 60 | * Boot_Key = MAGIC_BOOT_KEY; | ||
| 61 | * wdt_enable(WDTO_250MS); | ||
| 62 | * for (;;); | ||
| 63 | * } | ||
| 64 | * \endcode | ||
| 65 | * | ||
| 66 | * Note that the bootloader magic key can be any arbitrary value. The <em>FLASH_SIZE_BYTES</em> and | ||
| 67 | * <em>BOOTLOADER_SEC_SIZE_BYTES</em> tokens should be replaced with the total flash size of the AVR | ||
| 68 | * in bytes, and the allocated size of the bootloader section for the target AVR. | ||
| 69 | * | ||
| 70 | */ | ||
| 71 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/Style/Footer.htm b/lib/lufa/LUFA/DoxygenPages/Style/Footer.htm new file mode 100644 index 000000000..a72c5bdd2 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/Style/Footer.htm | |||
| @@ -0,0 +1,35 @@ | |||
| 1 | <!--BEGIN GENERATE_TREEVIEW--> | ||
| 2 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||
| 3 | <ul> | ||
| 4 | <li class="footer" style="float:left !important;"> | ||
| 5 | $generatedby | ||
| 6 | <a href="http://www.doxygen.org/index.html"> | ||
| 7 | <img class="footer" src="$relpath$doxygen.png" alt="doxygen"/> | ||
| 8 | </a> | ||
| 9 | $doxygenversion | ||
| 10 | </li> | ||
| 11 | |||
| 12 | <li class="footer"> | ||
| 13 | <a href="http://www.lufa-lib.org" title="LUFA Project Page">LUFA Project Page</a> | <a href="http://www.lufa-lib.org/support" title="LUFA Support List">Support Mailing List</a> | <a href="http://www.lufa-lib.org/donate" title="Donate to Support LUFA">Donate</a> | <a href="http://www.fourwalledcubicle.com" title="Four Walled Cubicle Website">Four Walled Cubicle</a> - LUFA, the Lightweight USB Framework for AVRs | ||
| 14 | </li> | ||
| 15 | </ul> | ||
| 16 | </div> | ||
| 17 | <!--END GENERATE_TREEVIEW--> | ||
| 18 | <!--BEGIN !GENERATE_TREEVIEW--> | ||
| 19 | <hr class="footer"/> | ||
| 20 | <div class="footer"> | ||
| 21 | <span style="float: left;"> | ||
| 22 | $generatedby | ||
| 23 | <a href="http://www.doxygen.org/index.html"> | ||
| 24 | <img class="footer" src="$relpath$doxygen.png" alt="doxygen"/> | ||
| 25 | </a> | ||
| 26 | $doxygenversion | ||
| 27 | </span> | ||
| 28 | |||
| 29 | <span style="margin-right: 20px; float: right;"> | ||
| 30 | <a href="http://www.lufa-lib.org" title="LUFA Project Page">LUFA Project Page</a> | <a href="http://www.lufa-lib.org/support" title="LUFA Support List">Support Mailing List</a> | <a href="http://www.lufa-lib.org/donate" title="Donate to Support LUFA">Donate</a> | <a href="http://www.fourwalledcubicle.com" title="Four Walled Cubicle Website">Four Walled Cubicle</a> - LUFA, the Lightweight USB Framework for AVRs | ||
| 31 | </span> | ||
| 32 | </div> | ||
| 33 | <!--END !GENERATE_TREEVIEW--> | ||
| 34 | </body> | ||
| 35 | </html> \ No newline at end of file | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/Style/Style.css b/lib/lufa/LUFA/DoxygenPages/Style/Style.css new file mode 100644 index 000000000..933215546 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/Style/Style.css | |||
| @@ -0,0 +1,93 @@ | |||
| 1 | /* ============================= */ | ||
| 2 | /* Page Header Formattings */ | ||
| 3 | /* ============================= */ | ||
| 4 | #titlearea { | ||
| 5 | background-color:#E1E7F4; | ||
| 6 | background-image:url('nav_f.png'); | ||
| 7 | background-repeat:repeat-x; | ||
| 8 | color:#20335A; | ||
| 9 | font-weight:bold; | ||
| 10 | text-shadow:0 1px 1px rgba(255, 255, 255, 0.9); | ||
| 11 | } | ||
| 12 | |||
| 13 | #projectlogo { | ||
| 14 | padding-left: 10px; | ||
| 15 | } | ||
| 16 | |||
| 17 | /* ============================= */ | ||
| 18 | /* General Text Formattings */ | ||
| 19 | /* ============================= */ | ||
| 20 | body,table,div,p,dl { | ||
| 21 | font-family:Lucida Grande, Verdana, Geneva, Arial, sans-serif; | ||
| 22 | font-size:13px; | ||
| 23 | line-height:1.3; | ||
| 24 | } | ||
| 25 | |||
| 26 | div.header, div.contents p { | ||
| 27 | padding-left:12px; | ||
| 28 | } | ||
| 29 | |||
| 30 | /* ============================= */ | ||
| 31 | /* API Documentation Formattings */ | ||
| 32 | /* ============================= */ | ||
| 33 | div.contents table.memberdecls, .paramname { | ||
| 34 | font-family:Consolas, Monaco, courier, sans-serif; | ||
| 35 | font-size:105%; | ||
| 36 | padding-right:20px; | ||
| 37 | } | ||
| 38 | |||
| 39 | /* ============================= */ | ||
| 40 | /* HTML Heading Formattings */ | ||
| 41 | /* ============================= */ | ||
| 42 | h1, h2, h3, h4 { | ||
| 43 | font-family:Lucida Grande, Verdana, Geneva, Arial, sans-serif; | ||
| 44 | } | ||
| 45 | |||
| 46 | h1 { | ||
| 47 | font-size:25px; | ||
| 48 | margin-bottom:10px; | ||
| 49 | } | ||
| 50 | |||
| 51 | h2 { | ||
| 52 | color:#42657B; | ||
| 53 | font-size:17px; | ||
| 54 | } | ||
| 55 | |||
| 56 | h3 { | ||
| 57 | font-size:15px; | ||
| 58 | } | ||
| 59 | |||
| 60 | h4 { | ||
| 61 | font-size:13px; | ||
| 62 | } | ||
| 63 | |||
| 64 | /* ============================= */ | ||
| 65 | /* Code Snippet Formattings */ | ||
| 66 | /* ============================= */ | ||
| 67 | span.keyword { | ||
| 68 | color:#008000; | ||
| 69 | } | ||
| 70 | |||
| 71 | span.keywordtype { | ||
| 72 | color:#604020; | ||
| 73 | } | ||
| 74 | |||
| 75 | span.keywordflow { | ||
| 76 | color:#e08000; | ||
| 77 | } | ||
| 78 | |||
| 79 | span.comment { | ||
| 80 | color:#008000; | ||
| 81 | } | ||
| 82 | |||
| 83 | span.preprocessor { | ||
| 84 | color:#806020; | ||
| 85 | } | ||
| 86 | |||
| 87 | span.stringliteral { | ||
| 88 | color:#002080; | ||
| 89 | } | ||
| 90 | |||
| 91 | span.charliteral { | ||
| 92 | color:#008080; | ||
| 93 | } | ||
diff --git a/lib/lufa/LUFA/DoxygenPages/VIDAndPIDValues.txt b/lib/lufa/LUFA/DoxygenPages/VIDAndPIDValues.txt new file mode 100644 index 000000000..8b1722044 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/VIDAndPIDValues.txt | |||
| @@ -0,0 +1,199 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_VIDPID VID and PID values | ||
| 8 | * | ||
| 9 | * \section Sec_VIDPID_Allocations VID and PID Allocations | ||
| 10 | * The LUFA library uses VID/PID combinations generously donated by Atmel. The following VID/PID combinations | ||
| 11 | * are used within the LUFA demos, and thus may be re-used by derivations of each demo. Free PID values may be | ||
| 12 | * used by future LUFA demo projects. | ||
| 13 | * | ||
| 14 | * <b>These VID/PID values should not be used in commercial designs under any circumstances.</b> Private projects | ||
| 15 | * may use the following values freely, but must accept any collisions due to other LUFA derived private projects | ||
| 16 | * sharing identical values. It is suggested that private projects using interfaces compatible with existing | ||
| 17 | * demos share the same VID/PID value. | ||
| 18 | * | ||
| 19 | * <table> | ||
| 20 | * <tr> | ||
| 21 | * <th>VID</th> | ||
| 22 | * <th>PID</th> | ||
| 23 | * <th>Usage</th> | ||
| 24 | * </tr> | ||
| 25 | * <tr> | ||
| 26 | * <td>0x03EB</td> | ||
| 27 | * <td>0x2040</td> | ||
| 28 | * <td>Test VID/PID (See \ref Sec_Test_VIDPID)</td> | ||
| 29 | * </tr> | ||
| 30 | * <tr> | ||
| 31 | * <td>0x03EB</td> | ||
| 32 | * <td>0x2041</td> | ||
| 33 | * <td>Mouse Demo Application</td> | ||
| 34 | * </tr> | ||
| 35 | * <tr> | ||
| 36 | * <td>0x03EB</td> | ||
| 37 | * <td>0x2042</td> | ||
| 38 | * <td>Keyboard Demo Application</td> | ||
| 39 | * </tr> | ||
| 40 | * <tr> | ||
| 41 | * <td>0x03EB</td> | ||
| 42 | * <td>0x2043</td> | ||
| 43 | * <td>Joystick Demo Application</td> | ||
| 44 | * </tr> | ||
| 45 | * <tr> | ||
| 46 | * <td>0x03EB</td> | ||
| 47 | * <td>0x2044</td> | ||
| 48 | * <td>CDC Demo Application</td> | ||
| 49 | * </tr> | ||
| 50 | * <tr> | ||
| 51 | * <td>0x03EB</td> | ||
| 52 | * <td>0x2045</td> | ||
| 53 | * <td>Mass Storage Demo Application</td> | ||
| 54 | * </tr> | ||
| 55 | * <tr> | ||
| 56 | * <td>0x03EB</td> | ||
| 57 | * <td>0x2046</td> | ||
| 58 | * <td>Audio Output Demo Application</td> | ||
| 59 | * </tr> | ||
| 60 | * <tr> | ||
| 61 | * <td>0x03EB</td> | ||
| 62 | * <td>0x2047</td> | ||
| 63 | * <td>Audio Input Demo Application</td> | ||
| 64 | * </tr> | ||
| 65 | * <tr> | ||
| 66 | * <td>0x03EB</td> | ||
| 67 | * <td>0x2048</td> | ||
| 68 | * <td>MIDI Demo Application</td> | ||
| 69 | * </tr> | ||
| 70 | * <tr> | ||
| 71 | * <td>0x03EB</td> | ||
| 72 | * <td>0x2049</td> | ||
| 73 | * <td>MagStripe Project</td> | ||
| 74 | * </tr> | ||
| 75 | * <tr> | ||
| 76 | * <td>0x03EB</td> | ||
| 77 | * <td>0x204A</td> | ||
| 78 | * <td>CDC Class Bootloader</td> | ||
| 79 | * </tr> | ||
| 80 | * <tr> | ||
| 81 | * <td>0x03EB</td> | ||
| 82 | * <td>0x204B</td> | ||
| 83 | * <td>USB to Serial Demo Application</td> | ||
| 84 | * </tr> | ||
| 85 | * <tr> | ||
| 86 | * <td>0x03EB</td> | ||
| 87 | * <td>0x204C</td> | ||
| 88 | * <td>RNDIS Demo Application</td> | ||
| 89 | * </tr> | ||
| 90 | * <tr> | ||
| 91 | * <td>0x03EB</td> | ||
| 92 | * <td>0x204D</td> | ||
| 93 | * <td>Combined Keyboard and Mouse Demo Application</td> | ||
| 94 | * </tr> | ||
| 95 | * <tr> | ||
| 96 | * <td>0x03EB</td> | ||
| 97 | * <td>0x204E</td> | ||
| 98 | * <td>Dual CDC Demo Application</td> | ||
| 99 | * </tr> | ||
| 100 | * <tr> | ||
| 101 | * <td>0x03EB</td> | ||
| 102 | * <td> | ||
| 103 | * 0x204F | ||
| 104 | * </td> | ||
| 105 | * <td>Generic HID Demo Application</td> | ||
| 106 | * </tr> | ||
| 107 | * <tr> | ||
| 108 | * <td>0x03EB</td> | ||
| 109 | * <td>0x2060</td> | ||
| 110 | * <td>Benito Programmer Project</td> | ||
| 111 | * </tr> | ||
| 112 | * <tr> | ||
| 113 | * <td>0x03EB</td> | ||
| 114 | * <td>0x2061</td> | ||
| 115 | * <td>Combined Mass Storage and Keyboard Demo</td> | ||
| 116 | * </tr> | ||
| 117 | * <tr> | ||
| 118 | * <td>0x03EB</td> | ||
| 119 | * <td>0x2062</td> | ||
| 120 | * <td>Combined CDC and Mouse Demo</td> | ||
| 121 | * </tr> | ||
| 122 | * <tr> | ||
| 123 | * <td>0x03EB</td> | ||
| 124 | * <td>0x2063</td> | ||
| 125 | * <td>Mass Storage/HID Interface Datalogger Project</td> | ||
| 126 | * </tr> | ||
| 127 | * <tr> | ||
| 128 | * <td>0x03EB</td> | ||
| 129 | * <td>0x2064</td> | ||
| 130 | * <td>Interfaceless Control-Only LUFA Devices</td> | ||
| 131 | * </tr> | ||
| 132 | * <tr> | ||
| 133 | * <td>0x03EB</td> | ||
| 134 | * <td>0x2065</td> | ||
| 135 | * <td>Test and Measurement Demo</td> | ||
| 136 | * </tr> | ||
| 137 | * <tr> | ||
| 138 | * <td>0x03EB</td> | ||
| 139 | * <td> | ||
| 140 | * 0x2066 | ||
| 141 | * </td> | ||
| 142 | * <td>Multiple Report Keyboard/Mouse HID Demo</td> | ||
| 143 | * </tr> | ||
| 144 | * <tr> | ||
| 145 | * <td>0x03EB</td> | ||
| 146 | * <td>0x2067</td> | ||
| 147 | * <td>HID Class Bootloader</td> | ||
| 148 | * </tr> | ||
| 149 | * <tr> | ||
| 150 | * <td>0x03EB</td> | ||
| 151 | * <td>0x2068</td> | ||
| 152 | * <td>Virtual Serial/Mass Storage Demo</td> | ||
| 153 | * </tr> | ||
| 154 | * <tr> | ||
| 155 | * <td>0x03EB</td> | ||
| 156 | * <td> | ||
| 157 | * 0x2069 | ||
| 158 | * </td> | ||
| 159 | * <td>Webserver Project</td> | ||
| 160 | * </tr> | ||
| 161 | * <tr> | ||
| 162 | * <td>0x03EB</td> | ||
| 163 | * <td>0x206A</td> | ||
| 164 | * <td>Media Control Project</td> | ||
| 165 | * </tr> | ||
| 166 | * <tr> | ||
| 167 | * <td>0x03EB</td> | ||
| 168 | * <td>0x206B</td> | ||
| 169 | * <td>Printer Class Bootloader</td> | ||
| 170 | * </tr> | ||
| 171 | * <tr> | ||
| 172 | * <td>0x03EB</td> | ||
| 173 | * <td>0x206C</td> | ||
| 174 | * <td>Bulk Vendor Demo Application</td> | ||
| 175 | * </tr> | ||
| 176 | * <tr> | ||
| 177 | * <td>0x03EB</td> | ||
| 178 | * <td>0x206D</td> | ||
| 179 | * <td>Dual MIDI Demo Application</td> | ||
| 180 | * </tr> | ||
| 181 | * <tr> | ||
| 182 | * <td>0x03EB</td> | ||
| 183 | * <td>0x206E</td> | ||
| 184 | * <td><i>Currently Unallocated</i></td> | ||
| 185 | * </tr> | ||
| 186 | * <tr> | ||
| 187 | * <td>0x03EB</td> | ||
| 188 | * <td>0x206F</td> | ||
| 189 | * <td><i>Currently Unallocated</i></td> | ||
| 190 | * </tr> | ||
| 191 | * </table> | ||
| 192 | * | ||
| 193 | * \section Sec_Test_VIDPID The Test VID/PID Combination | ||
| 194 | * For use in testing of LUFA powered devices during development only, by non-commercial entities. | ||
| 195 | * All devices must accept collisions on this VID/PID range (from other in-development LUFA devices) | ||
| 196 | * to be resolved by using a unique release number in the Device Descriptor. No devices using this | ||
| 197 | * VID/PID combination may be released to the general public. | ||
| 198 | */ | ||
| 199 | |||
diff --git a/lib/lufa/LUFA/DoxygenPages/WritingBoardDrivers.txt b/lib/lufa/LUFA/DoxygenPages/WritingBoardDrivers.txt new file mode 100644 index 000000000..b2ff07e66 --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/WritingBoardDrivers.txt | |||
| @@ -0,0 +1,47 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_WritingBoardDrivers Writing LUFA Board Drivers | ||
| 8 | * | ||
| 9 | * LUFA ships with several basic pre-made board drivers, to control hardware present on the supported board | ||
| 10 | * hardware - such as Dataflash ICs, LEDs, Joysticks, or other hardware peripherals. When compiling an application | ||
| 11 | * which makes use of one or more board drivers located in <i>LUFA/Drivers/Board</i>, you must also indicate which | ||
| 12 | * board hardware you are using in your project makefile. This is done by defining the <tt>BOARD</tt> macro using | ||
| 13 | * the <tt>-D</tt> switch passed to the compiler, with a constant of <tt>BOARD_{Name}</tt>. For example, | ||
| 14 | * <tt>-DBOARD=BOARD_USBKEY</tt> instructs the compiler to use the USBKEY board hardware drivers. | ||
| 15 | * | ||
| 16 | * If your application does not use <i>any</i> board level drivers, you can omit the definition of the <tt>BOARD</tt> | ||
| 17 | * macro. However, some users may wish to write their own custom board hardware drivers which are to remain compatible | ||
| 18 | * with the LUFA hardware API. To do this, the <tt>BOARD</tt> macro should be defined to the value <tt>BOARD_USER</tt>. | ||
| 19 | * This indicates that the board level drivers should be located in a folder named "Board" located inside the | ||
| 20 | * application's folder. | ||
| 21 | * | ||
| 22 | * When used, the driver stub files located in the <tt>LUFA/CodeTemplates/DriverStubs</tt> folder should be copied to | ||
| 23 | * the user application's <tt>Board/</tt> directory, and filled out to include the values and code needed to control | ||
| 24 | * the custom board hardware. Once done, the existing LUFA board level APIs (accessed in the regular | ||
| 25 | * <tt>LUFA/Drivers/Board/</tt> folder) will redirect to the user board drivers, maintaining code compatibility and | ||
| 26 | * allowing for a different board to be selected through the project makefile with no code changes. | ||
| 27 | * | ||
| 28 | * \section Sec_BoardTemplates Board Driver Templates | ||
| 29 | * | ||
| 30 | * The templates for each board driver are reproduced below. | ||
| 31 | * | ||
| 32 | * \subsection SSec_BoardTemplates_Board Template for USER <Board/Board.h> | ||
| 33 | * \include "DriverStubs/Board.h" | ||
| 34 | * | ||
| 35 | * \subsection SSec_BoardTemplates_Buttons Template for USER <Board/Buttons.h> | ||
| 36 | * \include "DriverStubs/Buttons.h" | ||
| 37 | * | ||
| 38 | * \subsection SSec_BoardTemplates_Dataflash Template for USER <Board/Dataflash.h> | ||
| 39 | * \include "DriverStubs/Dataflash.h" | ||
| 40 | * | ||
| 41 | * \subsection SSec_BoardTemplates_Joystick Template for USER <Board/Joystick.h> | ||
| 42 | * \include "DriverStubs/Joystick.h" | ||
| 43 | * | ||
| 44 | * \subsection SSec_BoardTemplates_LEDs Template for USER <Board/LEDs.h> | ||
| 45 | * \include "DriverStubs/LEDs.h" | ||
| 46 | */ | ||
| 47 | |||
