Fixed possible invalid program execution when in host mode if corrupt descriptor...
[pub/USBasp.git] / LUFA / ManPages / ChangeLog.txt
index e16a33d..9944515 100644 (file)
   *
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX
   *  <b>New:</b>
-  *  - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously
-  *    not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger)
-  *  - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c
-  *  - Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett)
-  *  - Added board hardware driver support for the Kernel Concepts USBFOO development board
-  *  - Added new USB_Device_GetFrameNumber() and USB_Host_GetFrameNumber() functions to retrieve the current USB frame number
-  *  - Added new USB_Host_EnableSOFEvents(), USB_Host_DisableSOFEvents() and EVENT_USB_Host_StartOfFrame() for the user application
-  *    handling of USB Start of Frame events while in USB Host mode
-  *  - Added new PRNT_Host_BytesReceived(), PRNT_Host_ReceiveByte(), PRNT_Host_SendByte() and PRNT_Host_Flush() functions to the
-  *    Print Host Class driver
-  *  - Added class specific descriptor alternative struct type defines with standard USB-IF element naming
-  *  - Added new project makefile template to the library and moved board driver stub files into in a new "CodeTemplates" directory
-  *  - Added board hardware driver support for the Linnix UDIP development board
-  *  - Added board hardware driver support for the Busware BUI development board
-  *  - Added board hardware driver support for the Arduino Uno development board
-  *  - Added board hardware driver support for the Busware CUL V3 868MHZ radio board
+  *  - Core:
+  *   - Added new ORDERED_EP_CONFIG compile time option to restrict endpoint/pipe configuration to ascending order
+  *     in exchange for a smaller compiled program binary size
+  *   - Added a new general RingBuff.h miscellaneous ring buffer library driver header
+  *   - Added new GCC_FORCE_POINTER_ACCESS() macro to correct GCC's mishandling of struct pointer accesses
+  *   - Added new GCC_MEMORY_BARRIER() macro to prevent instruction reordering across boundaries
+  *   - Added basic driver example use code to the library documentation
+  *   - Added new Endpoint_Null_Stream() and Pipe_Null_Stream() functions
+  *   - Added new ADC_GET_CHANNEL_MASK() convenience macro
+  *   - Added new HID report item macros (with HID_RI_ prefix) to allow for easy creation and editing of HID report descriptors
+  *   - Added new HID_DESCRIPTOR_MOUSE(), HID_DESCRIPTOR_KEYBOARD(), HID_DESCRIPTOR_JOYSTICK() and HID_DESCRIPTOR_VENDOR() macros
+  *     for easy automatic creation of basic USB HID device reports
+  *   - Added new MAX() and MIN() convenience macros
+  *   - Added new Serial_SendData() function to the Serial driver
+  *   - Added board driver support for the Sparkfun ATMEGA8U2 breakout board
+  *   - Added TWI baud rate prescaler and bit length parameters to the TWI_Init() function (thanks to Thomas Herlinghaus)
+  *   - Internal restructuring for eventual multiple architecture ports
+  *   - Added AVR32 UC3 architecture port (currently incomplete/experimental)
+  *   - Added new architecture independant functions to enable, disable, save and restore the Global Interrupt Enable flags
+  *   - Added USE_LUFA_CONFIG_HEADER compile time option to include a LUFAConfig.h header in the user director for LUFA configuration
+  *     tokens as an alternative to tokens defined in the project makefile
+  *  - Library Applications:
+  *   - Added ability to write protect Mass Storage disk write operations from the host OS
+  *   - Added new MIDIToneGenerator project
+  *   - Added new KeyboardMouseMultiReport Device ClassDriver demo
+  *   - Added new VirtualSerialMassStorage Device ClassDriver demo
+  *   - Added HID class bootloader, compatible with a modified version of the command line Teensy loader from PJRC.com
+  *   - Added LED flashing to the CDC and DFU class bootloaders to indicate when they are running
+  *   - Added new incomplete AndroidAccessoryHost Host LowLevel demo
   *
   *  <b>Changed:</b>
