Remove documentation of deleted parameters from the RNDIS Host Class driver's device...
[pub/lufa.git] / LUFA / ManPages / ChangeLog.txt
index 321a7d6..d06d913 100644 (file)
@@ -9,6 +9,86 @@
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
   *\r
   *  <b>New:</b>\r
+  *  - Added activity LED indicators to the AVRISP project to indicate when the device is busy processing a command\r
+  *  - The USB target family and allowable USB mode tokens are now public and documented (USB_CAN_BE_*, USB_SERIES_*_AVR)\r
+  *  - Added new XPLAIN USB to Serial Bridge project (thanks to John Steggall)\r
+  *  - Added new RNDISHost Host LowLevel demo\r
+  *  - Added new RNDIS Ethernet Host Class Driver\r
+  *  - Added new RNDISEthernet Host ClassDriver demo\r
+  *\r
+  *  <b>Changed:</b>\r
+  *  - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of keycodes\r
+  *    as this relied on non-standard OS driver behaviour to repeat key groups\r
+  *  - The SCSI_Request_Sense_Response_t and SCSI_Inquiry_Response_t type defines are now part of the Mass Storage Class\r
+  *    driver common defines, rather than being defined in the Host mode Class driver section only\r
+  *  - The USB_MODE_HOST token is now defined even when host mode is not available\r
+  *  - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to\r
+  *    indicate the report type to generate\r
+  *  - All Class Drivers now return false or the "DeviceDisconnected" error code of their respective error enums when a function\r
+  *    is called when no host/device is connected where possible\r
+  *  - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to HOST_SENDCONTROL_DeviceDisconnected to be in line\r
+  *    with the rest of the library errorcodes.\r
+  *\r
+  *  <b>Fixed:</b>\r
+  *  - Added missing CDC_Host_CreateBlockingStream() function code to the CDC Host Class driver\r
+  *  - Fixed incorrect values for REPORT_ITEM_TYPE_* enum values causing corrupt data in the HID Host Parser\r
+  *  - Fixed misnamed SI_Host_USBTask() and SI_Host_ConfigurePipes() functions\r
+  *  - Fixed broken USB_GetNextDescriptor() function causing the descriptor to jump ahead double the expected amount\r
+  *  - Fixed Pipe_IsEndpointBound() not masking the given Endpoint Address against PIPE_EPNUM_MASK\r
+  *  - Fixed host state machine not enabling Auto VBUS mode when HOST_DEVICE_SETTLE_DELAY_MS is set to zero\r
+  *  - Fixed misnamed Pipe_SetPipeToken() macro for setting a pipe's direction\r
+  *  - Fixed CDCHost failing on devices with bidirectional endpoints\r
+  *\r
+  *  \section Sec_ChangeLog091122 Version 091122\r
+  *\r
+  *  <b>New:</b>\r
+  *  - Added new Dual Role Keyboard/Mouse demo\r
+  *  - Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the HID Host Class driver when\r
+  *    Report protocol is not needed\r
+  *  - Added new MIDI LowLevel and ClassDriver Host demo, add new MIDI Host Class driver\r
+  *  - Added new CDC/Mouse ClassDriver device demo\r
+  *  - Added new Joystick Host ClassDriver and LowLevel demos\r
+  *  - Added new Printer Host mode Class driver\r
+  *  - Added new Printer Host mode ClassDriver demo\r
+  *  - Added optional support for double banked endpoints and pipes in the Device and Host mode Class drivers\r
+  *  - Added new stream creation function to the CDC Class drivers, to easily make standard I/O streams from CDC Class driver instances\r
+  *\r
+  *  <b>Changed:</b>\r
+  *  - Removed mostly useless "TestApp" demo, as it was mainly useful only for checking for sytax errors in the library\r
+  *  - MIDI device demos now receive MIDI events from the host and display note ON messages via the board LEDs\r
+  *  - Cleanups to the Device mode Mass Storage demo application SCSI routines\r
+  *  - Changed Audio Class driver sample read/write functions to be inline, to reduce the number of cycles needed to transfer\r
+  *    samples to and from the device (allowing more time for sample processing and output)\r
+  *  - Audio class Device mode demos now work at both 16MHz and 8MHz, rather than just at 8MHz\r
+  *  - The previous USBtoSerial demo has been moved into the projects directory, as it was just a modified CDC demo\r
+  *  - The Endpoint/Pipe functions now use the const qualifier on the input buffer\r
+  *  - Changed the CALLBACK_HIDParser_FilterHIDReportItem() callback to pass a HID_ReportItem_t rather than just the current\r
+  *    item's attributes, to expose more information on the item (including it's type, collection path, etc.)\r
+  *  - Changed MouseHostWithParser demos to check that the report items have a Mouse usage collection as a parent at some point,\r
+  *    to prevent Joysticks from enumerating with the demo\r
+  *  - Corrected the name of the misnamed USB_GetDeviceConfigDescriptor() function to USB_Host_GetDeviceConfigDescriptor().\r
+  *  - Keyboard LowLevel/ClassDriver demos now support multiple simultaneous keypresses (up to 6) per report\r
+  *\r
+  *  <b>Fixed:</b>\r
+  *  - Fixed PrinterHost demo returning invalid Device ID data when the attached device does not have a\r
+  *    device ID (thanks to Andrei Krainev)\r
+  *  - Changed LUFA_VERSION_INTEGER define to use BCD values, to make comparisons eaiser\r
+  *  - Fixed issue in the HID Host class driver's HID_Host_SendReportByID() routine using the incorrect mode (control/pipe)\r
+  *    to send report to the attached device\r
+  *  - Fixed ClassDriver AudioOutput device demo not selecting an audio output mode\r
+  *  - Fixed incorrect SampleFrequencyType value in the AudioInput and AudioOutput ClassDriver demos' descriptors\r
+  *  - Fixed incorrect event name rule in demo/project/bootloader makefiles\r
+  *  - Fixed HID device class driver not reselecting the correct endpoint once the user callback routines have been called\r
+  *  - Corrected HID descriptor in the Joystick Device demos - buttons should be placed outside the pointer collection\r
+  *  - Fixed HID report parser collection paths invalid due to misplaced semicolon in the free path item search loop\r
+  *  - Fixed HID host Class driver report send/receive report broken when issued through the control pipe\r
+  *  - Fixed HOST_STATE_AS_GPIOR compile time option being ignored when in host mode (thanks to David Lyons)\r
+  *  - Fixed LowLevel Keyboard demo not saving the issues report only after it has been sent to the host\r
+  *  - Fixed Endpoint_Write_Control_Stream_* functions not sending a terminating IN when given data Length is zero\r
+  *\r
+  *  \section Sec_ChangeLog090924 Version 090924\r
+  *\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
   *  - 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
+  *  - Added new combined Mass Storage and Keyboard demo (thanks to Matthias Hullin)\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
   *  - 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 from DirectAid.ca)\r
+  *    ATMEGAxx2 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