X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/092f82e06fc64436fd957b4b6b8d5ce33532efae..7d83bd0dccfeed374f5e3954de4790cae58379b6:/LUFA/ManPages/MigrationInformation.txt diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index 40fb70a25..3bbe5a195 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -10,20 +10,56 @@ * 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 XXXXXX to XXXXXX + * \section Sec_MigrationXXXXXX Migrating from 101122 to XXXXXX + * USB Core + * - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of + * reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimise the compiled program + * size, the new ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering + * in exchange for a smaller compiled binary size. + * + * \section Sec_Migration101122 Migrating from 100807 to 101122 * 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. * * 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. * - * \section Sec_Migration100807 Migrating from 100513 to 100807 + * 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 @@ -37,7 +73,7 @@ * 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 + * - 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 @@ -56,7 +92,7 @@ * - 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 + * \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 @@ -83,12 +119,12 @@ * - The HID Host Class driver's function signature for the HID_Host_SendReportByID() function has been changed, to allow for a new * ReportType parameter. Existing calls to this function should substitute REPORT_ITEM_TYPE_Out as this parameter's value. * - * \section Sec_Migration100219 Migrating from 091223 to 100219 + * \section Sec_Migration100219 Migrating from 091223 to 100219 * * 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 @@ -106,11 +142,11 @@ * 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 + * \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 @@ -121,15 +157,15 @@ * - 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 - * + * \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 + * \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. @@ -156,7 +192,7 @@ * 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 + * \section Sec_Migration090810 Migrating from 090605 to 090810 * * All * - The "Simple Scheduler" has been deprecated, as it was little more than an abstracted loop and caused much confusion. @@ -199,7 +235,7 @@ * - 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 + * \section Sec_Migration090605 Migrating from 090510 to 090605 * * Device Mode * - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing @@ -227,8 +263,7 @@ * - The DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with * regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a uint8_t value. * - * - * \section Sec_Migration090510 Migrating from 090401 to 090510 + * \section Sec_Migration090510 Migrating from 090401 to 090510 * * All * - The ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all @@ -247,7 +282,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. @@ -296,8 +331,7 @@ * structure type has been renamed to USB_Request_Header_t. * - The values of the Pipe_Stream_RW_ErrorCodes_t enum have had the "ERROR_" portion of their names removed. * - * - * \section Sec_Migration090401 Migrating from 090209 to 090401 + * \section Sec_Migration090401 Migrating from 090209 to 090401 * * All * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant "F_CLOCK", @@ -319,12 +353,11 @@ * * 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. * - * - * \section Sec_Migration090209 Migrating from 081217 to 090209 + * \section Sec_Migration090209 Migrating from 081217 to 090209 * * Device Mode * - The ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of ENDPOINT_TOTAL_ENDPOINTS. @@ -352,8 +385,7 @@ * - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to * the latest demo versions. * - * - * \section Sec_Migration171208 Migrating from V1.5.3 to 081217 + * \section Sec_Migration171208 Migrating from V1.5.3 to 081217 * * All * - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names, @@ -397,8 +429,7 @@ * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is * currently initialized. * - * - * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3 + * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3 * * Library Demos * - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number @@ -443,8 +474,7 @@ * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing * the token NO_STREAM_CALLBACKS to the compiler using the -D switch. * - * - * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2 + * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2 * * Library Demos * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations @@ -453,8 +483,7 @@ * - 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. * - * - * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1 + * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1 * * Library Demos * - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the @@ -469,8 +498,7 @@ * - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power. * Projects built upon the AudioOut demo should upgrade to the latest code. * - * - * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0 + * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0 * * Library Demos * - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To @@ -540,3 +568,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. */ +