-  *  - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions
-  *    depending of if the given bank size is a compile time constant, as the compiler does a better job of optimizing
-  *    with basic code
-  *  - Changed over all device demos to use a clearer algorithm for the configuring of the application's endpoints
-  *  - Added missing DataflashManager_CheckDataflashOperation() function to the MassStorageKeyboard demo, removed redundant
-  *    SCSI_Codes.h file as these values are part of the MassStorage Class Driver
-  *  - Added compile time error to the AVRISP-MKII project when built for the U4 chips, as the default VTARGET detection ADC channel
-  *    does not exist on these chips (thanks to Marco)
-  *  - Changed all Device mode LowLevel demos and Device Class drivers so that the control request is acknowledged and any data
-  *    transferred as quickly as possible without any processing inbetween sections, so that long callbacks or event handlers will
-  *    not break communications with the host by exceeding the maximum control request stage timeout period
-  *  - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove
-  *    the need for extra casting inside the callback (thanks to Jonathan Kollasch)
-  *  - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode
-  *  - Changed over all demos, drivers and internal functions to use the current frame number over the Start of Frame flag where possible
-  *    to free up the Start of Frame flag for interrupt use in the user application
-  *  - All project makefiles now correctly clean intermediate build files from assembly and C++ sources (thanks to Daniel Czigany)
-  *  - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode
-  *  - Renamed and moved class driver common constant definitions to make the naming scheme more uniform
-  *  - Changed default value for the reset polarity parameter in the AVRISP-MKII project so that it defaults to active low drive
-  *  - Changed configuration descriptor parser for all host mode projects and class drivers to ensure better compatibility with devices
+  *  - Core:
+  *   - Unordered Endpoint/Pipe configuration is now allowed once again by default via the previous reconfig workaround
+  *   - Refactored Host mode Class Driver *_Host_ConfigurePipes() routines to be more space efficient when compiled
+  *   - Added new *_ENUMERROR_PipeConfigurationFailed error codes for the *_Host_ConfigurePipes() routines
+  *   - The USARTStream global is now public and documented in the SerialStream module, allowing for the serial USART
+  *     stream to be accessed via its handle rather than via the implicit stdout and stdin streams
+  *   - The FAST_STREAM_TRANSFERS compile time option has been removed due to lack of use and low cost/benefit ratio
+  *   - Altered all endpoint/pipe stream transfers so that the new BytesProcessed parameter now points to a location
+  *     where the number of bytes in the transfer that have been completed can be stored (or NULL if entire transaction
+  *     should be performed in one chunk)
+  *   - The NO_STREAM_CALLBACKS compile time option has now been removed due to the new partial stream transfer feature
+  *   - Changed over all project and demo HID report descriptors to use the new HID report item macros
+  *   - Moved the HIDParser.c source file to the LUFA/Drivers/USB/Class/Common/ directory from the LUFA/Drivers/USB/Class/Host/
+  *   - Added support to the HID parser for extended USAGE items that contain the usage page as well as the usage index
+  *   - Removed the SerialStream driver, rolled functionality into the regular Serial peripheral driver via the new
+  *     Serial_CreateStream() and Serial_CreateBlockingStream() functions
+  *   - Renamed the low level Serial byte send/receive functions, to be consistent with the CDC class driver byte functions
+  *   - Altered the behaviour of the serial byte reception function so that is is non-blocking, and now returns a negative
+  *     value if no character is received (to remain consistent with the CDC class driver byte reception routines)
+  *   - Renamed the PRNT_Host_SendString(), CDC_Host_SendString() and CDC_Device_SendString() functions to *_SendData(), and
+  *     added new versions of the *_SendString() routines that expect a null terminated string instead
+  *   - Renamed all driver termination *_ShutDown() functions to the more logical name *_Disable()
+  *   - Reduced latency for executing the Start-Of-Frame events (if enabled in the user application)
+  *   - Removed Pipe_ClearErrorFlags(), pipe error flags are now automatically cleared when Pipe_ClearError() is called
+  *   - Endpoint_ResetFIFO() renamed to Endpoint_ResetEndpoint(), to be consistent with the Pipe_ResetPipe() function name
+  *   - Implemented on-demand PLL clock generation for the U4, U6 and U7 series USB AVRs when automatic PLL mode is specified
+  *   - F_CLOCK changed to F_USB to be more descriptive, and applicable on future architecture ports
+  *   - Renamed all low level Endpoint_Read_*, Endpoint_Write_* and Endpoint_Discard_* functions to use the number of bits instead of
+  *     a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
+  *   - Renamed all low level Pipe_Read_*, Pipe_Write_* and Pipe_Discard_* functions to use the number of bits instead of
+  *     a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
+  *  - Library Applications:
+  *   - Changed the XPLAINBridge software UART to use the regular timer CTC mode instead of the alternative CTC mode
+  *     via the Input Capture register, to reduce user confusion
+  *   - Combined page and word ISP programming mode code in the AVRISP-MKII clone project to reduce compiled size and
+  *     increase maintainability of the code
+  *   - Changed over library projects to use the new general ring buffer library driver module
+  *   - Added new high level TWI packet read/write commands, altered behaviour of the TWI_StartTransmission() function
+  *   - Changed TempDataLogger project's DS1307 driver to simplify the function interface and prevent a possible race condition
+  *   - Changed AVRISP-MKII project to use the Watchdog interrupt for command timeouts, to reduce CPU usage and free timer 0
+  *     for other uses
+  *   - Updated the software USART code in the XPLAIN Bridge application so that the incomming bits are sampled at their mid-point
+  *     instead of starting point, to give maximum reliability (thanks to Anton Staaf)
   *
   *  <b>Fixed:</b>
