Host.h 11.4 KB
 Dean Camera committed Feb 19, 2011 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 /* 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  Dean Camera committed Feb 20, 2011 32 33  * \brief Common USB Host definitions for all architectures. * \copydetails Group_Host  Dean Camera committed Feb 19, 2011 34 35 36 37 38 39 40  * * \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  Dean Camera committed Feb 20, 2011 41  * \brief USB Host management definitions for USB host mode.  Dean Camera committed Feb 19, 2011 42 43 44 45 46 47 48 49 50 51 52 53  * * 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"  Dean Camera committed Feb 27, 2011 54  #include "USBMode.h"  Dean Camera committed Feb 19, 2011 55   Dean Camera committed Feb 27, 2011 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165  /* 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: */  Dean Camera committed Feb 19, 2011 166  #if (ARCH == ARCH_AVR8)  Dean Camera committed Feb 20, 2011 167  #include "AVR8/Host_AVR8.h"  Dean Camera committed Mar 13, 2011 168 169  #elif (ARCH == ARCH_UC3) #include "UC3/Host_UC3.h"  Dean Camera committed Feb 19, 2011 170 171 172 173 174 175  #endif #endif /** @} */