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
15 * - AVRISP programmer project now has a more robust timeout system, allowing for an increse of the software USART speed
16 * for PDI and TPI programming
17 * - Added a timeout value to the TWI_StartTransmission() function, within which the addressed device must respond
18 * - Webserver project now uses the board LEDs to indicate the current IP configuration state
19 * - Added ENABLE_TELNET_SERVER compile time option to the Webserver project to disable the TELNET server if desired
20 * - Increased throughput of the USBtoSerial demo on systems that send multiple bytes per packet (thanks to Opendous Inc.)
23 * - Fixed software PDI/TPI programming mode in the AVRISP project not correctly toggling just the clock pin
24 * - Fixed TWI_StartTransmission() corrupting the contents of the GPIOR0 register
25 * - Fixed TWI driver not aborting when faced with no response after attempting to address a device on the bus
26 * - Fixed ADC routines not correctly returning the last result when multiple channels were read
27 * - Fixed ADC routines failing to read the extended channels (Channels 8 to 13, Internal Temperature Sensor) on the
28 * U4 series USB AVR parts
30 * \section Sec_ChangeLog100219 Version 100219
33 * - Added TPI programming support for 6-pin ATTINY devices to the AVRISP programmer project (thanks to Tom Light)
34 * - Added command timeout counter to the AVRISP project so that the device no longer freezes when incorrectly connected
36 * - Added new TemperatureDataLogger application, a USB data logger which writes to the device's dataflash and appears to
37 * the host as a standard Mass Storage device when inserted
38 * - Added MIDI event packing support to the MIDI Device and Host mode Class drivers, allowing for multiple MIDI events to
39 * sent or received in packed form in a single USB packet
40 * - Added new MIDI send buffer flush routines to the MIDI Device and Host mode Class drivers, to flush packed events
41 * - Added master mode hardware TWI driver for easy TWI peripheral control
42 * - Added ADC MUX masks for the standard ADC input channels on all AVR models with an ADC, altered demos to use these masks
43 * as on some models, the channel number is not identical to its single-ended ADC MUX mask
44 * - New Webserver project, a RNDIS host USB webserver using the open source uIP TCP/IP network stack and FatFS library
45 * - New BOARD value option BOARD_NONE (equivelent to not specifying BOARD) which will remove all board hardware drivers which
46 * do not adversely affect the code operation (currently only the LEDs driver)
47 * - Added keyboard modifier masks (HID_KEYBOARD_MODIFER_*) and LED report masks (KEYBOARD_LED_*) to the HID class driver and
49 * - Added .5MHz recovery clock to the AVRISP programmer project when in ISP programming mode to correct mis-set fuses
52 * - Slowed down software USART carried PDI programming in the AVRISP project to prevent transmission errors
53 * - Renamed the AVRISP project folder to AVRISP-MKII to reduce confusion
54 * - Renamed the RESET_LINE_* makefile tokens in the AVRISP MKII Project to AUX_LINE_*, as they are not always used for target
56 * - Changed over the MassStorageKeyboard Class driver device demo to use Start of Frame events rather than a timer to keep track
57 * of elapsed milliseconds
58 * - Inlined currently unused (but standardized) maintenance functions in the Device and Host Class drivers to save space
59 * - The XPLAINBridge project now selects between a USB to Serial bridge and a PDI programmer on startup, reading the JTAG port's
60 * TDI pin to determine which mode to use
61 * - Removed the stream example code from the Low Level VirtualSerial demos, as they were buggy and only served to add clutter
64 * - Fixed AVRISP project not able to enter programming mode when ISP protocol is used
65 * - Fixed AVRISP PDI race condition where the guard time between direction changes could be interpreted as a start bit
66 * - Fixed ADC_IsReadingComplete() returning an inverted result
67 * - Fixed blocking CDC streams not aborting when the host is disconnected
68 * - Fixed XPLAIN board Dataflash driver broken due to incorrect preprocessor commands
69 * - Fixed inverted XPLAIN LED driver output (LED turned on when it was supposed to be turned off, and vice-versa)
70 * - Fixed Class Driver struct interface numbers in the KeyboardMouse and VirtualSerialMouse demos (thanks to Renaud Cerrato)
71 * - Fixed invalid USB controller PLL prescaler values for the ATMEGAxxU2 controllers
72 * - Fixed lack of support for the ATMEGA32U2 in the DFU and CDC class bootloaders
73 * - Fixed Benito project not resetting the target AVR automatically when programming has completed
74 * - Fixed DFU bootloader programming not discarding the correct number of filler bytes from the host when non-aligned programming
75 * ranges are specified (thanks to Thomas Bleeker)
76 * - Fixed CDC and RNDIS host demos and class drivers - bidirectional endpoints should use two seperate pipes, not one half-duplex pipe
77 * - Fixed Pipe_IsEndpointBound() not taking the endpoint's direction into account
78 * - Fixed EEPROM and FLASH ISP programming in the AVRISP project
79 * - Fixed incorrect values of USB_CONFIG_ATTR_SELFPOWERED and USB_CONFIG_ATTR_REMOTEWAKEUP tokens (thanks to Claus Christensen)
80 * - Fixed SerialStream driver blocking while waiting for characters to be received instead of returning EOF
81 * - Fixed SerialStream driver not setting stdin to the created serial stream (thanks to Mike Alexander)
82 * - Fixed USB_GetHIDReportSize() returning the number of bits in the specified report instead of bytes
83 * - Fixed AVRISP project not extending the command delay after each successful page/word/byte program
84 * - Fixed accuracy of the SERIAL_UBBRVAL() and SERIAL_2X_UBBRVAL() macros for higher baudrates (thanks to Renaud Cerrato)
86 * \section Sec_ChangeLog091223 Version 091223
89 * - Added activity LED indicators to the AVRISP project to indicate when the device is busy processing a command
90 * - The USB target family and allowable USB mode tokens are now public and documented (USB_CAN_BE_*, USB_SERIES_*_AVR)
91 * - Added new XPLAIN USB to Serial Bridge project (thanks to John Steggall for initial proof-of-concept, David Prentice
92 * and Peter Danneger for revised software USART code)
93 * - Added new RNDIS Ethernet Host LowLevel demo
94 * - Added new RNDIS Ethernet Host Class Driver
95 * - Added new RNDIS Ethernet Host ClassDriver demo
96 * - Added CDC_Host_Flush() function to the CDC Host Class driver to flush sent data to the attached device
97 * - Added PDI programming support for XMEGA devices to the AVRISP programmer project (thanks to Justin Mattair)
98 * - Added support for the XPLAIN board Dataflash, with new XPLAIN_REV1 board target for the different dataflash used
99 * on the first revision boards compared to the one mounted on later revisions
100 * - Added new HID_ALIGN_DATA() macro to return the pre-retrieved value of a HID report item, left-aligned to a given datatype
101 * - Added new PreviousValue to the HID Report Parser report item structure, for easy monitoring of previous report item values
102 * - Added new EVK527 board target
103 * - Added new USB_Host_GetDeviceStringDescriptor() convenience function
104 * - Added new LEDNotification project to the library, to give a visual LED notification on new events from the host
105 * - Added new NO_DEVICE_REMOTE_WAKEUP and NO_DEVICE_SELF_POWER compile time options
108 * - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of keycodes
109 * as this relied on non-standard OS driver behaviour to repeat key groups
110 * - The SCSI_Request_Sense_Response_t and SCSI_Inquiry_Response_t type defines are now part of the Mass Storage Class
111 * driver common defines, rather than being defined in the Host mode Class driver section only
112 * - The USB_MODE_HOST token is now defined even when host mode is not available
113 * - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to
114 * indicate the report type to generate
115 * - All Class Drivers now return false or the "DeviceDisconnected" error code of their respective error enums when a function
116 * is called when no host/device is connected where possible
117 * - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to HOST_SENDCONTROL_DeviceDisconnected to be in line
118 * with the rest of the library errorcodes
119 * - Make MIDI device demos also turn off the on board LEDs if MIDI Note On messages are sent with a velocity of zero,
120 * which some devices use instead of Note Off messages (thanks to Robin Green)
121 * - The CDC demos are now named "VirtualSerial" instead to indicate the demos' function rather than its implemented USB class,
122 * to reduce confusion and to be in line with the rest of the LUFA demos
123 * - The SImage_Host_SendBlockHeader() and SImage_Host_ReceiveBlockHeader() Still Image Host Class driver functions are now public
126 * - Added missing CDC_Host_CreateBlockingStream() function code to the CDC Host Class driver
127 * - Fixed incorrect values for REPORT_ITEM_TYPE_* enum values causing corrupt data in the HID Host Parser
128 * - Fixed misnamed SI_Host_USBTask() and SI_Host_ConfigurePipes() functions
129 * - Fixed broken USB_GetNextDescriptor() function causing the descriptor to jump ahead double the expected amount
130 * - Fixed Pipe_IsEndpointBound() not masking the given Endpoint Address against PIPE_EPNUM_MASK
131 * - Fixed host state machine not enabling Auto VBUS mode when HOST_DEVICE_SETTLE_DELAY_MS is set to zero
132 * - Fixed misnamed Pipe_SetPipeToken() macro for setting a pipe's direction
133 * - Fixed CDCHost failing on devices with bidirectional endpoints
134 * - Fixed USB driver failing to define the PLL prescaler mask for the ATMEGA8U2 and ATMEGA16U2
135 * - Fixed HID Parser not distributing the Usage Min and Usage Max values across an array of report items
136 * - Fixed Mass Storage Host Class driver and Low Level demo not clearing the error condition if an attached device returns a
137 * STALL to a GET MAX LUN request (thanks to Martin Luxen)
138 * - Fixed TeensyHID bootloader not properly shutting down the USB interface to trigger a disconnection on the host before resetting
139 * - Fixed MassStorageHost Class driver demo not having USB_STREAM_TIMEOUT_MS compile time option set properly to prevent slow
140 * devices from timing out the data pipes
141 * - Fixed the definition of the Endpoint_BytesInEndpoint() macro for the U4 series AVR parts
142 * - Fixed MIDI host Class driver MIDI_Host_SendEventPacket() routine not properly checking for Pipe ready before writing
143 * - Fixed use of deprecated struct initializers, removed library unused parameter warnings when compiled with -Wextra enabled
144 * - Fixed Still Image Host Class driver truncating the PIMA response code (thanks to Daniel Seibert)
145 * - 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
146 * used (thanks to Daniel Levy)
147 * - Fixed TeensyHID bootloader not enumerating to the host correctly (thanks to Clint Fisher)
148 * - Fixed AVRISP project timeouts not checking for the correct timeout period (thanks to Carl Ott)
149 * - Fixed STK525 Dataflash driver using incorrect bit-shifting for Dataflash addresses (thanks to Tim Mitchell)
151 * \section Sec_ChangeLog091122 Version 091122
154 * - Added new Dual Role Keyboard/Mouse demo
155 * - Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the HID Host Class driver when
156 * Report protocol is not needed
157 * - Added new MIDI LowLevel and ClassDriver Host demo, add new MIDI Host Class driver
158 * - Added new CDC/Mouse ClassDriver device demo
159 * - Added new Joystick Host ClassDriver and LowLevel demos
160 * - Added new Printer Host mode Class driver
161 * - Added new Printer Host mode ClassDriver demo
162 * - Added optional support for double banked endpoints and pipes in the Device and Host mode Class drivers
163 * - Added new stream creation function to the CDC Class drivers, to easily make standard I/O streams from CDC Class driver instances
166 * - Removed mostly useless "TestApp" demo, as it was mainly useful only for checking for sytax errors in the library
167 * - MIDI device demos now receive MIDI events from the host and display note ON messages via the board LEDs
168 * - Cleanups to the Device mode Mass Storage demo application SCSI routines
169 * - Changed Audio Class driver sample read/write functions to be inline, to reduce the number of cycles needed to transfer
170 * samples to and from the device (allowing more time for sample processing and output)
171 * - Audio class Device mode demos now work at both 16MHz and 8MHz, rather than just at 8MHz
172 * - The previous USBtoSerial demo has been moved into the projects directory, as it was just a modified CDC demo
173 * - The Endpoint/Pipe functions now use the const qualifier on the input buffer
174 * - Changed the CALLBACK_HIDParser_FilterHIDReportItem() callback to pass a HID_ReportItem_t rather than just the current
175 * item's attributes, to expose more information on the item (including it's type, collection path, etc.)
176 * - Changed MouseHostWithParser demos to check that the report items have a Mouse usage collection as a parent at some point,
177 * to prevent Joysticks from enumerating with the demo
178 * - Corrected the name of the misnamed USB_GetDeviceConfigDescriptor() function to USB_Host_GetDeviceConfigDescriptor().
179 * - Keyboard LowLevel/ClassDriver demos now support multiple simultaneous keypresses (up to 6) per report
182 * - Fixed PrinterHost demo returning invalid Device ID data when the attached device does not have a
183 * device ID (thanks to Andrei Krainev)
184 * - Changed LUFA_VERSION_INTEGER define to use BCD values, to make comparisons eaiser
185 * - Fixed issue in the HID Host class driver's HID_Host_SendReportByID() routine using the incorrect mode (control/pipe)
186 * to send report to the attached device
187 * - Fixed ClassDriver AudioOutput device demo not selecting an audio output mode
188 * - Fixed incorrect SampleFrequencyType value in the AudioInput and AudioOutput ClassDriver demos' descriptors
189 * - Fixed incorrect event name rule in demo/project/bootloader makefiles
190 * - Fixed HID device class driver not reselecting the correct endpoint once the user callback routines have been called
191 * - Corrected HID descriptor in the Joystick Device demos - buttons should be placed outside the pointer collection
192 * - Fixed HID report parser collection paths invalid due to misplaced semicolon in the free path item search loop
193 * - Fixed HID host Class driver report send/receive report broken when issued through the control pipe
194 * - Fixed HOST_STATE_AS_GPIOR compile time option being ignored when in host mode (thanks to David Lyons)
195 * - Fixed LowLevel Keyboard demo not saving the issues report only after it has been sent to the host
196 * - Fixed Endpoint_Write_Control_Stream_* functions not sending a terminating IN when given data Length is zero
198 * \section Sec_ChangeLog090924 Version 090924
201 * - Added new host mode class drivers and matching demos to the library for rapid application development
202 * - Added flag to the HID report parser to indicate if a device has multiple reports
203 * - Added new EVENT_USB_Device_StartOfFrame() event, controlled by the new USB_Device_EnableSOFEvents() and
204 * USB_Device_DisableSOFEvents() macros to give bus-synchronised millisecond interrupts when in USB device mode
205 * - Added new Endpoint_SetEndpointDirection() macro for bidirectional endpoints
206 * - Added new AVRISP project, a LUFA powered clone of the Atmel AVRISP-MKII programmer
207 * - Added ShutDown() functions for all hardware peripheral drivers, so that peripherals can be turned off after use
208 * - Added new CDC_Device_Flush() command to the device mode CDC Class driver to flush Device->Host data
209 * - Added extra masks to the SPI driver, changed SPI_Init() so that the clock polarity and sample modes can be set
210 * - Added new callback to the HID report parser, so that the user application can filter only the items it is interested
211 * in to be stored into the HIDReportInfo structure to save RAM
212 * - Added support for the officially recommended external peripheral layout for the BUMBLEB board (thanks to Dave Fletcher)
213 * - Added new Pipe_IsFrozen() macro to determine if the currently selected pipe is frozen
214 * - Added new USB_GetHIDReportSize() function to the HID report parser to retrieve the size of a given report by its ID
215 * - Added new combined Mass Storage and Keyboard demo (thanks to Matthias Hullin)
218 * - SetIdle requests to the HID device driver with a 0 idle period (send changes only) now only affect the requested
219 * HID interface within the device, not all HID interfaces
220 * - Added explicit attribute masks to the device mode demos' descriptors
221 * - Added return values to the CDC and MIDI class driver transmit functions
222 * - Optimized Endpoint_Read_Word_* and Pipe_Read_Word_* macros to reduce compiled size
223 * - Added non-null function parameter pointer restrictions to USB Class drivers to improve user code reliability
224 * - Added new "Common" section to the class drivers, to hold all mode-independant definitions for clarity
225 * - Moved SCSI command/sense constants into the Mass Storage Class driver, instead of the user-code
226 * - Altered the SCSI commands in the LowLevel Mass Storage Host to save on FLASH space by reducing function calls
227 * - Changed the parameters and behaviour of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks
228 * and data validations internally, to simplify user code
229 * - Changed HIDParser to only zero out important values in the Parsed HID Report Item Information structure to save cycles
230 * - The HID report parser now always processed FEATURE items - HID_ENABLE_FEATURE_PROCESSING token now has no effect
231 * - The HID report parser now always ignores constant-data items, HID_INCLUDE_CONSTANT_DATA_ITEMS token now has no effect
232 * - The Benito Programmer project now has its own unique VID/PID pair allocated from the Atmel donated LUFA VID/PID pool
233 * - Add in new invalid event hook check targets to project makefiles to produce compilation errors when invalid event names
234 * are used in a project
235 * - The HID Report Parser now gives information on the total length of each report within a HID interface
236 * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now seperate USB_Descriptor_* and
237 * USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so both may be used
240 * - Fixed possible lockup in the CDC device class driver, when the host sends data that is a multiple of the
242 * - Fixed swapped parameters in the HID state memory copy call while processing a HID PUSH item in the HID report parser
243 * - Fixed memory corruption HID report parser when too many COLLECTION or PUSH items were processed
244 * - Fixed HID report parser not resetting the FEATURE item count when a REPORT ID item is encountered
245 * - Fixed USBtoSerial demos not reading in UDR1 when the USART receives data but the USB interface is not enumerated,
246 * causing continuous USART receive interrupts
247 * - Fixed misspelt event name in the Class driver USBtoSerial demo, preventing correct operation
248 * - Fixed invalid data being returned when a GetStatus request is issued in Device mode with an unhandled data recipient
249 * - Added hardware USART receive interrupt and software buffering to the Benito project to ensure received data is not
250 * missed or corrupted
251 * - Fixed Device mode HID Class driver always sending IN packets, even when nothing to report
252 * - Fixed Device mode HID Class driver not explicitly initializing the ReportSize parameter to zero before calling callback
253 * routine, so that ignored callbacks don't cause incorrect data to be sent
254 * - Fixed StillImageHost not correctly freezing and unfreezing data pipes while waiting for a response block header
255 * - Fixed error in the PrinterHost demo preventing the full page data from being sent to the attached device (thanks to John Andrews)
256 * - Fixed CDC based demos and projects' INF driver files under 64 bit versions of Windows (thanks to Ronny Hanson, Thomas Bleeker)
257 * - Re-add in missing flip, flip-ee, dfu and dfu-ee targets to project makefiles (thanks to Opendous Inc.)
258 * - Fix allowable F_CPU values comment in project makefiles to more accurately reflect the allowable values on the USB AVRs
259 * - Fixed DFU and CDC class bootloaders on the series 2 USB AVRs, corrected invalid signatures, added support for the new
260 * ATMEGAxx2 series 2 variant AVRs to the DFU bootloader
261 * - Fixed Low Level USBtoSerial demo not storing received characters (thanks to Michael Cooper)
262 * - Fixed MIDI Device Class driver not sending/receiving MIDI packets of the correct size (thanks to Thomas Bleeker)
265 * \section Sec_ChangeLog090810 Version 090810
268 * - Added new device class drivers and matching demos to the library for rapid application development
269 * - Added new PrinterHost demo (thanks to John Andrews)
270 * - Added USB Missle Launcher project, submitted by Dave Fletcher
271 * - Added new Benito Arduino Programmer project
272 * - Added incomplete device and host mode demos for later enhancement
273 * - Updated MassStorage device block write routines to use ping-pong Dataflash buffering to increase throughput by around 30%
274 * - Error status LEDs shown when device endpoint configuration fails to complete in all demos and projects
275 * - Added new USB_Host_SetDeviceConfiguration() convenience function for easy configuration selection of devices while in USB
277 * - Added new USB_Host_ClearPipeStall() convenience function to clear a stall condition on an attached device's endpoint
278 * - Added new USB_Host_GetDeviceDescriptor() convenience function to retrieve the attached device's Device descriptor
279 * - Added new Endpoint_ClearStatusStage() convenience function to assist with the status stages of control transfers
280 * - Added new USE_INTERNAL_SERIAL define for using the unique serial numbers in some AVR models as the USB device's serial number,
281 * added NO_INTERNAL_SERIAL compile time option to turn off new serial number reading code
282 * - Added new DATAFLASH_CHIP_MASK() macro to the Dataflash driver, which returns the Dataflash select mask for the given chip index
283 * - Added new HOST_STATE_WaitForDeviceRemoval host state machine state for non-blocking disabling of device communications until the
284 * device has been removed (for use when an error occurs or communications with the device have completed)
285 * - Added new FAST_STREAM_TRANSFERS compile time option for faster stream transfers via multiple bytes copied per stream loop
286 * - Added stdio stream demo code to the CDC device demos, to show how to create standard streams out of the virtual serial ports
287 * - Added new EEPROM and FLASH buffer versions of the Endpoint and Pipe stream functions
288 * - Added new USE_FLASH_DESCRIPTORS and FIXED_NUM_CONFIGURATIONS compile time options
289 * - Added support for the new ATMEGA32U2, ATMEGA16U2 and ATMEGA8U2 AVR models
290 * - Added new USB_DeviceState variable to keep track of the current Device mode USB state
291 * - Added new LEDs_ToggleLEDs() function to the LEDs driver
292 * - Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions
293 * - Added new DEVICE_STATE_AS_GPIOR and HOST_STATE_AS_GPIOR compile time options
294 * - Added 404 Not Found errors to the webserver in the RNDIS demos to indicate invalid URLs
297 * - Deprecated psuedo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused)
298 * - The device-mode CALLBACK_USB_GetDescriptor() function now has an extra parameter so that the memory space in which the requested
299 * descriptor is located can be specified. This means that descriptors can now be located in multiple memory spaces within a device.
300 * - Removed vague USB_IsConnected global - test USB_DeviceState or USB_HostState explicitly to gain previous functionality
301 * - Removed USB_IsSuspended global - test USB_DeviceState against DEVICE_STATE_Suspended instead
302 * - Extended USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch
303 * - Dataflash_WaitWhileBusy() now always ensures that the dataflash is ready for the next command immediately after returning,
304 * no need to call Dataflash_ToggleSelectedChipCS() afterwards
305 * - Low level API MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready
306 * - Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow errors
307 * - Pipe stream functions now automatically set the correct pipe token, so that bidirectional pipes can be used
308 * - Pipe_ConfigurePipe() now automatically defaults IN pipes to accepting infinite IN requests, this can still be changed by calling
309 * the existing Pipe_SetFiniteINRequests() function
310 * - Changed F_CLOCK entries in project makefiles to alias to F_CPU by default, as this is the most common case
311 * - Host mode demos now use sane terminal escape codes, so that text is always readable and events/program output is visually distinguished
312 * from oneanother using foreground colours
313 * - Internal per-device preprocessing conditions changed to per-device series rather than per-controller group for finer-grain
315 * - Interrupts are no longer disabled during the processing of Control Requests on the default endpoint while in device mode
316 * - AudioOutput demos now always output to board LEDs, regardless of output mode (removed AUDIO_OUT_LEDS project option)
317 * - Removed SINGLE_DEVICE_CONFIGURATION compile time option in favour of the new FIXED_NUM_CONFIGURATIONS option so that the exact number
318 * of device configurations can be defined statically
319 * - Removed VBUS events, as they are already exposed to the user application via the regular device connection and disconnection events
320 * - Renamed and altered existing events to properly seperate out Host and Device mode events
323 * - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix
324 * bootloaders on some of the USB AVR devices where avr-libc erronously defines RAMPZ
325 * - Fixes to MassStorageHost for better device compatibility (increase command timeout, change MassStore_WaitForDataReceived()
326 * to only unfreeze and check one data pipe at a time) to prevent incorrect device enumerations and freezes while trasferring data
327 * - Make Pipe_ConfigurePipe() mask the given endpoint number against PIPE_EPNUM_MASK to ensure the endpoint IN direction bit is
328 * cleared to prevent endpoint type corruption
329 * - Fixed issue opening CDC-ACM ports on hosts when the CDC device tries to send data before the host has set the line encoding
330 * - Fixed USB_OPT_MANUAL_PLL option being ignored during device disconnects on some models (thanks to Brian Dickman)
331 * - Fixed documentation mentioning Pipe_GetCurrentToken() function when correct function name is Pipe_GetPipeToken()
332 * - Fixed ADC driver for the ATMEGA32U4 and ATMEGA16U4 (thanks to Opendous Inc.)
333 * - Fixed CDCHost demo unfreezing the pipes at the point of configuration, rather than use
334 * - Fixed MassStorage demo not clearing the reset flag when a Mass Storage Reset is issued while not processing a command
335 * - Fixed USB_Host_SendControlRequest() not re-suspending the USB bus when initial device ready-wait fails
336 * - Fixed USB Pad regulator not being disabled on some AVR models when the USB_OPT_REG_DISABLED option is used
337 * - Fixed Host mode to Device mode UID change not causing a USB Disconnect event when a device was connected
338 * - Fixed Mouse/Keyboard demos not performing the correct arithmetic on the Idle period at the right times (thanks to Brian Dickman)
339 * - Fixed GenericHID failing HID class tests due to incorrect Logical Minimum and Logical Maximum values (thanks to Søren Greiner)
340 * - Fixed incorrect PIPE_EPNUM_MASK mask causing pipe failures on devices with endpoint addresses of 8 and above (thanks to John Andrews)
341 * - Fixed report data alignment issues in the MouseHostWithParser demo when X and Y movement data size is not a multiple of 8 bits
342 * - Fixed HID Report Descriptor Parser not correctly resetting internal states when a REPORT ID element is encountered
343 * - Fixed incorrect BUTTONS_BUTTON1 for the STK526 target
344 * - Fixed RNDIS demos freezing when more than one connection was attempted simultaneously, causing memory corruption
345 * - Fixed USBtoSerial demo receiving noise from the USART due to pullup not being enabled
348 * \section Sec_ChangeLog090605 Version 090605
350 * - Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest structure for control request data
351 * - Fixed documentation showing incorrect USB mode support on the supported AVRs list
352 * - Fixed RNDISEthernet not working under Linux due to Linux requiring an "optional" RNDIS request which was unhandled
353 * - Fixed Mouse and Keyboard device demos not acting in accordance with the HID specification for idle periods (thanks to Brian Dickman)
354 * - Removed support for endpoint/pipe non-control interrupts; these did not act in the way users expected, and had many subtle issues
355 * - Fixed Device Mode not handling Set Feature and Clear Feature Chapter 9 requests that are addressed to the device (thanks to Brian Dickman)
356 * - Moved control endpoint interrupt handling into the library itself, enable via the new INTERRUPT_CONTROL_ENDPOINT token
357 * - Fixed CDCHost not clearing configured pipes and resetting configured pipes mask when a partially enumerated invalid CDC
358 * interface is skipped
359 * - Clarified the size of library tokens which accept integer values in the Compile Time Tokens page, values now use the smallest datatype
360 * inside the library that is able to hold their defined value to save space
361 * - Removed DESCRIPTOR_ADDRESS() macro as it was largely supurflous and only served to obfuscate code
362 * - Rewritten event system to remove all macros, to make user code clearer
363 * - Fixed incorrect ENDPOINT_EPNUM_MASK mask preventing endpoints above EP3 from being selected (thanks to Jonathan Oakley)
364 * - Removed STREAM_CALLBACK() macro - callbacks now use regular function definitions to clarify user code
365 * - Removed DESCRIPTOR_COMPARATOR() macro - comparators should now use regular function definitions to clarify user code
366 * - USB_IsConnected is now cleared before the USB_Disconnect() event is fired in response to VBUS being removed
367 * - Fixed incorrect PID value being used in the USBtoSerial project (thanks to Phill)
368 * - Deleted StdDescriptors.c, renamed USB_GetDescriptor() to CALLBACK_USB_GetDescriptor, moved ConfigDescriptor.c/.h from the
369 * LUFA/Drivers/USB/Class/ directory to LUFA/Drivers/USB/HighLevel/ in preperation for the new USB class APIs
370 * - Moved out each demos' functionality library files (e.g. Ring Buffer library) to /Lib directories for a better directory structure
371 * - Removed Tx interrupt from the USBtoSerial demo; now sends characters via polling to ensure more time for the Rx interrupt
372 * - Fixed possible enumeration errors from spinloops which may fail to exit if the USB connection is severed before the exit condition
376 * \section Sec_ChangeLog090510 Version 090510
378 * - Added new GenericHIDHost demo
379 * - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use
380 * - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR
381 * - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile
383 * - All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected
384 * - Added new PIMA_DATA_SIZE() define to the Still Image Host demo
385 * - Add call to MassStore_WaitForDataReceived() in MassStore_GetReturnedStatus() to ensure that the CSW has been received in the
386 * extended MSC timeout period before continuing, to prevent long processing delays from causing the MassStore_GetReturnedStatus()
387 * to early-abort (thanks to Dmitry Maksimov)
388 * - Move StdRequestType.h, StreamCallbacks.h, USBMode.h from the LowLevel USB driver directory to the HighLevel USB driver directory,
389 * where they are more suited
390 * - Removed all binary constants and replaced with decimal or hexadecimal constants so that unpatched GCC compilers can still build the
391 * code without having to be itself patched and recompiled first
392 * - Added preprocessor checks and documentation to the bootloaders giving information about missing SIGNATURE_x defines due to
393 * outdated avr-libc versions.
394 * - Added support to the CDCHost demo for devices with multiple CDC interfaces which are not the correct ACM type preceding the desired
396 * - Fixed GenericHID demo not starting USB and HID management tasks when not using interrupt driven modes (thanks to Carl Kjeldsen)
397 * - Fixed RNDISEthenet demo checking the incorrect message field for packet size constraints (thanks to Jonathan Oakley)
398 * - Fixed WriteNextReport code in the GenericHIDHost demo using incorrect parameter types and not selecting the correct endpoint
399 * - Adjusted sample CTC timer calculations in the AudioOutput and AudioInput demos to match the CTC calculations in the AVR datasheet,
400 * and to fix instances where rounding caused the endpoint to underflow (thanks to Robin Theunis)
401 * - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0), so that other control type
402 * pipes can be used with the function
403 * - The USB Host management task now saves and restores the currently selected pipe before and after the task completes
404 * - Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev)
405 * - Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favour of new Endpoint_ClearIN(), Endpoint_ClearOUT(),
406 * Pipe_ClearIN() and Pipe_ClearOUT() macros (done to allow for the detection of packets of zero length)
407 * - Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API
408 * - Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been
409 * renamed to Endpoint_ClearSETUP(), the Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent() and the
410 * Pipe_ClearSetupSent() macro is no longer applicable and should be removed - changes made to compliment the new endpoint and pipe
411 * bank management API
412 * - Updated all demos, bootloaders and projects to use the new endpoint and pipe management APIs (thanks to Roman Thiel from Curetis AG)
413 * - Updated library doxygen documentation, added groups, changed documentation macro functions to real functions for clarity
414 * - Removed old endpoint and pipe aliased read/write/discard routines which did not have an explicit endian specifier for clarity
415 * - Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway
416 * - Renamed the main Drivers/AT90USBXXX directory to Drivers/Peripheral, renamed the Serial_Stream driver to SerialStream
417 * - Fixed CDC and USBtoSerial demos freezing where buffers were full while still transmitting or receiving (thanks to Peter Hand)
418 * - Removed "Host_" section of the function names in ConfigDescriptor.h, as most of the routines can now be used in device mode on the
420 * - Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name
421 * - Fixed incorrect HID interface class and subclass values in the Mouse and KeyboardMouse demos (thanks to Brian Dickman)
422 * - Capitalised the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and
423 * DSearch_Comp_Return_ErrorCodes_t enums
424 * - Removed "ERROR" from the enum names in the endpoint and pipe stream error code enums
425 * - Renamed the USB_PowerOnErrorCodes_t enum to USB_InitErrorCodes_t, renamed the POWERON_ERROR_NoUSBModeSpecified enum value to
426 * USB_INITERROR_NoUSBModeSpecified
427 * - Renamed USB_PowerOnFail event to USB_InitFailure
428 * - Renamed OTG.h header functions to be more consistent with the rest of the library API
429 * - Changed over all deprecated GCC structure tag initializers to the standardized C99 format (thanks to Mike Alexander)
430 * - USB_HostRequest renamed to USB_ControlRequest, entire control request header is now read into USB_ControlRequest in Device mode
431 * rather than having the library pass only partially read header data to the application
432 * - The USB_UnhandledControlPacket event has had its parameters removed, in favour of accessing the new USB_ControlRequest structure
433 * - The Endpoint control stream functions now correctly send a ZLP to the host when less data than requested is sent
434 * - Fixed USB_RemoteWakeupEnabled flag never being set (the REMOTE WAKEUP Set Feature request was not being handled)
435 * - Renamed the FEATURELESS_CONTROL_ONLY_DEVICE compile-time token to CONTROL_ONLY_DEVICE
436 * - Endpoint configuration is now refined to give better output when all configurations have static inputs - removed the now useless
437 * STATIC_ENDPOINT_CONFIGURATION compile time token
438 * - Fixed SPI driver init function not clearing SPI2X bit when not needed
439 * - Fixed PREVENT ALLOW MEDIUM REMOVAL command issuing in the MassStorageHost demo using incorrect parameters (thanks to Mike Alex)
440 * - Fixed MassStorageHost demo broken due to an incorrect if statement test in MassStore_GetReturnedStatus()
441 * - Fixed reversed signature byte ordering in the CDC bootloader (thanks to Johannes Raschke)
442 * - Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with faulty devices which do not respect the given
443 * wLength value when reading in the device descriptor
444 * - Fixed missing semicolon in the ATAVRUSBRF01 LED board driver code (thanks to Morten Lund)
445 * - 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
446 * with less than four LEDs without code modifications (thanks to Morten Lund)
447 * - Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button
448 * - Serial driver now correctly calculates the baud register value when in double speed mode
449 * - Init function of the Serial driver is now static inline to product smaller code for the common-case of static init values
452 * \section Sec_ChangeLog090401 Version 090401
454 * - Fixed MagStripe project configuration descriptor containing an unused (blank) endpoint descriptor
455 * - Incorporated makefile changes by Denver Gingerich to retain compatibility with stock (non-WinAVR) AVR-GCC installations
456 * - Fixed makefile EEPROM programming targets programming FLASH data in addition to EEPROM data
457 * - LUFA devices now enumerate correctly with LUFA hosts
458 * - Fixed Configuration Descriptor search routine freezing when a comparator returned a failure
459 * - Removed HID report item serial dump in the MouseHostWithParser and KeyboardHostWithParser - useful only for debugging, and
460 * slowed down the enumeration of HID devices too much
461 * - Increased the number of bits per track which can be read in the MagStripe project to 8192 when compiled for the AT90USBXXX6/7
462 * - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request
463 * - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission
464 * next time the device is attached to a host.
465 * - 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
466 * clock prescaling is performed) frequency, so that the PLL prescale mask can be determined
467 * - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with
468 * badly designed hosts or devices which greatly exceed the USB specification limits
469 * - Mass Storage Host demo now uses a USB_STREAM_TIMEOUT_MS of two seconds to maintain compatibility with poorly designed devices
470 * - Function attribute ATTR_ALWAYSINLINE renamed to ATTR_ALWAYS_INLINE to match other function attribute macro naming conventions
471 * - Added ATTR_ALWAYS_INLINE attribute to several key inlined library components, to ensure they are inlined in all circumstances
472 * - Removed SetSystemClockPrescaler() macro, the clock_prescale_set() avr-libc macro has been corrected in recent avr-libc versions
473 * - Fixed incorrect/missing control status stage transfers on demos, bootloaders and applications (thanks to Nate Lawson)
474 * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
475 * to also remove parts of the Get Status chapter 9 request to further reduce code usage
476 * - Makefile updated to include output giving the currently selected BOARD parameter value
477 * - Board Dataflash driver now allows for dataflash ICs which use different shifts for setting the current page/byte address (thanks
479 * - Added DataflashManager_WriteBlocks_RAM() and DataflashManager_ReadBlocks_RAM() functions to the MassStorage demo, to allow for easy
480 * interfacing with a FAT library for dataflash file level access
481 * - Corrected CDC class bootloader to fix a few bugs, changed address counter to store x2 addresses for convenience
482 * - Fixed typos in the SPI driver SPI_SPEED_FCPU_DIV_64 and SPI_SPEED_FCPU_DIV_128 masks (thanks to Markus Zocholl)
483 * - Keyboard and Mouse device demos (normal, data interrupt and fully interrupt driven) combined into unified keyboard and mouse demos
484 * - Keyboard and Mouse host demos (normal and data interrupt driven) combined into unified keyboard and mouse demos
485 * - Removed AVRISP_Programmer project due to code quality concerns
486 * - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incoming data
487 * - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)
488 * - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)
489 * - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)
490 * - Added new GenericHID device demo application
491 * - Fixed Still Image Host SImage_SendData() function not clearing the pipe bank after sending data
494 * \section Sec_ChangeLog090209 Version 090209
496 * - PWM timer mode in AudioOut demo changed to Fast PWM for speed
497 * - Updated Magstripe project to work with the latest hardware revision
498 * - Fixed library not responding to the BCERRI flag correctly in host mode, leading to device lockups
499 * - Fixed library handling Get Descriptor requests when not addressed as standard requests to the device or interface (thanks to
501 * - Fixed serious data corruption issue in MassStorage demo dataflash write routine
502 * - Added new NO_CLEARSET_FEATURE_REQUEST compile time token
503 * - USB task now restores previous global interrupt state after execution, rather than forcing global interrupts to be enabled
504 * - Fixed USB_DeviceEnumerationComplete event firing after each configuration change, rather than once after the initial configuration
505 * - Added ENDPOINT_DOUBLEBANK_SUPPORTED() macros to Endpoint.h, altered ENDPOINT_MAX_SIZE() to allow user to specify endpoint
506 * - ENDPOINT_MAX_ENDPOINTS changed to ENDPOINT_TOTAL_ENDPOINTS, PIPE_MAX_PIPES changed to PIPE_TOTAL_PIPES
507 * - Endpoint and Pipe non-control stream functions now ensure endpoint or pipe is ready before reading or writing
508 * - Changed Teensy bootloader to use a watchdog reset when exiting rather than a software jump
509 * - Fixed integer promotion error in MassStorage and MassStorageHost demos, corrupting read/write transfers
510 * - SPI_SendByte is now SPI_TransferByte, added new SPI_SendByte and SPI_ReceiveByte functions for fast one-way transfer
511 * - MassStorage demo changed to use new fast one-way SPI transfers to increase throughput
512 * - MassStorage handling of Mass Storage Reset class request improved
513 * - Altered MassStorage demo dataflash block read code for speed
514 * - Added USB_IsSuspended global flag
515 * - Simplified internal Dual Mode (OTG) USB library code to reduce code size
516 * - Extended stream timeout period to 100ms from 50ms
517 * - Mass Storage Host demo commands now all return an error code from the Pipe_Stream_RW_ErrorCodes_t enum
518 * - Added SubErrorCode parameter to the USB_DeviceEnumerationFailed event
519 * - VBUS drop interrupt now disabled during the manual-to-auto VBUS delivery handoff
520 * - Simplified low level backend so that device/host mode initialization uses the same code paths
521 * - Added workaround for faulty Mass Storage devices which do not implement the required GET_MAX_LUN request
522 * - Removed buggy Telnet application from the RNDIS demo
523 * - Moved Mass Storage class requests in the Mass Storage Host demo to wrapper functions in MassStoreCommands.c
524 * - Fixed incorrect SCSI command size value in the Request Sense command in MassStoreCommands.c
525 * - Added SetProtocol request to HID class non-parser Mouse and Keyboard demos to force devices to use the correct Boot Protocol
526 * - Added new "dfu" and "flip" programming targets to project makefiles
527 * - HID_PARSE_Sucessful enum member typo corrected to HID_PARSE_Successful
528 * - Changed COLLECTION item structures in the HID descriptor parser to include the collection's Usage Page value
529 * - Serial driver now sets Tx line as output, enables pullup on Rx line
530 * - Fixed smaller USB AVRs raising multiple connection and disconnection events when NO_LIMITED_CONTROLLER_CONNECT is disabled
531 * - Added HOST_DEVICE_SETTLE_DELAY_MS to give the host delay after a device is connected before it is enumerated
532 * - Fixed KeyboardHostWithParser demo linking against the wrong global variables
533 * - Completed doxygen documentation of remaining library bootloaders, demos and projects
534 * - Fixed incorrect bootloader start address in the TeensyHID bootloader
535 * - Added HWB button whole-disk ASCII dump functionality to MassStoreHost demo
536 * - Replaced printf_P(PSTR("%c"), {Variable}) calls with putchar(<Variable>) for speed and size savings
537 * - Serial driver now accepts baud rates over 16-bits in size, added double speed flag option
538 * - Fixed incorrect callback abort return value in Pipe.c
539 * - Added new flip-ee and dfu-ee makefile targets (courtesy of Opendous Inc.)
540 * - Removed reboot-on-disconnect code from the TeensyHID bootloader, caused problems on some systems
541 * - Fixed AudioOutput and AudioInput demos looping on the endpoint data, rather than processing a sample at a time and returning
542 * each time the task runs to allow for other tasks to execute
543 * - Added support for the Atmel ATAVRUSBRF01 board
544 * - Added AVRISP Programmer Project, courtesy of Opendous Inc.
545 * - Fixed CDC Host demo not searching through both CDC interfaces for endpoints
546 * - Fixed incorrect Product String descriptor length in the DFU class bootloader
549 * \section Sec_ChangeLog081224 Version 081224
551 * - MyUSB name changed to LUFA, the Lightweight USB Framework for AVRs
552 * - Fixed Mass Storage Host demo's MassStore_SendCommand() delay in the incorrect place
553 * - Fixed USBtoSerial demo not calling ReconfigureUSART() after a change in the line encoding
554 * - Fixed infinite loop in host mode Host-to-Device control transfers with data stages
555 * - HID report parser now supports devices with multiple reports in one interface via Report IDs
556 * - Fixed RZUSBSTICK board LED driver header incorrect macro definition order causing compile errors
557 * - Calling USB_Init() when the USB interface is already configured now forces a complete interface reset
558 * and re-enumeration - fixes MyUSB DFU bootloader not switching to app code correctly when soft reset used
559 * - Fixed "No newline at end of file" warning when stream callbacks are enabled
560 * - DFU bootloader now uses fixed signature bytes per device, rather than reading them out dynamically for size
561 * - Added new FIXED_CONTROL_ENDPOINT_SIZE and USE_SINGLE_DEVICE_CONFIGURATION switches to statically define certain values to
562 * reduce compiled binary size
563 * - Added new NO_LIMITED_CONTROLLER_CONNECT switch to prevent the library from trying to determine bus connection
564 * state from the suspension and wake up events on the smaller USB AVRs
565 * - Added summary of all library compile time tokens to the documentation
566 * - Added overview of the LUFA scheduler to the documentation
567 * - Removed MANUAL_PLL_CONTROL compile time token, replaced with a mask for the USB_Init() Options parameter
568 * - CDC bootloader now uses the correct non-far or far versions of the pgm_* functions depending on if RAMPZ is defined
569 * - Doxygen documentation now contains documentation on all the projects, bootloaders and most demos included with the library
570 * - CDC bootloader now runs user application when USB disconnected rather than waiting for a hard reset
571 * - MouseHostWithParser and KeyboardHostWithParser now support multiple-report devices
572 * - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver
573 * - Fixed the DFU bootloader, no longer freezes up when certain files are programmed into an AVR, made reading/writing faster
574 * - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal
575 * right-handed system
576 * - Added stub code to the CDC and USBtoSerial demos showing how to read and set the RS-232 handshake lines - not currently used in
577 * the demos, but the example code and supporting defines are now in place
578 * - Interrupts are now disabled when processing a control request in device mode, to avoid exceeding the strict control request
579 * timing requirements.
580 * - All demos now use a central StatusUpdate() function rather than direct calls to the board LED functions, so that the demos can
581 * easily be altered to show different LED combinations (or do something else entirely) as the demo's status changes
582 * - Removed LED commands from the CDC bootloader, unused by most AVR910 programming software
583 * - Fixed RNDIS demo ICMP ping requests echoing back incorrect data
584 * - Added DHCP server code to RNDIS demo, allowing for hands-free auto configuration on any PC
585 * - Fixed DFU bootloader PID value for the ATMEGA16U4 AVR
586 * - Endpoint and Pipe configuration functions now return an error code indicating success or failure
587 * - USB Reset in device mode now resets and disables all device endpoints
588 * - Added intermediate states to the host mode state machine, reducing the USB task blocking time to no more than 1ms explicitly per
589 * invocation when in host mode
590 * - Added support for the ATMEGA32U6 microcontroller
591 * - Added STATIC_ENDPOINT_CONFIGURATION compile time option, enabled in the bootloaders to minimize space usage
592 * - Removed redundant code from the USB device GetStatus() chapter 9 processing routine
593 * - Added new TeensyHID bootloader, compatible with the Teensy HID protocol (http://www.pjrc.com/teensy/)
594 * - Versions are now numbered by release dates, rather than arbitrary major/minor revision numbers
595 * - USB_RemoteWakeupEnabled is now correctly set and cleared by SetFeature and ClearFeature requests from the host
596 * - Changed prototype of GetDescriptor, so that it now returns the descriptor size (or zero if the descriptor doesn't exist)
597 * rather than passing the size back to the caller through a parameter and returning a boolean
600 * \section Sec_ChangeLog153 Version 1.5.3 - Released 2nd October, 2008
602 * - Fixed CDC bootloader using pgmspace macros for some descriptors inappropriately
603 * - Updated all Mouse and Keyboard device demos to include boot protocol support (now works in BIOS)
604 * - Renamed bootloader directories to remove spaces, which were causing build problems on several OSes
605 * - Removed serial number strings from all but the MassStore demo where it is required - users were not
606 * modifying the code to either omit the descriptor or use a unique serial per device causing problems
607 * when multiple units of the same device were plugged in at the same time
608 * - AudioOutput and AudioInput demos now correctly silence endpoints when not enabled by the host
609 * - Added KeyboardMouse demo (Keyboard and Mouse functionality combined into a single demo)
610 * - Added DriverStubs directory to house board level driver templates, to make MyUSB compatible custom board
611 * driver creation easier
612 * - Extended MassStorage demo to support multiple LUNs, 2 by default
613 * - Fixed incorrect device address mask, preventing the device from enumerating with addresses larger than 63
614 * - Fixed incorrect data direction mask in the GetStatus standard request, preventing it from being handled
615 * - Fixed incorrect GetStatus standard request for endpoints, now returns the endpoint STALL status correctly
616 * - Added in new USB_RemoteWakeupEnabled and USB_CurrentlySelfPowered flags rather than using fixed values
617 * - Added DualCDC demo to demonstrate the use of Interface Association Descriptors
618 * - Added pipe NAK detection and clearing API
619 * - Added pipe status change (NAK, STALL, etc.) interrupt API
620 * - Fixed MassStorageHost demo so that it no longer freezes randomly when issuing several commands in a row
621 * - Host demos configuration descriptor routines now return a unique error code when the returned data does
622 * not have a valid configuration descriptor header
623 * - Added Endpoint_WaitUntilReady() and Pipe_WaitUntilReady() functions
624 * - Stream functions now have software timeouts, timeout period can be set by the USB_STREAM_TIMEOUT_MS token
625 * - All demos now pass the USB.org automated Chapter 9 device compliance tests
626 * - All HID demos now pass the USB.org automated HID compliance tests
627 * - Polling interval of the interrupt endpoint in the CDC based demos changed to 0xFF to fix problems on Linux systems
628 * - Changed stream functions to accept a new callback function, with NO_STREAM_CALLBACKS used to disable all callbacks
629 * - Mass Storage demo dataflash management routines changed to use the endpoint stream functions
630 * - Added AVRStudio project files for each demo in addition to the existing Programmer's Notepad master project file
631 * - Re-added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
632 * are reflected in the hardware (change was previously lost)
635 * \section Sec_ChangeLog152 Version 1.5.2 - Released 31st July, 2008
637 * - Fixed SwapEndian_32() function in Common.h so that it now works correctly (wrong parameter types)
638 * - Updated RNDIS demo - notification endpoint is no longer blocking so that it works with faulty Linux RNDIS
639 * implementations (where the notification endpoint is ignored in favour of polling the control endpoint)
640 * - Fixed incorrect Vendor Description string return size in RNDIS demo for the OID_GEN_VENDOR_DESCRIPTION OID token
641 * - Added very basic TCP/IP stack and HTTP/TELNET servers to RNDIS demo
642 * - Fixed DFU bootloader exit causing programming software to complain about failed writes
643 * - Fixed DFU bootloader EEPROM programming mode wiping first flash page
644 * - Fixed Clear/Set Feature device standard request processing code (fixing MassStorage demo in the process)
645 * - Added support for the ATMEGA16U4 AVR microcontroller
646 * - Library licence changed from LGPLv3 to MIT license
649 * \section Sec_ChangeLog151 Version 1.5.1 - Released 31st July, 2008
651 * - Changed host demos to enable the host function task on the firing of the USB_DeviceEnumerationComplete event
652 * rather than the USB_DeviceAttached event
653 * - HID Usage Stack now forcefully cleared after an IN/OUT/FEATURE item has been completely processed to remove
654 * any referenced but not created usages
655 * - Changed USB_INT_DisableAllInterrupts() and USB_INT_ClearAllInterrupts(), USB_Host_GetNextDescriptorOfType(),
656 * USB_Host_GetNextDescriptorOfTypeBefore(), USB_Host_GetNextDescriptorOfTypeAfter() to normal functions (from inline)
657 * - Fixed USBtoSerial demo not sending data, only receiving
658 * - Fixed main makefile to make all by default, fixed MagStripe directory case to prevent case-sensitive path problems
659 * - ConfigDescriptor functions made normal, instead of static inline
660 * - Pipe/Endpoint *_Ignore_* functions changed to *_Discard_*, old names still present as aliases
661 * - Fixed ENDPOINT_MAX_SIZE define to be correct on limited USB controller AVRs
662 * - Changed endpoint and pipe size translation routines to use previous IF/ELSE IF cascade code, new algorithmic
663 * approach was buggy and caused problems
664 * - Bootloaders now compile with -fno-inline-small-functions option to reduce code size
665 * - Audio demos now use correct endpoint sizes for full and limited controller USB AVRs, double banking in all cases
666 * to be in line with the specification (isochronous endpoints MUST be double banked)
667 * - Added Interface Association descriptor to StdDescriptors.h, based on the relevant USB2.0 ECN
668 * - Fixed MIDI demo, corrected Audio Streaming descriptor to follow the MIDI-specific AS structure
669 * - Fixed HID class demo descriptors so that the HID interface's protocol is 0x00 (required for non-boot protocol HID
670 * devices) to prevent problems on hosts expecting the boot protocol functions to be supported
671 * - Added read/write control stream functions to Endpoint.h
672 * - Fixed AudioOut demo not setting port pins to inputs on USB disconnect properly
673 * - Added RNDISEthernet demo application
676 * \section Sec_ChangeLog150 Version 1.5.0 - Released 10 June, 2008
678 * - Fixed MIDI demo, now correctly waits for the endpoint to be ready between multiple note messages
679 * - Added CDC Host demo application
680 * - Added KeyboardFullInt demo application
681 * - Endpoint and Pipe creation routines now mask endpoint/pipe size with the size mask, to remove transaction
682 * size bits not required for the routines (improves compatibility with devices)
683 * - Fixed AudioInput demo - now correctly sends sampled audio to the host PC
684 * - Fixed AudioOutput demo once more -- apparently Windows requires endpoint packets to be >=192 bytes
685 * - Shrunk round-robbin scheduler code slightly via the use of struct pointers rather than array indexes
686 * - Fixed off-by-one error when determining if the Usage Stack is full inside the HID Report parser
687 * - Renamed Magstripe.h to MagstripeHW.h and moved driver out of the library and into the MagStripe demo folder
688 * - Added preprocessor checks to enable C linkage on the library components when used with a C++ compiler
689 * - Added Still Image Host demo application
690 * - The USB device task now restores the previously selected endpoint, allowing control requests to be transparently
691 * handled via interrupts while other endpoints are serviced through polling
692 * - Fixed device signature being sent in reverse order in the CDC bootloader
693 * - Host demos now have a separate ConfigDescriptor.c/.h file for configuration descriptor processing
694 * - HostWithParser demos now have a separate HIDReport.c/.h file for HID report processing and dumping
695 * - Removed non-mandatory commands from MassStorage demo to save space, fixed SENSE ResponseCode value
696 * - CDC demos now send empty packets after sending a full one to prevent buffering issues on the host
697 * - Updated demo descriptors to use VID/PID values donated by Atmel
698 * - Added DoxyGen documentation to the source files
699 * - Fixed Serial_IsCharReceived() definition, was previously reversed
700 * - Removed separate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead
701 * - Removed unused Device Qualifier descriptor structure
702 * - Renamed the USB_CreateEndpoints event to the more appropriate USB_ConfigurationChanged
703 * - Fixed MassStorageHost demo reading in the block data in reverse
704 * - Removed outdated typedefs in StdRequestType.h, superseded by the macro masks
705 * - Corrected OTG.h is now included when the AVR supports both Host and Device modes, for creating OTG products
706 * - USB_DeviceEnumerationComplete event is now also fired when in device mode and the host has finished its enumeration
707 * - Interrupt driven demos now properly restore previously selected endpoint when ISR is complete
708 * - USB_HOST_TIMEOUT_MS is now overridable in the user project makefile to a custom fixed timeout value
709 * - Renamed USB_Host_SOFGeneration_* macros to more friendly USB_Host_SuspendBus(), USB_Host_ResumeBus()
710 * and USB_Host_IsBusSuspended()
711 * - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistent, Pipe_SetInterruptFreq() is now
712 * Pipe_SetInterruptPeriod() to use the correct terminology
713 * - UnicodeString member of USB_Descriptor_String_t struct changed to an ordinary int array type, so that the GCC
714 * Unicode strings (prefixed with an L before the opening quotation mark) can be used instead of explicit arrays
715 * of ASCII characters
716 * - Fixed Endpoint/Pipes being configured incorrectly if the maximum endpoint/pipe size for the selected USB AVR
717 * model was given as the bank size
718 * - HID device demos now use a true raw array for the HID report descriptor rather than a struct wrapped array
719 * - Added VERSION_BCD() macro, fixed reported HID and USB version numbers in demo descriptors
720 * - Cleaned up GetDescriptor device chapter 9 handler function
721 * - Added GET_REPORT class specific request to HID demos to make them complaint to the HID class
722 * - Cleaned up setting of USB_IsInitialized and USB_IsConnected values to only when needed
723 * - Removed Atomic.c and ISRMacro.h; the library was already only compatible with recent avr-lib-c for other reasons
724 * - All demos and library functions now use USB standardized names for the USB data (bRequest, wLength, etc.)
725 * - Added USE_NONSTANDARD_DESCRIPTOR_NAMES token to switch back to the non-standard descriptor element names
728 * \section Sec_ChangeLog141 Version 1.4.1 - Released 5 May, 2008
730 * - Enhanced KeyboardWithParser demo, now prints out pressed alphanumeric characters like the standard demo
731 * - Fixed MassStorage demo, read/writes using non mode-10 commands now work correctly
732 * - Corrected version number in Version.h
735 * \section Sec_ChangeLog140 Version 1.4.0 - Released 5 May, 2008
737 * - Added HID Report Parser API to the library
738 * - Added Mouse and Keyboard host demo applications, using the new HID report parser engine
739 * - Added MouseFullInt demo, which demonstrates a fully interrupt (including control requests) mouse device
740 * - Fixed incorrect length value in the audio control descriptor of the AudioOutput and AudioInput demos
741 * - Added MIDI device demo application to the library
742 * - Fixed problem preventing USB devices from being resumed from a suspended state
743 * - Added new CDC class bootloader to the library, based on the AVR109 bootloader protocol
744 * - Added header to each demo application indicating the mode, class, subclass, standards used and supported speed
745 * - Functions expecting endpoint/pipe numbers are no longer automatically masked against ENDPOINT_EPNUM_MASK or
746 * PIPE_PIPENUM_MASK - this should be manually added to code which requires it
747 * - Fixed DFU class bootloader - corrected frequency of flash page writes, greatly reducing programming time
748 * - Renamed AVR_HOST_GetDeviceConfigDescriptor() to USB_Host_GetDeviceConfigDescriptor() and AVR_HOST_GetNextDescriptor()
749 * to USB_Host_GetNextDescriptor()
750 * - Added new USB_Host_GetNextDescriptorOfTypeBefore() and USB_Host_GetNextDescriptorOfTypeAfter() routines
751 * - Moved configuration descriptor routines to MyUSB/Drivers/USB/Class/, new accompanying ConfigDescriptors.c file
752 * - Added new configuration descriptor comparator API for more powerful descriptor parsing, updated host demos to use the
754 * - Fixed MassStorageHost demo capacity printout, and changed data read/write mode from little-endian to the correct
755 * big-endian for SCSI devices
756 * - Fixed macro/function naming consistency; USB_HOST is now USB_Host, USB_DEV is now USB_Device
757 * - Added better error reporting to host demos
758 * - Added 10 microsecond delay after addressing devices in host mode, to prevent control stalls
761 * \section Sec_ChangeLog132 Version 1.3.2 - Released April 1st, 2008
763 * - Added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
764 * are reflected in the hardware
765 * - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the
766 * GetLineCoding request had an incorrect RequestType mask preventing it from being processed
767 * - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full
768 * - Device control endpoint size is now determined from the device's descriptors rather than being fixed
769 * - Separated out SPI code into new SPI driver in AT90USBXXX driver directory
770 * - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID
771 * - Added support for the RZUSBSTICK board
772 * - Bicolour driver removed in favour of generic LEDs driver
773 * - Added support for the ATMEGA32U4 AVR
774 * - Added MANUAL_PLL_CONTROL compile time option to prevent the USB library from manipulating the PLL
777 * \section Sec_ChangeLog131 Version 1.3.1 - Released March 19th 2008
779 * - Fixed USB to Serial demo - class value in the descriptors was incorrect
780 * - Control endpoint size changed from 64 bytes to 8 bytes to save on USB FIFO RAM and to allow low
781 * speed mode devices to enumerate properly
782 * - USB to Serial demo data endpoints changed to dual-banked 16 byte to allow the demo to work
783 * on USB AVRs with limited USB FIFO RAM
784 * - Changed demo endpoint numbers to use endpoints 3 and 4 for double banking, to allow limited
785 * USB device controller AVRs (AT90USB162, AT90USB82) to function correctly
786 * - Updated Audio Out demo to use timer 1 for AVRs lacking a timer 3 for the PWM output
787 * - Fixed incorrect USB_DEV_OPT_HIGHSPEED entry in the Mass Storage device demo makefile
788 * - Optimized Mass Storage demo for a little extra transfer speed
789 * - Added LED indicators to the Keyboard demo for Caps Lock, Num Lock and Scroll Lock
790 * - Added Endpoint_Read_Stream, Endpoint_Write_Stream, Pipe_Read_Stream and Pipe_Write_Stream functions
791 * (including Big and Little Endian variants)
792 * - Made Dataflash functions inline for speed, removed now empty Dataflash.c driver file
793 * - Added new SetSystemClockPrescaler() macro (thanks to Joerg Wunsch)
794 * - Fixed Endpoint_ClearStall() to function correctly on full USB controller AVRs (AT90USBXXX6/7)
795 * - Endpoint_Setup_In_Clear() and Endpoint_Setup_Out_Clear() no longer set FIFOCON, in line with the
796 * directives in the datasheet
797 * - Fixed PLL prescaler defines for all AVR models and frequencies
798 * - Fixed ENDPOINT_INT_IN and ENDPOINT_INT_OUT definitions
799 * - Added interrupt driven keyboard and mouse device demos
800 * - Combined USB_Device_ClearFeature and USB_Device_SetFeature requests into a single routine for code
802 * - Added missing Pipe_GetCurrentPipe() macro to Pipe.h
805 * \section Sec_ChangeLog130 Version 1.3.0 - Released March 7th 2008
807 * - Unnecessary control endpoint config removed from device mode
808 * - Fixed device standard request interpreter accidentally processing some class-specific requests
809 * - Added USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS compile time options to instruct the library
810 * to use descriptors stored in RAM or EEPROM rather than flash memory
811 * - All demos now disable watchdog on startup, in case it has been enabled by fuses or the bootloader
812 * - USB_DEV_OPT_LOWSPEED option now works correctly
813 * - Added ability to set the USB options statically for a binary size reduction via the USE_STATIC_OPTIONS
814 * compile time define
815 * - USB_Init no longer takes a Mode parameter if compiled for a USB device with no host mode option, or
816 * if forced to a particular mode via the USB_HOST_ONLY or USB_DEVICE_ONLY compile time options
817 * - USB_Init no longer takes an Options parameter if options statically configured by USE_STATIC_OPTIONS
818 * - Endpoint_Ignore_* and Pipe_Ignore_* made smaller by making the dummy variable non-volatile so that the
819 * compiler can throw away the result more efficiently
820 * - Added in an optional GroupID value to each scheduler entry, so that groups of tasks can once again be
821 * controlled by the new Scheduler_SetGroupTaskMode() routine
822 * - Added support for AT90USB162 and AT90USB82 AVR models
823 * - Added support for the STK525 and STK526 boards
824 * - Added support for custom board drivers to be supplied by selecting the board type as BOARD_USER, and
825 * placing board drivers in {Application Directory}/Board/
826 * - PLL is now stopped and USB clock is frozen when detached from host in device mode, to save power
827 * - Joystick defines are now in synch with the schematics - orientation will be rotated for the USBKEY
828 * - Fixed USB_DEV_IsUSBSuspended() - now checks the correct register
829 * - Fixed data transfers to devices when in host mode
830 * - Renamed USB_DEV_OPT_HIGHSPEED to USB_DEV_OPT_FULLSPEED and USB_HOST_IsDeviceHighSpeed() to
831 * USB_HOST_IsDeviceFullSpeed() to be in line with the official USB speed names (to avoid confusion with
832 * the real high speed mode, which is unavailable on the USB AVRs)
835 * \section Sec_ChangeLog120 Version 1.2.0 - Released February 4th, 2008
837 * - Added USB_DeviceEnumerationComplete event for host mode
838 * - Added new Scheduler_Init routine to preprepare the scheduler, so that tasks can be started and
839 * stopped before the scheduler has been started (via Scheduler_Start)
840 * - Connection events in both Device and Host mode are now interrupt-driven, allowing the USB management
841 * task to be stopped when the USB is not connected to a host or device
842 * - All demos updated to stop the USB task when not in use via the appropriate USB events
843 * - Mass Storage Host demo application updated to function correctly with all USB flash disks
844 * - Mass Storage Host demo application now prints out the capacity and number of LUNs in the attached
845 * device, and prints the first block as hexadecimal numbers rather than ASCII characters
846 * - Endpoint and Pipe clearing routines now clear the Endpoint/Pipe interrupt and status flags
847 * - Shifted error handling code in the host enum state machine to a single block, to reduce code complexity
848 * - Added in DESCRIPTOR_TYPE, DESCRIPTOR_SIZE and DESCRIPTOR_CAST macros to make config descriptor processing
849 * clearer in USB hosts and DESCRIPTOR_ADDRESS for convenience in USB devices
850 * - Added in alloca macro to common.h, in case the user is using an old version of avr-lib-c missing the macro
853 * \section Sec_ChangeLog130 Version 1.1.0 - Released January 25th 2008
855 * - Fixed DCONNI interrupt being enabled accidentally after a USB reset
856 * - Fixed DDISCI interrupt not being disabled when a device is not connected
857 * - Added workaround for powerless pullup devices causing false disconnect interrupts
858 * - Added USB_DeviceEnumerationFailed event for Host mode
859 * - AVR_HOST_GetDeviceConfigDescriptor routine no longer modifies ConfigSizePtr if a valid buffer
861 * - Added ALLOCABLE_BYTES to DynAlloc, and added code to make the size of key storage variables
862 * dependant on size of memory parameters passed in via the user project's makefile
863 * - Fixed incorrect device reset routine being called in USBTask
864 * - Devices which do not connect within the standard 300mS are now supported
865 * - Removed incorrect ATTR_PURE from Scheduler_SetTaskMode(), which was preventing tasks from being
866 * started/stopped, as well as USB_InitTaskPointer(), which was breaking dual device/host USB projects
867 * - Changed scheduler to use the task name rather than IDs for setting the task mode, eliminating the
868 * need to have a task ID list
869 * - ID transistion interrupt now raises the appropriate device/host disconnect event if device attached
870 * - Fixed double VBUS change (and VBUS -) event when detatching in device mode
871 * - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile
872 * - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and
873 * Endpoint_IsConfigured() after calling the config functions to determine success
projects / pub / USBasp.git / blob