Fix broken MagStripe demo due to the HID Class driver changes.

[pub/lufa.git] / LUFA / ManPages / ChangeLog.txt

diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt
index a099835..bdb48d9 100644 (file)
--- a/LUFA/ManPages/ChangeLog.txt
+++ b/LUFA/ManPages/ChangeLog.txt
@@ -8,29 +8,151 @@
   *\r
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
   *\r
   *\r
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
   *\r

-  *  - Deprecated psuedo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused)\r
-  *  - Added new class drivers and matching demos to the library for rapid application development\r
+  *  <b>New:</b>\r
+  *  - Added new host mode class drivers and matching demos to the library for rapid application development\r
+  *  - Added flag to the HID report parser to indicate if a device has multiple reports\r
+  *  - Added new EVENT_USB_Device_StartOfFrame() event, controlled by the new USB_Device_EnableSOFEvents() and\r
+  *    USB_Device_DisableSOFEvents() macros to give bus-synchronised millisecond interrupts when in USB device mode\r
+  *  - Added new Endpoint_SetEndpointDirection() macro for bidirectional endpoints\r
+  *  - Added new AVRISP project, a LUFA powered clone of the Atmel AVRISP-MKII programmer\r
+  *  - Added ShutDown() functions for all hardware peripheral drivers, so that peripherals can be turned off after use\r
+  *  - Added new CDC_Device_Flush() command to the device mode CDC Class driver to flush Device->Host data\r
+  *  - Added extra masks to the SPI driver, changed SPI_Init() so that the clock polarity and sample modes can be set\r
+  *  - Added new callback to the HID report parser, so that the user application can filter only the items it is interested\r
+  *    in to be stored into the HIDReportInfo structure to save RAM\r
+  *  - Added support for the officially recommended external peripheral layout for the BUMBLEB board (thanks to Dave Fletcher)\r
+  *  - Added new Pipe_IsFrozen() macro to determine if the currently selected pipe is frozen\r
+  *  - Added new USB_GetHIDReportSize() function to the HID report parser to retrieve the size of a given report by its ID\r
+  *  \r
+  *  <b>Changed:</b>\r
+  *  - SetIdle requests to the HID device driver with a 0 idle period (send changes only) now only affect the requested\r
+  *    HID interface within the device, not all HID interfaces\r
+  *  - Added explicit attribute masks to the device mode demos' descriptors\r
+  *  - Added return values to the CDC and MIDI class driver transmit functions\r
+  *  - Optimized Endpoint_Read_Word_* and Pipe_Read_Word_* macros to reduce compiled size\r
+  *  - Added non-null function parameter pointer restrictions to USB Class drivers to improve user code reliability\r
+  *  - Added new "Common" section to the class drivers, to hold all mode-independant definitions for clarity\r
+  *  - Moved SCSI command/sense constants into the Mass Storage Class driver, instead of the user-code\r
+  *  - Altered the SCSI commands in the LowLevel Mass Storage Host to save on FLASH space by reducing function calls\r
+  *  - Changed the parameters and behaviour of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks\r
+  *    and data validations internally, to simplify user code\r
+  *  - Changed HIDParser to only zero out important values in the Parsed HID Report Item Information structure to save cycles\r
+  *  - The HID report parser now always processed FEATURE items - HID_ENABLE_FEATURE_PROCESSING token now has no effect\r
+  *  - The HID report parser now always ignores constant-data items, HID_INCLUDE_CONSTANT_DATA_ITEMS token now has no effect\r
+  *  - The Benito Programmer project now has its own unique VID/PID pair allocated from the Atmel donated LUFA VID/PID pool\r
+  *  - Add in new invalid event hook check targets to project makefiles to produce compilation errors when invalid event names\r
+  *    are used in a project\r
+  *  - The HID Report Parser now gives information on the total length of each report within a HID interface\r
+  *  - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now seperate USB_Descriptor_* and\r
+  *    USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so both may be used\r
+  *\r
+  *  <b>Fixed:</b>\r
+  *  - Fixed possible lockup in the CDC device class driver, when the host sends data that is a multiple of the\r
+  *    endpoint's bank\r
+  *  - Fixed swapped parameters in the HID state memory copy call while processing a HID PUSH item in the HID report parser\r
+  *  - Fixed memory corruption HID report parser when too many COLLECTION or PUSH items were processed\r
+  *  - Fixed HID report parser not resetting the FEATURE item count when a REPORT ID item is encountered\r
+  *  - Fixed USBtoSerial demos not reading in UDR1 when the USART receives data but the USB interface is not enumerated,\r
+  *    causing continuous USART receive interrupts\r
+  *  - Fixed misspelt event name in the Class driver USBtoSerial demo, preventing correct operation\r
+  *  - Fixed invalid data being returned when a GetStatus request is issued in Device mode with an unhandled data recipient\r
+  *  - Added hardware USART receive interrupt and software buffering to the Benito project to ensure received data is not\r
+  *    missed or corrupted\r
+  *  - Fixed Device mode HID Class driver always sending IN packets, even when nothing to report\r
+  *  - Fixed Device mode HID Class driver not explicitly initializing the ReportSize parameter to zero before calling callback\r
+  *    routine, so that ignored callbacks don't cause incorrect data to be sent\r
+  *  - Fixed StillImageHost not correctly freezing and unfreezing data pipes while waiting for a response block header\r
+  *  - Fixed error in the PrinterHost demo preventing the full page data from being sent to the attached device (thanks to John Andrews)\r
+  *  - Fixed CDC based demos and projects' INF driver files under 64 bit versions of Windows (thanks to Ronny Hanson, Thomas Bleeker)\r
+  *  - Re-add in missing flip, flip-ee, dfu and dfu-ee targets to project makefiles (thanks to Opendous Inc.)\r
+  *  - Fix allowable F_CPU values comment in project makefiles to more accurately reflect the allowable values on the USB AVRs\r
+  *  - Fixed DFU and CDC class bootloaders on the series 2 USB AVRs, corrected invalid signatures, added support for the new\r
+  *    ATMEGAxxx2 series 2 variant AVRs to the DFU bootloader\r
+  *  - Fixed Low Level USBtoSerial demo not storing received characters (thanks to Michael Cooper)\r
+  *  - Fixed MIDI Device Class driver not sending/receiving MIDI packets of the correct size (thanks to Thomas Bleeker)\r
+  *\r
+  *\r
+  *  \section Sec_ChangeLog090810 Version 090810\r
+  *\r
+  *  <b>New:</b>\r
+  *  - Added new device class drivers and matching demos to the library for rapid application development\r
+  *  - Added new PrinterHost demo (thanks to John Andrews)\r
+  *  - Added USB Missle Launcher project, submitted by Dave Fletcher\r
+  *  - Added new Benito Arduino Programmer project\r

   *  - Added incomplete device and host mode demos for later enhancement\r
   *  - Added incomplete device and host mode demos for later enhancement\r

