ChangeLog.txt 139 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653
  1. /** \file
  2. *
  3. * This file contains special DoxyGen information for the generation of the main page and other special
  4. * documentation pages. It is not a project source file.
  5. */
  6. /** \page Page_ChangeLog Project Changelog
  7. *
  8. * \section Sec_ChangeLog170418 Version 170418
  9. * <b>New:</b>
  10. * - Core:
  11. * - Added support for the Pololu A-Star Micro board (thanks to Joh Schneider)
  12. * - Added new \c LUFA_VERSION_RELEASE_TYPE macro to the library version header, to determine release type (thanks to NicoHood)
  13. *
  14. * <b>Fixed:</b>
  15. * - Core:
  16. * - The CALLBACK_USB_GetDescriptor() callback function into the user application erroneously had a uint8_t type for the wIndex
  17. * parameter, instead of uint16_t (thanks to Matlo)
  18. * - Fixed broken USE_RAM_DESCRIPTORS compile time option when the FIXED_NUM_CONFIGURATIONS compile time option is not enabled
  19. * in a user application (thanks to Matlo)
  20. * - Fixed missing \c va_end() calls in the HID bootloader CLI app which could cause portability issues
  21. * - Fixed void pointer arithmetic in the \c Serial_SendData() functions for AVR8 and XMEGA architectures
  22. * - Fixed void pointer arithmetic in the low level and class driver RNDIS demo protocol decoders
  23. * - Fixed low level RNDIS demo incorrectly setting the RNDIS state when a null packet filter was requested
  24. * - Fixed missing entries in several project's Atmel Studio integration files, such as driver INF files
  25. * - Fixed invalid endpoint indexes causing memory corruption in device Clear/Set Feature standard requests (thanks to Peter Popovec)
  26. * - Fixed incorrect serialization in USB_SetHIDReportItemInfo() function (thanks to e-chip)
  27. *
  28. * <b>Changed:</b>
  29. * - Added signed alternative libUSB driver for the AVRISP-MKII clone project, to support Atmel Studio 7 (thanks to Atmel)
  30. * - Removed no longer required LIBUSB_DRIVER_COMPAT and RESET_TOGGLES_LIBUSB_COMPAT configuration options from the AVRISP-MKII
  31. * clone project, as the new libUSB driver works for AVRDUDE and Atmel Studio 7 under Windows
  32. * - Replaced the LUFA build system with its (compatible) successor, DMBS (Dean's Makefile Build System)
  33. * - Removed obsolete library TAR export and associated documentation
  34. * - Fixed incorrect HID_DESCRIPTOR_KEYBOARD() macro definition (thanks to Eric Tang)
  35. *
  36. * \section Sec_ChangeLog151115 Version 151115
  37. * <b>New:</b>
  38. * - Added support for the Atmel Xplained-MINI series of development kits
  39. * - Added new PROGMEM variant send functions to the CDC class device driver (thanks to Stefan Hellermann)
  40. * - Added new PROGMEM variant send functions to the CDC class host driver
  41. * - Added additional Arduino Uno board definitions for the main processor reset (thanks to NicoHood)
  42. * - Added modified DocBook transforms to generate Atmel Studio 6/7 internal help documentation (thanks to Morten Engelhardt Olsen)
  43. *
  44. * <b>Changed:</b>
  45. * - Core:
  46. * - The TWI peripheral driver's TWI_WritePacket() and TWI_ReadPacket() functions now takes a 16-bit Length rather than an 8-bit
  47. * length, for longer transfers
  48. * - Library Applications:
  49. * - The CDC, DFU, Mass Storage and Printer class bootloaders will no longer run the user application if the application reset
  50. * vector is blank (thanks to Alex Kazik)
  51. * - The CDC, DFU and Printer class bootloaders are now compatible with the original Atmel XPLAIN and Arduino Leonardo boards
  52. * - The CDC, DFU, Mass Storage and Printer class bootloaders are not compatible with devices with the BOOTRST fuse set and will
  53. * exit automatically unless an external reset was the last reset cause (thanks to Alex Kazik)
  54. * - Added missing force-inline attribute to the endianness utility functions (thanks to Stefan Hellermann)
  55. * - Updated the DFU build system module to use updated EEPROM programming command arguments for dfu-programmer 0.6.2 or newer
  56. *
  57. * <b>Fixed:</b>
  58. * - Fixed broken XMEGA serial stream driver due to missing USART base pointer parameter (thanks to William Patterson)
  59. * - Fixed incorrect signature reported in the CDC/DFU bootloaders for the AT90USB82 (thanks to NicoHood)
  60. * - Fixed broken RNDIS demos on Linux machines whose DHCP hosts require a Lease Time option (thanks to Stefan Hellermann)
  61. * - Fixed broken LEDs_Disable() implementation for the Arduino Uno board (thanks to NicoHood)
  62. * - Fixed missing bounds checks and off-by-one in the DFU bootloader signature bytes (thanks to Reuti)
  63. *
  64. * \section Sec_ChangeLog140928 Version 140928
  65. * <b>New:</b>
  66. * - Core:
  67. * - Updated the BUILD build system module to add a new COMPILER_PATH optional variable
  68. * - Added Serial_IsSendReady() and Serial_IsSendComplete() functions to the Serial hardware peripheral driver
  69. * - Added support for the Arduino Yun board (ATMEGA32U4 co-processor)
  70. * - Added support for the Arduino Micro board (thanks to Zoltán Szőke)
  71. * - Library Applications:
  72. * - Added new Dual MIDI class driver device demo
  73. *
  74. * <b>Changed:</b>
  75. * - Core:
  76. * - The RNDIS device class driver now takes a user-supplied buffer and buffer length for the internal RNDIS
  77. * message management (thanks to Peter Mc Shane)
  78. *
  79. * <b>Fixed:</b>
  80. * - Core:
  81. * - Fixed device class driver pipe configuration routines returning success with a partially constructed instance
  82. * when a pipe configuration failed (thanks to Helge Suess)
  83. * - Fixed incorrect XMEGA DFLL reference frequency (thanks to Martin Aakerberg)
  84. * - Fixed possible infinite loop in the control endpoint stream write function (thanks to Clayton Knight)
  85. * - Fixed missing HID report ID prefix on HID class driver GetReport request responses (thanks to Bert van Hall)
  86. * - Fixed incorrect XMEGA USB controller clock division factory for non-Full Speed operation (thanks to Bert van Hall)
  87. * - Fixed the LUFA build system to prevent incorrect code from being generated in newer toolchains when building for larger
  88. * FLASH memory devices (thanks to demultiplexer)
  89. * - Fixed missing parenthesis in the MIDI_EVENT() macro which could cause incorrect results (thanks to hexwab)
  90. * - Fixed mixed capitalization of TWI in the XMEGA TWI driver causing compilation failures (thanks to Jacob Schloss)
  91. * - Fixed broken AVR8 USART-SPI peripheral driver (thanks to Phil Zakielarz)
  92. * - Library Applications:
  93. * - Fixed spurious 0xFE USART byte sent in the USBtoSerial project when the baud rate is changed (thanks to Carl Kjeldsen)
  94. * - Fixed blocking USART reads causing low throughput on slow baud rates in the USBtoSerial project (thanks to Nevada Smith)
  95. * - Fixed USART reception overrun corrupting the internal buffers in the USBtoSerial project (thanks to Nevada Smith)
  96. * - Fixed broken LowLevel Audio Out demo sampling frequency configuration (thanks to Torsten Duwe)
  97. *
  98. * \section Sec_ChangeLog140302 Version 140302
  99. * <b>New:</b>
  100. * - Library Applications:
  101. * - Added new Bulk Vendor low level device demo
  102. * - Added new libUSB host Python and NodeJS application examples for the Class driver GenericHID demo (thanks to Laszlo Monda)
  103. * - Added new AVR8 USB option to keep 3.3V regulator enabled (thanks to Michael Hanselmann)
  104. * - Added new USB_STRING_DESCRIPTOR() and USB_STRING_DESCRIPTOR_ARRAY() convenience macros (thanks to Laszlo Monda)
  105. *
  106. * <b>Changed:</b>
  107. * - Library Applications:
  108. * - Refactored out USB interface IDs in the demo applications into enums (thanks to Laszlo Monda)
  109. * - AVRISP-MKII Clone Project PDI/TPI frequency increased from 250KHz to 2MHz as it is now stable
  110. * - Increased TPI/PDI handshake delay to 100us from 1us to support targets with high amounts of capacitance on their
  111. * /RESET lines (thanks to Paul Duke)
  112. * - Changed the VERSION_BCD() macro to accept the major/minor/revision values as separate parameters
  113. *
  114. * <b>Fixed:</b>
  115. * - Core:
  116. * - Fixed MIDI device class driver MIDI_Device_ReceiveEventPacket() for the XMEGA architecture
  117. * - Library Applications:
  118. * - Fixed incorrect signature bytes returned in the DFU bootloader
  119. *
  120. * \section Sec_ChangeLog130901 Version 130901
  121. * <b>New:</b>
  122. * - Core:
  123. * - Added additional MIDI command definitions to the MIDI class driver (thanks to Daniel Dreibrodt)
  124. * - Added new CONCAT() and CONCAT_EXPANDED() convenience macros
  125. * - Added new Printer Device Class driver
  126. * - Added support for the XMEGA C3 Xplained board
  127. * - Added support for the U2S board (thanks to megal0maniac)
  128. * - Added TWI Master driver for the XMEGA architecture (thanks to Michael Janssen)
  129. * - Library Applications:
  130. * - Added new Printer class bootloader
  131. * - Added new Mass Storage class bootloader
  132. * - Added XMEGA support for class driver device demos (where applicable)
  133. * - Added Python host application example for the Generic HID class driver device demo
  134. * - Added Python alternative host application for the HID class bootloader
  135. *
  136. * <b>Changed:</b>
  137. * - Core:
  138. * - Updated the BUILD build system module to produce binary BIN files in addition to Intel HEX files
  139. * - Updated the Android Accessory Class to accept version 2 protocol devices (with version 1 functionality)
  140. * - All board drivers now implement dummy functions and constants when BOARD is set to NONE
  141. * - Added missing LEDs to the XMEGA A3BU Xplained board LED driver (thanks to Michael Janssen)
  142. * - Changed board Dataflash drivers to automatically configure the appropriate SPI interface for the selected board
  143. * - Library Applications:
  144. * - Re-added Set Control Line State request handling to the CDC class bootloader to prevent issues with the .NET serial
  145. * class (thanks to Erik Lins)
  146. * - TemperatureDataLogger project dummy RTC mode now tracks real time (thanks to David Lazarus)
  147. *
  148. * <b>Fixed:</b>
  149. * - Core:
  150. * - Fixed Low Speed USB devices broken when using the library HID Class driver (thanks to Michael)
  151. * - Fixed possible register corruption in USB Host mode on AVR8 devices when ORDERED_EP_CONFIG is used (thanks to Martin Aakerberg)
  152. * - Fixed Pipe_GetBoundEndpointAddress() returning invalid endpoint directions on AVR8 architecture devices (thanks to decerri)
  153. * under some circumstances
  154. * - Fixed incorrect USB device state set when a suspended LUFA device is woken while addressed but not configured (thanks to Balaji Krishnan)
  155. * - Fixed broken USART SPI driver for the AVR8 architecture due to incorrect initialization
  156. * - Fixed re-enumeration issue of XMEGA architecture targets (thanks to Jaroslav Jedlinsky)
  157. * - Fixed error receiving PIMA events via the Still Image Host class driver
  158. * - Library Applications:
  159. * - Added handler for SCSI_CMD_START_STOP_UNIT in demos using the Mass Storage class, to prevent ejection errors on *nix systems due to an
  160. * unknown SCSI command
  161. * - Fixed incorrect HID report descriptor generated for 16-bit axis ranges by the HID_DESCRIPTOR_MOUSE() and HID_DESCRIPTOR_JOYSTICK()
  162. * macros (thanks to Armory)
  163. * - Fixed incorrect HID report descriptor generated for button multiples of 8 by the HID_DESCRIPTOR_MOUSE() and HID_DESCRIPTOR_JOYSTICK()
  164. * macros
  165. * - Fixed race condition in the DFU class bootloader causing failed device reprogramming in some circumstances (thanks to Luis Mendes)
  166. * - Fixed incorrect time/date configuration data order in the TempDataLogger host application (thanks to David Lazarus)
  167. *
  168. * \section Sec_ChangeLog130303 Version 130303
  169. * <b>New:</b>
  170. * - Core:
  171. * - Added support for the Arduino Leonardo board
  172. * - Added support for the Atmel UC3-A3 Xplained board
  173. * - Added support for the Xevelabs USB2AX revision 3.1 board
  174. * - Added support for the Dimex Stange-ISP board (thanks to Gerhard Wesser)
  175. * - Added new \c doxygen_upgrade and \c doxygen_create targets to the DOXYGEN build system module
  176. * - Added new Board Hardware Information board driver
  177. * - Library Applications:
  178. * - Added a different device serial number when the AVRISP-MKII Clone project is in libUSB compatibility mode, so that
  179. * both the libUSB and Jungo drivers can be installed at the same time without having to use a filter driver
  180. *
  181. * <b>Changed:</b>
  182. * - Core:
  183. * - Added workaround for broken VBUS detection on AVR8 devices when a bootloader starts the application
  184. * via a software jump without first turning off the OTG pad (thanks to Simon Inns)
  185. * - Library Applications:
  186. * - Increased throughput in the USBtoSerial project now that data transmission is non-blocking (thanks to Joseph Lacerte)
  187. * - Updated bootloader makefiles to remove dependency on the \c bc command line calculator tool
  188. * - Updated AVRISP-MKII Clone Programmer project so that the SCK clock period is saved in EEPROM (thanks to Gerhard Wesser)
  189. * - Changed all *_SendByte() function prototypes to accept a void pointer for the input buffer (thanks to Simon Kuppers)
  190. *
  191. * <b>Fixed:</b>
  192. * - Core:
  193. * - Fixed incorrectly issuing STALL response to unsupported control request SETUP packets, rather than in the data/status stage
  194. * - Fixed inverted LEDs_GetLEDs() function implementation for the Benito, Minimus and Arduino UNO boards
  195. * - Fixed missing Windows 32-bit compatibility sections in the LUFA INF driver files (thanks to Christan Beharrell)
  196. * - Fixed logic hole breaking USB operations on a USB controller with only one supported USB mode and no USB_DEVICE_ONLY or USB_HOST_ONLY
  197. * configuration token set
  198. * - Fixed possible rounding in the VERSION_BCD() macros for some 0.01 step increments (thanks to Oliver Zander)
  199. * - Fixed incorrect Dataflash functionality in the USBKEY board if the driver is modified for a single Dataflash chip (thanks to Jonathan Oakley)
  200. * - Fixed incorrect definitions of \c HID_KEYBOARD_LED_KANA, \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN and \c HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400
  201. * and added a missing definition for \c HID_KEYBOARD_SC_APPLICATION (thanks to David Monro)
  202. * - Fixed maximum allowed keyboard key code usage of \c 0x65 rather than \c 0xFF for the \c HID_DESCRIPTOR_KEYBOARD() macro (thanks to David Monro)
  203. * - Fixed hardware race condition that could cause failed device enumerations for AVR8 and UC3 architectures (thanks to Mike Beyhs)
  204. * - Fixed incorrect Minimus board LED definitions (thanks to Joonas Lahtinen)
  205. * - Fixed incorrect ordering of the linker options in the build system causing link failures in some cases
  206. * - Fixed bug in the TWI peripheral driver for the AVR8 devices causing incorrect failure codes to be returned in some cases (thanks to Peter K)
  207. * - Fixed swapped LED3 and LED4 masks for the Olimex-32U4 development board LED driver
  208. * - Fixed potential NULL pointer dereference in the HID Host mode Class Driver (thanks to Pavel Kuzmin)
  209. * - Library Applications:
  210. * - Fixed broken RESET_TOGGLES_LIBUSB_COMPAT compile time option in the AVRISP-MKII project
  211. * - Fixed incompatibility in the CDC class bootloader on some systems (thanks to Sylvain Munaut)
  212. * - Fixed lengthy timeouts in the USBtoSerial project if no application on the host is consuming data (thanks to Nicolas Saugnier)
  213. * - Fixed lengthy automatic data flushing in the CDC and MIDI device class drivers
  214. * - Fixed incorrect LED masks for received data display in the Device GenericHID demos (thanks to Denys Berkovskyy)
  215. * - Fixed incorrect output in the HIDReportViewer project when no device is connected (thanks to Pavel Kuzmin)
  216. *
  217. * \section Sec_ChangeLog120730 Version 120730
  218. * <b>New:</b>
  219. * - Core:
  220. * - Added new, revamped modular build system with new makefile templates
  221. * - Added support for the BitWizard Multio and Big-Multio boards
  222. * - Added support for the DorkbotPDX Duce board
  223. * - Added support for the Olimex AVR-USB-32U4 board
  224. * - Added support for the Olimex AVR-USB-T32U4 board
  225. * - Added support for the Olimex AVR-ISP-MK2 board
  226. * - Added new Endpoint_ConfigureEndpointTable() function
  227. * - Added new Pipe_ConfigurePipeTable() function
  228. * - Added build test to verify correct compilation of all board drivers using all driver APIs
  229. * - Added build test to verify correct compilation of all bootloaders using all supported devices
  230. * - Added build test to verify that there are no detectable errors in the codebase via static analysis
  231. * - Added new JTAG_ENABLE() macro for the AVR8 architecture
  232. * - Library Applications:
  233. * - Modified the CDC Host demos to set a default CDC Line Encoding on enumerated devices
  234. * - Added Dataflash operational checks and aborts to all projects using the Dataflash to ensure it is working correctly before use
  235. * - Added new SerialToLCD user project contributed by Simon Foster
  236. * - Added new RESET_TOGGLES_LIBUSB_COMPAT compile time option to the AVRISP-MKII clone programmer project (thanks to Robert Spitzenpfeil)
  237. *
  238. * <b>Changed:</b>
  239. * - Core:
  240. * - Android Accessory Host property strings changed from a struct of pointer to an array to prevent unaligned access on greater than 8-bit architectures
  241. * - Audio Device Class driver changed to also require the index of the Audio Control interface within the device, for SET/GET/CUR/MIN/MAX/RES property adjustments
  242. * - Removed variable axis support from the HID_DESCRIPTOR_JOYSTICK() macro due to OS incompatibilities, replaced with fixed 3-axis joystick report structure
  243. * - Removed the old pseudo-scheduler from the library as it was unused and deprecated since the 090810 release
  244. * - Endpoint indexes are now specified as full endpoint addresses within the device in device mode, rather than a logical index
  245. * - The Endpoint_ConfigureEndpoint() function no longer takes an endpoint direction as a parameter, as this is now deduced from the specified full endpoint
  246. * address and type
  247. * - The Endpoint_ConfigureEndpoint() function no longer takes a number of banks as a special mask; the number of banks is now specified as an integer parameter
  248. * - Endpoints are now configured via instances of a new struct USB_Endpoint_Table_t in all device mode class drivers, rather than a list of endpoint parameters
  249. * - Pipe indexes are now specified as full pipe addresses within the host in host mode, rather than a logical index
  250. * - The Pipe_ConfigurePipe() function no longer takes an pipe token as a parameter, as this is now deduced from the specified full pipe address and type
  251. * - The Pipe_ConfigurePipe() function no longer takes a number of banks as a special mask; the number of banks is now specified as an integer parameter
  252. * - Pipes are now configured via instances of a new struct USB_Pipe_Table_t in all host mode class drivers, rather than a list of pipe parameters
  253. * - Added support for various assert and debugging macros for the UC3 devices
  254. * - Changed MIDI event structure MIDI_EventPacket_t to use a single field for the combined virtual cable index and command ID, to prevent bitfield packing issues
  255. * on some architectures (thanks to Darren Gibbs)
  256. * - Changed board LED driver implementations of LEDs_ToggleLEDs() for the AVR8 architecture to use the fast PIN register toggle alternative function for speed
  257. * - Library Applications:
  258. * - Raised the guard bits in the AVRISP-MKII clone project when in PDI and TPI to 32, to prevent communication errors on low quality connections to a target
  259. * - Added additional bootloader API data to expose the bootloader start address and class to the DFU and CDC class bootloaders
  260. * - Reverted AVRISP-MKII clone project watchdog based command timeout patch in favour of a hardware timer, to allow for use in devices with WDTRST fuse programmed
  261. * - The library bootloaders will now correctly start the user application after a watchdog-based application start, even if the /HWB line is held low externally
  262. * during the reset phase
  263. * - Increased endpoint polling interval for all demos and projects to 5ms, as 1ms was causing some enumeration issues on some machines (thanks to Riku Salminen)
  264. *
  265. * <b>Fixed:</b>
  266. * - Core:
  267. * - Fixed possible enumeration error if the user application selects a pipe other than the default Control pipe between the Powered and Default states of
  268. * the host state machine
  269. * - Fixed incorrect call to the user callback CALLBACK_Audio_Device_GetSetInterfaceProperty() in the Audio Class device driver (thanks to Tiit Ratsep)
  270. * - Fixed compile error for the UC3 architecture when INTERRUPT_CONTROL_ENDPOINT is specified (thanks to Andrus Aaslaid)
  271. * - Fixed compile error if LEDs_Disable() is called and BOARD=NONE is set (thanks to Sam Lin)
  272. * - Fixed inverted LED logic in the OLIMEX162 board LED driver
  273. * - Fixed incorrect response to GET STATUS requests in device mode if NO_DEVICE_SELF_POWER or NO_DEVICE_REMOTE_WAKEUP tokens are defined (thanks to Georg Glock)
  274. * - Fixed inverted LED logic in the USB2AX board LED driver
  275. * - Fixed possible deadlock in the CDC device driver if the USB connection is dropped while the CDC_REQ_SetLineEncoding control request is being processed by
  276. * the stack (thanks to Jonathan Hudgins)
  277. * - Fixed broken MIDI host driver MIDI_Host_ReceiveEventPacket() function due to not unfreezing the MIDI data IN pipe before use (thanks to Michael Brown)
  278. * - Fixed swapped Little Endian/Big Endian endpoint and pipe write code for the UC3 devices (thanks to Andrew Chu)
  279. * - Fixed the JTAG_DISABLE() macro clearing all other bits in MCUSR when called
  280. * - Fixed incorrect Micropendous board LED driver LEDs_SetAllLEDs() and LEDs_ChangeLEDs() function implementations (thanks to MitchJS)
  281. * - Fixed endianess issues in the RNDIS host class driver for UC3 devices (thanks to Andrew Chu)
  282. * - Library Applications:
  283. * - Fixed error in the AVRISP-MKII programmer when ISP mode is used at 64KHz (thanks to Ben R. Porter)
  284. * - Fixed AVRISP-MKII programmer project failing to compile for the U4 chips when VTARGET_ADC_CHANNEL is defined to an invalid channel and NO_VTARGET_DETECT is
  285. * defined (thanks to Steven Morehouse)
  286. * - Fixed AVRISP-MKII programmer project reset line polarity inverted when the generated EEP file is loaded into the USB AVR's EEPROM and avr-dude is used
  287. * - Fixed CDC and DFU bootloaders failing to compile when the bootloader section size is 8KB or more (thanks to Georg Glock)
  288. * - Fixed CDC and DFU bootloaders API function offsets incorrect on some devices (thanks to Rod DeMay)
  289. * - Fixed incorrect DFU version number reported to the host in the DFU bootloader descriptors (thanks to Georg Glock)
  290. * - Fixed incorrect version hundredths value encoding in VERSION_BCD() macro (thanks to Georg Glock)
  291. * - Fixed invalid configuration descriptor in the low level KeyboardMouse device demo (thanks to Jun Wako)
  292. * - Fixed CDC and DFU bootloaders API page erase and write function failures (thanks to Martin Lambert)
  293. *
  294. * \section Sec_ChangeLog120219 Version 120219
  295. * <b>New:</b>
  296. * - Core:
  297. * - Added support for the XMEGA A3BU Xplained board
  298. * - Added support for the new B series XMEGA devices
  299. * - Added support for version 2 of the Teensy boards (thanks to Christoph Redecker)
  300. * - Added support for the USB2AX boards, hardware revision 1-3
  301. * - Added new Android Accessory Host class driver
  302. * - Added new USB_Host_GetDescriptor(), USB_Host_GetDeviceConfiguration() and USB_Host_GetInterfaceAltSetting() functions
  303. * - Added new CALLBACK_Audio_Device_GetSetInterfaceProperty() callback to the Audio Device Class driver
  304. * - Added new LEDs_Disable(), Buttons_Disable() and Joystick_Disable() functions to the board hardware drivers
  305. * - Added support for the Micropendous family of boards (Arduino-like revisions 1 and 2, DIP, 32U2, A, 1, 2, 3 and 4)
  306. * - Added INVERTED_VBUS_ENABLE_LINE and NO_AUTO_VBUS_MANAGEMENT compile time options (thanks to Opendous Inc.)
  307. * - Added support for the Atmel XMEGA B1 Xplained board
  308. * - Added Serial USART peripheral driver for the XMEGA architecture
  309. * - Added Master Mode SPI USART peripheral driver for the XMEGA and AVR8 architectures
  310. * - Added build test to verify correct compilation of as many modules as possible under as many architectures as possible under the C and C++ languages
  311. * - Added build test to verify correct compilation of the USB driver when forced into single USB mode under as many architectures as possible
  312. * - Library Applications:
  313. * - Added User Application APIs to the CDC and DFU class bootloaders
  314. * - Added INVERTED_ISP_MISO compile time option to the AVRISP-MKII clone project (thanks to Chuck Rohs)
  315. * - Added new Android Accessory Host demo (thanks to Opendous Inc.)
  316. *
  317. * <b>Changed:</b>
  318. * - Core:
  319. * - When automatic PLL management mode is enabled on the U4 series AVR8 chips, the PLL is now configured for 48MHz and not
  320. * a divided 96MHz, to lower power consumption and to keep the system within the datasheet specs for 3.3V operation (thanks to Scott Vitale)
  321. * - Added Class, ClassDevice, ClassHost and ClassCommon to the internal class driver source filenames to prevent ambiguities
  322. * - Altered the Mass Storage Host class driver so that SCSI data STALLs from the attached device can be recovered from automatically without
  323. * having to reset the Mass Storage interface
  324. * - USB_CONFIG_ATTR_BUSPOWERED constant renamed to USB_CONFIG_ATTR_RESERVED, as this was misnamed (thanks to NXP Semiconductors)
  325. * - Reordered board name definition indexes so that a misspelled BOARD compile option will default to BOARD_USER rather than BOARD_USBKEY
  326. * - Altered the HID class driver to only try to construct at maximum one packet per USB frame, to reduce CPU usage
  327. * - All USB Class Driver configuration struct values are now non-const, to allow for run-time modifications if required before configuring an instance
  328. * - Library Applications:
  329. * - Altered the Mass Storage Host LowLevel demo so that SCSI data STALLs from the attached device can be recovered from automatically without
  330. * having to reset the Mass Storage interface
  331. * - Updated the AVRISP-MKII Clone programmer project to be compatible with the latest version of AVR Studio (version 5.1)
  332. * - Changed the AVRISP-MKII Clone programmer project to report a fixed 3.3V VTARGET voltage on USB AVRs lacking an ADC instead of 5V to prevent
  333. * warnings in AVR Studio 5.1 when programming XMEGA devices
  334. * - Allow serial strings to be generated on the older AVR8 devices which do not explicitly state they contain unique values in the datasheet,
  335. * as this appears to be implemented in hardware
  336. *
  337. * <b>Fixed:</b>
  338. * - Core:
  339. * - Fixed ring buffer size limited to 255 elements, instead of the intended 65535 elements.
  340. * - Fixed CDC class drivers not saving and sending all 16-bits of the control line states (thanks to Matthew Swabey)
  341. * - Fixed race conditions in the CDC, HID and Mass Storage class drivers when processing some control requests
  342. * - Fixed misspelled HID_KEYBOARD_MODIFIER_* macros in the HID class driver (thanks to Laszlo Monda)
  343. * - Fixed broken AVR32 endpoint/pipe communications when ORDERED_EP_CONFIG compile time option is not enabled (thanks to Matthias Jahr)
  344. * - Fixed broken compilation for the AVR32 devices if the NO_SOF_EVENTS compile time option was not enabled (thanks to Matthias Jahr)
  345. * - Fixed compiler warning on GCC with \c -wundef compile flag is used (thanks to Georg Glock)
  346. * - Fixed incorrect implementation of LEDs_ToggleLEDs() for the Adafruit-U4 board (thanks to Caroline Saliman)
  347. * - Fixed broken compilation of LUFA under C++ compilers when the Serial peripheral module header file is included in a C++ source file
  348. * - Fixed missing semicolon in the UC3 architecture host pipe functions
  349. * - Fixed failed compilation for the XMEGA architecture if USB_DEVICE_ONLY us not specified
  350. * - Fixed UC3 architecture ignoring the pipe size when Pipe_ConfigurePipe() is called
  351. * - Library Applications:
  352. * - Added reliability patches to the AVRISP-MKII Clone project's PDI/TPI protocols (thanks to Justin Mattair)
  353. * - Fixed AVRISP-MKII Clone compile warning on AVR8 U4 targets even when NO_VTARGET_DETECT is enabled
  354. * - Fixed AVRISP-MKII Clone failing to start application firmware once a TPI programming session is exited
  355. * - Fixed DFU class bootloader not resetting the LED pins as high impedance inputs when a software jump to the user applications is requested
  356. * - Fixed AVRISP-MKII Clone timing out on long programming commands such as programming the EEPROM on an ATMEGA8 (thanks to Martin Kelling)
  357. * - Fixed invalid PID value used in the TempDataLogger project host application (thanks to Anupam Pathak)
  358. *
  359. * \section Sec_ChangeLog111009 Version 111009
  360. * <b>New:</b>
  361. * - Core:
  362. * - Added USE_LUFA_CONFIG_HEADER compile time option to include a LUFAConfig.h header in the user director for LUFA configuration
  363. * tokens as an alternative to tokens defined in the project makefile
  364. * - Added new USB_Host_SetInterfaceAltSetting() convenience function for the selection of an interface's alternative setting
  365. * - Added Audio class control request definitions
  366. * - Added new CALLBACK_Audio_Device_GetSetEndpointProperty() callback to the Audio Device Class driver to allow for endpoint control manipulations
  367. * such as data sample rates
  368. * - Added support for the Audio class GET STATUS request in the Audio Device Class driver so that it is correctly ACKed when sent by the host
  369. * - Added new EVENT_Audio_Device_StreamStartStop() event to the Audio Device Class driver to detect stream start/stop events
  370. * - Added board driver support for the Busware TUL board
  371. * - Added board hardware driver support for the EVK1100 board
  372. * - Added board hardware driver support for the EVK1104 board
  373. * - Added new Host mode Audio Class driver
  374. * - Added new SPI_GetCurrentMode() function to the SPI peripheral driver
  375. * - Added RingBuffer_GetFreeCount() function to the Ring Buffer driver
  376. * - Added new HID_Host_SetIdlePeriod() function to the HID Host Class driver
  377. * - Added new USB_Host_ConfigurationNumber global variable to indicate the selected configuration in an attached device
  378. * - Added new USB_Host_GetDeviceStatus() function to the host standard request function set
  379. * - Added AVR USB XMEGA architecture port (currently incomplete/experimental)
  380. * - Added new STRINGIFY() and STRINGIFY_EXPANDED() convenience macros
  381. * - Added new JTAG_DISABLE() macro for the AVR8 architecture
  382. * - Added Device Qualifier standard descriptor structure definitions USB_StdDescriptor_DeviceQualifier_t and USB_Descriptor_DeviceQualifier_t
  383. * - Library Applications:
  384. * - Added RNDIS device mode to the Webserver project
  385. * - Added new incomplete AndroidAccessoryHost Host LowLevel demo
  386. * - Added new HIDReportViewer project
  387. * - Added new MediaControl project
  388. * - Added new AudioInputHost Host ClassDriver demo
  389. * - Added new AudioOutputHost Host ClassDriver demo
  390. * - Added new AudioInputHost Host LowLevel demo
  391. * - Added new AudioOutputHost Host LowLevel demo
  392. * - Added new "checksource" target to all library project makefiles
  393. * - Added new VTARGET_USE_INTERNAL_REF configuration option to the AVRISP-MKII clone project (thanks to Volker Bosch)
  394. *
  395. * <b>Changed:</b>
  396. * - Core:
  397. * - Altered the definition of the USB_Audio_Descriptor_Format_t descriptor so that the user is now responsible for supplying
  398. * the supported audio sampling rates, to allow for multiple audio interfaces with different numbers of supported rates and/or
  399. * continuous sample rates
  400. * - Pipe_BoundEndpointNumber() has been renamed to Pipe_GetBoundEndpointAddress(), and now returns the correct endpoint direction
  401. * as part of the endpoint address
  402. * - Renamed global state variables that are specific to a certain USB mode to clearly indicate which mode the variable relates to,
  403. * by changing the USB_* prefix to USB_Device_* or USB_Host_*
  404. * - Removed the HOST_STATE_WaitForDeviceRemoval and HOST_STATE_Suspended host state machine states, as these are no longer required
  405. * - Altered the USB_Host_SetDeviceConfiguration() function to update the global Host state machine state and the new
  406. * USB_Host_ConfigurationNumber global as required
  407. * - Added endian correcting code to the library USB class drivers for multiple architecture support
  408. * - Removed the ENDPOINT_DESCRIPTOR_DIR_* macros, replaced by ENDPOINT_DIR_* instead
  409. * - Renamed the JTAG_DEBUG_ASSERT() macro to JTAG_ASSERT()
  410. * - Added variable number of axis to HID_DESCRIPTOR_JOYSTICK() for multi-axis joysticks above just X and Y
  411. * - Renamed USB_Host_ClearPipeStall() to USB_Host_ClearEndpointStall() as the function works on an endpoint address within the attached device,
  412. * and not a Pipe within the host
  413. * - The MS_Host_ResetMSInterface() now performs a full Mass Storage reset sequence to prevent data corruption in the event of a device
  414. * lock up or timeout (thanks to David Lyons)
  415. * - Added endian-correction to the CDC driver's Line Encoding control request handlers.
  416. * - Library Applications:
  417. * - Modified the Low Level and Class Driver AudioInput and AudioOutput demos to support multiple audio sample rates
  418. * - Updated all host mode demos and projects to use the EVENT_USB_Host_DeviceEnumerationComplete() event callback for device configuration
  419. * instead of manual host state machine manipulations in the main application task
  420. * - Changed the reports in the GenericHID device demos to control the board LEDs, to reduce user confusion over the callback routines
  421. * - Added reliability patches to the AVRISP-MKII Clone project's ISP and PDI/TPI protocols (thanks to Justin Mattair)
  422. *
  423. * <b>Fixed:</b>
  424. * - Core:
  425. * - Large number of documentation and code comment corrections (thanks to Andrey from Microsin.ru)
  426. * - Fixed possibility of the AVR's SPI interface being pulled out of master mode if the /SS pin is a input and pulled low (thanks
  427. * to Andrey from Microsin.ru)
  428. * - Fixed compile error when FIXED_CONTROL_ENDPOINT_SIZE compile time option was disabled, and a USE_*_DESCRIPTORS compile time
  429. * option was not enabled on the AVR8s
  430. * - Fixed lack of C++ compatibility in some internal header files causing compile errors when using LUFA in C++ projects
  431. * - Fixed error in the pipe unordered allocation algorithm for the AVR8 devices breaking compatibility with some devices
  432. * - Fixed USB_USBTask not being called internally in stream transfers between packets when Partial Stream Transfers are used
  433. * - Fixed swapped TWI_ADDRESS_READ and TWI_ADDRESS_WRITE values
  434. * - Fixed TWI_ReadPacket() not releasing the TWI bus on read completion
  435. * - Fixed optimization error in the HID Parser item value USB_SetHIDReportItemInfo() and USB_GetHIDReportItemInfo() routines if the report item was
  436. * \c NULL (which should be allowable according to the API)
  437. * - Fixed HID Parser CALLBACK_HIDParser_FilterHIDReportItem() callback function not being passed a cacheable report item pointer
  438. * - Fixed HID Parser's largest report size bit count not including the size of the last parsed report item
  439. * - Fixed HID host driver's largest HID report size count corrupt when the number of report bits exceeds 255
  440. * - Library Applications:
  441. * - Fixed incorrect signature in the CDC and DFU class bootloaders for the ATMEGA8U2
  442. * - Fixed KeyboardHost and KeyboardHostWithParser demos displaying incorrect values when numerical keys were pressed
  443. * - Fixed compile errors in the incomplete BluetoothHost demo application (thanks to Timo Lindfors)
  444. * - Fixed incorrect Dataflash buffer use in the DataflashManager_WriteBlocks_RAM() function of several demos/projects (thanks to Jeremy Willden)
  445. * - Fixed incorrect logging interval (always 500ms longer than requested) in the TempDataLogger project
  446. * - Fixed incorrect buffer size check in the USBtoSerial project (thanks to Yuri A Nikiforov)
  447. * - Fixed port state table corruption in the TCP layer of the RNDIS Ethernet device demos
  448. *
  449. * \section Sec_ChangeLog110528 Version 110528
  450. * <b>New:</b>
  451. * - Core:
  452. * - Added new ORDERED_EP_CONFIG compile time option to restrict endpoint/pipe configuration to ascending order
  453. * in exchange for a smaller compiled program binary size
  454. * - Added a new general RingBuff.h miscellaneous ring buffer library driver header
  455. * - Added new GCC_FORCE_POINTER_ACCESS() macro to correct GCC's mishandling of struct pointer accesses
  456. * - Added new GCC_MEMORY_BARRIER() macro to prevent instruction reordering across boundaries
  457. * - Added basic driver example use code to the library documentation
  458. * - Added new Endpoint_Null_Stream() and Pipe_Null_Stream() functions
  459. * - Added new ADC_GET_CHANNEL_MASK() convenience macro
  460. * - Added new HID report item macros (with HID_RI_ prefix) to allow for easy creation and editing of HID report descriptors
  461. * - Added new HID_DESCRIPTOR_MOUSE(), HID_DESCRIPTOR_KEYBOARD(), HID_DESCRIPTOR_JOYSTICK() and HID_DESCRIPTOR_VENDOR() macros
  462. * for easy automatic creation of basic USB HID device reports
  463. * - Added new MAX() and MIN() convenience macros
  464. * - Added new Serial_SendData() function to the Serial driver
  465. * - Added board driver support for the Sparkfun ATMEGA8U2 breakout board
  466. * - Added TWI baud rate prescaler and bit length parameters to the TWI_Init() function (thanks to Thomas Herlinghaus)
  467. * - Internal restructuring for eventual multiple architecture ports
  468. * - Added AVR32 UC3 architecture port (currently incomplete/experimental)
  469. * - Added new architecture independent functions to enable, disable, save and restore the Global Interrupt Enable flags
  470. * - Added new RNDIS Device Class Driver packet send and receive functions
  471. * - Library Applications:
  472. * - Added ability to write protect Mass Storage disk write operations from the host OS
  473. * - Added new MIDIToneGenerator project
  474. * - Added new KeyboardMouseMultiReport Device ClassDriver demo
  475. * - Added new VirtualSerialMassStorage Device ClassDriver demo
  476. * - Added HID class bootloader, compatible with a modified version of the command line Teensy loader from PJRC.com
  477. * - Added LED flashing to the CDC and DFU class bootloaders to indicate when they are running
  478. *
  479. * <b>Changed:</b>
  480. * - Core:
  481. * - Unordered Endpoint/Pipe configuration is now allowed once again by default via the previous reconfig workaround
  482. * - Refactored Host mode Class Driver *_Host_ConfigurePipes() routines to be more space efficient when compiled
  483. * - Added new *_ENUMERROR_PipeConfigurationFailed error codes for the *_Host_ConfigurePipes() routines
  484. * - The USARTStream global is now public and documented in the SerialStream module, allowing for the serial USART
  485. * stream to be accessed via its handle rather than via the implicit stdout and stdin streams
  486. * - The FAST_STREAM_TRANSFERS compile time option has been removed due to lack of use and low cost/benefit ratio
  487. * - Altered all endpoint/pipe stream transfers so that the new BytesProcessed parameter now points to a location
  488. * where the number of bytes in the transfer that have been completed can be stored (or NULL if entire transaction
  489. * should be performed in one chunk)
  490. * - The NO_STREAM_CALLBACKS compile time option has now been removed due to the new partial stream transfer feature
  491. * - Changed over all project and demo HID report descriptors to use the new HID report item macros
  492. * - Moved the HIDParser.c source file to the LUFA/Drivers/USB/Class/Common/ directory from the LUFA/Drivers/USB/Class/Host/
  493. * - Added support to the HID parser for extended USAGE items that contain the usage page as well as the usage index
  494. * - Removed the SerialStream driver, rolled functionality into the regular Serial peripheral driver via the new
  495. * Serial_CreateStream() and Serial_CreateBlockingStream() functions
  496. * - Renamed the low level Serial byte send/receive functions, to be consistent with the CDC class driver byte functions
  497. * - Altered the behaviour of the serial byte reception function so that is is non-blocking, and now returns a negative
  498. * value if no character is received (to remain consistent with the CDC class driver byte reception routines)
  499. * - Renamed the PRNT_Host_SendString(), CDC_Host_SendString() and CDC_Device_SendString() functions to *_SendData(), and
  500. * added new versions of the *_SendString() routines that expect a null terminated string instead
  501. * - Renamed all driver termination *_ShutDown() functions to the more logical name *_Disable()
  502. * - Reduced latency for executing the Start-Of-Frame events (if enabled in the user application)
  503. * - Removed Pipe_ClearErrorFlags(), pipe error flags are now automatically cleared when Pipe_ClearError() is called
  504. * - Endpoint_ResetFIFO() renamed to Endpoint_ResetEndpoint(), to be consistent with the Pipe_ResetPipe() function name
  505. * - Implemented on-demand PLL clock generation for the U4, U6 and U7 series USB AVRs when automatic PLL mode is specified
  506. * - F_CLOCK changed to F_USB to be more descriptive, and applicable on future architecture ports
  507. * - Renamed all low level Endpoint_Read_*, Endpoint_Write_* and Endpoint_Discard_* functions to use the number of bits instead of
  508. * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
  509. * - Renamed all low level Pipe_Read_*, Pipe_Write_* and Pipe_Discard_* functions to use the number of bits instead of
  510. * a symbolic size (Byte, Word, DWord) so that the function names are applicable and correct across all architectures
  511. * - Separated out board drivers by architecture in the library internals for better organisation
  512. * - Library Applications:
  513. * - Changed the XPLAINBridge software UART to use the regular timer CTC mode instead of the alternative CTC mode
  514. * via the Input Capture register, to reduce user confusion
  515. * - Combined page and word ISP programming mode code in the AVRISP-MKII clone project to reduce compiled size and
  516. * increase maintainability of the code
  517. * - Changed over library projects to use the new general ring buffer library driver module
  518. * - Added new high level TWI packet read/write commands, altered behaviour of the TWI_StartTransmission() function
  519. * - Changed TempDataLogger project's DS1307 driver to simplify the function interface and prevent a possible race condition
  520. * - Changed AVRISP-MKII project to use the Watchdog interrupt for command timeouts, to reduce CPU usage and free timer 0
  521. * for other uses
  522. * - Updated the software USART code in the XPLAIN Bridge application so that the incoming bits are sampled at their mid-point
  523. * instead of starting point, to give maximum reliability (thanks to Anton Staaf)
  524. *
  525. * <b>Fixed:</b>
  526. * - Core:
  527. * - Fixed broken USBFOO board drivers due to missing BOARD_USBFOO define
  528. * - Fixed HID host class driver incorrectly binding to HID devices that do not have an OUT endpoint
  529. * - Fixed incorrect definition of the HID_KEYBOARD_SC_D constant in the HID class driver (thanks to Opendous Inc.)
  530. * - Fixed incorrect definition of the HID_KEYBOARD_SC_RIGHT_ARROW constant in the HID class driver (thanks to Joby Taffey)
  531. * - Fixed incorrect endpoint initialisation order in the several device demos (thanks to Rick Drolet)
  532. * - Fixed inverted Minimus board LEDs
  533. * - Fixed incorrect byte ordering in the Audio_Device_WriteSample24 function (thanks to WZab)
  534. * - Fixed several functions in the Host mode Still Image Class driver returning an error code from the incorrect
  535. * error code enum (thanks to Daniel Seibert)
  536. * - Fixed ReportID not being removed from the feature/out report data array in the HID class driver when Report IDs are used
  537. * - Fixed incorrect BUTTONS_BUTTON1 definition for the Minimus board
  538. * - Fixed Still Image Host class driver exiting the descriptor search routine prematurely if the data pipes (but not event pipe)
  539. * is found
  540. * - Fixed missing call to Pipe_SetInfiniteINRequests() in the Pipe_ConfigurePipe() routine
  541. * - Fixed Remote Wakeup broken on the AVRs due to the mechanism only operating when the SUSPI bit is set (thanks to Holger Steinhaus)
  542. * - Fixed possible invalid program execution when in host mode if corrupt descriptor lengths are supplied by the attached device
  543. * - Library Applications:
  544. * - Fixed Benito project discarding incoming data from the USB virtual serial port when the USART is busy
  545. * - Fixed broken DFU bootloader, added XPLAIN support for bootloader start when XCK jumpered to ground
  546. * - Fixed broken HID_REQ_GetReport request handler in the Low Level GenericHID demo
  547. * - Fixed possible lost data in the XPLAINBridge, USBtoSerial and Benito projects when the host exceeds the packet
  548. * timeout period on received packets as set by USB_STREAM_TIMEOUT_MS (thanks to Justin Rajewski)
  549. * - Fixed possible programming problem in the AVRISP-MKII clone project when programming specific patterns into a target
  550. * memory space that is only byte (not page) addressable
  551. * - Fixed errors in the incomplete Test and Measurement device demo preventing proper operation (thanks to Pavel Plotnikov)
  552. * - Fixed programming errors in the AVRISP-MKII project when the programming packet is a round multiple of the endpoint bank
  553. * size under avrdude (thanks to Steffan Woltjer)
  554. *
  555. *
  556. * \section Sec_ChangeLog101122 Version 101122
  557. * <b>New:</b>
  558. * - Core:
  559. * - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously
  560. * not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger)
  561. * - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c
  562. * - Added new USB_Device_GetFrameNumber() and USB_Host_GetFrameNumber() functions to retrieve the current USB frame number
  563. * - Added new USB_Host_EnableSOFEvents(), USB_Host_DisableSOFEvents() and EVENT_USB_Host_StartOfFrame() for the user application
  564. * handling of USB Start of Frame events while in USB Host mode
  565. * - Added new PRNT_Host_BytesReceived(), PRNT_Host_ReceiveByte(), PRNT_Host_SendByte() and PRNT_Host_Flush() functions to the
  566. * Print Host Class driver
  567. * - Added class specific descriptor alternative struct type defines with standard USB-IF element naming
  568. * - Added new project makefile template to the library and moved board driver stub files into in a new "CodeTemplates" directory
  569. * - Added board hardware driver support for the Adafruit U4 breakout board
  570. * - Added board hardware driver support for the Arduino Uno development board
  571. * - Added board hardware driver support for the Blackcat USB JTAG board (thanks to the PSGroove team)
  572. * - Added board hardware driver support for the Busware BUI development board
  573. * - Added board hardware driver support for the Busware CUL V3 868MHZ radio board (thanks to Dirk Tostmann)
  574. * - Added board hardware driver support for the Kernel Concepts USBFOO development board
  575. * - Added board hardware driver support for the Linnix UDIP development board
  576. * - Added board hardware driver support for the Olimex AVR-USB-162 development board (thanks to Steve Fawcett)
  577. * - Added board hardware driver support for the Maximus board (thanks to the PSGroove team)
  578. * - Added board hardware driver support for the Microsin AVR-USB162 breakout board
  579. * - Added board hardware driver support for the Minimus board (thanks to the PSGroove team)
  580. * - Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management
  581. * tasks for each driver is called
  582. * - Added standard keyboard HID report scan-code defines (thanks to Laszlo Monda)
  583. * - Added new Pipe_GetBusyBanks(), Endpoint_GetBusyBanks() and Endpoint_AbortPendingIN() functions
  584. * - Library Applications:
  585. * - Added default test tone generation mode to the Device mode AudioInput demos
  586. * - Added new NO_BLOCK_SUPPORT, NO_EEPROM_BYTE_SUPPORT, NO_FLASH_BYTE_SUPPORT and NO_LOCK_BYTE_WRITE_SUPPORT compile time options to the
  587. * CDC class bootloader
  588. * - Added new XCK_RESCUE_CLOCK_ENABLE compile time option to the AVRISP-MKII clone programmer project (thanks to Tom Light)
  589. *
  590. * <b>Changed:</b>
  591. * - Core:
  592. * - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions
  593. * depending of if the given bank size is a compile time constant, as the compiler does a better job of optimizing
  594. * with basic code
  595. * - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove
  596. * the need for extra casting inside the callback (thanks to Jonathan Kollasch)
  597. * - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode
  598. * - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode
  599. * - Renamed and moved class driver common constant definitions to make the naming scheme more uniform
  600. * - Moved the USB mode specifier constants into a new enum, so that they are semantically related to one another
  601. * - Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed it to return the maximum number of supported banks for
  602. * the given endpoint
  603. * - Better algorithm to extract and convert the internal device serial number into a string descriptor (if present)
  604. * - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be separately included
  605. * - The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called
  606. * - Renamed the EVENT_USB_Device_UnhandledControlRequest() event to EVENT_USB_Device_ControlRequest() as it is now fired before the library
  607. * request handlers, not afterwards
  608. * - Library Applications:
  609. * - Changed over all device demos to use a clearer algorithm for the configuring of the application's endpoints
  610. * - Added missing DataflashManager_CheckDataflashOperation() function to the MassStorageKeyboard demo, removed redundant
  611. * SCSI_Codes.h file as these values are part of the MassStorage Class Driver
  612. * - Added compile time error to the AVRISP-MKII project when built for the U4 chips, as the default VTARGET detection ADC channel
  613. * does not exist on these chips (thanks to Marco)
  614. * - Changed all Device mode LowLevel demos and Device Class drivers so that the control request is acknowledged and any data
  615. * transferred as quickly as possible without any processing in between sections, so that long callbacks or event handlers will
  616. * not break communications with the host by exceeding the maximum control request stage timeout period
  617. * - Changed over all demos, drivers and internal functions to use the current frame number over the Start of Frame flag where possible
  618. * to free up the Start of Frame flag for interrupt use in the user application
  619. * - All project makefiles now correctly clean intermediate build files from assembly and C++ sources (thanks to Daniel Czigany)
  620. * - Changed default value for the reset polarity parameter in the AVRISP-MKII project so that it defaults to active low drive
  621. * - Changed configuration descriptor parser for all host mode projects and class drivers to ensure better compatibility with devices
  622. * - All LowLevel demos changed to use the constants and types defined in the USB class drivers
  623. * - Changed AudioInput and AudioOutput demos to reload the next sample via an interrupt rather than polling the sample timer
  624. * - Rescue clock of the AVRISP-MKII moved to the AVR's OCR1A pin, so that the clock can be generated at all times
  625. * - Changed ClassDriver MIDI demos to process all incoming events in a loop until the bank becomes empty rather than one at a time
  626. * - Changed LowLevel MIDI demos to only clear the incoming event bank once it has become empty to support packed event packets
  627. *
  628. * <b>Fixed:</b>
  629. * - Core:
  630. * - Fixed USB_GetHIDReportItemInfo() function modifying the given report item's data when the report item does not exist
  631. * within the supplied report of a multiple report HID device
  632. * - Fixed critical pipe/endpoint memory allocation issue where the bank memory address space could be silently overlapped
  633. * in the USB controller if the endpoints or pipes were allocated in anything other than ascending order (thanks to Martin Degelsegger)
  634. * - Added LEDs_ToggleLEDs() function to several board LED drivers which were missing it (thanks to Andrei Krainev)
  635. * - Fixed SET FEATURE and CLEAR FEATURE control requests directed at an unconfigured endpoint causing request timeouts
  636. * - Fixed USB_Host_ClearPipeStall() incorrectly determining the endpoint direction from the currently selected pipe
  637. * - Fixed JTAG_DEBUG_POINT() and JTAG_DEBUG_BREAK() macros not compiling under pure C99 standards mode
  638. * - Fixed endpoint selection within the CALLBACK_HID_Device_CreateHIDReport() callback function causing broken GET REPORT requests
  639. * - Fixed incorrect command name for EEPROM memory programming in the makefile dfu-ee target
  640. * - Fixed incorrect LEDs_ChangeLEDs() function in the Benito board LED driver
  641. * - Fixed incorrect USB_DeviceState value when unconfiguring the device without an address set
  642. * - Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init() is called
  643. * - Fixed random enumeration failure while in device mode due to interrupts causing the Set Address request to exceed maximum timings
  644. * - Fixed MIDI_Host_Flush() not aborting early when the specified MIDI host interface was not configured
  645. * - Fixed MIDI class driver send routines silently discarding packets if the endpoint or pipe is busy (thanks to Robin Green)
  646. * - Library Applications:
  647. * - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to
  648. * missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger)
  649. * - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control
  650. * request handler
  651. * - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value
  652. * - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2
  653. * - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev)
  654. * - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used
  655. * - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules
  656. * - Fixed USBtoSerial and XPLAINBridge demos discarding data from the PC if the send buffer becomes full
  657. * - Fixed broken input in the MagStripe reader project due to an incorrect HID report descriptor
  658. * - Fixed incorrect PollingIntervalMS values in the demo/project/bootloader endpoint descriptors (thanks to MCS Electronics)
  659. * - Fixed AVRISP-MKII clone project not starting the target's program automatically after exiting TPI programming mode
  660. *
  661. *
  662. * \section Sec_ChangeLog100807 Version 100807
  663. * <b>New:</b>
  664. * - Added new ADC_DisableChannel() function (thanks to Mich Davis)
  665. * - Added new VTARGET_REF_VOLTS and VTARGET_SCALE_FACTOR compile time defines to the AVRISP-MKII programmer project to set
  666. * the VTARGET reference voltage and scale factor
  667. * - Added new pgm_read_ptr() macro to Common.h for reading of pointers out of flash memory space
  668. * - Added new SWAPENDIAN_16() and SWAPENDIAN_32() macros to Common.h for statically initialized variables at compile time
  669. * - Added new Drivers/USB/LowLevel/Device.c file to house Device mode specific functions that are more complicated than simple macros
  670. * - Added new AVRStudio 4 project files for all library demos, projects and bootloaders
  671. * - Added ability to set the serial baud rate via the user's terminal in the XPLAINBridge project
  672. * - Added new LUFA module variables for the different source modules in the core library makefile to simplify project makefiles
  673. * - Added start of a new Test and Measurement class demo (thanks to Peter Lawrence)
  674. * - Added new SPI_ORDER_* data order masks to the SPI peripheral driver
  675. * - Added support to the AVRISP-MKII project for ISP speeds slower than 125KHz via a new software SPI driver
  676. * - Added support for the new button/LED on the latest model USBTINY-MKII
  677. *
  678. * <b>Changed:</b>
  679. * - The RingBuff library code has been replaced in the XPLAINBridge, Benito and USBtoSerial projects with an ultra lightweight
  680. * ring buffer to help improve the reliability of the projects
  681. * - The EEPROM stream read/write functions now use eeprom_update_byte() instead of eeprom_write_byte(), so that only
  682. * changed bytes are written to EEPROM to preserve its lifespan
  683. * - Changed over the AVRISP-MKII and TemperatureDataLogger projects to use eeprom_update_byte() when writing non-volatile
  684. * parameters to EEPROM to preserve its lifespan
  685. * - Removed unused line encoding data and control requests from the CDC Bootloader code, to save space
  686. * - Renamed SERIAL_STREAM_ASSERT() macro to STDOUT_ASSERT()
  687. * - The USB_Device_IsRemoteWakeupSent() and USB_Device_IsUSBSuspended() macros have been deleted, as they are now obsolete
  688. * - Rewrote the implementation of the SwapEndian_16() and SwapEndian_32() functions so that they compile down in most instances to
  689. * minimal loads and stores rather than complicated shifts
  690. * - The software UART in the XPLAINBridge has been largely altered to try to improve upon its performance and reliability
  691. * - The USBtoSerial and Benito projects now flushes received data via a flush timer, so that several bytes can be transmitted at once
  692. * - Removed the automated checking of event names in the demo, project and bootloader makefiles due to inconsistencies between the
  693. * behaviour of the command line tools used to perform the check on each platform
  694. * - Internal USB driver source files renamed and moved to ease future possible architecture ports
  695. * - All internal pseudo-function macros have been converted to true inline functions for type-safety and readability
  696. * - Changed LED indicator masks for the AVRISP-MKII project, so that there are defined roles for each LED
  697. * - Altered the CDC Device and Host Class drivers' receive byte routines, so that no data is indicated by the function returning a
  698. * negative value (thanks to Andreas Paulin)
  699. * - Added auto flushing of OUT data to the CDC Host Class driver's USBTask function to automatically flush the send pipe buffer
  700. *
  701. * <b>Fixed:</b>
  702. * - Fixed AVRISP project sending a LOAD EXTENDED ADDRESS command to 128KB AVRs after programming or reading from
  703. * the last page of FLASH (thanks to Gerard Sexton)
  704. * - Fixed AVRISP project not sending a full erase-and-write EEPROM command to XMEGA targets when writing to the EEPROM
  705. * instead of the split write-only command (thanks to Tim Margush)
  706. * - Fixed RNDISEthernet demos crashing when calculating checksums for Ethernet/TCP packets of more than ~500 bytes due to
  707. * an overflow in the checksum calculation loop (thanks to Kevin Malec)
  708. * - Fixed XPLAINBridge project not correctly reading the XMEGA's supply voltage when reporting back to the host
  709. * - Fixed incorrect signature for the ATMEGA32U2 in the DFU bootloader (thanks to Axel Rohde)
  710. * - Fixed internal device serial not being accessible on the ATMEGAXXU2 AVRs (thanks to Axel Rohde)
  711. * - Fixed void pointer arithmetic in ConfigDescriptor.h breaking C++ compatibility (thanks to Michael Hennebry)
  712. * - Fixed broken PDI EEPROM Section Erase functionality in the AVRISP-MKII project
  713. * - Fixed USB_Device_SendRemoteWakeup() not working when the USB clock was frozen during USB bus suspend (thanks to Brian Dickman)
  714. * - Fixed occasional lockup of the AVRISP project due to the timeout extension code incorrectly extending the timeout in
  715. * PDI and TPI programming modes infinitely
  716. * - Fixed HID device class driver still using PrevReportINBuffer for GetReport control requests even when it has been
  717. * set to NULL by the user application (thanks to Axel Rohde)
  718. * - Fixed MIDI_Device_SendEventPacket() not correctly waiting for the endpoint to become ready (thanks to Robin Green)
  719. * - Fixed Benito and USBtoSerial projects not turning off the USART before reconfiguring it, which could cause incorrect
  720. * operation to occur (thanks to Bob Paddock)
  721. * - Fixed Serial peripheral driver not turning off the USART before reconfiguring it, which would cause incorrect operation
  722. * to occur (thanks to Bob Paddock)
  723. * - Fixed software application start command broken in the DFU class bootloader when dfu-programmer is used due to application
  724. * start address corruption
  725. *
  726. *
  727. * \section Sec_ChangeLog100513 Version 100513
  728. * <b>New:</b>
  729. * - Added incomplete MIDIToneGenerator project
  730. * - Added new Relay Controller Board project (thanks to OBinou)
  731. * - Added board hardware driver support for the Teensy, USBTINY MKII, Benito and JM-DB-U2 lines of third party USB AVR boards
  732. * - Added new ATTR_NO_INIT variable attribute for global variables that should not be automatically cleared on startup
  733. * - Added new ENDPOINT_*_BusSuspended error code to the Endpoint function, so that the stream functions early-abort if the bus
  734. * is suspended before or during a transfer
  735. * - Added new EVENT_CDC_Device_BreakSent() event and CDC_Host_SendBreak() function to the Device and Host CDC Class drivers
  736. * - Added ReportType parameter to the HID device class driver CALLBACK_HID_Device_ProcessHIDReport() function so that FEATURE
  737. * reports from the host to the device can be correctly processed
  738. * - Added ReportType parameter to the HID host class driver HID_Host_SendReportByID() function so that FEATURE reports can be
  739. * issued to the attached device
  740. *
  741. * <b>Changed:</b>
  742. * - AVRISP programmer project now has a more robust timeout system
  743. * - Added a timeout value to the TWI_StartTransmission() function, within which the addressed device must respond
  744. * - Webserver project now uses the board LEDs to indicate the current IP configuration state
  745. * - Added ENABLE_TELNET_SERVER compile time option to the Webserver project to disable the TELNET server if desired
  746. * - Increased throughput of the USBtoSerial demo on systems that send multiple bytes per packet (thanks to Opendous Inc.)
  747. * - Double bank CDC endpoints in the XPLAIN Bridge project, re-enable JTAG once the mode selection pin has been sampled.
  748. * - Standardized the naming scheme given to configuration descriptor sub-elements in the Device mode demos, bootloaders
  749. * and projects
  750. * - All Class Driver Host mode demos now correctly set the board LEDs to READY once the enumeration process has completed
  751. * - Added LIBUSB_FILTERDRV_COMPAT compile time option to the AVRISP programmer project to make the code compatible with Windows
  752. * builds of avrdude at the expense of AVRStudio compatibility
  753. * - Removed two-step endpoint/pipe bank clear and switch sequence for smaller, faster endpoint/pipe code
  754. * - The USB_Init() function no longer calls sei() - the user is now responsible for enabling interrupts when they are ready
  755. * for them to be enabled (thanks to Andrei Krainev)
  756. * - The Audio_Device_IsSampleReceived() and Audio_Device_IsReadyForNextSample() functions are now inline, to reduce overhead
  757. * - Removed the cast to uint16_t on the set baud rate in the USBtoSerial project, so that the higher >1M baud rates can be
  758. * selected (thanks to Steffan Woltjer)
  759. * - Removed software PDI and TPI emulation from the AVRISP-MKII clone project as it was very buggy and slow - PDI and TPI must
  760. * now be implemented via separate programming headers
  761. * - The CDC class bootloader now uses a watchdog reset rather than a soft-reset when exited to ensure that all hardware is
  762. * properly reset to their defaults
  763. * - Device mode class driver callbacks are now fired before the control request status stage is sent to prevent the host from
  764. * timing out if another request is immediately fired and the device has a lengthy callback routine
  765. * - The TeensyHID bootloader has been removed, per request from Paul at PJRC
  766. * - The LIBUSB_FILTERDRV_COMPAT compile time option in the XPLAINBridge and AVRISP-MKII projects has been renamed
  767. * LIBUSB_DRIVER_COMPAT, as it applies to all software on all platforms using the libUSB driver
  768. *
  769. * <b>Fixed:</b>
  770. * - Fixed possible device lockup when INTERRUPT_CONTROL_ENDPOINT is enabled and the control endpoint is not properly
  771. * selected when the ISR completes
  772. * - Fixed AVRISP-MKII clone project not correctly issuing LOAD EXTENDED ADDRESS commands when the extended address
  773. * boundary is crossed during programming or read back (thanks to Gerard Sexton)
  774. * - Fixed warnings when building the AVRISP-MKII clone project with the ENABLE_XPROG_PROTOCOL compile time option disabled
  775. * - Fixed software PDI/TPI programming mode in the AVRISP project not correctly toggling just the clock pin
  776. * - Fixed TWI_StartTransmission() corrupting the contents of the GPIOR0 register
  777. * - Fixed TWI driver not aborting when faced with no response after attempting to address a device on the bus
  778. * - Fixed ADC routines not correctly returning the last result when multiple channels were read
  779. * - Fixed ADC routines failing to read the extended channels (Channels 8 to 13, Internal Temperature Sensor) on the
  780. * U4 series USB AVR parts
  781. * - Fixed LowLevel MassStorage demo broken on the U2 series USB AVRs due to unsupported double-banked endpoint modes used
  782. * - Fixed compilation error in the AudioInput demos when MICROPHONE_BIASED_TO_HALF_RAIL is defined (thanks to C. Scott Ananian)
  783. * - Fixed incorrect definition of HID_ALIGN_DATA() causing incorrect HID report item data alignment
  784. * - Fixed Still Image Host class driver not resetting the transaction ID when a new session is opened, fixed driver not sending
  785. * a valid session ID to the device
  786. * - Removed invalid dfu and flip related targets from the bootloaders - bootloaders can only be replaced with an external programmer
  787. * - Fixed Set/Clear Feature requests directed to a non-configured endpoint not returning a stall to the host
  788. * - Fixed HID Device Class Driver not allocating a temporary buffer when the host requests a report via the control endpoint and the
  789. * user has set the PrevReportINBuffer driver configuration element to NULL (thanks to Lars Noschinski)
  790. * - Fixed device state not being reset to DEVICE_STATE_Default if the host sets a 0x00 device address
  791. * - Fixed device not stalling configuration requests before the device's address has been set
  792. * - Fixed possibility of internal signature retrieval being corrupted if an interrupt occurs during a signature byte
  793. * read (thanks to Andrei Krainev)
  794. * - Fixed device state not being reset back to the default state if the host sets the address to 0
  795. * - Fixed Set Configuration requests not being stalled until the host has set the device's address
  796. * - Fixed Host mode HID class driver not sending the correct report type when HID_Host_SendReportByID() was called and the
  797. * HID_HOST_BOOT_PROTOCOL_ONLY compile time option is set
  798. * - Fixed INTERRUPT_CONTROL_ENDPOINT compile time option preventing other interrupts from occurring while the control endpoint
  799. * request is being processed, causing possible lockups if a USB interrupt occurs during a transfer
  800. * - Remove incorrect Abstract Call Management class specific descriptor from the CDC demos, bootloaders and projects
  801. *
  802. *
  803. * \section Sec_ChangeLog100219 Version 100219
  804. *
  805. * <b>New:</b>
  806. * - Added TPI programming support for 6-pin ATTINY devices to the AVRISP programmer project (thanks to Tom Light)
  807. * - Added command timeout counter to the AVRISP project so that the device no longer freezes when incorrectly connected
  808. * to a target
  809. * - Added new TemperatureDataLogger application, a USB data logger which writes to the device's dataflash and appears to
  810. * the host as a standard Mass Storage device when inserted
  811. * - Added MIDI event packing support to the MIDI Device and Host mode Class drivers, allowing for multiple MIDI events to
  812. * sent or received in packed form in a single USB packet
  813. * - Added new MIDI send buffer flush routines to the MIDI Device and Host mode Class drivers, to flush packed events
  814. * - Added master mode hardware TWI driver for easy TWI peripheral control
  815. * - Added ADC MUX masks for the standard ADC input channels on all AVR models with an ADC, altered demos to use these masks
  816. * as on some models, the channel number is not identical to its single-ended ADC MUX mask
  817. * - New Webserver project, a RNDIS host USB webserver using the open source uIP TCP/IP network stack and FatFS library
  818. * - New BOARD value option BOARD_NONE (equivalent to not specifying BOARD) which will remove all board hardware drivers which
  819. * do not adversely affect the code operation (currently only the LEDs driver)
  820. * - Added keyboard modifier masks (HID_KEYBOARD_MODIFER_*) and LED report masks (KEYBOARD_LED_*) to the HID class driver and
  821. * Keyboard demos
  822. * - Added .5MHz recovery clock to the AVRISP programmer project when in ISP programming mode to correct mis-set fuses
  823. *
  824. * <b>Changed:</b>
  825. * - Slowed down software USART carried PDI programming in the AVRISP project to prevent transmission errors
  826. * - Renamed the AVRISP project folder to AVRISP-MKII to reduce confusion
  827. * - Renamed the RESET_LINE_* makefile tokens in the AVRISP MKII Project to AUX_LINE_*, as they are not always used for target
  828. * reset
  829. * - Changed over the MassStorageKeyboard Class driver device demo to use Start of Frame events rather than a timer to keep track
  830. * of elapsed milliseconds
  831. * - Inlined currently unused (but standardized) maintenance functions in the Device and Host Class drivers to save space
  832. * - The XPLAINBridge project now selects between a USB to Serial bridge and a PDI programmer on startup, reading the JTAG port's
  833. * TDI pin to determine which mode to use
  834. * - Removed the stream example code from the Low Level VirtualSerial demos, as they were buggy and only served to add clutter
  835. *
  836. * <b>Fixed:</b>
  837. * - Fixed AVRISP project not able to enter programming mode when ISP protocol is used
  838. * - Fixed AVRISP PDI race condition where the guard time between direction changes could be interpreted as a start bit
  839. * - Fixed ADC_IsReadingComplete() returning an inverted result
  840. * - Fixed blocking CDC streams not aborting when the host is disconnected
  841. * - Fixed XPLAIN board Dataflash driver broken due to incorrect preprocessor commands
  842. * - Fixed inverted XPLAIN LED driver output (LED turned on when it was supposed to be turned off, and vice-versa)
  843. * - Fixed Class Driver struct interface numbers in the KeyboardMouse and VirtualSerialMouse demos (thanks to Renaud Cerrato)
  844. * - Fixed invalid USB controller PLL prescaler values for the ATMEGAxxU2 controllers
  845. * - Fixed lack of support for the ATMEGA32U2 in the DFU and CDC class bootloaders
  846. * - Fixed Benito project not resetting the target AVR automatically when programming has completed
  847. * - Fixed DFU bootloader programming not discarding the correct number of filler bytes from the host when non-aligned programming
  848. * ranges are specified (thanks to Thomas Bleeker)
  849. * - Fixed CDC and RNDIS host demos and class drivers - bidirectional endpoints should use two separate pipes, not one half-duplex pipe
  850. * - Fixed Pipe_IsEndpointBound() not taking the endpoint's direction into account
  851. * - Fixed EEPROM and FLASH ISP programming in the AVRISP project
  852. * - Fixed incorrect values of USB_CONFIG_ATTR_SELFPOWERED and USB_CONFIG_ATTR_REMOTEWAKEUP tokens (thanks to Claus Christensen)
  853. * - Fixed SerialStream driver blocking while waiting for characters to be received instead of returning EOF
  854. * - Fixed SerialStream driver not setting stdin to the created serial stream (thanks to Mike Alexander)
  855. * - Fixed USB_GetHIDReportSize() returning the number of bits in the specified report instead of bytes
  856. * - Fixed AVRISP project not extending the command delay after each successful page/word/byte program
  857. * - Fixed accuracy of the SERIAL_UBBRVAL() and SERIAL_2X_UBBRVAL() macros for higher baud rates (thanks to Renaud Cerrato)
  858. *
  859. *
  860. * \section Sec_ChangeLog091223 Version 091223
  861. *
  862. * <b>New:</b>
  863. * - Added activity LED indicators to the AVRISP project to indicate when the device is busy processing a command
  864. * - The USB target family and allowable USB mode tokens are now public and documented (USB_CAN_BE_*, USB_SERIES_*_AVR)
  865. * - Added new XPLAIN USB to Serial Bridge project (thanks to John Steggall for initial proof-of-concept, David Prentice
  866. * and Peter Danneger for revised software USART code)
  867. * - Added new RNDIS Ethernet Host LowLevel demo
  868. * - Added new RNDIS Ethernet Host Class Driver
  869. * - Added new RNDIS Ethernet Host ClassDriver demo
  870. * - Added CDC_Host_Flush() function to the CDC Host Class driver to flush sent data to the attached device
  871. * - Added PDI programming support for XMEGA devices to the AVRISP programmer project (thanks to Justin Mattair)
  872. * - Added support for the XPLAIN board Dataflash, with new XPLAIN_REV1 board target for the different Dataflash used
  873. * on the first revision boards compared to the one mounted on later revisions
  874. * - Added new HID_ALIGN_DATA() macro to return the pre-retrieved value of a HID report item, left-aligned to a given datatype
  875. * - Added new PreviousValue to the HID Report Parser report item structure, for easy monitoring of previous report item values
  876. * - Added new EVK527 board target
  877. * - Added new USB_Host_GetDeviceStringDescriptor() convenience function
  878. * - Added new LEDNotification project to the library, to give a visual LED notification on new events from the host
  879. * - Added new NO_DEVICE_REMOTE_WAKEUP and NO_DEVICE_SELF_POWER compile time options
  880. *
  881. * <b>Changed:</b>
  882. * - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of key codes
  883. * as this relied on non-standard OS driver behaviour to repeat key groups
  884. * - The SCSI_Request_Sense_Response_t and SCSI_Inquiry_Response_t type defines are now part of the Mass Storage Class
  885. * driver common defines, rather than being defined in the Host mode Class driver section only
  886. * - The USB_MODE_HOST token is now defined even when host mode is not available
  887. * - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to
  888. * indicate the report type to generate
  889. * - All Class Drivers now return false or the "DeviceDisconnected" error code of their respective error enums when a function
  890. * is called when no host/device is connected where possible
  891. * - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to HOST_SENDCONTROL_DeviceDisconnected to be in line
  892. * with the rest of the library error codes
  893. * - Make MIDI device demos also turn off the on board LEDs if MIDI Note On messages are sent with a velocity of zero,
  894. * which some devices use instead of Note Off messages (thanks to Robin Green)
  895. * - The CDC demos are now named "VirtualSerial" instead to indicate the demos' function rather than its implemented USB class,
  896. * to reduce confusion and to be in line with the rest of the LUFA demos
  897. * - The SImage_Host_SendBlockHeader() and SImage_Host_ReceiveBlockHeader() Still Image Host Class driver functions are now public
  898. *
  899. * <b>Fixed:</b>
  900. * - Added missing CDC_Host_CreateBlockingStream() function code to the CDC Host Class driver
  901. * - Fixed incorrect values for REPORT_ITEM_TYPE_* enum values causing corrupt data in the HID Host Parser
  902. * - Fixed misnamed SI_Host_USBTask() and SI_Host_ConfigurePipes() functions
  903. * - Fixed broken USB_GetNextDescriptor() function causing the descriptor to jump ahead double the expected amount
  904. * - Fixed Pipe_IsEndpointBound() not masking the given Endpoint Address against PIPE_EPNUM_MASK
  905. * - Fixed host state machine not enabling Auto VBUS mode when HOST_DEVICE_SETTLE_DELAY_MS is set to zero
  906. * - Fixed misnamed Pipe_SetPipeToken() macro for setting a pipe's direction
  907. * - Fixed CDCHost failing on devices with bidirectional endpoints
  908. * - Fixed USB driver failing to define the PLL prescaler mask for the ATMEGA8U2 and ATMEGA16U2
  909. * - Fixed HID Parser not distributing the Usage Min and Usage Max values across an array of report items
  910. * - Fixed Mass Storage Host Class driver and Low Level demo not clearing the error condition if an attached device returns a
  911. * STALL to a GET MAX LUN request (thanks to Martin Luxen)
  912. * - Fixed TeensyHID bootloader not properly shutting down the USB interface to trigger a disconnection on the host before resetting
  913. * - Fixed MassStorageHost Class driver demo not having USB_STREAM_TIMEOUT_MS compile time option set properly to prevent slow
  914. * devices from timing out the data pipes
  915. * - Fixed the definition of the Endpoint_BytesInEndpoint() macro for the U4 series AVR parts
  916. * - Fixed MIDI host Class driver MIDI_Host_SendEventPacket() routine not properly checking for Pipe ready before writing
  917. * - Fixed use of deprecated struct initializers, removed library unused parameter warnings when compiled with -Wextra enabled
  918. * - Fixed Still Image Host Class driver truncating the PIMA response code (thanks to Daniel Seibert)
  919. * - Fixed USB_CurrentMode not being reset to USB_MODE_NONE when the USB interface is shut down and both Host and Device modes can be
  920. * used (thanks to Daniel Levy)
  921. * - Fixed TeensyHID bootloader not enumerating to the host correctly (thanks to Clint Fisher)
  922. * - Fixed AVRISP project timeouts not checking for the correct timeout period (thanks to Carl Ott)
  923. * - Fixed STK525 Dataflash driver using incorrect bit-shifting for Dataflash addresses (thanks to Tim Mitchell)
  924. *
  925. *
  926. * \section Sec_ChangeLog091122 Version 091122
  927. *
  928. * <b>New:</b>
  929. * - Added new Dual Role Keyboard/Mouse demo
  930. * - Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the HID Host Class driver when
  931. * Report protocol is not needed
  932. * - Added new MIDI LowLevel and ClassDriver Host demo, add new MIDI Host Class driver
  933. * - Added new CDC/Mouse ClassDriver device demo
  934. * - Added new Joystick Host ClassDriver and LowLevel demos
  935. * - Added new Printer Host mode Class driver
  936. * - Added new Printer Host mode ClassDriver demo
  937. * - Added optional support for double banked endpoints and pipes in the Device and Host mode Class drivers
  938. * - Added new stream creation function to the CDC Class drivers, to easily make standard I/O streams from CDC Class driver instances
  939. *
  940. * <b>Changed:</b>
  941. * - Removed mostly useless "TestApp" demo, as it was mainly useful only for checking for syntax errors in the library
  942. * - MIDI device demos now receive MIDI events from the host and display note ON messages via the board LEDs
  943. * - Cleanups to the Device mode Mass Storage demo application SCSI routines
  944. * - Changed Audio Class driver sample read/write functions to be inline, to reduce the number of cycles needed to transfer
  945. * samples to and from the device (allowing more time for sample processing and output)
  946. * - Audio class Device mode demos now work at both 16MHz and 8MHz, rather than just at 8MHz
  947. * - The previous USBtoSerial demo has been moved into the projects directory, as it was just a modified CDC demo
  948. * - The Endpoint/Pipe functions now use the const qualifier on the input buffer
  949. * - Changed the CALLBACK_HIDParser_FilterHIDReportItem() callback to pass a HID_ReportItem_t rather than just the current
  950. * item's attributes, to expose more information on the item (including it's type, collection path, etc.)
  951. * - Changed MouseHostWithParser demos to check that the report items have a Mouse usage collection as a parent at some point,
  952. * to prevent Joysticks from enumerating with the demo
  953. * - Corrected the name of the misnamed USB_GetDeviceConfigDescriptor() function to USB_Host_GetDeviceConfigDescriptor().
  954. * - Keyboard LowLevel/ClassDriver demos now support multiple simultaneous key presses (up to 6) per report
  955. *
  956. * <b>Fixed:</b>
  957. * - Fixed PrinterHost demo returning invalid Device ID data when the attached device does not have a
  958. * device ID (thanks to Andrei Krainev)
  959. * - Changed LUFA_VERSION_INTEGER define to use BCD values, to make comparisons easier
  960. * - Fixed issue in the HID Host class driver's HID_Host_SendReportByID() routine using the incorrect mode (control/pipe)
  961. * to send report to the attached device
  962. * - Fixed ClassDriver AudioOutput device demo not selecting an audio output mode
  963. * - Fixed incorrect SampleFrequencyType value in the AudioInput and AudioOutput ClassDriver demos' descriptors
  964. * - Fixed incorrect event name rule in demo/project/bootloader makefiles
  965. * - Fixed HID device class driver not reselecting the correct endpoint once the user callback routines have been called
  966. * - Corrected HID descriptor in the Joystick Device demos - buttons should be placed outside the pointer collection
  967. * - Fixed HID report parser collection paths invalid due to misplaced semicolon in the free path item search loop
  968. * - Fixed HID host Class driver report send/receive report broken when issued through the control pipe
  969. * - Fixed HOST_STATE_AS_GPIOR compile time option being ignored when in host mode (thanks to David Lyons)
  970. * - Fixed LowLevel Keyboard demo not saving the issues report only after it has been sent to the host
  971. * - Fixed Endpoint_Write_Control_Stream_* functions not sending a terminating IN when given data Length is zero
  972. *
  973. *
  974. * \section Sec_ChangeLog090924 Version 090924
  975. *
  976. * <b>New:</b>
  977. * - Added new host mode class drivers and matching demos to the library for rapid application development
  978. * - Added flag to the HID report parser to indicate if a device has multiple reports
  979. * - Added new EVENT_USB_Device_StartOfFrame() event, controlled by the new USB_Device_EnableSOFEvents() and
  980. * USB_Device_DisableSOFEvents() macros to give bus-synchronized millisecond interrupts when in USB device mode
  981. * - Added new Endpoint_SetEndpointDirection() macro for bidirectional endpoints
  982. * - Added new AVRISP project, a LUFA powered clone of the Atmel AVRISP-MKII programmer
  983. * - Added ShutDown() functions for all hardware peripheral drivers, so that peripherals can be turned off after use
  984. * - Added new CDC_Device_Flush() command to the device mode CDC Class driver to flush Device->Host data
  985. * - Added extra masks to the SPI driver, changed SPI_Init() so that the clock polarity and sample modes can be set
  986. * - Added new callback to the HID report parser, so that the user application can filter only the items it is interested
  987. * in to be stored into the HIDReportInfo structure to save RAM
  988. * - Added support for the officially recommended external peripheral layout for the BUMBLEB board (thanks to Dave Fletcher)
  989. * - Added new Pipe_IsFrozen() macro to determine if the currently selected pipe is frozen
  990. * - Added new USB_GetHIDReportSize() function to the HID report parser to retrieve the size of a given report by its ID
  991. * - Added new combined Mass Storage and Keyboard demo (thanks to Matthias Hullin)
  992. *
  993. * <b>Changed:</b>
  994. * - SetIdle requests to the HID device driver with a 0 idle period (send changes only) now only affect the requested
  995. * HID interface within the device, not all HID interfaces
  996. * - Added explicit attribute masks to the device mode demos' descriptors
  997. * - Added return values to the CDC and MIDI class driver transmit functions
  998. * - Optimized Endpoint_Read_Word_* and Pipe_Read_Word_* macros to reduce compiled size
  999. * - Added non-null function parameter pointer restrictions to USB Class drivers to improve user code reliability
  1000. * - Added new "Common" section to the class drivers, to hold all mode-independent definitions for clarity
  1001. * - Moved SCSI command/sense constants into the Mass Storage Class driver, instead of the user-code
  1002. * - Altered the SCSI commands in the LowLevel Mass Storage Host to save on FLASH space by reducing function calls
  1003. * - Changed the parameters and behaviour of the USB_GetDeviceConfigDescriptor() function so that it now performs size checks
  1004. * and data validations internally, to simplify user code
  1005. * - Changed HIDParser to only zero out important values in the Parsed HID Report Item Information structure to save cycles
  1006. * - The HID report parser now always processed FEATURE items - HID_ENABLE_FEATURE_PROCESSING token now has no effect
  1007. * - The HID report parser now always ignores constant-data items, HID_INCLUDE_CONSTANT_DATA_ITEMS token now has no effect
  1008. * - The Benito Programmer project now has its own unique VID/PID pair allocated from the Atmel donated LUFA VID/PID pool
  1009. * - Add in new invalid event hook check targets to project makefiles to produce compilation errors when invalid event names
  1010. * are used in a project
  1011. * - The HID Report Parser now gives information on the total length of each report within a HID interface
  1012. * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate USB_Descriptor_* and
  1013. * USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so both may be used
  1014. *
  1015. * <b>Fixed:</b>
  1016. * - Fixed possible lockup in the CDC device class driver, when the host sends data that is a multiple of the
  1017. * endpoint's bank
  1018. * - Fixed swapped parameters in the HID state memory copy call while processing a HID PUSH item in the HID report parser
  1019. * - Fixed memory corruption HID report parser when too many COLLECTION or PUSH items were processed
  1020. * - Fixed HID report parser not resetting the FEATURE item count when a REPORT ID item is encountered
  1021. * - Fixed USBtoSerial demos not reading in UDR1 when the USART receives data but the USB interface is not enumerated,
  1022. * causing continuous USART receive interrupts
  1023. * - Fixed misspelled event name in the Class driver USBtoSerial demo, preventing correct operation
  1024. * - Fixed invalid data being returned when a GetStatus request is issued in Device mode with an unhandled data recipient
  1025. * - Added hardware USART receive interrupt and software buffering to the Benito project to ensure received data is not
  1026. * missed or corrupted
  1027. * - Fixed Device mode HID Class driver always sending IN packets, even when nothing to report
  1028. * - Fixed Device mode HID Class driver not explicitly initializing the ReportSize parameter to zero before calling callback
  1029. * routine, so that ignored callbacks don't cause incorrect data to be sent
  1030. * - Fixed StillImageHost not correctly freezing and unfreezing data pipes while waiting for a response block header
  1031. * - Fixed error in the PrinterHost demo preventing the full page data from being sent to the attached device (thanks to John Andrews)
  1032. * - Fixed CDC based demos and projects' INF driver files under 64 bit versions of Windows (thanks to Ronny Hanson, Thomas Bleeker)
  1033. * - Re-add in missing flip, flip-ee, dfu and dfu-ee targets to project makefiles (thanks to Opendous Inc.)
  1034. * - Fix allowable F_CPU values comment in project makefiles to more accurately reflect the allowable values on the USB AVRs
  1035. * - Fixed DFU and CDC class bootloaders on the series 2 USB AVRs, corrected invalid signatures, added support for the new
  1036. * ATMEGAxx2 series 2 variant AVRs to the DFU bootloader
  1037. * - Fixed Low Level USBtoSerial demo not storing received characters (thanks to Michael Cooper)
  1038. * - Fixed MIDI Device Class driver not sending/receiving MIDI packets of the correct size (thanks to Thomas Bleeker)
  1039. *
  1040. *
  1041. * \section Sec_ChangeLog090810 Version 090810
  1042. *
  1043. * <b>New:</b>
  1044. * - Added new device class drivers and matching demos to the library for rapid application development
  1045. * - Added new PrinterHost demo (thanks to John Andrews)
  1046. * - Added USB Missile Launcher project, submitted by Dave Fletcher
  1047. * - Added new Benito Arduino Programmer project
  1048. * - Added incomplete device and host mode demos for later enhancement
  1049. * - Updated MassStorage device block write routines to use ping-pong Dataflash buffering to increase throughput by around 30%
  1050. * - Error status LEDs shown when device endpoint configuration fails to complete in all demos and projects
  1051. * - Added new USB_Host_SetDeviceConfiguration() convenience function for easy configuration selection of devices while in USB
  1052. * host mode
  1053. * - Added new USB_Host_ClearPipeStall() convenience function to clear a stall condition on an attached device's endpoint
  1054. * - Added new USB_Host_GetDeviceDescriptor() convenience function to retrieve the attached device's Device descriptor
  1055. * - Added new Endpoint_ClearStatusStage() convenience function to assist with the status stages of control transfers
  1056. * - Added new USE_INTERNAL_SERIAL define for using the unique serial numbers in some AVR models as the USB device's serial number,
  1057. * added NO_INTERNAL_SERIAL compile time option to turn off new serial number reading code
  1058. * - Added new DATAFLASH_CHIP_MASK() macro to the Dataflash driver, which returns the Dataflash select mask for the given chip index
  1059. * - Added new HOST_STATE_WaitForDeviceRemoval host state machine state for non-blocking disabling of device communications until the
  1060. * device has been removed (for use when an error occurs or communications with the device have completed)
  1061. * - Added new FAST_STREAM_TRANSFERS compile time option for faster stream transfers via multiple bytes copied per stream loop
  1062. * - Added stdio stream demo code to the CDC device demos, to show how to create standard streams out of the virtual serial ports
  1063. * - Added new EEPROM and FLASH buffer versions of the Endpoint and Pipe stream functions
  1064. * - Added new USE_FLASH_DESCRIPTORS and FIXED_NUM_CONFIGURATIONS compile time options
  1065. * - Added support for the new ATMEGA32U2, ATMEGA16U2 and ATMEGA8U2 AVR models
  1066. * - Added new USB_DeviceState variable to keep track of the current Device mode USB state
  1067. * - Added new LEDs_ToggleLEDs() function to the LEDs driver
  1068. * - Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions
  1069. * - Added new DEVICE_STATE_AS_GPIOR and HOST_STATE_AS_GPIOR compile time options
  1070. * - Added 404 Not Found errors to the webserver in the RNDIS demos to indicate invalid URLs
  1071. *
  1072. * <b>Changed:</b>
  1073. * - Deprecated pseudo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused)
  1074. * - The device-mode CALLBACK_USB_GetDescriptor() function now has an extra parameter so that the memory space in which the requested
  1075. * descriptor is located can be specified. This means that descriptors can now be located in multiple memory spaces within a device.
  1076. * - Removed vague USB_IsConnected global - test USB_DeviceState or USB_HostState explicitly to gain previous functionality
  1077. * - Removed USB_IsSuspended global - test USB_DeviceState against DEVICE_STATE_Suspended instead
  1078. * - Extended USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch
  1079. * - Dataflash_WaitWhileBusy() now always ensures that the dataflash is ready for the next command immediately after returning,
  1080. * no need to call Dataflash_ToggleSelectedChipCS() afterwards
  1081. * - Low level API MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready
  1082. * - Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow errors
  1083. * - Pipe stream functions now automatically set the correct pipe token, so that bidirectional pipes can be used
  1084. * - Pipe_ConfigurePipe() now automatically defaults IN pipes to accepting infinite IN requests, this can still be changed by calling
  1085. * the existing Pipe_SetFiniteINRequests() function
  1086. * - Changed F_USB entries in project makefiles to alias to F_CPU by default, as this is the most common case
  1087. * - Host mode demos now use sane terminal escape codes, so that text is always readable and events/program output is visually distinguished
  1088. * from one another using foreground colours
  1089. * - Internal per-device preprocessing conditions changed to per-device series rather than per-controller group for finer-grain
  1090. * internal control
  1091. * - Interrupts are no longer disabled during the processing of Control Requests on the default endpoint while in device mode
  1092. * - AudioOutput demos now always output to board LEDs, regardless of output mode (removed AUDIO_OUT_LEDS project option)
  1093. * - Removed SINGLE_DEVICE_CONFIGURATION compile time option in favor of the new FIXED_NUM_CONFIGURATIONS option so that the exact number
  1094. * of device configurations can be defined statically
  1095. * - Removed VBUS events, as they are already exposed to the user application via the regular device connection and disconnection events
  1096. * - Renamed and altered existing events to properly separate out Host and Device mode events
  1097. * - All demos switched over from GNU99 standards mode to C99 standards mode, to reduce the dependencies on GCC-only language extensions
  1098. *
  1099. * <b>Fixed:</b>
  1100. * - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed to fix
  1101. * bootloaders on some of the USB AVR devices where avr-libc erroneously defines RAMPZ
  1102. * - Fixes to MassStorageHost for better device compatibility (increase command timeout, change MassStore_WaitForDataReceived()
  1103. * to only unfreeze and check one data pipe at a time) to prevent incorrect device enumerations and freezes while transferring data
  1104. * - Make Pipe_ConfigurePipe() mask the given endpoint number against PIPE_EPNUM_MASK to ensure the endpoint IN direction bit is
  1105. * cleared to prevent endpoint type corruption
  1106. * - Fixed issue opening CDC-ACM ports on hosts when the CDC device tries to send data before the host has set the line encoding
  1107. * - Fixed USB_OPT_MANUAL_PLL option being ignored during device disconnects on some models (thanks to Brian Dickman)
  1108. * - Fixed documentation mentioning Pipe_GetCurrentToken() function when correct function name is Pipe_GetPipeToken()
  1109. * - Fixed ADC driver for the ATMEGA32U4 and ATMEGA16U4 (thanks to Opendous Inc.)
  1110. * - Fixed CDCHost demo unfreezing the pipes at the point of configuration, rather than use
  1111. * - Fixed MassStorage demo not clearing the reset flag when a Mass Storage Reset is issued while not processing a command
  1112. * - Fixed USB_Host_SendControlRequest() not re-suspending the USB bus when initial device ready-wait fails
  1113. * - Fixed USB Pad regulator not being disabled on some AVR models when the USB_OPT_REG_DISABLED option is used
  1114. * - Fixed Host mode to Device mode UID change not causing a USB Disconnect event when a device was connected
  1115. * - Fixed Mouse/Keyboard demos not performing the correct arithmetic on the Idle period at the right times (thanks to Brian Dickman)
  1116. * - Fixed GenericHID failing HID class tests due to incorrect Logical Minimum and Logical Maximum values (thanks to Soren Greiner)
  1117. * - Fixed incorrect PIPE_EPNUM_MASK mask causing pipe failures on devices with endpoint addresses of 8 and above (thanks to John Andrews)
  1118. * - Fixed report data alignment issues in the MouseHostWithParser demo when X and Y movement data size is not a multiple of 8 bits
  1119. * - Fixed HID Report Descriptor Parser not correctly resetting internal states when a REPORT ID element is encountered
  1120. * - Fixed incorrect BUTTONS_BUTTON1 for the STK526 target
  1121. * - Fixed RNDIS demos freezing when more than one connection was attempted simultaneously, causing memory corruption
  1122. * - Fixed USBtoSerial demo receiving noise from the USART due to pull-up not being enabled
  1123. *
  1124. *
  1125. * \section Sec_ChangeLog090605 Version 090605
  1126. *
  1127. * - Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest structure for control request data
  1128. * - Fixed documentation showing incorrect USB mode support on the supported AVRs list
  1129. * - Fixed RNDISEthernet not working under Linux due to Linux requiring an "optional" RNDIS request which was unhandled
  1130. * - Fixed Mouse and Keyboard device demos not acting in accordance with the HID specification for idle periods (thanks to Brian Dickman)
  1131. * - Removed support for endpoint/pipe non-control interrupts; these did not act in the way users expected, and had many subtle issues
  1132. * - Fixed Device Mode not handling Set Feature and Clear Feature Chapter 9 requests that are addressed to the device (thanks to Brian Dickman)
  1133. * - Moved control endpoint interrupt handling into the library itself, enable via the new INTERRUPT_CONTROL_ENDPOINT token
  1134. * - Fixed CDCHost not clearing configured pipes and resetting configured pipes mask when a partially enumerated invalid CDC
  1135. * interface is skipped
  1136. * - Clarified the size of library tokens which accept integer values in the Compile Time Tokens page, values now use the smallest datatype
  1137. * inside the library that is able to hold their defined value to save space
  1138. * - Removed DESCRIPTOR_ADDRESS() macro as it was largely superfluous and only served to obfuscate code
  1139. * - Rewritten event system to remove all macros, to make user code clearer
  1140. * - Fixed incorrect ENDPOINT_EPNUM_MASK mask preventing endpoints above EP3 from being selected (thanks to Jonathan Oakley)
  1141. * - Removed STREAM_CALLBACK() macro - callbacks now use regular function definitions to clarify user code
  1142. * - Removed DESCRIPTOR_COMPARATOR() macro - comparators should now use regular function definitions to clarify user code
  1143. * - USB_IsConnected is now cleared before the USB_Disconnect() event is fired in response to VBUS being removed
  1144. * - Fixed incorrect PID value being used in the USBtoSerial project (thanks to Phill)
  1145. * - Deleted StdDescriptors.c, renamed USB_GetDescriptor() to CALLBACK_USB_GetDescriptor, moved ConfigDescriptor.c/.h from the
  1146. * LUFA/Drivers/USB/Class/ directory to LUFA/Drivers/USB/HighLevel/ in preparation for the new USB class APIs
  1147. * - Moved out each demos' functionality library files (e.g. Ring Buffer library) to /Lib directories for a better directory structure
  1148. * - Removed Tx interrupt from the USBtoSerial demo; now sends characters via polling to ensure more time for the Rx interrupt
  1149. * - Fixed possible enumeration errors from spin-loops which may fail to exit if the USB connection is severed before the exit condition
  1150. * becomes true
  1151. *
  1152. *
  1153. * \section Sec_ChangeLog090510 Version 090510
  1154. *
  1155. * - Added new GenericHIDHost demo
  1156. * - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use
  1157. * - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR
  1158. * - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile
  1159. * time options
  1160. * - All comments in the library, bootloaders, demos and projects have now been spell-checked and spelling mistakes/typos corrected
  1161. * - Added new PIMA_DATA_SIZE() define to the Still Image Host demo
  1162. * - Add call to MassStore_WaitForDataReceived() in MassStore_GetReturnedStatus() to ensure that the CSW has been received in the
  1163. * extended MSC timeout period before continuing, to prevent long processing delays from causing the MassStore_GetReturnedStatus()
  1164. * to early-abort (thanks to Dmitry Maksimov)
  1165. * - Move StdRequestType.h, StreamCallbacks.h, USBMode.h from the LowLevel USB driver directory to the HighLevel USB driver directory,
  1166. * where they are more suited
  1167. * - Removed all binary constants and replaced with decimal or hexadecimal constants so that unpatched GCC compilers can still build the
  1168. * code without having to be itself patched and recompiled first
  1169. * - Added preprocessor checks and documentation to the bootloaders giving information about missing SIGNATURE_x defines due to
  1170. * outdated avr-libc versions.
  1171. * - Added support to the CDCHost demo for devices with multiple CDC interfaces which are not the correct ACM type preceding the desired
  1172. * ACM CDC interface
  1173. * - Fixed GenericHID demo not starting USB and HID management tasks when not using interrupt driven modes (thanks to Carl Kjeldsen)
  1174. * - Fixed RNDISEthenet demo checking the incorrect message field for packet size constraints (thanks to Jonathan Oakley)
  1175. * - Fixed WriteNextReport code in the GenericHIDHost demo using incorrect parameter types and not selecting the correct endpoint
  1176. * - Adjusted sample CTC timer calculations in the AudioOutput and AudioInput demos to match the CTC calculations in the AVR datasheet,
  1177. * and to fix instances where rounding caused the endpoint to underflow (thanks to Robin Theunis)
  1178. * - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0), so that other control type
  1179. * pipes can be used with the function
  1180. * - The USB Host management task now saves and restores the currently selected pipe before and after the task completes
  1181. * - Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev)
  1182. * - Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favor of new Endpoint_ClearIN(), Endpoint_ClearOUT(),
  1183. * Pipe_ClearIN() and Pipe_ClearOUT() macros (done to allow for the detection of packets of zero length)
  1184. * - Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API
  1185. * - Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been
  1186. * renamed to Endpoint_ClearSETUP(), the Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent() and the
  1187. * Pipe_ClearSetupSent() macro is no longer applicable and should be removed - changes made to compliment the new endpoint and pipe
  1188. * bank management API
  1189. * - Updated all demos, bootloaders and projects to use the new endpoint and pipe management APIs (thanks to Roman Thiel from Curetis AG)
  1190. * - Updated library Doxygen documentation, added groups, changed documentation macro functions to real functions for clarity
  1191. * - Removed old endpoint and pipe aliased read/write/discard routines which did not have an explicit endian specifier for clarity
  1192. * - Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway
  1193. * - Renamed the main Drivers/AT90USBXXX directory to Drivers/Peripheral, renamed the Serial_Stream driver to SerialStream
  1194. * - Fixed CDC and USBtoSerial demos freezing where buffers were full while still transmitting or receiving (thanks to Peter Hand)
  1195. * - Removed "Host_" section of the function names in ConfigDescriptor.h, as most of the routines can now be used in device mode on the
  1196. * device descriptor
  1197. * - Renamed functions in the HID parser to have a "USB_" prefix and the acronym "HID" in the name
  1198. * - Fixed incorrect HID interface class and subclass values in the Mouse and KeyboardMouse demos (thanks to Brian Dickman)
  1199. * - Capitalized the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and
  1200. * DSearch_Comp_Return_ErrorCodes_t enums
  1201. * - Removed "ERROR" from the enum names in the endpoint and pipe stream error code enums
  1202. * - Renamed the USB_PowerOnErrorCodes_t enum to USB_InitErrorCodes_t, renamed the POWERON_ERROR_NoUSBModeSpecified enum value to
  1203. * USB_INITERROR_NoUSBModeSpecified
  1204. * - Renamed USB_PowerOnFail event to USB_InitFailure
  1205. * - Renamed OTG.h header functions to be more consistent with the rest of the library API
  1206. * - Changed over all deprecated GCC structure tag initializers to the standardized C99 format (thanks to Mike Alexander)
  1207. * - USB_HostRequest renamed to USB_ControlRequest, entire control request header is now read into USB_ControlRequest in Device mode
  1208. * rather than having the library pass only partially read header data to the application
  1209. * - The USB_UnhandledControlPacket event has had its parameters removed, in favor of accessing the new USB_ControlRequest structure
  1210. * - The Endpoint control stream functions now correctly send a ZLP to the host when less data than requested is sent
  1211. * - Fixed USB_RemoteWakeupEnabled flag never being set (the REMOTE WAKEUP Set Feature request was not being handled)
  1212. * - Renamed the FEATURELESS_CONTROL_ONLY_DEVICE compile-time token to CONTROL_ONLY_DEVICE
  1213. * - Endpoint configuration is now refined to give better output when all configurations have static inputs - removed the now useless
  1214. * STATIC_ENDPOINT_CONFIGURATION compile time token
  1215. * - Fixed SPI driver init function not clearing SPI2X bit when not needed
  1216. * - Fixed PREVENT ALLOW MEDIUM REMOVAL command issuing in the MassStorageHost demo using incorrect parameters (thanks to Mike Alex)
  1217. * - Fixed MassStorageHost demo broken due to an incorrect if statement test in MassStore_GetReturnedStatus()
  1218. * - Fixed reversed signature byte ordering in the CDC bootloader (thanks to Johannes Raschke)
  1219. * - Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with faulty devices which do not respect the given
  1220. * wLength value when reading in the device descriptor
  1221. * - Fixed missing semicolon in the ATAVRUSBRF01 LED board driver code (thanks to Morten Lund)
  1222. * - 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
  1223. * with less than four LEDs without code modifications (thanks to Morten Lund)
  1224. * - Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button
  1225. * - Serial driver now correctly calculates the baud register value when in double speed mode
  1226. * - Init function of the Serial driver is now static inline to product smaller code for the common-case of static init values
  1227. *
  1228. *
  1229. * \section Sec_ChangeLog090401 Version 090401
  1230. *
  1231. * - Fixed MagStripe project configuration descriptor containing an unused (blank) endpoint descriptor
  1232. * - Incorporated makefile changes by Denver Gingerich to retain compatibility with stock (non-WinAVR) AVR-GCC installations
  1233. * - Fixed makefile EEPROM programming targets programming FLASH data in addition to EEPROM data
  1234. * - LUFA devices now enumerate correctly with LUFA hosts
  1235. * - Fixed Configuration Descriptor search routine freezing when a comparator returned a failure
  1236. * - Removed HID report item serial dump in the MouseHostWithParser and KeyboardHostWithParser - useful only for debugging, and
  1237. * slowed down the enumeration of HID devices too much
  1238. * - Increased the number of bits per track which can be read in the MagStripe project to 8192 when compiled for the AT90USBXXX6/7
  1239. * - Fixed KeyboardMouse demo discarding the wIndex value in the REQ_GetReport request
  1240. * - USBtoSerial demo now discards all Rx data when not connected to a USB host, rather than buffering characters for transmission
  1241. * next time the device is attached to a host.
  1242. * - Added new F_USB compile time constant to the library and makefiles, to give the raw input clock (used to feed the PLL before any
  1243. * clock prescaling is performed) frequency, so that the PLL prescale mask can be determined
  1244. * - Changed stream wait timeout counter to be 16-bit, so that very long timeout periods can be set for correct communications with
  1245. * badly designed hosts or devices which greatly exceed the USB specification limits
  1246. * - Mass Storage Host demo now uses a USB_STREAM_TIMEOUT_MS of two seconds to maintain compatibility with poorly designed devices
  1247. * - Function attribute ATTR_ALWAYSINLINE renamed to ATTR_ALWAYS_INLINE to match other function attribute macro naming conventions
  1248. * - Added ATTR_ALWAYS_INLINE attribute to several key inlined library components, to ensure they are inlined in all circumstances
  1249. * - Removed SetSystemClockPrescaler() macro, the clock_prescale_set() avr-libc macro has been corrected in recent avr-libc versions
  1250. * - Fixed incorrect/missing control status stage transfers on demos, bootloaders and applications (thanks to Nate Lawson)
  1251. * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
  1252. * to also remove parts of the Get Status chapter 9 request to further reduce code usage
  1253. * - Makefile updated to include output giving the currently selected BOARD parameter value
  1254. * - Board Dataflash driver now allows for dataflash ICs which use different shifts for setting the current page/byte address (thanks
  1255. * to Kenneth Clubb)
  1256. * - Added DataflashManager_WriteBlocks_RAM() and DataflashManager_ReadBlocks_RAM() functions to the MassStorage demo, to allow for easy
  1257. * interfacing with a FAT library for dataflash file level access
  1258. * - Corrected CDC class bootloader to fix a few bugs, changed address counter to store x2 addresses for convenience
  1259. * - Fixed typos in the SPI driver SPI_SPEED_FCPU_DIV_64 and SPI_SPEED_FCPU_DIV_128 masks (thanks to Markus Zocholl)
  1260. * - Keyboard and Mouse device demos (normal, data interrupt and fully interrupt driven) combined into unified keyboard and mouse demos
  1261. * - Keyboard and Mouse host demos (normal and data interrupt driven) combined into unified keyboard and mouse demos
  1262. * - Removed AVRISP_Programmer project due to code quality concerns
  1263. * - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incoming data
  1264. * - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)
  1265. * - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)
  1266. * - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)
  1267. * - Added new GenericHID device demo application
  1268. * - Fixed Still Image Host SImage_SendData() function not clearing the pipe bank after sending data
  1269. *
  1270. *
  1271. * \section Sec_ChangeLog090209 Version 090209
  1272. *
  1273. * - PWM timer mode in AudioOut demo changed to Fast PWM for speed
  1274. * - Updated Magstripe project to work with the latest hardware revision
  1275. * - Fixed library not responding to the BCERRI flag correctly in host mode, leading to device lockups
  1276. * - Fixed library handling Get Descriptor requests when not addressed as standard requests to the device or interface (thanks to
  1277. * Nate Lawson)
  1278. * - Fixed serious data corruption issue in MassStorage demo dataflash write routine
  1279. * - Added new NO_CLEARSET_FEATURE_REQUEST compile time token
  1280. * - USB task now restores previous global interrupt state after execution, rather than forcing global interrupts to be enabled
  1281. * - Fixed USB_DeviceEnumerationComplete event firing after each configuration change, rather than once after the initial configuration
  1282. * - Added ENDPOINT_DOUBLEBANK_SUPPORTED() macros to Endpoint.h, altered ENDPOINT_MAX_SIZE() to allow user to specify endpoint
  1283. * - ENDPOINT_MAX_ENDPOINTS changed to ENDPOINT_TOTAL_ENDPOINTS, PIPE_MAX_PIPES changed to PIPE_TOTAL_PIPES
  1284. * - Endpoint and Pipe non-control stream functions now ensure endpoint or pipe is ready before reading or writing
  1285. * - Changed Teensy bootloader to use a watchdog reset when exiting rather than a software jump
  1286. * - Fixed integer promotion error in MassStorage and MassStorageHost demos, corrupting read/write transfers
  1287. * - SPI_SendByte is now SPI_TransferByte, added new SPI_SendByte and SPI_ReceiveByte functions for fast one-way transfer
  1288. * - MassStorage demo changed to use new fast one-way SPI transfers to increase throughput
  1289. * - MassStorage handling of Mass Storage Reset class request improved
  1290. * - Altered MassStorage demo dataflash block read code for speed
  1291. * - Added USB_IsSuspended global flag
  1292. * - Simplified internal Dual Mode (OTG) USB library code to reduce code size
  1293. * - Extended stream timeout period to 100ms from 50ms
  1294. * - Mass Storage Host demo commands now all return an error code from the Pipe_Stream_RW_ErrorCodes_t enum
  1295. * - Added SubErrorCode parameter to the USB_DeviceEnumerationFailed event
  1296. * - VBUS drop interrupt now disabled during the manual-to-auto VBUS delivery handoff
  1297. * - Simplified low level backend so that device/host mode initialization uses the same code paths
  1298. * - Added workaround for faulty Mass Storage devices which do not implement the required GET_MAX_LUN request
  1299. * - Removed buggy Telnet application from the RNDIS demo
  1300. * - Moved Mass Storage class requests in the Mass Storage Host demo to wrapper functions in MassStoreCommands.c
  1301. * - Fixed incorrect SCSI command size value in the Request Sense command in MassStoreCommands.c
  1302. * - Added SetProtocol request to HID class non-parser Mouse and Keyboard demos to force devices to use the correct Boot Protocol
  1303. * - Added new "dfu" and "flip" programming targets to project makefiles
  1304. * - HID_PARSE_Sucessful enum member typo corrected to HID_PARSE_Successful
  1305. * - Changed COLLECTION item structures in the HID descriptor parser to include the collection's Usage Page value
  1306. * - Serial driver now sets Tx line as output, enables pull-up on Rx line
  1307. * - Fixed smaller USB AVRs raising multiple connection and disconnection events when NO_LIMITED_CONTROLLER_CONNECT is disabled
  1308. * - Added HOST_DEVICE_SETTLE_DELAY_MS to give the host delay after a device is connected before it is enumerated
  1309. * - Fixed KeyboardHostWithParser demo linking against the wrong global variables
  1310. * - Completed doxygen documentation of remaining library bootloaders, demos and projects
  1311. * - Fixed incorrect bootloader start address in the TeensyHID bootloader
  1312. * - Added HWB button whole-disk ASCII dump functionality to MassStoreHost demo
  1313. * - Replaced printf_P(PSTR("%c"), {Variable}) calls with putchar(<Variable>) for speed and size savings
  1314. * - Serial driver now accepts baud rates over 16-bits in size, added double speed flag option
  1315. * - Fixed incorrect callback abort return value in Pipe.c
  1316. * - Added new flip-ee and dfu-ee makefile targets (courtesy of Opendous Inc.)
  1317. * - Removed reboot-on-disconnect code from the TeensyHID bootloader, caused problems on some systems
  1318. * - Fixed AudioOutput and AudioInput demos looping on the endpoint data, rather than processing a sample at a time and returning
  1319. * each time the task runs to allow for other tasks to execute
  1320. * - Added support for the Atmel ATAVRUSBRF01 board
  1321. * - Added AVRISP Programmer Project, courtesy of Opendous Inc.
  1322. * - Fixed CDC Host demo not searching through both CDC interfaces for endpoints
  1323. * - Fixed incorrect Product String descriptor length in the DFU class bootloader
  1324. *
  1325. *
  1326. * \section Sec_ChangeLog081224 Version 081224
  1327. *
  1328. * - MyUSB name changed to LUFA, the Lightweight USB Framework for AVRs
  1329. * - Fixed Mass Storage Host demo's MassStore_SendCommand() delay in the incorrect place
  1330. * - Fixed USBtoSerial demo not calling ReconfigureUSART() after a change in the line encoding
  1331. * - Fixed infinite loop in host mode Host-to-Device control transfers with data stages
  1332. * - HID report parser now supports devices with multiple reports in one interface via Report IDs
  1333. * - Fixed RZUSBSTICK board LED driver header incorrect macro definition order causing compile errors
  1334. * - Calling USB_Init() when the USB interface is already configured now forces a complete interface reset
  1335. * and re-enumeration - fixes MyUSB DFU bootloader not switching to app code correctly when soft reset used
  1336. * - Fixed "No newline at end of file" warning when stream callbacks are enabled
  1337. * - DFU bootloader now uses fixed signature bytes per device, rather than reading them out dynamically for size
  1338. * - Added new FIXED_CONTROL_ENDPOINT_SIZE and USE_SINGLE_DEVICE_CONFIGURATION switches to statically define certain values to
  1339. * reduce compiled binary size
  1340. * - Added new NO_LIMITED_CONTROLLER_CONNECT switch to prevent the library from trying to determine bus connection
  1341. * state from the suspension and wake up events on the smaller USB AVRs
  1342. * - Added summary of all library compile time tokens to the documentation
  1343. * - Added overview of the LUFA scheduler to the documentation
  1344. * - Removed MANUAL_PLL_CONTROL compile time token, replaced with a mask for the USB_Init() Options parameter
  1345. * - CDC bootloader now uses the correct non-far or far versions of the pgm_* functions depending on if RAMPZ is defined
  1346. * - Doxygen documentation now contains documentation on all the projects, bootloaders and most demos included with the library
  1347. * - CDC bootloader now runs user application when USB disconnected rather than waiting for a hard reset
  1348. * - MouseHostWithParser and KeyboardHostWithParser now support multiple-report devices
  1349. * - RNDIS demo can now close connections correctly using the new TCP_APP_CLOSECONNECTION() macro - used in Webserver
  1350. * - Fixed the DFU bootloader, no longer freezes up when certain files are programmed into an AVR, made reading/writing faster
  1351. * - Fixed mouse/joystick up/down movements reversed - HID mouse X/Y coordinates use a left-handed coordinate system, not a normal
  1352. * right-handed system
  1353. * - Added stub code to the CDC and USBtoSerial demos showing how to read and set the RS-232 handshake lines - not currently used in
  1354. * the demos, but the example code and supporting defines are now in place
  1355. * - Interrupts are now disabled when processing a control request in device mode, to avoid exceeding the strict control request
  1356. * timing requirements.
  1357. * - All demos now use a central StatusUpdate() function rather than direct calls to the board LED functions, so that the demos can
  1358. * easily be altered to show different LED combinations (or do something else entirely) as the demo's status changes
  1359. * - Removed LED commands from the CDC bootloader, unused by most AVR910 programming software
  1360. * - Fixed RNDIS demo ICMP ping requests echoing back incorrect data
  1361. * - Added DHCP server code to RNDIS demo, allowing for hands-free auto configuration on any PC
  1362. * - Fixed DFU bootloader PID value for the ATMEGA16U4 AVR
  1363. * - Endpoint and Pipe configuration functions now return an error code indicating success or failure
  1364. * - USB Reset in device mode now resets and disables all device endpoints
  1365. * - Added intermediate states to the host mode state machine, reducing the USB task blocking time to no more than 1ms explicitly per
  1366. * invocation when in host mode
  1367. * - Added support for the ATMEGA32U6 microcontroller
  1368. * - Added STATIC_ENDPOINT_CONFIGURATION compile time option, enabled in the bootloaders to minimize space usage
  1369. * - Removed redundant code from the USB device GetStatus() chapter 9 processing routine
  1370. * - Added new TeensyHID bootloader, compatible with the Teensy HID protocol (http://www.pjrc.com/teensy/)
  1371. * - Versions are now numbered by release dates, rather than arbitrary major/minor revision numbers
  1372. * - USB_RemoteWakeupEnabled is now correctly set and cleared by SetFeature and ClearFeature requests from the host
  1373. * - Changed prototype of GetDescriptor, so that it now returns the descriptor size (or zero if the descriptor doesn't exist)
  1374. * rather than passing the size back to the caller through a parameter and returning a boolean
  1375. *
  1376. *
  1377. * \section Sec_ChangeLog153 Version 1.5.3 (081002)
  1378. *
  1379. * - Fixed CDC bootloader using pgmspace macros for some descriptors inappropriately
  1380. * - Updated all Mouse and Keyboard device demos to include boot protocol support (now works in BIOS)
  1381. * - Renamed bootloader directories to remove spaces, which were causing build problems on several OSes
  1382. * - Removed serial number strings from all but the MassStore demo where it is required - users were not
  1383. * modifying the code to either omit the descriptor or use a unique serial per device causing problems
  1384. * when multiple units of the same device were plugged in at the same time
  1385. * - AudioOutput and AudioInput demos now correctly silence endpoints when not enabled by the host
  1386. * - Added KeyboardMouse demo (Keyboard and Mouse functionality combined into a single demo)
  1387. * - Added DriverStubs directory to house board level driver templates, to make MyUSB compatible custom board
  1388. * driver creation easier
  1389. * - Extended MassStorage demo to support multiple LUNs, 2 by default
  1390. * - Fixed incorrect device address mask, preventing the device from enumerating with addresses larger than 63
  1391. * - Fixed incorrect data direction mask in the GetStatus standard request, preventing it from being handled
  1392. * - Fixed incorrect GetStatus standard request for endpoints, now returns the endpoint STALL status correctly
  1393. * - Added in new USB_RemoteWakeupEnabled and USB_CurrentlySelfPowered flags rather than using fixed values
  1394. * - Added DualCDC demo to demonstrate the use of Interface Association Descriptors
  1395. * - Added pipe NAK detection and clearing API
  1396. * - Added pipe status change (NAK, STALL, etc.) interrupt API
  1397. * - Fixed MassStorageHost demo so that it no longer freezes randomly when issuing several commands in a row
  1398. * - Host demos configuration descriptor routines now return a unique error code when the returned data does
  1399. * not have a valid configuration descriptor header
  1400. * - Added Endpoint_WaitUntilReady() and Pipe_WaitUntilReady() functions
  1401. * - Stream functions now have software timeouts, timeout period can be set by the USB_STREAM_TIMEOUT_MS token
  1402. * - All demos now pass the USB.org automated Chapter 9 device compliance tests
  1403. * - All HID demos now pass the USB.org automated HID compliance tests
  1404. * - Polling interval of the interrupt endpoint in the CDC based demos changed to 0xFF to fix problems on Linux systems
  1405. * - Changed stream functions to accept a new callback function, with NO_STREAM_CALLBACKS used to disable all callbacks
  1406. * - Mass Storage demo Dataflash management routines changed to use the endpoint stream functions
  1407. * - Added AVRStudio project files for each demo in addition to the existing Programmer's Notepad master project file
  1408. * - Re-added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
  1409. * are reflected in the hardware (change was previously lost)
  1410. *
  1411. *
  1412. * \section Sec_ChangeLog152 Version 1.5.2 (080731)
  1413. *
  1414. * - Fixed SwapEndian_32() function in Common.h so that it now works correctly (wrong parameter types)
  1415. * - Updated RNDIS demo - notification endpoint is no longer blocking so that it works with faulty Linux RNDIS
  1416. * implementations (where the notification endpoint is ignored in favor of polling the control endpoint)
  1417. * - Fixed incorrect Vendor Description string return size in RNDIS demo for the OID_GEN_VENDOR_DESCRIPTION OID token
  1418. * - Added very basic TCP/IP stack and HTTP/TELNET servers to RNDIS demo
  1419. * - Fixed DFU bootloader exit causing programming software to complain about failed writes
  1420. * - Fixed DFU bootloader EEPROM programming mode wiping first flash page
  1421. * - Fixed Clear/Set Feature device standard request processing code (fixing MassStorage demo in the process)
  1422. * - Added support for the ATMEGA16U4 AVR microcontroller
  1423. * - Library license changed from LGPLv3 to MIT license
  1424. *
  1425. *
  1426. * \section Sec_ChangeLog151 Version 1.5.1 (080707)
  1427. *
  1428. * - Changed host demos to enable the host function task on the firing of the USB_DeviceEnumerationComplete event
  1429. * rather than the USB_DeviceAttached event
  1430. * - HID Usage Stack now forcefully cleared after an IN/OUT/FEATURE item has been completely processed to remove
  1431. * any referenced but not created usages
  1432. * - Changed USB_INT_DisableAllInterrupts() and USB_INT_ClearAllInterrupts(), USB_Host_GetNextDescriptorOfType(),
  1433. * USB_Host_GetNextDescriptorOfTypeBefore(), USB_Host_GetNextDescriptorOfTypeAfter() to normal functions (from inline)
  1434. * - Fixed USBtoSerial demo not sending data, only receiving
  1435. * - Fixed main makefile to make all by default, fixed MagStripe directory case to prevent case-sensitive path problems
  1436. * - ConfigDescriptor functions made normal, instead of static inline
  1437. * - Pipe/Endpoint *_Ignore_* functions changed to *_Discard_*, old names still present as aliases
  1438. * - Fixed ENDPOINT_MAX_SIZE define to be correct on limited USB controller AVRs
  1439. * - Changed endpoint and pipe size translation routines to use previous IF/ELSE IF cascade code, new algorithmic
  1440. * approach was buggy and caused problems
  1441. * - Bootloaders now compile with -fno-inline-small-functions option to reduce code size
  1442. * - Audio demos now use correct endpoint sizes for full and limited controller USB AVRs, double banking in all cases
  1443. * to be in line with the specification (isochronous endpoints MUST be double banked)
  1444. * - Added Interface Association descriptor to StdDescriptors.h, based on the relevant USB2.0 ECN
  1445. * - Fixed MIDI demo, corrected Audio Streaming descriptor to follow the MIDI-specific AS structure
  1446. * - Fixed HID class demo descriptors so that the HID interface's protocol is 0x00 (required for non-boot protocol HID
  1447. * devices) to prevent problems on hosts expecting the boot protocol functions to be supported
  1448. * - Added read/write control stream functions to Endpoint.h
  1449. * - Fixed AudioOut demo not setting port pins to inputs on USB disconnect properly
  1450. * - Added RNDISEthernet demo application
  1451. *
  1452. *
  1453. * \section Sec_ChangeLog150 Version 1.5.0 (080610)
  1454. *
  1455. * - Fixed MIDI demo, now correctly waits for the endpoint to be ready between multiple note messages
  1456. * - Added CDC Host demo application
  1457. * - Added KeyboardFullInt demo application
  1458. * - Endpoint and Pipe creation routines now mask endpoint/pipe size with the size mask, to remove transaction
  1459. * size bits not required for the routines (improves compatibility with devices)
  1460. * - Fixed AudioInput demo - now correctly sends sampled audio to the host PC
  1461. * - Fixed AudioOutput demo once more -- apparently Windows requires endpoint packets to be >=192 bytes
  1462. * - Shrunk round-robin scheduler code slightly via the use of struct pointers rather than array indexes
  1463. * - Fixed off-by-one error when determining if the Usage Stack is full inside the HID Report parser
  1464. * - Renamed Magstripe.h to MagstripeHW.h and moved driver out of the library and into the MagStripe demo folder
  1465. * - Added preprocessor checks to enable C linkage on the library components when used with a C++ compiler
  1466. * - Added Still Image Host demo application
  1467. * - The USB device task now restores the previously selected endpoint, allowing control requests to be transparently
  1468. * handled via interrupts while other endpoints are serviced through polling
  1469. * - Fixed device signature being sent in reverse order in the CDC bootloader
  1470. * - Host demos now have a separate ConfigDescriptor.c/.h file for configuration descriptor processing
  1471. * - HostWithParser demos now have a separate HIDReport.c/.h file for HID report processing and dumping
  1472. * - Removed non-mandatory commands from MassStorage demo to save space, fixed SENSE ResponseCode value
  1473. * - CDC demos now send empty packets after sending a full one to prevent buffering issues on the host
  1474. * - Updated demo descriptors to use VID/PID values donated by Atmel
  1475. * - Added DoxyGen documentation to the source files
  1476. * - Fixed Serial_IsCharReceived() definition, was previously reversed
  1477. * - Removed separate USB_Descriptor_Language_t descriptor, USB_Descriptor_String_t is used instead
  1478. * - Removed unused Device Qualifier descriptor structure
  1479. * - Renamed the USB_CreateEndpoints event to the more appropriate USB_ConfigurationChanged
  1480. * - Fixed MassStorageHost demo reading in the block data in reverse
  1481. * - Removed outdated typedefs in StdRequestType.h, superseded by the macro masks
  1482. * - Corrected OTG.h is now included when the AVR supports both Host and Device modes, for creating OTG products
  1483. * - USB_DeviceEnumerationComplete event is now also fired when in device mode and the host has finished its enumeration
  1484. * - Interrupt driven demos now properly restore previously selected endpoint when ISR is complete
  1485. * - The value of USB_HOST_TIMEOUT_MS can now be overridden in the user project makefile to a custom fixed timeout value
  1486. * - Renamed USB_Host_SOFGeneration_* macros to more friendly USB_Host_SuspendBus(), USB_Host_ResumeBus()
  1487. * and USB_Host_IsBusSuspended()
  1488. * - Renamed *_*_Is* macros to *_Is* to make all flag checking macros consistent, Pipe_SetInterruptFreq() is now
  1489. * Pipe_SetInterruptPeriod() to use the correct terminology
  1490. * - UnicodeString member of USB_Descriptor_String_t struct changed to an ordinary int array type, so that the GCC
  1491. * Unicode strings (prefixed with an L before the opening quotation mark) can be used instead of explicit arrays
  1492. * of ASCII characters
  1493. * - Fixed Endpoint/Pipes being configured incorrectly if the maximum endpoint/pipe size for the selected USB AVR
  1494. * model was given as the bank size
  1495. * - HID device demos now use a true raw array for the HID report descriptor rather than a struct wrapped array
  1496. * - Added VERSION_BCD() macro, fixed reported HID and USB version numbers in demo descriptors
  1497. * - Cleaned up GetDescriptor device chapter 9 handler function
  1498. * - Added GET_REPORT class specific request to HID demos to make them complaint to the HID class
  1499. * - Cleaned up setting of USB_IsInitialized and USB_IsConnected values to only when needed
  1500. * - Removed Atomic.c and ISRMacro.h; the library was already only compatible with recent avr-lib-c for other reasons
  1501. * - All demos and library functions now use USB standardized names for the USB data (bRequest, wLength, etc.)
  1502. * - Added USE_NONSTANDARD_DESCRIPTOR_NAMES token to switch back to the non-standard descriptor element names
  1503. *
  1504. *
  1505. * \section Sec_ChangeLog141 Version 1.4.1 (090519)
  1506. *
  1507. * - Enhanced KeyboardWithParser demo, now prints out pressed alphanumeric characters like the standard demo
  1508. * - Fixed MassStorage demo, read/writes using non mode-10 commands now work correctly
  1509. * - Corrected version number in Version.h
  1510. *
  1511. *
  1512. * \section Sec_ChangeLog140 Version 1.4.0 (090505)
  1513. *
  1514. * - Added HID Report Parser API to the library
  1515. * - Added Mouse and Keyboard host demo applications, using the new HID report parser engine
  1516. * - Added MouseFullInt demo, which demonstrates a fully interrupt (including control requests) mouse device
  1517. * - Fixed incorrect length value in the audio control descriptor of the AudioOutput and AudioInput demos
  1518. * - Added MIDI device demo application to the library
  1519. * - Fixed problem preventing USB devices from being resumed from a suspended state
  1520. * - Added new CDC class bootloader to the library, based on the AVR109 bootloader protocol
  1521. * - Added header to each demo application indicating the mode, class, subclass, standards used and supported speed
  1522. * - Functions expecting endpoint/pipe numbers are no longer automatically masked against ENDPOINT_EPNUM_MASK or
  1523. * PIPE_PIPENUM_MASK - this should be manually added to code which requires it
  1524. * - Fixed DFU class bootloader - corrected frequency of flash page writes, greatly reducing programming time
  1525. * - Renamed AVR_HOST_GetDeviceConfigDescriptor() to USB_Host_GetDeviceConfigDescriptor() and AVR_HOST_GetNextDescriptor()
  1526. * to USB_Host_GetNextDescriptor()
  1527. * - Added new USB_Host_GetNextDescriptorOfTypeBefore() and USB_Host_GetNextDescriptorOfTypeAfter() routines
  1528. * - Moved configuration descriptor routines to MyUSB/Drivers/USB/Class/, new accompanying ConfigDescriptors.c file
  1529. * - Added new configuration descriptor comparator API for more powerful descriptor parsing, updated host demos to use the
  1530. * new comparator API
  1531. * - Fixed MassStorageHost demo capacity printout, and changed data read/write mode from little-endian to the correct
  1532. * big-endian for SCSI devices
  1533. * - Fixed macro/function naming consistency; USB_HOST is now USB_Host, USB_DEV is now USB_Device
  1534. * - Added better error reporting to host demos
  1535. * - Added 10 microsecond delay after addressing devices in host mode, to prevent control stalls
  1536. *
  1537. *
  1538. * \section Sec_ChangeLog132 Version 1.3.2 (080401)
  1539. *
  1540. * - Added call to ReconfigureUSART() in USBtoSerial SetLineCoding request, so that baud rate changes
  1541. * are reflected in the hardware
  1542. * - Fixed CDC and USBtoSerial demos - Stream commands do not work for control endpoints, and the
  1543. * GetLineCoding request had an incorrect RequestType mask preventing it from being processed
  1544. * - Improved reliability of the USBtoSerial demo, adding a busy wait while the buffer is full
  1545. * - Device control endpoint size is now determined from the device's descriptors rather than being fixed
  1546. * - Separated out SPI code into new SPI driver in AT90USBXXX driver directory
  1547. * - Bootloader now returns correct PID for the selected USB AVR model, not just the AT90USB128X PID
  1548. * - Added support for the RZUSBSTICK board
  1549. * - Bicolour driver removed in favor of generic LEDs driver
  1550. * - Added support for the ATMEGA32U4 AVR
  1551. * - Added MANUAL_PLL_CONTROL compile time option to prevent the USB library from manipulating the PLL
  1552. *
  1553. *
  1554. * \section Sec_ChangeLog131 Version 1.3.1 (080319)
  1555. *
  1556. * - Fixed USB to Serial demo - class value in the descriptors was incorrect
  1557. * - Control endpoint size changed from 64 bytes to 8 bytes to save on USB FIFO RAM and to allow low
  1558. * speed mode devices to enumerate properly
  1559. * - USB to Serial demo data endpoints changed to dual-banked 16 byte to allow the demo to work
  1560. * on USB AVRs with limited USB FIFO RAM
  1561. * - Changed demo endpoint numbers to use endpoints 3 and 4 for double banking, to allow limited
  1562. * USB device controller AVRs (AT90USB162, AT90USB82) to function correctly
  1563. * - Updated Audio Out demo to use timer 1 for AVRs lacking a timer 3 for the PWM output
  1564. * - Fixed incorrect USB_DEV_OPT_HIGHSPEED entry in the Mass Storage device demo makefile
  1565. * - Optimized Mass Storage demo for a little extra transfer speed
  1566. * - Added LED indicators to the Keyboard demo for Caps Lock, Num Lock and Scroll Lock
  1567. * - Added Endpoint_Read_Stream, Endpoint_Write_Stream, Pipe_Read_Stream and Pipe_Write_Stream functions
  1568. * (including Big and Little Endian variants)
  1569. * - Made Dataflash functions inline for speed, removed now empty Dataflash.c driver file
  1570. * - Added new SetSystemClockPrescaler() macro (thanks to Joerg Wunsch)
  1571. * - Fixed Endpoint_ClearStall() to function correctly on full USB controller AVRs (AT90USBXXX6/7)
  1572. * - Endpoint_Setup_In_Clear() and Endpoint_Setup_Out_Clear() no longer set FIFOCON, in line with the
  1573. * directives in the datasheet
  1574. * - Fixed PLL prescaler defines for all AVR models and frequencies
  1575. * - Fixed ENDPOINT_INT_IN and ENDPOINT_INT_OUT definitions
  1576. * - Added interrupt driven keyboard and mouse device demos
  1577. * - Combined USB_Device_ClearFeature and USB_Device_SetFeature requests into a single routine for code
  1578. * size savings
  1579. * - Added missing Pipe_GetCurrentPipe() macro to Pipe.h
  1580. *
  1581. *
  1582. * \section Sec_ChangeLog130 Version 1.3.0 (080307)
  1583. *
  1584. * - Unnecessary control endpoint config removed from device mode
  1585. * - Fixed device standard request interpreter accidentally processing some class-specific requests
  1586. * - Added USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS compile time options to instruct the library
  1587. * to use descriptors stored in RAM or EEPROM rather than flash memory
  1588. * - All demos now disable watchdog on startup, in case it has been enabled by fuses or the bootloader
  1589. * - USB_DEV_OPT_LOWSPEED option now works correctly
  1590. * - Added ability to set the USB options statically for a binary size reduction via the USE_STATIC_OPTIONS
  1591. * compile time define
  1592. * - USB_Init no longer takes a Mode parameter if compiled for a USB device with no host mode option, or
  1593. * if forced to a particular mode via the USB_HOST_ONLY or USB_DEVICE_ONLY compile time options
  1594. * - USB_Init no longer takes an Options parameter if options statically configured by USE_STATIC_OPTIONS
  1595. * - Endpoint_Ignore_* and Pipe_Ignore_* made smaller by making the dummy variable non-volatile so that the
  1596. * compiler can throw away the result more efficiently
  1597. * - Added in an optional GroupID value to each scheduler entry, so that groups of tasks can once again be
  1598. * controlled by the new Scheduler_SetGroupTaskMode() routine
  1599. * - Added support for AT90USB162 and AT90USB82 AVR models
  1600. * - Added support for the STK525 and STK526 boards
  1601. * - Added support for custom board drivers to be supplied by selecting the board type as BOARD_USER, and
  1602. * placing board drivers in {Application Directory}/Board/
  1603. * - PLL is now stopped and USB clock is frozen when detached from host in device mode, to save power
  1604. * - Joystick defines are now in sync with the schematics - orientation will be rotated for the USBKEY
  1605. * - Fixed USB_DEV_IsUSBSuspended() - now checks the correct register
  1606. * - Fixed data transfers to devices when in host mode
  1607. * - Renamed USB_DEV_OPT_HIGHSPEED to USB_DEV_OPT_FULLSPEED and USB_HOST_IsDeviceHighSpeed() to
  1608. * USB_HOST_IsDeviceFullSpeed() to be in line with the official USB speed names (to avoid confusion with
  1609. * the real high speed mode, which is unavailable on the USB AVRs)
  1610. *
  1611. *
  1612. * \section Sec_ChangeLog120 Version 1.2.0 (080204)
  1613. *
  1614. * - Added USB_DeviceEnumerationComplete event for host mode
  1615. * - Added new Scheduler_Init routine to prepare the scheduler, so that tasks can be started and
  1616. * stopped before the scheduler has been started (via Scheduler_Start)
  1617. * - Connection events in both Device and Host mode are now interrupt-driven, allowing the USB management
  1618. * task to be stopped when the USB is not connected to a host or device
  1619. * - All demos updated to stop the USB task when not in use via the appropriate USB events
  1620. * - Mass Storage Host demo application updated to function correctly with all USB flash disks
  1621. * - Mass Storage Host demo application now prints out the capacity and number of LUNs in the attached
  1622. * device, and prints the first block as hexadecimal numbers rather than ASCII characters
  1623. * - Endpoint and Pipe clearing routines now clear the Endpoint/Pipe interrupt and status flags
  1624. * - Shifted error handling code in the host enum state machine to a single block, to reduce code complexity
  1625. * - Added in DESCRIPTOR_TYPE, DESCRIPTOR_SIZE and DESCRIPTOR_CAST macros to make config descriptor processing
  1626. * clearer in USB hosts and DESCRIPTOR_ADDRESS for convenience in USB devices
  1627. * - Added in alloca macro to common.h, in case the user is using an old version of avr-lib-c missing the macro
  1628. *
  1629. *
  1630. * \section Sec_ChangeLog110 Version 1.1.0 (080125)
  1631. *
  1632. * - Fixed DCONNI interrupt being enabled accidentally after a USB reset
  1633. * - Fixed DDISCI interrupt not being disabled when a device is not connected
  1634. * - Added workaround for powerless pull-up devices causing false disconnect interrupts
  1635. * - Added USB_DeviceEnumerationFailed event for Host mode
  1636. * - AVR_HOST_GetDeviceConfigDescriptor routine no longer modifies ConfigSizePtr if a valid buffer
  1637. * pointer is passed
  1638. * - Added ALLOCABLE_BYTES to DynAlloc, and added code to make the size of key storage variables
  1639. * dependent on size of memory parameters passed in via the user project's makefile
  1640. * - Fixed incorrect device reset routine being called in USBTask
  1641. * - Devices which do not connect within the standard 300mS are now supported
  1642. * - Removed incorrect ATTR_PURE from Scheduler_SetTaskMode(), which was preventing tasks from being
  1643. * started/stopped, as well as USB_InitTaskPointer(), which was breaking dual device/host USB projects
  1644. * - Changed scheduler to use the task name rather than IDs for setting the task mode, eliminating the
  1645. * need to have a task ID list
  1646. * - ID transition interrupt now raises the appropriate device/host disconnect event if device attached
  1647. * - Fixed double VBUS change (and VBUS -) event when detaching in device mode
  1648. * - Added ability to disable ANSI terminal codes by the defining of DISABLE_TERMINAL_CODES in makefile
  1649. * - Removed return from ConfigurePipe and ConfigureEndpoint functions - use Pipe_IsConfigured() and
  1650. * Endpoint_IsConfigured() after calling the config functions to determine success
  1651. */