X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/24e621a8d8424721ed21ce329d2a28dbf8c35343..3ae9e6042fc1ebc876e32142dde606f7890518b2:/LUFA/ManPages/MigrationInformation.txt diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index 2a0d0c533..6faa65a9f 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -10,7 +10,38 @@ * 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 100513 to XXXXXX + * \section Sec_MigrationXXXXXX Migrating from 100807 to XXXXXX + * USB Core + * - A new USB driver source file, Drivers/USB/HighLevel/EndpointStream.c now exists. This source file should be added + * to all project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source + * variables. + * - A new USB driver source file, Drivers/USB/HighLevel/PipeStream.c now exists. This source file should be added to all + * project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables. + * - The EVENT_USB_InitFailure() event has been removed, as the USB_Init() function will no longer fail; if not USB mode is + * specified, the controller will default to UID selection mode. + * + * Device Mode + * - Endpoints MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application + * allocated endpoints in ascending order - or if your application uses the USB device mode class drivers, ensure that each instance's + * endpoint indexes are not overlapped with other interface's endpoints. + * - The signature for the CALLBACK_USB_GetDescriptor() callback has changed, the "void** const DescriptorAddress" parameter is + * now "const void** const DescriptorAddress". Existing applications should update their callback signatures to match this, and + * eliminate any casting of descriptor pointers to a non-const pointer. + * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation + * for each class driver for the new class specific descriptor type names. + * + * Host Mode + * - Pipes MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application + * allocated pipes in ascending order - or if your application uses the USB host mode class drivers, ensure that each instance's + * pipe indexes are not overlapped with other interface's pipes. + * - The PRNT_Host_SendData() function has been renamed to \ref PRNT_Host_SendString(). Existing applications should simply + * replace all references to the obsolete function name with the new function name. + * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation + * for each class driver for the new class specific descriptor type names. + * - The Still Image Host class' function prefix has been changed from "SImage_" to "SI_", to remain consistent with the rest of the + * driver's enums, type defines and constants. + * + * \section Sec_Migration100807 Migrating from 100513 to 100807 * * Non-USB Library Components * - The Dataflash board driver stub file has changed, as dataflash functions previously located in the internal @@ -81,7 +112,7 @@ * Host Mode * - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send - * pipe bank is full. To override this new behavior and revert to the previous behavior, the user application may manually + * pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually * flush the queued event(s) to the device by calling \ref MIDI_Host_Flush(). * - The Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address * is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint @@ -90,14 +121,14 @@ * Device Mode * - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send - * endpoint bank is full. To override this new behavior and revert to the previous behavior, the user application may manually + * endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually * flush the queued event(s) to the host by calling \ref MIDI_Device_Flush(). * * \section Sec_Migration091223 Migrating from 091122 to 091223 * * 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. + * now named SImage_Host_USBTask() and 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. * - The HID Parser item usages no longer contain separate minimum and maximum values, as this was a violation of the HID @@ -126,7 +157,7 @@ * call to SPI_Init() before using the Dataflash driver * * Host Mode - * - The USB_GetDeviceConfigDescriptor() function's parameters and behavior 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 intermediary steps. @@ -435,7 +466,7 @@ * * Library Demos * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations - * of the RNDIS specification, which had non-standard behavior. Projects built upon the demo should upgrade + * of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade * to the latest code. * - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where * possible any existing devices upgrade to the latest bootloader code.