-  *  - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed\r
+  *  - Updated MassStorage device block write routines to use ping-pong Dataflash buffering to increase throughput by around 30%\r

   *  - Error status LEDs shown when device endpoint configuration fails to complete in all demos and projects\r
   *  - Error status LEDs shown when device endpoint configuration fails to complete in all demos and projects\r

-  *  - Low level API MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready\r
-  *  - Fixes to MassStorageHost for better device compatibility (increase command timeout, change MassStore_WaitForDataReceived()\r
-  *    to only unfreeze and check one data pipe at a time)\r
-  *  - Internal per-device preprocessing conditions changed to per-device series rather than per controller group for finer-grain\r
-  *    internal control\r

   *  - Added new USB_Host_SetDeviceConfiguration() convenience function for easy configuration selection of devices while in USB\r
   *    host mode\r
   *  - Added new USB_Host_ClearPipeStall() convenience function to clear a stall condition on an attached device's endpoint\r
   *  - Added new USB_Host_GetDeviceDescriptor() convenience function to retrieve the attached device's Device descriptor\r
   *  - Added new USB_Host_SetDeviceConfiguration() convenience function for easy configuration selection of devices while in USB\r
   *    host mode\r
   *  - Added new USB_Host_ClearPipeStall() convenience function to clear a stall condition on an attached device's endpoint\r
   *  - Added new USB_Host_GetDeviceDescriptor() convenience function to retrieve the attached device's Device descriptor\r