-  *  - Fixed USB_GetHIDReportItemInfo() function modifying the given report item's data when the report item does not exist
-  *    within the supplied report of a multiple report HID device
-  *  - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to
-  *    missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger)
-  *  - Fixed critical pipe/endpoint memory allocation issue where the bank memory address space could be silently overlapped
-  *    in the USB controller if the endpoints or pipes were allocated in anything other than ascending order (thanks to Martin Degelsegger)
-  *  - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control
-  *    request handler
-  *  - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value
-  *  - Added LEDs_ToggleLEDs() function to several board LED drivers which were missing it (thanks to Andrei Krainev)
-  *  - Fixed SET FEATURE and CLEAR FEATURE control requests directed at an unconfigured endpoint causing request timeouts
-  *  - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2
-  *  - Fixed USB_Host_ClearPipeStall() incorrectly determining the endpoint direction from the currently selected pipe
-  *  - Fixed JTAG_DEBUG_POINT() and JTAG_DEBUG_BREAK() macros not compiling under pure C99 standards mode
-  *  - Fixed endpoint selection within the CALLBACK_HID_Device_CreateHIDReport() callback function causing broken GET REPORT requests
-  *  - Fixed incorrect command name for EEPROM memory programming in the makefile dfu-ee target
-  *  - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev)
-  *  - Fixed incorrect LEDs_ChangeLEDs() function in the Benito board LED driver
-  *  - Fixed incorrect USB_DeviceState value when unconfiguring the device without an address set
-  *  - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used
-  *  - Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init() is called
-  *  - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules
+  *  - Core:
+  *   - Fixed broken USBFOO board drivers due to missing BOARD_USBFOO define
+  *   - Fixed HID host class driver incorrectly binding to HID devices that do not have an OUT endpoint
+  *   - Fixed incorrect definition of the HID_KEYBOARD_SC_D constant in the HID class driver (thanks to Opendous Inc.)
+  *   - Fixed incorrect definition of the HID_KEYBOARD_SC_RIGHT_ARROW constant in the HID class driver (thanks to Joby Taffey)
+  *   - Fixed incorrect endpoint initialisation order in the several device demos (thanks to Rick Drolet)
+  *   - Fixed inverted Minimum board LEDs
+  *   - Fixed incorrect byte ordering in the Audio_Device_WriteSample24 function (thanks to WZab)
+  *   - Fixed several functions in the Host mode Still Image Class driver returning an error code from the incorrect
+  *     error code enum (thanks to Daniel Seibert)
+  *   - Fixed ReportID not being removed from the feature/out report data array in the HID class driver when Report IDs are used
+  *   - Fixed incorect BUTTONS_BUTTON1 definition for the Minimus board
+  *   - Fixed Still Image Host class driver exiting the descriptor search routine prematurely if the data pipes (but not event pipe)
+  *     is found
+  *   - Fixed missing call to Pipe_SetInfiniteINRequests() in the Pipe_ConfigurePipe() routine
+  *   - Fixed Remote Wakeup broken on the AVRs due to the mechanism only operating when the SUSPI bit is set (thanks to Holger Steinhaus)
+  *   - Fixed possible invalid program execution when in host mode if corrupt descriptor lengths are supplied by the attached device
+  *  - Library Applications:
+  *   - Fixed Benito project discarding incoming data from the USB virtual serial port when the USART is busy
+  *   - Fixed broken DFU bootloader, added XPLAIN support for bootloader start when XCK jumpered to ground
+  *   - Fixed broken HID_REQ_GetReport request handler in the Low Level GenericHID demo
+  *   - Fixed possible lost data in the XPLAINBridge, USBtoSerial and Benito projects when the host exceeds the packet
+  *     timeout period on received packets as set by USB_STREAM_TIMEOUT_MS (thanks to Justin Rajewski)
+  *   - Fixed possible programming problem in the AVRISP-MKII clone project when programming specific patterns into a target
+  *     memory space that is only byte (not page) addressable
+  *   - Fixed errors in the incomplete Test and Measurement device demo preventing proper operation (thanks to Pavel Plotnikov)
+  *   - Fixed programming errors in the AVRISP-MKII project when the programming packet is a round multiple of the endpoint bank
+  *     size under avrdude (thanks to Steffan Woltjer)
+  *
+  *
+  *  \section Sec_ChangeLog101122 Version 101122
+  *  <b>New:</b>
+  *  - Core:
+  *    - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously
+  *      not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger)
+  *    - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c
+  *    - Added new USB_Device_GetFrameNumber() and USB_Host_GetFrameNumber() functions to retrieve the current USB frame number
+  *    - Added new USB_Host_EnableSOFEvents(), USB_Host_DisableSOFEvents() and EVENT_USB_Host_StartOfFrame() for the user application
+  *      handling of USB Start of Frame events while in USB Host mode
+  *    - Added new PRNT_Host_BytesReceived(), PRNT_Host_ReceiveByte(), PRNT_Host_SendByte() and PRNT_Host_Flush() functions to the
+  *      Print Host Class driver
+  *    - Added class specific descriptor alternative struct type defines with standard USB-IF element naming
+  *    - Added new project makefile template to the library and moved board driver stub files into in a new "CodeTemplates" directory
+  *    - Added board hardware driver support for the Adafruit U4 breakout board
+  *    - Added board hardware driver support for the Arduino Uno development board
+  *    - Added board hardware driver support for the Blackcat USB JTAG board (thanks to the PSGroove team)
+  *    - Added board hardware driver support for the Busware BUI development board
+  *    - Added board hardware driver support for the Busware CUL V3 868MHZ radio board (thanks to Dirk Tostmann)
+  *    - Added board hardware driver support for the Kernel Concepts USBFOO development board
+  *    - Added board hardware driver support for the Linnix UDIP development board
+  *    - Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett)
+  *    - Added board hardware driver support for the Maximus board (thanks to the PSGroove team)
+  *    - Added board hardware driver support for the Microsin AVR-USB162 breakout board
+  *    - Added board hardware driver support for the Minimus board (thanks to the PSGroove team)
+  *    - Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management
+  *      tasks for each driver is called
+  *    - Added standard keyboard HID report scancode defines (thanks to Laszlo Monda)
+  *    - Added new Pipe_GetBusyBanks(), Endpoint_GetBusyBanks() and Endpoint_AbortPendingIN() functions
+  *  - Library Applications:
+  *    - Added default test tone generation mode to the Device mode AudioInput demos
+  *    - Added new NO_BLOCK_SUPPORT, NO_EEPROM_BYTE_SUPPORT, NO_FLASH_BYTE_SUPPORT and NO_LOCK_BYTE_WRITE_SUPPORT compile time options to the
+  *      CDC class bootloader
+  *    - Added new XCK_RESCUE_CLOCK_ENABLE compile time option to the AVRISP-MKII clone programmer project (thanks to Tom Light)
+  *
+  *  <b>Changed:</b>
+  *  - Core:
+  *    - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions
+  *      depending of if the given bank size is a compile time constant, as the compiler does a better job of optimizing
+  *      with basic code
+  *    - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove
+  *      the need for extra casting inside the callback (thanks to Jonathan Kollasch)
+  *    - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode
+  *    - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode
+  *    - Renamed and moved class driver common constant definitions to make the naming scheme more uniform
+  *    - Moved the USB mode specifier constants into a new enum, so that they are semantically related to one another
+  *    - Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed it to return the maximum number of supported banks for
+  *      the given endpoint
+  *    - Better algorithm to extract and convert the internal device serial number into a string descriptor (if present)
+  *    - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be separately included
+  *    - The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called
+  *    - Renamed the EVENT_USB_Device_UnhandledControlRequest() event to EVENT_USB_Device_ControlRequest() as it is now fired before the library
+  *      request handlers, not afterwards
+  *  - Library Applications:
+  *    - Changed over all device demos to use a clearer algorithm for the configuring of the application's endpoints
+  *    - Added missing DataflashManager_CheckDataflashOperation() function to the MassStorageKeyboard demo, removed redundant
+  *      SCSI_Codes.h file as these values are part of the MassStorage Class Driver
+  *    - Added compile time error to the AVRISP-MKII project when built for the U4 chips, as the default VTARGET detection ADC channel
+  *      does not exist on these chips (thanks to Marco)
+  *    - Changed all Device mode LowLevel demos and Device Class drivers so that the control request is acknowledged and any data
+  *      transferred as quickly as possible without any processing in between sections, so that long callbacks or event handlers will
+  *      not break communications with the host by exceeding the maximum control request stage timeout period
+  *    - Changed over all demos, drivers and internal functions to use the current frame number over the Start of Frame flag where possible
+  *      to free up the Start of Frame flag for interrupt use in the user application
+  *    - All project makefiles now correctly clean intermediate build files from assembly and C++ sources (thanks to Daniel Czigany)
+  *    - Changed default value for the reset polarity parameter in the AVRISP-MKII project so that it defaults to active low drive
+  *    - Changed configuration descriptor parser for all host mode projects and class drivers to ensure better compatibility with devices
+  *    - All LowLevel demos changed to use the constants and types defined in the USB class drivers
+  *    - Changed AudioInput and AudioOutput demos to reload the next sample via an interrupt rather than polling the sample timer
+  *    - Rescue clock of the AVRISP-MKII moved to the AVR's OCR1A pin, so that the clock can be generated at all times
+  *    - Changed ClassDriver MIDI demos to process all incoming events in a loop until the bank becomes empty rather than one at a time
+  *    - Changed LowLevel MIDI demos to only clear the incoming event bank once it has become empty to support packed event packets
+  *
+  *  <b>Fixed:</b>
+  *  - Core:
+  *    - Fixed USB_GetHIDReportItemInfo() function modifying the given report item's data when the report item does not exist
+  *      within the supplied report of a multiple report HID device
+  *    - Fixed critical pipe/endpoint memory allocation issue where the bank memory address space could be silently overlapped
+  *      in the USB controller if the endpoints or pipes were allocated in anything other than ascending order (thanks to Martin Degelsegger)
+  *    - Added LEDs_ToggleLEDs() function to several board LED drivers which were missing it (thanks to Andrei Krainev)
+  *    - Fixed SET FEATURE and CLEAR FEATURE control requests directed at an unconfigured endpoint causing request timeouts
+  *    - Fixed USB_Host_ClearPipeStall() incorrectly determining the endpoint direction from the currently selected pipe
+  *    - Fixed JTAG_DEBUG_POINT() and JTAG_DEBUG_BREAK() macros not compiling under pure C99 standards mode
+  *    - Fixed endpoint selection within the CALLBACK_HID_Device_CreateHIDReport() callback function causing broken GET REPORT requests
+  *    - Fixed incorrect command name for EEPROM memory programming in the makefile dfu-ee target
+  *    - Fixed incorrect LEDs_ChangeLEDs() function in the Benito board LED driver
+  *    - Fixed incorrect USB_DeviceState value when unconfiguring the device without an address set
+  *    - Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init() is called
+  *    - Fixed random enumeration failure while in device mode due to interrupts causing the Set Address request to exceed maximum timings
+  *    - Fixed MIDI_Host_Flush() not aborting early when the specified MIDI host interface was not configured
+  *    - Fixed MIDI class driver send routines silently discarding packets if the endpoint or pipe is busy (thanks to Robin Green)
+  *  - Library Applications:
+  *    - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to
+  *      missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger)
+  *    - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control
+  *      request handler
+  *    - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value
+  *    - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2
+  *    - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev)
+  *    - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used
+  *    - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules
+  *    - Fixed USBtoSerial and XPLAINBridge demos discarding data from the PC if the send buffer becomes full
+  *    - Fixed broken input in the MagStripe reader project due to an incorrect HID report descriptor
+  *    - Fixed incorrect PollingIntervalMS values in the demo/project/bootloader endpoint descriptors (thanks to MCS Electronics)
+  *    - Fixed AVRISP-MKII clone project not starting the target's program automatically after exiting TPI programming mode
+  *
   *
   *  \section Sec_ChangeLog100807 Version 100807
   *  <b>New:</b>
   *  - Fixed software application start command broken in the DFU class bootloader when dfu-programmer is used due to application
   *    start address corruption
   *
