X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/0d8679cf6bf02b3fd07028f63187286f5d4ffc20..fec31947a6b4e77f65d92bf14b32533bbbc39b2d:/LUFA/ManPages/MigrationInformation.txt

diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index ecd4e9e80..be0952f28 100644
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -10,16 +10,96 @@
  *  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 091122 to XXXXXX
+ *
+ *  <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.
+ *    - 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.
+ *
+ *  <b>Device Mode</b>
+ *    - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to
+ *      indicate the report type to generate. Existing applications may simply add and ignore this additional parameter.
+ *
+ * \section Sec_Migration091122 Migrating from 090924 to 091122
+ *  
+ *  <b>Host Mode</b>
+ *    - The HID_PARSE_UsageStackOverflow HID parser error constant is now named \ref HID_PARSE_UsageListOverflow
+ *    - The \ref CALLBACK_HIDParser_FilterHIDReportItem() HID Parser callback now passes a complete HID_ReportItem_t to the
+ *      user application, instead of just its attributes.
+ *    - The USB_GetDeviceConfigDescriptor() function was incorrectly named and is now called \ref USB_Host_GetDeviceConfigDescriptor().
+ *
+ * \section Sec_Migration090924 Migrating from 090810 to 090924
+ *
+ *  <b>Non-USB Library Components</b>
+ *    - The ADC_Off() function has been renamed to \ref ADC_ShutDown() to be consistent with the rest of the library.
+ *    - The \ref SPI_Init() routine's parameters have changed, so that the clock polarity and data sampling modes can be set. See
+ *      the \ref SPI_Init() function documentation for more details
+ *    - The \ref Dataflash_Init() routine no longer initializes the SPI bus - the SPI bus should be initialized manually via a
+ *      call to SPI_Init() before using the Dataflash driver
+ *
+ *  <b>Host Mode</b>
+ *    - The USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to
+ *      preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single
+ *      call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user
+ *      application perform these intermediatary steps.
+ *    - The HID report parser now requires a mandatory callback in the user code, to filter only the items the application
+ *      is interested in into the processed HID report item structure to save RAM. See \ref CALLBACK_HIDParser_FilterHIDReportItem().
+ *    - The HID report parser now always parses FEATURE and always ignores constant-data items - the HID_ENABLE_FEATURE_PROCESSING
+ *      and HID_INCLUDE_CONSTANT_DATA_ITEMS compile time tokens now have no effect.
+ *    - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now seperate USB_Descriptor_*
+ *      and USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
+ *      the one project. For existing projects using the standardized names, change all code to use the USB_StdDescriptor_* variants.
+ *
+ *  <b>Device Mode</b>
+ *    - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now seperate USB_Descriptor_*
+ *      and USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
+ *      the one project. For existing projects using the standardized names, change all code to use the USB_StdDescriptor_* variants.
+ *
+ * \section Sec_Migration090810 Migrating from 090605 to 090810
  *
  *  <b>All</b>
- *    - The "Simple Scheduler" has been deprecated, as it was little more than an abtracted loop and caused much confusion. User
- *      applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future
+ *    - The "Simple Scheduler" has been <i>deprecated</i>, as it was little more than an abtracted loop and caused much confusion.
+ *      User applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future
  *      release.
  *    - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never
  *      used in user applications. The library is available from the author's website for those wishing to still use it in their
  *      applications.
  *
+ *  <b>Non-USB Library Components</b>
+ *    - 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.
+ *
+ *  <b>Library Demos</b>
+ *    - 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.
+ *
+ *  <b>Host Mode</b>
+ *    - 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
+ *      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.
+ *
+ *  <b>Device Mode</b>
+ *    - 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
  *
  *  <b>Device Mode</b>
@@ -191,7 +271,7 @@
  *      as it is neither a full nor a standards compliant implementation.
  *
  *  <b>Non-USB Library Components</b>
- *    - The Serial_IsCharRecieved() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
+ *    - The Serial_IsCharReceived() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
  *
  *  <b>Device Mode</b>
  *    - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask