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 100219 to XXXXXX
15 * <b>Non-USB Library Components</b>
16 * - The \ref TWI_StartTransmission() function now takes in a timeout period, expressed in milliseconds, within which the addressed
17 * device must respond or the function will abort.
19 * \section Sec_Migration100219 Migrating from 091223 to 100219
21 * <b>Non-USB Library Components</b>
22 * - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models,
23 * the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used
24 * when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function
25 * is an exception, and should always be called with a channel number rather than a channel mask.
28 * - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
29 * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
30 * pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
31 * flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().
32 * - The Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address
33 * is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint
34 * address against the \ref PIPE_EPNUM_MASK token before calling Pipe_IsEndpointBound().
37 * - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
38 * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
39 * endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
40 * flush the queued event(s) to the host by calling \ref MIDI_Device_Flush().
42 * \section Sec_Migration091223 Migrating from 091122 to 091223
45 * - The Still Image Host Class driver SI_Host_USBTask() and SI_Host_ConfigurePipes() functions were misnamed, and are
46 * now named \ref SImage_Host_USBTask() and \ref SImage_Host_ConfigurePipes() respectively.
47 * - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to \ref HOST_SENDCONTROL_DeviceDisconnected to be in
48 * line with the rest of the library error codes.
49 * - The HID Parser item usages no longer contain seperate minimum and maximum values, as this was a violation of the HID
50 * specification. Instead, the values are distributed evenly across each item as its usage value, to ensure that all items
51 * can be distinguished from oneanother.
54 * - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to
55 * indicate the report type to generate. Existing applications may simply add and ignore this additional parameter.
57 * \section Sec_Migration091122 Migrating from 090924 to 091122
60 * - The HID_PARSE_UsageStackOverflow HID parser error constant is now named \ref HID_PARSE_UsageListOverflow
61 * - The \ref CALLBACK_HIDParser_FilterHIDReportItem() HID Parser callback now passes a complete HID_ReportItem_t to the
62 * user application, instead of just its attributes.
63 * - The USB_GetDeviceConfigDescriptor() function was incorrectly named and is now called \ref USB_Host_GetDeviceConfigDescriptor().
65 * \section Sec_Migration090924 Migrating from 090810 to 090924
67 * <b>Non-USB Library Components</b>
68 * - The ADC_Off() function has been renamed to \ref ADC_ShutDown() to be consistent with the rest of the library.
69 * - The \ref SPI_Init() routine's parameters have changed, so that the clock polarity and data sampling modes can be set. See
70 * the \ref SPI_Init() function documentation for more details
71 * - The \ref Dataflash_Init() routine no longer initializes the SPI bus - the SPI bus should be initialized manually via a
72 * call to SPI_Init() before using the Dataflash driver
75 * - The USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to
76 * preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single
77 * call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user
78 * application perform these intermediatary steps.
79 * - The HID report parser now requires a mandatory callback in the user code, to filter only the items the application
80 * is interested in into the processed HID report item structure to save RAM. See \ref CALLBACK_HIDParser_FilterHIDReportItem().
81 * - The HID report parser now always parses FEATURE and always ignores constant-data items - the HID_ENABLE_FEATURE_PROCESSING
82 * and HID_INCLUDE_CONSTANT_DATA_ITEMS compile time tokens now have no effect.
83 * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now seperate USB_Descriptor_*
84 * and USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
85 * the one project. For existing projects using the standardized names, change all code to use the USB_StdDescriptor_* variants.
88 * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now seperate USB_Descriptor_*
89 * and USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
90 * the one project. For existing projects using the standardized names, change all code to use the USB_StdDescriptor_* variants.
92 * \section Sec_Migration090810 Migrating from 090605 to 090810
95 * - The "Simple Scheduler" has been <i>deprecated</i>, as it was little more than an abtracted loop and caused much confusion.
96 * User applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future
98 * - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never
99 * used in user applications. The library is available from the author's website for those wishing to still use it in their
102 * <b>Non-USB Library Components</b>
103 * - The ATTR_NOINLINE function attribute macro has been renamed to ATTR_NO_INLINE to be in line with the rest of the function attribute
106 * <b>Library Demos</b>
107 * - Most demos now have a corresponding Class Driver implementation, which uses the new internal library class drivers for the standard
108 * USB classes. This allows for more rapid device and host development, and so should be used in preference to the low level APIs where
109 * possible so that fixes to the class drivers propagate to all applications which use them automatically with each new LUFA release.
112 * - The HIDParser.c module has moved from LUFA/Drivers/USB/Class/ to LUFA/Drivers/USB/Class/Host/.
113 * - The USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first
114 * parameter, to add support for multi-configuration devices. Existing code should use a configuration index of 1 to indicate the
115 * first configuration descriptor within the device.
116 * - The non-standard "Ready" host state has been removed. Existing \ref HOST_STATE_Configured code should be moved to the end of
117 * the existing \ref HOST_STATE_Addressed state, and the existing HOST_STATE_Ready state code should be moved to the \ref HOST_STATE_Configured
119 * - The USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_HostState explicitly to ensure the host is
120 * in the desired state instead.
121 * - The USB event names have been changed and their firing conditions changed to properly seperate out Host mode events from Device mode
122 * events. See the \ref Group_Events page for details on the new event names and firing conditions.
125 * - The \ref CALLBACK_USB_GetDescriptor() function now takes an extra parameter to specify the descriptor's memory space so that
126 * descriptors in mixed memory spaces can be used. The previous functionality can be returned by defining the USE_FLASH_DESCRIPTORS
127 * token in the project makefile to fix all descriptors into FLASH space and remove the extra function parameter.
128 * - The USB_IsSuspended global has been removed - test \ref USB_DeviceState against \ref DEVICE_STATE_Suspended instead.
129 * - The USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_DeviceState explicitly to ensure the device
130 * is in the desired state instead.
131 * - The VBUS events have been removed, as they are already exposed to the user via the USB_Connect and USB_Disconnect events.
132 * - The USB event names have been changed and their firing conditions changed to properly seperate out Host mode events from Device mode
133 * events. See the \ref Group_Events page for details on the new event names and firing conditions. *
135 * \section Sec_Migration090605 Migrating from 090510 to 090605
138 * - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing
139 * projects using interrupts on non-control endpoints should switch to polling. For control interrupts, the library can
140 * manage the control endpoint via interrupts automatically by compiling with the INTERRUPT_CONTROL_ENDPOINT token defined.
141 * - The DESCRIPTOR_ADDRESS() macro has been removed. User applications should use normal casts to obtain a descriptor's memory
143 * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
144 * \ref Group_Events for new API details.
145 * - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
146 * function signatures of a function accepting no arguments and returning a uint8_t value.
147 * - The Event_DeviceError() event no longer exists, as its sole caller (unlinked USB_GetDescriptor() function) now produces a
148 * compilation error rather than a runtime error. The StdDescriptors.c file no longer exists as a result, and should be removed
149 * from project makefiles.
150 * - The USB_GetDescriptor() function has been renamed to CALLBACK_USB_GetDescriptor() to be in line with the new CALLBACK_ function
151 * prefixes for functions which *must* be implemented in the user application.
154 * - Support for non-control data pipe interrupts has been dropped due to many issues in the implementation. All existing
155 * projects using interrupts on non-control pipes should switch to polling.
156 * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
157 * \ref Group_Events for new API details.
158 * - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
159 * function signatures of a function accepting no arguments and returning a uint8_t value.
160 * - The DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with
161 * regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a uint8_t value.
164 * \section Sec_Migration090510 Migrating from 090401 to 090510
167 * - The ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all
168 * BUTTLOADTAG elements, or download and extract ButtLoadTag.h header from the ButtLoad project.
169 * - The Drivers/AT90USBXXX directory has been renamed to Drivers/Peripheral.
170 * - The Serial_Stream driver has been renamed to SerialStream to remain consistent with the rest of the library naming scheme.
171 * - The HWB driver has changed to the Buttons driver. See the board Buttons driver documentation for the new API.
173 * <b>Dual Role Mode</b>
174 * - The USB_PowerOnFail even has been renamed to USB_InitFailure.
175 * - The functions in OTG.h have been renamed to remain more consistent with the library API. See the functions in OTG.h for more
178 * <b>Library Demos</b>
179 * - Most demos, bootloaders and applications have had significant changes from previous versions. Applications built off of any
180 * library demos should update to the latest versions.
183 * - The Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the Endpoint_ClearIN(), Endpoint_ClearOUT()
184 * macros. See Endpoint.h documentation for more details on the new endpoint management macros.
185 * - The Endpoint_ReadWriteAllowed() macro has been renamed to Endpoint_IsReadWriteAllowed() to be more consistent with the rest of
186 * the API naming scheme.
187 * - The Endpoint_IsSetupINReady() and Endpoint_IsSetupOutReceived() macros have been renamed to Endpoint_IsINReady() and
188 * Endpoint_IsOUTReceived() respectively.
189 * - The Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived().
190 * - The Endpoint_ClearSetupReceived() macro has been renamed to Endpoint_ClearSETUP().
191 * - All endpoint read/write/discard aliases which did not have an explicitly endianness specifier (such as Endpoint_Read_Word()) have
192 * been removed for clarity. Existing projects should use the "_LE" suffix on such calls to use the explicit Little Endian versions.
193 * - The USB_UnhandledControlPacket event no longer has any parameters. User code should no longer attempt to read in the remainder of
194 * the Control Request header as all Control Request header data is now preloaded by the library and made available in the
195 * USB_ControlRequest structure.
196 * - The FEATURELESS_CONTROL_ONLY_DEVICE token has been renamed to CONTROL_ONLY_DEVICE.
197 * - The STATIC_ENDPOINT_CONFIGURATION is no longer applicable as the library will apply this optimization when appropriate automatically.
198 * - The values of the Endpoint_Stream_RW_ErrorCodes_t and Endpoint_ControlStream_RW_ErrorCodes_t enums have had the "ERROR_" portion
199 * of their names removed.
202 * - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on
203 * other control type pipes. Care should be taken to ensure that the Control pipe is always selected before the function is called
204 * in existing projects where the Control pipe is to be operated on.
205 * - The USB Host management task now saves and restores the currently selected pipe before and after the task runs. Projects no longer
206 * need to manage this manually when calling the USB management task.
207 * - The Pipe_ClearCurrentBank() macro has been removed, and is now replaced with the Pipe_ClearIN(), Pipe_ClearOUT() macros. See
208 * Pipe.h documentation for more details on the new pipe management macros.
209 * - The Pipe_ReadWriteAllowed() macro has been renamed to Pipe_IsReadWriteAllowed() to be more consistent with the rest of the API
211 * - The Pipe_IsSetupINReceived() and Pipe_IsOutReady() macros have been renamed to Pipe_IsINReceived() and Pipe_IsOUTReady()
213 * - The new Pipe_ClearSETUP() macro should be used to send SETUP transactions, rather than the previous Pipe_ClearSetupOUT() macro.
214 * - The Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent().
215 * - The Pipe_ClearSetupSent() macro is no longer applicable and should be removed.
216 * - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as Pipe_Read_Word()) have
217 * been removed for clarity. Existing projects should use the "_LE" suffix on such calls to use the explicit Little Endian versions.
218 * - The Host_IsResetBusDone() macro has been renamed to Host_IsBusResetComplete().
219 * - The Pipe_Ignore_Word() and Pipe_Ignore_DWord() functions have been renamed to Pipe_Discard_Word() and Pipe_Discard_DWord() to remain
220 * consistent with the rest of the pipe API.
221 * - It is no longer needed to manually include the headers from LUFA/Drivers/USB/Class, as they are now included along with the rest
222 * of the USB headers when LUFA/Drivers/USB/USB.h is included.
223 * - Functions in the ConfigDescriptor.h header file no longer have "Host_" as part of their names.
224 * - The ProcessHIDReport() has been renamed to USB_ProcessHIDReport(), GetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo()
225 * and SetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo().
226 * - The values of the DSearch_Return_ErrorCodes_t and DSearch_Comp_Return_ErrorCodes_t enums have had their respective "Descriptor_Search"
227 * and "Descriptor_Search_Comp" prefixes changed to all caps.
228 * - The USB_HostRequest global has been renamed to USB_ControlRequest, and is used in Device mode also. The USB_Host_Request_Header_t
229 * structure type has been renamed to USB_Request_Header_t.
230 * - The values of the Pipe_Stream_RW_ErrorCodes_t enum have had the "ERROR_" portion of their names removed.
233 * \section Sec_Migration090401 Migrating from 090209 to 090401
236 * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant "F_CLOCK",
237 * defined in the project makefile and passed to the compiler via the -D switch.
238 * - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the
239 * EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called.
240 * - As the avr-libc macro has been corrected in recent avr-libc distributions, the SetSystemClockPrescaler() macro has been removed.
241 * Include <avr/power.h> and call clock_prescale_set(clock_div_1); instead on recent avr-libc distributions.
243 * <b>Library Demos</b>
244 * - The USBtoSerial demo now discards all data when not connected to a host, rather than buffering it for later transmission.
245 * - Most demos, bootloaders and applications have had their control request handling code corrected, to properly send the status
246 * stage in all handled requests. If you are using code based off one of the library demos, bootloaders or applications, you should
247 * update to the latest revisions.
249 * <b>Non-USB Library Components</b>
250 * - The ATTR_ALWAYSINLINE function attribute macro has been renamed to ATTR_ALWAYS_INLINE.
251 * - Custom board Dataflash drivers now require the implementation of Dataflash_SelectChipFromPage() and Dataflash_SendAddressBytes().
254 * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
255 * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the
256 * NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further
257 * modifications required.
260 * \section Sec_Migration090209 Migrating from 081217 to 090209
263 * - The ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of ENDPOINT_TOTAL_ENDPOINTS.
264 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
265 * makefile if desired to restore the previous 50ms timeout.
268 * - The PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of PIPE_TOTAL_ENDPOINTS.
269 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
270 * makefile if desired to restore the previous 50ms timeout.
271 * - The USB_DeviceEnumerationFailed event now contains a second "SubErrorCode" parameter, giving the error code of the function
273 * - The HID_PARSE_Sucessful enum member constant has been corrected to HID_PARSE_Successful.
275 * <b>Non-USB Library Components</b>
276 * - The previous SPI_SendByte() functionality is now located in SPI_TransferByte(). SPI_SendByte() now discards the return byte
277 * for speed, to compliment the new SPI_ReceiveByte() function. If two-way SPI transfers are required, calls to SPI_SendByte()
278 * should be changed to SPI_TransferByte().
279 * - The serial driver now sets the Tx line as an output explicitly, and enables the pullup of the Rx line.
280 * - The Serial_Init() and SerialStream_Init() functions now take a second DoubleSpeed parameter, which indicates if the USART
281 * should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at
282 * the given AVR clock speed.
284 * <b>Library Demos</b>
285 * - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to
286 * the latest demo versions.
289 * \section Sec_Migration171208 Migrating from V1.5.3 to 081217
292 * - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names,
293 * have been changed to LUFA.
295 * <b>Library Demos</b>
296 * - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding
297 * parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version.
298 * - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and
299 * KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects
300 * built on either "WithParser" demo should update to the latest code.
301 * - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not
302 * recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes,
303 * as it is neither a full nor a standards compliant implementation.
305 * <b>Non-USB Library Components</b>
306 * - The Serial_IsCharReceived() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
309 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
310 * to be used in the Options parameter of the USB_Init() function.
311 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
312 * currently initialized.
313 * - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library
314 * or user request processing code to exceed the strict USB timing requirements on control transfers.
315 * - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured
316 * after a Reset event, it should be altered to explicitly re-initialize all user endpoints.
317 * - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now
318 * returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified
319 * descriptor does not exist.
320 * - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the
321 * GetDescriptor function.
324 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
325 * to be used in the Options parameter of the USB_Init() function.
326 * - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and
327 * SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the
328 * current report. If sending a report to a multi-report device, the first byte of the report is automatically
329 * set to the report ID of the given report item.
330 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
331 * currently initialized.
334 * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3
336 * <b>Library Demos</b>
337 * - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number
338 * string is required in Mass Storage devices, or devices which are to retain settings when moved between
339 * ports on a machine. As people were not changing the serial number value, this was causing conflicts and so
340 * the serial number descriptor has been removed from all but the Mass Storage demo, which requires it.
341 * - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated
342 * them. Projects built upon either demo should upgrade to the latest code.
343 * - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented.
344 * - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built
345 * on the MassStoreDemo code should update to the latest version.
346 * - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused
347 * problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade
348 * to the latest code.
349 * - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects
350 * built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code.
351 * - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should
352 * upgrade to the latest code.
353 * - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was
354 * previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update
355 * to the latest code.
358 * - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream.
359 * If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The
360 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
361 * timeout duration in ms.
362 * - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled
363 * and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and
364 * USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details.
365 * - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated
366 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
367 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
370 * - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream.
371 * If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The
372 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
373 * timeout duration in ms.
374 * - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures.
375 * - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated
376 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
377 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
380 * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2
382 * <b>Library Demos</b>
383 * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
384 * of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
385 * to the latest code.
386 * - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
387 * possible any existing devices upgrade to the latest bootloader code.
390 * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1
392 * <b>Library Demos</b>
393 * - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the
394 * global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo
395 * should upgrade to the latest code.
396 * - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID
397 * demos should upgrade to the latest code.
398 * - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors.
399 * Projects built upon the HID demos should upgrade to the latest code.
400 * - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo
401 * should upgrade to the latest code.
402 * - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power.
403 * Projects built upon the AudioOut demo should upgrade to the latest code.
406 * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0
408 * <b>Library Demos</b>
409 * - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To
410 * avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing
411 * projects should at least manually correct the BCD version numbers, or preferably update the descriptors to
412 * encode the version number in BCD format using the new macro.
413 * - The mandatory GetReport class-specific request was accidentally omitted from previous versions of the demos
414 * based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the
415 * HID demos should also be updated accordingly.
416 * - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission.
417 * Failure to do this on projects which always or frequently send full packets will cause buffering issues on
418 * the host OS. All CDC user projects are advised to update their transmission routines in the same manner as
419 * the library CDC demos.
420 * - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected
421 * Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven
422 * demos should also update to properly save and restore the selected Endpoint/Pipe.
424 * <b>Non-USB Library Components</b>
425 * - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only
426 * compatible with avr-libc library versions newer than the time before the functionality of the deleted
427 * headers was available.
430 * - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and
431 * functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API.
432 * The previously split Type and Index parameters are now passed as the original wValue parameter to the
433 * function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the
434 * previous Index parameter.
435 * - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the
436 * official USB specification. Existing code will need to be altered to use the new parameter names.
437 * - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more
438 * appropriate. It fires in an identical manner to the previously named event, thus the only change to be made
439 * is the event name itself in the user project.
440 * - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a
441 * pseudo-descriptor modelled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type
442 * descriptor as indicated in the USB specification, thus all device code must be updated accordingly.
443 * - The names of several Endpoint macros have been changed to be more consistent with the rest of the library,
444 * with no implementation changes. This means that existing code can be altered to use the new macro names
445 * with no other considerations required. See Endpoint.h for the new macro names.
446 * - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t
447 * structure named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this
448 * demo should correct the structure value to maintain compatibility across multiple OS platforms.
449 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
450 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
451 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
452 * documentation for more details.
455 * - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its
456 * members renamed to the official USB specification names for requests. Existing code will need to be updated
457 * to use the new names.
458 * - The names of several Pipe macros have been changed to be more consistent with the rest of the library,
459 * with no implementation changes. This means that existing code can be altered to use the new macro names
460 * with no other considerations required. See Pipe.h for the new macro names.
461 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
462 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
463 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
464 * documentation for more details.
465 * - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h
466 * module documentation for the new macro names.
468 * <b>Dual Role Mode</b>
469 * - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing
470 * projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG
471 * header inside the library.
472 * - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has
473 * finished enumerating the device. Projects relying on the event only firing in Host mode should be updated
474 * so that the event action only occurs when the USB_Mode global is set to USB_MODE_HOST.
projects / pub / USBasp.git / blob