Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

MigrationInformation.txt 58KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  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_Migration Migrating from Older Versions
  7. *
  8. * Below is migration information for updating existing projects based on previous versions of the LUFA library
  9. * to the next version released. It does not indicate all new additions to the library in each version change, only
  10. * areas relevant to making older projects compatible with the API changes of each new release.
  11. *
  12. * \section Sec_Migration120730 Migrating from 120219 to 120730
  13. * <b>Device Mode</b>
  14. * - The device mode Audio Class driver now requires an additional configuration parameter, the Audio Control interface index. Existing applications should
  15. * be adjusted to specify the additional configuration parameter.
  16. * - The HID_DESCRIPTOR_JOYSTICK() macro no longer takes a variable number of axis as a parameter, due to OS incompatibilities; this macro now uses a fixed
  17. * 3 axis of data. User applications should update their calls to this macro and their report structures to suit a fixed 3-axis joystick report. If a user
  18. * application requires more than 3 axis' of data, a custom report descriptor will need to be constructed by hand.
  19. * - The \ref Endpoint_ConfigureEndpoint() function no longer takes in masks for the banks and direction; the number of banks is now an integer argument, and
  20. * the direction is obtained from the full endpoint address within the device. Applications calling Endpoint_ConfigureEndpoint() should update their API
  21. * call to use a full endpoint address (including ENDPOINT_DIR_IN or ENDPOINT_DIR_OUT direction in the MSB of the endpoint address) and an integer number
  22. * of banks.
  23. * - All endpoint functions now operate on full endpoint addresses within the device, rather than a directionless endpoint index. Applications should update
  24. * their API calls to use full endpoint addresses when required within the device.
  25. * - All device mode class drivers have been updated to use a new unified endpoint description structure for all endpoints; existing applications will need
  26. * to update their class driver struct instantiation to match the new scheme (see \ref USB_Endpoint_Table_t).
  27. * - The \c ENDPOINT_BANKS_SUPPORTED() and \c ENDPOINT_MAX_ENDPOINT_SIZE() macros have been removed, as these do not function correctly with the new addressing
  28. * scheme for the endpoint APIs. Please refer to the target device's datasheet for the maximum bank size of each endpoint.
  29. * - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined
  30. * into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure
  31. * element name.
  32. *
  33. * <b>Host Mode</b>
  34. * - The Android Accessory Host class driver property strings are now a array of \c char* rather than a struct of named pointers. Existing applications
  35. * should use C99 Designated Initializers with the property string indexes located in \ref AOA_Strings_t instead.
  36. * - The \ref Pipe_ConfigurePipe() function no longer takes in masks for the banks and token; the number of banks is now an integer argument, and the token
  37. * is now inferred from the full pipe address within the device, and the pipe type. Applications calling Pipe_ConfigurePipe() should update their API
  38. * call to use a full pipe address (including PIPE_DIR_IN or PIPE_DIR_OUT direction in the MSB of the pipe address) and an integer number of banks.
  39. * - All pipe functions now operate on full pipe addresses within the device, rather than a directionless pipe index. Applications should update their API
  40. * calls to use full pipe addresses when required within the device.
  41. * - All host mode class drivers have been updated to use a new unified pipe description structure for all pipes; existing applications will need to update
  42. * their class driver struct instantiation to match the new scheme (see \ref USB_Pipe_Table_t).
  43. * - The MIDI class driver \ref MIDI_EventPacket_t event packet no longer contains seperate \c CableIndex and \c Command entries; these have been combined
  44. * into a single \c Event element which can be contructed using the new macro \ref MIDI_EVENT(). Existing applications should use the new macro and structure
  45. * element name.
  46. * - The library "LUFA/Drivers/USB/Core/ConfigDescriptor.c" source file has been renamed "LUFA/Drivers/USB/Core/ConfigDescriptors.c" as this was clashing with
  47. * files in some low level host mode demo applications, preventing parallel project builds. If you are referencing the project source files directly instead
  48. * of using the makefile module names, you will need to adjust your project makefile.
  49. *
  50. * \section Sec_Migration120219 Migrating from 111009 to 120219
  51. * <b>USB Core</b>
  52. * - The HID_KEYBOARD_MODIFER_* macros in the HID class driver have been corrected to HID_KEYBOARD_MODIFIER_* (note the spelling of "modifier").
  53. * Existing applications should switch over to the correctly spelled macro names.
  54. * - The names of the USB Device and USB Host class driver files have changed; a new "ClassDevice" and "ClassHost" postfix has been added to the
  55. * respective class driver files. Projects referencing the class driver source files by filename rather than the LUFA_SRC_USBCLASS makefile
  56. * variable should append these postfixes to the source file names. Projects including the USB class driver dispatch headers directly should either
  57. * switch to including the main USB driver header instead, or use the updated header filenames.
  58. * - The USB_CONFIG_ATTR_BUSPOWERED constant has been renamed to USB_CONFIG_ATTR_RESERVED, as this was misnamed. All devices must set this bit in
  59. * the Configuration descriptor's attributes field. As all devices are assumed to be bus-powered unless stated otherwise with the
  60. * USB_CONFIG_ATTR_SELFPOWERED flag a replacement constant for bus powered devices is not provided.
  61. *
  62. * <b>Device Mode</b>
  63. * - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetInterfaceProperty().
  64. * Existing applications must implement this new callback, however if no audio entities are defined in the audio device's descriptors,
  65. * this function may be hard-coded to always return false for previous behaviour to be retained.
  66. *
  67. * \section Sec_Migration111009 Migrating from 110528 to 111009
  68. * <b>Non-USB Library Components</b>
  69. * - The \c JTAG_DEBUG_ASSERT() macro has been renamed \ref JTAG_ASSERT() to be consistent with \ref STDOUT_ASSERT().
  70. *
  71. * <b>USB Core</b>
  72. * - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of
  73. * reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimize the compiled program
  74. * size, the new \c ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering
  75. * in exchange for a smaller compiled binary size.
  76. * - The previous \c F_CLOCK symbol, required in the project makefile, has been renamed to \c F_USB. This is due to the previous name
  77. * being far too generic for use in future architecture ports, where multiple clock domains are used.
  78. *
  79. * <b>Device Mode</b>
  80. * - The Endpoint stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter.
  81. * This should be set to \c NULL to retain previous behaviour of the functions, or point to a location where the number of bytes
  82. * processed in the current transaction can be stored. If the \c BytesProcessed parameter is non \c NULL, each time the endpoint
  83. * bank becomes full and the packet is sent, the routine will exit with the new \ref ENDPOINT_RWSTREAM_IncompleteTransfer
  84. * error code to allow the user application to determine when to send the next chunk of data.
  85. * - The \ref CDC_Device_SendString() function now expects a null terminated string instead of an explicit length. Existing code
  86. * should use the new \ref CDC_Device_SendData() function, or remove the length parameter from the function call.
  87. * - The \c Endpoint_ResetFIFO() function has been renamed to \ref Endpoint_ResetEndpoint(), to make the API function names more
  88. * consistent. Existing applications using the old function name should simply replace it with a call to the new function name.
  89. * - The \c Endpoint_*_Byte() functions have been renamed Endpoint_*_8() to ensure they are correct across all architectures. Existing
  90. * code using these functions should replace the previous function names with the new function names.
  91. * - The \c Endpoint_*_Word() functions have been renamed Endpoint_*_16() to ensure they are correct across all architectures. Existing
  92. * code using these functions should replace the previous function names with the new function names.
  93. * - The \c Endpoint_*_DWord() functions have been renamed Endpoint_*_32() to ensure they are correct across all architectures. Existing
  94. * code using these functions should replace the previous function names with the new function names.
  95. * - The Device mode RNDIS class driver no longer stores the incoming and outgoing packets in the class driver instance; the user is
  96. * now expected to manually define a storage location for the packet data. Packets must now be sent and received manually via a call
  97. * to \ref RNDIS_Device_ReadPacket() and/or \ref RNDIS_Device_SendPacket().
  98. * - The definition of the Audio class \ref USB_Audio_Descriptor_Format_t has been altered, to remove the fixed singular
  99. * audio sample rate in the descriptor definition, and to rename the \c SampleFrequencyType to the more appropriate
  100. * \c TotalDiscreteSampleRates. Existing applications will need to add an array of \ref USB_Audio_SampleFreq_t elements
  101. * immediately following any \ref USB_Audio_Descriptor_Format_t descriptors, and insert the appropriate sampling rates
  102. * supported by the device, as well as rename the descriptor elements to match the updated element names.
  103. * - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetEndpointProperty().
  104. * Existing applications must implement this new callback, however if multiple sample rates or pitch control is not used,
  105. * this function may be hard-coded to always return false for previous behaviour to be retained.
  106. * - The \c USB_ConfigurationNumber, \c USB_RemoteWakeupEnabled and \c USB_CurrentlySelfPowered globals have been renamed to
  107. * \ref USB_Device_ConfigurationNumber, \ref USB_Device_RemoteWakeupEnabled and \ref USB_Device_CurrentlySelfPowered to clearly indicate
  108. * the USB mode they relate to. Existing applications using these variables should rename all references to the previous names.
  109. * - The \c ENDPOINT_DESCRIPTOR_DIR_IN and \c ENDPOINT_DESCRIPTOR_DIR_OUT macros have now been replaced by \ref ENDPOINT_DIR_IN and
  110. * \ref ENDPOINT_DIR_OUT to improve code clarity.
  111. * - The \ref HID_DESCRIPTOR_JOYSTICK() macro now takes an additional (first) parameter indicating the number of axis in the joystick.
  112. *
  113. * <b>Host Mode</b>
  114. * - The Pipe stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter.
  115. * This should be set to \c NULL to retain previous behaviour of the functions, or point to a location where the number of bytes
  116. * processed in the current transaction can be stored. If the BytesProcessed parameter is non \c NULL, each time the pipe
  117. * bank becomes full and the packet is sent, the routine will exit with the new \ref PIPE_RWSTREAM_IncompleteTransfer
  118. * error code to allow the user application to determine when to send the next chunk of data.
  119. * - The \ref PRNT_Host_SendString() and \ref CDC_Host_SendString() functions now expect a null terminated string instead of an explicit
  120. * length. Existing code should use the new \ref PRNT_Host_SendData() and \ref CDC_Host_SendData() functions, or remove the
  121. * length parameter from the function call.
  122. * - The \c Pipe_ClearErrorFlags() function has been removed, as the pipe error flags are now automatically cleared when the
  123. * \ref Pipe_ClearError() function is called.
  124. * - The \c Pipe_*_Byte() functions have been renamed Pipe_*_8() to ensure they are correct across all architectures. Existing code using
  125. * these functions should replace the previous function names with the new function names.
  126. * - The \c Pipe_*_Word() functions have been renamed Pipe_*_16() to ensure they are correct across all architectures. Existing code using
  127. * these functions should replace the previous function names with the new function names.
  128. * - The \c Pipe_*_DWord() functions have been renamed Pipe_*_32() to ensure they are correct across all architectures. Existing code using
  129. * these functions should replace the previous function names with the new function names.
  130. * - The \c USB_Host_ClearPipeStall() function has been renamed to USB_Host_ClearEndpointStall(), as it operates on a full endpoing address
  131. * within the attached device and not a pipe within the host. Existing code using the old function name should update the function calls and
  132. * check for correct usage.
  133. *
  134. * \section Sec_Migration101122 Migrating from 100807 to 101122
  135. * <b>USB Core</b>
  136. * - A new USB driver source file, \c Drivers/USB/HighLevel/EndpointStream.c now exists. This source file should be added
  137. * to all project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source
  138. * variables.
  139. * - A new USB driver source file, \c Drivers/USB/HighLevel/PipeStream.c now exists. This source file should be added to all
  140. * project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables.
  141. * - The \c EVENT_USB_InitFailure() event has been removed, as the \ref USB_Init() function will no longer fail; if not USB mode is
  142. * specified, the controller will default to UID selection mode.
  143. * - The USB mode specifier constants have been moved into a new enum and renamed. Existing projects should use the equivalent
  144. * value in the new \ref USB_Modes_t enum.
  145. * - All class driver headers are now included as part of the standard \c LUFA/Drivers/USB/USB.h master dispatch header, and should
  146. * no longer be included separately. Class driver module source files must still be added as a separate module in the project's
  147. * makefile if used.
  148. *
  149. * <b>Device Mode</b>
  150. * - Endpoints MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application
  151. * allocated endpoints in ascending order - or if your application uses the USB device mode class drivers, ensure that each instance's
  152. * endpoint indexes are not overlapped with other interface's endpoints.
  153. * - The signature for the \ref CALLBACK_USB_GetDescriptor() callback has changed, the \c void** \c const \c DescriptorAddress parameter is
  154. * now \c const \c void** \c const \c DescriptorAddress. Existing applications should update their callback signatures to match this, and
  155. * eliminate any casting of descriptor pointers to a non \c const pointer.
  156. * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation
  157. * for each class driver for the new class specific descriptor type names.
  158. * - The \c ENDPOINT_DOUBLEBANK_SUPPORTED() macro is has been renamed \c ENDPOINT_BANKS_SUPPORTED() and now returns the total number of
  159. * banks supported by the given endpoint. Existing code should switch to the new naming scheme, and test that the return value of the
  160. * macro is equal to or greater than 2 to regain the previous functionality.
  161. * - The \c EVENT_USB_Device_UnhandledControlRequest() event is now named \ref EVENT_USB_Device_ControlRequest() and fires before (not after)
  162. * the internal library event handlers. Existing code should rename the event handlers in the user application to match the new event
  163. * name, and should ensure that the new execution order does not affect the application's operation.
  164. *
  165. * <b>Host Mode</b>
  166. * - Pipes MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application
  167. * allocated pipes in ascending order - or if your application uses the USB host mode class drivers, ensure that each instance's
  168. * pipe indexes are not overlapped with other interface's pipes.
  169. * - The \c PRNT_Host_SendData() function has been renamed to \ref PRNT_Host_SendString(). Existing applications should simply
  170. * replace all references to the obsolete function name with the new function name.
  171. * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation
  172. * for each class driver for the new class specific descriptor type names.
  173. * - The Still Image Host class' function prefix has been changed from \c SImage_ to \c SI_, to remain consistent with the rest of the
  174. * driver's enums, type defines and constants.
  175. *
  176. * \section Sec_Migration100807 Migrating from 100513 to 100807
  177. *
  178. * <b>Non-USB Library Components</b>
  179. * - The Dataflash board driver stub file has changed, as dataflash functions previously located in the internal
  180. * Dataflash driver of the library have now been moved to the individual board files. Existing drivers can
  181. * copy-paste the new functions from the board Dataflash stub driver.
  182. *
  183. * <b>USB Core</b>
  184. * - A new USB driver source file, \c Drivers/USB/LowLevel/Device.c now exists. This source file should be added to all project
  185. * makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables.
  186. * - The \c Drivers/USB/LowLevel/DevChapter9.c source file has moved to \c Drivers/USB/HighLevel/DeviceStandardReq.c - this should
  187. * be updated in all project makefiles, or the makefile should be updated to use the new module source variables.
  188. * - The \c Drivers/USB/LowLevel/HostChapter9.h source file has moved to \c Drivers/USB/HighLevel/HostStandardReq.c - this should
  189. * be updated in all project makefiles, or the makefile should be updated to use the new module source variables.
  190. * - The \c Drivers/USB/LowLevel/LowLevel.c source file has moved to \c Drivers/LowLevel/USBController.c - this should be updated
  191. * in all project makefiles, or the makefile should be updated to use the new module source variables.
  192. *
  193. * <b>Device Mode</b>
  194. * - The \c USB_Device_IsRemoteWakeupSent() macro has been removed, as the remote wakeup request is now fully handled by the
  195. * enhanced \ref USB_Device_SendRemoteWakeup() function. Existing code may now discard any checks to \c USB_Device_IsRemoteWakeupSent().
  196. * - The \c USB_Device_IsUSBSuspended() macro has been removed, as it is obsolete. Existing code should compare \ref USB_DeviceState
  197. * to see if it the device is in the \ref DEVICE_STATE_Suspended state instead.
  198. * - The \ref CDC_Device_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
  199. * received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact
  200. * number of queued bytes received is not needed.
  201. *
  202. * <b>Host Mode</b>
  203. * - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
  204. * received. This allows for more efficient coding, as a call to \ref CDC_Host_BytesReceived() is no longer needed if the exact
  205. * number of queued bytes received is not needed.
  206. * - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual
  207. * flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask().
  208. *
  209. * \section Sec_Migration100513 Migrating from 100219 to 100513
  210. *
  211. * <b>Non-USB Library Components</b>
  212. * - The \ref TWI_StartTransmission() function now takes in a timeout period, expressed in milliseconds, within which the addressed
  213. * device must respond or the function will abort.
  214. *
  215. * <b>Device Mode</b>
  216. * - The \ref USB_Init() function no longer calls \c sei() to enable global interrupts, as the user application may need
  217. * to perform other initialization before it is ready to handle global interrupts. The user application is now responsible
  218. * for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process
  219. * functions correctly.
  220. * - The \c USBInterrupt.c USB driver source file has been relocated from \c LUFA/Drivers/USB/HighLevel/ to \c LUFA/Drivers/USB/LowLevel.
  221. * Projects must update their makefile SRC values accordingly.
  222. * - The HID Device Class driver's function signature for the \ref CALLBACK_HID_Device_ProcessHIDReport() function has been changed, to
  223. * allow for a new \c ReportType parameter. This new parameter must be added in all user applications using the Device mode HID Class
  224. * Driver, but may be ignored unless Host-to-Device FEATURE HID reports are used.
  225. *
  226. * <b>Host Mode</b>
  227. * - The \ref USB_Init() function no longer calls \c sei() to enable global interrupts, as the user application may need
  228. * to perform other initialization before it is ready to handle global interrupts. The user application is now responsible
  229. * for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process
  230. * functions correctly.
  231. * - The \c USBInterrupt.c USB driver source file has been relocated from \c LUFA/Drivers/USB/HighLevel/ to \c LUFA/Drivers/USB/LowLevel.
  232. * Projects must update their makefile \c SRC values accordingly.
  233. * - The HID Host Class driver's function signature for the \ref HID_Host_SendReportByID() function has been changed, to allow for a new
  234. * ReportType parameter. Existing calls to this function should substitute \c REPORT_ITEM_TYPE_Out as this parameter's value.
  235. *
  236. * \section Sec_Migration100219 Migrating from 091223 to 100219
  237. *
  238. * <b>Non-USB Library Components</b>
  239. * - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models,
  240. * the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used
  241. * when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function
  242. * is an exception, and should always be called with a channel number rather than a channel mask.
  243. *
  244. * <b>Host Mode</b>
  245. * - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
  246. * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
  247. * pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
  248. * flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().
  249. * - The \ref Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address
  250. * is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint
  251. * address against the \ref PIPE_EPNUM_MASK token before calling \ref Pipe_IsEndpointBound().
  252. *
  253. * <b>Device Mode</b>
  254. * - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
  255. * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
  256. * endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
  257. * flush the queued event(s) to the host by calling \ref MIDI_Device_Flush().
  258. *
  259. * \section Sec_Migration091223 Migrating from 091122 to 091223
  260. *
  261. * <b>Host Mode</b>
  262. * - The Still Image Host Class driver \ref SI_Host_USBTask() and \ref SI_Host_ConfigurePipes() functions were misnamed, and are
  263. * now named \c SImage_Host_USBTask() and \c SImage_Host_ConfigurePipes() respectively.
  264. * - The \c HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to \ref HOST_SENDCONTROL_DeviceDisconnected to be in
  265. * line with the rest of the library error codes.
  266. * - The HID Parser item usages no longer contain separate minimum and maximum values, as this was a violation of the HID
  267. * specification. Instead, the values are distributed evenly across each item as its usage value, to ensure that all items
  268. * can be distinguished from one-another.
  269. *
  270. * <b>Device Mode</b>
  271. * - The \ref CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new \c ReportType parameter to
  272. * indicate the report type to generate. Existing applications may simply add and ignore this additional parameter.
  273. *
  274. * \section Sec_Migration091122 Migrating from 090924 to 091122
  275. *
  276. * <b>Host Mode</b>
  277. * - The \c HID_PARSE_UsageStackOverflow HID parser error constant is now named \ref HID_PARSE_UsageListOverflow
  278. * - The \ref CALLBACK_HIDParser_FilterHIDReportItem() HID Parser callback now passes a complete \ref HID_ReportItem_t to the
  279. * user application, instead of just its attributes.
  280. * - The \c USB_GetDeviceConfigDescriptor() function was incorrectly named and is now called \ref USB_Host_GetDeviceConfigDescriptor().
  281. *
  282. * \section Sec_Migration090924 Migrating from 090810 to 090924
  283. *
  284. * <b>Non-USB Library Components</b>
  285. * - The \c ADC_Off() function has been renamed to \c ADC_ShutDown() to be consistent with the rest of the library.
  286. * - The \ref SPI_Init() routine's parameters have changed, so that the clock polarity and data sampling modes can be set. See
  287. * the \ref SPI_Init() function documentation for more details
  288. * - The \ref Dataflash_Init() routine no longer initializes the SPI bus - the SPI bus should be initialized manually via a
  289. * call to \ref SPI_Init() before using the Dataflash driver
  290. *
  291. * <b>Host Mode</b>
  292. * - The \c USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to
  293. * preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single
  294. * call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user
  295. * application perform these intermediary steps.
  296. * - The HID report parser now requires a mandatory callback in the user code, to filter only the items the application
  297. * is interested in into the processed HID report item structure to save RAM. See \ref CALLBACK_HIDParser_FilterHIDReportItem().
  298. * - The HID report parser now always parses FEATURE and always ignores constant-data items - the \c HID_ENABLE_FEATURE_PROCESSING
  299. * and \c HID_INCLUDE_CONSTANT_DATA_ITEMS compile time tokens now have no effect.
  300. * - The \c USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate \c USB_Descriptor_*
  301. * and \c USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
  302. * the one project. For existing projects using the standardized names, change all code to use the \c USB_StdDescriptor_* variants.
  303. *
  304. * <b>Device Mode</b>
  305. * - The \c USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate \c USB_Descriptor_*
  306. * and \c USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
  307. * the one project. For existing projects using the standardized names, change all code to use the \c USB_StdDescriptor_* variants.
  308. *
  309. * \section Sec_Migration090810 Migrating from 090605 to 090810
  310. *
  311. * <b>All</b>
  312. * - The "Simple Scheduler" has been <i>deprecated</i>, as it was little more than an abstracted loop and caused much confusion.
  313. * User applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future
  314. * release.
  315. * - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never
  316. * used in user applications.
  317. *
  318. * <b>Non-USB Library Components</b>
  319. * - The \c ATTR_NOINLINE function attribute macro has been renamed to \ref ATTR_NO_INLINE to be in line with the rest of the function attribute
  320. * macro names.
  321. *
  322. * <b>Library Demos</b>
  323. * - Most demos now have a corresponding Class Driver implementation, which uses the new internal library class drivers for the standard
  324. * USB classes. This allows for more rapid device and host development, and so should be used in preference to the low level APIs where
  325. * possible so that fixes to the class drivers propagate to all applications which use them automatically with each new LUFA release.
  326. *
  327. * <b>Host Mode</b>
  328. * - The \c HIDParser.c module has moved from \c LUFA/Drivers/USB/Class/ to \c LUFA/Drivers/USB/Class/Host/.
  329. * - The \c USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first
  330. * parameter, to add support for multi-configuration devices. Existing code should use a configuration index of 1 to indicate the
  331. * first configuration descriptor within the device.
  332. * - The non-standard "Ready" host state has been removed. Existing \ref HOST_STATE_Configured code should be moved to the end of
  333. * the existing \ref HOST_STATE_Addressed state, and the existing HOST_STATE_Ready state code should be moved to the \ref HOST_STATE_Configured
  334. * state.
  335. * - The \c USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_HostState explicitly to ensure the host is
  336. * in the desired state instead.
  337. * - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode
  338. * events. See the \ref Group_Events page for details on the new event names and firing conditions.
  339. *
  340. * <b>Device Mode</b>
  341. * - The \ref CALLBACK_USB_GetDescriptor() function now takes an extra parameter to specify the descriptor's memory space so that
  342. * descriptors in mixed memory spaces can be used. The previous functionality can be returned by defining the \c USE_FLASH_DESCRIPTORS
  343. * token in the project makefile to fix all descriptors into FLASH space and remove the extra function parameter.
  344. * - The \c USB_IsSuspended global has been removed - test \ref USB_DeviceState against \ref DEVICE_STATE_Suspended instead.
  345. * - The \c USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_DeviceState explicitly to ensure the device
  346. * is in the desired state instead.
  347. * - The VBUS events have been removed, as they are already exposed to the user via the \c USB_Connect and \c USB_Disconnect events.
  348. * - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode
  349. * events. See the \ref Group_Events page for details on the new event names and firing conditions.
  350. *
  351. * \section Sec_Migration090605 Migrating from 090510 to 090605
  352. *
  353. * <b>Device Mode</b>
  354. * - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing
  355. * projects using interrupts on non-control endpoints should switch to polling. For control interrupts, the library can
  356. * manage the control endpoint via interrupts automatically by compiling with the \c INTERRUPT_CONTROL_ENDPOINT token defined.
  357. * - The \c DESCRIPTOR_ADDRESS() macro has been removed. User applications should use normal casts to obtain a descriptor's memory
  358. * address.
  359. * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
  360. * \ref Group_Events for new API details.
  361. * - The \c STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
  362. * function signatures of a function accepting no arguments and returning a \c uint8_t value.
  363. * - The \c Event_DeviceError() event no longer exists, as its sole caller (unlinked \c USB_GetDescriptor() function) now produces a
  364. * compilation error rather than a runtime error. The \c StdDescriptors.c file no longer exists as a result, and should be removed
  365. * from project makefiles.
  366. * - The \c USB_GetDescriptor() function has been renamed to \ref CALLBACK_USB_GetDescriptor() to be in line with the new \c CALLBACK_
  367. * function prefixes for functions which <i>must</i> be implemented in the user application.
  368. *
  369. * <b>Host Mode</b>
  370. * - Support for non-control data pipe interrupts has been dropped due to many issues in the implementation. All existing
  371. * projects using interrupts on non-control pipes should switch to polling.
  372. * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
  373. * \ref Group_Events for new API details.
  374. * - The \c STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
  375. * function signatures of a function accepting no arguments and returning a \c uint8_t value.
  376. * - The \c DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with
  377. * regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a \c uint8_t value.
  378. *
  379. * \section Sec_Migration090510 Migrating from 090401 to 090510
  380. *
  381. * <b>All</b>
  382. * - The \c ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all
  383. * \c BUTTLOADTAG() elements, or download and extract \c ButtLoadTag.h header from the ButtLoad project.
  384. * - The \c Drivers/AT90USBXXX/ directory has been renamed to \c Drivers/Peripheral/.
  385. * - The \c Serial_Stream driver has been renamed to \c SerialStream to remain consistent with the rest of the library naming scheme.
  386. * - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API.
  387. *
  388. * <b>Dual Role Mode</b>
  389. * - The \c USB_PowerOnFail event has been renamed to \c USB_InitFailure.
  390. * - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more
  391. * details.
  392. *
  393. * <b>Device Mode</b>
  394. * - The \c Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the \ref Endpoint_ClearIN(), \ref Endpoint_ClearOUT()
  395. * macros. See \c Endpoint.h documentation for more details on the new endpoint management macros.
  396. * - The \c Endpoint_ReadWriteAllowed() macro has been renamed to \ref Endpoint_IsReadWriteAllowed() to be more consistent with the rest of
  397. * the API naming scheme.
  398. * - The \c Endpoint_IsSetupINReady() and \c Endpoint_IsSetupOUTReceived() macros have been renamed to \ref Endpoint_IsINReady() and
  399. * \ref Endpoint_IsOUTReceived() respectively.
  400. * - The \c Endpoint_IsSetupReceived() macro has been renamed to \ref Endpoint_IsSETUPReceived().
  401. * - The \c Endpoint_ClearSetupReceived() macro has been renamed to \ref Endpoint_ClearSETUP().
  402. * - All endpoint read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Endpoint_Read_Word()) have
  403. * been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions.
  404. * - The \c USB_UnhandledControlPacket event no longer has any parameters. User code should no longer attempt to read in the remainder of
  405. * the Control Request header as all Control Request header data is now preloaded by the library and made available in the
  406. * USB_ControlRequest structure.
  407. * - The \c FEATURELESS_CONTROL_ONLY_DEVICE token has been renamed to \c CONTROL_ONLY_DEVICE.
  408. * - The \c STATIC_ENDPOINT_CONFIGURATION is no longer applicable as the library will apply this optimization when appropriate automatically.
  409. * - The values of the \ref Endpoint_Stream_RW_ErrorCodes_t and \ref Endpoint_ControlStream_RW_ErrorCodes_t enums have had the \c ERROR_ portion
  410. * of their names removed.
  411. *
  412. * <b>Host Mode</b>
  413. * - The \ref USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on
  414. * other control type pipes. Care should be taken to ensure that the Control pipe is always selected before the function is called
  415. * in existing projects where the Control pipe is to be operated on.
  416. * - The USB Host management task now saves and restores the currently selected pipe before and after the task runs. Projects no longer
  417. * need to manage this manually when calling the USB management task.
  418. * - The \c Pipe_ClearCurrentBank() macro has been removed, and is now replaced with the Pipe_ClearIN(), Pipe_ClearOUT() macros. See
  419. * Pipe.h documentation for more details on the new pipe management macros.
  420. * - The \c Pipe_ReadWriteAllowed() macro has been renamed to \ref Pipe_IsReadWriteAllowed() to be more consistent with the rest of the API
  421. * naming scheme.
  422. * - The \c Pipe_IsSetupINReceived() and \c Pipe_IsOutReady() macros have been renamed to \ref Pipe_IsINReceived() and \ref Pipe_IsOUTReady()
  423. * respectively.
  424. * - The new \ref Pipe_ClearSETUP() macro should be used to send SETUP transactions, rather than the previous \c Pipe_ClearSetupOUT() macro.
  425. * - The \c Pipe_IsSetupSent() macro has been renamed to \ref Pipe_IsSETUPSent().
  426. * - The \c Pipe_ClearSetupSent() macro is no longer applicable and should be removed.
  427. * - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as \c Pipe_Read_Word()) have
  428. * been removed for clarity. Existing projects should use the \c _LE suffix on such calls to use the explicit Little Endian versions.
  429. * - The \c Host_IsResetBusDone() macro has been renamed to \c Host_IsBusResetComplete().
  430. * - The \c Pipe_Ignore_Word() and \c Pipe_Ignore_DWord() functions have been renamed to \c Pipe_Discard_Word() and \c Pipe_Discard_DWord()
  431. * to remain consistent with the rest of the pipe API.
  432. * - It is no longer needed to manually include the headers from \c LUFA/Drivers/USB/Class, as they are now included along with the rest
  433. * of the USB headers when \c LUFA/Drivers/USB/USB.h is included.
  434. * - Functions in the \c ConfigDescriptor.h header file no longer have \c Host_ as part of their names.
  435. * - The \c ProcessHIDReport() has been renamed to \ref USB_ProcessHIDReport(), \c GetReportItemInfo() has been renamed to \ref USB_GetHIDReportItemInfo()
  436. * and \c SetReportItemInfo() has been renamed to \ref USB_GetHIDReportItemInfo().
  437. * - The values of the \ref DSearch_Return_ErrorCodes_t and \ref DSearch_Comp_Return_ErrorCodes_t enums have had their respective \c Descriptor_Search
  438. * and \c Descriptor_Search_Comp prefixes changed to all caps.
  439. * - The \c USB_HostRequest global has been renamed to \ref USB_ControlRequest, and is used in Device mode also. The \c USB_Host_Request_Header_t
  440. * structure type has been renamed to \ref USB_Request_Header_t.
  441. * - The values of the \ref Pipe_Stream_RW_ErrorCodes_t enum have had the \c ERROR_ portion of their names removed.
  442. *
  443. * \section Sec_Migration090401 Migrating from 090209 to 090401
  444. *
  445. * <b>All</b>
  446. * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant \c F_USB,
  447. * defined in the project makefile and passed to the compiler via the -D switch.
  448. * - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the
  449. * EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called.
  450. * - As the avr-libc macro has been corrected in recent avr-libc distributions, the \c SetSystemClockPrescaler() macro has been removed.
  451. * Include \c <avr/power.h> and call \c clock_prescale_set(clock_div_1); instead on recent avr-libc distributions.
  452. *
  453. * <b>Library Demos</b>
  454. * - The USBtoSerial demo now discards all data when not connected to a host, rather than buffering it for later transmission.
  455. *
  456. * <b>Non-USB Library Components</b>
  457. * - The \c ATTR_ALWAYSINLINE function attribute macro has been renamed to \ref ATTR_ALWAYS_INLINE.
  458. * - Custom board Dataflash drivers now require the implementation of \ref Dataflash_SelectChipFromPage() and \ref Dataflash_SendAddressBytes().
  459. *
  460. * <b>Device Mode</b>
  461. * - The \c NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to \c FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
  462. * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the
  463. * \c NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the \c FEATURELESS_CONTROL_ONLY_DEVICE token with no further
  464. * modifications required.
  465. *
  466. * \section Sec_Migration090209 Migrating from 081217 to 090209
  467. *
  468. * <b>Device Mode</b>
  469. * - The \c ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of \c ENDPOINT_TOTAL_ENDPOINTS.
  470. * - The \c USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
  471. * makefile if desired to restore the previous 50ms timeout.
  472. *
  473. * <b>Host Mode</b>
  474. * - The \c PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of \c PIPE_TOTAL_ENDPOINTS.
  475. * - The \c USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
  476. * makefile if desired to restore the previous 50ms timeout.
  477. * - The \c USB_DeviceEnumerationFailed event now contains a second \c SubErrorCode parameter, giving the error code of the function
  478. * which failed.
  479. * - The \c HID_PARSE_Sucessful enum member constant name has been corrected to \ref HID_PARSE_Successful.
  480. *
  481. * <b>Non-USB Library Components</b>
  482. * - The previous \c SPI_SendByte() functionality is now located in \ref SPI_TransferByte(). \ref SPI_SendByte() now discards the return byte
  483. * for speed, to compliment the new \ref SPI_ReceiveByte() function. If bidirectional SPI transfers are required, calls to \ref SPI_SendByte()
  484. * should be changed to \ref SPI_TransferByte().
  485. * - The serial driver now sets the Tx line as an output explicitly, and enables the pull-up of the Rx line.
  486. * - The \ref Serial_Init() and \c SerialStream_Init() functions now take a second \c DoubleSpeed parameter, which indicates if the USART
  487. * should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at the given AVR
  488. * clock speed.
  489. *
  490. * \section Sec_Migration171208 Migrating from V1.5.3 to 081217
  491. *
  492. * <b>All</b>
  493. * - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names,
  494. * have been changed to LUFA.
  495. *
  496. * <b>Library Demos</b>
  497. * - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding
  498. * parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version.
  499. * - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and
  500. * KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects
  501. * built on either "WithParser" demo should update to the latest code.
  502. * - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not
  503. * recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes,
  504. * as it is neither a full nor a standards compliant implementation.
  505. *
  506. * <b>Non-USB Library Components</b>
  507. * - The Serial_IsCharReceived() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
  508. *
  509. * <b>Device Mode</b>
  510. * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
  511. * to be used in the Options parameter of the USB_Init() function.
  512. * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
  513. * currently initialized.
  514. * - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library
  515. * or user request processing code to exceed the strict USB timing requirements on control transfers.
  516. * - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured
  517. * after a Reset event, it should be altered to explicitly re-initialize all user endpoints.
  518. * - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now
  519. * returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified
  520. * descriptor does not exist.
  521. * - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the
  522. * GetDescriptor function.
  523. *
  524. * <b>Host Mode</b>
  525. * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
  526. * to be used in the Options parameter of the USB_Init() function.
  527. * - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and
  528. * SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the
  529. * current report. If sending a report to a multi-report device, the first byte of the report is automatically
  530. * set to the report ID of the given report item.
  531. * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
  532. * currently initialized.
  533. *
  534. * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3
  535. *
  536. * <b>Library Demos</b>
  537. * - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number
  538. * string is required in Mass Storage devices, or devices which are to retain settings when moved between
  539. * ports on a machine. As people were not changing the serial number value, this was causing conflicts and so
  540. * the serial number descriptor has been removed from all but the Mass Storage demo, which requires it.
  541. * - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated
  542. * them. Projects built upon either demo should upgrade to the latest code.
  543. * - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented.
  544. * - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built
  545. * on the MassStoreDemo code should update to the latest version.
  546. * - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused
  547. * problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade
  548. * to the latest code.
  549. * - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects
  550. * built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code.
  551. * - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should
  552. * upgrade to the latest code.
  553. * - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was
  554. * previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update
  555. * to the latest code.
  556. *
  557. * <b>Device Mode</b>
  558. * - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream.
  559. * If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The
  560. * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
  561. * timeout duration in ms.
  562. * - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled
  563. * and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and
  564. * USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details.
  565. * - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated
  566. * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
  567. * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
  568. *
  569. * <b>Host Mode</b>
  570. * - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream.
  571. * If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The
  572. * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
  573. * timeout duration in ms.
  574. * - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures.
  575. * - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated
  576. * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
  577. * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
  578. *
  579. * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2
  580. *
  581. * <b>Library Demos</b>
  582. * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
  583. * of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
  584. * to the latest code.
  585. * - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
  586. * possible any existing devices upgrade to the latest bootloader code.
  587. *
  588. * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1
  589. *
  590. * <b>Library Demos</b>
  591. * - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the
  592. * global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo
  593. * should upgrade to the latest code.
  594. * - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID
  595. * demos should upgrade to the latest code.
  596. * - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors.
  597. * Projects built upon the HID demos should upgrade to the latest code.
  598. * - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo
  599. * should upgrade to the latest code.
  600. * - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power.
  601. * Projects built upon the AudioOut demo should upgrade to the latest code.
  602. *
  603. * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0
  604. *
  605. * <b>Library Demos</b>
  606. * - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To
  607. * avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing
  608. * projects should at least manually correct the BCD version numbers, or preferably update the descriptors to
  609. * encode the version number in BCD format using the new macro.
  610. * - The mandatory GetReport class-specific request was accidentally omitted from previous versions of the demos
  611. * based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the
  612. * HID demos should also be updated accordingly.
  613. * - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission.
  614. * Failure to do this on projects which always or frequently send full packets will cause buffering issues on
  615. * the host OS. All CDC user projects are advised to update their transmission routines in the same manner as
  616. * the library CDC demos.
  617. * - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected
  618. * Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven
  619. * demos should also update to properly save and restore the selected Endpoint/Pipe.
  620. *
  621. * <b>Non-USB Library Components</b>
  622. * - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only
  623. * compatible with avr-libc library versions newer than the time before the functionality of the deleted
  624. * headers was available.
  625. *
  626. * <b>Device Mode</b>
  627. * - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and
  628. * functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API.
  629. * The previously split Type and Index parameters are now passed as the original wValue parameter to the
  630. * function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the
  631. * previous Index parameter.
  632. * - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the
  633. * official USB specification. Existing code will need to be altered to use the new parameter names.
  634. * - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more
  635. * appropriate. It fires in an identical manner to the previously named event, thus the only change to be made
  636. * is the event name itself in the user project.
  637. * - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a
  638. * pseudo-descriptor modeled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type
  639. * descriptor as indicated in the USB specification, thus all device code must be updated accordingly.
  640. * - The names of several Endpoint macros have been changed to be more consistent with the rest of the library,
  641. * with no implementation changes. This means that existing code can be altered to use the new macro names
  642. * with no other considerations required. See Endpoint.h for the new macro names.
  643. * - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t
  644. * structure named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this
  645. * demo should correct the structure value to maintain compatibility across multiple OS platforms.
  646. * - By default, the descriptor structures use the official USB specification names for the elements. Previous
  647. * versions of the library used non-standard (but more verbose) names, which are still usable in the current
  648. * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
  649. * documentation for more details.
  650. *
  651. * <b>Host Mode</b>
  652. * - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its
  653. * members renamed to the official USB specification names for requests. Existing code will need to be updated
  654. * to use the new names.
  655. * - The names of several Pipe macros have been changed to be more consistent with the rest of the library,
  656. * with no implementation changes. This means that existing code can be altered to use the new macro names
  657. * with no other considerations required. See Pipe.h for the new macro names.
  658. * - By default, the descriptor structures use the official USB specification names for the elements. Previous
  659. * versions of the library used non-standard (but more verbose) names, which are still usable in the current
  660. * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
  661. * documentation for more details.
  662. * - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h
  663. * module documentation for the new macro names.
  664. *
  665. * <b>Dual Role Mode</b>
  666. * - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing
  667. * projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG
  668. * header inside the library.
  669. * - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has
  670. * finished enumerating the device. Projects relying on the event only firing in Host mode should be updated
  671. * so that the event action only occurs when the USB_Mode global is set to USB_MODE_HOST.
  672. */