* \section Sec_ChangeLogXXXXXX Version XXXXXX\r
*\r
* <b>New:</b>\r
- * - Added new class drivers and matching demos to the library for rapid application development\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
+ * 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
+ * - 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
+ * 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
+ * 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
+ *\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
+ * - 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
* - 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
- * - Updated MassStorage device block write routines to use ping-pong Dataflash buffering to increase throughput by around 30%\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 low-level CDC demo, to show how to create standard streams out of the virtual serial ports\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 TOTAL_NUM_CONFIGURATIONS compile time options\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 PrinterHost demo (thanks to John Andrews)\r
* - Added new USB_DeviceState variable to keep track of the current Device mode USB state\r
- * - Added new Endpoint_ClearStatusStage() convenience function to assist with the status stages of control transfers\r
- * - Added new Benito Arduino Programmer project\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 errors to the Webserver in the RNDIS demos to indicate invalid URLs\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
- * - Internal per-device preprocessing conditions changed to per-device series rather than per controller group for finer-grain\r
- * internal control\r
* - Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow errors\r
- * - Extended USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch\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
- * - 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
* - Changed F_CLOCK entries in project makefiles to alias to F_CPU by default, as this is the most common case\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
* - 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
- * - 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
+ * - 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
* 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
+ * - 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 CDCHost demo unfreezing the pipes at the point of configuration, rather than use\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
* - 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
projects / pub / lufa.git / blobdiff