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