Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with...

[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..b1d60af 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.h
@@ -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


@@ -73,7 +68,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 +85,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 +95,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 +114,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


@@ -184,8 +179,7 @@
                         *\r
                         *  For information on each state, refer to the USB 2.0 specification. Some states have\r
                         *\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


@@ -205,28 +199,28 @@
                                HOST_STATE_Suspended                    = 13, /**< May be implemented by the user project. */\r
                        };\r
                        \r
                                HOST_STATE_Suspended                    = 13, /**< May be implemented by the user project. */\r
                        };\r
                        \r

-                       /** Enum for the error codes for the USB_HostError event.\r
+                       /** Enum for the error codes for the \ref USB_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 USB_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 USB_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