Minor documentation improvements.

[pub/USBasp.git] / LUFA / Drivers / USB / Core / HostStandardReq.h

diff --git a/LUFA/Drivers/USB/Core/HostStandardReq.h b/LUFA/Drivers/USB/Core/HostStandardReq.h
index ab49119..5bdfe45 100644 (file)
--- a/LUFA/Drivers/USB/Core/HostStandardReq.h
+++ b/LUFA/Drivers/USB/Core/HostStandardReq.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -69,7 +69,7 @@
                                 */
                                #define USB_HOST_TIMEOUT_MS                1000
                        #endif
                                 */
                                #define USB_HOST_TIMEOUT_MS                1000
                        #endif

-                       
+

                /* Enums: */
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error
                         *  if the transfer of the request is unsuccessful.
                /* Enums: */
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error
                         *  if the transfer of the request is unsuccessful.


@@ -80,12 +80,12 @@
                        {
                                HOST_SENDCONTROL_Successful         = 0, /**< No error occurred in the request transfer. */
                                HOST_SENDCONTROL_DeviceDisconnected = 1, /**< The attached device was disconnected during the
                        {
                                HOST_SENDCONTROL_Successful         = 0, /**< No error occurred in the request transfer. */
                                HOST_SENDCONTROL_DeviceDisconnected = 1, /**< The attached device was disconnected during the

-                                                                       *   request transfer.
+                                                                       *     request transfer.

                                                                        */
                                HOST_SENDCONTROL_PipeError          = 2, /**< An error occurred in the pipe while sending the request. */
                                HOST_SENDCONTROL_SetupStalled       = 3, /**< The attached device stalled the request, usually
                                                                        */
                                HOST_SENDCONTROL_PipeError          = 2, /**< An error occurred in the pipe while sending the request. */
                                HOST_SENDCONTROL_SetupStalled       = 3, /**< The attached device stalled the request, usually

-                                                                       *   indicating that the request is unsupported on the device.
-                                                                       */
+                                                                         *   indicating that the request is unsupported on the device.
+                                                                         */

                                HOST_SENDCONTROL_SoftwareTimeOut    = 4, /**< The request or data transfer timed out. */
                        };
 
                                HOST_SENDCONTROL_SoftwareTimeOut    = 4, /**< The request or data transfer timed out. */
                        };
 


@@ -95,13 +95,13 @@
                         *
                         *  To set a device configuration, call the \ref USB_Host_SetDeviceConfiguration() function.
                         *
                         *
                         *  To set a device configuration, call the \ref USB_Host_SetDeviceConfiguration() function.
                         *

-                        *  \note This variable should be treated as read-only in the user application, and never manually
-                        *        changed in value.
+                        *  \attention This variable should be treated as read-only in the user application, and never manually
+                        *             changed in value.

                         *
                         *  \ingroup Group_Host
                         */
                        extern uint8_t USB_Host_ConfigurationNumber;
                         *
                         *  \ingroup Group_Host
                         */
                        extern uint8_t USB_Host_ConfigurationNumber;

-                       
+

                /* Function Prototypes: */
                        /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,
                         *  and transfers the data stored in the buffer to the device, or from the device to the buffer
                /* Function Prototypes: */
                        /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,
                         *  and transfers the data stored in the buffer to the device, or from the device to the buffer


@@ -130,7 +130,7 @@
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                        uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                        uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);

-                       
+

                        /** Sends a GET CONFIGURATION standard request to the attached device, to retrieve the currently selected
                         *  device configuration index.
                         *
                        /** Sends a GET CONFIGURATION standard request to the attached device, to retrieve the currently selected
                         *  device configuration index.
                         *


@@ -144,43 +144,28 @@
                         */
                        uint8_t USB_Host_GetDeviceConfiguration(uint8_t* const ConfigNumber) ATTR_NON_NULL_PTR_ARG(1);
 
                         */
                        uint8_t USB_Host_GetDeviceConfiguration(uint8_t* const ConfigNumber) ATTR_NON_NULL_PTR_ARG(1);
 

-                       /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the device descriptor.
-                        *  This can be used to easily retrieve information about the device such as its VID, PID and power
-                        *  requirements.
+                       /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the  descriptor of the
+                        *  specified type and index.

                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *  \ingroup Group_PipeControlReq
                         *
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *  \ingroup Group_PipeControlReq
                         *

-                        *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where
-                        *                                   the read data is to be stored.
+                        *  \param[in]  Type          Type of descriptor to retrieve, a value from the \ref USB_DescriptorTypes_t enum.
+                        *  \param[in]  Index         Index of the descriptor to retrieve.
+                        *  \param[out] Buffer        Pointer to the destination buffer where the retrieved string descriptor is to be stored.
+                        *  \param[in]  BufferLength  Maximum size of the string descriptor which can be stored into the buffer.

                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */

