projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fix up the incomplete Webserver project so that it integrates with the uIP stack...
[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 1ff2d7a..07ff0fc 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
+  Copyright 2010  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -28,16 +28,11 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r
-/** \file\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
 /** \ingroup Group_USB\r
  *  @defgroup Group_Host Host Management\r
  *\r
 /** \ingroup Group_USB\r
  *  @defgroup Group_Host Host Management\r
  *\r
- *  Functions, macros, variables, enums and types related to the management of a USB host when in Host mode.\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
  *  @{\r
  */\r
@@ -52,6 +47,8 @@
 \r
                #include "../../../Common/Common.h"\r
                #include "../HighLevel/USBInterrupt.h"\r
 \r
                #include "../../../Common/Common.h"\r
                #include "../HighLevel/USBInterrupt.h"\r
+               #include "../HighLevel/StdDescriptors.h"\r
+               #include "Pipe.h"\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
@@ -65,7 +62,7 @@
                         *  and that the address used is not important (other than the fact that it is non-zero), a\r
                         *  fixed value is specified by the library.\r
                         */\r
                         *  and that the address used is not important (other than the fact that it is non-zero), a\r
                         *  fixed value is specified by the library.\r
                         */\r
-                       #define USB_HOST_DEVICEADDRESS             1\r
+                       #define USB_HOST_DEVICEADDRESS                 1\r
 \r
                        #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)\r
                                /** Constant for the maximum software timeout period of sent USB control transactions to an attached\r
 \r
                        #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)\r
                                /** Constant for the maximum software timeout period of sent USB control transactions to an attached\r
@@ -73,7 +70,7 @@
                                 *  library will return a timeout error code.\r
                                 *\r
                                 *  This value may be overridden in the user project makefile as the value of the \r
                                 *  library will return a timeout error code.\r
                                 *\r
                                 *  This value may be overridden in the user project makefile as the value of the \r
-                                *  USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.\r
+                                *  \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.\r
                                 */\r
                                #define USB_HOST_TIMEOUT_MS                1000\r
                        #endif\r
                                 */\r
                                #define USB_HOST_TIMEOUT_MS                1000\r
                        #endif\r
@@ -90,7 +87,7 @@
                                #define HOST_DEVICE_SETTLE_DELAY_MS        1500\r
                        #endif\r
                \r
                                #define HOST_DEVICE_SETTLE_DELAY_MS        1500\r
                        #endif\r
                \r
-               /* Psuedo-Function Macros: */\r
+               /* Pseudo-Function Macros: */\r
                        #if defined(__DOXYGEN__)\r
                                /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.\r
                                 *  USB bus resets leave the default control pipe configured (if already configured).\r
                        #if defined(__DOXYGEN__)\r
                                /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.\r
                                 *  USB bus resets leave the default control pipe configured (if already configured).\r
@@ -100,7 +97,7 @@
                                 */\r
                                static inline void USB_Host_ResetBus(void);\r
 \r
                                 */\r
                                static inline void USB_Host_ResetBus(void);\r
 \r
-                               /** Determines if a previously issued bus reset (via the USB_Host_ResetBus() macro) has\r
+                               /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has\r
                                 *  completed.\r
                                 *\r
                                 *  \return Boolean true if no bus reset is currently being sent, false otherwise.\r
                                 *  completed.\r
                                 *\r
                                 *  \return Boolean true if no bus reset is currently being sent, false otherwise.\r
@@ -119,7 +116,7 @@
                                 */\r
                                static inline void USB_Host_SuspendBus(void);\r
                                \r
                                 */\r
                                static inline void USB_Host_SuspendBus(void);\r
                                \r
-                               /** Determines if the USB bus has been suspended via the use of the USB_Host_SuspendBus() macro,\r
+                               /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,\r
                                 *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,\r
                                 *  except for the Remote Wakeup event from the device if supported.\r
                                 *\r
                                 *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,\r
                                 *  except for the Remote Wakeup event from the device if supported.\r
                                 *\r
@@ -178,55 +175,181 @@
                                #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON &   (1 << RESUME)) ? false : true)\r
                        #endif\r
 \r
                                #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON &   (1 << RESUME)) ? false : true)\r
                        #endif\r
 \r
+               /* Function Prototypes: */\r
+                       /** Convenience function. This routine sends a SetConfiguration standard request to the attached\r
+                        *  device, with the given configuration index. This can be used to easily set the device\r
+                        *  configuration without creating and sending the request manually.\r
+                        *\r
+                        *  \note After this routine returns, the control pipe will be selected.\r
+                        *\r
+                        *  \param[in] ConfigNumber  Configuration index to send to the device\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+                        */\r
+                       uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);\r
+                       \r
+                       /** Convenience function. This routine sends a GetDescriptor standard request to the attached\r
+                        *  device, requesting the device descriptor. This can be used to easily retrieve information\r
+                        *  about the device such as its VID, PID and power requirements.\r
+                        *\r
+                        *  \note After this routine returns, the control pipe will be selected.\r
+                        *\r
+                        *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where\r
+                        *                                   the read data is to be stored\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+                        */\r
+                       uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);\r
+                       \r
+                       /** Convenience function. This routine sends a GetDescriptor standard request to the attached\r
+                        *  device, requesting the string descriptor of the specified index. This can be used to easily\r
+                        *  retrieve string descriptors from the device by index, after the index is obtained from the\r
+                        *  Device or Configuration descriptors.\r
+                        *\r
+                        *  \note After this routine returns, the control pipe will be selected.\r
+                        *\r
+                        *  \param[in] Index  Index of the string index to retrieve\r
+                        *  \param[out] Buffer  Pointer to the destination buffer where the retrieved string decriptor is\r
+                        *                      to be stored\r
+                        *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+                        */\r
+                       uint8_t USB_Host_GetDeviceStringDescriptor(uint8_t Index, void* const Buffer, uint8_t BufferLength);\r
+                       \r
+                       /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.\r
+                        *\r
+                        *  \note After this routine returns, the control pipe will be selected.\r
+                        *\r
+                        *  \param[in] EndpointIndex  Index of the endpoint to clear\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+                        */                     \r
+                       uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);\r
+\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 state, refer to the USB 2.0 specification. Some states have\r
                         *\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 state, refer to the USB 2.0 specification. Some states have\r
                         *\r
