Clean up and add more comments to the AVRISP-MKII project. Make sure the SPI_MULTI...
[pub/lufa.git] / LUFA / ManPages / MigrationInformation.txt
index 89bba96..cf81901 100644 (file)
  *  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 091122 to XXXXXX\r
- *  \r
- *  <b>There is no migration information for this version.</b>\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