Partial commit: change references to Drivers/AT90USBXXX to Drivers/Peripheral.
[pub/lufa.git] / LUFA / ChangeLog.txt
index e8dbba0..760aec2 100644 (file)
@@ -8,7 +8,50 @@
   *\r
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
   *\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 mutiple CDC interfaces which are not the correct ACM type preceeding 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
+  *    Endpoint_ClearControlIN(), Endpoint_ClearControlOUT(), Pipe_ClearIN(), Pipe_ClearOUT(), Pipe_ClearControlIN() and\r
+  *    Pipe_ClearControlOUT() 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_ClearControlSETUP(), 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)\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\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
@@ -16,7 +59,7 @@
   *  - Fixed Configuration Descriptor search routine freezing when a comparitor 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
@@ -29,7 +72,7 @@
   *  - 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
   *  - 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 incomming data\r
-  *  - Fixed documentation typoes 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 CAN_BE_DEVICE is defined (thanks to Ian Gregg)\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
   *  - 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
   *  - 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