Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with...
[pub/lufa.git] / LUFA / ChangeLog.txt
index 58bd9d2..2c40ba8 100644 (file)
@@ -8,16 +8,84 @@
   *\r
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
   *\r
-  *  - Added new incomplete BluetoothHost demo\r
-  *  - Changed AVRISP Programmer descriptors to use a newly allocated 0x204F PID value\r
+  *  - Added new GenericHIDHost demo\r
+  *  - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use\r
+  *  - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR\r
+  *  - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile\r
+  *    time options\r
+  *  - All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected\r
+  *  - Added new PIMA_DATA_SIZE() define to the Still Image Host demo\r
+  *  - Add call to MassStore_WaitForDataReceived() in MassStore_GetReturnedStatus() to ensure that the CSW has been received in the\r
+  *    extended MSC timeout period before continuing, to prevent long processing delays from causing the MassStore_GetReturnedStatus()\r
+  *    to early-abort (thanks to Dmitry Maksimov)\r
+  *  - Move StdRequestType.h, StreamCallbacks.h, USBMode.h from the LowLevel USB driver directory to the HighLevel USB driver directory,\r
+  *    where they are more suited\r
+  *  - Removed all binary constants and replaced with decimal or hexadecimal constants so that unpatched GCC compilers can still build the\r
+  *    code without having to be itself patched and recompiled first\r
+  *  - Added preprocessor checks and documentation to the bootloaders giving information about missing SIGNATURE_x defines due to\r
+  *    outdated avr-libc versions.\r
+  *  - Added support to the CDCHost demo for devices with multiple CDC interfaces which are not the correct ACM type preceding the desired\r
+  *    ACM CDC interface\r
+  *  - Fixed GenericHID demo not starting USB and HID management tasks when not using interrupt driven modes (thanks to Carl Kjeldsen)\r
+  *  - Fixed RNDISEthenet demo checking the incorrect message field for packet size constraints (thanks to Jonathan Oakley)\r
+  *  - Fixed WriteNextReport code in the GenericHIDHost demo using incorrect parameter types and not selecting the correct endpoint\r
+  *  - Adjusted sample CTC timer calculations in the AudioOutput and AudioInput demos to match the CTC calculations in the AVR datasheet,\r
+  *    and to fix instances where rounding caused the endpoint to underflow (thanks to Robin Theunis)\r
+  *  - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0), so that other control type\r
+  *    pipes can be used with the function\r
+  *  - The USB Host management task now saves and restores the currently selected pipe before and after the task completes\r
+  *  - Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev)\r
+  *  - Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favour of new Endpoint_ClearIN(), Endpoint_ClearOUT(),\r
+  *    Pipe_ClearIN() and Pipe_ClearOUT() macros (done to allow for the detection of packets of zero length)\r
+  *  - Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API\r
+  *  - Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been\r
+  *    renamed to Endpoint_ClearSETUP(), the Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent() and the\r
+  *    Pipe_ClearSetupSent() macro is no longer applicable and should be removed - changes made to compliment the new endpoint and pipe\r
+  *    bank management API\r
+  *  - Updated all demos, bootloaders and projects to use the new endpoint and pipe management APIs (thanks to Roman Thiel from Curetis AG)\r
+  *  - Updated library doxygen documentation, added groups, changed documentation macro functions to real functions for clarity\r
+  *  - Removed old endpoint and pipe aliased read/write/discard routines which did not have an explicit endian specifier for clarity\r
+  *  - Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway\r
+  *  - Renamed the main Drivers/AT90USBXXX directory to Drivers/Peripheral, renamed the Serial_Stream driver to SerialStream\r
+  *  - Fixed CDC and USBtoSerial demos freezing where buffers were full while still transmitting or receiving (thanks to Peter Hand)\r
+  *  - Removed "Host_" section of the function names in ConfigDescriptor.h, as most of the routines can now be used in device mode on the\r
+  *    device descriptor\r
+  *  - Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name\r
+  *  - Fixed incorrect HID interface class and subclass values in the Mouse and KeyboardMouse demos (thanks to Brian Dickman)\r
+  *  - Capitalised the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and\r
+  *    DSearch_Comp_Return_ErrorCodes_t enums\r
+  *  - Removed "ERROR" from the enum names in the endpoint and pipe stream error code enums\r
+  *  - Renamed the USB_PowerOnErrorCodes_t enum to USB_InitErrorCodes_t, renamed the POWERON_ERROR_NoUSBModeSpecified enum value to\r
+  *    USB_INITERROR_NoUSBModeSpecified\r
+  *  - Renamed USB_PowerOnFail event to USB_InitFailure\r
+  *  - Renamed OTG.h header functions to be more consistent with the rest of the library API\r
+  *  - Changed over all deprecated GCC structure tag initializers to the standardized C99 format (thanks to Mike Alexander)\r
+  *  - USB_HostRequest renamed to USB_ControlRequest, entire control request header is now read into USB_ControlRequest in Device mode\r
+  *    rather than having the library pass only partially read header data to the application\r
+  *  - The USB_UnhandledControlPacket event has had its parameters removed, in favour of accessing the new USB_ControlRequest structure\r
+  *  - The Endpoint control stream functions now correctly send a ZLP to the host when less data than requested is sent\r
+  *  - Fixed USB_RemoteWakeupEnabled flag never being set (the REMOTE WAKEUP Set Feature request was not being handled)\r
+  *  - Renamed the FEATURELESS_CONTROL_ONLY_DEVICE compile-time token to CONTROL_ONLY_DEVICE\r
+  *  - Endpoint configuration is now refined to give better output when all configurations have static inputs - removed the now useless\r
+  *    STATIC_ENDPOINT_CONFIGURATION compile time token\r
+  *  - Fixed SPI driver init function not clearing SPI2X bit when not needed\r
+  *  - Fixed PREVENT ALLOW MEDIUM REMOVAL command issuing in the MassStorageHost demo using incorrect parameters (thanks to Mike Alex)\r
+  *  - Fixed MassStorageHost demo broken due to an incorrect if statement test in MassStore_GetReturnedStatus()\r
+  *  - Fixed reversed signature byte ordering in the CDC bootloader (thanks to Johannes Raschke)\r
+  *  - Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with faulty devices which do not respect the given\r
+  *    wLength value when reading in the device descriptor\r
+  *    \r
+  *\r
+  *  \section Sec_ChangeLog090401 Version 090401\r
+  *\r
   *  - Fixed MagStripe project configuration descriptor containing an unused (blank) endpoint descriptor\r
   *  - Incorporated makefile changes by Denver Gingerich to retain compatibility with stock (non-WinAVR) AVR-GCC installations\r
   *  - Fixed makefile EEPROM programming targets programming FLASH data in addition to EEPROM data\r
   *  - LUFA devices now enumerate correctly with LUFA hosts\r
