Documentation improvements - put driver example code into its own section, fix incorr...

[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 001653b..a406498 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -52,12 +52,12 @@
 
        /* Includes: */
                #include <stdint.h>
 
        /* Includes: */
                #include <stdint.h>

-               
+

                #include "../../../Common/Common.h"
                #include "HostStandardReq.h"
                #include "USBMode.h"
                #include "StdDescriptors.h"
                #include "../../../Common/Common.h"
                #include "HostStandardReq.h"
                #include "USBMode.h"
                #include "StdDescriptors.h"

-               
+

        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {


@@ -67,8 +67,8 @@
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif

-               
-       /* Public Interface - May be used in end-application: */        
+
+       /* Public Interface - May be used in end-application: */

                /* Macros: */
                        /** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared
                         *  with the EP_TYPE_* masks to determine the exact type of the endpoint.
                /* Macros: */
                        /** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared
                         *  with the EP_TYPE_* masks to determine the exact type of the endpoint.


@@ -107,10 +107,10 @@
                         *  This value's meaning depends on the descriptor's placement in the descriptor, but standard type
                         *  values can be accessed in the \ref USB_DescriptorTypes_t enum.
                         */
                         *  This value's meaning depends on the descriptor's placement in the descriptor, but standard type
                         *  values can be accessed in the \ref USB_DescriptorTypes_t enum.
                         */

-                       #define DESCRIPTOR_TYPE(DescriptorPtr)    DESCRIPTOR_CAST(DescriptorPtr, USB_Descriptor_Header_t).Type
-                       
+                       #define DESCRIPTOR_TYPE(DescriptorPtr)    DESCRIPTOR_PCAST(DescriptorPtr, USB_Descriptor_Header_t)->Type
+

                        /** Returns the descriptor's size, expressed as the 8-bit value indicating the number of bytes. */
                        /** Returns the descriptor's size, expressed as the 8-bit value indicating the number of bytes. */

-                       #define DESCRIPTOR_SIZE(DescriptorPtr)    DESCRIPTOR_CAST(DescriptorPtr, USB_Descriptor_Header_t).Size
+                       #define DESCRIPTOR_SIZE(DescriptorPtr)    DESCRIPTOR_PCAST(DescriptorPtr, USB_Descriptor_Header_t)->Size

 
                /* Type Defines: */
                        /** Type define for a Configuration Descriptor comparator function (function taking a pointer to an array
 
                /* Type Defines: */
                        /** Type define for a Configuration Descriptor comparator function (function taking a pointer to an array


@@ -119,7 +119,7 @@
                         *  \see \ref USB_GetNextDescriptorComp function for more details.
                         */
                        typedef uint8_t (* ConfigComparatorPtr_t)(void*);
                         *  \see \ref USB_GetNextDescriptorComp function for more details.
                         */
                        typedef uint8_t (* ConfigComparatorPtr_t)(void*);

-                       
+

                /* Enums: */
                        /** Enum for the possible return codes of the \ref USB_Host_GetDeviceConfigDescriptor() function. */
                        enum USB_Host_GetConfigDescriptor_ErrorCodes_t
                /* Enums: */
                        /** Enum for the possible return codes of the \ref USB_Host_GetDeviceConfigDescriptor() function. */
                        enum USB_Host_GetConfigDescriptor_ErrorCodes_t


@@ -138,7 +138,7 @@
                                                                        */
                                HOST_GETCONFIG_InvalidData      = 6, /**< The device returned invalid configuration descriptor data. */
                        };
                                                                        */
                                HOST_GETCONFIG_InvalidData      = 6, /**< The device returned invalid configuration descriptor data. */
                        };

-               
+

                        /** Enum for return values of a descriptor comparator function. */
                        enum DSearch_Return_ErrorCodes_t
                        {
                        /** Enum for return values of a descriptor comparator function. */
                        enum DSearch_Return_ErrorCodes_t
                        {


@@ -155,7 +155,7 @@
                                DESCRIPTOR_SEARCH_COMP_Fail            = 1, /**< Comparator function returned Descriptor_Search_Fail. */
                                DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */
                        };
                                DESCRIPTOR_SEARCH_COMP_Fail            = 1, /**< Comparator function returned Descriptor_Search_Fail. */
                                DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */
                        };

-       
+

                /* Function Prototypes: */
                        /** Retrieves the configuration descriptor data from an attached device via a standard request into a buffer,
                         *  including validity and size checking to prevent a buffer overflow.
                /* Function Prototypes: */
                        /** Retrieves the configuration descriptor data from an attached device via a standard request into a buffer,
                         *  including validity and size checking to prevent a buffer overflow.


@@ -266,16 +266,16 @@
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor.
                         */
                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor.
                         */
                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,

-                                                                void** CurrConfigLoc) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);                                                                         
+                                                                void** CurrConfigLoc) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);

                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
                                                                 void** CurrConfigLoc)
                        {
                                uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;
                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
                                                                 void** CurrConfigLoc)
                        {
                                uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;

-                               
+

                                *CurrConfigLoc  = ((uint8_t*)*CurrConfigLoc) + CurrDescriptorSize;
                                *BytesRem      -= CurrDescriptorSize;
                        }
                                *CurrConfigLoc  = ((uint8_t*)*CurrConfigLoc) + CurrDescriptorSize;
                                *BytesRem      -= CurrDescriptorSize;
                        }

-               
+

        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }


@@ -284,3 +284,4 @@
 #endif
 
 /** @} */
 #endif
 
 /** @} */

+