Moved all source to the trunk directory.
[pub/USBasp.git] / LUFA / MigrationInformation.txt
1 /** \file
2 *
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.
5 */
6
7 /** \page Page_Migration Migrating from Older Versions
8 *
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.
12 *
13 * \section Sec_MigrationXXXXXX Migrating from 090209 to XXXXXX
14 *
15 *
16 * \section Sec_Migration090209 Migrating from 081217 to 090209
17 *
18 * <b>Device Mode</b>
19 * - The ENDPOINT_MAX_ENDPOINTS constant has been renamed to the more appropriate name of ENDPOINT_TOTAL_ENDPOINTS.
20 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
21 * makefile if desired to restore the previous 50ms timeout.
22 *
23 * <b>Host Mode</b>
24 * - The PIPE_MAX_ENDPOINTS constant has been renamed to the more appropriate name of PIPE_TOTAL_ENDPOINTS.
25 * - The USB_STREAM_TIMEOUT_MS stream timeout default period has been extended to 100ms. This can be overridden in the user
26 * makefile if desired to restore the previous 50ms timeout.
27 * - The USB_DeviceEnumerationFailed event now contains a second "SubErrorCode" parameter, giving the error code of the function
28 * which failed.
29 * - The HID_PARSE_Sucessful enum member constant has been corrected to HID_PARSE_Successful.
30 *
31 * <b>Non-USB Library Components</b>
32 * - The previous SPI_SendByte() functionality is now located in SPI_TransferByte(). SPI_SendByte() now discards the return byte
33 * for speed, to compliment the new SPI_ReceiveByte() function. If two-way SPI transfers are required, calls to SPI_SendByte()
34 * should be changed to SPI_TransferByte().
35 * - The serial driver now sets the Tx line as an output explicitly, and enables the pullup of the Rx line.
36 * - The Serial_Init() and SerialStream_Init() functions now take a second DoubleSpeed parameter, which indicates if the USART
37 * should be initialized in double speed mode - useful in some circumstances for attaining baud rates not usually possible at
38 * the given AVR clock speed.
39 *
40 * <b>Library Demos</b>
41 * - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to
42 * the latest demo versions.
43 *
44 * \section Sec_Migration171208 Migrating from V1.5.3 to 081217
45 *
46 * <b>All</b>
47 * - The MyUSB project name has been changed to LUFA (Lightweight Framework for USB AVRs). All references to MyUSB, including macro names,
48 * have been changed to LUFA.
49 *
50 * <b>Library Demos</b>
51 * - The ReconfigureUSART() routine in the USBtoSerial demo was not being called after new line encoding
52 * parameters were set by the host. Projects built on the USBtoSerial code should update to the latest version.
53 * - The HID Parser now supports multiple report (on a single endpoint) HID devices. The MouseHostWithParser and
54 * KeyboardHostWithPaser demos use the updated API functions to function correctly on such devices. Projects
55 * built on either "WithParser" demo should update to the latest code.
56 * - The RNDIS demo TCP stack has been modified so that connections can be properly closed. It is still not
57 * recommended that the MyUSB RNDIS demo TCP/IP stack be used for anything other than demonstration purposes,
58 * as it is neither a full nor a standards compliant implementation.
59 *
60 * <b>Non-USB Library Components</b>
61 * - The Serial_IsCharRecieved() macro has been changed to the correct spelling of Serial_IsCharReceived() in Serial.h.
62 *
63 * <b>Device Mode</b>
64 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
65 * to be used in the Options parameter of the USB_Init() function.
66 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
67 * currently initialized.
68 * - Interrupts are now disabled when processing control requests, to avoid problems with interrupts causing the library
69 * or user request processing code to exceed the strict USB timing requirements on control transfers.
70 * - The USB Reset event now resets and disables all device endpoints. If user code depends on endpoints remaining configured
71 * after a Reset event, it should be altered to explicitly re-initialize all user endpoints.
72 * - The prototype for the GetDescriptor function has been changed, as the return value was redundant. The function now
73 * returns the size of the descriptor, rather than passing it back via a parameter, or returns NO_DESCRIPTOR if the specified
74 * descriptor does not exist.
75 * - The NO_DESCRIPTOR_STRING macro has been renamed NO_DESCRIPTOR, and is now also used as a possible return value for the
76 * GetDescriptor function.
77 *
78 * <b>Host Mode</b>
79 * - The MANUAL_PLL_CONTROL compile time token has been removed, and replaced with a USB_OPT_MANUAL_PLL mask
80 * to be used in the Options parameter of the USB_Init() function.
81 * - The HID report parser now supports multiple Report IDs. The HID report parser GetReportItemInfo() and
82 * SetReportItemInfo() routines now return a boolean, set if the requested report item was located in the
83 * current report. If sending a report to a multi-report device, the first byte of the report is automatically
84 * set to the report ID of the given report item.
85 * - Calling USB_Init() now forces a complete USB interface reset and enumeration, even if the USB interface is
86 * currently initialized.
87 *
88 *
89 * \section Sec_Migration152 Migrating from V1.5.2 to V1.5.3
90 *
91 * <b>Library Demos</b>
92 * - Previously, all demos contained a serial number string descriptor, filled with all zeros. A serial number
93 * string is required in Mass Storage devices, or devices which are to retain settings when moved between
94 * ports on a machine. As people were not changing the serial number value, this was causing conflicts and so
95 * the serial number descriptor has been removed from all but the Mass Storage demo, which requires it.
96 * - The AudioOut and AudioIn demos did not previously silence their endpoints when the host has deactivated
97 * them. Projects built upon either demo should upgrade to the latest code.
98 * - The FEATURE_ENDPOINT macro has been renamed FEATURE_ENDPOINT_HALT, and is now correctly documented.
99 * - The MassStoreHost demo contained errors which caused it to lock up randomly on certain devices. Projects built
100 * on the MassStoreDemo code should update to the latest version.
101 * - The Interrupt type endpoint in the CDC based demos previously had a polling interval of 0x02, which caused
102 * problems on some Linux systems. This has been changed to 0xFF, projects built on the CDC demos should upgrade
103 * to the latest code.
104 * - The HID keyboard and mouse demos were not previously boot mode compatible. To enable boot mode support, projects
105 * built on the keyboard or mouse demos (or derivatives) should upgrade to the latest code.
106 * - The Mass Storage demo was not previously standards compliant. Projects built on the Mass Storage demo should
107 * upgrade to the latest code.
108 * - The USART was not being reconfigured after the host sent new encoding settings in the USBtoSerial demo. This was
109 * previously discovered and fixed, but the change was lost. Projects built on the USBtoSerial demo should update
110 * to the latest code.
111 *
112 * <b>Device Mode</b>
113 * - The endpoint non-control stream functions now have a default timeout of 50ms between packets in the stream.
114 * If this timeout is exceeded, the function returns the new ENDPOINT_RWSTREAM_ERROR_Timeout error value. The
115 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
116 * timeout duration in ms.
117 * - Rather than returning fixed values, the flags indicating if the device has Remote Wakeup currently enabled
118 * and/or is self-powered are now accessed and set through the new USB_RemoteWakeupEnabled and
119 * USB_CurrentlySelfPowered macros. See the DevChapter9.h documentation for more details.
120 * - All endpoint stream functions now require an extra Callback function parameter. Existing code may be updated
121 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by pasing
122 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
123 *
124 * <b>Host Mode</b>
125 * - The pipe non-control stream functions now have a default timeout of 50ms between packets in the stream.
126 * If this timeout is exceeded, the function returns the new PIPE_RWSTREAM_ERROR_Timeout error value. The
127 * timeout value can be overridden by defining the USB_STREAM_TIMEOUT_MS in the project makefile to the desired
128 * timeout duration in ms.
129 * - CollectionPath_t has been renamed to HID_CollectionPath_t to be more in line with the other HID parser structures.
130 * - All pipe stream functions now require an extra Callback function parameter. Existing code may be updated
131 * to either supply NO_STREAM_CALLBACK as the extra parameter, or disable stream callbacks altogether by pasing
132 * the token NO_STREAM_CALLBACKS to the compiler using the -D switch.
133 *
134 *
135 * \section Sec_Migration151 Migrating from V1.5.1 to V1.5.2
136 *
137 * <b>Library Demos</b>
138 * - The RNDIS demo application has been updated so that it is functional on Linux under earlier implementations
139 * of the RNDIS specification, which had non-standard behaviour. Projects built upon the demo should upgrade
140 * to the latest code.
141 * - The DFU class bootloader has had several bugs corrected in this release. It is recommended that where
142 * possible any existing devices upgrade to the latest bootloader code.
143 *
144 *
145 * \section Sec_Migration150 Migrating from V1.5.0 to V1.5.1
146 *
147 * <b>Library Demos</b>
148 * - The USBtoSerial demo was broken in the 1.5.0 release, due to incorrect register polling in place of the
149 * global "Transmitting" flag. The change has been reverted in this release. Projects built upon the demo
150 * should upgrade to the latest code.
151 * - The HID class demos did not implement the mandatory GetReport HID class request. Projects built upon the HID
152 * demos should upgrade to the latest code.
153 * - The HID class demos incorrectly reported themselves as boot-protocol enabled HID devices in their descriptors.
154 * Projects built upon the HID demos should upgrade to the latest code.
155 * - The MIDI device demo had incorrect AudioStreaming interface descriptors. Projects built upon the MIDI demo
156 * should upgrade to the latest code.
157 * - The AudioOut demo did not correctly tristate the speaker pins when USB was disconnected, wasting power.
158 * Projects built upon the AudioOut demo should upgrade to the latest code.
159 *
160 *
161 * \section Sec_Migration141 Migrating from V1.4.1 to V1.5.0
162 *
163 * <b>Library Demos</b>
164 * - Previous versions of the library demos had incorrectly encoded BCD version numbers in the descriptors. To
165 * avoid such mistakes in the future, the VERSION_BCD macro has been added to StdDescriptors.h. Existing
166 * projects should at least manually correct the BCD version numbers, or preferably update the descriptors to
167 * encode the version number in BCD format using the new macro.
168 * - The mandatory GetReport class-specific request was accidentally ommitted from previous versions of the demos
169 * based on the Human Interface Device (HID) class. This has been corrected, and any user projects based on the
170 * HID demos should also be updated accordingly.
171 * - The CDC demos now correctly send an empty packet directly after a full packet, to end the transmission.
172 * Failure to do this on projects which always or frequently send full packets will cause buffering issues on
173 * the host OS. All CDC user projects are advised to update their transmission routines in the same manner as
174 * the library CDC demos.
175 * - The previous interrupt-driven Endpoint/Pipe demos did not properly save and restore the currently selected
176 * Endpoint/Pipe when the ISR fired. This has been corrected - user projects based on the interrupt driven
177 * demos should also update to properly save and restore the selected Endpoint/Pipe.
178 *
179 * <b>Non-USB Library Components</b>
180 * - The Atomic.h and ISRMacro.h header files in MyUSB/Common have been removed, as the library is now only
181 * compatible with avr-libc library versions newer than the time before the functionality of the deleted
182 * headers was available.
183 *
184 * <b>Device Mode</b>
185 * - The GetDescriptor function (see StdDescriptors.h) now has a new prototype, with altered parameter names and
186 * functions. Existing projects will need to update the GetDescriptor implementation to reflect the new API.
187 * The previously split Type and Index parameters are now passed as the original wValue parameter to the
188 * function, to make way for the USB specification wIndex parameter which is <i>not</i> the same as the
189 * previous Index parameter.
190 * - The USB_UnhandledControlPacket event (see Events.h) now has new parameter names, to be in line with the
191 * official USB specification. Existing code will need to be altered to use the new parameter names.
192 * - The USB_CreateEndpoints event (see Events.h) has been renamed to USB_ConfigurationChanged, which is more
193 * appropriate. It fires in an identical manner to the previously named event, thus the only change to be made
194 * is the event name itself in the user project.
195 * - The USB_Descriptor_Language_t structure no longer exists in StdDescriptors.h, as this was a
196 * psudo-descriptor modelled on the string descriptor. It is replaced by the true USB_Descriptor_String_t type
197 * descriptor as indicated in the USB specification, thus all device code must be updated accordingly.
198 * - The names of several Endpoint macros have been changed to be more consistant with the rest of the library,
199 * with no implementation changes. This means that existing code can be altered to use the new macro names
200 * with no other considerations required. See Endpoint.h for the new macro names.
201 * - The previous version of the MassStorage demo had an incorrect value in the SCSI_Request_Sense_Response_t
202 * strucuture named SenseData in SCSI.c which caused some problems with some hosts. User projects based on this
203 * demo should correct the structure value to maintain compatibility across multiple OS platforms.
204 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
205 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
206 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
207 * documentation for more details.
208 *
209 * <b>Host Mode</b>
210 * - The USB_Host_Request_Header_t structure in HostChapter9.h (used for issuing control requests) has had its
211 * members renamed to the official USB specification names for requests. Existing code will need to be updated
212 * to use the new names.
213 * - The names of several Pipe macros have been changed to be more consistant with the rest of the library,
214 * with no implementation changes. This means that existing code can be altered to use the new macro names
215 * with no other considerations required. See Pipe.h for the new macro names.
216 * - By default, the descriptor structures use the official USB specification names for the elements. Previous
217 * versions of the library used non-standard (but more verbose) names, which are still usable in the current
218 * and future releases when the correct compile time option is enabled. See the StdDescriptors.h file
219 * documentation for more details.
220 * - The names of the macros in Host.h for controlling the SOF generation have been renamed, see the Host.h
221 * module documentation for the new macro names.
222 *
223 * <b>Dual Role Mode</b>
224 * - The OTG.h header file has been corrected so that the macros now perform their stated functions. Any existing
225 * projects using custom headers to fix the broken OTG header should now be altered to once again use the OTG
226 * header inside the library.
227 * - The USB_DeviceEnumerationComplete event (see Events.h) now also fires in Device mode, when the host has
228 * finished enumerating the device. Projects relying on the event only firing in Host mode should be updated
229 * so that the event action only ocurrs when the USB_Mode global is set to USB_MODE_HOST.
230 */