Clean up and add more comments to the AVRISP-MKII project. Make sure the SPI_MULTI...

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

diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index 0070a34..cf81901 100644 (file)
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -10,7 +10,44 @@
  *  to the next version released. It does not indicate all new additions to the library in each version change, only\r
  *  areas relevant to making older projects compatible with the API changes of each new release.\r
  *\r
- * \section Sec_MigrationXXXXXX Migrating from 090810 to XXXXXX\r
+ * \section Sec_MigrationXXXXXX Migrating from 091223 to XXXXXX\r
+ *\r
+ *  <b>Host Mode</b>\r
+ *    - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be\r
+ *      packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send\r
+ *      pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually\r
+ *      flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().\r
+ *\r
+ *  <b>Device Mode</b>\r
+ *    - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be\r
+ *      packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send\r
+ *      endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually\r
+ *      flush the queued event(s) to the host by calling \ref MIDI_Device_Flush().\r
+ *\r
+ * \section Sec_Migration091223 Migrating from 091122 to 091223\r
+ *\r
+ *  <b>Host Mode</b>\r
+ *    - The Still Image Host Class driver SI_Host_USBTask() and SI_Host_ConfigurePipes() functions were misnamed, and are\r
+ *      now named \ref SImage_Host_USBTask() and \ref SImage_Host_ConfigurePipes() respectively.\r
+ *    - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to \ref HOST_SENDCONTROL_DeviceDisconnected to be in\r
+ *      line with the rest of the library error codes.\r
+ *    - The HID Parser item usages no longer contain seperate minimum and maximum values, as this was a violation of the HID\r
+ *      specification. Instead, the values are distributed evenly across each item as its usage value, to ensure that all items\r
+ *      can be distinguished from oneanother.\r
+ *\r
+ *  <b>Device Mode</b>\r
+ *    - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to\r
+ *      indicate the report type to generate. Existing applications may simply add and ignore this additional parameter.\r
+ *\r
+ * \section Sec_Migration091122 Migrating from 090924 to 091122\r
+ *  \r
+ *  <b>Host Mode</b>\r
+ *    - The HID_PARSE_UsageStackOverflow HID parser error constant is now named \ref HID_PARSE_UsageListOverflow\r
+ *    - The \ref CALLBACK_HIDParser_FilterHIDReportItem() HID Parser callback now passes a complete HID_ReportItem_t to the\r
+ *      user application, instead of just its attributes.\r
+ *    - The USB_GetDeviceConfigDescriptor() function was incorrectly named and is now called \ref USB_Host_GetDeviceConfigDescriptor().\r
+ *\r
+ * \section Sec_Migration090924 Migrating from 090810 to 090924\r
  *\r
  *  <b>Non-USB Library Components</b>\r
  *    - The ADC_Off() function has been renamed to \ref ADC_ShutDown() to be consistent with the rest of the library.\r
@@ -20,7 +57,7 @@
  *      call to SPI_Init() before using the Dataflash driver\r
  *\r
  *  <b>Host Mode</b>\r
- *    - The \ref USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to\r
+ *    - The USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to\r
  *      preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single\r
  *      call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user\r
  *      application perform these intermediatary steps.\r
@@ -58,7 +95,7 @@
  *\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
+ *    - The 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