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