Added new XCK_RESCUE_CLOCK_ENABLE compile time option to the AVRISP-MKII clone progra...

[pub/lufa.git] / LUFA / ManPages / MigrationInformation.txt

diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index 2a0d0c5..08c7a9f 100644 (file)
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -10,7 +10,49 @@
  *  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.
  *
  *  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
+ *  <b>USB Core</b>
+ *    - 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.
+ *
+ *  <b>Device Mode</b>
+ *    - 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.
+ *
+ *  <b>Host Mode</b>
+ *    - 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

  *
  *  <b>Non-USB Library Components</b>
  *    - The Dataflash board driver stub file has changed, as dataflash functions previously located in the internal
  *
  *  <b>Non-USB Library Components</b>
  *    - The Dataflash board driver stub file has changed, as dataflash functions previously located in the internal


@@ -24,7 +66,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.
  *      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.
  *
  *  <b>Device Mode</b>
  *      in all project makefiles, or the makefile should be updated to use the new module source variables.
  *
  *  <b>Device Mode</b>


@@ -74,14 +116,14 @@
  *
  *  <b>Non-USB Library Components</b>
  *    - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models,
  *
  *  <b>Non-USB Library Components</b>
  *    - 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.
  *
  *  <b>Host Mode</b>
  *    - 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
  *      is an exception, and should always be called with a channel number rather than a channel mask.
  *
  *  <b>Host Mode</b>
  *    - 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
  *      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 +132,14 @@
  *  <b>Device Mode</b>
  *    - 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
  *  <b>Device Mode</b>
  *    - 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
  *
  *  <b>Host Mode</b>
  *    - The Still Image Host Class driver SI_Host_USBTask() and SI_Host_ConfigurePipes() functions were misnamed, and are
  *      flush the queued event(s) to the host by calling \ref MIDI_Device_Flush().
  *
  * \section Sec_Migration091223 Migrating from 091122 to 091223
  *
  *  <b>Host Mode</b>
  *    - 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
  *    - 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


@@ -109,7 +151,7 @@
  *      indicate the report type to generate. Existing applications may simply add and ignore this additional parameter.
  *
  * \section Sec_Migration091122 Migrating from 090924 to 091122
  *      indicate the report type to generate. Existing applications may simply add and ignore this additional parameter.
  *
  * \section Sec_Migration091122 Migrating from 090924 to 091122

- *  
+ *

  *  <b>Host Mode</b>
  *    - 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
  *  <b>Host Mode</b>
  *    - 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


@@ -126,7 +168,7 @@
  *      call to SPI_Init() before using the Dataflash driver
  *
  *  <b>Host Mode</b>
  *      call to SPI_Init() before using the Dataflash driver
  *
  *  <b>Host Mode</b>

- *    - 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.
  *      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.


@@ -234,7 +276,7 @@
  *      library demos should update to the latest versions.
  *
  *  <b>Device Mode</b>
  *      library demos should update to the latest versions.
  *
  *  <b>Device Mode</b>

- *    - 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.
  *      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.


@@ -306,7 +348,7 @@
  *
  *  <b>Device Mode</b>
  *    - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
  *
  *  <b>Device Mode</b>
  *    - 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.
  *
  *      NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further
  *      modifications required.
  *


@@ -435,7 +477,7 @@
  *
  *  <b>Library Demos</b>
  *    - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
  *
  *  <b>Library Demos</b>
  *    - 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.
  *      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.


@@ -527,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.
  */
  *      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.
  */

+