6ac480446b72c91e27d5a9693d7d859328b1ae52
[pub/USBasp.git] / LUFA / DoxygenPages / ChangeLog.txt
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_ChangeLogXXXXXX Version XXXXXX
10 * <b>New:</b>
11 * - Core:
12 * - Added support for the XMEGA A3BU Xplained board
13 * - Added support for the new B series XMEGA devices
14 * - Added support for version 2 of the Teensy boards (thanks to Christoph Redecker)
15 * - Added new Android Accessory Host class driver
16 * - Library Applications:
17 * - Added User Application APIs to the CDC and DFU class bootloaders
18 * - Added INVERTED_ISP_MISO compile time option to the AVRISP-MKII clone project (thanks to Chuck Rohs)
19 * - Added new Android Accessory Host demo (thanks to Opendous Inc.)
20 *
21 * <b>Changed:</b>
22 * - Core:
23 * - When automatic PLL management mode is enabled on the U4 series AVR8 chips, the PLL is now configured for 48MHz and not
24 * a divided 96MHz, to lower power consumption and to keep the system within the datasheet specs for 3.3V operation (thanks to Scott Vitale)
25 * - Added Class, ClassDevice, ClassHost and ClassCommon to the internal class driver source filenames to prevent ambiguities
26 * - Library Applications:
27 * - None
28 *
29 * <b>Fixed:</b>
30 * - Core:
31 * - Fixed ring buffer size limited to 255 elements, instead of the intended 65535 elements.
32 * - Fixed CDC class drivers not saving and sending all 16-bits of the control line states (thanks to Matthew Swabey)
33 * - Fixed race conditions in the CDC, HID and Mass Storage class drivers when processing some control requests
34 * - Fixed misspelled HID_KEYBOARD_MODIFIER_* macros in the HID class driver (thanks to Laszlo Monda)
35 * - Fixed broken AVR32 endpoint/pipe communications when ORDERED_EP_CONFIG compile time option is not enabled (thanks to Matthias Jahr)
36 * - Fixed broken compilation for the AVR32 devices if the NO_SOF_EVENTS compile time option was not enabled (thanks to Matthias Jahr)
37 * - Library Applications:
38 * - Added reliability patches to the AVRISP-MKII Clone project's PDI/TPI protocols (thanks to Justin Mattair)
39 * - Fixed AVRISP-MKII Clone compile warning on AVR8 U4 targets even when NO_VTARGET_DETECT is enabled
40 *
41 * \section Sec_ChangeLog111009 Version 111009
42 * <b>New:</b>
43 * - Core:
44 * - Added USE_LUFA_CONFIG_HEADER compile time option to include a LUFAConfig.h header in the user director for LUFA configuration
45 * tokens as an alternative to tokens defined in the project makefile
46 * - Added new USB_Host_SetInterfaceAltSetting() convenience function for the selection of an interface's alternative setting
47 * - Added Audio class control request definitions
48 * - Added new CALLBACK_Audio_Device_GetSetEndpointProperty() callback to the Audio Device Class driver to allow for endpoint control manipulations
49 * such as data sample rates
50 * - 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
51 * - Added new EVENT_Audio_Device_StreamStartStop() event to the Audio Device Class driver to detect stream start/stop events
52 * - Added board driver support for the Busware TUL board
53 * - Added board hardware driver support for the EVK1100 board
54 * - Added board hardware driver support for the EVK1104 board
55 * - Added new Host mode Audio Class driver
56 * - Added new SPI_GetCurrentMode() function to the SPI peripheral driver
57 * - Added RingBuffer_GetFreeCount() function to the Ring Buffer driver
58 * - Added new HID_Host_SetIdlePeriod() function to the HID Host Class driver
59 * - Added new USB_Host_ConfigurationNumber global variable to indicate the selected configuration in an attached device
60 * - Added new USB_Host_GetDeviceStatus() function to the host standard request function set
61 * - Added AVR USB XMEGA architecture port (currently incomplete/experimental)
62 * - Added new STRINGIFY() and STRINGIFY_EXPANDED() convenience macros
63 * - Added new JTAG_DISABLE() macro for the AVR8 architecture
64 * - Added Device Qualifier standard descriptor structure definitions USB_StdDescriptor_DeviceQualifier_t and USB_Descriptor_DeviceQualifier_t
65 * - Library Applications:
66 * - Added RNDIS device mode to the Webserver project
67 * - Added new incomplete AndroidAccessoryHost Host LowLevel demo
68 * - Added new HIDReportViewer project
69 * - Added new MediaControl project
70 * - Added new AudioInputHost Host ClassDriver demo
71 * - Added new AudioOutputHost Host ClassDriver demo
72 * - Added new AudioInputHost Host LowLevel demo
73 * - Added new AudioOutputHost Host LowLevel demo
74 * - Added new "checksource" target to all library project makefiles
75 * - Added new VTARGET_USE_INTERNAL_REF configuration option to the AVRISP-MKII clone project (thanks to Volker Bosch)
76 *
77 * <b>Changed:</b>
78 * - Core:
79 * - Altered the definition of the USB_Audio_Descriptor_Format_t descriptor so that the user is now responsible for supplying
80 * the supported audio sampling rates, to allow for multiple audio interfaces with different numbers of supported rates and/or
81 * continuous sample rates
82 * - Pipe_BoundEndpointNumber() has been renamed to Pipe_GetBoundEndpointAddress(), and now returns the correct endpoint direction
83 * as part of the endpoint address
84 * - Renamed global state variables that are specific to a certain USB mode to clearly indicate which mode the variable relates to,
85 * by changing the USB_* prefix to USB_Device_* or USB_Host_*
86 * - Removed the HOST_STATE_WaitForDeviceRemoval and HOST_STATE_Suspended host state machine states, as these are no longer required
87 * - Altered the USB_Host_SetDeviceConfiguration() function to update the global Host state machine state and the new
88 * USB_Host_ConfigurationNumber global as required
89 * - Added endian correcting code to the library USB class drivers for multiple architecture support
90 * - Removed the ENDPOINT_DESCRIPTOR_DIR_* macros, replaced by ENDPOINT_DIR_* instead
91 * - Renamed the JTAG_DEBUG_ASSERT() macro to JTAG_ASSERT()
92 * - Added variable number of axis to HID_DESCRIPTOR_JOYSTICK() for multi-axis joysticks above just X and Y
93 * - Renamed USB_Host_ClearPipeStall() to USB_Host_ClearEndpointStall() as the function works on an endpoint address within the attached device,
94 * and not a Pipe within the host
95 * - The MS_Host_ResetMSInterface() now performs a full Mass Storage reset sequence to prevent data corruption in the event of a device
96 * lock up or timeout (thanks to David Lyons)
97 * - Added endian-correction to the CDC driver's Line Encoding control request handlers.
98 * - Library Applications:
99 * - Modified the Low Level and Class Driver AudioInput and AudioOutput demos to support multiple audio sample rates
100 * - Updated all host mode demos and projects to use the EVENT_USB_Host_DeviceEnumerationComplete() event callback for device configuration
101 * instead of manual host state machine manipulations in the main application task
102 * - Changed the reports in the GenericHID device demos to control the board LEDs, to reduce user confusion over the callback routines
103 * - Added reliability patches to the AVRISP-MKII Clone project's ISP and PDI/TPI protocols (thanks to Justin Mattair)
104 *
105 * <b>Fixed:</b>
106 * - Core:
107 * - Large number of documentation and code comment corrections (thanks to Andrey from Microsin.ru)
108 * - 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
109 * to Andrey from Microsin.ru)
110 * - Fixed compile error when FIXED_CONTROL_ENDPOINT_SIZE compile time option was disabled, and a USE_*_DESCRIPTORS compile time
111 * option was not enabled on the AVR8s
112 * - Fixed lack of C++ compatibility in some internal header files causing compile errors when using LUFA in C++ projects
113 * - Fixed error in the pipe unordered allocation algorithm for the AVR8 devices breaking compatibility with some devices
114 * - Fixed USB_USBTask not being called internally in stream transfers between packets when Partial Stream Transfers are used
115 * - Fixed swapped TWI_ADDRESS_READ and TWI_ADDRESS_WRITE values
116 * - Fixed TWI_ReadPacket() not releasing the TWI bus on read completion
117 * - Fixed optimization error in the HID Parser item value USB_SetHIDReportItemInfo() and USB_GetHIDReportItemInfo() routines if the report item was
118 * \c NULL (which should be allowable according to the API)
119 * - Fixed HID Parser CALLBACK_HIDParser_FilterHIDReportItem() callback function not being passed a cacheable report item pointer
120 * - Fixed HID Parser's largest report size bit count not including the size of the last parsed report item
121 * - Fixed HID host driver's largest HID report size count corrupt when the number of report bits exceeds 255
122 * - Library Applications:
123 * - Fixed incorrect signature in the CDC and DFU class bootloaders for the ATMEGA8U2
124 * - Fixed KeyboardHost and KeyboardHostWithParser demos displaying incorrect values when numerical keys were pressed
125 * - Fixed compile errors in the incomplete BluetoothHost demo application (thanks to Timo Lindfors)
126 * - Fixed incorrect Dataflash buffer use in the DataflashManager_WriteBlocks_RAM() function of several demos/projects (thanks to Jeremy Willden)
127 * - Fixed incorrect logging interval (always 500ms longer than requested) in the TempDataLogger project
128 * - Fixed incorrect buffer size check in the USBtoSerial project (thanks to Yuri A Nikiforov)
129 * - Fixed port state table corruption in the TCP layer of the RNDIS Ethernet device demos
130 *
131 * \section Sec_ChangeLog110528 Version 110528
132 * <b>New:</b>
133 * - Core:
134 * - Added new ORDERED_EP_CONFIG compile time option to restrict endpoint/pipe configuration to ascending order
135 * in exchange for a smaller compiled program binary size
136 * - Added a new general RingBuff.h miscellaneous ring buffer library driver header
137 * - Added new GCC_FORCE_POINTER_ACCESS() macro to correct GCC's mishandling of struct pointer accesses
138 * - Added new GCC_MEMORY_BARRIER() macro to prevent instruction reordering across boundaries
139 * - Added basic driver example use code to the library documentation
140 * - Added new Endpoint_Null_Stream() and Pipe_Null_Stream() functions
141 * - Added new ADC_GET_CHANNEL_MASK() convenience macro
142 * - Added new HID report item macros (with HID_RI_ prefix) to allow for easy creation and editing of HID report descriptors
143 * - Added new HID_DESCRIPTOR_MOUSE(), HID_DESCRIPTOR_KEYBOARD(), HID_DESCRIPTOR_JOYSTICK() and HID_DESCRIPTOR_VENDOR() macros
144 * for easy automatic creation of basic USB HID device reports
145 * - Added new MAX() and MIN() convenience macros
146 * - Added new Serial_SendData() function to the Serial driver
147 * - Added board driver support for the Sparkfun ATMEGA8U2 breakout board
148 * - Added TWI baud rate prescaler and bit length parameters to the TWI_Init() function (thanks to Thomas Herlinghaus)
149 * - Internal restructuring for eventual multiple architecture ports
150 * - Added AVR32 UC3 architecture port (currently incomplete/experimental)
151 * - Added new architecture independent functions to enable, disable, save and restore the Global Interrupt Enable flags
152 * - Added new RNDIS Device Class Driver packet send and receive functions
153 * - Library Applications:
154 * - Added ability to write protect Mass Storage disk write operations from the host OS
155 * - Added new MIDIToneGenerator project
156 * - Added new KeyboardMouseMultiReport Device ClassDriver demo
157 * - Added new VirtualSerialMassStorage Device ClassDriver demo
158 * - Added HID class bootloader, compatible with a modified version of the command line Teensy loader from PJRC.com
159 * - Added LED flashing to the CDC and DFU class bootloaders to indicate when they are running
160 *
161 * <b>Changed:</b>
162 * - Core:
163 * - Unordered Endpoint/Pipe configuration is now allowed once again by default via the previous reconfig workaround
164 * - Refactored Host mode Class Driver *_Host_ConfigurePipes() routines to be more space efficient when compiled
165 * - Added new *_ENUMERROR_PipeConfigurationFailed error codes for the *_Host_ConfigurePipes() routines
166 * - The USARTStream global is now public and documented in the SerialStream module, allowing for the serial USART
167 * stream to be accessed via its handle rather than via the implicit stdout and stdin streams
168 * - The FAST_STREAM_TRANSFERS compile time option has been removed due to lack of use and low cost/benefit ratio
169 * - Altered all endpoint/pipe stream transfers so that the new BytesProcessed parameter now points to a location
170 * where the number of bytes in the transfer that have been completed can be stored (or NULL if entire transaction
171 * should be performed in one chunk)
172 * - The NO_STREAM_CALLBACKS compile time option has now been removed due to the new partial stream transfer feature
173 * - Changed over all project and demo HID report descriptors to use the new HID report item macros
174 * - Moved the HIDParser.c source file to the LUFA/Drivers/USB/Class/Common/ directory from the LUFA/Drivers/USB/Class/Host/
175 * - Added support to the HID parser for extended USAGE items that contain the usage page as well as the usage index
176 * - Removed the SerialStream driver, rolled functionality into the regular Serial peripheral driver via the new
177 * Serial_CreateStream() and Serial_CreateBlockingStream() functions
178 * - Renamed the low level Serial byte send/receive functions, to be consistent with the CDC class driver byte functions
179 * - Altered the behaviour of the serial byte reception function so that is is non-blocking, and now returns a negative
180 * value if no character is received (to remain consistent with the CDC class driver byte reception routines)
181 * - Renamed the PRNT_Host_SendString(), CDC_Host_SendString() and CDC_Device_SendString() functions to *_SendData(), and
182 * added new versions of the *_SendString() routines that expect a null terminated string instead
183 * - Renamed all driver termination *_ShutDown() functions to the more logical name *_Disable()
184 * - Reduced latency for executing the Start-Of-Frame events (if enabled in the user application)
185 * - Removed Pipe_ClearErrorFlags(), pipe error flags are now automatically cleared when Pipe_ClearError() is called
186 * - Endpoint_ResetFIFO() renamed to Endpoint_ResetEndpoint(), to be consistent with the Pipe_ResetPipe() function name
187 * - Implemented on-demand PLL clock generation for the U4, U6 and U7 series USB AVRs when automatic PLL mode is specified
188 * - F_CLOCK changed to F_USB to be more descriptive, and applicable on future architecture ports
189 * - Renamed all low level Endpoint_Read_*, Endpoint_Write_* and Endpoint_Discard_* functions to use the number of bits instead of
190 * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
191 * - Renamed all low level Pipe_Read_*, Pipe_Write_* and Pipe_Discard_* functions to use the number of bits instead of
192 * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
193 * - Separated out board drivers by architecture in the library internals for better organisation
194 * - Library Applications:
195 * - Changed the XPLAINBridge software UART to use the regular timer CTC mode instead of the alternative CTC mode
196 * via the Input Capture register, to reduce user confusion
197 * - Combined page and word ISP programming mode code in the AVRISP-MKII clone project to reduce compiled size and
198 * increase maintainability of the code
199 * - Changed over library projects to use the new general ring buffer library driver module
200 * - Added new high level TWI packet read/write commands, altered behaviour of the TWI_StartTransmission() function
201 * - Changed TempDataLogger project's DS1307 driver to simplify the function interface and prevent a possible race condition
202 * - Changed AVRISP-MKII project to use the Watchdog interrupt for command timeouts, to reduce CPU usage and free timer 0
203 * for other uses
204 * - Updated the software USART code in the XPLAIN Bridge application so that the incoming bits are sampled at their mid-point
205 * instead of starting point, to give maximum reliability (thanks to Anton Staaf)
206 *
207 * <b>Fixed:</b>
208 * - Core:
209 * - Fixed broken USBFOO board drivers due to missing BOARD_USBFOO define
210 * - Fixed HID host class driver incorrectly binding to HID devices that do not have an OUT endpoint
211 * - Fixed incorrect definition of the HID_KEYBOARD_SC_D constant in the HID class driver (thanks to Opendous Inc.)
212 * - Fixed incorrect definition of the HID_KEYBOARD_SC_RIGHT_ARROW constant in the HID class driver (thanks to Joby Taffey)
213 * - Fixed incorrect endpoint initialisation order in the several device demos (thanks to Rick Drolet)
214 * - Fixed inverted Minimus board LEDs
215 * - Fixed incorrect byte ordering in the Audio_Device_WriteSample24 function (thanks to WZab)
216 * - Fixed several functions in the Host mode Still Image Class driver returning an error code from the incorrect
217 * error code enum (thanks to Daniel Seibert)
218 * - Fixed ReportID not being removed from the feature/out report data array in the HID class driver when Report IDs are used
219 * - Fixed incorrect BUTTONS_BUTTON1 definition for the Minimus board
220 * - Fixed Still Image Host class driver exiting the descriptor search routine prematurely if the data pipes (but not event pipe)
221 * is found
222 * - Fixed missing call to Pipe_SetInfiniteINRequests() in the Pipe_ConfigurePipe() routine
223 * - Fixed Remote Wakeup broken on the AVRs due to the mechanism only operating when the SUSPI bit is set (thanks to Holger Steinhaus)
224 * - Fixed possible invalid program execution when in host mode if corrupt descriptor lengths are supplied by the attached device
225 * - Library Applications:
226 * - Fixed Benito project discarding incoming data from the USB virtual serial port when the USART is busy
227 * - Fixed broken DFU bootloader, added XPLAIN support for bootloader start when XCK jumpered to ground
228 * - Fixed broken HID_REQ_GetReport request handler in the Low Level GenericHID demo
229 * - Fixed possible lost data in the XPLAINBridge, USBtoSerial and Benito projects when the host exceeds the packet
230 * timeout period on received packets as set by USB_STREAM_TIMEOUT_MS (thanks to Justin Rajewski)
231 * - Fixed possible programming problem in the AVRISP-MKII clone project when programming specific patterns into a target
232 * memory space that is only byte (not page) addressable
233 * - Fixed errors in the incomplete Test and Measurement device demo preventing proper operation (thanks to Pavel Plotnikov)
234 * - Fixed programming errors in the AVRISP-MKII project when the programming packet is a round multiple of the endpoint bank
235 * size under avrdude (thanks to Steffan Woltjer)
236 *
237 *
238 * \section Sec_ChangeLog101122 Version 101122
239 * <b>New:</b>
240 * - Core:
241 * - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously
242 * not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger)
243 * - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c
244 * - Added new USB_Device_GetFrameNumber() and USB_Host_GetFrameNumber() functions to retrieve the current USB frame number
245 * - Added new USB_Host_EnableSOFEvents(), USB_Host_DisableSOFEvents() and EVENT_USB_Host_StartOfFrame() for the user application
246 * handling of USB Start of Frame events while in USB Host mode
247 * - Added new PRNT_Host_BytesReceived(), PRNT_Host_ReceiveByte(), PRNT_Host_SendByte() and PRNT_Host_Flush() functions to the
248 * Print Host Class driver
249 * - Added class specific descriptor alternative struct type defines with standard USB-IF element naming
250 * - Added new project makefile template to the library and moved board driver stub files into in a new "CodeTemplates" directory
251 * - Added board hardware driver support for the Adafruit U4 breakout board
252 * - Added board hardware driver support for the Arduino Uno development board
253 * - Added board hardware driver support for the Blackcat USB JTAG board (thanks to the PSGroove team)
254 * - Added board hardware driver support for the Busware BUI development board
255 * - Added board hardware driver support for the Busware CUL V3 868MHZ radio board (thanks to Dirk Tostmann)
256 * - Added board hardware driver support for the Kernel Concepts USBFOO development board
257 * - Added board hardware driver support for the Linnix UDIP development board
258 * - Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett)
259 * - Added board hardware driver support for the Maximus board (thanks to the PSGroove team)
260 * - Added board hardware driver support for the Microsin AVR-USB162 breakout board
261 * - Added board hardware driver support for the Minimus board (thanks to the PSGroove team)
262 * - Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management
263 * tasks for each driver is called
264 * - Added standard keyboard HID report scan-code defines (thanks to Laszlo Monda)
265 * - Added new Pipe_GetBusyBanks(), Endpoint_GetBusyBanks() and Endpoint_AbortPendingIN() functions
266 * - Library Applications:
267 * - Added default test tone generation mode to the Device mode AudioInput demos
268 * - Added new NO_BLOCK_SUPPORT, NO_EEPROM_BYTE_SUPPORT, NO_FLASH_BYTE_SUPPORT and NO_LOCK_BYTE_WRITE_SUPPORT compile time options to the
269 * CDC class bootloader
270 * - Added new XCK_RESCUE_CLOCK_ENABLE compile time option to the AVRISP-MKII clone programmer project (thanks to Tom Light)
271 *
272 * <b>Changed:</b>
273 * - Core:
274 * - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions
275 * depending of if the given bank size is a compile time constant, as the compiler does a better job of optimizing
276 * with basic code
277 * - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove
278 * the need for extra casting inside the callback (thanks to Jonathan Kollasch)
279 * - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode
280 * - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode
281 * - Renamed and moved class driver common constant definitions to make the naming scheme more uniform
282 * - Moved the USB mode specifier constants into a new enum, so that they are semantically related to one another
283 * - Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed it to return the maximum number of supported banks for
284 * the given endpoint
285 * - Better algorithm to extract and convert the internal device serial number into a string descriptor (if present)
286 * - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be separately included
287 * - The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called
288 * - Renamed the EVENT_USB_Device_UnhandledControlRequest() event to EVENT_USB_Device_ControlRequest() as it is now fired before the library
289 * request handlers, not afterwards
290 * - Library Applications:
291 * - Changed over all device demos to use a clearer algorithm for the configuring of the application's endpoints
292 * - Added missing DataflashManager_CheckDataflashOperation() function to the MassStorageKeyboard demo, removed redundant
293 * SCSI_Codes.h file as these values are part of the MassStorage Class Driver
294 * - Added compile time error to the AVRISP-MKII project when built for the U4 chips, as the default VTARGET detection ADC channel
295 * does not exist on these chips (thanks to Marco)
296 * - Changed all Device mode LowLevel demos and Device Class drivers so that the control request is acknowledged and any data
297 * transferred as quickly as possible without any processing in between sections, so that long callbacks or event handlers will
298 * not break communications with the host by exceeding the maximum control request stage timeout period
299 * - Changed over all demos, drivers and internal functions to use the current frame number over the Start of Frame flag where possible
300 * to free up the Start of Frame flag for interrupt use in the user application
301 * - All project makefiles now correctly clean intermediate build files from assembly and C++ sources (thanks to Daniel Czigany)
302 * - Changed default value for the reset polarity parameter in the AVRISP-MKII project so that it defaults to active low drive
303 * - Changed configuration descriptor parser for all host mode projects and class drivers to ensure better compatibility with devices
304 * - All LowLevel demos changed to use the constants and types defined in the USB class drivers
305 * - Changed AudioInput and AudioOutput demos to reload the next sample via an interrupt rather than polling the sample timer
306 * - Rescue clock of the AVRISP-MKII moved to the AVR's OCR1A pin, so that the clock can be generated at all times
307 * - Changed ClassDriver MIDI demos to process all incoming events in a loop until the bank becomes empty rather than one at a time
308 * - Changed LowLevel MIDI demos to only clear the incoming event bank once it has become empty to support packed event packets
309 *
310 * <b>Fixed:</b>
311 * - Core:
312 * - Fixed USB_GetHIDReportItemInfo() function modifying the given report item's data when the report item does not exist
313 * within the supplied report of a multiple report HID device
314 * - Fixed critical pipe/endpoint memory allocation issue where the bank memory address space could be silently overlapped
315 * in the USB controller if the endpoints or pipes were allocated in anything other than ascending order (thanks to Martin Degelsegger)
316 * - Added LEDs_ToggleLEDs() function to several board LED drivers which were missing it (thanks to Andrei Krainev)
317 * - Fixed SET FEATURE and CLEAR FEATURE control requests directed at an unconfigured endpoint causing request timeouts
318 * - Fixed USB_Host_ClearPipeStall() incorrectly determining the endpoint direction from the currently selected pipe
319 * - Fixed JTAG_DEBUG_POINT() and JTAG_DEBUG_BREAK() macros not compiling under pure C99 standards mode
320 * - Fixed endpoint selection within the CALLBACK_HID_Device_CreateHIDReport() callback function causing broken GET REPORT requests
321 * - Fixed incorrect command name for EEPROM memory programming in the makefile dfu-ee target
322 * - Fixed incorrect LEDs_ChangeLEDs() function in the Benito board LED driver
323 * - Fixed incorrect USB_DeviceState value when unconfiguring the device without an address set
324 * - Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init() is called
325 * - Fixed random enumeration failure while in device mode due to interrupts causing the Set Address request to exceed maximum timings
326 * - Fixed MIDI_Host_Flush() not aborting early when the specified MIDI host interface was not configured
327 * - Fixed MIDI class driver send routines silently discarding packets if the endpoint or pipe is busy (thanks to Robin Green)
328 * - Library Applications:
329 * - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to
330 * missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger)
331 * - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control
332 * request handler
333 * - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value
334 * - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2
335 * - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev)
336 * - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used
337 * - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules
338 * - Fixed USBtoSerial and XPLAINBridge demos discarding data from the PC if the send buffer becomes full
339 * - Fixed broken input in the MagStripe reader project due to an incorrect HID report descriptor
340 * - Fixed incorrect PollingIntervalMS values in the demo/project/bootloader endpoint descriptors (thanks to MCS Electronics)
341 * - Fixed AVRISP-MKII clone project not starting the target's program automatically after exiting TPI programming mode
342 *
343 *
344 * \section Sec_ChangeLog100807 Version 100807
345 * <b>New:</b>
346 * - Added new ADC_DisableChannel() function (thanks to Mich Davis)
347 * - Added new VTARGET_REF_VOLTS and VTARGET_SCALE_FACTOR compile time defines to the AVRISP-MKII programmer project to set
348 * the VTARGET reference voltage and scale factor
349 * - Added new pgm_read_ptr() macro to Common.h for reading of pointers out of flash memory space
350 * - Added new SWAPENDIAN_16() and SWAPENDIAN_32() macros to Common.h for statically initialized variables at compile time
351 * - Added new Drivers/USB/LowLevel/Device.c file to house Device mode specific functions that are more complicated than simple macros
352 * - Added new AVRStudio 4 project files for all library demos, projects and bootloaders
353 * - Added ability to set the serial baud rate via the user's terminal in the XPLAINBridge project
354 * - Added new LUFA module variables for the different source modules in the core library makefile to simplify project makefiles
355 * - Added start of a new Test and Measurement class demo (thanks to Peter Lawrence)
356 * - Added new SPI_ORDER_* data order masks to the SPI peripheral driver
357 * - Added support to the AVRISP-MKII project for ISP speeds slower than 125KHz via a new software SPI driver
358 * - Added support for the new button/LED on the latest model USBTINY-MKII
359 *
360 * <b>Changed:</b>
361 * - The RingBuff library code has been replaced in the XPLAINBridge, Benito and USBtoSerial projects with an ultra lightweight
362 * ring buffer to help improve the reliability of the projects
363 * - The EEPROM stream read/write functions now use eeprom_update_byte() instead of eeprom_write_byte(), so that only
364 * changed bytes are written to EEPROM to preserve its lifespan
365 * - Changed over the AVRISP-MKII and TemperatureDataLogger projects to use eeprom_update_byte() when writing non-volatile
366 * parameters to EEPROM to preserve its lifespan
367 * - Removed unused line encoding data and control requests from the CDC Bootloader code, to save space
368 * - Renamed SERIAL_STREAM_ASSERT() macro to STDOUT_ASSERT()
369 * - The USB_Device_IsRemoteWakeupSent() and USB_Device_IsUSBSuspended() macros have been deleted, as they are now obsolete
370 * - Rewrote the implementation of the SwapEndian_16() and SwapEndian_32() functions so that they compile down in most instances to
371 * minimal loads and stores rather than complicated shifts
372 * - The software UART in the XPLAINBridge has been largely altered to try to improve upon its performance and reliability
373 * - The USBtoSerial and Benito projects now flushes received data via a flush timer, so that several bytes can be transmitted at once
374 * - Removed the automated checking of event names in the demo, project and bootloader makefiles due to inconsistencies between the
375 * behaviour of the command line tools used to perform the check on each platform
376 * - Internal USB driver source files renamed and moved to ease future possible architecture ports
377 * - All internal pseudo-function macros have been converted to true inline functions for type-safety and readability
378 * - Changed LED indicator masks for the AVRISP-MKII project, so that there are defined roles for each LED
379 * - Altered the CDC Device and Host Class drivers' receive byte routines, so that no data is indicated by the function returning a
380 * negative value (thanks to Andreas Paulin)
381 * - Added auto flushing of OUT data to the CDC Host Class driver's USBTask function to automatically flush the send pipe buffer
382 *
383 * <b>Fixed:</b>
384 * - Fixed AVRISP project sending a LOAD EXTENDED ADDRESS command to 128KB AVRs after programming or reading from
385 * the last page of FLASH (thanks to Gerard Sexton)
386 * - Fixed AVRISP project not sending a full erase-and-write EEPROM command to XMEGA targets when writing to the EEPROM
387 * instead of the split write-only command (thanks to Tim Margush)
388 * - Fixed RNDISEthernet demos crashing when calculating checksums for Ethernet/TCP packets of more than ~500 bytes due to
389 * an overflow in the checksum calculation loop (thanks to Kevin Malec)
390 * - Fixed XPLAINBridge project not correctly reading the XMEGA's supply voltage when reporting back to the host
391 * - Fixed incorrect signature for the ATMEGA32U2 in the DFU bootloader (thanks to Axel Rohde)
392 * - Fixed internal device serial not being accessible on the ATMEGAXXU2 AVRs (thanks to Axel Rohde)
393 * - Fixed void pointer arithmetic in ConfigDescriptor.h breaking C++ compatibility (thanks to Michael Hennebry)
394 * - Fixed broken PDI EEPROM Section Erase functionality in the AVRISP-MKII project
395 * - Fixed USB_Device_SendRemoteWakeup() not working when the USB clock was frozen during USB bus suspend (thanks to Brian Dickman)
396 * - Fixed occasional lockup of the AVRISP project due to the timeout extension code incorrectly extending the timeout in
397 * PDI and TPI programming modes infinitely
398 * - Fixed HID device class driver still using PrevReportINBuffer for GetReport control requests even when it has been
399 * set to NULL by the user application (thanks to Axel Rohde)
400 * - Fixed MIDI_Device_SendEventPacket() not correctly waiting for the endpoint to become ready (thanks to Robin Green)
401 * - Fixed Benito and USBtoSerial projects not turning off the USART before reconfiguring it, which could cause incorrect
402 * operation to occur (thanks to Bob Paddock)
403 * - Fixed Serial peripheral driver not turning off the USART before reconfiguring it, which would cause incorrect operation
404 * to occur (thanks to Bob Paddock)
405 * - Fixed software application start command broken in the DFU class bootloader when dfu-programmer is used due to application
406 * start address corruption
407 *
408 *
409 * \section Sec_ChangeLog100513 Version 100513
410 * <b>New:</b>
411 * - Added incomplete MIDIToneGenerator project
412 * - Added new Relay Controller Board project (thanks to OBinou)
413 * - Added board hardware driver support for the Teensy, USBTINY MKII, Benito and JM-DB-U2 lines of third party USB AVR boards
414 * - Added new ATTR_NO_INIT variable attribute for global variables that should not be automatically cleared on startup
415 * - Added new ENDPOINT_*_BusSuspended error code to the Endpoint function, so that the stream functions early-abort if the bus
416 * is suspended before or during a transfer
417 * - Added new EVENT_CDC_Device_BreakSent() event and CDC_Host_SendBreak() function to the Device and Host CDC Class drivers
418 * - Added ReportType parameter to the HID device class driver CALLBACK_HID_Device_ProcessHIDReport() function so that FEATURE
419 * reports from the host to the device can be correctly processed
420 * - Added ReportType parameter to the HID host class driver HID_Host_SendReportByID() function so that FEATURE reports can be
421 * issued to the attached device
422 *
423 * <b>Changed:</b>
424 * - AVRISP programmer project now has a more robust timeout system
425 * - Added a timeout value to the TWI_StartTransmission() function, within which the addressed device must respond
426 * - Webserver project now uses the board LEDs to indicate the current IP configuration state
427 * - Added ENABLE_TELNET_SERVER compile time option to the Webserver project to disable the TELNET server if desired
428 * - Increased throughput of the USBtoSerial demo on systems that send multiple bytes per packet (thanks to Opendous Inc.)
429 * - Double bank CDC endpoints in the XPLAIN Bridge project, re-enable JTAG once the mode selection pin has been sampled.
430 * - Standardized the naming scheme given to configuration descriptor sub-elements in the Device mode demos, bootloaders
431 * and projects
432 * - All Class Driver Host mode demos now correctly set the board LEDs to READY once the enumeration process has completed
433 * - Added LIBUSB_FILTERDRV_COMPAT compile time option to the AVRISP programmer project to make the code compatible with Windows
434 * builds of avrdude at the expense of AVRStudio compatibility
435 * - Removed two-step endpoint/pipe bank clear and switch sequence for smaller, faster endpoint/pipe code
436 * - The USB_Init() function no longer calls sei() - the user is now responsible for enabling interrupts when they are ready
437 * for them to be enabled (thanks to Andrei Krainev)
438 * - The Audio_Device_IsSampleReceived() and Audio_Device_IsReadyForNextSample() functions are now inline, to reduce overhead
439 * - Removed the cast to uint16_t on the set baud rate in the USBtoSerial project, so that the higher >1M baud rates can be
440 * selected (thanks to Steffan Woltjer)
441 * - Removed software PDI and TPI emulation from the AVRISP-MKII clone project as it was very buggy and slow - PDI and TPI must
442 * now be implemented via separate programming headers
443 * - The CDC class bootloader now uses a watchdog reset rather than a soft-reset when exited to ensure that all hardware is
444 * properly reset to their defaults
445 * - Device mode class driver callbacks are now fired before the control request status stage is sent to prevent the host from
446 * timing out if another request is immediately fired and the device has a lengthy callback routine
447 * - The TeensyHID bootloader has been removed, per request from Paul at PJRC
448 * - The LIBUSB_FILTERDRV_COMPAT compile time option in the XPLAINBridge and AVRISP-MKII projects has been renamed
449 * LIBUSB_DRIVER_COMPAT, as it applies to all software on all platforms using the libUSB driver
450 *
451 * <b>Fixed:</b>
452 * - Fixed possible device lockup when INTERRUPT_CONTROL_ENDPOINT is enabled and the control endpoint is not properly
453 * selected when the ISR completes
454 * - Fixed AVRISP-MKII clone project not correctly issuing LOAD EXTENDED ADDRESS commands when the extended address
455 * boundary is crossed during programming or read back (thanks to Gerard Sexton)
456 * - Fixed warnings when building the AVRISP-MKII clone project with the ENABLE_XPROG_PROTOCOL compile time option disabled
457 * - Fixed software PDI/TPI programming mode in the AVRISP project not correctly toggling just the clock pin
458 * - Fixed TWI_StartTransmission() corrupting the contents of the GPIOR0 register
459 * - Fixed TWI driver not aborting when faced with no response after attempting to address a device on the bus
460 * - Fixed ADC routines not correctly returning the last result when multiple channels were read
461 * - Fixed ADC routines failing to read the extended channels (Channels 8 to 13, Internal Temperature Sensor) on the
462 * U4 series USB AVR parts
463 * - Fixed LowLevel MassStorage demo broken on the U2 series USB AVRs due to unsupported double-banked endpoint modes used
464 * - Fixed compilation error in the AudioInput demos when MICROPHONE_BIASED_TO_HALF_RAIL is defined (thanks to C. Scott Ananian)
465 * - Fixed incorrect definition of HID_ALIGN_DATA() causing incorrect HID report item data alignment
466 * - Fixed Still Image Host class driver not resetting the transaction ID when a new session is opened, fixed driver not sending
467 * a valid session ID to the device
468 * - Removed invalid dfu and flip related targets from the bootloaders - bootloaders can only be replaced with an external programmer
469 * - Fixed Set/Clear Feature requests directed to a non-configured endpoint not returning a stall to the host
470 * - Fixed HID Device Class Driver not allocating a temporary buffer when the host requests a report via the control endpoint and the
471 * user has set the PrevReportINBuffer driver configuration element to NULL (thanks to Lars Noschinski)
472 * - Fixed device state not being reset to DEVICE_STATE_Default if the host sets a 0x00 device address
473 * - Fixed device not stalling configuration requests before the device's address has been set
474 * - Fixed possibility of internal signature retrieval being corrupted if an interrupt occurs during a signature byte
475 * read (thanks to Andrei Krainev)
476 * - Fixed device state not being reset back to the default state if the host sets the address to 0
477 * - Fixed Set Configuration requests not being stalled until the host has set the device's address
478 * - Fixed Host mode HID class driver not sending the correct report type when HID_Host_SendReportByID() was called and the
479 * HID_HOST_BOOT_PROTOCOL_ONLY compile time option is set
480 * - Fixed INTERRUPT_CONTROL_ENDPOINT compile time option preventing other interrupts from occurring while the control endpoint
481 * request is being processed, causing possible lockups if a USB interrupt occurs during a transfer
482 * - Remove incorrect Abstract Call Management class specific descriptor from the CDC demos, bootloaders and projects
483 *
484 *
485 * \section Sec_ChangeLog100219 Version 100219
486 *
487 * <b>New:</b>
488 * - Added TPI programming support for 6-pin ATTINY devices to the AVRISP programmer project (thanks to Tom Light)
489 * - Added command timeout counter to the AVRISP project so that the device no longer freezes when incorrectly connected
490 * to a target
491 * - Added new TemperatureDataLogger application, a USB data logger which writes to the device's dataflash and appears to
492 * the host as a standard Mass Storage device when inserted
493 * - Added MIDI event packing support to the MIDI Device and Host mode Class drivers, allowing for multiple MIDI events to
494 * sent or received in packed form in a single USB packet
495 * - Added new MIDI send buffer flush routines to the MIDI Device and Host mode Class drivers, to flush packed events
496 * - Added master mode hardware TWI driver for easy TWI peripheral control
497 * - Added ADC MUX masks for the standard ADC input channels on all AVR models with an ADC, altered demos to use these masks
498 * as on some models, the channel number is not identical to its single-ended ADC MUX mask
499 * - New Webserver project, a RNDIS host USB webserver using the open source uIP TCP/IP network stack and FatFS library
500 * - New BOARD value option BOARD_NONE (equivalent to not specifying BOARD) which will remove all board hardware drivers which
501 * do not adversely affect the code operation (currently only the LEDs driver)
502 * - Added keyboard modifier masks (HID_KEYBOARD_MODIFER_*) and LED report masks (KEYBOARD_LED_*) to the HID class driver and
503 * Keyboard demos
504 * - Added .5MHz recovery clock to the AVRISP programmer project when in ISP programming mode to correct mis-set fuses
505 *
506 * <b>Changed:</b>
507 * - Slowed down software USART carried PDI programming in the AVRISP project to prevent transmission errors
508 * - Renamed the AVRISP project folder to AVRISP-MKII to reduce confusion
509 * - Renamed the RESET_LINE_* makefile tokens in the AVRISP MKII Project to AUX_LINE_*, as they are not always used for target
510 * reset
511 * - Changed over the MassStorageKeyboard Class driver device demo to use Start of Frame events rather than a timer to keep track
512 * of elapsed milliseconds
513 * - Inlined currently unused (but standardized) maintenance functions in the Device and Host Class drivers to save space
514 * - The XPLAINBridge project now selects between a USB to Serial bridge and a PDI programmer on startup, reading the JTAG port's
515 * TDI pin to determine which mode to use
516 * - Removed the stream example code from the Low Level VirtualSerial demos, as they were buggy and only served to add clutter
517 *
518 * <b>Fixed:</b>
519 * - Fixed AVRISP project not able to enter programming mode when ISP protocol is used
520 * - Fixed AVRISP PDI race condition where the guard time between direction changes could be interpreted as a start bit
521 * - Fixed ADC_IsReadingComplete() returning an inverted result
522 * - Fixed blocking CDC streams not aborting when the host is disconnected
523 * - Fixed XPLAIN board Dataflash driver broken due to incorrect preprocessor commands
524 * - Fixed inverted XPLAIN LED driver output (LED turned on when it was supposed to be turned off, and vice-versa)
525 * - Fixed Class Driver struct interface numbers in the KeyboardMouse and VirtualSerialMouse demos (thanks to Renaud Cerrato)
526 * - Fixed invalid USB controller PLL prescaler values for the ATMEGAxxU2 controllers
527 * - Fixed lack of support for the ATMEGA32U2 in the DFU and CDC class bootloaders
528 * - Fixed Benito project not resetting the target AVR automatically when programming has completed
529 * - Fixed DFU bootloader programming not discarding the correct number of filler bytes from the host when non-aligned programming
530 * ranges are specified (thanks to Thomas Bleeker)
531 * - Fixed CDC and RNDIS host demos and class drivers - bidirectional endpoints should use two separate pipes, not one half-duplex pipe
532 * - Fixed Pipe_IsEndpointBound() not taking the endpoint's direction into account
533 * - Fixed EEPROM and FLASH ISP programming in the AVRISP project
534 * - Fixed incorrect values of USB_CONFIG_ATTR_SELFPOWERED and USB_CONFIG_ATTR_REMOTEWAKEUP tokens (thanks to Claus Christensen)
535 * - Fixed SerialStream driver blocking while waiting for characters to be received instead of returning EOF
536 * - Fixed SerialStream driver not setting stdin to the created serial stream (thanks to Mike Alexander)
537 * - Fixed USB_GetHIDReportSize() returning the number of bits in the specified report instead of bytes
538 * - Fixed AVRISP project not extending the command delay after each successful page/word/byte program
539 * - Fixed accuracy of the SERIAL_UBBRVAL() and SERIAL_2X_UBBRVAL() macros for higher baud rates (thanks to Renaud Cerrato)
540 *
541 *
542 * \section Sec_ChangeLog091223 Version 091223
543 *
544 * <b>New:</b>
545 * - Added activity LED indicators to the AVRISP project to indicate when the device is busy processing a command
546 * - The USB target family and allowable USB mode tokens are now public and documented (USB_CAN_BE_*, USB_SERIES_*_AVR)
547 * - Added new XPLAIN USB to Serial Bridge project (thanks to John Steggall for initial proof-of-concept, David Prentice
548 * and Peter Danneger for revised software USART code)
549 * - Added new RNDIS Ethernet Host LowLevel demo
550 * - Added new RNDIS Ethernet Host Class Driver
551 * - Added new RNDIS Ethernet Host ClassDriver demo
552 * - Added CDC_Host_Flush() function to the CDC Host Class driver to flush sent data to the attached device
553 * - Added PDI programming support for XMEGA devices to the AVRISP programmer project (thanks to Justin Mattair)
554 * - Added support for the XPLAIN board Dataflash, with new XPLAIN_REV1 board target for the different dataflash used
555 * on the first revision boards compared to the one mounted on later revisions
556 * - Added new HID_ALIGN_DATA() macro to return the pre-retrieved value of a HID report item, left-aligned to a given datatype
557 * - Added new PreviousValue to the HID Report Parser report item structure, for easy monitoring of previous report item values
558 * - Added new EVK527 board target
559 * - Added new USB_Host_GetDeviceStringDescriptor() convenience function
560 * - Added new LEDNotification project to the library, to give a visual LED notification on new events from the host
561 * - Added new NO_DEVICE_REMOTE_WAKEUP and NO_DEVICE_SELF_POWER compile time options
562 *
563 * <b>Changed:</b>
564 * - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of key codes
565 * as this relied on non-standard OS driver behaviour to repeat key groups
566 * - The SCSI_Request_Sense_Response_t and SCSI_Inquiry_Response_t type defines are now part of the Mass Storage Class
567 * driver common defines, rather than being defined in the Host mode Class driver section only
568 * - The USB_MODE_HOST token is now defined even when host mode is not available
569 * - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to
570 * indicate the report type to generate
571 * - All Class Drivers now return false or the "DeviceDisconnected" error code of their respective error enums when a function
572 * is called when no host/device is connected where possible
573 * - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to HOST_SENDCONTROL_DeviceDisconnected to be in line
574 * with the rest of the library error codes
575 * - Make MIDI device demos also turn off the on board LEDs if MIDI Note On messages are sent with a velocity of zero,
576 * which some devices use instead of Note Off messages (thanks to Robin Green)
577 * - The CDC demos are now named "VirtualSerial" instead to indicate the demos' function rather than its implemented USB class,
578 * to reduce confusion and to be in line with the rest of the LUFA demos
579 * - The SImage_Host_SendBlockHeader() and SImage_Host_ReceiveBlockHeader() Still Image Host Class driver functions are now public
580 *
581 * <b>Fixed:</b>
582 * - Added missing CDC_Host_CreateBlockingStream() function code to the CDC Host Class driver
583 * - Fixed incorrect values for REPORT_ITEM_TYPE_* enum values causing corrupt data in the HID Host Parser
584 * - Fixed misnamed SI_Host_USBTask() and SI_Host_ConfigurePipes() functions
585 * - Fixed broken USB_GetNextDescriptor() function causing the descriptor to jump ahead double the expected amount
586 * - Fixed Pipe_IsEndpointBound() not masking the given Endpoint Address against PIPE_EPNUM_MASK
587 * - Fixed host state machine not enabling Auto VBUS mode when HOST_DEVICE_SETTLE_DELAY_MS is set to zero
588 * - Fixed misnamed Pipe_SetPipeToken() macro for setting a pipe's direction
589 * - Fixed CDCHost failing on devices with bidirectional endpoints
590 * - Fixed USB driver failing to define the PLL prescaler mask for the ATMEGA8U2 and ATMEGA16U2
591 * - Fixed HID Parser not distributing the Usage Min and Usage Max values across an array of report items
592 * - Fixed Mass Storage Host Class driver and Low Level demo not clearing the error condition if an attached device returns a
593 * STALL to a GET MAX LUN request (thanks to Martin Luxen)
594 * - Fixed TeensyHID bootloader not properly shutting down the USB interface to trigger a disconnection on the host before resetting
595 * - Fixed MassStorageHost Class driver demo not having USB_STREAM_TIMEOUT_MS compile time option set properly to prevent slow
596 * devices from timing out the data pipes
597 * - Fixed the definition of the Endpoint_BytesInEndpoint() macro for the U4 series AVR parts
598 * - Fixed MIDI host Class driver MIDI_Host_SendEventPacket() routine not properly checking for Pipe ready before writing
599 * - Fixed use of deprecated struct initializers, removed library unused parameter warnings when compiled with -Wextra enabled
600 * - Fixed Still Image Host Class driver truncating the PIMA response code (thanks to Daniel Seibert)
601 * - 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
602 * used (thanks to Daniel Levy)
603 * - Fixed TeensyHID bootloader not enumerating to the host correctly (thanks to Clint Fisher)
604 * - Fixed AVRISP project timeouts not checking for the correct timeout period (thanks to Carl Ott)
605 * - Fixed STK525 Dataflash driver using incorrect bit-shifting for Dataflash addresses (thanks to Tim Mitchell)
606 *
607 *
608 * \section Sec_ChangeLog091122 Version 091122
609 *
610 * <b>New:</b>
611 * - Added new Dual Role Keyboard/Mouse demo
612 * - Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the HID Host Class driver when
613 * Report protocol is not needed
614 * - Added new MIDI LowLevel and ClassDriver Host demo, add new MIDI Host Class driver
615 * - Added new CDC/Mouse ClassDriver device demo
616 * - Added new Joystick Host ClassDriver and LowLevel demos
617 * - Added new Printer Host mode Class driver
618 * - Added new Printer Host mode ClassDriver demo
619 * - Added optional support for double banked endpoints and pipes in the Device and Host mode Class drivers
620 * - Added new stream creation function to the CDC Class drivers, to easily make standard I/O streams from CDC Class driver instances
621 *
622 * <b>Changed:</b>
623 * - Removed mostly useless "TestApp" demo, as it was mainly useful only for checking for syntax errors in the library
624 * - MIDI device demos now receive MIDI events from the host and display note ON messages via the board LEDs
625 * - Cleanups to the Device mode Mass Storage demo application SCSI routines
626 * - Changed Audio Class driver sample read/write functions to be inline, to reduce the number of cycles needed to transfer
627 * samples to and from the device (allowing more time for sample processing and output)
628 * - Audio class Device mode demos now work at both 16MHz and 8MHz, rather than just at 8MHz
629 * - The previous USBtoSerial demo has been moved into the projects directory, as it was just a modified CDC demo
630 * - The Endpoint/Pipe functions now use the const qualifier on the input buffer
631 * - Changed the CALLBACK_HIDParser_FilterHIDReportItem() callback to pass a HID_ReportItem_t rather than just the current
632 * item's attributes, to expose more information on the item (including it's type, collection path, etc.)
633 * - Changed MouseHostWithParser demos to check that the report items have a Mouse usage collection as a parent at some point,
634 * to prevent Joysticks from enumerating with the demo
635 * - Corrected the name of the misnamed USB_GetDeviceConfigDescriptor() function to USB_Host_GetDeviceConfigDescriptor().
636 * - Keyboard LowLevel/ClassDriver demos now support multiple simultaneous key presses (up to 6) per report
637 *
638 * <b>Fixed:</b>
639 * - Fixed PrinterHost demo returning invalid Device ID data when the attached device does not have a
640 * device ID (thanks to Andrei Krainev)
641 * - Changed LUFA_VERSION_INTEGER define to use BCD values, to make comparisons easier
642 * - Fixed issue in the HID Host class driver's HID_Host_SendReportByID() routine using the incorrect mode (control/pipe)
643 * to send report to the attached device
644 * - Fixed ClassDriver AudioOutput device demo not selecting an audio output mode
645 * - Fixed incorrect SampleFrequencyType value in the AudioInput and AudioOutput ClassDriver demos' descriptors
646 * - Fixed incorrect event name rule in demo/project/bootloader makefiles
647 * - Fixed HID device class driver not reselecting the correct endpoint once the user callback routines have been called
648 * - Corrected HID descriptor in the Joystick Device demos - buttons should be placed outside the pointer collection
649 * - Fixed HID report parser collection paths invalid due to misplaced semicolon in the free path item search loop
650 * - Fixed HID host Class driver report send/receive report broken when issued through the control pipe
651 * - Fixed HOST_STATE_AS_GPIOR compile time option being ignored when in host mode (thanks to David Lyons)
652 * - Fixed LowLevel Keyboard demo not saving the issues report only after it has been sent to the host
653 * - Fixed Endpoint_Write_Control_Stream_* functions not sending a terminating IN when given data Length is zero
654 *
655 *
656 * \section Sec_ChangeLog090924 Version 090924
657 *
658 * <b>New:</b>
659 * - Added new host mode class drivers and matching demos to the library for rapid application development
660 * - Added flag to the HID report parser to indicate if a device has multiple reports
661 * - Added new EVENT_USB_Device_StartOfFrame() event, controlled by the new USB_Device_EnableSOFEvents() and
662 * USB_Device_DisableSOFEvents() macros to give bus-synchronized millisecond interrupts when in USB device mode
663 * - Added new Endpoint_SetEndpointDirection() macro for bidirectional endpoints
664 * - Added new AVRISP project, a LUFA powered clone of the Atmel AVRISP-MKII programmer
665 * - Added ShutDown() functions for all hardware peripheral drivers, so that peripherals can be turned off after use
666 * - Added new CDC_Device_Flush() command to the device mode CDC Class driver to flush Device->Host data
667 * - Added extra masks to the SPI driver, changed SPI_Init() so that the clock polarity and sample modes can be set
668 * - Added new callback to the HID report parser, so that the user application can filter only the items it is interested
669 * in to be stored into the HIDReportInfo structure to save RAM
670 * - Added support for the officially recommended external peripheral layout for the BUMBLEB board (thanks to Dave Fletcher)
671 * - Added new Pipe_IsFrozen() macro to determine if the currently selected pipe is frozen
672 * - Added new USB_GetHIDReportSize() function to the HID report parser to retrieve the size of a given report by its ID
673 * - Added new combined Mass Storage and Keyboard demo (thanks to Matthias Hullin)
674 *
675 * <b>Changed:</b>
676 * - SetIdle requests to the HID device driver with a 0 idle period (send changes only) now only affect the requested
677 * HID interface within the device, not all HID interfaces
678 * - Added explicit attribute masks to the device mode demos' descriptors
679 * - Added return values to the CDC and MIDI class driver transmit functions
680 * - Optimized Endpoint_Read_Word_* and Pipe_Read_Word_* macros to reduce compiled size
681 * - Added non-null function parameter pointer restrictions to USB Class drivers to improve user code reliability
682 * - Added new "Common" section to the class drivers, to hold all mode-independent definitions for clarity
683 * - Moved SCSI command/sense constants into the Mass Storage Class driver, instead of the user-code
684 * - Altered the SCSI commands in the LowLevel Mass Storage Host to save on FLASH space by reducing function calls
685 * - Changed the parameters and behaviour of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks
686 * and data validations internally, to simplify user code
687 * - Changed HIDParser to only zero out important values in the Parsed HID Report Item Information structure to save cycles
688 * - The HID report parser now always processed FEATURE items - HID_ENABLE_FEATURE_PROCESSING token now has no effect
689 * - The HID report parser now always ignores constant-data items, HID_INCLUDE_CONSTANT_DATA_ITEMS token now has no effect
690 * - The Benito Programmer project now has its own unique VID/PID pair allocated from the Atmel donated LUFA VID/PID pool
691 * - Add in new invalid event hook check targets to project makefiles to produce compilation errors when invalid event names
692 * are used in a project
693 * - The HID Report Parser now gives information on the total length of each report within a HID interface
694 * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate USB_Descriptor_* and
695 * USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so both may be used
696 *
697 * <b>Fixed:</b>
698 * - Fixed possible lockup in the CDC device class driver, when the host sends data that is a multiple of the
699 * endpoint's bank
700 * - Fixed swapped parameters in the HID state memory copy call while processing a HID PUSH item in the HID report parser
701 * - Fixed memory corruption HID report parser when too many COLLECTION or PUSH items were processed
702 * - Fixed HID report parser not resetting the FEATURE item count when a REPORT ID item is encountered
703 * - Fixed USBtoSerial demos not reading in UDR1 when the USART receives data but the USB interface is not enumerated,
704 * causing continuous USART receive interrupts
705 * - Fixed misspelled event name in the Class driver USBtoSerial demo, preventing correct operation
706 * - Fixed invalid data being returned when a GetStatus request is issued in Device mode with an unhandled data recipient
707 * - Added hardware USART receive interrupt and software buffering to the Benito project to ensure received data is not
708 * missed or corrupted
709 * - Fixed Device mode HID Class driver always sending IN packets, even when nothing to report
710 * - Fixed Device mode HID Class driver not explicitly initializing the ReportSize parameter to zero before calling callback
711 * routine, so that ignored callbacks don't cause incorrect data to be sent
712 * - Fixed StillImageHost not correctly freezing and unfreezing data pipes while waiting for a response block header
713 * - Fixed error in the PrinterHost demo preventing the full page data from being sent to the attached device (thanks to John Andrews)
714 * - Fixed CDC based demos and projects' INF driver files under 64 bit versions of Windows (thanks to Ronny Hanson, Thomas Bleeker)
715 * - Re-add in missing flip, flip-ee, dfu and dfu-ee targets to project makefiles (thanks to Opendous Inc.)
716 * - Fix allowable F_CPU values comment in project makefiles to more accurately reflect the allowable values on the USB AVRs
717 * - Fixed DFU and CDC class bootloaders on the series 2 USB AVRs, corrected invalid signatures, added support for the new
718 * ATMEGAxx2 series 2 variant AVRs to the DFU bootloader
719 * - Fixed Low Level USBtoSerial demo not storing received characters (thanks to Michael Cooper)
720 * - Fixed MIDI Device Class driver not sending/receiving MIDI packets of the correct size (thanks to Thomas Bleeker)
721 *
722 *
723 * \section Sec_ChangeLog090810 Version 090810
724 *
725 * <b>New:</b>
726 * - Added new device class drivers and matching demos to the library for rapid application development
727 * - Added new PrinterHost demo (thanks to John Andrews)
728 * - Added USB Missile Launcher project, submitted by Dave Fletcher
729 * - Added new Benito Arduino Programmer project
730 * - Added incomplete device and host mode demos for later enhancement
731 * - Updated MassStorage device block write routines to use ping-pong Dataflash buffering to increase throughput by around 30%
732 * - Error status LEDs shown when device endpoint configuration fails to complete in all demos and projects
733 * - Added new USB_Host_SetDeviceConfiguration() convenience function for easy configuration selection of devices while in USB
734 * host mode
735 * - Added new USB_Host_ClearPipeStall() convenience function to clear a stall condition on an attached device's endpoint
736 * - Added new USB_Host_GetDeviceDescriptor() convenience function to retrieve the attached device's Device descriptor
737 * - Added new Endpoint_ClearStatusStage() convenience function to assist with the status stages of control transfers
738 * - Added new USE_INTERNAL_SERIAL define for using the unique serial numbers in some AVR models as the USB device's serial number,
739 * added NO_INTERNAL_SERIAL compile time option to turn off new serial number reading code
740 * - Added new DATAFLASH_CHIP_MASK() macro to the Dataflash driver, which returns the Dataflash select mask for the given chip index
741 * - Added new HOST_STATE_WaitForDeviceRemoval host state machine state for non-blocking disabling of device communications until the
742 * device has been removed (for use when an error occurs or communications with the device have completed)
743 * - Added new FAST_STREAM_TRANSFERS compile time option for faster stream transfers via multiple bytes copied per stream loop
744 * - Added stdio stream demo code to the CDC device demos, to show how to create standard streams out of the virtual serial ports
745 * - Added new EEPROM and FLASH buffer versions of the Endpoint and Pipe stream functions
746 * - Added new USE_FLASH_DESCRIPTORS and FIXED_NUM_CONFIGURATIONS compile time options
747 * - Added support for the new ATMEGA32U2, ATMEGA16U2 and ATMEGA8U2 AVR models
748 * - Added new USB_DeviceState variable to keep track of the current Device mode USB state
749 * - Added new LEDs_ToggleLEDs() function to the LEDs driver
750 * - Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions
751 * - Added new DEVICE_STATE_AS_GPIOR and HOST_STATE_AS_GPIOR compile time options
752 * - Added 404 Not Found errors to the webserver in the RNDIS demos to indicate invalid URLs
753 *
754 * <b>Changed:</b>
755 * - Deprecated pseudo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused)
756 * - The device-mode CALLBACK_USB_GetDescriptor() function now has an extra parameter so that the memory space in which the requested
757 * descriptor is located can be specified. This means that descriptors can now be located in multiple memory spaces within a device.
758 * - Removed vague USB_IsConnected global - test USB_DeviceState or USB_HostState explicitly to gain previous functionality
759 * - Removed USB_IsSuspended global - test USB_DeviceState against DEVICE_STATE_Suspended instead
760 * - Extended USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch
761 * - Dataflash_WaitWhileBusy() now always ensures that the dataflash is ready for the next command immediately after returning,
762 * no need to call Dataflash_ToggleSelectedChipCS() afterwards
763 * - Low level API MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready
764 * - Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow errors
765 * - Pipe stream functions now automatically set the correct pipe token, so that bidirectional pipes can be used
766 * - Pipe_ConfigurePipe() now automatically defaults IN pipes to accepting infinite IN requests, this can still be changed by calling
767 * the existing Pipe_SetFiniteINRequests() function
768 * - Changed F_USB entries in project makefiles to alias to F_CPU by default, as this is the most common case
769 * - Host mode demos now use sane terminal escape codes, so that text is always readable and events/program output is visually distinguished
770 * from one another using foreground colours
771 * - Internal per-device preprocessing conditions changed to per-device series rather than per-controller group for finer-grain
772 * internal control
773 * - Interrupts are no longer disabled during the processing of Control Requests on the default endpoint while in device mode
774 * - AudioOutput demos now always output to board LEDs, regardless of output mode (removed AUDIO_OUT_LEDS project option)
775 * - Removed SINGLE_DEVICE_CONFIGURATION compile time option in favor of the new FIXED_NUM_CONFIGURATIONS option so that the exact number
776 * of device configurations can be defined statically
777 * - Removed VBUS events, as they are already exposed to the user application via the regular device connection and disconnection events
778 * - Renamed and altered existing events to properly separate out Host and Device mode events
779 * - All demos switched over from GNU99 standards mode to C99 standards mode, to reduce the dependencies on GCC-only language extensions
780 *
781 * <b>Fixed:</b>
782 * - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix
783 * bootloaders on some of the USB AVR devices where avr-libc erroneously defines RAMPZ
784 * - Fixes to MassStorageHost for better device compatibility (increase command timeout, change MassStore_WaitForDataReceived()
785 * to only unfreeze and check one data pipe at a time) to prevent incorrect device enumerations and freezes while transferring data
786 * - Make Pipe_ConfigurePipe() mask the given endpoint number against PIPE_EPNUM_MASK to ensure the endpoint IN direction bit is
787 * cleared to prevent endpoint type corruption
788 * - Fixed issue opening CDC-ACM ports on hosts when the CDC device tries to send data before the host has set the line encoding
789 * - Fixed USB_OPT_MANUAL_PLL option being ignored during device disconnects on some models (thanks to Brian Dickman)
790 * - Fixed documentation mentioning Pipe_GetCurrentToken() function when correct function name is Pipe_GetPipeToken()
791 * - Fixed ADC driver for the ATMEGA32U4 and ATMEGA16U4 (thanks to Opendous Inc.)
792 * - Fixed CDCHost demo unfreezing the pipes at the point of configuration, rather than use
793 * - Fixed MassStorage demo not clearing the reset flag when a Mass Storage Reset is issued while not processing a command
794 * - Fixed USB_Host_SendControlRequest() not re-suspending the USB bus when initial device ready-wait fails
795 * - Fixed USB Pad regulator not being disabled on some AVR models when the USB_OPT_REG_DISABLED option is used
796 * - Fixed Host mode to Device mode UID change not causing a USB Disconnect event when a device was connected
797 * - Fixed Mouse/Keyboard demos not performing the correct arithmetic on the Idle period at the right times (thanks to Brian Dickman)
798 * - Fixed GenericHID failing HID class tests due to incorrect Logical Minimum and Logical Maximum values (thanks to Soren Greiner)
799 * - Fixed incorrect PIPE_EPNUM_MASK mask causing pipe failures on devices with endpoint addresses of 8 and above (thanks to John Andrews)
800 * - Fixed report data alignment issues in the MouseHostWithParser demo when X and Y movement data size is not a multiple of 8 bits
801 * - Fixed HID Report Descriptor Parser not correctly resetting internal states when a REPORT ID element is encountered
802 * - Fixed incorrect BUTTONS_BUTTON1 for the STK526 target
803 * - Fixed RNDIS demos freezing when more than one connection was attempted simultaneously, causing memory corruption
804 * - Fixed USBtoSerial demo receiving noise from the USART due to pull-up not being enabled
805 *
806 *
807 * \section Sec_ChangeLog090605 Version 090605
808 *
809 * - Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest structure for control request data
810 * - Fixed documentation showing incorrect USB mode support on the supported AVRs list
811 * - Fixed RNDISEthernet not working under Linux due to Linux requiring an "optional" RNDIS request which was unhandled
812 * - Fixed Mouse and Keyboard device demos not acting in accordance with the HID specification for idle periods (thanks to Brian Dickman)
813 * - Removed support for endpoint/pipe non-control interrupts; these did not act in the way users expected, and had many subtle issues
814 * - Fixed Device Mode not handling Set Feature and Clear Feature Chapter 9 requests that are addressed to the device (thanks to Brian Dickman)
815 * - Moved control endpoint interrupt handling into the library itself, enable via the new INTERRUPT_CONTROL_ENDPOINT token
816 * - Fixed CDCHost not clearing configured pipes and resetting configured pipes mask when a partially enumerated invalid CDC
817 * interface is skipped
818 * - Clarified the size of library tokens which accept integer values in the Compile Time Tokens page, values now use the smallest datatype
819 * inside the library that is able to hold their defined value to save space
820 * - Removed DESCRIPTOR_ADDRESS() macro as it was largely superfluous and only served to obfuscate code
821 * - Rewritten event system to remove all macros, to make user code clearer
822 * - Fixed incorrect ENDPOINT_EPNUM_MASK mask preventing endpoints above EP3 from being selected (thanks to Jonathan Oakley)
823 * - Removed STREAM_CALLBACK() macro - callbacks now use regular function definitions to clarify user code
824 * - Removed DESCRIPTOR_COMPARATOR() macro - comparators should now use regular function definitions to clarify user code
825 * - USB_IsConnected is now cleared before the USB_Disconnect() event is fired in response to VBUS being removed
826 * - Fixed incorrect PID value being used in the USBtoSerial project (thanks to Phill)
827 * - Deleted StdDescriptors.c, renamed USB_GetDescriptor() to CALLBACK_USB_GetDescriptor, moved ConfigDescriptor.c/.h from the
828 * LUFA/Drivers/USB/Class/ directory to LUFA/Drivers/USB/HighLevel/ in preparation for the new USB class APIs
829 * - Moved out each demos' functionality library files (e.g. Ring Buffer library) to /Lib directories for a better directory structure
830 * - Removed Tx interrupt from the USBtoSerial demo; now sends characters via polling to ensure more time for the Rx interrupt
831 * - Fixed possible enumeration errors from spin-loops which may fail to exit if the USB connection is severed before the exit condition
832 * becomes true
833 *
834 *
835 * \section Sec_ChangeLog090510 Version 090510
836 *
837 * - Added new GenericHIDHost demo
838 * - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use
839 * - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR
840 * - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile
841 * time options
842 * - All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected
843 * - Added new PIMA_DATA_SIZE() define to the Still Image Host demo
844 * - Add call to MassStore_WaitForDataReceived() in MassStore_GetReturnedStatus() to ensure that the CSW has been received in the
845 * extended MSC timeout period before continuing, to prevent long processing delays from causing the MassStore_GetReturnedStatus()
846 * to early-abort (thanks to Dmitry Maksimov)
847 * - Move StdRequestType.h, StreamCallbacks.h, USBMode.h from the LowLevel USB driver directory to the HighLevel USB driver directory,
848 * where they are more suited
849 * - Removed all binary constants and replaced with decimal or hexadecimal constants so that unpatched GCC compilers can still build the
850 * code without having to be itself patched and recompiled first
851 * - Added preprocessor checks and documentation to the bootloaders giving information about missing SIGNATURE_x defines due to
852 * outdated avr-libc versions.
853 * - Added support to the CDCHost demo for devices with multiple CDC interfaces which are not the correct ACM type preceding the desired
854 * ACM CDC interface
855 * - Fixed GenericHID demo not starting USB and HID management tasks when not using interrupt driven modes (thanks to Carl Kjeldsen)
856 * - Fixed RNDISEthenet demo checking the incorrect message field for packet size constraints (thanks to Jonathan Oakley)
857 * - Fixed WriteNextReport code in the GenericHIDHost demo using incorrect parameter types and not selecting the correct endpoint
858 * - Adjusted sample CTC timer calculations in the AudioOutput and AudioInput demos to match the CTC calculations in the AVR datasheet,
859 * and to fix instances where rounding caused the endpoint to underflow (thanks to Robin Theunis)
860 * - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0), so that other control type
861 * pipes can be used with the function
862 * - The USB Host management task now saves and restores the currently selected pipe before and after the task completes
863 * - Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev)
864 * - Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favor of new Endpoint_ClearIN(), Endpoint_ClearOUT(),
865 * Pipe_ClearIN() and Pipe_ClearOUT() macros (done to allow for the detection of packets of zero length)
866 * - Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API
867 * - Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been
868 * renamed to Endpoint_ClearSETUP(), the Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent() and the
869 * Pipe_ClearSetupSent() macro is no longer applicable and should be removed - changes made to compliment the new endpoint and pipe
870 * bank management API
871 * - Updated all demos, bootloaders and projects to use the new endpoint and pipe management APIs (thanks to Roman Thiel from Curetis AG)
872 * - Updated library doxygen documentation, added groups, changed documentation macro functions to real functions for clarity
873 * - Removed old endpoint and pipe aliased read/write/discard routines which did not have an explicit endian specifier for clarity
874 * - Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway
875 * - Renamed the main Drivers/AT90USBXXX directory to Drivers/Peripheral, renamed the Serial_Stream driver to SerialStream
876 * - Fixed CDC and USBtoSerial demos freezing where buffers were full while still transmitting or receiving (thanks to Peter Hand)
877 * - Removed "Host_" section of the function names in ConfigDescriptor.h, as most of the routines can now be used in device mode on the
878 * device descriptor
879 * - Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name
880 * - Fixed incorrect HID interface class and subclass values in the Mouse and KeyboardMouse demos (thanks to Brian Dickman)
881 * - Capitalized the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and
882 * DSearch_Comp_Return_ErrorCodes_t enums
883 * - Removed "ERROR" from the enum names in the endpoint and pipe stream error code enums
884 * - Renamed the USB_PowerOnErrorCodes_t enum to USB_InitErrorCodes_t, renamed the POWERON_ERROR_NoUSBModeSpecified enum value to
885 * USB_INITERROR_NoUSBModeSpecified
886 * - Renamed USB_PowerOnFail event to USB_InitFailure
887 * - Renamed OTG.h header functions to be more consistent with the rest of the library API
888 * - Changed over all deprecated GCC structure tag initializers to the standardized C99 format (thanks to Mike Alexander)
889 * - USB_HostRequest renamed to USB_ControlRequest, entire control request header is now read into USB_ControlRequest in Device mode
890 * rather than having the library pass only partially read header data to the application
891 * - The USB_UnhandledControlPacket event has had its parameters removed, in favor of accessing the new USB_ControlRequest structure
892 * - The Endpoint control stream functions now correctly send a ZLP to the host when less data than requested is sent
893 * - Fixed USB_RemoteWakeupEnabled flag never being set (the REMOTE WAKEUP Set Feature request was not being handled)
894 * - Renamed the FEATURELESS_CONTROL_ONLY_DEVICE compile-time token to CONTROL_ONLY_DEVICE
895 * - Endpoint configuration is now refined to give better output when all configurations have static inputs - removed the now useless
896 * STATIC_ENDPOINT_CONFIGURATION compile time token
897 * - Fixed SPI driver init function not clearing SPI2X bit when not needed
898 * - Fixed PREVENT ALLOW MEDIUM REMOVAL command issuing in the MassStorageHost demo using incorrect parameters (thanks to Mike Alex)
899 * - Fixed MassStorageHost demo broken due to an incorrect if statement test in MassStore_GetReturnedStatus()
900 * - Fixed reversed signature byte ordering in the CDC bootloader (thanks to Johannes Raschke)
901 * - Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with faulty devices which do not respect the given
902 * wLength value when reading in the device descriptor
903 * - Fixed missing semicolon in the ATAVRUSBRF01 LED board driver code (thanks to Morten Lund)
904 * - 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
905 * with less than four LEDs without code modifications (thanks to Morten Lund)
906 * - Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button
907 * - Serial driver now correctly calculates the baud register value when in double speed mode
908 * - Init function of the Serial driver is now static inline to product smaller code for the common-case of static init values
909 *
910 *
911 * \section Sec_ChangeLog090401 Version 090401
912 *
913 * - Fixed MagStripe project configuration descriptor containing an unused (blank) endpoint descriptor
914 * - Incorporated makefile changes by Denver Gingerich to retain compatibility with stock (non-WinAVR) AVR-GCC installations
915 * - Fixed makefile EEPROM programming targets programming FLASH data in addition to EEPROM data
916 * - LUFA devices now enumerate correctly with LUFA hosts
917 * - Fixed Configuration Descriptor search routine freezing when a comparator returned a failure
918 * - Removed HID report item serial dump in the MouseHostWithParser and KeyboardHostWithParser - useful only for debugging, and
919 * slowed down the enumeration of HID devices too much
920 * - Increased the number of bits per track which can be read in the MagStripe project to 8192 when compiled for the AT90USBXXX6/7
921 * - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request
922 * - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission
923 * next time the device is attached to a host.
924 * - 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
925 * clock prescaling is performed) frequency, so that the PLL prescale mask can be determined
926 * - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with
927 * badly designed hosts or devices which greatly exceed the USB specification limits
928 * - Mass Storage Host demo now uses a USB_STREAM_TIMEOUT_MS of two seconds to maintain compatibility with poorly designed devices
929 * - Function attribute ATTR_ALWAYSINLINE renamed to ATTR_ALWAYS_INLINE to match other function attribute macro naming conventions
930 * - Added ATTR_ALWAYS_INLINE attribute to several key inlined library components, to ensure they are inlined in all circumstances
931 * - Removed SetSystemClockPrescaler() macro, the clock_prescale_set() avr-libc macro has been corrected in recent avr-libc versions
932 * - Fixed incorrect/missing control status stage transfers on demos, bootloaders and applications (thanks to Nate Lawson)
933 * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
934 * to also remove parts of the Get Status chapter 9 request to further reduce code usage
935 * - Makefile updated to include output giving the currently selected BOARD parameter value
936 * - Board Dataflash driver now allows for dataflash ICs which use different shifts for setting the current page/byte address (thanks
937 * to Kenneth Clubb)
938 * - Added DataflashManager_WriteBlocks_RAM() and DataflashManager_ReadBlocks_RAM() functions to the MassStorage demo, to allow for easy
939 * interfacing with a FAT library for dataflash file level access
940 * - Corrected CDC class bootloader to fix a few bugs, changed address counter to store x2 addresses for convenience
941 * - Fixed typos in the SPI driver SPI_SPEED_FCPU_DIV_64 and SPI_SPEED_FCPU_DIV_128 masks (thanks to Markus Zocholl)
942 * - Keyboard and Mouse device demos (normal, data interrupt and fully interrupt driven) combined into unified keyboard and mouse demos
943 * - Keyboard and Mouse host demos (normal and data interrupt driven) combined into unified keyboard and mouse demos
944 * - Removed AVRISP_Programmer project due to code quality concerns
945 * - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incoming data
946 * - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)
947 * - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)
948 * - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)
949 * - Added new GenericHID device demo application
950 * - Fixed Still Image Host SImage_SendData() function not clearing the pipe bank after sending data
951 *
952 *
953 * \section Sec_ChangeLog090209 Version 090209
954 *
955 * - PWM timer mode in AudioOut demo changed to Fast PWM for speed
956 * - Updated Magstripe project to work with the latest hardware revision
957 * - Fixed library not responding to the BCERRI flag correctly in host mode, leading to device lockups
958 * - Fixed library handling Get Descriptor requests when not addressed as standard requests to the device or interface (thanks to
959 * Nate Lawson)
960 * - Fixed serious data corruption issue in MassStorage demo dataflash write routine
961 * - Added new NO_CLEARSET_FEATURE_REQUEST compile time token
962 * - USB task now restores previous global interrupt state after execution, rather than forcing global interrupts to be enabled
963 * - Fixed USB_DeviceEnumerationComplete event firing after each configuration change, rather than once after the initial configuration
964 * - Added ENDPOINT_DOUBLEBANK_SUPPORTED() macros to Endpoint.h, altered ENDPOINT_MAX_SIZE() to allow user to specify endpoint
965 * - ENDPOINT_MAX_ENDPOINTS changed to ENDPOINT_TOTAL_ENDPOINTS, PIPE_MAX_PIPES changed to PIPE_TOTAL_PIPES
966 * - Endpoint and Pipe non-control stream functions now ensure endpoint or pipe is ready before reading or writing
967 * - Changed Teensy bootloader to use a watchdog reset when exiting rather than a software jump
968 * - Fixed integer promotion error in MassStorage and MassStorageHost demos, corrupting read/write transfers
969 * - SPI_SendByte is now SPI_TransferByte, added new SPI_SendByte and SPI_ReceiveByte functions for fast one-way transfer
970 * - MassStorage demo changed to use new fast one-way SPI transfers to increase throughput
971 * - MassStorage handling of Mass Storage Reset class request improved
972 * - Altered MassStorage demo dataflash block read code for speed
973 * - Added USB_IsSuspended global flag
974 * - Simplified internal Dual Mode (OTG) USB library code to reduce code size
975 * - Extended stream timeout period to 100ms from 50ms
976 * - Mass Storage Host demo commands now all return an error code from the Pipe_Stream_RW_ErrorCodes_t enum
977 * - Added SubErrorCode parameter to the USB_DeviceEnumerationFailed event
978 * - VBUS drop interrupt now disabled during the manual-to-auto VBUS delivery handoff
979 * - Simplified low level backend so that device/host mode initialization uses the same code paths
980 * - Added workaround for faulty Mass Storage devices which do not implement the required GET_MAX_LUN request
981 * - Removed buggy Telnet application from the RNDIS demo
982 * - Moved Mass Storage class requests in the Mass Storage Host demo to wrapper functions in MassStoreCommands.c
983 * - Fixed incorrect SCSI command size value in the Request Sense command in MassStoreCommands.c
984 * - Added SetProtocol request to HID class non-parser Mouse and Keyboard demos to force devices to use the correct Boot Protocol
985 * - Added new "dfu" and "flip" programming targets to project makefiles
986 * - HID_PARSE_Sucessful enum member typo corrected to HID_PARSE_Successful
987 * - Changed COLLECTION item structures in the HID descriptor parser to include the collection's Usage Page value
988 * - Serial driver now sets Tx line as output, enables pull-up on Rx line
989 * - Fixed smaller USB AVRs raising multiple connection and disconnection events when NO_LIMITED_CONTROLLER_CONNECT is disabled
990 * - Added HOST_DEVICE_SETTLE_DELAY_MS to give the host delay after a device is connected before it is enumerated
991 * - Fixed KeyboardHostWithParser demo linking against the wrong global variables
992 * - Completed doxygen documentation of remaining library bootloaders, demos and projects
993 * - Fixed incorrect bootloader start address in the TeensyHID bootloader
994 * - Added HWB button whole-disk ASCII dump functionality to MassStoreHost demo
995 * - Replaced printf_P(PSTR("%c"), {Variable}) calls with putchar(<Variable>) for speed and size savings
996 * - Serial driver now accepts baud rates over 16-bits in size, added double speed flag option
997 * - Fixed incorrect callback abort return value in Pipe.c
998 * - Added new flip-ee and dfu-ee makefile targets (courtesy of Opendous Inc.)
999 * - Removed reboot-on-disconnect code from the TeensyHID bootloader, caused problems on some systems
1000 * - Fixed AudioOutput and AudioInput demos looping on the endpoint data, rather than processing a sample at a time and returning
1001 * each time the task runs to allow for other tasks to execute
1002 * - Added support for the Atmel ATAVRUSBRF01 board
1003 * - Added AVRISP Programmer Project, courtesy of Opendous Inc.
1004 * - Fixed CDC Host demo not searching through both CDC interfaces for endpoints
1005 * - Fixed incorrect Product String descriptor length in the DFU class bootloader
1006 *
1007 *
1008 * \section Sec_ChangeLog081224 Version 081224
1009 *
1010 * - MyUSB name changed to LUFA, the Lightweight USB Framework for AVRs
1011 * - Fixed Mass Storage Host demo's MassStore_SendCommand() delay in the incorrect place
1012 * - Fixed USBtoSerial demo not calling ReconfigureUSART() after a change in the line encoding
1013 * - Fixed infinite loop in host mode Host-to-Device control transfers with data stages
1014 * - HID report parser now supports devices with multiple reports in one interface via Report IDs
1015 * - Fixed RZUSBSTICK board LED driver header incorrect macro definition order causing compile errors
1016 * - Calling USB_Init() when the USB interface is already configured now forces a complete interface reset
1017 * and re-enumeration - fixes MyUSB DFU bootloader not switching to app code correctly when soft reset used
1018 * - Fixed "No newline at end of file" warning when stream callbacks are enabled
1019 * - DFU bootloader now uses fixed signature bytes per device, rather than reading them out dynamically for size
1020 * - Added new FIXED_CONTROL_ENDPOINT_SIZE and USE_SINGLE_DEVICE_CONFIGURATION switches to statically define certain values to
1021 * reduce compiled binary size
1022 * - Added new NO_LIMITED_CONTROLLER_CONNECT switch to prevent the library from trying to determine bus connection
1023 * state from the suspension and wake up events on the smaller USB AVRs
1024 * - Added summary of all library compile time tokens to the documentation
1025 * - Added overview of the LUFA scheduler to the documentation
1026 * - Removed MANUAL_PLL_CONTROL compile time token, replaced with a mask for the USB_Init() Options parameter
1027 * - CDC bootloader now uses the correct non-far or far versions of the pgm_* functions depending on if RAMPZ is defined
1028 * - Doxygen documentation now contains documentation on all the projects, bootloaders and most demos included with the library
1029 * - CDC bootloader now runs user application when USB disconnected rather than waiting for a hard reset
1030 * - MouseHostWithParser and KeyboardHostWithParser now support multiple-report devices
1031 * - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver
1032 * - Fixed the DFU bootloader, no longer freezes up when certain files are programmed into an AVR, made reading/writing faster
1033 * - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal
1034 * right-handed system
1035 * - Added stub code to the CDC and USBtoSerial demos showing how to read and set the RS-232 handshake lines - not currently used in
1036 * the demos, but the example code and supporting defines are now in place
1037 * - Interrupts are now disabled when processing a control request in device mode, to avoid exceeding the strict control request
1038 * timing requirements.
1039 * - All demos now use a central StatusUpdate() function rather than direct calls to the board LED functions, so that the demos can
1040 * easily be altered to show different LED combinations (or do something else entirely) as the demo's status changes
1041 * - Removed LED commands from the CDC bootloader, unused by most AVR910 programming software
1042 * - Fixed RNDIS demo ICMP ping requests echoing back incorrect data
1043 * - Added DHCP server code to RNDIS demo, allowing for hands-free auto configuration on any PC
1044 * - Fixed DFU bootloader PID value for the ATMEGA16U4 AVR
1045 * - Endpoint and Pipe configuration functions now return an error code indicating success or failure
1046 * - USB Reset in device mode now resets and disables all device endpoints
1047 * - Added intermediate states to the host mode state machine, reducing the USB task blocking time to no more than 1ms explicitly per
1048 * invocation when in host mode
1049 * - Added support for the ATMEGA32U6 microcontroller
1050 * - Added STATIC_ENDPOINT_CONFIGURATION compile time option, enabled in the bootloaders to minimize space usage
1051 * - Removed redundant code from the USB device GetStatus() chapter 9 processing routine
1052 * - Added new TeensyHID bootloader, compatible with the Teensy HID protocol (http://www.pjrc.com/teensy/)
1053 * - Versions are now numbered by release dates, rather than arbitrary major/minor revision numbers
1054 * - USB_RemoteWakeupEnabled is now correctly set and cleared by SetFeature and ClearFeature requests from the host
1055 * - Changed prototype of GetDescriptor, so that it now returns the descriptor size (or zero if the descriptor doesn't exist)
1056 * rather than passing the size back to the caller through a parameter and returning a boolean
1057 *
1058 *
1059 * \section Sec_ChangeLog153 Version 1.5.3 - Released 2nd October, 2008
1060 *
1061 * - Fixed CDC bootloader using pgmspace macros for some descriptors inappropriately
1062 * - Updated all Mouse and Keyboard device demos to include boot protocol support (now works in BIOS)
1063 * - Renamed bootloader directories to remove spaces, which were causing build problems on several OSes
1064 * - Removed serial number strings from all but the MassStore demo where it is required - users were not
1065 * modifying the code to either omit the descriptor or use a unique serial per device causing problems
1066 * when multiple units of the same device were plugged in at the same time
1067 * - AudioOutput and AudioInput demos now correctly silence endpoints when not enabled by the host
1068 * - Added KeyboardMouse demo (Keyboard and Mouse functionality combined into a single demo)
1069 * - Added DriverStubs directory to house board level driver templates, to make MyUSB compatible custom board
1070 * driver creation easier
1071 * - Extended MassStorage demo to support multiple LUNs, 2 by default
1072 * - Fixed incorrect device address mask, preventing the device from enumerating with addresses larger than 63
1073 * - Fixed incorrect data direction mask in the GetStatus standard request, preventing it from being handled
1074 * - Fixed incorrect GetStatus standard request for endpoints, now returns the endpoint STALL status correctly
1075 * - Added in new USB_RemoteWakeupEnabled and USB_CurrentlySelfPowered flags rather than using fixed values
1076 * - Added DualCDC demo to demonstrate the use of Interface Association Descriptors
1077 * - Added pipe NAK detection and clearing API
1078 * - Added pipe status change (NAK, STALL, etc.) interrupt API
1079 * - Fixed MassStorageHost demo so that it no longer freezes randomly when issuing several commands in a row
1080 * - Host demos configuration descriptor routines now return a unique error code when the returned data does
1081 * not have a valid configuration descriptor header
1082 * - Added Endpoint_WaitUntilReady() and Pipe_WaitUntilReady() functions
1083 * - Stream functions now have software timeouts, timeout period can be set by the USB_STREAM_TIMEOUT_MS token
1084 * - All demos now pass the USB.org automated Chapter 9 device compliance tests
1085 * - All HID demos now pass the USB.org automated HID compliance tests
1086 * - Polling interval of the interrupt endpoint in the CDC based demos changed to 0xFF to fix problems on Linux systems
1087 * - Changed stream functions to accept a new callback function, with NO_STREAM_CALLBACKS used to disable all callbacks
1088 * - Mass Storage demo dataflash management routines changed to use the endpoint stream functions
1089 * - Added AVRStudio project files for each demo in addition to the existing Programmer's Notepad master project file
1090 * - Re-added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
1091 * are reflected in the hardware (change was previously lost)
1092 *
1093 *
1094 * \section Sec_ChangeLog152 Version 1.5.2 - Released 31st July, 2008
1095 *
1096 * - Fixed SwapEndian_32() function in Common.h so that it now works correctly (wrong parameter types)
1097 * - Updated RNDIS demo - notification endpoint is no longer blocking so that it works with faulty Linux RNDIS
1098 * implementations (where the notification endpoint is ignored in favor of polling the control endpoint)
1099 * - Fixed incorrect Vendor Description string return size in RNDIS demo for the OID_GEN_VENDOR_DESCRIPTION OID token
1100 * - Added very basic TCP/IP stack and HTTP/TELNET servers to RNDIS demo
1101 * - Fixed DFU bootloader exit causing programming software to complain about failed writes
1102 * - Fixed DFU bootloader EEPROM programming mode wiping first flash page
1103 * - Fixed Clear/Set Feature device standard request processing code (fixing MassStorage demo in the process)
1104 * - Added support for the ATMEGA16U4 AVR microcontroller
1105 * - Library license changed from LGPLv3 to MIT license
1106 *
1107 *
1108 * \section Sec_ChangeLog151 Version 1.5.1 - Released 7th July, 2008
1109 *
1110 * - Changed host demos to enable the host function task on the firing of the USB_DeviceEnumerationComplete event
1111 * rather than the USB_DeviceAttached event
1112 * - HID Usage Stack now forcefully cleared after an IN/OUT/FEATURE item has been completely processed to remove
1113 * any referenced but not created usages
1114 * - Changed USB_INT_DisableAllInterrupts() and USB_INT_ClearAllInterrupts(), USB_Host_GetNextDescriptorOfType(),
1115 * USB_Host_GetNextDescriptorOfTypeBefore(), USB_Host_GetNextDescriptorOfTypeAfter() to normal functions (from inline)
1116 * - Fixed USBtoSerial demo not sending data, only receiving
1117 * - Fixed main makefile to make all by default, fixed MagStripe directory case to prevent case-sensitive path problems
1118 * - ConfigDescriptor functions made normal, instead of static inline
1119 * - Pipe/Endpoint *_Ignore_* functions changed to *_Discard_*, old names still present as aliases
1120 * - Fixed ENDPOINT_MAX_SIZE define to be correct on limited USB controller AVRs
1121 * - Changed endpoint and pipe size translation routines to use previous IF/ELSE IF cascade code, new algorithmic
1122 * approach was buggy and caused problems
1123 * - Bootloaders now compile with -fno-inline-small-functions option to reduce code size
1124 * - Audio demos now use correct endpoint sizes for full and limited controller USB AVRs, double banking in all cases
1125 * to be in line with the specification (isochronous endpoints MUST be double banked)
1126 * - Added Interface Association descriptor to StdDescriptors.h, based on the relevant USB2.0 ECN
1127 * - Fixed MIDI demo, corrected Audio Streaming descriptor to follow the MIDI-specific AS structure
1128 * - Fixed HID class demo descriptors so that the HID interface's protocol is 0x00 (required for non-boot protocol HID
1129 * devices) to prevent problems on hosts expecting the boot protocol functions to be supported
1130 * - Added read/write control stream functions to Endpoint.h
1131 * - Fixed AudioOut demo not setting port pins to inputs on USB disconnect properly
1132 * - Added RNDISEthernet demo application
1133 *
1134 *
1135 * \section Sec_ChangeLog150 Version 1.5.0 - Released 10 June, 2008
1136 *
1137 * - Fixed MIDI demo, now correctly waits for the endpoint to be ready between multiple note messages
1138 * - Added CDC Host demo application
1139 * - Added KeyboardFullInt demo application
1140 * - Endpoint and Pipe creation routines now mask endpoint/pipe size with the size mask, to remove transaction
1141 * size bits not required for the routines (improves compatibility with devices)
1142 * - Fixed AudioInput demo - now correctly sends sampled audio to the host PC
1143 * - Fixed AudioOutput demo once more -- apparently Windows requires endpoint packets to be >=192 bytes
1144 * - Shrunk round-robbin scheduler code slightly via the use of struct pointers rather than array indexes
1145 * - Fixed off-by-one error when determining if the Usage Stack is full inside the HID Report parser
1146 * - Renamed Magstripe.h to MagstripeHW.h and moved driver out of the library and into the MagStripe demo folder
1147 * - Added preprocessor checks to enable C linkage on the library components when used with a C++ compiler
1148 * - Added Still Image Host demo application
1149 * - The USB device task now restores the previously selected endpoint, allowing control requests to be transparently
1150 * handled via interrupts while other endpoints are serviced through polling
1151 * - Fixed device signature being sent in reverse order in the CDC bootloader
1152 * - Host demos now have a separate ConfigDescriptor.c/.h file for configuration descriptor processing
1153 * - HostWithParser demos now have a separate HIDReport.c/.h file for HID report processing and dumping
1154 * - Removed non-mandatory commands from MassStorage demo to save space, fixed SENSE ResponseCode value
1155 * - CDC demos now send empty packets after sending a full one to prevent buffering issues on the host
1156 * - Updated demo descriptors to use VID/PID values donated by Atmel
1157 * - Added DoxyGen documentation to the source files
1158 * - Fixed Serial_IsCharReceived() definition, was previously reversed
1159 * - Removed separate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead
1160 * - Removed unused Device Qualifier descriptor structure
1161 * - Renamed the USB_CreateEndpoints event to the more appropriate USB_ConfigurationChanged
1162 * - Fixed MassStorageHost demo reading in the block data in reverse
1163 * - Removed outdated typedefs in StdRequestType.h, superseded by the macro masks
1164 * - Corrected OTG.h is now included when the AVR supports both Host and Device modes, for creating OTG products
1165 * - USB_DeviceEnumerationComplete event is now also fired when in device mode and the host has finished its enumeration
1166 * - Interrupt driven demos now properly restore previously selected endpoint when ISR is complete
1167 * - The value of USB_HOST_TIMEOUT_MS can now be overridden in the user project makefile to a custom fixed timeout value
1168 * - Renamed USB_Host_SOFGeneration_* macros to more friendly USB_Host_SuspendBus(), USB_Host_ResumeBus()
1169 * and USB_Host_IsBusSuspended()
1170 * - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistent, Pipe_SetInterruptFreq() is now
1171 * Pipe_SetInterruptPeriod() to use the correct terminology
1172 * - UnicodeString member of USB_Descriptor_String_t struct changed to an ordinary int array type, so that the GCC
1173 * Unicode strings (prefixed with an L before the opening quotation mark) can be used instead of explicit arrays
1174 * of ASCII characters
1175 * - Fixed Endpoint/Pipes being configured incorrectly if the maximum endpoint/pipe size for the selected USB AVR
1176 * model was given as the bank size
1177 * - HID device demos now use a true raw array for the HID report descriptor rather than a struct wrapped array
1178 * - Added VERSION_BCD() macro, fixed reported HID and USB version numbers in demo descriptors
1179 * - Cleaned up GetDescriptor device chapter 9 handler function
1180 * - Added GET_REPORT class specific request to HID demos to make them complaint to the HID class
1181 * - Cleaned up setting of USB_IsInitialized and USB_IsConnected values to only when needed
1182 * - Removed Atomic.c and ISRMacro.h; the library was already only compatible with recent avr-lib-c for other reasons
1183 * - All demos and library functions now use USB standardized names for the USB data (bRequest, wLength, etc.)
1184 * - Added USE_NONSTANDARD_DESCRIPTOR_NAMES token to switch back to the non-standard descriptor element names
1185 *
1186 *
1187 * \section Sec_ChangeLog141 Version 1.4.1 - Released 19 May, 2008
1188 *
1189 * - Enhanced KeyboardWithParser demo, now prints out pressed alphanumeric characters like the standard demo
1190 * - Fixed MassStorage demo, read/writes using non mode-10 commands now work correctly
1191 * - Corrected version number in Version.h
1192 *
1193 *
1194 * \section Sec_ChangeLog140 Version 1.4.0 - Released 5 May, 2008
1195 *
1196 * - Added HID Report Parser API to the library
1197 * - Added Mouse and Keyboard host demo applications, using the new HID report parser engine
1198 * - Added MouseFullInt demo, which demonstrates a fully interrupt (including control requests) mouse device
1199 * - Fixed incorrect length value in the audio control descriptor of the AudioOutput and AudioInput demos
1200 * - Added MIDI device demo application to the library
1201 * - Fixed problem preventing USB devices from being resumed from a suspended state
1202 * - Added new CDC class bootloader to the library, based on the AVR109 bootloader protocol
1203 * - Added header to each demo application indicating the mode, class, subclass, standards used and supported speed
1204 * - Functions expecting endpoint/pipe numbers are no longer automatically masked against ENDPOINT_EPNUM_MASK or
1205 * PIPE_PIPENUM_MASK - this should be manually added to code which requires it
1206 * - Fixed DFU class bootloader - corrected frequency of flash page writes, greatly reducing programming time
1207 * - Renamed AVR_HOST_GetDeviceConfigDescriptor() to USB_Host_GetDeviceConfigDescriptor() and AVR_HOST_GetNextDescriptor()
1208 * to USB_Host_GetNextDescriptor()
1209 * - Added new USB_Host_GetNextDescriptorOfTypeBefore() and USB_Host_GetNextDescriptorOfTypeAfter() routines
1210 * - Moved configuration descriptor routines to MyUSB/Drivers/USB/Class/, new accompanying ConfigDescriptors.c file
1211 * - Added new configuration descriptor comparator API for more powerful descriptor parsing, updated host demos to use the
1212 * new comparator API
1213 * - Fixed MassStorageHost demo capacity printout, and changed data read/write mode from little-endian to the correct
1214 * big-endian for SCSI devices
1215 * - Fixed macro/function naming consistency; USB_HOST is now USB_Host, USB_DEV is now USB_Device
1216 * - Added better error reporting to host demos
1217 * - Added 10 microsecond delay after addressing devices in host mode, to prevent control stalls
1218 *
1219 *
1220 * \section Sec_ChangeLog132 Version 1.3.2 - Released April 1st, 2008
1221 *
1222 * - Added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
1223 * are reflected in the hardware
1224 * - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the
1225 * GetLineCoding request had an incorrect RequestType mask preventing it from being processed
1226 * - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full
1227 * - Device control endpoint size is now determined from the device's descriptors rather than being fixed
1228 * - Separated out SPI code into new SPI driver in AT90USBXXX driver directory
1229 * - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID
1230 * - Added support for the RZUSBSTICK board
1231 * - Bicolour driver removed in favor of generic LEDs driver
1232 * - Added support for the ATMEGA32U4 AVR
1233 * - Added MANUAL_PLL_CONTROL compile time option to prevent the USB library from manipulating the PLL
1234 *
1235 *
1236 * \section Sec_ChangeLog131 Version 1.3.1 - Released March 19th 2008
1237 *
1238 * - Fixed USB to Serial demo - class value in the descriptors was incorrect
1239 * - Control endpoint size changed from 64 bytes to 8 bytes to save on USB FIFO RAM and to allow low
1240 * speed mode devices to enumerate properly
1241 * - USB to Serial demo data endpoints changed to dual-banked 16 byte to allow the demo to work
1242 * on USB AVRs with limited USB FIFO RAM
1243 * - Changed demo endpoint numbers to use endpoints 3 and 4 for double banking, to allow limited
1244 * USB device controller AVRs (AT90USB162, AT90USB82) to function correctly
1245 * - Updated Audio Out demo to use timer 1 for AVRs lacking a timer 3 for the PWM output
1246 * - Fixed incorrect USB_DEV_OPT_HIGHSPEED entry in the Mass Storage device demo makefile
1247 * - Optimized Mass Storage demo for a little extra transfer speed
1248 * - Added LED indicators to the Keyboard demo for Caps Lock, Num Lock and Scroll Lock
1249 * - Added Endpoint_Read_Stream, Endpoint_Write_Stream, Pipe_Read_Stream and Pipe_Write_Stream functions
1250 * (including Big and Little Endian variants)
1251 * - Made Dataflash functions inline for speed, removed now empty Dataflash.c driver file
1252 * - Added new SetSystemClockPrescaler() macro (thanks to Joerg Wunsch)
1253 * - Fixed Endpoint_ClearStall() to function correctly on full USB controller AVRs (AT90USBXXX6/7)
1254 * - Endpoint_Setup_In_Clear() and Endpoint_Setup_Out_Clear() no longer set FIFOCON, in line with the
1255 * directives in the datasheet
1256 * - Fixed PLL prescaler defines for all AVR models and frequencies
1257 * - Fixed ENDPOINT_INT_IN and ENDPOINT_INT_OUT definitions
1258 * - Added interrupt driven keyboard and mouse device demos
1259 * - Combined USB_Device_ClearFeature and USB_Device_SetFeature requests into a single routine for code
1260 * size savings
1261 * - Added missing Pipe_GetCurrentPipe() macro to Pipe.h
1262 *
1263 *
1264 * \section Sec_ChangeLog130 Version 1.3.0 - Released March 7th 2008
1265 *
1266 * - Unnecessary control endpoint config removed from device mode
1267 * - Fixed device standard request interpreter accidentally processing some class-specific requests
1268 * - Added USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS compile time options to instruct the library
1269 * to use descriptors stored in RAM or EEPROM rather than flash memory
1270 * - All demos now disable watchdog on startup, in case it has been enabled by fuses or the bootloader
1271 * - USB_DEV_OPT_LOWSPEED option now works correctly
1272 * - Added ability to set the USB options statically for a binary size reduction via the USE_STATIC_OPTIONS
1273 * compile time define
1274 * - USB_Init no longer takes a Mode parameter if compiled for a USB device with no host mode option, or
1275 * if forced to a particular mode via the USB_HOST_ONLY or USB_DEVICE_ONLY compile time options
1276 * - USB_Init no longer takes an Options parameter if options statically configured by USE_STATIC_OPTIONS
1277 * - Endpoint_Ignore_* and Pipe_Ignore_* made smaller by making the dummy variable non-volatile so that the
1278 * compiler can throw away the result more efficiently
1279 * - Added in an optional GroupID value to each scheduler entry, so that groups of tasks can once again be
1280 * controlled by the new Scheduler_SetGroupTaskMode() routine
1281 * - Added support for AT90USB162 and AT90USB82 AVR models
1282 * - Added support for the STK525 and STK526 boards
1283 * - Added support for custom board drivers to be supplied by selecting the board type as BOARD_USER, and
1284 * placing board drivers in {Application Directory}/Board/
1285 * - PLL is now stopped and USB clock is frozen when detached from host in device mode, to save power
1286 * - Joystick defines are now in synch with the schematics - orientation will be rotated for the USBKEY
1287 * - Fixed USB_DEV_IsUSBSuspended() - now checks the correct register
1288 * - Fixed data transfers to devices when in host mode
1289 * - Renamed USB_DEV_OPT_HIGHSPEED to USB_DEV_OPT_FULLSPEED and USB_HOST_IsDeviceHighSpeed() to
1290 * USB_HOST_IsDeviceFullSpeed() to be in line with the official USB speed names (to avoid confusion with
1291 * the real high speed mode, which is unavailable on the USB AVRs)
1292 *
1293 *
1294 * \section Sec_ChangeLog120 Version 1.2.0 - Released February 4th, 2008
1295 *
1296 * - Added USB_DeviceEnumerationComplete event for host mode
1297 * - Added new Scheduler_Init routine to prepare the scheduler, so that tasks can be started and
1298 * stopped before the scheduler has been started (via Scheduler_Start)
1299 * - Connection events in both Device and Host mode are now interrupt-driven, allowing the USB management
1300 * task to be stopped when the USB is not connected to a host or device
1301 * - All demos updated to stop the USB task when not in use via the appropriate USB events
1302 * - Mass Storage Host demo application updated to function correctly with all USB flash disks
1303 * - Mass Storage Host demo application now prints out the capacity and number of LUNs in the attached
1304 * device, and prints the first block as hexadecimal numbers rather than ASCII characters
1305 * - Endpoint and Pipe clearing routines now clear the Endpoint/Pipe interrupt and status flags
1306 * - Shifted error handling code in the host enum state machine to a single block, to reduce code complexity
1307 * - Added in DESCRIPTOR_TYPE, DESCRIPTOR_SIZE and DESCRIPTOR_CAST macros to make config descriptor processing
1308 * clearer in USB hosts and DESCRIPTOR_ADDRESS for convenience in USB devices
1309 * - Added in alloca macro to common.h, in case the user is using an old version of avr-lib-c missing the macro
1310 *
1311 *
1312 * \section Sec_ChangeLog130 Version 1.1.0 - Released January 25th 2008
1313 *
1314 * - Fixed DCONNI interrupt being enabled accidentally after a USB reset
1315 * - Fixed DDISCI interrupt not being disabled when a device is not connected
1316 * - Added workaround for powerless pull-up devices causing false disconnect interrupts
1317 * - Added USB_DeviceEnumerationFailed event for Host mode
1318 * - AVR_HOST_GetDeviceConfigDescriptor routine no longer modifies ConfigSizePtr if a valid buffer
1319 * pointer is passed
1320 * - Added ALLOCABLE_BYTES to DynAlloc, and added code to make the size of key storage variables
1321 * dependant on size of memory parameters passed in via the user project's makefile
1322 * - Fixed incorrect device reset routine being called in USBTask
1323 * - Devices which do not connect within the standard 300mS are now supported
1324 * - Removed incorrect ATTR_PURE from Scheduler_SetTaskMode(), which was preventing tasks from being
1325 * started/stopped, as well as USB_InitTaskPointer(), which was breaking dual device/host USB projects
1326 * - Changed scheduler to use the task name rather than IDs for setting the task mode, eliminating the
1327 * need to have a task ID list
1328 * - ID transition interrupt now raises the appropriate device/host disconnect event if device attached
1329 * - Fixed double VBUS change (and VBUS -) event when detaching in device mode
1330 * - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile
1331 * - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and
1332 * Endpoint_IsConfigured() after calling the config functions to determine success
1333 */
1334