-/** \file\r
- *\r
- * This file contains special DoxyGen information for the generation of the main page and other special\r
- * documentation pages. It is not a project source file.\r
- */\r
-\r
- /** \page Page_ChangeLog Project Changelog\r
- *\r
- * \section Sec_ChangeLogXXXXXX Version XXXXXX\r
- *\r
- * - Removed psuedo-scheduler, dynamic memory block allocator from the library (no longer needed and not used respectively)\r
- * - Added new class drivers and matching demos to the library for rapid application development\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
- * - 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
- *\r
- *\r
- * \section Sec_ChangeLog090605 Version 090605\r
- *\r
- * - Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest structure for control request data\r
- * - Fixed documentation showing incorrect USB mode support on the supported AVRs list\r
- * - Fixed RNDISEthernet not working under Linux due to Linux requiring an "optional" RNDIS request which was unhandled\r
- * - Fixed Mouse and Keyboard device demos not acting in accordance with the HID specification for idle periods (thanks to Brian Dickman)\r
- * - Removed support for endpoint/pipe non-control interrupts; these did not act in the way users expected, and had many subtle issues\r
- * - Fixed Device Mode not handling Set Feature and Clear Feature Chapter 9 requests that are addressed to the device (thanks to Brian Dickman)\r
- * - Moved control endpoint interrupt handling into the library itself, enable via the new INTERRUPT_CONTROL_ENDPOINT token\r
- * - Fixed CDCHost not clearing configured pipes and resetting configured pipes mask when a partially enumerated invalid CDC\r
- * interface is skipped\r
- * - Clarified the size of library tokens which accept integer values in the Compile Time Tokens page, values now use the smallest datatype\r
- * inside the library that is able to hold their defined value to save space\r
- * - Removed DESCRIPTOR_ADDRESS() macro as it was largely supurflous and only served to obfuscate code\r
- * - Rewritten event system to remove all macros, to make user code clearer\r
- * - Fixed incorrect ENDPOINT_EPNUM_MASK mask preventing endpoints above EP3 from being selected (thanks to Jonathan Oakley)\r
- * - Removed STREAM_CALLBACK() macro - callbacks now use regular function definitions to clarify user code\r
- * - Removed DESCRIPTOR_COMPARATOR() macro - comparators should now use regular function definitions to clarify user code\r
- * - USB_IsConnected is now cleared before the USB_Disconnect() event is fired in response to VBUS being removed\r
- * - Fixed incorrect PID value being used in the USBtoSerial project (thanks to Phill)\r
- * - Deleted StdDescriptors.c, renamed USB_GetDescriptor() to CALLBACK_USB_GetDescriptor, moved ConfigDescriptor.c/.h from the\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
- *\r
- *\r
- * \section Sec_ChangeLog090510 Version 090510\r
- *\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
- * - Fixed missing semicolon in the ATAVRUSBRF01 LED board driver code (thanks to Morten Lund)\r
- * - Changed LED board driver code to define dummy LED masks for the first four board LEDs, so that user code can be compiled for boards\r
- * with less than four LEDs without code modifications (thanks to Morten Lund)\r
- * - Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button\r
- * - Serial driver now correctly calculates the baud register value when in double speed mode\r
- * - Init function of the Serial driver is now static inline to product smaller code for the common-case of static init values\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 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 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 new F_CLOCK compile time constant to the library and makefiles, to give the raw input clock (used to feed the PLL before any\r
- * clock prescaling is performed) frequency, so that the PLL prescale mask can be determined\r
- * - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with\r
- * badly designed hosts or devices which greatly exceed the USB specification limits\r
- * - Mass Storage Host demo now uses a USB_STREAM_TIMEOUT_MS of two seconds to maintain compatibility with poorly designed devices\r
- * - Function attribute ATTR_ALWAYSINLINE renamed to ATTR_ALWAYS_INLINE to match other function attribute macro naming conventions\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 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
- * - PWM timer mode in AudioOut demo changed to Fast PWM for speed\r
- * - Updated Magstripe project to work with the latest hardware revision\r
- * - Fixed library not responding to the BCERRI flag correctly in host mode, leading to device lockups\r
- * - Fixed library handling Get Descriptor requests when not addressed as standard requests to the device or interface (thanks to\r
- * Nate Lawson)\r
- * - Fixed serious data corruption issue in MassStorage demo dataflash write routine\r
- * - Added new NO_CLEARSET_FEATURE_REQUEST compile time token\r
- * - USB task now restores previous global interrupt state after execution, rather than forcing global interrupts to be enabled\r
- * - Fixed USB_DeviceEnumerationComplete event firing after each configuration change, rather than once after the initial configuration\r
- * - Added ENDPOINT_DOUBLEBANK_SUPPORTED() macros to Endpoint.h, altered ENDPOINT_MAX_SIZE() to allow user to specify endpoint\r
- * - ENDPOINT_MAX_ENDPOINTS changed to ENDPOINT_TOTAL_ENDPOINTS, PIPE_MAX_PIPES changed to PIPE_TOTAL_PIPES\r
- * - Endpoint and Pipe non-control stream functions now ensure endpoint or pipe is ready before reading or writing\r
- * - Changed Teensy bootloader to use a watchdog reset when exiting rather than a software jump\r
- * - Fixed integer promotion error in MassStorage and MassStorageHost demos, corrupting read/write transfers\r
- * - SPI_SendByte is now SPI_TransferByte, added new SPI_SendByte and SPI_ReceiveByte functions for fast one-way transfer\r
- * - MassStorage demo changed to use new fast one-way SPI transfers to increase throughput\r
- * - MassStorage handling of Mass Storage Reset class request improved\r
- * - Altered MassStorage demo dataflash block read code for speed\r
- * - Added USB_IsSuspended global flag\r
- * - Simplified internal Dual Mode (OTG) USB library code to reduce code size\r
- * - Extended stream timeout period to 100ms from 50ms\r
- * - Mass Storage Host demo commands now all return an error code from the Pipe_Stream_RW_ErrorCodes_t enum\r
- * - Added SubErrorCode parameter to the USB_DeviceEnumerationFailed event\r
- * - VBUS drop interrupt now disabled during the manual-to-auto VBUS delivery handoff\r
- * - Simplified low level backend so that device/host mode initialization uses the same code paths\r
- * - Added workaround for faulty Mass Storage devices which do not implement the required GET_MAX_LUN request\r
- * - Removed buggy Telnet application from the RNDIS demo\r
- * - Moved Mass Storage class requests in the Mass Storage Host demo to wrapper functions in MassStoreCommands.c\r
- * - Fixed incorrect SCSI command size value in the Request Sense command in MassStoreCommands.c\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 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 KeyboardHostWithParser demo linking against the wrong global variables\r
- * - Completed doxygen documentation of remaining library bootloaders, demos and projects\r
- * - Fixed incorrect bootloader start address in the TeensyHID bootloader\r
- * - Added HWB button whole-disk ASCII dump functionality to MassStoreHost demo\r
- * - Replaced printf_P(PSTR("%c"), {Variable}) calls with putchar(<Variable>) for speed and size savings\r
- * - Serial driver now accepts baud rates over 16-bits in size, added double speed flag option\r
- * - Fixed incorrect callback abort return value in Pipe.c\r
- * - Added new flip-ee and dfu-ee makefile targets (courtesy of Opendous Inc.)\r
- * - Removed reboot-on-disconnect code from the TeensyHID bootloader, caused problems on some systems\r
- * - Fixed AudioOutput and AudioInput demos looping on the endpoint data, rather than processing a sample at a time and returning\r
- * each time the task runs to allow for other tasks to execute\r
- * - Added support for the Atmel ATAVRUSBRF01 board\r
- * - Added AVRISP Programmer Project, courtesy of Opendous Inc.\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
- * - Fixed Mass Storage Host demo's MassStore_SendCommand() delay in the incorrect place\r
- * - Fixed USBtoSerial demo not calling ReconfigureUSART() after a change in the line encoding\r
- * - Fixed infinite loop in host mode Host-to-Device control transfers with data stages\r
- * - HID report parser now supports devices with multiple reports in one interface via Report IDs\r
- * - Fixed RZUSBSTICK board LED driver header incorrect macro definition order causing compile errors\r
- * - Calling USB_Init() when the USB interface is already configured now forces a complete interface reset\r
- * and re-enumeration - fixes MyUSB DFU bootloader not switching to app code correctly when soft reset used\r
- * - Fixed "No newline at end of file" warning when stream callbacks are enabled\r
- * - DFU bootloader now uses fixed signature bytes per device, rather than reading them out dynamically for size\r
- * - Added new FIXED_CONTROL_ENDPOINT_SIZE and USE_SINGLE_DEVICE_CONFIGURATION switches to statically define certain values to\r
- * reduce compiled binary size\r
- * - Added new NO_LIMITED_CONTROLLER_CONNECT switch to prevent the library from trying to determine bus connection\r
- * state from the suspension and wake up events on the smaller USB AVRs\r
- * - Added summary of all library compile time tokens to the documentation\r
- * - Added overview of the LUFA scheduler to the documentation\r
- * - Removed MANUAL_PLL_CONTROL compile time token, replaced with a mask for the USB_Init() Options parameter\r
- * - CDC bootloader now uses the correct non-far or far versions of the pgm_* functions depending on if RAMPZ is defined\r
- * - Doxygen documentation now contains documentation on all the projects, bootloaders and most demos included with the library\r
- * - CDC bootloader now runs user application when USB disconnected rather than waiting for a hard reset\r
- * - MouseHostWithParser and KeyboardHostWithParser now support multiple-report devices\r
- * - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver \r
- * - Fixed the DFU bootloader, no longer freezes up when certain files are programmed into an AVR, made reading/writing faster\r
- * - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal \r
- * right-handed system\r
- * - Added stub code to the CDC and USBtoSerial demos showing how to read and set the RS-232 handshake lines - not currently used in\r
- * the demos, but the example code and supporting defines are now in place\r
- * - Interrupts are now disabled when processing a control request in device mode, to avoid exceeding the strict control request\r
- * timing requirements.\r
- * - All demos now use a central StatusUpdate() function rather than direct calls to the board LED functions, so that the demos can\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 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
- * - Added intermediate states to the host mode state machine, reducing the USB task blocking time to no more than 1ms explicitly per\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 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
- * 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
- * - Added DriverStubs directory to house board level driver templates, to make MyUSB compatible custom board\r
- * driver creation easier\r
- * - Extended MassStorage demo to support multiple LUNs, 2 by default\r
- * - Fixed incorrect device address mask, preventing the device from enumerating with addresses larger than 63\r
- * - Fixed incorrect data direction mask in the GetStatus standard request, preventing it from being handled\r
- * - Fixed incorrect GetStatus standard request for endpoints, now returns the endpoint STALL status correctly\r
- * - Added in new USB_RemoteWakeupEnabled and USB_CurrentlySelfPowered flags rather than using fixed values\r
- * - Added DualCDC demo to demonstrate the use of Interface Association Descriptors\r
- * - Added pipe NAK detection and clearing API\r
- * - Added pipe status change (NAK, STALL, etc.) interrupt API\r
- * - Fixed MassStorageHost demo so that it no longer freezes randomly when issuing several commands in a row\r
- * - Host demos configuration descriptor routines now return a unique error code when the returned data does\r
- * not have a valid configuration descriptor header\r
- * - Added Endpoint_WaitUntilReady() and Pipe_WaitUntilReady() functions\r
- * - Stream functions now have software timeouts, timeout period can be set by the USB_STREAM_TIMEOUT_MS token\r
- * - All demos now pass the USB.org automated Chapter 9 device compliance tests\r
- * - All HID demos now pass the USB.org automated HID compliance tests\r
- * - Polling interval of the interrupt endpoint in the CDC based demos changed to 0xFF to fix problems on Linux systems\r
- * - Changed stream functions to accept a new callback function, with NO_STREAM_CALLBACKS used to disable all callbacks\r
- * - Mass Storage demo dataflash management routines changed to use the endpoint stream functions \r
- * - Added AVRStudio project files for each demo in addition to the existing Programmer's Notepad master project file\r
- * - Re-added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes\r
- * are reflected in the hardware (change was previously lost)\r
- *\r
- *\r
- * \section Sec_ChangeLog152 Version 1.5.2 - Released 31st July, 2008\r
- *\r
- * - Fixed SwapEndian_32() function in Common.h so that it now works correctly (wrong parameter types)\r
- * - Updated RNDIS demo - notification endpoint is no longer blocking so that it works with faulty Linux RNDIS\r
- * implementations (where the notification endpoint is ignored in favour of polling the control endpoint)\r
- * - Fixed incorrect Vendor Description string return size in RNDIS demo for the OID_GEN_VENDOR_DESCRIPTION OID token\r
- * - Added very basic TCP/IP stack and HTTP/TELNET servers to RNDIS demo\r
- * - Fixed DFU bootloader exit causing programming software to complain about failed writes\r
- * - Fixed DFU bootloader EEPROM programming mode wiping first flash page\r
- * - Fixed Clear/Set Feature device standard request processing code (fixing MassStorage demo in the process)\r
- * - Added support for the ATMEGA16U4 AVR microcontroller\r
- * - Library licence changed from LGPLv3 to MIT license\r
- *\r
- *\r
- * \section Sec_ChangeLog151 Version 1.5.1 - Released 31st July, 2008\r
- *\r
- * - Changed host demos to enable the host function task on the firing of the USB_DeviceEnumerationComplete event\r
- * rather than the USB_DeviceAttached event\r
- * - HID Usage Stack now forcefully cleared after an IN/OUT/FEATURE item has been completely processed to remove\r
- * any referenced but not created usages\r
- * - Changed USB_INT_DisableAllInterrupts() and USB_INT_ClearAllInterrupts(), USB_Host_GetNextDescriptorOfType(),\r
- * USB_Host_GetNextDescriptorOfTypeBefore(), USB_Host_GetNextDescriptorOfTypeAfter() to normal functions (from inline)\r
- * - Fixed USBtoSerial demo not sending data, only receiving\r
- * - Fixed main makefile to make all by default, fixed MagStripe directory case to prevent case-sensitive path problems\r
- * - ConfigDescriptor functions made normal, instead of static inline\r
- * - Pipe/Endpoint *_Ignore_* functions changed to *_Discard_*, old names still present as aliases\r
- * - Fixed ENDPOINT_MAX_SIZE define to be correct on limited USB controller AVRs\r
- * - Changed endpoint and pipe size translation routines to use previous IF/ELSE IF cascade code, new algorithmic\r
- * approach was buggy and caused problems\r
- * - Bootloaders now compile with -fno-inline-small-functions option to reduce code size\r
- * - Audio demos now use correct endpoint sizes for full and limited controller USB AVRs, double banking in all cases\r
- * to be in line with the specification (isochronous endpoints MUST be double banked)\r
- * - Added Interface Association descriptor to StdDescriptors.h, based on the relevant USB2.0 ECN\r
- * - Fixed MIDI demo, corrected Audio Streaming descriptor to follow the MIDI-specific AS structure\r
- * - Fixed HID class demo descriptors so that the HID interface's protocol is 0x00 (required for non-boot protocol HID\r
- * devices) to prevent problems on hosts expecting the boot protocol functions to be supported\r
- * - Added read/write control stream functions to Endpoint.h\r
- * - Fixed AudioOut demo not setting port pins to inputs on USB disconnect properly\r
- * - Added RNDISEthernet demo application\r
- *\r
- *\r
- * \section Sec_ChangeLog150 Version 1.5.0 - Released 10 June, 2008\r
- *\r
- * - Fixed MIDI demo, now correctly waits for the endpoint to be ready between multiple note messages\r
- * - Added CDC Host demo application\r
- * - Added KeyboardFullInt demo application\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 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
- * - Added preprocessor checks to enable C linkage on the library components when used with a C++ compiler\r
- * - Added Still Image Host demo application\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 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 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, 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 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
- * of ASCII characters\r
- * - Fixed Endpoint/Pipes being configured incorrectly if the maximum endpoint/pipe size for the selected USB AVR\r
- * model was given as the bank size\r
- * - HID device demos now use a true raw array for the HID report descriptor rather than a struct wrapped array\r
- * - Added VERSION_BCD() macro, fixed reported HID and USB version numbers in demo descriptors\r
- * - Cleaned up GetDescriptor device chapter 9 handler function\r
- * - Added GET_REPORT class specific request to HID demos to make them complaint to the HID class\r
- * - Cleaned up setting of USB_IsInitialized and USB_IsConnected values to only when needed\r
- * - Removed Atomic.c and ISRMacro.h; the library was already only compatible with recent avr-lib-c for other reasons\r
- * - All demos and library functions now use USB standardized names for the USB data (bRequest, wLength, etc.)\r
- * - Added USE_NONSTANDARD_DESCRIPTOR_NAMES token to switch back to the non-standard descriptor element names\r
- *\r
- *\r
- * \section Sec_ChangeLog141 Version 1.4.1 - Released 5 May, 2008\r
- *\r
- * - Enhanced KeyboardWithParser demo, now prints out pressed alphanumeric characters like the standard demo\r
- * - Fixed MassStorage demo, read/writes using non mode-10 commands now work correctly\r
- * - Corrected version number in Version.h\r
- *\r
- *\r
- * \section Sec_ChangeLog140 Version 1.4.0 - Released 5 May, 2008\r
- *\r
- * - Added HID Report Parser API to the library\r
- * - Added Mouse and Keyboard host demo applications, using the new HID report parser engine\r
- * - Added MouseFullInt demo, which demonstrates a fully interrupt (including control requests) mouse device\r
- * - Fixed incorrect length value in the audio control descriptor of the AudioOutput and AudioInput demos\r
- * - Added MIDI device demo application to the library\r
- * - Fixed problem preventing USB devices from being resumed from a suspended state\r
- * - Added new CDC class bootloader to the library, based on the AVR109 bootloader protocol\r
- * - Added header to each demo application indicating the mode, class, subclass, standards used and supported speed\r
- * - Functions expecting endpoint/pipe numbers are no longer automatically masked against ENDPOINT_EPNUM_MASK or\r
- * PIPE_PIPENUM_MASK - this should be manually added to code which requires it\r
- * - Fixed DFU class bootloader - corrected frequency of flash page writes, greatly reducing programming time\r
- * - Renamed AVR_HOST_GetDeviceConfigDescriptor() to USB_Host_GetDeviceConfigDescriptor() and AVR_HOST_GetNextDescriptor()\r
- * to USB_Host_GetNextDescriptor()\r
- * - Added new USB_Host_GetNextDescriptorOfTypeBefore() and USB_Host_GetNextDescriptorOfTypeAfter() routines\r
- * - Moved configuration descriptor routines to MyUSB/Drivers/USB/Class/, new accompanying ConfigDescriptors.c file\r
- * - Added new configuration descriptor comparator API for more powerful descriptor parsing, updated host demos to use the\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 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
- *\r
- * \section Sec_ChangeLog132 Version 1.3.2 - Released April 1st, 2008\r
- *\r
- * - Added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes\r
- * are reflected in the hardware\r
- * - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the \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
- * - 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
- * - Added support for the ATMEGA32U4 AVR\r
- * - Added MANUAL_PLL_CONTROL compile time option to prevent the USB library from manipulating the PLL\r
- *\r
- *\r
- * \section Sec_ChangeLog131 Version 1.3.1 - Released March 19th 2008\r
- *\r
- * - Fixed USB to Serial demo - class value in the descriptors was incorrect\r
- * - Control endpoint size changed from 64 bytes to 8 bytes to save on USB FIFO RAM and to allow low\r
- * speed mode devices to enumerate properly\r
- * - USB to Serial demo data endpoints changed to dual-banked 16 byte to allow the demo to work\r
- * on USB AVRs with limited USB FIFO RAM\r
- * - Changed demo endpoint numbers to use endpoints 3 and 4 for double banking, to allow limited\r
- * USB device controller AVRs (AT90USB162, AT90USB82) to function correctly\r
- * - Updated Audio Out demo to use timer 1 for AVRs lacking a timer 3 for the PWM output\r
- * - Fixed incorrect USB_DEV_OPT_HIGHSPEED entry in the Mass Storage device demo makefile\r
- * - Optimized Mass Storage demo for a little extra transfer speed\r
- * - Added LED indicators to the Keyboard demo for Caps Lock, Num Lock and Scroll Lock\r
- * - Added Endpoint_Read_Stream, Endpoint_Write_Stream, Pipe_Read_Stream and Pipe_Write_Stream functions\r
- * (including Big and Little Endian variants)\r
- * - Made Dataflash functions inline for speed, removed now empty Dataflash.c driver file\r
- * - Added new SetSystemClockPrescaler() macro (thanks to Joerg Wunsch)\r
- * - Fixed Endpoint_ClearStall() to function correctly on full USB controller AVRs (AT90USBXXX6/7)\r
- * - Endpoint_Setup_In_Clear() and Endpoint_Setup_Out_Clear() no longer set FIFOCON, in line with the\r
- * directives in the datasheet\r
- * - Fixed PLL prescaler defines for all AVR models and frequencies\r
- * - Fixed ENDPOINT_INT_IN and ENDPOINT_INT_OUT definitions\r
- * - Added interrupt driven keyboard and mouse device demos\r
- * - Combined USB_Device_ClearFeature and USB_Device_SetFeature requests into a single routine for code\r
- * size savings\r
- * - Added missing Pipe_GetCurrentPipe() macro to Pipe.h\r
- *\r
- *\r
- * \section Sec_ChangeLog130 Version 1.3.0 - Released March 7th 2008\r
- *\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
- * - All demos now disable watchdog on startup, in case it has been enabled by fuses or the bootloader\r
- * - USB_DEV_OPT_LOWSPEED option now works correctly\r
- * - Added ability to set the USB options statically for a binary size reduction via the USE_STATIC_OPTIONS\r
- * compile time define\r
- * - USB_Init no longer takes a Mode parameter if compiled for a USB device with no host mode option, or\r
- * if forced to a particular mode via the USB_HOST_ONLY or USB_DEVICE_ONLY compile time options\r
- * - USB_Init no longer takes an Options parameter if options statically configured by USE_STATIC_OPTIONS\r
- * - Endpoint_Ignore_* and Pipe_Ignore_* made smaller by making the dummy variable non-volatile so that the\r
- * compiler can throw away the result more efficiently\r
- * - Added in an optional GroupID value to each scheduler entry, so that groups of tasks can once again be\r
- * controlled by the new Scheduler_SetGroupTaskMode() routine\r
- * - Added support for AT90USB162 and AT90USB82 AVR models\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 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
- * - Renamed USB_DEV_OPT_HIGHSPEED to USB_DEV_OPT_FULLSPEED and USB_HOST_IsDeviceHighSpeed() to\r
- * USB_HOST_IsDeviceFullSpeed() to be in line with the official USB speed names (to avoid confusion with\r
- * the real high speed mode, which is unavailable on the USB AVRs)\r
- *\r
- *\r
- * \section Sec_ChangeLog120 Version 1.2.0 - Released February 4th, 2008\r
- *\r
- * - Added USB_DeviceEnumerationComplete event for host mode\r
- * - Added new Scheduler_Init routine to preprepare the scheduler, so that tasks can be started and\r
- * stopped before the scheduler has been started (via Scheduler_Start)\r
- * - Connection events in both Device and Host mode are now interrupt-driven, allowing the USB management\r
- * task to be stopped when the USB is not connected to a host or device\r
- * - All demos updated to stop the USB task when not in use via the appropriate USB events\r
- * - Mass Storage Host demo application updated to function correctly with all USB flash disks\r
- * - Mass Storage Host demo application now prints out the capacity and number of LUNs in the attached\r
- * device, and prints the first block as hexadecimal numbers rather than ASCII characters\r
- * - Endpoint and Pipe clearing routines now clear the Endpoint/Pipe interrupt and status flags\r
- * - Shifted error handling code in the host enum state machine to a single block, to reduce code complexity\r
- * - Added in DESCRIPTOR_TYPE, DESCRIPTOR_SIZE and DESCRIPTOR_CAST macros to make config descriptor processing\r
- * clearer in USB hosts and DESCRIPTOR_ADDRESS for convenience in USB devices\r
- * - Added in alloca macro to common.h, in case the user is using an old version of avr-lib-c missing the macro\r
- *\r
- *\r
- * \section Sec_ChangeLog130 Version 1.1.0 - Released January 25th 2008\r
- *\r
- * - Fixed DCONNI interrupt being enabled accidentally after a USB reset\r
- * - Fixed DDISCI interrupt not being disabled when a device is not connected\r
- * - Added workaround for powerless pullup devices causing false disconnect interrupts\r
- * - Added USB_DeviceEnumerationFailed event for Host mode\r
- * - AVR_HOST_GetDeviceConfigDescriptor routine no longer modifies ConfigSizePtr if a valid buffer\r
- * pointer is passed\r
- * - Added ALLOCABLE_BYTES to DynAlloc, and added code to make the size of key storage variables\r
- * dependant on size of memory parameters passed in via the user project's makefile\r
- * - Fixed incorrect device reset routine being called in USBTask\r
- * - Devices which do not connect within the standard 300mS are now supported\r
- * - Removed incorrect ATTR_PURE from Scheduler_SetTaskMode(), which was preventing tasks from being\r
- * started/stopped, as well as USB_InitTaskPointer(), which was breaking dual device/host USB projects\r
- * - Changed scheduler to use the task name rather than IDs for setting the task mode, eliminating the\r
- * need to have a task ID list\r
- * - ID transistion interrupt now raises the appropriate device/host disconnect event if device attached\r
- * - Fixed double VBUS change (and VBUS -) event when detatching in device 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
- */\r
projects / pub / USBasp.git / commitdiff