-  *  - Fixed Configuration Descriptor search routine freezing when a comparitor returned a failure\r
+  *  - Fixed Configuration Descriptor search routine freezing when a comparator returned a failure\r
   *  - Removed HID report item serial dump in the MouseHostWithParser and KeyboardHostWithParser - useful only for debugging, and\r
   *    slowed down the enumeration of HID devices too much\r
-  *  - Increased the number of bits per track which can be read in the MagStripe project to 20480 when compiled for the AT90USBXXX6/7\r
+  *  - Increased the number of bits per track which can be read in the MagStripe project to 8192 when compiled for the AT90USBXXX6/7\r
   *  - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request\r
   *  - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission\r
   *    next time the device is attached to a host.\r
   *  - Added ATTR_ALWAYS_INLINE attribute to several key inlined library components, to ensure they are inlined in all circumstances\r
   *  - Removed SetSystemClockPrescaler() macro, the clock_prescale_set() avr-libc macro has been corrected in recent avr-libc versions\r
   *  - Fixed incorrect/missing control status stage transfers on demos, bootloaders and applications (thanks to Nate Lawson)\r
-  *  - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to NO_FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded\r
+  *  - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded\r
   *    to also remove parts of the Get Status chapter 9 request to further reduce code usage\r
   *  - Makefile updated to include output giving the currently selected BOARD parameter value\r
