-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2011.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this\r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in\r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief Common USB Host definitions for all architectures.\r
- * \copydetails Group_Host\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
- * dispatch header located in LUFA/Drivers/USB/USB.h.\r
- */\r
-\r
-/** \ingroup Group_USB\r
- * \defgroup Group_Host Host Management\r
- * \brief USB Host management definitions for USB host mode.\r
- *\r
- * USB Host mode related macros and enums. This module contains macros and enums which are used when\r
- * the USB controller is initialized in host mode.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef __USBHOST_H__\r
-#define __USBHOST_H__\r
-\r
- /* Includes: */\r
- #include "../../../Common/Common.h"\r
- #include "USBMode.h" \r
-\r
- /* 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
- #if (ARCH == ARCH_AVR8)\r
- #include "AVR8/Host_AVR8.h"\r
- #elif (ARCH == ARCH_UC3)\r
- #include "UC3/Host_UC3.h"\r
- #endif\r
-\r
-#endif\r
-\r
-/** @} */\r
-\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2011.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief Common USB Host definitions for all architectures.
+ * \copydetails Group_Host
+ *
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver
+ * dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
+/** \ingroup Group_USB
+ * \defgroup Group_Host Host Management
+ * \brief USB Host management definitions for USB host mode.
+ *
+ * USB Host mode related macros and enums. This module contains macros and enums which are used when
+ * the USB controller is initialized in host mode.
+ *
+ * @{
+ */
+
+#ifndef __USBHOST_H__
+#define __USBHOST_H__
+
+ /* Includes: */
+ #include "../../../Common/Common.h"
+ #include "USBMode.h"
+
+ /* Preprocessor Checks: */
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Enums: */
+ /** Enum for the various states of the USB Host state machine. Only some states are
+ * implemented in the LUFA library - other states are left to the user to implement.
+ *
+ * For information on each possible USB host state, refer to the USB 2.0 specification.
+ * Several of the USB host states are broken up further into multiple smaller sub-states,
+ * so that they can be internally implemented inside the library in an efficient manner.
+ *
+ * \see \ref USB_HostState, which stores the current host state machine state.
+ */
+ enum USB_Host_States_t
+ {
+ HOST_STATE_WaitForDeviceRemoval = 0, /**< Internally implemented by the library. This state can be
+ * used by the library to wait until the attached device is
+ * removed by the user - useful for when an error occurs or
+ * further communication with the device is not needed. This
+ * allows for other code to run while the state machine is
+ * effectively disabled.
+ */
+ HOST_STATE_WaitForDevice = 1, /**< Internally implemented by the library. This state indicates
+ * that the stack is waiting for an interval to elapse before
+ * continuing with the next step of the device enumeration
+ * process.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Unattached = 2, /**< Internally implemented by the library. This state indicates
+ * that the host state machine is waiting for a device to be
+ * attached so that it can start the enumeration process.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Powered = 3, /**< Internally implemented by the library. This state indicates
+ * that a device has been attached, and the library's internals
+ * are being configured to begin the enumeration process.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Powered_WaitForDeviceSettle = 4, /**< Internally implemented by the library. This state indicates
+ * that the stack is waiting for the initial settling period to
+ * elapse before beginning the enumeration process.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Powered_WaitForConnect = 5, /**< Internally implemented by the library. This state indicates
+ * that the stack is waiting for a connection event from the USB
+ * controller to indicate a valid USB device has been attached to
+ * the bus and is ready to be enumerated.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Powered_DoReset = 6, /**< Internally implemented by the library. This state indicates
+ * that a valid USB device has been attached, and that it is
+ * will now be reset to ensure it is ready for enumeration.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Powered_ConfigPipe = 7, /**< Internally implemented by the library. This state indicates
+ * that the attached device is currently powered and reset, and
+ * that the control pipe is now being configured by the stack.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Default = 8, /**< Internally implemented by the library. This state indicates
+ * that the stack is currently retrieving the control endpoint's
+ * size from the device, so that the control pipe can be altered
+ * to match.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Default_PostReset = 9, /**< Internally implemented by the library. This state indicates that
+ * the control pipe is being reconfigured to match the retrieved
+ * control endpoint size from the device, and the device's USB bus
+ * address is being set.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Default_PostAddressSet = 10, /**< Internally implemented by the library. This state indicates that
+ * the device's address has now been set, and the stack is has now
+ * completed the device enumeration process. This state causes the
+ * stack to change the current USB device address to that set for
+ * the connected device, before progressing to the user-implemented
+ * \ref HOST_STATE_Addressed state for further communications.
+ *
+ * \note Do not manually change to this state in the user code.
+ */
+ HOST_STATE_Addressed = 11, /**< May be implemented by the user project. This state should
+ * set the device configuration before progressing to the
+ * \ref HOST_STATE_Configured state. Other processing (such as the
+ * retrieval and processing of the device descriptor) should also
+ * be placed in this state.
+ */
+ HOST_STATE_Configured = 12, /**< May be implemented by the user project. This state should implement the
+ * actual work performed on the attached device and changed to the
+ * \ref HOST_STATE_Suspended or \ref HOST_STATE_WaitForDeviceRemoval states as needed.
+ */
+ HOST_STATE_Suspended = 15, /**< May be implemented by the user project. This state should be maintained
+ * while the bus is suspended, and changed to either the \ref HOST_STATE_Configured
+ * (after resuming the bus with the USB_Host_ResumeBus() macro) or the
+ * \ref HOST_STATE_WaitForDeviceRemoval states as needed.
+ */
+ };
+
+ /* Architecture Includes: */
+ #if (ARCH == ARCH_AVR8)
+ #include "AVR8/Host_AVR8.h"
+ #elif (ARCH == ARCH_UC3)
+ #include "UC3/Host_UC3.h"
+ #endif
+
+#endif
+
+/** @} */
+
projects / pub / USBasp.git / blobdiff