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 090605 to XXXXXX
16 * - The "simple scheduler" has been removed, as it was little more than an abtracted loop and caused much confusion. User
17 * applications using the scheduler should switch to regular loops instead.
18 * - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never
19 * used in user applications. The library is available from the author's website for those wishing to still use it in their
22 * \section Sec_Migration090605 Migrating from 090510 to 090605
25 * - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing
26 * projects using interrupts on non-control endpoints should switch to polling. For control interrupts, the library can
27 * manage the control endpoint via interrupts automatically by compiling with the INTERRUPT_CONTROL_ENDPOINT token defined.
28 * - The DESCRIPTOR_ADDRESS() macro has been removed. User applications should use normal casts to obtain a descriptor's memory
30 * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
31 * \ref Group_Events for new API details.
32 * - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
33 * function signatures of a function accepting no arguments and returning a uint8_t value.
34 * - The Event_DeviceError() event no longer exists, as its sole caller (unlinked USB_GetDescriptor() function) now produces a
35 * compilation error rather than a runtime error. The StdDescriptors.c file no longer exists as a result, and should be removed
36 * from project makefiles.
37 * - The USB_GetDescriptor() function has been renamed to CALLBACK_USB_GetDescriptor() to be in line with the new CALLBACK_ function
38 * prefixes for functions which *must* be implemented in the user application.
41 * - Support for non-control data pipe interrupts has been dropped due to many issues in the implementation. All existing
42 * projects using interrupts on non-control pipes should switch to polling.
43 * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
44 * \ref Group_Events for new API details.
45 * - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
46 * function signatures of a function accepting no arguments and returning a uint8_t value.
47 * - The DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with
48 * regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a uint8_t value.
51 * \section Sec_Migration090510 Migrating from 090401 to 090510
54 * - The ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all
55 * BUTTLOADTAG elements, or download and extract ButtLoadTag.h header from the ButtLoad project.
56 * - The Drivers/AT90USBXXX directory has been renamed to Drivers/Peripheral.
57 * - The Serial_Stream driver has been renamed to SerialStream to remain consistent with the rest of the library naming scheme.
58 * - The HWB driver has changed to the Buttons driver. See the board Buttons driver documentation for the new API.
60 * <b>Dual Role Mode</b>
61 * - The USB_PowerOnFail even has been renamed to USB_InitFailure.
62 * - The functions in OTG.h have been renamed to remain more consistent with the library API. See the functions in OTG.h for more
65 * <b>Library Demos</b>
66 * - Most demos, bootloaders and applications have had significant changes from previous versions. Applications built off of any
67 * library demos should update to the latest versions.
70 * - The Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the Endpoint_ClearIN(), Endpoint_ClearOUT()
71 * macros. See Endpoint.h documentation for more details on the new endpoint management macros.
72 * - The Endpoint_ReadWriteAllowed() macro has been renamed to Endpoint_IsReadWriteAllowed() to be more consistent with the rest of
73 * the API naming scheme.
74 * - The Endpoint_IsSetupINReady() and Endpoint_IsSetupOutReceived() macros have been renamed to Endpoint_IsINReady() and
75 * Endpoint_IsOUTReceived() respectively.
76 * - The Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived().
77 * - The Endpoint_ClearSetupReceived() macro has been renamed to Endpoint_ClearSETUP().
78 * - All endpoint read/write/discard aliases which did not have an explicitly endianness specifier (such as Endpoint_Read_Word()) have
79 * been removed for clarity. Existing projects should use the "_LE" suffix on such calls to use the explicit Little Endian versions.
80 * - The USB_UnhandledControlPacket event no longer has any parameters. User code should no longer attempt to read in the remainder of
81 * the Control Request header as all Control Request header data is now preloaded by the library and made available in the
82 * USB_ControlRequest structure.
83 * - The FEATURELESS_CONTROL_ONLY_DEVICE token has been renamed to CONTROL_ONLY_DEVICE.
84 * - The STATIC_ENDPOINT_CONFIGURATION is no longer applicable as the library will apply this optimization when appropriate automatically.
85 * - The values of the Endpoint_Stream_RW_ErrorCodes_t and Endpoint_ControlStream_RW_ErrorCodes_t enums have had the "ERROR_" portion
86 * of their names removed.
89 * - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on
90 * other control type pipes. Care should be taken to ensure that the Control pipe is always selected before the function is called
91 * in existing projects where the Control pipe is to be operated on.
92 * - The USB Host management task now saves and restores the currently selected pipe before and after the task runs. Projects no longer
93 * need to manage this manually when calling the USB management task.
94 * - The Pipe_ClearCurrentBank() macro has been removed, and is now replaced with the Pipe_ClearIN(), Pipe_ClearOUT() macros. See
95 * Pipe.h documentation for more details on the new pipe management macros.
96 * - The Pipe_ReadWriteAllowed() macro has been renamed to Pipe_IsReadWriteAllowed() to be more consistent with the rest of the API
98 * - The Pipe_IsSetupINReceived() and Pipe_IsOutReady() macros have been renamed to Pipe_IsINReceived() and Pipe_IsOUTReady()
100 * - The new Pipe_ClearSETUP() macro should be used to send SETUP transactions, rather than the previous Pipe_ClearSetupOUT() macro.
101 * - The Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent().
102 * - The Pipe_ClearSetupSent() macro is no longer applicable and should be removed.
103 * - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as Pipe_Read_Word()) have
104 * been removed for clarity. Existing projects should use the "_LE" suffix on such calls to use the explicit Little Endian versions.
105 * - The Host_IsResetBusDone() macro has been renamed to Host_IsBusResetComplete().
106 * - The Pipe_Ignore_Word() and Pipe_Ignore_DWord() functions have been renamed to Pipe_Discard_Word() and Pipe_Discard_DWord() to remain
107 * consistent with the rest of the pipe API.
108 * - It is no longer needed to manually include the headers from LUFA/Drivers/USB/Class, as they are now included along with the rest
109 * of the USB headers when LUFA/Drivers/USB/USB.h is included.
110 * - Functions in the ConfigDescriptor.h header file no longer have "Host_" as part of their names.
111 * - The ProcessHIDReport() has been renamed to USB_ProcessHIDReport(), GetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo()
112 * and SetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo().
113 * - The values of the DSearch_Return_ErrorCodes_t and DSearch_Comp_Return_ErrorCodes_t enums have had their respective "Descriptor_Search"
114 * and "Descriptor_Search_Comp" prefixes changed to all caps.
115 * - The USB_HostRequest global has been renamed to USB_ControlRequest, and is used in Device mode also. The USB_Host_Request_Header_t
116 * structure type has been renamed to USB_Request_Header_t.
117 * - The values of the Pipe_Stream_RW_ErrorCodes_t enum have had the "ERROR_" portion of their names removed.
120 * \section Sec_Migration090401 Migrating from 090209 to 090401
123 * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant "F_CLOCK",
124 * defined in the project makefile and passed to the compiler via the -D switch.
125 * - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the
126 * EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called.
127 * - As the avr-libc macro has been corrected in recent avr-libc distributions, the SetSystemClockPrescaler() macro has been removed.
128 * Include <avr/power.h> and call clock_prescale_set(clock_div_1); instead on recent avr-libc distributions.
130 * <b>Library Demos</b>
131 * - The USBtoSerial demo now discards all data when not connected to a host, rather than buffering it for later transmission.
132 * - Most demos, bootloaders and applications have had their control request handling code corrected, to properly send the status
133 * stage in all handled requests. If you are using code based off one of the library demos, bootloaders or applications, you should
134 * update to the latest revisions.
136 * <b>Non-USB Library Components</b>
137 * - The ATTR_ALWAYSINLINE function attribute macro has been renamed to ATTR_ALWAYS_INLINE.
138 * - Custom board Dataflash drivers now require the implementation of Dataflash_SelectChipFromPage() and Dataflash_SendAddressBytes().
141 * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
142 * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the
143 * NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further
144 * modifications required.
147 * \section Sec_Migration090209 Migrating from 081217 to 090209
150 * - The ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of ENDPOINT_TOTAL_ENDPOINTS.
151 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
152 * makefile if desired to restore the previous 50ms timeout.
155 * - The PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of PIPE_TOTAL_ENDPOINTS.
156 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
157 * makefile if desired to restore the previous 50ms timeout.
158 * - The USB_DeviceEnumerationFailed event now contains a second "SubErrorCode" parameter, giving the error code of the function
160 * - The HID_PARSE_Sucessful enum member constant has been corrected to HID_PARSE_Successful.
162 * <b>Non-USB Library Components</b>
163 * - The previous SPI_SendByte() functionality is now located in SPI_TransferByte(). SPI_SendByte() now discards the return byte
164 * for speed, to compliment the new SPI_ReceiveByte() function. If two-way SPI transfers are required, calls to SPI_SendByte()
165 * should be changed to SPI_TransferByte().
166 * - The serial driver now sets the Tx line as an output explicitly, and enables the pullup of the Rx line.
167 * - The Serial_Init() and SerialStream_Init() functions now take a second DoubleSpeed parameter, which indicates if the USART
168 * should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at
169 * the given AVR clock speed.
171 * <b>Library Demos</b>
172 * - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to
173 * the latest demo versions.
176 * \section Sec_Migration171208 Migrating from V1.5.3 to 081217
179 * - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names,
180 * have been changed to LUFA.
182 * <b>Library Demos</b>
183 * - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding
184 * parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version.
185 * - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and
186 * KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects
187 * built on either "WithParser" demo should update to the latest code.
188 * - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not
189 * recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes,
190 * as it is neither a full nor a standards compliant implementation.
192 * <b>Non-USB Library Components</b>
193 * - The Serial_IsCharRecieved() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
196 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
197 * to be used in the Options parameter of the USB_Init() function.
198 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
199 * currently initialized.
200 * - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library
201 * or user request processing code to exceed the strict USB timing requirements on control transfers.
202 * - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured
203 * after a Reset event, it should be altered to explicitly re-initialize all user endpoints.
204 * - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now
205 * returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified
206 * descriptor does not exist.
207 * - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the
208 * GetDescriptor function.
211 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
212 * to be used in the Options parameter of the USB_Init() function.
213 * - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and
214 * SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the
215 * current report. If sending a report to a multi-report device, the first byte of the report is automatically
216 * set to the report ID of the given report item.
217 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
218 * currently initialized.
221 * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3
223 * <b>Library Demos</b>
224 * - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number
225 * string is required in Mass Storage devices, or devices which are to retain settings when moved between
226 * ports on a machine. As people were not changing the serial number value, this was causing conflicts and so
227 * the serial number descriptor has been removed from all but the Mass Storage demo, which requires it.
228 * - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated
229 * them. Projects built upon either demo should upgrade to the latest code.
230 * - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented.
231 * - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built
232 * on the MassStoreDemo code should update to the latest version.
233 * - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused
234 * problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade
235 * to the latest code.
236 * - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects
237 * built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code.
238 * - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should
239 * upgrade to the latest code.
240 * - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was
241 * previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update
242 * to the latest code.
245 * - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream.
246 * If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The
247 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
248 * timeout duration in ms.
249 * - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled
250 * and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and
251 * USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details.
252 * - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated
253 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
254 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
257 * - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream.
258 * If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The
259 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
260 * timeout duration in ms.
261 * - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures.
262 * - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated
263 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
264 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
267 * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2
269 * <b>Library Demos</b>
270 * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
271 * of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
272 * to the latest code.
273 * - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
274 * possible any existing devices upgrade to the latest bootloader code.
277 * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1
279 * <b>Library Demos</b>
280 * - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the
281 * global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo
282 * should upgrade to the latest code.
283 * - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID
284 * demos should upgrade to the latest code.
285 * - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors.
286 * Projects built upon the HID demos should upgrade to the latest code.
287 * - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo
288 * should upgrade to the latest code.
289 * - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power.
290 * Projects built upon the AudioOut demo should upgrade to the latest code.
293 * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0
295 * <b>Library Demos</b>
296 * - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To
297 * avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing
298 * projects should at least manually correct the BCD version numbers, or preferably update the descriptors to
299 * encode the version number in BCD format using the new macro.
300 * - The mandatory GetReport class-specific request was accidentally omitted from previous versions of the demos
301 * based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the
302 * HID demos should also be updated accordingly.
303 * - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission.
304 * Failure to do this on projects which always or frequently send full packets will cause buffering issues on
305 * the host OS. All CDC user projects are advised to update their transmission routines in the same manner as
306 * the library CDC demos.
307 * - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected
308 * Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven
309 * demos should also update to properly save and restore the selected Endpoint/Pipe.
311 * <b>Non-USB Library Components</b>
312 * - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only
313 * compatible with avr-libc library versions newer than the time before the functionality of the deleted
314 * headers was available.
317 * - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and
318 * functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API.
319 * The previously split Type and Index parameters are now passed as the original wValue parameter to the
320 * function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the
321 * previous Index parameter.
322 * - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the
323 * official USB specification. Existing code will need to be altered to use the new parameter names.
324 * - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more
325 * appropriate. It fires in an identical manner to the previously named event, thus the only change to be made
326 * is the event name itself in the user project.
327 * - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a
328 * pseudo-descriptor modelled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type
329 * descriptor as indicated in the USB specification, thus all device code must be updated accordingly.
330 * - The names of several Endpoint macros have been changed to be more consistent with the rest of the library,
331 * with no implementation changes. This means that existing code can be altered to use the new macro names
332 * with no other considerations required. See Endpoint.h for the new macro names.
333 * - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t
334 * structure named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this
335 * demo should correct the structure value to maintain compatibility across multiple OS platforms.
336 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
337 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
338 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
339 * documentation for more details.
342 * - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its
343 * members renamed to the official USB specification names for requests. Existing code will need to be updated
344 * to use the new names.
345 * - The names of several Pipe macros have been changed to be more consistent with the rest of the library,
346 * with no implementation changes. This means that existing code can be altered to use the new macro names
347 * with no other considerations required. See Pipe.h for the new macro names.
348 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
349 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
350 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
351 * documentation for more details.
352 * - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h
353 * module documentation for the new macro names.
355 * <b>Dual Role Mode</b>
356 * - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing
357 * projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG
358 * header inside the library.
359 * - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has
360 * finished enumerating the device. Projects relying on the event only firing in Host mode should be updated
361 * so that the event action only occurs when the USB_Mode global is set to USB_MODE_HOST.
projects / pub / USBasp.git / blob