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