Removed "Host_" section of the function names in ConfigDescriptor.h, as most of the...

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / HostChapter9.h

diff --git a/LUFA/Drivers/USB/LowLevel/HostChapter9.h b/LUFA/Drivers/USB/LowLevel/HostChapter9.h
index 1ca4343..c2c4ece 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/HostChapter9.h
+++ b/LUFA/Drivers/USB/LowLevel/HostChapter9.h
@@ -28,14 +28,6 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-/** \file\r
- *\r
- *  Module for host mode request processing. This module allows for the transmission of standard, class and\r
- *  vendor control requests to the default control endpoint of an attached device while in host mode.\r
- *\r
- *  \see Chapter 9 of the USB 2.0 specification.\r
- */\r
-\r

 #ifndef __HOSTCHAPTER9_H__\r
 #define __HOSTCHAPTER9_H__\r
 \r
 #ifndef __HOSTCHAPTER9_H__\r
 #define __HOSTCHAPTER9_H__\r
 \r


@@ -44,7 +36,8 @@
                #include <stdbool.h>\r
                \r
                #include "LowLevel.h"\r
                #include <stdbool.h>\r
                \r
                #include "LowLevel.h"\r

-               #include "StdRequestType.h"\r
+               #include "../HighLevel/USBMode.h"\r
+               #include "../HighLevel/StdRequestType.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


@@ -57,6 +50,8 @@
                         *\r
                         *  \see StdRequestType.h for information on the request type and data.\r
                         *  \see The USB 2.0 specification for more information on standard control requests.\r
                         *\r
                         *  \see StdRequestType.h for information on the request type and data.\r
                         *  \see The USB 2.0 specification for more information on standard control requests.\r

+                        *\r
+                        *  \ingroup Group_PipeControlReq\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r


@@ -70,6 +65,8 @@
                /* Enums: */\r
                        /** Enum for the USB_Host_SendControlRequest() return code, indicating the reason for the error\r
                         *  if the transfer of the request is unsuccessful.\r
                /* Enums: */\r
                        /** Enum for the 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
                         */\r
                        enum USB_Host_SendControlErrorCodes_t\r
                        {\r


@@ -77,7 +74,7 @@
                                HOST_SENDCONTROL_DeviceDisconnect = 1, /**< The attached device was disconnected during the\r
                                                                        *   request transfer.\r
                                                                        */\r
                                HOST_SENDCONTROL_DeviceDisconnect = 1, /**< The attached device was disconnected during the\r
                                                                        *   request transfer.\r
                                                                        */\r

-                               HOST_SENDCONTROL_PipeError        = 2, /**< An error occured in the pipe while sending the request. */\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_SetupStalled     = 3, /**< The attached device stalled the request, usually\r
                                                                        *   indicating that the request is unsupported on the device.\r
                                                                        */\r


@@ -88,13 +85,17 @@
                        /** Global for the request to send via the USB_Host_SendControlRequest() function. This\r
                         *  global should be filled with the correct control request data before sending the request to\r
                         *  the attached device while in host mode.\r
                        /** Global for the request to send via the USB_Host_SendControlRequest() function. This\r
                         *  global should be filled with the correct control request data before sending the request to\r
                         *  the attached device while in host mode.\r

+                        *\r
+                        *  \ingroup Group_PipeControlReq\r

                         */\r
                        extern USB_Host_Request_Header_t USB_HostRequest;\r
                        \r
                /* Function Prototypes: */\r
                        /** Sends the request stored in the USB_HostRequest 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
                         */\r
                        extern USB_Host_Request_Header_t USB_HostRequest;\r
                        \r
                /* Function Prototypes: */\r
                        /** Sends the request stored in the USB_HostRequest 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.\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
                         *\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