-  *  - Added USB Missle Launcher project, submitted by Dave Fletcher\r
+  *  - Added new Endpoint_ClearStatusStage() convenience function to assist with the status stages of control transfers\r
+  *  - Added new USE_INTERNAL_SERIAL define for using the unique serial numbers in some AVR models as the USB device's serial number,\r
+  *    added NO_INTERNAL_SERIAL compile time option to turn off new serial number reading code\r
+  *  - Added new DATAFLASH_CHIP_MASK() macro to the Dataflash driver, which returns the Dataflash select mask for the given chip index\r
+  *  - Added new HOST_STATE_WaitForDeviceRemoval host state machine state for non-blocking disabling of device communications until the\r
+  *    device has been removed (for use when an error occurs or communications with the device have completed)\r
+  *  - Added new FAST_STREAM_TRANSFERS compile time option for faster stream transfers via multiple bytes copied per stream loop\r
+  *  - Added stdio stream demo code to the CDC device demos, to show how to create standard streams out of the virtual serial ports\r
+  *  - Added new EEPROM and FLASH buffer versions of the Endpoint and Pipe stream functions\r
+  *  - Added new USE_FLASH_DESCRIPTORS and FIXED_NUM_CONFIGURATIONS compile time options\r
+  *  - Added support for the new ATMEGA32U2, ATMEGA16U2 and ATMEGA8U2 AVR models\r
+  *  - Added new USB_DeviceState variable to keep track of the current Device mode USB state\r
+  *  - Added new LEDs_ToggleLEDs() function to the LEDs driver\r
+  *  - Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions\r
+  *  - Added new DEVICE_STATE_AS_GPIOR and HOST_STATE_AS_GPIOR compile time options\r
+  *  - Added 404 Not Found errors to the webserver in the RNDIS demos to indicate invalid URLs\r
+  *  \r
+  *  <b>Changed:</b>\r
+  *  - Deprecated psuedo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused)\r
+  *  - The device-mode CALLBACK_USB_GetDescriptor() function now has an extra parameter so that the memory space in which the requested\r
+  *    descriptor is located can be specified. This means that descriptors can now be located in multiple memory spaces within a device.\r
+  *  - Removed vague USB_IsConnected global - test USB_DeviceState or USB_HostState explicitly to gain previous functionality\r
+  *  - Removed USB_IsSuspended global - test USB_DeviceState against DEVICE_STATE_Suspended instead\r
+  *  - Extended USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch\r
+  *  - Dataflash_WaitWhileBusy() now always ensures that the dataflash is ready for the next command immediately after returning,\r
+  *    no need to call Dataflash_ToggleSelectedChipCS() afterwards\r
+  *  - Low level API MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready\r

   *  - Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow errors\r
   *  - Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow errors\r

+  *  - Pipe stream functions now automatically set the correct pipe token, so that bidirectional pipes can be used\r
+  *  - Pipe_ConfigurePipe() now automatically defaults IN pipes to accepting infinite IN requests, this can still be changed by calling\r
+  *    the existing Pipe_SetFiniteINRequests() function\r
+  *  - Changed F_CLOCK entries in project makefiles to alias to F_CPU by default, as this is the most common case\r
+  *  - Host mode demos now use sane terminal escape codes, so that text is always readable and events/program output is visually distinguished\r
+  *    from oneanother using foreground colours\r
+  *  - Internal per-device preprocessing conditions changed to per-device series rather than per-controller group for finer-grain\r
+  *    internal control\r
+  *  - Interrupts are no longer disabled during the processing of Control Requests on the default endpoint while in device mode\r
+  *  - AudioOutput demos now always output to board LEDs, regardless of output mode (removed AUDIO_OUT_LEDS project option)\r
+  *  - Removed SINGLE_DEVICE_CONFIGURATION compile time option in favour of the new FIXED_NUM_CONFIGURATIONS option so that the exact number\r
+  *    of device configurations can be defined statically\r
+  *  - Removed VBUS events, as they are already exposed to the user application via the regular device connection and disconnection events\r
+  *  - Renamed and altered existing events to properly seperate out Host and Device mode events\r
+  *\r
+  *  <b>Fixed:</b>\r
+  *  - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix\r
+  *    bootloaders on some of the USB AVR devices where avr-libc erronously defines RAMPZ\r
+  *  - Fixes to MassStorageHost for better device compatibility (increase command timeout, change MassStore_WaitForDataReceived()\r
+  *    to only unfreeze and check one data pipe at a time) to prevent incorrect device enumerations and freezes while trasferring data\r

   *  - Make Pipe_ConfigurePipe() mask the given endpoint number against PIPE_EPNUM_MASK to ensure the endpoint IN direction bit is\r
   *    cleared to prevent endpoint type corruption\r
   *  - Make Pipe_ConfigurePipe() mask the given endpoint number against PIPE_EPNUM_MASK to ensure the endpoint IN direction bit is\r
   *    cleared to prevent endpoint type corruption\r

