X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/beb0b2bda0c45e958e88933a055d409e42fa0a0b..2f95eea14689d30a3172a7e1e30980072bf23fac:/LUFA/ManPages/MigrationInformation.txt
diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index f1b5f55ce..36c7d3580 100644
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -10,7 +10,10 @@
* 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 090605 to XXXXXX
+ * \section Sec_MigrationXXXXXX Migrating from 090810 to XXXXXX
+ * No migration information for this version yet.
+ *
+ * \section Sec_Migration090810 Migrating from 090605 to 090810
*
* All
* - The "Simple Scheduler" has been deprecated, as it was little more than an abtracted loop and caused much confusion.
@@ -20,11 +23,38 @@
* used in user applications. The library is available from the author's website for those wishing to still use it in their
* applications.
*
+ * Non-USB Library Components
+ * - The ATTR_NOINLINE function attribute macro has been renamed to ATTR_NO_INLINE to be in line with the rest of the function attribute
+ * macro names.
+ *
+ * Library Demos
+ * - Most demos now have a corresponding Class Driver implementation, which uses the new internal library class drivers for the standard
+ * USB classes. This allows for more rapid device and host development, and so should be used in preference to the low level APIs where
+ * possible so that fixes to the class drivers propagate to all applications which use them automatically with each new LUFA release.
+ *
* Host Mode
* - The HIDParser.c module has moved from LUFA/Drivers/USB/Class/ to LUFA/Drivers/USB/Class/Host/.
- * - The USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first
+ * - The \ref USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first
* parameter, to add support for multi-configuration devices. Existing code should use a configuration index of 1 to indicate the
* first configuration descriptor within the device.
+ * - The non-standard "Ready" host state has been removed. Existing \ref HOST_STATE_Configured code should be moved to the end of
+ * the existing \ref HOST_STATE_Addressed state, and the existing HOST_STATE_Ready state code should be moved to the \ref HOST_STATE_Configured
+ * state.
+ * - The USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_HostState explicitly to ensure the host is
+ * in the desired state instead.
+ * - The USB event names have been changed and their firing conditions changed to properly seperate out Host mode events from Device mode
+ * events. See the \ref Group_Events page for details on the new event names and firing conditions.
+ *
+ * Device Mode
+ * - The \ref CALLBACK_USB_GetDescriptor() function now takes an extra parameter to specify the descriptor's memory space so that
+ * descriptors in mixed memory spaces can be used. The previous functionality can be returned by defining the USE_FLASH_DESCRIPTORS
+ * token in the project makefile to fix all descriptors into FLASH space and remove the extra function parameter.
+ * - The USB_IsSuspended global has been removed - test \ref USB_DeviceState against \ref DEVICE_STATE_Suspended instead.
+ * - The USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_DeviceState explicitly to ensure the device
+ * is in the desired state instead.
+ * - The VBUS events have been removed, as they are already exposed to the user via the USB_Connect and USB_Disconnect events.
+ * - The USB event names have been changed and their firing conditions changed to properly seperate out Host mode events from Device mode
+ * events. See the \ref Group_Events page for details on the new event names and firing conditions. *
*
* \section Sec_Migration090605 Migrating from 090510 to 090605
*