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