X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/0210fa5648b1ed65caa384f966ac40b4ecc489ae..a36012fc4b057dc1fe96f75a005cd8ba017a6a71:/LUFA/ManPages/MigrationInformation.txt diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index a9b8ae55f..d5f680eef 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -17,9 +17,22 @@ * \c TotalDiscreteSampleRates. Existing applications will need to add an array of \ref USB_Audio_SampleFreq_t elements * immediately following any \ref USB_Audio_Descriptor_Format_t descriptors, and insert the appropriate sampling rates * supported by the device, as well as rename the descriptor elements to match the updated element names. - * - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_GetSetEndpointProperty(). + * - The device mode Audio class driver now requires a new user application callback, \ref CALLBACK_Audio_Device_GetSetEndpointProperty(). * Existing applications must implement this new callback, however if multiple sample rates or pitch control is not used, * this function may be hard-coded to always return false for previous behaviour to be retained. + * - The \c USB_ConfigurationNumber, \c USB_RemoteWakeupEnabled and \c USB_CurrentlySelfPowered globals have been renamed to + * \ref USB_Device_ConfigurationNumber, \ref USB_Device_RemoteWakeupEnabled and \ref USB_Device_CurrentlySelfPowered to clearly indicate + * the USB mode they relate to. Existing applications using these variables should rename all references to the previous names. + * + * Host Mode + * - The USB_Host_SetDeviceConfiguration() function now automatically sets the USB Host state machine to the \ref HOST_STATE_Configured + * state if a non-zero configuration is set sucessfully, or the \ref HOST_STATE_Addressed if a zero-index configuration is specified. Existing + * applications should no longer manually alter the \ref USB_HostState global, and should instead call this function to configure and + * unconfigure an attached device. + * - The \c HOST_STATE_WaitForDeviceRemoval and \c HOST_STATE_Suspended host state machine states have been removed; these are replaced by + * unconfiguring the attached device via a call to \ref USB_Host_SetDeviceConfiguration() and a test of \ref USB_Host_IsBusSuspended() instead. + * - It is highly recommended that the EVENT_USB_Host_DeviceEnumerationComplete() event callback now be used for initial device configuration, + * rather than a switch on the USB host state machine state for readability. * * \section Sec_Migration110528 Migrating from 101122 to 110528 * Non-USB Library Components @@ -154,7 +167,7 @@ * * Host Mode * - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was - * received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact + * received. This allows for more efficient coding, as a call to \ref CDC_Host_BytesReceived() is no longer needed if the exact * number of queued bytes received is not needed. * - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual * flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask(). @@ -339,7 +352,7 @@ * - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API. * * Dual Role Mode - * - The \c USB_PowerOnFail even has been renamed to \c USB_InitFailure. + * - The \c USB_PowerOnFail event has been renamed to \c USB_InitFailure. * - 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 * details. *