-                       uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr) ATTR_NON_NULL_PTR_ARG(1);
-
-                       /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the string descriptor
-                        *  of the specified index. This can be used to easily retrieve string descriptors from the device by
-                        *  index, after the index is obtained from the Device or Configuration descriptors.
-                        *
-                        *  \note After this routine returns, the control pipe will be selected.
-                        *
-                        *  \ingroup Group_PipeControlReq
-                        *
-                        *  \param[in]  Index        Index of the string index to retrieve.
-                        *  \param[out] Buffer       Pointer to the destination buffer where the retrieved string descriptor is
-                        *                           to be stored.
-                        *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer.
-                        *
-                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
-                        */
-                       uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
-                                                                  void* const Buffer,
-                                                                  const uint8_t BufferLength) ATTR_NON_NULL_PTR_ARG(2);
+                       uint8_t USB_Host_GetDescriptor(const uint8_t Type,
+                                                      const uint8_t Index,
+                                                      void* const Buffer,
+                                                      const uint8_t BufferLength) ATTR_NON_NULL_PTR_ARG(3);

 
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
                         *  retrieved feature status can then be examined by masking the retrieved value with the various
 
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
                         *  retrieved feature status can then be examined by masking the retrieved value with the various

-                        *  FEATURE_* masks for bus/self power information and remote wakeup support.
+                        *  \c FEATURE_* masks for bus/self power information and remote wakeup support.

                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *


@@ -217,7 +202,7 @@
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                        uint8_t USB_Host_SetInterfaceAltSetting(const uint8_t InterfaceIndex,
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                        uint8_t USB_Host_SetInterfaceAltSetting(const uint8_t InterfaceIndex,

-                                                                                                       const uint8_t AltSetting);
+                                                               const uint8_t AltSetting);

 
 
                        /** Retrieves the current alternative setting for the specified interface, via a GET INTERFACE standard request to
 
 
                        /** Retrieves the current alternative setting for the specified interface, via a GET INTERFACE standard request to


@@ -234,7 +219,53 @@
                         */
                        uint8_t USB_Host_GetInterfaceAltSetting(const uint8_t InterfaceIndex,
                                                                uint8_t* const AltSetting) ATTR_NON_NULL_PTR_ARG(2);
                         */
                        uint8_t USB_Host_GetInterfaceAltSetting(const uint8_t InterfaceIndex,
                                                                uint8_t* const AltSetting) ATTR_NON_NULL_PTR_ARG(2);

-                                                                               
+
+               /* Inline Functions: */
+                       /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the device descriptor.
+                        *  This can be used to easily retrieve information about the device such as its VID, PID and power
+                        *  requirements. This is a convenience wrapper for \ref USB_Host_GetDescriptor().
+                        *
+                        *  \note After this routine returns, the control pipe will be selected.
+                        *
+                        *  \ingroup Group_PipeControlReq
+                        *
+                        *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where
+                        *                                   the read data is to be stored.
+                        *
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
+                        */
+                       static inline uint8_t USB_Host_GetDeviceDescriptor(USB_Descriptor_Device_t* const DeviceDescriptorPtr) ATTR_NON_NULL_PTR_ARG(1);
+                       static inline uint8_t USB_Host_GetDeviceDescriptor(USB_Descriptor_Device_t* const DeviceDescriptorPtr)
+                       {
+                               return USB_Host_GetDescriptor(DTYPE_Device, 0, DeviceDescriptorPtr, sizeof(USB_Descriptor_Device_t));
+                       }
+
+                       /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the string descriptor
+                        *  of the specified index. This can be used to easily retrieve string descriptors from the device by
+                        *  index, after the index is obtained from the Device or Configuration descriptors. This is a convenience
+                        *  wrapper for \ref USB_Host_GetDescriptor().
+                        *
+                        *  \note After this routine returns, the control pipe will be selected.
+                        *
+                        *  \ingroup Group_PipeControlReq
+                        *
+                        *  \param[in]  Index        Index of the string descriptor to retrieve.
+                        *  \param[out] Buffer       Pointer to the destination buffer where the retrieved string descriptor is
+                        *                           to be stored.
+                        *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer.
+                        *
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
+                        */
+                       static inline uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
+                                                                                void* const Buffer,
+                                                                                const uint8_t BufferLength) ATTR_NON_NULL_PTR_ARG(2);
+                       static inline uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
+                                                                                void* const Buffer,
+                                                                                const uint8_t BufferLength)
+                       {
+                               return USB_Host_GetDescriptor(DTYPE_String, Index,  Buffer, BufferLength);
+                       }
+

        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Enums: */
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Enums: */


@@ -247,6 +278,7 @@
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HOSTSTDREQ_C)
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HOSTSTDREQ_C)

+                               static uint8_t USB_Host_SendControlRequest_PRV(void* const BufferPtr);

                                static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);
                        #endif
        #endif
                                static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);
                        #endif
        #endif