+  *
   *  \section Sec_ChangeLog100513 Version 100513
   *  <b>New:</b>
   *  - Added incomplete MIDIToneGenerator project
   *    read (thanks to Andrei Krainev)
   *  - Fixed device state not being reset back to the default state if the host sets the address to 0
   *  - Fixed Set Configuration requests not being stalled until the host has set the device's address
-  *  - Fixed Host mode HID class driver not sending the correct report type when HID_Host_SendReportByID() was called and the 
+  *  - Fixed Host mode HID class driver not sending the correct report type when HID_Host_SendReportByID() was called and the
   *    HID_HOST_BOOT_PROTOCOL_ONLY compile time option is set
   *  - Fixed INTERRUPT_CONTROL_ENDPOINT compile time option preventing other interrupts from occurring while the control endpoint
   *    request is being processed, causing possible lockups if a USB interrupt occurs during a transfer
   *  - Remove incorrect Abstract Call Management class specific descriptor from the CDC demos, bootloaders and projects
   *
+  *
   *  \section Sec_ChangeLog100219 Version 100219
   *
   *  <b>New:</b>
   *  - Fixed AVRISP project not extending the command delay after each successful page/word/byte program
   *  - Fixed accuracy of the SERIAL_UBBRVAL() and SERIAL_2X_UBBRVAL() macros for higher baud rates (thanks to Renaud Cerrato)
   *
