Statistics
| Branch: | Tag: | Revision:

root / LUFA / ManPages / ChangeLog.txt @ 978b99e5

History | View | Annotate | Download (113 KB)

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