X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/b221e7d175e4b5ca463fdd6d05b8c3fc71bd7c40..fec31947a6b4e77f65d92bf14b32533bbbc39b2d:/LUFA/ManPages/MigrationInformation.txt diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index 0070a34ac..be0952f28 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -10,7 +10,27 @@ * 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 090810 to XXXXXX + * \section Sec_MigrationXXXXXX Migrating from 091122 to XXXXXX + * + * Host Mode + * - 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. + * + * Device Mode + * - 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 + * + * Host Mode + * - 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 * * Non-USB Library Components * - The ADC_Off() function has been renamed to \ref ADC_ShutDown() to be consistent with the rest of the library. @@ -20,7 +40,7 @@ * call to SPI_Init() before using the Dataflash driver * * Host Mode - * - The \ref USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to + * - 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. @@ -58,7 +78,7 @@ * * Host Mode * - The HIDParser.c module has moved from LUFA/Drivers/USB/Class/ to LUFA/Drivers/USB/Class/Host/. - * - The \ref USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first + * - 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