Minor updates to the Benito programmer - remove redundant PORT register manipulations.

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / ConfigDescriptor.h

diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
index 17b6378..a9b0b14 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
@@ -133,9 +133,9 @@
                         *\r
                         *  \note This function is available in USB Host mode only.\r
                         *\r
                         *\r
                         *  \note This function is available in USB Host mode only.\r
                         *\r

-                        *  \param BytesRem  Pointer to an int storing the remaining bytes in the configuration descriptor\r
-                        *  \param CurrConfigLoc  Pointer to the current position in the configuration descriptor\r
-                        *  \param ComparatorRoutine  Name of the comparator search function to use on the configuration descriptor\r
+                        *  \param[in,out] BytesRem  Pointer to an int storing the remaining bytes in the configuration descriptor\r
+                        *  \param[in,out] CurrConfigLoc  Pointer to the current position in the configuration descriptor\r
+                        *  \param[in] ComparatorRoutine  Name of the comparator search function to use on the configuration descriptor\r

                         *\r
                         *  \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum\r
                         *\r
                         *\r
                         *  \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum\r
                         *\r


@@ -183,17 +183,17 @@
                /* Function Prototypes: */\r
                        /** Retrieves the configuration descriptor data or size from an attached device via a standard request.\r
                         *\r
                /* Function Prototypes: */\r
                        /** Retrieves the configuration descriptor data or size from an attached device via a standard request.\r
                         *\r

-                        *  \param ConfigNumber  Device configuration descriptor number to fetch from the device (usually set to 1 for\r
-                        *                       single configuration devices)\r
+                        *  \param[in] ConfigNumber  Device configuration descriptor number to fetch from the device (usually set to 1 for\r
+                        *                           single configuration devices)\r

                         *\r
                         *\r

-                        *  \param ConfigSizePtr  Pointer to a uint16_t for either storing or retrieving the configuration\r
-                        *         descriptor size\r
+                        *  \param[in,out] ConfigSizePtr  Pointer to a uint16_t for either storing or retrieving the configuration\r
+                        *                                descriptor size\r

                         *\r
                         *\r

-                        *  \param BufferPtr  Pointer to the buffer for storing the configuration descriptor data. If this is\r
-                        *                    NULL, the size of the configuration descriptor will be retrieved instead and\r
-                        *                    placed in the variable pointed to by ConfigSizePtr. If this is non-NULL, the number\r
-                        *                    of bytes indicated by ConfigSizePtr of the configuration descriptor will be loaded\r
-                        *                    into the buffer\r
+                        *  \param[out] BufferPtr  Pointer to the buffer for storing the configuration descriptor data. If this is\r
+                        *                         NULL, the size of the configuration descriptor will be retrieved instead and\r
+                        *                         placed in the variable pointed to by ConfigSizePtr. If this is non-NULL, the number\r
+                        *                         of bytes indicated by ConfigSizePtr of the configuration descriptor will be loaded\r
+                        *                         into the buffer\r

                         */\r
                        uint8_t USB_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr)\r
                                                              ATTR_NON_NULL_PTR_ARG(2);\r
                         */\r
                        uint8_t USB_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const ConfigSizePtr, void* BufferPtr)\r
                                                              ATTR_NON_NULL_PTR_ARG(2);\r


@@ -201,9 +201,9 @@
                        /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.\r
                         *  The bytes remaining value is automatically decremented.\r
                         *\r
                        /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.\r
                         *  The bytes remaining value is automatically decremented.\r
                         *\r

-                        * \param BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
-                        * \param CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r
-                        * \param Type  Descriptor type value to search for\r
+                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
+                        * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r
+                        * \param[in] Type  Descriptor type value to search for\r

                         */\r
                        void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,\r
                                                         uint8_t** const CurrConfigLoc,\r
                         */\r
                        void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,\r
                                                         uint8_t** const CurrConfigLoc,\r


@@ -215,10 +215,10 @@
                         *  descriptor is reached first, the number of bytes remaining to process is set to zero and the\r
                         *  function exits. The bytes remaining value is automatically decremented.\r
                         *\r
                         *  descriptor is reached first, the number of bytes remaining to process is set to zero and the\r
                         *  function exits. The bytes remaining value is automatically decremented.\r
                         *\r

-                        * \param BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
-                        * \param CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r
-                        * \param Type  Descriptor type value to search for\r
-                        * \param BeforeType  Descriptor type value which must not be reached before the given Type descriptor\r
+                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
+                        * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r
+                        * \param[in] Type  Descriptor type value to search for\r
+                        * \param[in] BeforeType  Descriptor type value which must not be reached before the given Type descriptor\r

                         */\r
                        void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,\r
                                                               uint8_t** const CurrConfigLoc,\r
                         */\r
                        void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,\r
                                                               uint8_t** const CurrConfigLoc,\r


@@ -230,10 +230,10 @@
                         *  which must come after a descriptor of the second given type value. The bytes remaining value is\r
                         *  automatically decremented.\r
                         *\r
                         *  which must come after a descriptor of the second given type value. The bytes remaining value is\r
                         *  automatically decremented.\r
                         *\r

-                        * \param BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
-                        * \param CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r
-                        * \param Type  Descriptor type value to search for\r
-                        * \param AfterType  Descriptor type value which must be reached before the given Type descriptor\r
+                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
+                        * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r
+                        * \param[in] Type  Descriptor type value to search for\r
+                        * \param[in] AfterType  Descriptor type value which must be reached before the given Type descriptor\r

                         */\r
                        void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,\r
                                                              uint8_t** const CurrConfigLoc,\r
                         */\r
                        void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,\r
                                                              uint8_t** const CurrConfigLoc,\r


@@ -245,8 +245,8 @@
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then\r
                            points to the next sub-descriptor. The bytes remaining value is automatically decremented.\r
                         *\r
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then\r
                            points to the next sub-descriptor. The bytes remaining value is automatically decremented.\r
                         *\r

-                        * \param BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
-                        * \param CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r
+                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor\r
+                        * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor\r

                         */\r
                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,\r
                                                                 uint8_t** const CurrConfigLoc) \r
                         */\r
                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,\r
                                                                 uint8_t** const CurrConfigLoc) \r