+  *
   *  \section Sec_ChangeLog091223 Version 091223
   *
   *  <b>New:</b>
   *  - Fixed Mass Storage Host Class driver and Low Level demo not clearing the error condition if an attached device returns a
   *    STALL to a GET MAX LUN request (thanks to Martin Luxen)
   *  - Fixed TeensyHID bootloader not properly shutting down the USB interface to trigger a disconnection on the host before resetting
-  *  - Fixed MassStorageHost Class driver demo not having USB_STREAM_TIMEOUT_MS compile time option set properly to prevent slow 
+  *  - Fixed MassStorageHost Class driver demo not having USB_STREAM_TIMEOUT_MS compile time option set properly to prevent slow
   *    devices from timing out the data pipes
   *  - Fixed the definition of the Endpoint_BytesInEndpoint() macro for the U4 series AVR parts
   *  - Fixed MIDI host Class driver MIDI_Host_SendEventPacket() routine not properly checking for Pipe ready before writing
   *  - Fixed AVRISP project timeouts not checking for the correct timeout period (thanks to Carl Ott)
   *  - Fixed STK525 Dataflash driver using incorrect bit-shifting for Dataflash addresses (thanks to Tim Mitchell)
   *
+  *
   *  \section Sec_ChangeLog091122 Version 091122
   *
   *  <b>New:</b>
   *  - Fixed LowLevel Keyboard demo not saving the issues report only after it has been sent to the host
   *  - Fixed Endpoint_Write_Control_Stream_* functions not sending a terminating IN when given data Length is zero
   *
