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