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 101122 to XXXXXX
14 * <b>Non-USB Library Components</b>
15 * - The TWI driver \ref TWI_StartTransmission() function return type has now changed, so that the function returns an
16 * error code from the \ref TWI_ErrorCodes_t enum instead of a boolean success flag. Existing code must now check
17 * against the \ref TWI_ERROR_NoError return value for success instead of a boolean true value, or it will not function
21 * - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of
22 * reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimise the compiled program
23 * size, the new ORDERED_EP_CONFIG compile time option may be defined in the project makefile to restrict the ordering
24 * in exchange for a smaller compiled binary size.
27 * - The Endpoint stream functions now all require a BytesProcessed parameter instead of the previous callback parameter.
28 * This should be set to NULL to retain previous behaviour of the functions, or point to a location where the number of bytes
29 * processed in the current transaction can be stored. If the BytesProcessed parameter is non-NULL, each time the endpoint
30 * bank becomes full and the packet is sent, the routine will exit with the new \ref ENDPOINT_RWSTREAM_IncompleteTransfer
31 * error code to allow the user application to determine when to send the next chunk of data.
34 * - The Pipe stream functions now all require a BytesProcessed parameter instead of the previous callback parameter.
35 * This should be set to NULL to retain previous behaviour of the functions, or point to a location where the number of bytes
36 * processed in the current transaction can be stored. If the BytesProcessed parameter is non-NULL, each time the pipe
37 * bank becomes full and the packet is sent, the routine will exit with the new \ref PIPE_RWSTREAM_IncompleteTransfer
38 * error code to allow the user application to determine when to send the next chunk of data.
40 * \section Sec_Migration101122 Migrating from 100807 to 101122
42 * - A new USB driver source file, Drivers/USB/HighLevel/EndpointStream.c now exists. This source file should be added
43 * to all project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source
45 * - A new USB driver source file, Drivers/USB/HighLevel/PipeStream.c now exists. This source file should be added to all
46 * project makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables.
47 * - The EVENT_USB_InitFailure() event has been removed, as the USB_Init() function will no longer fail; if not USB mode is
48 * specified, the controller will default to UID selection mode.
49 * - The USB mode specifier constants have been moved into a new enum and renamed. Existing projects should use the equivalent
50 * value in the new \ref USB_Modes_t enum.
51 * - All class driver headers are now included as part of the standard LUFA/Drivers/USB/USB.h master dispatch header, and should
52 * no longer be included separately. Class driver module source files must still be added as a separate module in the project's
56 * - Endpoints MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application
57 * allocated endpoints in ascending order - or if your application uses the USB device mode class drivers, ensure that each instance's
58 * endpoint indexes are not overlapped with other interface's endpoints.
59 * - The signature for the CALLBACK_USB_GetDescriptor() callback has changed, the "void** const DescriptorAddress" parameter is
60 * now "const void** const DescriptorAddress". Existing applications should update their callback signatures to match this, and
61 * eliminate any casting of descriptor pointers to a non-const pointer.
62 * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation
63 * for each class driver for the new class specific descriptor type names.
64 * - The ENDPOINT_DOUBLEBANK_SUPPORTED() macro is has been renamed \ref ENDPOINT_BANKS_SUPPORTED() and now returns the total number of
65 * banks supported by the given endpoint. Existing code should switch to the new naming scheme, and test that the return value of the
66 * macro is equal to or greater than 2 to regain the previous functionality.
67 * - The EVENT_USB_Device_UnhandledControlRequest() event is now named \ref EVENT_USB_Device_ControlRequest() and fires before (not after)
68 * the internal library event handlers. Existing code should rename the event handlers in the user application to match the new event
69 * name, and should ensure that the new execution order does not affect the application's operation.
72 * - Pipes MUST be allocated in ascending order to ensure that bank corruption does not occur. Ensure that your user application
73 * allocated pipes in ascending order - or if your application uses the USB host mode class drivers, ensure that each instance's
74 * pipe indexes are not overlapped with other interface's pipes.
75 * - The PRNT_Host_SendData() function has been renamed to \ref PRNT_Host_SendString(). Existing applications should simply
76 * replace all references to the obsolete function name with the new function name.
77 * - The names of the class specific descriptor type defines in the USB Class drivers have changed - refer to the driver documentation
78 * for each class driver for the new class specific descriptor type names.
79 * - The Still Image Host class' function prefix has been changed from "SImage_" to "SI_", to remain consistent with the rest of the
80 * driver's enums, type defines and constants.
82 * \section Sec_Migration100807 Migrating from 100513 to 100807
84 * <b>Non-USB Library Components</b>
85 * - The Dataflash board driver stub file has changed, as dataflash functions previously located in the internal
86 * Dataflash driver of the library have now been moved to the individual board files. Existing drivers can
87 * copy-paste the new functions from the board Dataflash stub driver.
90 * - A new USB driver source file, Drivers/USB/LowLevel/Device.c now exists. This source file should be added to all project
91 * makefiles using the USB driver of LUFA, or the makefile should be updated to use the new module source variables.
92 * - The Drivers/USB/LowLevel/DevChapter9.c source file has moved to Drivers/USB/HighLevel/DeviceStandardReq.c - this should
93 * be updated in all project makefiles, or the makefile should be updated to use the new module source variables.
94 * - The Drivers/USB/LowLevel/HostChapter9.h source file has moved to Drivers/USB/HighLevel/HostStandardReq.c - this should
95 * be updated in all project makefiles, or the makefile should be updated to use the new module source variables.
96 * - The Drivers/USB/LowLevel/LowLevel.c source file has moved to Drivers/LowLevel/USBController.c - this should be updated
97 * in all project makefiles, or the makefile should be updated to use the new module source variables.
100 * - The USB_Device_IsRemoteWakeupSent() macro has been removed, as the remote wakeup request is now fully handled by the
101 * enhanced \ref USB_Device_SendRemoteWakeup() function. Existing code may now discard any checks to USB_Device_IsRemoteWakeupSent().
102 * - The USB_Device_IsUSBSuspended() macro has been removed, as it is obsolete. Existing code should compare \ref USB_DeviceState
103 * to see if it the device is in the \ref DEVICE_STATE_Suspended state instead.
104 * - The \ref CDC_Device_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
105 * received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact
106 * number of queued bytes received is not needed.
109 * - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
110 * received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact
111 * number of queued bytes received is not needed.
112 * - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual
113 * flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask().
115 * \section Sec_Migration100513 Migrating from 100219 to 100513
117 * <b>Non-USB Library Components</b>
118 * - The \ref TWI_StartTransmission() function now takes in a timeout period, expressed in milliseconds, within which the addressed
119 * device must respond or the function will abort.
122 * - The \ref USB_Init() function no longer calls sei() to enable global interrupts, as the user application may need
123 * to perform other initialization before it is ready to handle global interrupts. The user application is now responsible
124 * for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process
125 * functions correctly.
126 * - The USBInterrupt.c USB driver source file has been relocated from LUFA/Drivers/USB/HighLevel/ to LUFA/Drivers/USB/LowLevel.
127 * Projects must update their makefile SRC values accordingly.
128 * - The HID Device Class driver's function signature for the CALLBACK_HID_Device_ProcessHIDReport() function has been changed, to
129 * allow for a new ReportType parameter. This new parameter must be added in all user applications using the Device mode HID Class
130 * Driver, but may be ignored unless Host-to-Device FEATURE HID reports are used.
133 * - The \ref USB_Init() function no longer calls sei() to enable global interrupts, as the user application may need
134 * to perform other initialization before it is ready to handle global interrupts. The user application is now responsible
135 * for enabling global interrupts before or shortly after calling \ref USB_Init() to ensure that the enumeration process
136 * functions correctly.
137 * - The USBInterrupt.c USB driver source file has been relocated from LUFA/Drivers/USB/HighLevel/ to LUFA/Drivers/USB/LowLevel.
138 * Projects must update their makefile SRC values accordingly.
139 * - The HID Host Class driver's function signature for the HID_Host_SendReportByID() function has been changed, to allow for a new
140 * ReportType parameter. Existing calls to this function should substitute REPORT_ITEM_TYPE_Out as this parameter's value.
142 * \section Sec_Migration100219 Migrating from 091223 to 100219
144 * <b>Non-USB Library Components</b>
145 * - Due to some ADC channels not being identical to their ADC MUX selection masks for single-ended conversions on some AVR models,
146 * the ADC driver now has explicit masks for each of the standard ADC channels (see \ref Group_ADC). These masks should be used
147 * when calling the ADC functions to ensure proper operation across all AVR models. Note that the \ref ADC_SetupChannel() function
148 * is an exception, and should always be called with a channel number rather than a channel mask.
151 * - The MIDI Host Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
152 * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
153 * pipe bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
154 * flush the queued event(s) to the device by calling \ref MIDI_Host_Flush().
155 * - The Pipe_IsEndpointBound() function now takes the endpoint's direction into account, by checking if the MSB of the endpoint's address
156 * is set to denote IN endpoints. If the previous functionality where the direction is to be discounted is required, mask the endpoint
157 * address against the \ref PIPE_EPNUM_MASK token before calling Pipe_IsEndpointBound().
160 * - The MIDI Device Class driver send and receive routines now operate on packed events, where multiple MIDI events may be
161 * packed into a single USB packet. This means that the sending of MIDI events will now be delayed until the MIDI send
162 * endpoint bank is full. To override this new behaviour and revert to the previous behaviour, the user application may manually
163 * flush the queued event(s) to the host by calling \ref MIDI_Device_Flush().
165 * \section Sec_Migration091223 Migrating from 091122 to 091223
168 * - The Still Image Host Class driver SI_Host_USBTask() and SI_Host_ConfigurePipes() functions were misnamed, and are
169 * now named SImage_Host_USBTask() and SImage_Host_ConfigurePipes() respectively.
170 * - The HOST_SENDCONTROL_DeviceDisconnect enum value has been renamed to \ref HOST_SENDCONTROL_DeviceDisconnected to be in
171 * line with the rest of the library error codes.
172 * - The HID Parser item usages no longer contain separate minimum and maximum values, as this was a violation of the HID
173 * specification. Instead, the values are distributed evenly across each item as its usage value, to ensure that all items
174 * can be distinguished from one-another.
177 * - The CALLBACK_HID_Device_CreateHIDReport() HID Device Class driver callback now has a new ReportType parameter to
178 * indicate the report type to generate. Existing applications may simply add and ignore this additional parameter.
180 * \section Sec_Migration091122 Migrating from 090924 to 091122
183 * - The HID_PARSE_UsageStackOverflow HID parser error constant is now named \ref HID_PARSE_UsageListOverflow
184 * - The \ref CALLBACK_HIDParser_FilterHIDReportItem() HID Parser callback now passes a complete HID_ReportItem_t to the
185 * user application, instead of just its attributes.
186 * - The USB_GetDeviceConfigDescriptor() function was incorrectly named and is now called \ref USB_Host_GetDeviceConfigDescriptor().
188 * \section Sec_Migration090924 Migrating from 090810 to 090924
190 * <b>Non-USB Library Components</b>
191 * - The ADC_Off() function has been renamed to \ref ADC_ShutDown() to be consistent with the rest of the library.
192 * - The \ref SPI_Init() routine's parameters have changed, so that the clock polarity and data sampling modes can be set. See
193 * the \ref SPI_Init() function documentation for more details
194 * - The \ref Dataflash_Init() routine no longer initializes the SPI bus - the SPI bus should be initialized manually via a
195 * call to SPI_Init() before using the Dataflash driver
198 * - The USB_GetDeviceConfigDescriptor() function's parameters and behaviour has changed; the user is required to
199 * preallocate the largest allowable buffer, and pass the size of the buffer to the function. This allows for a single
200 * call to the function to retrieve, size check and validate the Configuration Descriptor rather than having the user
201 * application perform these intermediary steps.
202 * - The HID report parser now requires a mandatory callback in the user code, to filter only the items the application
203 * is interested in into the processed HID report item structure to save RAM. See \ref CALLBACK_HIDParser_FilterHIDReportItem().
204 * - The HID report parser now always parses FEATURE and always ignores constant-data items - the HID_ENABLE_FEATURE_PROCESSING
205 * and HID_INCLUDE_CONSTANT_DATA_ITEMS compile time tokens now have no effect.
206 * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate USB_Descriptor_*
207 * and USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
208 * the one project. For existing projects using the standardized names, change all code to use the USB_StdDescriptor_* variants.
211 * - The USE_NONSTANDARD_DESCRIPTOR_NAMES compile time token has been removed - there are now separate USB_Descriptor_*
212 * and USB_StdDescriptor_* structures for both the LUFA and standardized element naming conventions so that both may be used in
213 * the one project. For existing projects using the standardized names, change all code to use the USB_StdDescriptor_* variants.
215 * \section Sec_Migration090810 Migrating from 090605 to 090810
218 * - The "Simple Scheduler" has been <i>deprecated</i>, as it was little more than an abstracted loop and caused much confusion.
219 * User applications using the scheduler should switch to regular loops instead. The scheduler code will be removed in a future
221 * - The "Dynamic Memory Block Allocator" has been removed, as it was unused in (and unrelated to) the LUFA library and never
222 * used in user applications. The library is available from the author's website for those wishing to still use it in their
225 * <b>Non-USB Library Components</b>
226 * - The ATTR_NOINLINE function attribute macro has been renamed to ATTR_NO_INLINE to be in line with the rest of the function attribute
229 * <b>Library Demos</b>
230 * - Most demos now have a corresponding Class Driver implementation, which uses the new internal library class drivers for the standard
231 * USB classes. This allows for more rapid device and host development, and so should be used in preference to the low level APIs where
232 * possible so that fixes to the class drivers propagate to all applications which use them automatically with each new LUFA release.
235 * - The HIDParser.c module has moved from LUFA/Drivers/USB/Class/ to LUFA/Drivers/USB/Class/Host/.
236 * - The USB_GetDeviceConfigDescriptor() function now requires the desired configuration index within the device as its first
237 * parameter, to add support for multi-configuration devices. Existing code should use a configuration index of 1 to indicate the
238 * first configuration descriptor within the device.
239 * - The non-standard "Ready" host state has been removed. Existing \ref HOST_STATE_Configured code should be moved to the end of
240 * the existing \ref HOST_STATE_Addressed state, and the existing HOST_STATE_Ready state code should be moved to the \ref HOST_STATE_Configured
242 * - 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
243 * in the desired state instead.
244 * - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode
245 * events. See the \ref Group_Events page for details on the new event names and firing conditions.
248 * - The \ref CALLBACK_USB_GetDescriptor() function now takes an extra parameter to specify the descriptor's memory space so that
249 * descriptors in mixed memory spaces can be used. The previous functionality can be returned by defining the USE_FLASH_DESCRIPTORS
250 * token in the project makefile to fix all descriptors into FLASH space and remove the extra function parameter.
251 * - The USB_IsSuspended global has been removed - test \ref USB_DeviceState against \ref DEVICE_STATE_Suspended instead.
252 * - The USB_IsConnected global has been removed, as it is too vague for general use. Test \ref USB_DeviceState explicitly to ensure the device
253 * is in the desired state instead.
254 * - The VBUS events have been removed, as they are already exposed to the user via the USB_Connect and USB_Disconnect events.
255 * - The USB event names have been changed and their firing conditions changed to properly separate out Host mode events from Device mode
256 * events. See the \ref Group_Events page for details on the new event names and firing conditions. *
258 * \section Sec_Migration090605 Migrating from 090510 to 090605
261 * - Support for non-control data endpoint interrupts has been dropped due to many issues in the implementation. All existing
262 * projects using interrupts on non-control endpoints should switch to polling. For control interrupts, the library can
263 * manage the control endpoint via interrupts automatically by compiling with the INTERRUPT_CONTROL_ENDPOINT token defined.
264 * - The DESCRIPTOR_ADDRESS() macro has been removed. User applications should use normal casts to obtain a descriptor's memory
266 * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
267 * \ref Group_Events for new API details.
268 * - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
269 * function signatures of a function accepting no arguments and returning a uint8_t value.
270 * - The Event_DeviceError() event no longer exists, as its sole caller (unlinked USB_GetDescriptor() function) now produces a
271 * compilation error rather than a runtime error. The StdDescriptors.c file no longer exists as a result, and should be removed
272 * from project makefiles.
273 * - The USB_GetDescriptor() function has been renamed to CALLBACK_USB_GetDescriptor() to be in line with the new CALLBACK_ function
274 * prefixes for functions which *must* be implemented in the user application.
277 * - Support for non-control data pipe interrupts has been dropped due to many issues in the implementation. All existing
278 * projects using interrupts on non-control pipes should switch to polling.
279 * - The library events system has been rewritten, so that all macros have been removed to allow for clearer user code. See
280 * \ref Group_Events for new API details.
281 * - The STREAM_CALLBACK() macro has been removed. User applications should replace all instances of the macro with regular
282 * function signatures of a function accepting no arguments and returning a uint8_t value.
283 * - The DESCRIPTOR_COMPARATOR() macro has been removed. User applications should replace all instances of the macro with
284 * regular function signatures of a function accepting a void pointer to the descriptor to test, and returning a uint8_t value.
286 * \section Sec_Migration090510 Migrating from 090401 to 090510
289 * - The ButtLoadTag.h header has been removed, as it was never used for its intended purpose. Projects should either remove all
290 * BUTTLOADTAG elements, or download and extract ButtLoadTag.h header from the ButtLoad project.
291 * - The Drivers/AT90USBXXX directory has been renamed to Drivers/Peripheral.
292 * - The Serial_Stream driver has been renamed to SerialStream to remain consistent with the rest of the library naming scheme.
293 * - The HWB driver has changed to the Buttons driver. See the board Buttons driver documentation for the new API.
295 * <b>Dual Role Mode</b>
296 * - The USB_PowerOnFail even has been renamed to USB_InitFailure.
297 * - The functions in OTG.h have been renamed to remain more consistent with the library API. See the functions in OTG.h for more
300 * <b>Library Demos</b>
301 * - Most demos, bootloaders and applications have had significant changes from previous versions. Applications built off of any
302 * library demos should update to the latest versions.
305 * - The Endpoint_ClearCurrentBank() macro has been removed, and is now replaced with the Endpoint_ClearIN(), Endpoint_ClearOUT()
306 * macros. See Endpoint.h documentation for more details on the new endpoint management macros.
307 * - The Endpoint_ReadWriteAllowed() macro has been renamed to Endpoint_IsReadWriteAllowed() to be more consistent with the rest of
308 * the API naming scheme.
309 * - The Endpoint_IsSetupINReady() and Endpoint_IsSetupOutReceived() macros have been renamed to Endpoint_IsINReady() and
310 * Endpoint_IsOUTReceived() respectively.
311 * - The Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived().
312 * - The Endpoint_ClearSetupReceived() macro has been renamed to Endpoint_ClearSETUP().
313 * - All endpoint read/write/discard aliases which did not have an explicitly endianness specifier (such as Endpoint_Read_Word()) have
314 * been removed for clarity. Existing projects should use the "_LE" suffix on such calls to use the explicit Little Endian versions.
315 * - The USB_UnhandledControlPacket event no longer has any parameters. User code should no longer attempt to read in the remainder of
316 * the Control Request header as all Control Request header data is now preloaded by the library and made available in the
317 * USB_ControlRequest structure.
318 * - The FEATURELESS_CONTROL_ONLY_DEVICE token has been renamed to CONTROL_ONLY_DEVICE.
319 * - The STATIC_ENDPOINT_CONFIGURATION is no longer applicable as the library will apply this optimization when appropriate automatically.
320 * - The values of the Endpoint_Stream_RW_ErrorCodes_t and Endpoint_ControlStream_RW_ErrorCodes_t enums have had the "ERROR_" portion
321 * of their names removed.
324 * - The USB_Host_SendControlRequest() function no longer automatically selects the Control pipe (pipe 0) to allow it to be used on
325 * other control type pipes. Care should be taken to ensure that the Control pipe is always selected before the function is called
326 * in existing projects where the Control pipe is to be operated on.
327 * - The USB Host management task now saves and restores the currently selected pipe before and after the task runs. Projects no longer
328 * need to manage this manually when calling the USB management task.
329 * - The Pipe_ClearCurrentBank() macro has been removed, and is now replaced with the Pipe_ClearIN(), Pipe_ClearOUT() macros. See
330 * Pipe.h documentation for more details on the new pipe management macros.
331 * - The Pipe_ReadWriteAllowed() macro has been renamed to Pipe_IsReadWriteAllowed() to be more consistent with the rest of the API
333 * - The Pipe_IsSetupINReceived() and Pipe_IsOutReady() macros have been renamed to Pipe_IsINReceived() and Pipe_IsOUTReady()
335 * - The new Pipe_ClearSETUP() macro should be used to send SETUP transactions, rather than the previous Pipe_ClearSetupOUT() macro.
336 * - The Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent().
337 * - The Pipe_ClearSetupSent() macro is no longer applicable and should be removed.
338 * - All pipe read/write/discard aliases which did not have an explicitly endianness specifier (such as Pipe_Read_Word()) have
339 * been removed for clarity. Existing projects should use the "_LE" suffix on such calls to use the explicit Little Endian versions.
340 * - The Host_IsResetBusDone() macro has been renamed to Host_IsBusResetComplete().
341 * - The Pipe_Ignore_Word() and Pipe_Ignore_DWord() functions have been renamed to Pipe_Discard_Word() and Pipe_Discard_DWord() to remain
342 * consistent with the rest of the pipe API.
343 * - It is no longer needed to manually include the headers from LUFA/Drivers/USB/Class, as they are now included along with the rest
344 * of the USB headers when LUFA/Drivers/USB/USB.h is included.
345 * - Functions in the ConfigDescriptor.h header file no longer have "Host_" as part of their names.
346 * - The ProcessHIDReport() has been renamed to USB_ProcessHIDReport(), GetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo()
347 * and SetReportItemInfo() has been renamed to USB_GetHIDReportItemInfo().
348 * - The values of the DSearch_Return_ErrorCodes_t and DSearch_Comp_Return_ErrorCodes_t enums have had their respective "Descriptor_Search"
349 * and "Descriptor_Search_Comp" prefixes changed to all caps.
350 * - The USB_HostRequest global has been renamed to USB_ControlRequest, and is used in Device mode also. The USB_Host_Request_Header_t
351 * structure type has been renamed to USB_Request_Header_t.
352 * - The values of the Pipe_Stream_RW_ErrorCodes_t enum have had the "ERROR_" portion of their names removed.
354 * \section Sec_Migration090401 Migrating from 090209 to 090401
357 * - LUFA projects must now give the raw input clock frequency (before any prescaling) as a compile time constant "F_CLOCK",
358 * defined in the project makefile and passed to the compiler via the -D switch.
359 * - The makefile EEPROM programming targets for FLIP and dfu-programmer no longer program in the FLASH data in addition to the
360 * EEPROM data into the device. If both are to be programmed, both the EEPROM and FLASH programming targets must be called.
361 * - As the avr-libc macro has been corrected in recent avr-libc distributions, the SetSystemClockPrescaler() macro has been removed.
362 * Include <avr/power.h> and call clock_prescale_set(clock_div_1); instead on recent avr-libc distributions.
364 * <b>Library Demos</b>
365 * - The USBtoSerial demo now discards all data when not connected to a host, rather than buffering it for later transmission.
366 * - Most demos, bootloaders and applications have had their control request handling code corrected, to properly send the status
367 * stage in all handled requests. If you are using code based off one of the library demos, bootloaders or applications, you should
368 * update to the latest revisions.
370 * <b>Non-USB Library Components</b>
371 * - The ATTR_ALWAYSINLINE function attribute macro has been renamed to ATTR_ALWAYS_INLINE.
372 * - Custom board Dataflash drivers now require the implementation of Dataflash_SelectChipFromPage() and Dataflash_SendAddressBytes().
375 * - The NO_CLEARSET_FEATURE_REQUEST compile time token has been renamed to FEATURELESS_CONTROL_ONLY_DEVICE, and its function expanded
376 * to also remove parts of the Get Status chapter 9 request to further reduce code usage. On all applications currently using the
377 * NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further
378 * modifications required.
380 * \section Sec_Migration090209 Migrating from 081217 to 090209
383 * - The ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of ENDPOINT_TOTAL_ENDPOINTS.
384 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
385 * makefile if desired to restore the previous 50ms timeout.
388 * - The PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of PIPE_TOTAL_ENDPOINTS.
389 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
390 * makefile if desired to restore the previous 50ms timeout.
391 * - The USB_DeviceEnumerationFailed event now contains a second "SubErrorCode" parameter, giving the error code of the function
393 * - The HID_PARSE_Sucessful enum member constant has been corrected to HID_PARSE_Successful.
395 * <b>Non-USB Library Components</b>
396 * - The previous SPI_SendByte() functionality is now located in SPI_TransferByte(). SPI_SendByte() now discards the return byte
397 * for speed, to compliment the new SPI_ReceiveByte() function. If two-way SPI transfers are required, calls to SPI_SendByte()
398 * should be changed to SPI_TransferByte().
399 * - The serial driver now sets the Tx line as an output explicitly, and enables the pull-up of the Rx line.
400 * - The Serial_Init() and SerialStream_Init() functions now take a second DoubleSpeed parameter, which indicates if the USART
401 * should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at
402 * the given AVR clock speed.
404 * <b>Library Demos</b>
405 * - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to
406 * the latest demo versions.
408 * \section Sec_Migration171208 Migrating from V1.5.3 to 081217
411 * - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names,
412 * have been changed to LUFA.
414 * <b>Library Demos</b>
415 * - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding
416 * parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version.
417 * - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and
418 * KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects
419 * built on either "WithParser" demo should update to the latest code.
420 * - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not
421 * recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes,
422 * as it is neither a full nor a standards compliant implementation.
424 * <b>Non-USB Library Components</b>
425 * - The Serial_IsCharReceived() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
428 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
429 * to be used in the Options parameter of the USB_Init() function.
430 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
431 * currently initialized.
432 * - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library
433 * or user request processing code to exceed the strict USB timing requirements on control transfers.
434 * - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured
435 * after a Reset event, it should be altered to explicitly re-initialize all user endpoints.
436 * - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now
437 * returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified
438 * descriptor does not exist.
439 * - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the
440 * GetDescriptor function.
443 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
444 * to be used in the Options parameter of the USB_Init() function.
445 * - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and
446 * SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the
447 * current report. If sending a report to a multi-report device, the first byte of the report is automatically
448 * set to the report ID of the given report item.
449 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
450 * currently initialized.
452 * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3
454 * <b>Library Demos</b>
455 * - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number
456 * string is required in Mass Storage devices, or devices which are to retain settings when moved between
457 * ports on a machine. As people were not changing the serial number value, this was causing conflicts and so
458 * the serial number descriptor has been removed from all but the Mass Storage demo, which requires it.
459 * - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated
460 * them. Projects built upon either demo should upgrade to the latest code.
461 * - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented.
462 * - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built
463 * on the MassStoreDemo code should update to the latest version.
464 * - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused
465 * problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade
466 * to the latest code.
467 * - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects
468 * built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code.
469 * - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should
470 * upgrade to the latest code.
471 * - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was
472 * previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update
473 * to the latest code.
476 * - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream.
477 * If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The
478 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
479 * timeout duration in ms.
480 * - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled
481 * and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and
482 * USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details.
483 * - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated
484 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
485 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
488 * - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream.
489 * If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The
490 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
491 * timeout duration in ms.
492 * - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures.
493 * - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated
494 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by passing
495 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
497 * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2
499 * <b>Library Demos</b>
500 * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
501 * of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
502 * to the latest code.
503 * - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
504 * possible any existing devices upgrade to the latest bootloader code.
506 * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1
508 * <b>Library Demos</b>
509 * - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the
510 * global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo
511 * should upgrade to the latest code.
512 * - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID
513 * demos should upgrade to the latest code.
514 * - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors.
515 * Projects built upon the HID demos should upgrade to the latest code.
516 * - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo
517 * should upgrade to the latest code.
518 * - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power.
519 * Projects built upon the AudioOut demo should upgrade to the latest code.
521 * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0
523 * <b>Library Demos</b>
524 * - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To
525 * avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing
526 * projects should at least manually correct the BCD version numbers, or preferably update the descriptors to
527 * encode the version number in BCD format using the new macro.
528 * - The mandatory GetReport class-specific request was accidentally omitted from previous versions of the demos
529 * based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the
530 * HID demos should also be updated accordingly.
531 * - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission.
532 * Failure to do this on projects which always or frequently send full packets will cause buffering issues on
533 * the host OS. All CDC user projects are advised to update their transmission routines in the same manner as
534 * the library CDC demos.
535 * - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected
536 * Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven
537 * demos should also update to properly save and restore the selected Endpoint/Pipe.
539 * <b>Non-USB Library Components</b>
540 * - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only
541 * compatible with avr-libc library versions newer than the time before the functionality of the deleted
542 * headers was available.
545 * - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and
546 * functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API.
547 * The previously split Type and Index parameters are now passed as the original wValue parameter to the
548 * function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the
549 * previous Index parameter.
550 * - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the
551 * official USB specification. Existing code will need to be altered to use the new parameter names.
552 * - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more
553 * appropriate. It fires in an identical manner to the previously named event, thus the only change to be made
554 * is the event name itself in the user project.
555 * - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a
556 * pseudo-descriptor modeled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type
557 * descriptor as indicated in the USB specification, thus all device code must be updated accordingly.
558 * - The names of several Endpoint macros have been changed to be more consistent with the rest of the library,
559 * with no implementation changes. This means that existing code can be altered to use the new macro names
560 * with no other considerations required. See Endpoint.h for the new macro names.
561 * - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t
562 * structure named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this
563 * demo should correct the structure value to maintain compatibility across multiple OS platforms.
564 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
565 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
566 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
567 * documentation for more details.
570 * - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its
571 * members renamed to the official USB specification names for requests. Existing code will need to be updated
572 * to use the new names.
573 * - The names of several Pipe macros have been changed to be more consistent with the rest of the library,
574 * with no implementation changes. This means that existing code can be altered to use the new macro names
575 * with no other considerations required. See Pipe.h for the new macro names.
576 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
577 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
578 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
579 * documentation for more details.
580 * - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h
581 * module documentation for the new macro names.
583 * <b>Dual Role Mode</b>
584 * - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing
585 * projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG
586 * header inside the library.
587 * - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has
588 * finished enumerating the device. Projects relying on the event only firing in Host mode should be updated
589 * so that the event action only occurs when the USB_Mode global is set to USB_MODE_HOST.
projects / pub / USBasp.git / blob