X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6b7770ef2b7f0a7210d8a69ca2edaca1b468815d..d41cd9a41aca81eaa21e65e6c53672fe604fa3d5:/LUFA/ManPages/MigrationInformation.txt diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index 7653a44b6..08c7a9f88 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -10,11 +10,82 @@ * 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_Migration100513 Migrating from 100512 to 100513 - * This release was made shortly after the 100512 release, to fix a critical device-mode error. No specific migration - * information applies to this release - see \ref Sec_Migration100512 for migration information of the previous release. + * \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. + * - The USB mode specifier constants have been moved into a new enum and renamed. Existing projects should use the equivalent + * value in the new \ref USB_Modes_t enum. + * - All class driver headers are now included as part of the standard LUFA/Drivers/USB/USB.h master dispatch header, and should + * no longer be included seperately. Class driver module source files must still be added as a seperate module in the project's + * makefile if used. * - * \section Sec_Migration100512 Migrating from 100219 to 100512 + * 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. + * - The ENDPOINT_DOUBLEBANK_SUPPORTED() macro is has been renamed \ref ENDPOINT_BANKS_SUPPORTED() and now returns the total number of + * banks supported by the given endpoint. Existing code should switch to the new naming scheme, and test that the return value of the + * macro is equal to or greated than 2 to regain the previous functionality. + * - The EVENT_USB_Device_UnhandledControlRequest() event is now named \ref EVENT_USB_Device_ControlRequest() and fires before (not after) + * the internal library event handlers. Existing code should rename the event handlers in the user application to match the new event + * name, and should ensure that the new execution order does not affect the application's operation. + * + * 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 + * Dataflash driver of the library have now been moved to the individual board files. Existing drivers can + * copy-paste the new functions from the board Dataflash stub driver. + * + * USB Core + * - A new USB driver source file, Drivers/USB/LowLevel/Device.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 Drivers/USB/LowLevel/DevChapter9.c source file has moved to Drivers/USB/HighLevel/DeviceStandardReq.c - this should + * be updated in all project makefiles, or the makefile should be updated to use the new module source variables. + * - The Drivers/USB/LowLevel/HostChapter9.h source file has moved to Drivers/USB/HighLevel/HostStandardReq.c - this should + * be updated in all project makefiles, or the makefile should be updated to use the new module source variables. + * - The Drivers/USB/LowLevel/LowLevel.c source file has moved to Drivers/LowLevel/USBController.c - this should be updated + * in all project makefiles, or the makefile should be updated to use the new module source variables. + * + * Device Mode + * - The USB_Device_IsRemoteWakeupSent() macro has been removed, as the remote wakeup request is now fully handled by the + * enhanced \ref USB_Device_SendRemoteWakeup() function. Existing code may now discard any checks to USB_Device_IsRemoteWakeupSent(). + * - The USB_Device_IsUSBSuspended() macro has been removed, as it is obsolete. Existing code should compare \ref USB_DeviceState + * to see if it the device is in the \ref DEVICE_STATE_Suspended state instead. + * - The \ref CDC_Device_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was + * received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact + * number of queued bytes received is not needed. + * + * Host Mode + * - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was + * received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact + * number of queued bytes received is not needed. + * - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual + * flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask(). + * + * \section Sec_Migration100513 Migrating from 100219 to 100513 * * Non-USB Library Components * - The \ref TWI_StartTransmission() function now takes in a timeout period, expressed in milliseconds, within which the addressed @@ -29,7 +100,7 @@ * Projects must update their makefile SRC values accordingly. * - The HID Device Class driver's function signature for the CALLBACK_HID_Device_ProcessHIDReport() function has been changed, to * allow for a new ReportType parameter. This new parameter must be added in all user applications using the Device mode HID Class - * Driver, but may be ingnored unless Host-to-Device FEATURE HID reports are used. + * Driver, but may be ignored unless Host-to-Device FEATURE HID reports are used. * * Host Mode * - The \ref USB_Init() function no longer calls sei() to enable global interrupts, as the user application may need @@ -45,8 +116,8 @@ * * Non-USB Library Components * - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models, - * the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used - * when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function + * the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used + * when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function * is an exception, and should always be called with a channel number rather than a channel mask. * * Host Mode @@ -68,19 +139,19 @@ * * 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 seperate minimum and maximum values, as this was a violation of the HID + * - The HID Parser item usages no longer contain separate minimum and maximum values, as this was a violation of the HID * specification. Instead, the values are distributed evenly across each item as its usage value, to ensure that all items - * can be distinguished from oneanother. + * can be distinguished from one-another. * * 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 @@ -100,24 +171,24 @@ * - 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. + * application perform these intermediary 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_* + * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate 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. * * Device Mode - * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now seperate USB_Descriptor_* + * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate 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 * * All - * - The "Simple Scheduler" has been deprecated, as it was little more than an abtracted loop and caused much confusion. + * - The "Simple Scheduler" has been deprecated, as it was little more than an abstracted 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 @@ -143,7 +214,7 @@ * 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 + * - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode * events. See the \ref Group_Events page for details on the new event names and firing conditions. * * Device Mode @@ -154,7 +225,7 @@ * - 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 + * - The USB event names have been changed and their firing conditions changed to properly separate 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 @@ -205,7 +276,7 @@ * library demos should update to the latest versions. * * Device Mode - * - The Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the Endpoint_ClearIN(), Endpoint_ClearOUT() + * - The Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the Endpoint_ClearIN(), Endpoint_ClearOUT() * macros. See Endpoint.h documentation for more details on the new endpoint management macros. * - The Endpoint_ReadWriteAllowed() macro has been renamed to Endpoint_IsReadWriteAllowed() to be more consistent with the rest of * the API naming scheme. @@ -277,7 +348,7 @@ * * Device Mode * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded - * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the + * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the * NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further * modifications required. * @@ -301,7 +372,7 @@ * - The previous SPI_SendByte() functionality is now located in SPI_TransferByte(). SPI_SendByte() now discards the return byte * for speed, to compliment the new SPI_ReceiveByte() function. If two-way SPI transfers are required, calls to SPI_SendByte() * should be changed to SPI_TransferByte(). - * - The serial driver now sets the Tx line as an output explicitly, and enables the pullup of the Rx line. + * - The serial driver now sets the Tx line as an output explicitly, and enables the pull-up of the Rx line. * - The Serial_Init() and SerialStream_Init() functions now take a second DoubleSpeed parameter, which indicates if the USART * should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at * the given AVR clock speed. @@ -463,7 +534,7 @@ * appropriate. It fires in an identical manner to the previously named event, thus the only change to be made * is the event name itself in the user project. * - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a - * pseudo-descriptor modelled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type + * pseudo-descriptor modeled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type * descriptor as indicated in the USB specification, thus all device code must be updated accordingly. * - The names of several Endpoint macros have been changed to be more consistent with the rest of the library, * with no implementation changes. This means that existing code can be altered to use the new macro names @@ -498,3 +569,4 @@ * finished enumerating the device. Projects relying on the event only firing in Host mode should be updated * so that the event action only occurs when the USB_Mode global is set to USB_MODE_HOST. */ +