Ensure new Benito Programmer project matches Don's established LED behaviour - flash...
[pub/lufa.git] / LUFA / ManPages / MigrationInformation.txt
index ecd4e9e..5ea8d9c 100644 (file)
  * \section Sec_MigrationXXXXXX Migrating from 090605 to XXXXXX\r
  *\r
  *  <b>All</b>\r
- *    - The "Simple Scheduler" has been deprecated, as it was little more than an abtracted loop and caused much confusion. User\r
- *      applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future\r
+ *    - The "Simple Scheduler" has been <i>deprecated</i>, as it was little more than an abtracted loop and caused much confusion.\r
+ *      User applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future\r
  *      release.\r
  *    - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never\r
  *      used in user applications. The library is available from the author's website for those wishing to still use it in their\r
  *      applications.\r
+ *    - The USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_DeviceState or \ref USB_HostState\r
+ *      explicitly to ensure the device is in the desired state instead.\r
+ *\r
+ *  <b>Host Mode</b>\r
+ *    - The HIDParser.c module has moved from LUFA/Drivers/USB/Class/ to LUFA/Drivers/USB/Class/Host/.\r
+ *    - The \ref USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first\r
+ *      parameter, to add support for multi-configuration devices. Existing code should use a configuration index of 1 to indicate the\r
+ *      first configuration descriptor within the device.\r
+ *    - The non-standard "Ready" host state has been removed. Existing \ref HOST_STATE_Configured code should be moved to the end of\r
+ *      the existing \ref HOST_STATE_Addressed state, and the existing HOST_STATE_Ready state code should be moved to the \ref HOST_STATE_Configured\r
+ *      state.\r
+ *\r
+ *  <b>Device Mode</b>\r
+ *    - The \ref CALLBACK_USB_GetDescriptor() function now takes an extra parameter to specify the descriptor's memory space so that\r
+ *      descriptors in mixed memory spaces can be used. The previous functionality can be returned by defining the USE_FLASH_DESCRIPTORS\r
+ *      token in the project makefile to fix all descriptors into FLASH space and remove the extra function parameter.\r
+ *    - Removed USB_IsSuspended - test \ref USB_DeviceState against \ref DEVICE_STATE_Suspended instead.\r
+ *\r
  *\r
  * \section Sec_Migration090605 Migrating from 090510 to 090605\r
  *\r