Document CDC Host class driver functions and enums.

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Host.h

diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h
index 88634fd..50912ad 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.h
@@ -241,32 +241,32 @@
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached                     = 3,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered                      = 3,  /**< Internally implemented by the library. This state indicates\r

                                                                               *   that a device has been attached, and the library's internals\r
                                                                               *   are being configured to begin the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that a device has been attached, and the library's internals\r
                                                                               *   are being configured to begin the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached_WaitForDeviceSettle = 4,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_WaitForDeviceSettle = 4,   /**< Internally implemented by the library. This state indicates\r

                                                                               *   that the stack is waiting for the initial settling period to\r
                                                                               *   elapse before beginning the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that the stack is waiting for the initial settling period to\r
                                                                               *   elapse before beginning the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached_WaitForConnect      = 5,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_WaitForConnect      = 5,   /**< Internally implemented by the library. This state indicates\r

                                                                               *   that the stack is waiting for a connection event from the USB\r
                                                                               *   controller to indicate a valid USB device has been attached to\r
                                                                               *   the bus and is ready to be enumerated.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that the stack is waiting for a connection event from the USB\r
                                                                               *   controller to indicate a valid USB device has been attached to\r
                                                                               *   the bus and is ready to be enumerated.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached_DoReset             = 6,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_DoReset             = 6,   /**< Internally implemented by the library. This state indicates\r

                                                                               *   that a valid USB device has been attached, and that it is\r
                                                                               *   will now be reset to ensure it is ready for enumeration.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that a valid USB device has been attached, and that it is\r
                                                                               *   will now be reset to ensure it is ready for enumeration.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Powered                      = 7,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_ConfigPipe           = 7,  /**< Internally implemented by the library. This state indicates\r

                                                                               *   that the attached device is currently powered and reset, and\r
                                                                               *   that the control pipe is now being configured by the stack.\r
                                                                               *   \r
                                                                               *   that the attached device is currently powered and reset, and\r
                                                                               *   that the control pipe is now being configured by the stack.\r
                                                                               *   \r


@@ -301,26 +301,18 @@
                                                                               *   retrieval and processing of the device descriptor) should also\r
                                                                               *   be placed in this state.\r
                                                                               */\r
                                                                               *   retrieval and processing of the device descriptor) should also\r
                                                                               *   be placed in this state.\r
                                                                               */\r

-                               HOST_STATE_Configured                   = 12, /**< May be implemented by the user project. This state should\r
-                                                                              *   implement any extra device configuration (such as the setting of\r
-                                                                              *   class-specific parameters) before normal communication is begun\r
-                                                                              *   in the HOST_STATE_Ready state.\r
-                                                                              */\r
-                               HOST_STATE_Ready                        = 13, /**< May be implemented by the user project. This state should\r
-                                                                              *   contain the main communications with the attached device. From this\r
-                                                                              *   this state the host state machine should be changed to either\r
-                                                                              *   HOST_STATE_Suspended (after the bus is manually suspended using the\r
-                                                                              *   USB_Host_SuspendBus() macro) or HOST_STATE_WaitForDeviceRemoval as\r
-                                                                              *   needed.\r
+                               HOST_STATE_Configured                   = 12, /**< May be implemented by the user project. This state should implement the\r
+                                                                              *   actual work performed on the attached device and changed to the\r
+                                                                              *   HOST_STATE_Suspended or HOST_STATE_WaitForDeviceRemoval states as needed.\r

                                                                               */\r
                                HOST_STATE_Suspended                    = 15, /**< May be implemented by the user project. This state should be maintained\r
                                                                               */\r
                                HOST_STATE_Suspended                    = 15, /**< May be implemented by the user project. This state should be maintained\r

-                                                                              *   while the bus is suspended, and changed to either the HOST_STATE_Ready\r
+                                                                              *   while the bus is suspended, and changed to either the HOST_STATE_Configured\r

                                                                               *   (after resuming the bus with the USB_Host_ResumeBus() macro) or the\r
                                                                               *   HOST_STATE_WaitForDeviceRemoval states as needed.\r
                                                                               */\r
                        };\r
                        \r
                                                                               *   (after resuming the bus with the USB_Host_ResumeBus() macro) or the\r
                                                                               *   HOST_STATE_WaitForDeviceRemoval states as needed.\r
                                                                               */\r
                        };\r
                        \r

-                       /** Enum for the error codes for the \ref EVENT_USB_HostError() event.\r
+                       /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.\r

                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r
                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r


@@ -334,14 +326,14 @@
                                                                      */\r
                        };\r
                        \r
                                                                      */\r
                        };\r
                        \r

-                       /** Enum for the error codes for the \ref EVENT_USB_DeviceEnumerationFailed() event.\r
+                       /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.\r

                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r
                        enum USB_Host_EnumerationErrorCodes_t\r
                        {\r
                                HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid\r
                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r
                        enum USB_Host_EnumerationErrorCodes_t\r
                        {\r
                                HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid\r

-                                                                     *   ErrorCode parameter value for the \ref EVENT_USB_DeviceEnumerationFailed()\r
+                                                                     *   ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed()\r

                                                                      *   event.\r
                                                                      */\r
                                HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed\r
                                                                      *   event.\r
                                                                      */\r
                                HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed\r