+  *
   *  \section Sec_ChangeLog090924 Version 090924
   *
   *  <b>New:</b>
   *  - Added new Pipe_IsFrozen() macro to determine if the currently selected pipe is frozen
   *  - Added new USB_GetHIDReportSize() function to the HID report parser to retrieve the size of a given report by its ID
   *  - Added new combined Mass Storage and Keyboard demo (thanks to Matthias Hullin)
-  *  
+  *
   *  <b>Changed:</b>
   *  - SetIdle requests to the HID device driver with a 0 idle period (send changes only) now only affect the requested
   *    HID interface within the device, not all HID interfaces
   *  - Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions
   *  - Added new DEVICE_STATE_AS_GPIOR and HOST_STATE_AS_GPIOR compile time options
   *  - Added 404 Not Found errors to the webserver in the RNDIS demos to indicate invalid URLs
-  *  
+  *
   *  <b>Changed:</b>
   *  - Deprecated pseudo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused)
   *  - The device-mode CALLBACK_USB_GetDescriptor() function now has an extra parameter so that the memory space in which the requested
   *  - Pipe stream functions now automatically set the correct pipe token, so that bidirectional pipes can be used
   *  - Pipe_ConfigurePipe() now automatically defaults IN pipes to accepting infinite IN requests, this can still be changed by calling
   *    the existing Pipe_SetFiniteINRequests() function
