3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
7 /** \page Page_ChangeLog Project Changelog
9 * \section Sec_ChangeLogXXXXXX Version XXXXXX
11 * - Added new GenericHIDHost demo
12 * - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use
13 * - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR
14 * - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile
16 * - All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected
17 * - Added new PIMA_DATA_SIZE() define to the Still Image Host demo
18 * - Add call to MassStore_WaitForDataReceived() in MassStore_GetReturnedStatus() to ensure that the CSW has been received in the
19 * extended MSC timeout period before continuing, to prevent long processing delays from causing the MassStore_GetReturnedStatus()
20 * to early-abort (thanks to Dmitry Maksimov)
21 * - Move StdRequestType.h, StreamCallbacks.h, USBMode.h from the LowLevel USB driver directory to the HighLevel USB driver directory,
22 * where they are more suited
23 * - Removed all binary constants and replaced with decimal or hexadecimal constants so that unpatched GCC compilers can still build the
24 * code without having to be itself patched and recompiled first
25 * - Added preprocessor checks and documentation to the bootloaders giving information about missing SIGNATURE_x defines due to
26 * outdated avr-libc versions.
27 * - Added support to the CDCHost demo for devices with mutiple CDC interfaces which are not the correct ACM type preceeding the desired
29 * - Fixed GenericHID demo not starting USB and HID management tasks when not using interrupt driven modes (thanks to Carl Kjeldsen)
30 * - Fixed RNDISEthenet demo checking the incorrect message field for packet size constraints (thanks to Jonathan)
31 * - Fixed WriteNextReport code in the GenericHIDHost demo using incorrect parameter types and not selecting the correct endpoint
33 * \section Sec_ChangeLog090401 Version 090401
35 * - Fixed MagStripe project configuration descriptor containing an unused (blank) endpoint descriptor
36 * - Incorporated makefile changes by Denver Gingerich to retain compatibility with stock (non-WinAVR) AVR-GCC installations
37 * - Fixed makefile EEPROM programming targets programming FLASH data in addition to EEPROM data
38 * - LUFA devices now enumerate correctly with LUFA hosts
39 * - Fixed Configuration Descriptor search routine freezing when a comparitor returned a failure
40 * - Removed HID report item serial dump in the MouseHostWithParser and KeyboardHostWithParser - useful only for debugging, and
41 * slowed down the enumeration of HID devices too much
42 * - Increased the number of bits per track which can be read in the MagStripe project to 8192 when compiled for the AT90USBXXX6/7
43 * - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request
44 * - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission
45 * next time the device is attached to a host.
46 * - 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
47 * clock prescaling is performed) frequency, so that the PLL prescale mask can be determined
48 * - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with
49 * badly designed hosts or devices which greatly exceed the USB specification limits
50 * - Mass Storage Host demo now uses a USB_STREAM_TIMEOUT_MS of two seconds to maintain compatibility with poorly designed devices
51 * - Function attribute ATTR_ALWAYSINLINE renamed to ATTR_ALWAYS_INLINE to match other function attribute macro naming conventions
52 * - Added ATTR_ALWAYS_INLINE attribute to several key inlined library components, to ensure they are inlined in all circumstances
53 * - Removed SetSystemClockPrescaler() macro, the clock_prescale_set() avr-libc macro has been corrected in recent avr-libc versions
54 * - Fixed incorrect/missing control status stage transfers on demos, bootloaders and applications (thanks to Nate Lawson)
55 * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
56 * to also remove parts of the Get Status chapter 9 request to further reduce code usage
57 * - Makefile updated to include output giving the currently selected BOARD parameter value
58 * - Board Dataflash driver now allows for dataflash ICs which use different shifts for setting the current page/byte address (thanks
60 * - Added DataflashManager_WriteBlocks_RAM() and DataflashManager_ReadBlocks_RAM() functions to the MassStorage demo, to allow for easy
61 * interfacing with a FAT library for dataflash file level access
62 * - Corrected CDC class bootloader to fix a few bugs, changed address counter to store x2 addresses for convenience
63 * - Fixed typos in the SPI driver SPI_SPEED_FCPU_DIV_64 and SPI_SPEED_FCPU_DIV_128 masks (thanks to Markus Zocholl)
64 * - Keyboard and Mouse device demos (normal, data interrupt and fully interrupt driven) combined into unified keyboard and mouse demos
65 * - Keyboard and Mouse host demos (normal and data interrupt driven) combined into unified keyboard and mouse demos
66 * - Removed AVRISP_Programmer project due to code quality concerns
67 * - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incomming data
68 * - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)
69 * - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)
70 * - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)
71 * - Added new GenericHID device demo application
72 * - Fixed Still Image Host SImage_SendData() function not clearing the pipe bank after sending data
75 * \section Sec_ChangeLog090209 Version 090209
77 * - PWM timer mode in AudioOut demo changed to Fast PWM for speed
78 * - Updated Magstripe project to work with the latest hardware revision
79 * - Fixed library not responding to the BCERRI flag correctly in host mode, leading to device lockups
80 * - Fixed library handling Get Descriptor requests when not addressed as standard requests to the device or interface (thanks to
82 * - Fixed serious data corruption issue in MassStorage demo dataflash write routine
83 * - Added new NO_CLEARSET_FEATURE_REQUEST compile time token
84 * - USB task now restores previous global interrupt state after execution, rather than forcing global interrupts to be enabled
85 * - Fixed USB_DeviceEnumerationComplete event firing after each configuration change, rather than once after the initial configuration
86 * - Added ENDPOINT_DOUBLEBANK_SUPPORTED() macros to Endpoint.h, altered ENDPOINT_MAX_SIZE() to allow user to specify endpoint
87 * - ENDPOINT_MAX_ENDPOINTS changed to ENDPOINT_TOTAL_ENDPOINTS, PIPE_MAX_PIPES changed to PIPE_TOTAL_PIPES
88 * - Endpoint and Pipe non-control stream functions now ensure endpoint or pipe is ready before reading or writing
89 * - Changed Teensy bootloader to use a watchdog reset when exiting rather than a software jump
90 * - Fixed integer promotion error in MassStorage and MassStorageHost demos, corrupting read/write transfers
91 * - SPI_SendByte is now SPI_TransferByte, added new SPI_SendByte and SPI_ReceiveByte functions for fast one-way transfer
92 * - MassStorage demo changed to use new fast one-way SPI transfers to increase throughput
93 * - MassStorage handling of Mass Storage Reset class request improved
94 * - Altered MassStorage demo dataflash block read code for speed
95 * - Added USB_IsSuspended global flag
96 * - Simplified internal Dual Mode (OTG) USB library code to reduce code size
97 * - Extended stream timeout period to 100ms from 50ms
98 * - Mass Storage Host demo commands now all return an error code from the Pipe_Stream_RW_ErrorCodes_t enum
99 * - Added SubErrorCode parameter to the USB_DeviceEnumerationFailed event
100 * - VBUS drop interrupt now disabled during the manual-to-auto VBUS delivery handoff
101 * - Simplified low level backend so that device/host mode initialization uses the same code paths
102 * - Added workaround for faulty Mass Storage devices which do not implement the required GET_MAX_LUN request
103 * - Removed buggy Telnet application from the RNDIS demo
104 * - Moved Mass Storage class requests in the Mass Storage Host demo to wrapper functions in MassStoreCommands.c
105 * - Fixed incorrect SCSI command size value in the Request Sense command in MassStoreCommands.c
106 * - Added SetProtocol request to HID class non-parser Mouse and Keyboard demos to force devices to use the correct Boot Protocol
107 * - Added new "dfu" and "flip" programming targets to project makefiles
108 * - HID_PARSE_Sucessful enum member typo corrected to HID_PARSE_Successful
109 * - Changed COLLECTION item strucutres in the HID descriptor parser to include the collection's Usage Page value
110 * - Serial driver now sets Tx line as output, enables pullup on Rx line
111 * - Fixed smaller USB AVRs raising multiple connection and disconnection events when NO_LIMITED_CONTROLLER_CONNECT is disabled
112 * - Added HOST_DEVICE_SETTLE_DELAY_MS to give the host delay after a device is connected before it is enumerated
113 * - Fixed KeyboardHostWithParser demo linking against the wrong global variables
114 * - Completed doxygen documentation of remaining library bootloaders, demos and projects
115 * - Fixed incorrect bootloader start address in the TeensyHID bootloader
116 * - Added HWB button whole-disk ASCII dump functionality to MassStoreHost demo
117 * - Replaced printf_P(PSTR("%c"), {Variable}) calls with putchar(<Variable>) for speed and size savings
118 * - Serial driver now accepts baud rates over 16-bits in size, added double speed flag option
119 * - Fixed incorrect callback abort return value in Pipe.c
120 * - Added new flip-ee and dfu-ee makefile targets (courtesy of Opendous Inc.)
121 * - Removed reboot-on-disconnect code from the TeensyHID bootloader, caused problems on some systems
122 * - Fixed AudioOutput and AudioInput demos looping on the endpoint data, rather than processing a sample at a time and returning
123 * each time the task runs to allow for other tasks to execute
124 * - Added support for the Atmel ATAVRUSBRF01 board
125 * - Added AVRISP Programmer Project, courtesy of Opendous Inc.
126 * - Fixed CDC Host demo not searching through both CDC interfaces for endpoints
127 * - Fixed incorrect Product String descriptor length in the DFU class bootloader
130 * \section Sec_ChangeLog081224 Version 081224
132 * - MyUSB name changed to LUFA, the Lightweight USB Framework for AVRs
133 * - Fixed Mass Storage Host demo's MassStore_SendCommand() delay in the incorrect place
134 * - Fixed USBtoSerial demo not calling ReconfigureUSART() after a change in the line encoding
135 * - Fixed infinite loop in host mode Host-to-Device control transfers with data stages
136 * - HID report parser now supports devices with multiple reports in one interface via Report IDs
137 * - Fixed RZUSBSTICK board LED driver header incorrect macro definition order causing compile errors
138 * - Calling USB_Init() when the USB interface is already configured now forces a complete interface reset
139 * and re-enumeration - fixes MyUSB DFU bootloader not switching to app code correctly when soft reset used
140 * - Fixed "No newline at end of file" warning when stream callbacks are enabled
141 * - DFU bootloader now uses fixed signature bytes per device, rather than reading them out dynamically for size
142 * - Added new FIXED_CONTROL_ENDPOINT_SIZE and USE_SINGLE_DEVICE_CONFIGURATION switches to statically define certain values to
143 * reduce compiled binary size
144 * - Added new NO_LIMITED_CONTROLLER_CONNECT switch to prevent the library from trying to determine bus connection
145 * state from the suspension and wake up events on the smaller USB AVRs
146 * - Added summary of all library compile time tokens to the documentation
147 * - Added overview of the LUFA scheduler to the documentation
148 * - Removed MANUAL_PLL_CONTROL compile time token, replaced with a mask for the USB_Init() Options parameter
149 * - CDC bootloader now uses the correct non-far or far versions of the pgm_* functions depending on if RAMPZ is defined
150 * - Doxygen documentation now contains documentation on all the projects, bootloaders and most demos included with the library
151 * - CDC bootloader now runs user application when USB disconnected rather than waiting for a hard reset
152 * - MouseHostWithParser and KeyboardHostWithParser now support multiple-report devices
153 * - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver
154 * - Fixed the DFU bootloader, no longer freezes up when certain files are programmed into an AVR, made reading/writing faster
155 * - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal
156 * right-handed system
157 * - Added stub code to the CDC and USBtoSerial demos showing how to read and set the RS-232 handshake lines - not currently used in
158 * the demos, but the example code and supporting defines are now in place
159 * - Interrupts are now disabled when processing a control request in device mode, to avoid exceeding the strict control request
160 * timing requirements.
161 * - All demos now use a central StatusUpdate() function rather than direct calls to the board LED functions, so that the demos can
162 * easily be altered to show different LED combinations (or do something else entirely) as the demo's status changes
163 * - Removed LED commands from the CDC bootloader, unused by most AVR910 programming software
164 * - Fixed RNDIS demo ICMP ping requests echoing back incorrect data
165 * - Added DHCP server code to RNDIS demo, allowing for hands-free autoconfiguration on any PC
166 * - Fixed DFU bootloader PID value for the ATMEGA16U4 AVR
167 * - Endpoint and Pipe configuration functions now return an error code indicating success or failure
168 * - USB Reset in device mode now resets and disables all device endpoints
169 * - Added intermediate states to the host mode state machine, reducing the USB task blocking time to no more than 1ms explicitly per
170 * invocation when in host mode
171 * - Added support for the ATMEGA32U6 microcontroller
172 * - Added STATIC_ENDPOINT_CONFIGURATION compile time option, enabled in the bootloaders to minimize space usage
173 * - Removed redudant code from the USB device GetStatus() chapter 9 processing routine
174 * - Added new TeensyHID bootloader, compatible with the Teensy HID protocol (http://www.pjrc.com/teensy/)
175 * - Versions are now numbered by release dates, rather than arbitrary major/minor revision numbers
176 * - USB_RemoteWakeupEnabled is now correctly set and cleared by SetFeature and ClearFeature requests from the host
177 * - Changed prototype of GetDescriptor, so that it now returns the descriptor size (or zero if the descriptor doesn't exist)
178 * rather than passing the size back to the caller through a parameter and returning a boolean
181 * \section Sec_ChangeLog153 Version 1.5.3 - Released 2nd October, 2008
183 * - Fixed CDC bootloader using pgmspace macros for some descriptors inappropriately
184 * - Updated all Mouse and Keyboard device demos to include boot protocol support (now works in BIOS)
185 * - Renamed bootloader directories to remove spaces, which were causing build problems on several OSes
186 * - Removed serial number strings from all but the MassStore demo where it is required - users were not
187 * modifing the code to either ommit the descriptor or use a unique serial per device causing problems
188 * when multiple units of the same device were plugged in at the same time
189 * - AudioOutput and AudioInput demos now correctly silence endpoints when not enabled by the host
190 * - Added KeyboardMouse demo (Keyboard and Mouse functionality combined into a single demo)
191 * - Added DriverStubs directory to house board level driver templates, to make MyUSB compatible custom board
192 * driver creation easier
193 * - Extended MassStorage demo to support multiple LUNs, 2 by default
194 * - Fixed incorrect device address mask, preventing the device from enumerating with addresses larger than 63
195 * - Fixed incorrect data direction mask in the GetStatus standard request, preventing it from being handled
196 * - Fixed incorrect GetStatus standard request for endpoints, now returns the endpoint STALL status correctly
197 * - Added in new USB_RemoteWakeupEnabled and USB_CurrentlySelfPowered flags rather than using fixed values
198 * - Added DualCDC demo to demonstrate the use of Interface Association Descriptors
199 * - Added pipe NAK detection and clearing API
200 * - Added pipe status change (NAK, STALL, etc.) interrupt API
201 * - Fixed MassStorageHost demo so that it no longer freezes randomly when issuing several commands in a row
202 * - Host demos configuration descriptor routines now return a unique error code when the returned data does
203 * not have a valid configuration descriptor header
204 * - Added Endpoint_WaitUntilReady() and Pipe_WaitUntilReady() functions
205 * - Stream functions now have software timeouts, timeout period can be set by the USB_STREAM_TIMEOUT_MS token
206 * - All demos now pass the USB.org automated Chapter 9 device compliance tests
207 * - All HID demos now pass the USB.org automated HID compliance tests
208 * - Polling interval of the interrupt endpoint in the CDC based demos changed to 0xFF to fix problems on Linux systems
209 * - Changed stream functions to accept a new callback function, with NO_STREAM_CALLBACKS used to disable all callbacks
210 * - Mass Storage demo dataflash management routines changed to use the endpoint stream functions
211 * - Added AVRStudio project files for each demo in addition to the existing Programmer's Notepad master project file
212 * - Re-added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
213 * are reflected in the hardware (change was previously lost)
216 * \section Sec_ChangeLog152 Version 1.5.2 - Released 31st July, 2008
218 * - Fixed SwapEndian_32() function in Common.h so that it now works correctly (wrong parameter types)
219 * - Updated RNDIS demo - notification endpoint is no longer blocking so that it works with faulty Linux RNDIS
220 * implementations (where the notification endpoint is ignored in favour of polling the control endpoint)
221 * - Fixed incorrect Vendor Description string return size in RNDIS demo for the OID_GEN_VENDOR_DESCRIPTION OID token
222 * - Added very basic TCP/IP stack and HTTP/TELNET servers to RNDIS demo
223 * - Fixed DFU bootloader exit causing programming software to complain about failed writes
224 * - Fixed DFU bootloader EEPROM programming mode wiping first flash page
225 * - Fixed Clear/Set Feature device standard request processing code (fixing MassStorage demo in the process)
226 * - Added support for the ATMEGA16U4 AVR microcontroller
227 * - Library licence changed from LGPLv3 to MIT license
230 * \section Sec_ChangeLog151 Version 1.5.1 - Released 31st July, 2008
232 * - Changed host demos to enable the host function task on the firing of the USB_DeviceEnumerationComplete event
233 * rather than the USB_DeviceAttached event
234 * - HID Usage Stack now forcefully cleared after an IN/OUT/FEATURE item has been completely processed to remove
235 * any referenced but not created usages
236 * - Changed USB_INT_DisableAllInterrupts() and USB_INT_ClearAllInterrupts(), USB_Host_GetNextDescriptorOfType(),
237 * USB_Host_GetNextDescriptorOfTypeBefore(), USB_Host_GetNextDescriptorOfTypeAfter() to normal functions (from inline)
238 * - Fixed USBtoSerial demo not sending data, only receiving
239 * - Fixed main makefile to make all by default, fixed MagStripe directory case to prevent case-sensitive path problems
240 * - ConfigDescriptor functions made normal, instead of static inline
241 * - Pipe/Endpoint *_Ignore_* functions changed to *_Discard_*, old names still present as aliases
242 * - Fixed ENDPOINT_MAX_SIZE define to be correct on limited USB controller AVRs
243 * - Changed endpoint and pipe size translation routines to use previous IF/ELSE IF cascade code, new algorithmic
244 * approach was buggy and caused problems
245 * - Bootloaders now compile with -fno-inline-small-functions option to reduce code size
246 * - Audio demos now use correct endpoint sizes for full and limited controller USB AVRs, double banking in all cases
247 * to be in line with the specification (isochronous endpoints MUST be double banked)
248 * - Added Interface Association descriptor to StdDescriptors.h, based on the relevant USB2.0 ECN
249 * - Fixed MIDI demo, corrected Audio Streaming descriptor to follow the MIDI-specific AS structure
250 * - Fixed HID class demo descriptors so that the HID interface's protocol is 0x00 (required for non-boot protocol HID
251 * devices) to prevent problems on hosts expecting the boot protocol functions to be supported
252 * - Added read/write control stream functions to Endpoint.h
253 * - Fixed AudioOut demo not setting port pins to inputs on USB disconnect properly
254 * - Added RNDISEthernet demo application
257 * \section Sec_ChangeLog150 Version 1.5.0 - Released 10 June, 2008
259 * - Fixed MIDI demo, now correctly waits for the endpoint to be ready between multiple note messages
260 * - Added CDC Host demo application
261 * - Added KeyboardFullInt demo application
262 * - Endpoint and Pipe creation routines now mask endpoint/pipe size with the size mask, to remove transaction
263 * size bits not required for the routines (improves compatibility with devices)
264 * - Fixed AudioInput demo - now correctly sends sampled audio to the host PC
265 * - Fixed AudioOutput demo oncemore -- apparently Windows requires endpoint packets to be >=192 bytes
266 * - Shrunk round-robbin scheduler code slightly via the use of struct pointers rather than array indexes
267 * - Fixed off-by-one error when determining if the Usage Stack is full inside the HID Report parser
268 * - Renamed Magstripe.h to MagstripeHW.h and moved driver out of the library and into the MagStripe demo folder
269 * - Added preprocessor checks to enable C linkage on the library components when used with a C++ compiler
270 * - Added Still Image Host demo application
271 * - The USB device task now restores the previously selected endpoint, allowing control requests to be transparently
272 * handled via interrupts while other endpoints are serviced through polling
273 * - Fixed device signature being sent in reverse order in the CDC bootloader
274 * - Host demos now have a seperate ConfigDescriptor.c/.h file for configuration descriptor processing
275 * - HostWithParser demos now have a seperate HIDReport.c/.h file for HID report processing and dumping
276 * - Removed non-mandatory commands from MassStorage demo to save space, fixed SENSE ResponseCode value
277 * - CDC demos now send empty packets after sending a full one to prevent buffering issues on the host
278 * - Updated demo descriptors to use VID/PID values donated by Atmel
279 * - Added DoxyGen documentation to the source files
280 * - Fixed Serial_IsCharRecieved() definition, was previously reversed
281 * - Removed seperate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead
282 * - Removed unused Device Qualifier descriptor structure
283 * - Renamed the USB_CreateEndpoints event to the more appropriate USB_ConfigurationChanged
284 * - Fixed MassStorageHost demo reading in the block data in reverse
285 * - Removed outdated typedefs in StdRequestType.h, superceeded by the macro masks
286 * - Corrected OTG.h is now included when the AVR supports both Host and Device modes, for creating OTG products
287 * - USB_DeviceEnumerationComplete event is now also fired when in device mode and the host has finished its enumeration
288 * - Interrupt driven demos now properly restore previously selected endpoint when ISR is complete
289 * - USB_HOST_TIMEOUT_MS is now overridable in the user project makefile to a custom fixed timeout value
290 * - Renamed USB_Host_SOFGeneration_* macros to more friendly USB_Host_SuspendBus(), USB_Host_ResumeBus()
291 * and USB_Host_IsBusSuspended()
292 * - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistant, Pipe_SetInterruptFreq() is now
293 * Pipe_SetInterruptPeriod() to use the correct terminology
294 * - UnicodeString member of USB_Descriptor_String_t struct changed to an ordinary int array type, so that the GCC
295 * Unicode strings (prefixed with an L before the opening quotation mark) can be used instead of explicit arrays
296 * of ASCII characters
297 * - Fixed Endpoint/Pipes being configured incorrectly if the maximum endpoint/pipe size for the selected USB AVR
298 * model was given as the bank size
299 * - HID device demos now use a true raw array for the HID report descriptor rather than a struct wrapped array
300 * - Added VERSION_BCD() macro, fixed reported HID and USB version numbers in demo descriptors
301 * - Cleaned up GetDescriptor device chapter 9 handler function
302 * - Added GET_REPORT class specific request to HID demos to make them complaint to the HID class
303 * - Cleaned up setting of USB_IsInitialized and USB_IsConnected values to only when needed
304 * - Removed Atomic.c and ISRMacro.h; the library was already only compatible with recent avr-lib-c for other reasons
305 * - All demos and library functions now use USB standardized names for the USB data (bRequest, wLength, etc.)
306 * - Added USE_NONSTANDARD_DESCRIPTOR_NAMES token to switch back to the non-standard descriptor element names
309 * \section Sec_ChangeLog141 Version 1.4.1 - Released 5 May, 2008
311 * - Enhanced KeyboardWithParser demo, now prints out pressed alphanumeric characters like the standard demo
312 * - Fixed MassStorage demo, read/writes using non mode-10 commands now work correctly
313 * - Corrected version number in Version.h
316 * \section Sec_ChangeLog140 Version 1.4.0 - Released 5 May, 2008
318 * - Added HID Report Parser API to the library
319 * - Added Mouse and Keyboard host demo applications, using the new HID report parser engine
320 * - Added MouseFullInt demo, which demonstrates a fully interrupt (including control requests) mouse device
321 * - Fixed incorrect length value in the audio control descriptor of the AudioOutput and AudioInput demos
322 * - Added MIDI device demo application to the library
323 * - Fixed problem preventing USB devices from being resumed from a suspended state
324 * - Added new CDC class bootloader to the library, based on the AVR109 bootloader protocol
325 * - Added header to each demo application indicating the mode, class, subclass, standards used and supported speed
326 * - Functions expecting endpoint/pipe numbers are no longer automatically masked against ENDPOINT_EPNUM_MASK or
327 * PIPE_PIPENUM_MASK - this should be manually added to code which requires it
328 * - Fixed DFU class bootloader - corrected frequency of flash page writes, greatly reducing programming time
329 * - Renamed AVR_HOST_GetDeviceConfigDescriptor() to USB_Host_GetDeviceConfigDescriptor() and AVR_HOST_GetNextDescriptor()
330 * to USB_Host_GetNextDescriptor()
331 * - Added new USB_Host_GetNextDescriptorOfTypeBefore() and USB_Host_GetNextDescriptorOfTypeAfter() routines
332 * - Moved configuration descriptor routines to MyUSB/Drivers/USB/Class/, new accompanying ConfigDescriptors.c file
333 * - Added new configuration descriptor comparator API for more powerful descriptor parsing, updated host demos to use the
335 * - Fixed MassStorageHost demo capacity printout, and changed data read/write mode from little-endian to the correct
336 * big-endian for SCSI devices
337 * - Fixed macro/function naming consistancy; USB_HOST is now USB_Host, USB_DEV is now USB_Device
338 * - Added better error reporting to host demos
339 * - Added 10 microsecond delay after addressing devices in host mode, to prevent control stalls
342 * \section Sec_ChangeLog132 Version 1.3.2 - Released April 1st, 2008
344 * - Added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
345 * are reflected in the hardware
346 * - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the
347 * GetLineCoding request had an incorrect RequestType mask preventing it from being processed
348 * - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full
349 * - Device control endpoint size is now determined from the device's descriptors rather than being fixed
350 * - Seperated out SPI code into new SPI driver in AT90USBXXX driver directory
351 * - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID
352 * - Added support for the RZUSBSTICK board
353 * - Bicolour driver removed in favour of generic LEDs driver
354 * - Added support for the ATMEGA32U4 AVR
355 * - Added MANUAL_PLL_CONTROL compile time option to prevent the USB library from manipulating the PLL
358 * \section Sec_ChangeLog131 Version 1.3.1 - Released March 19th 2008
360 * - Fixed USB to Serial demo - class value in the descriptors was incorrect
361 * - Control endpoint size changed from 64 bytes to 8 bytes to save on USB FIFO RAM and to allow low
362 * speed mode devices to enumerate properly
363 * - USB to Serial demo data endpoints changed to dual-banked 16 byte to allow the demo to work
364 * on USB AVRs with limited USB FIFO RAM
365 * - Changed demo endpoint numbers to use endpoints 3 and 4 for double banking, to allow limited
366 * USB device controller AVRs (AT90USB162, AT90USB82) to function correctly
367 * - Updated Audio Out demo to use timer 1 for AVRs lacking a timer 3 for the PWM output
368 * - Fixed incorrect USB_DEV_OPT_HIGHSPEED entry in the Mass Storage device demo makefile
369 * - Optimized Mass Storage demo for a little extra transfer speed
370 * - Added LED indicators to the Keyboard demo for Caps Lock, Num Lock and Scroll Lock
371 * - Added Endpoint_Read_Stream, Endpoint_Write_Stream, Pipe_Read_Stream and Pipe_Write_Stream functions
372 * (including Big and Little Endian variants)
373 * - Made Dataflash functions inline for speed, removed now empty Dataflash.c driver file
374 * - Added new SetSystemClockPrescaler() macro (thanks to Joerg Wunsch)
375 * - Fixed Endpoint_ClearStall() to function correctly on full USB controller AVRs (AT90USBXXX6/7)
376 * - Endpoint_Setup_In_Clear() and Endpoint_Setup_Out_Clear() no longer set FIFOCON, in line with the
377 * directives in the datasheet
378 * - Fixed PLL prescaler defines for all AVR models and frequencies
379 * - Fixed ENDPOINT_INT_IN and ENDPOINT_INT_OUT definitions
380 * - Added interrupt driven keyboard and mouse device demos
381 * - Combined USB_Device_ClearFeature and USB_Device_SetFeature requests into a single routine for code
383 * - Added missing Pipe_GetCurrentPipe() macro to Pipe.h
386 * \section Sec_ChangeLog130 Version 1.3.0 - Released March 7th 2008
388 * - Unneccesary control endpoint config removed from device mode
389 * - Fixed device standard request interpreter accidentally processing some class-specific requests
390 * - Added USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS compile time options to instruct the library
391 * to use descriptors stored in RAM or EEPROM rather than flash memory
392 * - All demos now disable watchdog on startup, in case it has been enabled by fuses or the bootloader
393 * - USB_DEV_OPT_LOWSPEED option now works correctly
394 * - Added ability to set the USB options statically for a binary size reduction via the USE_STATIC_OPTIONS
395 * compile time define
396 * - USB_Init no longer takes a Mode parameter if compiled for a USB device with no host mode option, or
397 * if forced to a particular mode via the USB_HOST_ONLY or USB_DEVICE_ONLY compile time options
398 * - USB_Init no longer takes an Options parameter if options statically configured by USE_STATIC_OPTIONS
399 * - Endpoint_Ignore_* and Pipe_Ignore_* made smaller by making the dummy variable non-volatile so that the
400 * compiler can throw away the result more efficiently
401 * - Added in an optional GroupID value to each scheduler entry, so that groups of tasks can once again be
402 * controlled by the new Scheduler_SetGroupTaskMode() routine
403 * - Added support for AT90USB162 and AT90USB82 AVR models
404 * - Added support for the STK525 and STK526 boards
405 * - Added support for custom board drivers to be supplied by selecting the board type as BOARD_USER, and
406 * placing board drivers in {Application Directory}/Board/
407 * - PLL is now stopped and USB clock is frozen when detatched from host in device mode, to save power
408 * - Joystick defines are now in synch with the schematics - orientation will be rotated for the USBKEY
409 * - Fixed USB_DEV_IsUSBSuspended() - now checks the correct register
410 * - Fixed data transfers to devices when in host mode
411 * - Renamed USB_DEV_OPT_HIGHSPEED to USB_DEV_OPT_FULLSPEED and USB_HOST_IsDeviceHighSpeed() to
412 * USB_HOST_IsDeviceFullSpeed() to be in line with the official USB speed names (to avoid confusion with
413 * the real high speed mode, which is unavailable on the USB AVRs)
416 * \section Sec_ChangeLog120 Version 1.2.0 - Released February 4th, 2008
418 * - Added USB_DeviceEnumerationComplete event for host mode
419 * - Added new Scheduler_Init routine to preprepare the scheduler, so that tasks can be started and
420 * stopped before the scheduler has been started (via Scheduler_Start)
421 * - Connection events in both Device and Host mode are now interrupt-driven, allowing the USB management
422 * task to be stopped when the USB is not connected to a host or device
423 * - All demos updated to stop the USB task when not in use via the appropriate USB events
424 * - Mass Storage Host demo application updated to function correctly with all USB flash disks
425 * - Mass Storage Host demo application now prints out the capacity and number of LUNs in the attached
426 * device, and prints the first block as hexadecimal numbers rather than ASCII characters
427 * - Endpoint and Pipe clearing routines now clear the Endpoint/Pipe interrupt and status flags
428 * - Shifted error handling code in the host enum state machine to a single block, to reduce code complexity
429 * - Added in DESCRIPTOR_TYPE, DESCRIPTOR_SIZE and DESCRIPTOR_CAST macros to make config descriptor processing
430 * clearer in USB hosts and DESCRIPTOR_ADDRESS for convenience in USB devices
431 * - Added in alloca macro to common.h, in case the user is using an old version of avr-lib-c missing the macro
434 * \section Sec_ChangeLog130 Version 1.1.0 - Released January 25th 2008
436 * - Fixed DCONNI interrupt being enabled accidentally after a USB reset
437 * - Fixed DDISCI interrupt not being disabled when a device is not connected
438 * - Added workaround for powerless pullup devices causing false disconnect interrupts
439 * - Added USB_DeviceEnumerationFailed event for Host mode
440 * - AVR_HOST_GetDeviceConfigDescriptor routine no longer modifies ConfigSizePtr if a valid buffer
442 * - Added ALLOCABLE_BYTES to DynAlloc, and added code to make the size of key storage variables
443 * dependant on size of memory parameters passed in via the user project's makefile
444 * - Fixed incorrect device reset routine being called in USBTask
445 * - Devices which do not connect within the standard 300mS are now supported
446 * - Removed incorrect ATTR_PURE from Scheduler_SetTaskMode(), which was preventing tasks from being
447 * started/stopped, as well as USB_InitTaskPointer(), which was breaking dual device/host USB projects
448 * - Changed scheduler to use the task name rather than IDs for setting the task mode, eliminating the
449 * need to have a task ID list
450 * - ID transistion interrupt now raises the appropriate device/host disconnect event if device attached
451 * - Fixed double VBUS change (and VBUS -) event when detatching in device mode
452 * - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile
453 * - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and
454 * Endpoint_IsConfigured() after calling the config functions to determine success
projects / pub / USBasp.git / blob