-                        *  \see USBTask.h for information on the global variable USB_HostState, which stores the\r
-                        *       current host state machine state.\r
+                        *  \see \ref USB_HostState, which stores the current host state machine state.\r
                         */\r
                        enum USB_Host_States_t\r
                        {\r
                         */\r
                        enum USB_Host_States_t\r
                        {\r
-                               HOST_STATE_WaitForDevice                = 0,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Unattached                   = 1,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Attached                     = 2,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Attached_WaitForDeviceSettle = 3,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Attached_WaitForConnect      = 4,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Attached_DoReset             = 5,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Powered                      = 6,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Default                      = 7,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Default_PostReset            = 8,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Default_PostAddressSet       = 9,  /**< Internally implemented by the library. */\r
-                               HOST_STATE_Addressed                    = 10, /**< May be implemented by the user project. */\r
-                               HOST_STATE_Configured                   = 11, /**< May be implemented by the user project. */\r
-                               HOST_STATE_Ready                        = 12, /**< May be implemented by the user project. */\r
-                               HOST_STATE_Suspended                    = 13, /**< May be implemented by the user project. */\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
+                                                                              *   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
+                                                                              *   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
+                                                                              *   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
+                                                                              *   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
                        };\r
                        \r
-                       /** Enum for the error codes for the USB_HostError event.\r
+                       /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.\r
                         *\r
                         *\r
-                        *  \see Events.h for more information on this event.\r
+                        *  \see \ref Group_Events for more information on this event.\r
                         */\r
                        enum USB_Host_ErrorCodes_t\r
                        {\r
                                HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This\r
                         */\r
                        enum USB_Host_ErrorCodes_t\r
                        {\r
                                HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This\r
-                                                                     *  error may be the result of an attached device drawing\r
+                                                                     *   error may be the result of an attached device drawing\r
                                                                      *   too much current from the VBUS line, or due to the\r
                                                                      *   AVR's power source being unable to supply sufficient\r
                                                                      *   current.\r
                                                                      */\r
                        };\r
                        \r
                                                                      *   too much current from the VBUS line, or due to the\r
                                                                      *   AVR's power source being unable to supply sufficient\r
                                                                      *   current.\r
                                                                      */\r
                        };\r
                        \r
-                       /** Enum for the error codes for the USB_DeviceEnumerationFailed event.\r
+                       /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.\r
                         *\r
                         *\r
-                        *  \see Events.h for more information on this event.\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
                        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 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
@@ -250,7 +373,7 @@
                        #define USB_Host_HostMode_On()          MACROS{ USBCON |=  (1 << HOST);           }MACROE\r
                        #define USB_Host_HostMode_Off()         MACROS{ USBCON &= ~(1 << HOST);           }MACROE\r
 \r
                        #define USB_Host_HostMode_On()          MACROS{ USBCON |=  (1 << HOST);           }MACROE\r
                        #define USB_Host_HostMode_Off()         MACROS{ USBCON &= ~(1 << HOST);           }MACROE\r
 \r
-                       #define USB_Host_VBUS_Auto_Enable()     MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |=  (1 << UVCONE);                    }MACROE\r
+                       #define USB_Host_VBUS_Auto_Enable()     MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |=  (1 << UVCONE);                   }MACROE\r
                        #define USB_Host_VBUS_Manual_Enable()   MACROS{ OTGCON |=  (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE); DDRE |= (1 << 7); }MACROE\r
 \r
                        #define USB_Host_VBUS_Auto_On()         MACROS{ OTGCON |= (1 << VBUSREQ);         }MACROE\r
                        #define USB_Host_VBUS_Manual_Enable()   MACROS{ OTGCON |=  (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE); DDRE |= (1 << 7); }MACROE\r
 \r
                        #define USB_Host_VBUS_Auto_On()         MACROS{ OTGCON |= (1 << VBUSREQ);         }MACROE\r
@@ -259,7 +382,7 @@
                        #define USB_Host_VBUS_Auto_Off()        MACROS{ OTGCON |=  (1 << VBUSRQC);        }MACROE\r
                        #define USB_Host_VBUS_Manual_Off()      MACROS{ PORTE  &= ~(1 << 7);              }MACROE\r
 \r
                        #define USB_Host_VBUS_Auto_Off()        MACROS{ OTGCON |=  (1 << VBUSRQC);        }MACROE\r
                        #define USB_Host_VBUS_Manual_Off()      MACROS{ PORTE  &= ~(1 << 7);              }MACROE\r
 \r
-                       #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR  =  (addr & 0x7F);         }MACROE\r
+                       #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR  =  ((addr) & 0x7F);       }MACROE\r
 \r
                /* Enums: */\r
                        enum USB_Host_WaitMSErrorCodes_t\r
 \r
                /* Enums: */\r
                        enum USB_Host_WaitMSErrorCodes_t\r
@@ -271,8 +394,12 @@
                        };\r
 \r
                /* Function Prototypes: */\r
                        };\r
 \r
                /* Function Prototypes: */\r
+                       void    USB_Host_ProcessNextHostState(void);\r
                        uint8_t USB_Host_WaitMS(uint8_t MS);\r
                        uint8_t USB_Host_WaitMS(uint8_t MS);\r
-                       void    USB_Host_ResetDevice(void);\r
+                       \r
+                       #if defined(INCLUDE_FROM_HOST_C)\r
+                               static void USB_Host_ResetDevice(void);\r
+                       #endif\r
        #endif\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
        #endif\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
USB isp AVR programmer