-  *  - Changed F_CLOCK entries in project makefiles to alias to F_CPU by default, as this is the most common case
+  *  - Changed F_USB entries in project makefiles to alias to F_CPU by default, as this is the most common case
   *  - Host mode demos now use sane terminal escape codes, so that text is always readable and events/program output is visually distinguished
   *    from one another using foreground colours
   *  - Internal per-device preprocessing conditions changed to per-device series rather than per-controller group for finer-grain
   *    of device configurations can be defined statically
   *  - Removed VBUS events, as they are already exposed to the user application via the regular device connection and disconnection events
   *  - Renamed and altered existing events to properly separate out Host and Device mode events
-  *  - All demos switched over from GNU99 standards mode to C99 standards mode, to reduce the dependancies on GCC-only language extensions
+  *  - All demos switched over from GNU99 standards mode to C99 standards mode, to reduce the dependencies on GCC-only language extensions
   *
   *  <b>Fixed:</b>
   *  - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix
   *  - Fixed USB Pad regulator not being disabled on some AVR models when the USB_OPT_REG_DISABLED option is used
   *  - Fixed Host mode to Device mode UID change not causing a USB Disconnect event when a device was connected
   *  - Fixed Mouse/Keyboard demos not performing the correct arithmetic on the Idle period at the right times (thanks to Brian Dickman)
