X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/a504a3a010ec2441dda0209f195492fb36e7c97b..d47df1cd3a340306255b26a7112d7ff7fa6cd4e4:/LUFA/MigrationInformation.txt

diff --git a/LUFA/MigrationInformation.txt b/LUFA/MigrationInformation.txt
index f3c3a6fa4..cbf5b936d 100644
--- a/LUFA/MigrationInformation.txt
+++ b/LUFA/MigrationInformation.txt
@@ -10,13 +10,51 @@
  *  to the next version released. It does not indicate all new additions to the library in each version change, only
  *  areas relevant to making older projects compatible with the API changes of each new release.
  *
- * \section Sec_MigrationXXXXXX Migrating from 090401 to XXXXXX
+ * \section Sec_Migration090605 Migrating from 090510 to 090605
+ *
+ *
+ * \section Sec_Migration090605 Migrating from 090510 to 090605
+ *
+ *  <b>Device Mode</b>
+ *    - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing
+ *      projects using interrupts on non-control endpoints should switch to polling. For control interrupts, the library can
+ *      manage the control endpoint via interrupts automatically by compiling with the INTERRUPT_CONTROL_ENDPOINT token defined.
+ *    - The DESCRIPTOR_ADDRESS() macro has been removed. User applications should use normal casts to obtain a descriptor's memory
+ *      address.
+ *    - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
+ *      \ref Group_Events for new API details.
+ *    - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
+ *      function signatures of a function accepting no arguments and returning a uint8_t value.
+ *    - The Event_DeviceError() event no longer exists, as its sole caller (unlinked USB_GetDescriptor() function) now produces a
+ *      compilation error rather than a runtime error. The StdDescriptors.c file no longer exists as a result, and should be removed
+ *      from project makefiles.
+ *    - The USB_GetDescriptor() function has been renamed to CALLBACK_USB_GetDescriptor() to be in line with the new CALLBACK_ function
+ *      prefixes for functions which *must* be implemented in the user application.
+ *
+ *  <b>Host Mode</b>
+ *    - Support for non-control data pipe interrupts has been dropped due to many issues in the implementation. All existing
+ *      projects using interrupts on non-control pipes should switch to polling.
+ *    - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
+ *      \ref Group_Events for new API details.
+ *    - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
+ *      function signatures of a function accepting no arguments and returning a uint8_t value.
+ *    - The DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with
+ *      regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a uint8_t value.
+ *
+ *
+ * \section Sec_Migration090510 Migrating from 090401 to 090510
  *
  *  <b>All</b>
  *    - The ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all
  *      BUTTLOADTAG elements, or download and extract ButtLoadTag.h header from the ButtLoad project.
  *    - The Drivers/AT90USBXXX directory has been renamed to Drivers/Peripheral.
  *    - The Serial_Stream driver has been renamed to SerialStream to remain consistent with the rest of the library naming scheme.
+ *    - The HWB driver has changed to the Buttons driver. See the board Buttons driver documentation for the new API.
+ *
+ *  <b>Dual Role Mode</b>
+ *    - The USB_PowerOnFail even has been renamed to USB_InitFailure.
+ *    - The functions in OTG.h have been renamed to remain more consistent with the library API. See the functions in OTG.h for more
+ *      details.
  *
  *  <b>Library Demos</b>
  *    - Most demos, bootloaders and applications have had significant changes from previous versions. Applications built off of any
@@ -38,6 +76,8 @@
  *      USB_ControlRequest structure.
  *    - The FEATURELESS_CONTROL_ONLY_DEVICE token has been renamed to CONTROL_ONLY_DEVICE.
  *    - The STATIC_ENDPOINT_CONFIGURATION is no longer applicable as the library will apply this optimization when appropriate automatically.
+ *    - The values of the Endpoint_Stream_RW_ErrorCodes_t and Endpoint_ControlStream_RW_ErrorCodes_t enums have had the "ERROR_" portion
+ *      of their names removed.
  *
  *  <b>Host Mode</b>
  *    - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on
@@ -68,6 +108,8 @@
  *      and "Descriptor_Search_Comp" prefixes changed to all caps.
  *    - The USB_HostRequest global has been renamed to USB_ControlRequest, and is used in Device mode also. The USB_Host_Request_Header_t
  *      structure type has been renamed to USB_Request_Header_t.
+ *    - The values of the Pipe_Stream_RW_ErrorCodes_t enum have had the "ERROR_" portion of their names removed.
+ *
  *
  * \section Sec_Migration090401 Migrating from 090209 to 090401
  *