-  *  - Fix documentation mentioning Pipe_GetCurrentToken() function when real name is Pipe_GetPipeToken()\r
-  *  - Extend USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch\r
-  *  - Added new USE_INTERNAL_SERIAL define for using the unique serial numbers in some AVR models as the USB device's serial number,\r
-  *    added NO_INTERNAL_SERIAL compile time option to turn off new serial number reading code\r
+  *  - Fixed issue opening CDC-ACM ports on hosts when the CDC device tries to send data before the host has set the line encoding\r
+  *  - Fixed USB_OPT_MANUAL_PLL option being ignored during device disconnects on some models (thanks to Brian Dickman)\r
+  *  - Fixed documentation mentioning Pipe_GetCurrentToken() function when correct function name is Pipe_GetPipeToken()\r

   *  - Fixed ADC driver for the ATMEGA32U4 and ATMEGA16U4 (thanks to Opendous Inc.)\r
   *  - Fixed ADC driver for the ATMEGA32U4 and ATMEGA16U4 (thanks to Opendous Inc.)\r

+  *  - Fixed CDCHost demo unfreezing the pipes at the point of configuration, rather than use\r
+  *  - Fixed MassStorage demo not clearing the reset flag when a Mass Storage Reset is issued while not processing a command\r
+  *  - Fixed USB_Host_SendControlRequest() not re-suspending the USB bus when initial device ready-wait fails\r
+  *  - Fixed USB Pad regulator not being disabled on some AVR models when the USB_OPT_REG_DISABLED option is used\r
+  *  - Fixed Host mode to Device mode UID change not causing a USB Disconnect event when a device was connected\r
+  *  - Fixed Mouse/Keyboard demos not performing the correct arithmetic on the Idle period at the right times (thanks to Brian Dickman)\r
+  *  - Fixed GenericHID failing HID class tests due to incorrect Logical Minimum and Logical Maximum values (thanks to Søren Greiner)\r
+  *  - Fixed incorrect PIPE_EPNUM_MASK mask causing pipe failures on devices with endpoint addresses of 8 and above (thanks to John Andrews)\r
+  *  - Fixed report data alignment issues in the MouseHostWithParser demo when X and Y movement data size is not a multiple of 8 bits\r
+  *  - Fixed HID Report Descriptor Parser not correctly resetting internal states when a REPORT ID element is encountered\r
+  *  - Fixed incorrect BUTTONS_BUTTON1 for the STK526 target\r
+  *  - Fixed RNDIS demos freezing when more than one connection was attempted simultaneously, causing memory corruption\r
+  *  - Fixed USBtoSerial demo receiving noise from the USART due to pullup not being enabled\r

   *\r
   *\r
   *  \section Sec_ChangeLog090605 Version 090605\r
   *\r
   *\r
   *  \section Sec_ChangeLog090605 Version 090605\r


@@ -57,6 +179,8 @@
   *    LUFA/Drivers/USB/Class/ directory to LUFA/Drivers/USB/HighLevel/ in preperation for the new USB class APIs\r
   *  - Moved out each demos' functionality library files (e.g. Ring Buffer library) to /Lib directories for a better directory structure\r
   *  - Removed Tx interrupt from the USBtoSerial demo; now sends characters via polling to ensure more time for the Rx interrupt\r
   *    LUFA/Drivers/USB/Class/ directory to LUFA/Drivers/USB/HighLevel/ in preperation for the new USB class APIs\r
   *  - Moved out each demos' functionality library files (e.g. Ring Buffer library) to /Lib directories for a better directory structure\r
   *  - Removed Tx interrupt from the USBtoSerial demo; now sends characters via polling to ensure more time for the Rx interrupt\r

+  *  - Fixed possible enumeration errors from spinloops which may fail to exit if the USB connection is severed before the exit condition\r
+  *    becomes true\r

   *\r
   *\r
   *  \section Sec_ChangeLog090510 Version 090510\r
   *\r
   *\r
   *  \section Sec_ChangeLog090510 Version 090510\r


@@ -382,7 +506,7 @@
   *  - 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
   *  - 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
+  *  - Fixed Serial_IsCharReceived() definition, was previously reversed\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
   *  - 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