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