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