+  *  - Board Dataflash driver now allows for dataflash ICs which use different shifts for setting the current page/byte address (thanks\r
+  *    to Kenneth Clubb)\r
+  *  - Added DataflashManager_WriteBlocks_RAM() and DataflashManager_ReadBlocks_RAM() functions to the MassStorage demo, to allow for easy\r
+  *    interfacing with a FAT library for dataflash file level access\r
+  *  - Corrected CDC class bootloader to fix a few bugs, changed address counter to store x2 addresses for convenience\r
+  *  - Fixed typos in the SPI driver SPI_SPEED_FCPU_DIV_64 and SPI_SPEED_FCPU_DIV_128 masks (thanks to Markus Zocholl)\r
+  *  - Keyboard and Mouse device demos (normal, data interrupt and fully interrupt driven) combined into unified keyboard and mouse demos\r
+  *  - Keyboard and Mouse host demos (normal and data interrupt driven) combined into unified keyboard and mouse demos\r
+  *  - Removed AVRISP_Programmer project due to code quality concerns\r
+  *  - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incoming data\r
+  *  - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)\r
+  *  - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)\r
+  *  - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)\r
+  *  - Added new GenericHID device demo application\r
+  *  - Fixed Still Image Host SImage_SendData() function not clearing the pipe bank after sending data\r
+  *\r
   *\r
   *  \section Sec_ChangeLog090209 Version 090209\r
   *\r
   *  - Added SetProtocol request to HID class non-parser Mouse and Keyboard demos to force devices to use the correct Boot Protocol\r
   *  - Added new "dfu" and "flip" programming targets to project makefiles\r
   *  - HID_PARSE_Sucessful enum member typo corrected to HID_PARSE_Successful\r
-  *  - Changed COLLECTION item strucutres in the HID descriptor parser to include the collection's Usage Page value\r
+  *  - Changed COLLECTION item structures in the HID descriptor parser to include the collection's Usage Page value\r
   *  - Serial driver now sets Tx line as output, enables pullup on Rx line\r
   *  - Fixed smaller USB AVRs raising multiple connection and disconnection events when NO_LIMITED_CONTROLLER_CONNECT is disabled\r
   *  - Added HOST_DEVICE_SETTLE_DELAY_MS to give the host delay after a device is connected before it is enumerated\r
   *  - Fixed CDC Host demo not searching through both CDC interfaces for endpoints\r
   *  - Fixed incorrect Product String descriptor length in the DFU class bootloader\r
   *\r
+  *\r
   *  \section Sec_ChangeLog081224 Version 081224\r
   *\r
   *  - MyUSB name changed to LUFA, the Lightweight USB Framework for AVRs\r
   *    easily be altered to show different LED combinations (or do something else entirely) as the demo's status changes\r
   *  - Removed LED commands from the CDC bootloader, unused by most AVR910 programming software\r
   *  - Fixed RNDIS demo ICMP ping requests echoing back incorrect data\r
-  *  - Added DHCP server code to RNDIS demo, allowing for hands-free autoconfiguration on any PC\r
+  *  - Added DHCP server code to RNDIS demo, allowing for hands-free auto configuration on any PC\r
   *  - Fixed DFU bootloader PID value for the ATMEGA16U4 AVR\r
   *  - Endpoint and Pipe configuration functions now return an error code indicating success or failure\r
   *  - USB Reset in device mode now resets and disables all device endpoints\r
   *    invocation when in host mode\r
   *  - Added support for the ATMEGA32U6 microcontroller\r
   *  - Added STATIC_ENDPOINT_CONFIGURATION compile time option, enabled in the bootloaders to minimize space usage\r
