Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / HostChapter9.h
index cbb5ba5..bdecddd 100644 (file)
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Enums: */\r
-                       /** Enum for the USB_Host_SendControlRequest() return code, indicating the reason for the error\r
+                       /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error\r
                         *  if the transfer of the request is unsuccessful.\r
                         *\r
                         *  \ingroup Group_PipeControlReq\r
                         */\r
                        enum USB_Host_SendControlErrorCodes_t\r
                        {\r
-                               HOST_SENDCONTROL_Successful       = 0, /**< No error occurred in the request transfer. */\r
-                               HOST_SENDCONTROL_DeviceDisconnect = 1, /**< The attached device was disconnected during the\r
+                               HOST_SENDCONTROL_Successful         = 0, /**< No error occurred in the request transfer. */\r
+                               HOST_SENDCONTROL_DeviceDisconnected = 1, /**< The attached device was disconnected during the\r
                                                                        *   request transfer.\r
                                                                        */\r
-                               HOST_SENDCONTROL_PipeError        = 2, /**< An error occurred in the pipe while sending the request. */\r
-                               HOST_SENDCONTROL_SetupStalled     = 3, /**< The attached device stalled the request, usually\r
+                               HOST_SENDCONTROL_PipeError          = 2, /**< An error occurred in the pipe while sending the request. */\r
+                               HOST_SENDCONTROL_SetupStalled       = 3, /**< The attached device stalled the request, usually\r
                                                                        *   indicating that the request is unsupported on the device.\r
                                                                        */\r
-                               HOST_SENDCONTROL_SoftwareTimeOut  = 4, /**< The request or data transfer timed out. */\r
+                               HOST_SENDCONTROL_SoftwareTimeOut    = 4, /**< The request or data transfer timed out. */\r
                        };\r
                        \r
                /* Function Prototypes: */\r
-                       /** Sends the request stored in the USB_ControlRequest global structure to the attached device,\r
+                       /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,\r
                         *  and transfers the data stored in the buffer to the device, or from the device to the buffer\r
                         *  as requested. The transfer is made on the currently selected pipe.\r
                         *\r
                         *  \ingroup Group_PipeControlReq\r
                         *\r
-                        *  \param BufferPtr  Pointer to the start of the data buffer if the request has a data stage, or\r
-                        *                    NULL if the request transfers no data to or from the device.\r
+                        *  \param[in] BufferPtr  Pointer to the start of the data buffer if the request has a data stage, or\r
+                        *                        NULL if the request transfers no data to or from the device.\r
                         *\r
-                        *  \return A value from the USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
                         */\r
                        uint8_t USB_Host_SendControlRequest(void* BufferPtr);\r
                        \r
@@ -90,7 +90,7 @@
        \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_HOSTCHAPTER9_C)\r
-                               static uint8_t USB_Host_Wait_For_Setup_IOS(const uint8_t WaitType);\r
+                               static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);\r
                        #endif\r
        #endif\r
 \r