Fixed random enumeration failure while in device mode due to interrupts causing the...

[pub/lufa.git] / LUFA / ManPages / MigrationInformation.txt

diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index 40fb70a..6faa65a 100644 (file)
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -10,18 +10,36 @@
  *  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 XXXXXX to XXXXXX
+ * \section Sec_MigrationXXXXXX Migrating from 100807 to XXXXXX
  *  <b>USB Core</b>
  *    - A new USB driver source file, Drivers/USB/HighLevel/EndpointStream.c now exists. This source file should be added
  *      to all project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source
  *      variables.
  *    - A new USB driver source file, Drivers/USB/HighLevel/PipeStream.c now exists. This source file should be added to all
  *      project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables.
+ *    - The EVENT_USB_InitFailure() event has been removed, as the USB_Init() function will no longer fail; if not USB mode is
+ *      specified, the controller will default to UID selection mode.
  *
  *  <b>Device Mode</b>
+ *    - Endpoints MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application
+ *      allocated endpoints in ascending order - or if your application uses the USB device mode class drivers, ensure that each instance's
+ *      endpoint indexes are not overlapped with other interface's endpoints.
  *    - The signature for the CALLBACK_USB_GetDescriptor() callback has changed, the "void** const DescriptorAddress" parameter is
  *      now "const void** const DescriptorAddress". Existing applications should update their callback signatures to match this, and
  *      eliminate any casting of descriptor pointers to a non-const pointer.
+ *    - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation
+ *      for each class driver for the new class specific descriptor type names.
+ *
+ *  <b>Host Mode</b>
+ *    - Pipes MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application
+ *      allocated pipes in ascending order - or if your application uses the USB host mode class drivers, ensure that each instance's
+ *      pipe indexes are not overlapped with other interface's pipes.
+ *    - The PRNT_Host_SendData() function has been renamed to \ref PRNT_Host_SendString(). Existing applications should simply
+ *      replace all references to the obsolete function name with the new function name.
+ *    - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation
+ *      for each class driver for the new class specific descriptor type names.
+ *    - The Still Image Host class' function prefix has been changed from "SImage_" to "SI_", to remain consistent with the rest of the
+ *      driver's enums, type defines and constants.
  *
  * \section Sec_Migration100807 Migrating from 100513 to 100807
  *
@@ -110,7 +128,7 @@
  *
  *  <b>Host Mode</b>
  *    - The Still Image Host Class driver SI_Host_USBTask() and SI_Host_ConfigurePipes() functions were misnamed, and are
- *      now named \ref SImage_Host_USBTask() and \ref SImage_Host_ConfigurePipes() respectively.
+ *      now named SImage_Host_USBTask() and SImage_Host_ConfigurePipes() respectively.
  *    - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to \ref HOST_SENDCONTROL_DeviceDisconnected to be in
  *      line with the rest of the library error codes.
  *    - The HID Parser item usages no longer contain separate minimum and maximum values, as this was a violation of the HID