-  *  - Fixed GenericHID failing HID class tests due to incorrect Logical Minimum and Logical Maximum values (thanks to SΓΈren Greiner)
+  *  - Fixed GenericHID failing HID class tests due to incorrect Logical Minimum and Logical Maximum values (thanks to Soren Greiner)
   *  - Fixed incorrect PIPE_EPNUM_MASK mask causing pipe failures on devices with endpoint addresses of 8 and above (thanks to John Andrews)
   *  - Fixed report data alignment issues in the MouseHostWithParser demo when X and Y movement data size is not a multiple of 8 bits
   *  - Fixed HID Report Descriptor Parser not correctly resetting internal states when a REPORT ID element is encountered
   *  - Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button
   *  - Serial driver now correctly calculates the baud register value when in double speed mode
   *  - Init function of the Serial driver is now static inline to product smaller code for the common-case of static init values
-  *    
+  *
   *
   *  \section Sec_ChangeLog090401 Version 090401
   *
   *  - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request
   *  - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission
   *    next time the device is attached to a host.
-  *  - 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
+  *  - Added new F_USB compile time constant to the library and makefiles, to give the raw input clock (used to feed the PLL before any
   *    clock prescaling is performed) frequency, so that the PLL prescale mask can be determined
   *  - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with
   *    badly designed hosts or devices which greatly exceed the USB specification limits
   *  - Doxygen documentation now contains documentation on all the projects, bootloaders and most demos included with the library
   *  - CDC bootloader now runs user application when USB disconnected rather than waiting for a hard reset
   *  - MouseHostWithParser and KeyboardHostWithParser now support multiple-report devices
-  *  - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver  
+  *  - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver
   *  - Fixed the DFU bootloader, no longer freezes up when certain files are programmed into an AVR, made reading/writing faster
-  *  - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal 
+  *  - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal
   *    right-handed system
   *  - Added stub code to the CDC and USBtoSerial demos showing how to read and set the RS-232 handshake lines - not currently used in
   *    the demos, but the example code and supporting defines are now in place
   *  - All HID demos now pass the USB.org automated HID compliance tests
   *  - Polling interval of the interrupt endpoint in the CDC based demos changed to 0xFF to fix problems on Linux systems
   *  - Changed stream functions to accept a new callback function, with NO_STREAM_CALLBACKS used to disable all callbacks
-  *  - Mass Storage demo dataflash management routines changed to use the endpoint stream functions            
+  *  - Mass Storage demo dataflash management routines changed to use the endpoint stream functions
   *  - Added AVRStudio project files for each demo in addition to the existing Programmer's Notepad master project file
   *  - Re-added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
   *    are reflected in the hardware (change was previously lost)
   *
   *  - Added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
   *    are reflected in the hardware
-  *  - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the 
+  *  - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the
   *    GetLineCoding request had an incorrect RequestType mask preventing it from being processed
   *  - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full
   *  - Device control endpoint size is now determined from the device's descriptors rather than being fixed
   *  - ID transition interrupt now raises the appropriate device/host disconnect event if device attached
   *  - Fixed double VBUS change (and VBUS -) event when detaching in device mode
   *  - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile
-  *  - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and 
+  *  - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and
   *    Endpoint_IsConfigured() after calling the config functions to determine success
   */
+