LUFA/MigrationInformation.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \page Page_Migration Migrating from Older Versions
   8  *
   9  *  Below is migration information for updating existing projects based on previous versions of the LUFA library
  10  *  to the next version released. It does not indicate all new additions to the library in each version change, only
  11  *  areas relevant to making older projects compatible with the API changes of each new release.
  12  *
  13  * \section Sec_MigrationXXXXXX Migrating from 090401 to XXXXXX
  14  *
  15  *  <b>Host Mode</b>
  16  *    - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on
  17  *      other control type pipes. Care should be taken to ensure that the Control pipe is always selected before the function is called
  18  *      in existing projects where the Control pipe is to be operated on.
  19  *    - The USB Host management task now saves and restores the currently selected pipe before and after the task runs. Projects no longer
  20  *      need to manage this manually when calling the USB management task.
  21  *
  22  * \section Sec_Migration090401 Migrating from 090209 to 090401
  23  *
  24  *  <b>All</b>
  25  *    - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant "F_CLOCK",
  26  *      defined in the project makefile and passed to the compiler via the -D switch.
  27  *    - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the
  28  *      EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called.
  29  *    - As the avr-libc macro has been corrected in recent avr-libc distributions, the SetSystemClockPrescaler() macro has been removed.
  30  *      Include <avr/power.h> and call clock_prescale_set(clock_div_1); instead on recent avr-libc distributions.
  31  *
  32  *  <b>Library Demos</b>
  33  *    - The USBtoSerial demo now discards all data when not connected to a host, rather than buffering it for later transmission.
  34  *    - Most demos, bootloaders and applications have had their control request handling code corrected, to properly send the status
  35  *      stage in all handled requests. If you are using code based off one of the library demos, bootloaders or applications, you should
  36  *      update to the latest revisions.
  37  *
  38  *  <b>Non-USB Library Components</b>
  39  *    - The ATTR_ALWAYSINLINE function attribute macro has been renamed to ATTR_ALWAYS_INLINE.
  40  *    - Custom board Dataflash drivers now require the implementation of Dataflash_SelectChipFromPage() and Dataflash_SendAddressBytes().
  41  *
  42  *  <b>Device Mode</b>
  43  *    - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
  44  *      to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the
  45  *      NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further
  46  *      modifications required.
  47  *
  48  *
  49  * \section Sec_Migration090209 Migrating from 081217 to 090209
  50  *
  51  *  <b>Device Mode</b>
  52  *    - The ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of ENDPOINT_TOTAL_ENDPOINTS.
  53  *    - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
  54  *      makefile if desired to restore the previous 50ms timeout.
  55  *
  56  *  <b>Host Mode</b>
  57  *    - The PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of PIPE_TOTAL_ENDPOINTS.
  58  *    - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
  59  *      makefile if desired to restore the previous 50ms timeout.
  60  *    - The USB_DeviceEnumerationFailed event now contains a second "SubErrorCode" parameter, giving the error code of the function
  61  *      which failed.
  62  *    - The HID_PARSE_Sucessful enum member constant has been corrected to HID_PARSE_Successful.
  63  *
  64  *  <b>Non-USB Library Components</b>
  65  *    - The previous SPI_SendByte() functionality is now located in SPI_TransferByte(). SPI_SendByte() now discards the return byte
  66  *      for speed, to compliment the new SPI_ReceiveByte() function. If two-way SPI transfers are required, calls to SPI_SendByte()
  67  *      should be changed to SPI_TransferByte().
  68  *    - The serial driver now sets the Tx line as an output explicitly, and enables the pullup of the Rx line.
  69  *    - The Serial_Init() and SerialStream_Init() functions now take a second DoubleSpeed parameter, which indicates if the USART
  70  *      should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at
  71  *      the given AVR clock speed.
  72  *
  73  *  <b>Library Demos</b>
  74  *    - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to
  75  *      the latest demo versions.
  76  *
  77  *
  78  * \section Sec_Migration171208 Migrating from V1.5.3 to 081217
  79  *
  80  *  <b>All</b>
  81  *    - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names,
  82  *      have been changed to LUFA.
  83  *
  84  *  <b>Library Demos</b>
  85  *    - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding
  86  *      parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version.
  87  *    - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and
  88  *      KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects
  89  *      built on either "WithParser" demo should update to the latest code.
  90  *    - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not
  91  *      recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes,
  92  *      as it is neither a full nor a standards compliant implementation.
  93  *
  94  *  <b>Non-USB Library Components</b>
  95  *    - The Serial_IsCharRecieved() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
  96  *
  97  *  <b>Device Mode</b>
  98  *    - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
  99  *      to be used in the Options parameter of the USB_Init() function.
 100  *    - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
 101  *      currently initialized.
 102  *    - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library
 103  *      or user request processing code to exceed the strict USB timing requirements on control transfers.
 104  *    - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured
 105  *      after a Reset event, it should be altered to explicitly re-initialize all user endpoints.
 106  *    - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now
 107  *      returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified
 108  *      descriptor does not exist.
 109  *    - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the
 110  *      GetDescriptor function.
 111  *
 112  *  <b>Host Mode</b>
 113  *    - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
 114  *      to be used in the Options parameter of the USB_Init() function.
 115  *    - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and
 116  *      SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the
 117  *      current report. If sending a report to a multi-report device, the first byte of the report is automatically
 118  *      set to the report ID of the given report item.
 119  *    - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
 120  *      currently initialized.
 121  *
 122  *
 123  * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3
 124  *
 125  *  <b>Library Demos</b>
 126  *    - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number
 127  *      string is required in Mass Storage devices, or devices which are to retain settings when moved between
 128  *      ports on a machine. As people were not changing the serial number value, this was causing conflicts and so
 129  *      the serial number descriptor has been removed from all but the Mass Storage demo, which requires it.
 130  *    - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated
 131  *      them. Projects built upon either demo should upgrade to the latest code.
 132  *    - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented.
 133  *    - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built
 134  *      on the MassStoreDemo code should update to the latest version.
 135  *    - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused
 136  *      problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade
 137  *      to the latest code.
 138  *    - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects
 139  *      built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code.
 140  *    - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should
 141  *      upgrade to the latest code.
 142  *    - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was
 143  *      previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update
 144  *      to the latest code.
 145  *
 146  *  <b>Device Mode</b>
 147  *    - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream.
 148  *      If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The
 149  *      timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
 150  *      timeout duration in ms.
 151  *    - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled
 152  *      and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and
 153  *      USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details.
 154  *    - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated
 155  *      to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by pasing
 156  *      the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
 157  *
 158  *  <b>Host Mode</b>
 159  *    - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream.
 160  *      If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The
 161  *      timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
 162  *      timeout duration in ms.
 163  *    - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures.
 164  *    - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated
 165  *      to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by pasing
 166  *      the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
 167  *
 168  *
 169  * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2
 170  *
 171  *  <b>Library Demos</b>
 172  *    - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
 173  *      of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
 174  *      to the latest code.
 175  *    - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
 176  *      possible any existing devices upgrade to the latest bootloader code.
 177  *
 178  *
 179  * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1
 180  *
 181  *  <b>Library Demos</b>
 182  *    - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the
 183  *      global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo
 184  *      should upgrade to the latest code.
 185  *    - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID
 186  *      demos should upgrade to the latest code.
 187  *    - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors.
 188  *      Projects built upon the HID demos should upgrade to the latest code.
 189  *    - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo
 190  *      should upgrade to the latest code.
 191  *    - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power.
 192  *      Projects built upon the AudioOut demo should upgrade to the latest code.
 193  *
 194  *
 195  * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0
 196  *
 197  *  <b>Library Demos</b>
 198  *    - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To
 199  *      avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing
 200  *      projects should at least manually correct the BCD version numbers, or preferably update the descriptors to
 201  *      encode the version number in BCD format using the new macro.
 202  *    - The mandatory GetReport class-specific request was accidentally ommitted from previous versions of the demos
 203  *      based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the
 204  *      HID demos should also be updated accordingly.
 205  *    - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission.
 206  *      Failure to do this on projects which always or frequently send full packets will cause buffering issues on
 207  *      the host OS. All CDC user projects are advised to update their transmission routines in the same manner as
 208  *      the library CDC demos.
 209  *    - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected
 210  *      Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven
 211  *      demos should also update to properly save and restore the selected Endpoint/Pipe.
 212  *
 213  *  <b>Non-USB Library Components</b>
 214  *    - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only
 215  *      compatible with avr-libc library versions newer than the time before the functionality of the deleted
 216  *      headers was available.
 217  *
 218  *  <b>Device Mode</b>
 219  *    - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and
 220  *      functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API.
 221  *      The previously split Type and Index parameters are now passed as the original wValue parameter to the
 222  *      function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the
 223  *      previous Index parameter.
 224  *    - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the
 225  *      official USB specification. Existing code will need to be altered to use the new parameter names.
 226  *    - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more
 227  *      appropriate. It fires in an identical manner to the previously named event, thus the only change to be made
 228  *      is the event name itself in the user project.
 229  *    - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a
 230  *      psudo-descriptor modelled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type
 231  *      descriptor as indicated in the USB specification, thus all device code must be updated accordingly.
 232  *    - The names of several Endpoint macros have been changed to be more consistant with the rest of the library,
 233  *      with no implementation changes. This means that existing code can be altered to use the new macro names
 234  *      with no other considerations required. See Endpoint.h for the new macro names.
 235  *    - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t
 236  *      strucuture named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this
 237  *      demo should correct the structure value to maintain compatibility across multiple OS platforms.
 238  *    - By default, the descriptor structures use the official USB specification names for the elements. Previous
 239  *      versions of the library used non-standard (but more verbose) names, which are still usable in the current
 240  *      and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
 241  *      documentation for more details.
 242  *
 243  *  <b>Host Mode</b>
 244  *    - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its
 245  *      members renamed to the official USB specification names for requests. Existing code will need to be updated
 246  *      to use the new names.
 247  *    - The names of several Pipe macros have been changed to be more consistant with the rest of the library,
 248  *      with no implementation changes. This means that existing code can be altered to use the new macro names
 249  *      with no other considerations required. See Pipe.h for the new macro names.
 250  *    - By default, the descriptor structures use the official USB specification names for the elements. Previous
 251  *      versions of the library used non-standard (but more verbose) names, which are still usable in the current
 252  *      and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
 253  *      documentation for more details.
 254  *    - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h
 255  *      module documentation for the new macro names.
 256  *
 257  *  <b>Dual Role Mode</b>
 258  *    - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing
 259  *      projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG
 260  *      header inside the library.
 261  *    - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has
 262  *      finished enumerating the device. Projects relying on the event only firing in Host mode should be updated
 263  *      so that the event action only ocurrs when the USB_Mode global is set to USB_MODE_HOST.
 264  */