+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Enums: */\r
+ /** Enum for the various states of the USB Host state machine. Only some states are\r
+ * implemented in the LUFA library - other states are left to the user to implement.\r
+ *\r
+ * For information on each possible USB host state, refer to the USB 2.0 specification.\r
+ * Several of the USB host states are broken up further into multiple smaller sub-states,\r
+ * so that they can be internally implemented inside the library in an efficient manner.\r
+ *\r
+ * \see \ref USB_HostState, which stores the current host state machine state.\r
+ */\r
+ enum USB_Host_States_t\r
+ {\r
+ HOST_STATE_WaitForDeviceRemoval = 0, /**< Internally implemented by the library. This state can be\r
+ * used by the library to wait until the attached device is\r
+ * removed by the user - useful for when an error occurs or\r
+ * further communication with the device is not needed. This\r
+ * allows for other code to run while the state machine is\r
+ * effectively disabled.\r
+ */\r
+ HOST_STATE_WaitForDevice = 1, /**< Internally implemented by the library. This state indicates\r
+ * that the stack is waiting for an interval to elapse before\r
+ * continuing with the next step of the device enumeration\r
+ * process.\r
+ *\r
+ * \note Do not manually change to this state in the user code.\r
+ */\r
+ HOST_STATE_Unattached = 2, /**< Internally implemented by the library. This state indicates\r
+ * that the host state machine is waiting for a device to be\r
+ * attached so that it can start the enumeration process.\r
+ *\r
+ * \note Do not manually change to this state in the user code.\r
+ */\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
+ 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
+ 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
+ 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
+ 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
+ * \note Do not manually change to this state in the user code.\r
+ */\r
+ HOST_STATE_Default = 8, /**< Internally implemented by the library. This state indicates\r
+ * that the stack is currently retrieving the control endpoint's\r
+ * size from the device, so that the control pipe can be altered\r
+ * to match.\r
+ *\r
+ * \note Do not manually change to this state in the user code.\r
+ */\r
+ HOST_STATE_Default_PostReset = 9, /**< Internally implemented by the library. This state indicates that\r
+ * the control pipe is being reconfigured to match the retrieved\r
+ * control endpoint size from the device, and the device's USB bus\r
+ * address is being set.\r
+ *\r
+ * \note Do not manually change to this state in the user code.\r
+ */\r
+ HOST_STATE_Default_PostAddressSet = 10, /**< Internally implemented by the library. This state indicates that\r
+ * the device's address has now been set, and the stack is has now\r
+ * completed the device enumeration process. This state causes the\r
+ * stack to change the current USB device address to that set for\r
+ * the connected device, before progressing to the user-implemented\r
+ * \ref HOST_STATE_Addressed state for further communications.\r
+ *\r
+ * \note Do not manually change to this state in the user code.\r
+ */\r
+ HOST_STATE_Addressed = 11, /**< May be implemented by the user project. This state should\r
+ * set the device configuration before progressing to the\r
+ * \ref HOST_STATE_Configured state. Other processing (such as the\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 implement the\r
+ * actual work performed on the attached device and changed to the\r
+ * \ref HOST_STATE_Suspended or \ref 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
+ * while the bus is suspended, and changed to either the \ref HOST_STATE_Configured\r
+ * (after resuming the bus with the USB_Host_ResumeBus() macro) or the\r
+ * \ref HOST_STATE_WaitForDeviceRemoval states as needed.\r
+ */\r
+ };\r
+\r
+ /* Architecture Includes: */\r
projects / pub / USBasp.git / commitdiff