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