-  *  - Removed redudant code from the USB device GetStatus() chapter 9 processing routine\r
+  *  - Removed redundant code from the USB device GetStatus() chapter 9 processing routine\r
   *  - Added new TeensyHID bootloader, compatible with the Teensy HID protocol (http://www.pjrc.com/teensy/)\r
   *  - Versions are now numbered by release dates, rather than arbitrary major/minor revision numbers\r
   *  - USB_RemoteWakeupEnabled is now correctly set and cleared by SetFeature and ClearFeature requests from the host\r
   *  - Changed prototype of GetDescriptor, so that it now returns the descriptor size (or zero if the descriptor doesn't exist)\r
   *    rather than passing the size back to the caller through a parameter and returning a boolean\r
   *\r
+  *\r
   *  \section Sec_ChangeLog153 Version 1.5.3 - Released 2nd October, 2008\r
   *\r
   *  - Fixed CDC bootloader using pgmspace macros for some descriptors inappropriately\r
   *  - Updated all Mouse and Keyboard device demos to include boot protocol support (now works in BIOS)\r
   *  - Renamed bootloader directories to remove spaces, which were causing build problems on several OSes\r
   *  - Removed serial number strings from all but the MassStore demo where it is required - users were not\r
-  *    modifing the code to either ommit the descriptor or use a unique serial per device causing problems\r
+  *    modifying the code to either omit the descriptor or use a unique serial per device causing problems\r
   *    when multiple units of the same device were plugged in at the same time\r
   *  - AudioOutput and AudioInput demos now correctly silence endpoints when not enabled by the host\r
   *  - Added KeyboardMouse demo (Keyboard and Mouse functionality combined into a single demo)\r
   *  - Endpoint and Pipe creation routines now mask endpoint/pipe size with the size mask, to remove transaction\r
   *    size bits not required for the routines (improves compatibility with devices)\r
   *  - Fixed AudioInput demo - now correctly sends sampled audio to the host PC\r
-  *  - Fixed AudioOutput demo oncemore -- apparently Windows requires endpoint packets to be >=192 bytes\r
+  *  - Fixed AudioOutput demo once more -- apparently Windows requires endpoint packets to be >=192 bytes\r
   *  - Shrunk round-robbin scheduler code slightly via the use of struct pointers rather than array indexes\r
   *  - Fixed off-by-one error when determining if the Usage Stack is full inside the HID Report parser\r
   *  - Renamed Magstripe.h to MagstripeHW.h and moved driver out of the library and into the MagStripe demo folder\r
   *  - The USB device task now restores the previously selected endpoint, allowing control requests to be transparently\r
   *    handled via interrupts while other endpoints are serviced through polling\r
   *  - Fixed device signature being sent in reverse order in the CDC bootloader\r
-  *  - Host demos now have a seperate ConfigDescriptor.c/.h file for configuration descriptor processing\r
-  *  - HostWithParser demos now have a seperate HIDReport.c/.h file for HID report processing and dumping\r
+  *  - Host demos now have a separate ConfigDescriptor.c/.h file for configuration descriptor processing\r
+  *  - HostWithParser demos now have a separate HIDReport.c/.h file for HID report processing and dumping\r
   *  - Removed non-mandatory commands from MassStorage demo to save space, fixed SENSE ResponseCode value\r
   *  - CDC demos now send empty packets after sending a full one to prevent buffering issues on the host\r
   *  - Updated demo descriptors to use VID/PID values donated by Atmel\r
   *  - Added DoxyGen documentation to the source files\r
   *  - Fixed Serial_IsCharRecieved() definition, was previously reversed\r
-  *  - Removed seperate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead\r
+  *  - Removed separate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead\r
   *  - Removed unused Device Qualifier descriptor structure\r
   *  - Renamed the USB_CreateEndpoints event to the more appropriate USB_ConfigurationChanged\r
   *  - Fixed MassStorageHost demo reading in the block data in reverse\r
-  *  - Removed outdated typedefs in StdRequestType.h, superceeded by the macro masks\r
+  *  - Removed outdated typedefs in StdRequestType.h, superseded by the macro masks\r
   *  - Corrected OTG.h is now included when the AVR supports both Host and Device modes, for creating OTG products\r
   *  - USB_DeviceEnumerationComplete event is now also fired when in device mode and the host has finished its enumeration\r
   *  - Interrupt driven demos now properly restore previously selected endpoint when ISR is complete\r
   *  - USB_HOST_TIMEOUT_MS is now overridable in the user project makefile to a custom fixed timeout value\r
   *  - Renamed USB_Host_SOFGeneration_* macros to more friendly USB_Host_SuspendBus(), USB_Host_ResumeBus()\r
   *    and USB_Host_IsBusSuspended()\r
-  *  - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistant, Pipe_SetInterruptFreq() is now\r
+  *  - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistent, Pipe_SetInterruptFreq() is now\r
   *    Pipe_SetInterruptPeriod() to use the correct terminology\r
   *  - UnicodeString member of USB_Descriptor_String_t struct changed to an ordinary int array type, so that the GCC\r
   *    Unicode strings (prefixed with an L before the opening quotation mark) can be used instead of explicit arrays\r
   *    new comparator API\r
   *  - Fixed MassStorageHost demo capacity printout, and changed data read/write mode from little-endian to the correct\r
   *    big-endian for SCSI devices\r
-  *  - Fixed macro/function naming consistancy; USB_HOST is now USB_Host, USB_DEV is now USB_Device\r
+  *  - Fixed macro/function naming consistency; USB_HOST is now USB_Host, USB_DEV is now USB_Device\r
   *  - Added better error reporting to host demos\r
   *  - Added 10 microsecond delay after addressing devices in host mode, to prevent control stalls\r
   *\r
   *    GetLineCoding request had an incorrect RequestType mask preventing it from being processed\r
   *  - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full\r
   *  - Device control endpoint size is now determined from the device's descriptors rather than being fixed\r
-  *  - Seperated out SPI code into new SPI driver in AT90USBXXX driver directory\r
+  *  - Separated out SPI code into new SPI driver in AT90USBXXX driver directory\r
   *  - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID\r
   *  - Added support for the RZUSBSTICK board\r
   *  - Bicolour driver removed in favour of generic LEDs driver\r
   *\r
   *  \section Sec_ChangeLog130 Version 1.3.0 - Released March 7th 2008\r
   *\r
-  *  - Unneccesary control endpoint config removed from device mode\r
+  *  - Unnecessary control endpoint config removed from device mode\r
   *  - Fixed device standard request interpreter accidentally processing some class-specific requests\r
   *  - Added USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS compile time options to instruct the library\r
   *    to use descriptors stored in RAM or EEPROM rather than flash memory\r
   *  - Added support for the STK525 and STK526 boards\r
   *  - Added support for custom board drivers to be supplied by selecting the board type as BOARD_USER, and\r
   *    placing board drivers in {Application Directory}/Board/\r
-  *  - PLL is now stopped and USB clock is frozen when detatched from host in device mode, to save power\r
+  *  - PLL is now stopped and USB clock is frozen when detached from host in device mode, to save power\r
   *  - Joystick defines are now in synch with the schematics - orientation will be rotated for the USBKEY\r
   *  - Fixed USB_DEV_IsUSBSuspended() - now checks the correct register\r
   *  - Fixed data transfers to devices when in host mode\r
   *  - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile\r
   *  - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and \r
   *    Endpoint_IsConfigured() after calling the config functions to determine success\r
-  */
\ No newline at end of file
+  */\r