aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/ManPages/MigrationInformation.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-07-08 07:25:56 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-07-08 07:25:56 +0000
commit137ce280c1e9c33e9393f1dfd6bb160c131bd1a4 (patch)
tree9db0900f06376a93ef2b6d9e9ef1edbfdc2a1f79 /LUFA/ManPages/MigrationInformation.txt
parentbcb627e1a1bb9f013670d981ead2db97d7c70608 (diff)
downloadlufa-137ce280c1e9c33e9393f1dfd6bb160c131bd1a4.tar.gz
lufa-137ce280c1e9c33e9393f1dfd6bb160c131bd1a4.tar.bz2
lufa-137ce280c1e9c33e9393f1dfd6bb160c131bd1a4.zip
Updated all host mode demos and projects to use the EVENT_USB_Host_DeviceEnumerationComplete() event callback for device configuration instead of manual host state machine manipulations in the main application task.
Added new USB_Host_ConfigurationNumber global variable to indicate the selected configuration in an attached device. Renamed global state variables that are specific to a certain USB mode to clearly indicate which mode the variable relates to, by changing the USB_* prefix to USB_Device_* or USB_Host_*. Removed the HOST_STATE_WaitForDeviceRemoval and HOST_STATE_Suspended host state machine states, as these are no longer required. Altered the USB_Host_SetDeviceConfiguration() function to update the new USB_Host_ConfigurationNumber global as required. Moved out the Host mode standard request convenience/helper functions from the architecture specific Host driver files to the architecture agnostic HostStandardReq.c driver file.
Diffstat (limited to 'LUFA/ManPages/MigrationInformation.txt')
-rw-r--r--LUFA/ManPages/MigrationInformation.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index 390dd8846..d5f680eef 100644
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -20,6 +20,19 @@
* - 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.
+ *
+ * <b>Host Mode</b>
+ * - 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
* <b>Non-USB Library Components</b>